Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(sync): add AC notifications when initiating the sync fallback #5586

Closed
wants to merge 5 commits into from

Conversation

jrainville
Copy link
Member

Needed for status-im/status-desktop#15750

Adds an AC notification when the syncing fails and the user is prompted to use a seed phrase instead.
There is one notification for the initiator (created) and one for the old account (received).
Once the flow is completed, ie the receiver presses Enable and sync, the notifications are deleted

NOTE: this is a rebased version on top of develop, so the original commits are also in there. Please review only the last commit
The original PR is here #5567

pairing.webm

cammellos and others added 5 commits July 25, 2024 16:08
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.
Needed for status-im/status-desktop#15750

Adds an AC notification when the syncing fails and the user is prompted to use a seed phrase instead.
There is one notification for the initiator (created) and one for the old account (received).
Once the flow is completed, ie the receiver presses Enable and sync,  the notifications are deleted
@status-im-auto
Copy link
Member

status-im-auto commented Jul 25, 2024

Jenkins Builds

Commit #️⃣ Finished (UTC) Duration Platform Result
✖️ 765ff71 #1 2024-07-25 20:52:20 ~1 min tests 📄log
✔️ 765ff71 #1 2024-07-25 20:53:35 ~2 min tests-rpc 📄log
✔️ 765ff71 #1 2024-07-25 20:54:59 ~3 min linux 📦zip
✔️ 765ff71 #1 2024-07-25 20:56:26 ~5 min android 📦aar
✔️ 765ff71 #1 2024-07-25 20:58:40 ~7 min ios 📦zip

Copy link
Contributor

@qfrank qfrank left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@igor-sirotin
Copy link
Collaborator

didn't look at the code yet, but I wonder if this is related to:

@jrainville
Copy link
Member Author

Closing as it is now part of #5794

@jrainville jrainville closed this Sep 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants