Fixes authentication when user is registered via module API

[maheichyk]

Type: Defect
Related: https://github.com/matrix-org/matrix-react-sdk-module-api

When user is registered via module API (using ILAG module for example) the following error is received:

Invariant Violation: Dispatch.dispatch(...): Cannot dispatch in the middle of a dispatch.
    invariant invariant.js:40
    dispatch Dispatcher.js:179
    dispatch dispatcher.ts:45
    doSetLoggedIn Lifecycle.ts:604
    <anonymous> Lifecycle.ts:76
    _invokeCallback Dispatcher.js:214
    dispatch Dispatcher.js:189
    dispatch dispatcher.ts:45
    overwriteAccountAuth ProxiedModuleApi.ts:146
    _callee$ IlagModule.js:78

This PR provides a fix to resolve this problem.

Checklist

• Tests written for new code (and old code if feasible)
• Linter and other CI checks pass
• Sign-off given on the changes (see CONTRIBUTING.md)

---

Here's what your changelog entry will look like:

🐛 Bug Fixes

• Fixes authentication when user is registered via module API (#10156). Contributed by @maheichyk.

[t3chguy]

Seems like this was the only caller which used OverwriteLoginPayload so it should be cleaned up

[maheichyk]

thanks, okay, I have removed OverwriteLoginPayload and it's usages from the code.

[maheichyk]

This change actually breaks a lot of tests (approximately 10%). It looks not clear to me. It seems that some mocking is not working properly anymore. Is it valid to use Lifecycle this way? If yes maybe there is some idea or hint how the tests could be fixed? @t3chguy could you please help?

[t3chguy]

Given the method you are calling was not previously exported - it wasn't a designed use for it to be called like this.

As for the test failures, would need to step through the code to see what is wrong. Not something I'm able to dive into right now unfortunately

[maheichyk]

Created another PR that fixes this issue: #10257

[maheichyk]

closing this PR in favor of #10257