Page MenuHomePhabricator

[native] Handler for migrating to signed device lists
ClosedPublic

Authored by bartek on Thu, Dec 12, 7:24 AM.
Tags
None
Referenced Files
F3520476: D14148.id46381.diff
Mon, Dec 23, 12:30 AM
F3516099: D14148.id46573.diff
Sun, Dec 22, 12:13 PM
F3515869: D14148.id46530.diff
Sun, Dec 22, 10:43 AM
F3515850: D14148.id46381.diff
Sun, Dec 22, 10:35 AM
F3515758: D14148.id46460.diff
Sun, Dec 22, 10:06 AM
F3514473: D14148.id46569.diff
Sun, Dec 22, 5:08 AM
Unknown Object (File)
Fri, Dec 20, 6:29 PM
Unknown Object (File)
Fri, Dec 20, 7:29 AM
Subscribers

Details

Summary

Address ENG-9618.

Code handling migrating user from old flows to signed device lists

Test Plan

Manual testing - using console logs I confirmed that:

  • migration code is run only when latest backup info is absent, and latest device list was unsigned
    • device list is being reordered and signed device list update is sent during migration
    • userkeys backup is created
  • normal backup creation runs otherwise

Diff Detail

Repository
rCOMM Comm
Lint
No Lint Coverage
Unit
No Test Coverage

Event Timeline

bartek held this revision as a draft.

Keeping it as a draft becasue we discussed with @kamil that it's best to merge it with BackupHandler - this will solve issues with synchronizing the two handlers

Merge handler into BackupHandler

bartek published this revision for review.Mon, Dec 16, 6:16 AM
bartek edited the test plan for this revision. (Show Details)
native/backup/backup-handler.js
82 ↗(On Diff #46460)

What's the point of this ref?

kamil requested changes to this revision.Mon, Dec 16, 9:00 AM
kamil added inline comments.
native/backup/backup-handler.js
182–185 ↗(On Diff #46460)

You should add migrationRunning.current here or you can rely on backupUploadInProgress, but make sure to set it to false when early returning or throwing error

195–200 ↗(On Diff #46460)

You should avoid throwing here, backupUploadInProgress will be set to true forever now. (this applies to error below)

In testUserKeysRestore we throw an error but later we show an alert with that message, maybe we could do the same here to show the message to staff?

244–288 ↗(On Diff #46460)

is there a chance to make this and reorderAndSignDeviceList to be part of useDeviceListUpdate to have code for updating the device list encapsulated in one place?

267 ↗(On Diff #46460)

is there a task tracking implementing this?

299–305 ↗(On Diff #46460)

this code can now be executed on a non-primary device I think.

Can this be put at the top and the early-exit to make this code cleaner?

This revision now requires changes to proceed.Mon, Dec 16, 9:00 AM
native/backup/backup-handler.js
82 ↗(On Diff #46460)

Hmm, it was needed when the handlers were separate, but now when they are merged, the migrationRunning ref is actually not needed, its purpose is already fully covered by the backupUploadInProgress. I'll remove it

182–185 ↗(On Diff #46460)

After analyzing it, the migrationRunning ref is actually not needed, its purpose is already fully covered by the backupUploadInProgress

195–200 ↗(On Diff #46460)

Good call

267 ↗(On Diff #46460)

I was about to make a separate diff for it, but it became short and simple so I'd rather fixup it into this one

299–305 ↗(On Diff #46460)

It's not that simple:

  • Migration should be able to run on non-primary device too
  • The promise must have the same return value for all branches.

The solution is to duplicate conditions for the above if plus the primary device condition, and early exit before creating this promise

native/backup/backup-handler.js
200–227 ↗(On Diff #46530)

This whole block can be replaced with selector call when ENG-9763 is done

kamil added inline comments.
native/backup/backup-handler.js
202 ↗(On Diff #46530)

Maybe or merge with condition below?

291–293 ↗(On Diff #46530)

shouldn't we call this in a loop, and also check if we're still primary before uploading backup keys?

316–320 ↗(On Diff #46530)

Now, this covers both regular backup upload and migration, I would prefer to somehow differentiate (use different try-catch) so this could be easier to debug if needed

244–288 ↗(On Diff #46460)

this comment was skipped - but perhaps we can make it in a separate diff

This revision is now accepted and ready to land.Tue, Dec 17, 7:02 AM
native/backup/backup-handler.js
202 ↗(On Diff #46530)

Good idea

291–293 ↗(On Diff #46530)

I thought about this a bit and considered a few scenarios. After doing some testing, I think this works the best:

  • The device list is updated at this point.
  • Retry it 3-5 times.
  • If it fails, don't set the backupID locally, so the next time this hook is run, it will trigger uploading backup again.
  • Because the device list is updated, other devices will no longer be trying to upload it.
316–320 ↗(On Diff #46530)

Good idea, but two try-catch blocks introduced too much nesting here, so I'll make error message conditional basing on shouldDoMigration

native/backup/backup-handler.js
244–288 ↗(On Diff #46460)

Not sure if this is a good idea. The reorderAndSignDeviceList is exceptional and should be used only in one place - this migration code.