add fallback flow to pairing #5567
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Jenkins BuildsClick to see older builds (30)
|
cammellos
force-pushed
the
feature/fallback-pairing-seed
branch
from
6413382
to
da2a8c0
Compare
cammellos
force-pushed
the
feature/fallback-pairing-seed
branch
2 times, most recently
from
7d0468b
to
4207c5f
Compare
feat(pairing)!: add fallback flow to pairing This commit includes the following changes: *Breaking change in connection string* The local pairing code that was parsing the connection string had a few non-upgradable features: - It was strictly checking the number of parameters, throwing an error if the number was different. This made it impossible to add parameters to it without breaking. - It was strictly checking the version number. This made increasing the version number impossible as older client would just refuse to connect. The code has been changed so that: - Version is not used. Better not to use something than to use it wrongly, rarely version is needed if the protocol is correctly upgraded. - Two parameters have been added, `installation-id` and `key-uid`. Those are needed for the fallback flow. I have also removed version from the payload, since it wasn't used. This means that we don't support v1 anymore. V2 parsing should be supported (a new might be able to parse a v2 client, but not the other way around). It is to be considered a complete breaking change. 2.30 -> 2.30 syncing only is supported, but going forward there's a clear strategy on how to update the protocol (append parameters, don't change existing one). *Changed `MessengerResponse` to use internally a map of `installations` rather than an array (minor)* Just moving towards maps as arrays tend to lead to subtle bugs. *Moved pairing methods to messenger_pairing.go* Just moved some methods *Added 2 new methods for the fallback flow* `FinishPairingThroughSeedPhraseProcess` https://github.com/status-im/status-go/pull/5567/files#diff-1ad620b07fa3bd5fbc96c9f459d88829938a162bf1aaf41c61dea6e38b488d54R29 `EnableAndSyncInstallation` https://github.com/status-im/status-go/pull/5567/files#diff-1ad620b07fa3bd5fbc96c9f459d88829938a162bf1aaf41c61dea6e38b488d54R18 *Flow for clients* Client A1 is logged in Client A2 is logged out 1) Client A1 shows a QR code 2) Client A2 scans a QR code 3) If connection fails on A2, the user will be prompted to enter a seed phrase. 4) If the generated account matches the `key-uid` from the QR code, A2 should call `FinishPairingThroughSeedPhraseProcess` with the installation id passed in the QR code. This will send installation information over waku. The user should be shown its own installation id and prompted to check the other device. 5) Client A1 will receive new installation data through waku, if they are still on the qr code page, they should show a popup to the user showing the received installation id, and a way to `Enable and Sync`, which should call the `EnableAndSyncInstallation` endpoint. This should finish the fallback syncing flow. *Current issues* Currently I haven't tested that all the data is synced after finishing the flow. I see that the two devices are paired correctly, but for example the `DisplayName` is not changed on the receiving device. I haven't had time to look into it further.
qfrank
force-pushed
the
feature/fallback-pairing-seed
branch
from
c39d9dc
to
2514315
Compare
|
pls use PR instead of this one |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit includes the following changes:
Breaking change in connection string
The local pairing code that was parsing the connection string had a few non-upgradable features:
The code has been changed so that:
installation-idandkey-uid. Those are needed for the fallback flow.I have also removed version from the payload, since it wasn't used.
This means that we don't support v1 anymore. V2 parsing should be supported (a new might be able to parse a v2 client, but not the other way around). It is to be considered a complete breaking change. 2.30 -> 2.30 syncing only is supported, but going forward there's a clear strategy on how to update the protocol (append parameters, don't change existing one).
https://www.youtube.com/watch?v=oyLBGkS5ICk Is a must watch video for understanding the strategy
Changed
MessengerResponseto use internally a map ofinstallationsrather than an array (minor)Just moving towards maps as arrays tend to lead to subtle bugs.
Moved pairing methods to messenger_pairing.go
Just moved some methods
Added 2 new methods for the fallback flow
FinishPairingThroughSeedPhraseProcesshttps://github.com/status-im/status-go/pull/5567/files#diff-1ad620b07fa3bd5fbc96c9f459d88829938a162bf1aaf41c61dea6e38b488d54R29
EnableAndSyncInstallationhttps://github.com/status-im/status-go/pull/5567/files#diff-1ad620b07fa3bd5fbc96c9f459d88829938a162bf1aaf41c61dea6e38b488d54R18
Flow for clients
Client A1 is logged in
Client A2 is logged out
key-uidfrom the QR code, A2 should callFinishPairingThroughSeedPhraseProcesswith the installation id passed in the QR code. This will send installation information over waku. The user should be shown its own installation id and prompted to check the other device.Enable and Sync, which should call theEnableAndSyncInstallationendpoint. This should finish the fallback syncing flow.Current issues
Currently I haven't tested that all the data is synced after finishing the flow. I see that the two devices are paired correctly, but for example the
DisplayNameis not changed on the receiving device. I haven't had time to look into it further.