Sync 3rd party wallpaper app name

chrome/browser/resources/chromeos/wallpaper_manager/js/event_page.js

 // Copyright (c) 2013 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 var WALLPAPER_PICKER_WIDTH = 574;
 var WALLPAPER_PICKER_HEIGHT = 420;
 
 var wallpaperPickerWindow;
 
 var surpriseWallpaper = null;
@@ skipping 254 matching lines @@
       chrome.wallpaperPrivate.restoreMinimizedWindows();
     });
     WallpaperUtil.testSendMessage('wallpaper-window-created');
   });
 });
 
 chrome.syncFileSystem.onFileStatusChanged.addListener(function(detail) {
   WallpaperUtil.enabledSyncThemesCallback(function(syncEnabled) {
     if (!syncEnabled)
       return;
-    if (detail.status == 'synced') {
-      if (detail.direction == 'remote_to_local') {
-        if (detail.action == 'added') {
-          Constants.WallpaperLocalStorage.get(
-              Constants.AccessLocalWallpaperInfoKey,
-              function(items) {
-                var localData = items[Constants.AccessLocalWallpaperInfoKey];
-                if (localData && localData.url == detail.fileEntry.name &&
-                    localData.source == Constants.WallpaperSourceEnum.Custom) {
-                  WallpaperUtil.setCustomWallpaperFromSyncFS(localData.url,
-                                                             localData.layout);
-                } else if (!localData || localData.url !=
-                           detail.fileEntry.name.replace(
-                               Constants.CustomWallpaperThumbnailSuffix, '')) {
-                  // localData might be null on a powerwashed device.
-                  WallpaperUtil.storeWallpaperFromSyncFSToLocalFS(
-                      detail.fileEntry);
-                }
-             });
-        } else if (detail.action == 'deleted') {
-          var fileName = detail.fileEntry.name.replace(
-              Constants.CustomWallpaperThumbnailSuffix, '');
-          WallpaperUtil.deleteWallpaperFromLocalFS(fileName);
+    if (detail.status == 'synced' && detail.direction == 'remote_to_local') {

[tbarzic, 2016/02/05 22:27:37]

nit: I think this would be easier to read:

if (detail.status !== 'synced' || detail.direction != 'remote_to_local')
  return;

[xdai1, 2016/02/06 01:42:30]

Done.

+      if (detail.action == 'added') {
+        // TODO(xdai): Get rid of this setCustomWallpaperFromSyncFS logic.
+        // WallpaperInfo is saved in the sync filesystem before the corresonding

[tbarzic, 2016/02/05 22:27:37]

I'm not sure if this is necessary true. I don't think there is guarantee on
ordering of change events on sync storage (where wallpaper info is stored) and
sync file system (where wallpaper files are stored).

I think localData.url == detail.fileEntry.name is supposed to handle this (i.e.
if local data has already been updated, set the wallpaper, otherwise, expect
wallpaper to be set when sync storage is updated with new wallpaper info)

On the other hand if this event comes before storage.onChange,
setCustomWallpaperFromSyncFS would fail when it attempts to get the wallpaper
from the sync file system.

[xdai1, 2016/02/06 01:42:30]

As discussed offline, modified the comment to better describe it. 

+        // custom wallpaper and thumbnail are saved, thus the onChanged() might
+        // not set the custom wallpaper correctly.
+        Constants.WallpaperLocalStorage.get(
+            Constants.AccessLocalWallpaperInfoKey, function(items) {
+          var localData = items[Constants.AccessLocalWallpaperInfoKey];
+          if (localData &&
+              localData.url == detail.fileEntry.name &&
+              localData.source == Constants.WallpaperSourceEnum.Custom) {
+            WallpaperUtil.setCustomWallpaperFromSyncFS(localData.url,
+                                                       localData.layout);
+          }
+        });
+        // We only need to store the custom wallpaper if it was set by the
+        // built-in wallpaper picker.
+        if (detail.fileEntry.name.indexOf(
+            Constants.ThirdPartyWallpaperPrefix) == -1) {
+          WallpaperUtil.storeWallpaperFromSyncFSToLocalFS(detail.fileEntry);

[tbarzic, 2016/02/05 22:27:37]

Previously, local FS was not updated if call to
wallpaperPrivate.setCustomWallpaper failed, are you sure we don't want to keep
that behaviour?

[xdai1, 2016/02/06 01:42:30]

I prefer the current behavior. Even if the synced wallpaper is not set directly,
we still should save it to the local fs to make it possible to retry/let user to
manually select it from the wallpaper picker. 
No check mark will appear in the wallpaper picker if the synced wallpaper is not
set up correctly.

[tbarzic, 2016/02/06 01:50:14]

OK. 

         }
+      } else if (detail.action == 'deleted') {
+        var fileName = detail.fileEntry.name.replace(
+            Constants.CustomWallpaperThumbnailSuffix, '');
+        WallpaperUtil.deleteWallpaperFromLocalFS(fileName);
       }
     }
   });
 });
 
 chrome.storage.onChanged.addListener(function(changes, namespace) {
   WallpaperUtil.enabledSyncThemesCallback(function(syncEnabled) {
     if (syncEnabled) {
       // If sync theme is enabled, use values from chrome.storage.sync to sync
       // wallpaper changes.
       WallpaperUtil.requestSyncFS(function() {});
       if (changes[Constants.AccessSyncSurpriseMeEnabledKey]) {
         if (changes[Constants.AccessSyncSurpriseMeEnabledKey].newValue) {
           SurpriseWallpaper.getInstance().next();
         } else {
           SurpriseWallpaper.getInstance().disable();
         }
       }
 
       if (changes[Constants.AccessLocalWallpaperInfoKey]) {
         // If the old wallpaper is a third party wallpaper we should remove it
         // from the local & sync file system to free space.
         var oldInfo = changes[Constants.AccessLocalWallpaperInfoKey].oldValue;
-        if (oldInfo.url.indexOf(Constants.ThirdPartyWallpaperPrefix) != -1) {
+        if (oldInfo &&
+            oldInfo.url.indexOf(Constants.ThirdPartyWallpaperPrefix) != -1) {
           WallpaperUtil.deleteWallpaperFromLocalFS(oldInfo.url);
           WallpaperUtil.deleteWallpaperFromSyncFS(oldInfo.url);
         }
       }
 
       if (changes[Constants.AccessSyncWallpaperInfoKey]) {
         var syncInfo = changes[Constants.AccessSyncWallpaperInfoKey].newValue;
 
         Constants.WallpaperSyncStorage.get(
             Constants.AccessSyncSurpriseMeEnabledKey, function(enabledItems) {
@@ skipping 14 matching lines @@
                 (syncSurpriseMeEnabled &&
                  syncLastSurpriseMeChangedDate == today)) {
               Constants.WallpaperLocalStorage.get(
                   Constants.AccessLocalWallpaperInfoKey, function(infoItems) {
                 var localInfo =
                     infoItems[Constants.AccessLocalWallpaperInfoKey];
                 // Normally, the wallpaper info saved in local storage and sync
                 // storage are the same. If the synced value changed by sync
                 // service, they may different. In that case, change wallpaper
                 // to the one saved in sync storage and update the local value.
-                if (localInfo == undefined ||
+                if (!localInfo ||
                     localInfo.url != syncInfo.url ||
                     localInfo.layout != syncInfo.layout ||
                     localInfo.source != syncInfo.source) {
                   if (syncInfo.source == Constants.WallpaperSourceEnum.Online) {
                     // TODO(bshe): Consider schedule an alarm to set online
                     // wallpaper later when failed. Note that we need to cancel
                     // the retry if user set another wallpaper before retry
                     // alarm invoked.
                     WallpaperUtil.setOnlineWallpaper(syncInfo.url,
                         syncInfo.layout, function() {}, function() {});
@@ skipping 34 matching lines @@
       }
     }
   });
 });
 
 chrome.alarms.onAlarm.addListener(function() {
   SurpriseWallpaper.getInstance().next();
 });
 
 chrome.wallpaperPrivate.onWallpaperChangedBy3rdParty.addListener(function(
-    wallpaper, thumbnail, layout) {
+    wallpaper, thumbnail, layout, appName) {
   WallpaperUtil.saveToLocalStorage(
       Constants.AccessLocalSurpriseMeEnabledKey, false, function() {
     WallpaperUtil.saveToSyncStorage(Constants.AccessSyncSurpriseMeEnabledKey,
                                     false);
   });
   SurpriseWallpaper.getInstance().disable();
 
   // Make third party wallpaper syncable through different devices.
-  // TODO(xdai): also sync the third party app name.
   var filename = Constants.ThirdPartyWallpaperPrefix + new Date().getTime();
   var thumbnailFilename = filename + Constants.CustomWallpaperThumbnailSuffix;
   WallpaperUtil.storeWallpaperToSyncFS(filename, wallpaper);
   WallpaperUtil.storeWallpaperToSyncFS(thumbnailFilename, thumbnail);
-  WallpaperUtil.saveWallpaperInfo(filename, layout,
-                                  Constants.WallpaperSourceEnum.Custom);
+  WallpaperUtil.saveWallpaperInfo(
+      filename, layout, Constants.WallpaperSourceEnum.Custom, appName);
 });