Bug 989338 - save non-placement stuff from previously saved placements, r=Unfocused

browser/components/customizableui/CustomizableUI.jsm

@@ -1845,12 +1845,25 @@ let CustomizableUIInternal = {
     if (gInBatchStack || !gDirty) {
       return;
     }
-    let state = { placements: gPlacements,
+    // Clone because we want to modify this map:
+    let state = { placements: new Map(gPlacements),
                   seen: gSeenWidgets,
                   dirtyAreaCache: gDirtyAreaCache,
                   currentVersion: kVersion,
                   newElementCount: gNewElementCount };
 
+    // Merge in previously saved areas if not present in gPlacements.
+    // This way, state is still persisted for e.g. temporarily disabled
+    // add-ons - see bug 989338.
+    if (gSavedState && gSavedState.placements) {
+      for (let area of Object.keys(gSavedState.placements)) {
+        if (!state.placements.has(area)) {
+          let placements = gSavedState.placements[area];
+          state.placements.set(area, placements);
+        }
+      }
+    }
+
     LOG("Saving state.");
     let serialized = JSON.stringify(state, this.serializerHelper);
     LOG("State saved as: " + serialized);

browser/components/customizableui/test/browser.ini

@@ -104,6 +104,7 @@ skip-if = os == "linux"
 [browser_985815_propagate_setToolbarVisibility.js]
 [browser_981305_separator_insertion.js]
 [browser_988072_sidebar_events.js]
+[browser_989338_saved_placements_not_resaved.js]
 [browser_989751_subviewbutton_class.js]
 [browser_987177_destroyWidget_xul.js]
 [browser_987177_xul_wrapper_updating.js]

browser/components/customizableui/test/browser_989338_saved_placements_not_resaved.js

@@ -0,0 +1,56 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+"use strict";
+
+const BUTTONID = "test-widget-saved-earlier";
+const AREAID = "test-area-saved-earlier";
+
+let hadSavedState;
+function test() {
+  // Hack our way into the module to fake a saved state that isn't there...
+  let backstagePass = Cu.import("resource:///modules/CustomizableUI.jsm", {});
+  hadSavedState = backstagePass.gSavedState != null;
+  if (!hadSavedState) {
+    backstagePass.gSavedState = {placements: {}};
+  }
+  backstagePass.gSavedState.placements[AREAID] = [BUTTONID];
+  // Put bogus stuff in the saved state for the nav-bar, so as to check the current placements
+  // override this one...
+  backstagePass.gSavedState.placements[CustomizableUI.AREA_NAVBAR] = ["bogus-navbar-item"];
+
+  backstagePass.gDirty = true;
+  backstagePass.CustomizableUIInternal.saveState();
+
+  let newSavedState = JSON.parse(Services.prefs.getCharPref("browser.uiCustomization.state"));
+  let savedArea = Array.isArray(newSavedState.placements[AREAID]);
+  ok(savedArea, "Should have re-saved the state, even though the area isn't registered");
+
+  if (savedArea) {
+    placementArraysEqual(AREAID, newSavedState.placements[AREAID], [BUTTONID]);
+  }
+  ok(!backstagePass.gPlacements.has(AREAID), "Placements map shouldn't have been affected");
+
+  let savedNavbar = Array.isArray(newSavedState.placements[CustomizableUI.AREA_NAVBAR]);
+  ok(savedNavbar, "Should have saved nav-bar contents");
+  if (savedNavbar) {
+    placementArraysEqual(CustomizableUI.AREA_NAVBAR, newSavedState.placements[CustomizableUI.AREA_NAVBAR],
+                         CustomizableUI.getWidgetIdsInArea(CustomizableUI.AREA_NAVBAR));
+  }
+};
+
+registerCleanupFunction(function() {
+  let backstagePass = Cu.import("resource:///modules/CustomizableUI.jsm", {});
+  if (!hadSavedState) {
+    backstagePass.gSavedState = null;
+  } else {
+    let savedPlacements = backstagePass.gSavedState.placements;
+    delete savedPlacements[AREAID];
+    let realNavBarPlacements = CustomizableUI.getWidgetIdsInArea(CustomizableUI.AREA_NAVBAR);
+    savedPlacements[CustomizableUI.AREA_NAVBAR] = realNavBarPlacements;
+  }
+  backstagePass.gDirty = true;
+  backstagePass.CustomizableUIInternal.saveState();
+});
+