599544 - Need notification for when storage format mismatch

Status: RESOLVED FIXED

(Firefox for Android Graveyard :: General, defect)

Description

[Philipp von Weitershausen [:philikon]]

Once in a while a newer Firefox Sync version may require a newer storage format, making it incompatible with older versions. There are two scenarios here:

* User upgrades a desktop computer to a newer Firefox Sync version. The desktop will reupload everything in the new storage format. The outdated Fennec client should display a notification upon the next sync telling the user to upgrade to a newer version of Fennec's Sync (or Fennec).

* User ugprades a mobile device to a newer Firefox Sync version. The data in the account is still in the old format. Key generation is disabled on Fennec, so Sync won't reupload everything. It should display a notification that tells the user to upgrade all of their other computers as well and have them sync (the first desktop machine will reupload everything in the new format).

Comment 1

[Mike Connor [:mconnor]]

Not sure of the right milestone for this to block, but it should absolutely block something, hopefully b1?

Comment 2

[Philipp von Weitershausen [:philikon]]

Renominating this for blocking-fennec to block 4.0b2. The crypto simplification that's being planned for Sync will rev the storage format once more so the sooner the have Fennec message a storage format mismatch the better.

I don't know how exactly the notification would be displayed, but the mechanics of it would be similar to how it's done in Firefox [1]:

* listen to the weave:service:sync:error observer notification

* check for Weave.Status.sync == Weave.VERSION_OUT_OF_DATE and each of Weave.Status.engines.* == Weave.VERSION_OUT_OF_DATE.

[1] http://mxr.mozilla.org/mozilla-central/source/browser/base/content/browser-syncui.js#359

Comment 3

[Mike Connor [:mconnor]]

(In reply to comment #2)
> * check for Weave.Status.sync == Weave.VERSION_OUT_OF_DATE and each of
> Weave.Status.engines.* == Weave.VERSION_OUT_OF_DATE.

To be clear here, if any of those are true, we should show the notification.

Comment 4

[Mark Finkle (:mfinkle) (use needinfo?)]

Attachment: patch

Simple patch that uses the info provided and some code from Firefox to display a simple alert, telling the user Sync needs to be updated. Then we load the "update" URL in a new tab.

I don't know if this will give the user enough explanation as to what's happening. I reused the strings from the Firefox notification. Are they applicable to Fennec?

CC'ing Madhava too

Comment 5

[Madhava Enros [:madhava]]

How about "Update Firefox to continue using Sync" ?

Ideally, wherever we show this would give users an avenue to kick off an update.

Comment 6

[Mark Finkle (:mfinkle) (use needinfo?)]

Attachment: patch 2

This patch uses VERSION_OUT_OF_DATE and DESKTOP_VERSION_OUT_OF_DATE to display two different strings, and the option to visit a web page to learn more about the problem.

http://people.mozilla.com/~mfinkle/fennec/screenshots/fennec-sync-client-outdated.png
http://people.mozilla.com/~mfinkle/fennec/screenshots/fennec-sync-remote-outdated.png

Comment 7

[Madhava Enros [:madhava]]

Are we giving people a way to update - is that something that's on the Learn More page?  I don't want to make people hunt for it themselves.

Also - one quibble about the remote version.  Wouldn't it be better to say "Please update Firefox on your other computer(s)." - it's not clear to me what it would mean to update sync, when sync is built in.

Comment 8

[Mike Connor [:mconnor]]

Comment on attachment 485444 [details] [diff] [review]
patch 2


>+    // Check for a storage format update, update the user and load the Sync update page
>+    if (aTopic =="weave:service:sync:error") {
>+      let clientOutdated = Weave.Status.sync == Weave.VERSION_OUT_OF_DATE;
>+      for (let [engine, reason] in Iterator(Weave.Status.engines))
>+        clientOutdated = clientOutdated || reason == Weave.VERSION_OUT_OF_DATE;
>+
>+      let remoteOutdated = Weave.Status.sync == Weave.DESKTOP_VERSION_OUT_OF_DATE;
>+      for (let [engine, reason] in Iterator(Weave.Status.engines))
>+        remoteOutdated = remoteOutdated || reason == Weave.DESKTOP_VERSION_OUT_OF_DATE;

I know this is last minute, but this is a lot of unnecessary work.  Why not do something like this? 

  let clientOutdated = false, remoteOutdated = false;
  if (Weave.Status.sync == Weave.VERSION_OUT_OF_DATE)
    clientOutdated = true;
  else if (Weave.Status.sync == Weave.DESKTOP_VERSION_OUT_OF_DATE)
    remoteOutdated = true;
  else if (Weave.Status.service == Weave.SYNC_FAILED_PARTIAL) {
    // some engines failed, check for per-engine compat
    for (let [engine, reason] in Iterator(Weave.Status.engines)) {
       clientOutdated = clientOutdated || reason == Weave.VERSION_OUT_OF_DATE;
       remoteOutdated = remoteOutdated || reason == Weave.DESKTOP_VERSION_OUT_OF_DATE;
    }
  }

with that, r=me

Also, to answer madhava's question, the intent is that the page will support client/local/remote info as params so we can make this smarter over time.  Sync is built into Firefox, but we're building against a future where this may not just be a Firefox feature, so we need to make sure this is flexible.

Comment 9

[Mark Finkle (:mfinkle) (use needinfo?)]

pushed with mconnor's code change and madhava's string change:
http://hg.mozilla.org/mobile-browser/rev/7b2fed0166ec

Comment 10

[Naoki Hirata :nhirata (please use needinfo instead of cc)]

Need older version of Fennec to verify...

Comment 11

[Ioana Chiorean]

https://litmus.mozilla.org/show_test.cgi?id=15183