gh-8460: Workspaces sync [2.0]

src/browser/components/preferences/sync-js.patch

@@ -0,0 +1,20 @@
+diff --git a/browser/components/preferences/sync.js b/browser/components/preferences/sync.js
+index dc89a9c41a0dbd44054ede0025d333773f0ae908..7fd91bd704b3b187277e4c8b076f990cb56ea8dc 100644
+--- a/browser/components/preferences/sync.js
++++ b/browser/components/preferences/sync.js
+@@ -40,6 +40,7 @@ Preferences.addAll([
+   { id: "services.sync.engine.creditcards", type: "bool" },
+   { id: "services.sync.engine.addons", type: "bool" },
+   { id: "services.sync.engine.prefs", type: "bool" },
++  { id: "services.sync.engine.workspaces", type: "bool" },
+ ]);
+
+ /**
+@@ -512,6 +513,7 @@ const SYNC_ENGINE_SETTINGS = [
+   },
+   { id: "syncAddons", pref: "services.sync.engine.addons", type: "addons" },
+   { id: "syncSettings", pref: "services.sync.engine.prefs", type: "settings" },
++  { id: "syncWorkspaces", pref: "services.sync.engine.workspaces", type: "workspaces" },
+ ];
+
+ SYNC_ENGINE_SETTINGS.forEach(({ id, pref }) => {

src/services/sync/modules/service-sys-mjs.patch

@@ -0,0 +1,15 @@
+diff --git a/services/sync/modules/service.sys.mjs b/services/sync/modules/service.sys.mjs
+index c873293871ffaba305bc1bf41730d79c13546b85..0e0171cec13dfcbb296ec7bf03628370ce2fa93f 100644
+--- a/services/sync/modules/service.sys.mjs
++++ b/services/sync/modules/service.sys.mjs
+@@ -99,6 +99,10 @@ function getEngineModules() {
+     whenTrue: "ExtensionStorageEngineKinto",
+     whenFalse: "ExtensionStorageEngineBridge",
+   };
++  result.Workspaces = {
++    module: "resource:///modules/zen/ZenWorkspacesSync.sys.mjs",
++    symbol: "ZenWorkspacesEngine",
++  };
+   return result;
+ }
+

src/toolkit/components/contextualidentity/ContextualIdentityService-sys-mjs.patch

@@ -0,0 +1,19 @@
+diff --git a/toolkit/components/contextualidentity/ContextualIdentityService.sys.mjs b/toolkit/components/contextualidentity/ContextualIdentityService.sys.mjs
+index 5702ff28cc22206f5ce16584dac8a78d816562ce..2132ee9ad8f553b3effeb7c4386e5fae46b80507 100644
+--- a/toolkit/components/contextualidentity/ContextualIdentityService.sys.mjs
++++ b/toolkit/components/contextualidentity/ContextualIdentityService.sys.mjs
+@@ -270,11 +270,11 @@ _ContextualIdentityService.prototype = {
+     });
+   },
+
+-  create(name, icon, color) {
++  create(name, icon, color, id = null) {
+     this.ensureDataReady();
+
+-    // Retrieve the next userContextId available.
+-    let userContextId = ++this._lastUserContextId;
++    // If explicit ID is provided, use it if it's not already in use, otherwise use the next available ID.
++    let userContextId = id !== null && !this._identities.some(i => i.userContextId === id) ? id : ++this._lastUserContextId;
+
+     // Throw an error if the next userContextId available is invalid (the one associated to
+     // MAX_USER_CONTEXT_ID is already reserved to "userContextIdInternal.webextStorageLocal", which

src/zen/common/modules/ZenSessionStore.mjs

@@ -14,6 +14,9 @@ class ZenSessionStore extends nsZenPreloadedFeature {
   });
 
   restoreInitialTabData(tab, tabData) {
+    if (typeof tab.setUserContextId === "function") {
+      tab.setUserContextId(tabData.userContextId || 0);
+    }
     if (tabData.zenWorkspace) {
       tab.setAttribute("zen-workspace-id", tabData.zenWorkspace);
     }

src/zen/folders/ZenFolder.mjs

@@ -80,7 +80,7 @@ export class nsZenFolder extends MozTabbrowserTabGroup {
 
     this.labelElement.onRenameFinished = newLabel => {
       this.name = newLabel.trim() || "Folder";
-      const event = new CustomEvent("ZenFolderRenamed", {
+      const event = new CustomEvent("TabGroupUpdate", {
         bubbles: true,
       });
       this.dispatchEvent(event);
@@ -172,6 +172,11 @@ export class nsZenFolder extends MozTabbrowserTabGroup {
   }
 
   async delete() {
+    Services.obs.notifyObservers(
+      null,
+      "zen-workspace-item-changed",
+      `f~${this.id}`
+    );
     for (const tab of this.allItemsRecursive) {
       if (tab.hasAttribute("zen-empty-tab")) {
         // Manually remove the empty tabs as removeTabs() inside removeTabGroup

src/zen/folders/ZenFolders.mjs

@@ -641,16 +641,22 @@ class nsZenFolders extends nsZenDOMOperatedFeature {
     const insertBefore =
       options.insertBefore ||
       pinnedContainer.querySelector(".pinned-tabs-container-separator");
-    const emptyTab = gBrowser.addTab("about:blank", {
-      skipAnimation: true,
-      pinned: true,
-      triggeringPrincipal: Services.scriptSecurityManager.getSystemPrincipal(),
-      _forZenEmptyTab: true,
-      createLazyBrowser: true,
-    });
 
-    gBrowser.pinTab(emptyTab);
-    tabs = [emptyTab, ...filteredTabs];
+    if (!options.skipEmptyTab) {
+      const emptyTab = gBrowser.addTab("about:blank", {
+        skipAnimation: true,
+        pinned: true,
+        triggeringPrincipal:
+          Services.scriptSecurityManager.getSystemPrincipal(),
+        _forZenEmptyTab: true,
+        createLazyBrowser: true,
+      });
+
+      gBrowser.pinTab(emptyTab);
+      tabs = [emptyTab, ...filteredTabs];
+    } else {
+      tabs = filteredTabs;
+    }
 
     const folder = this._createFolderNode(options);
 
@@ -680,6 +686,13 @@ class nsZenFolders extends nsZenDOMOperatedFeature {
     }
 
     this.#groupInit(folder);
+    if (folder.id) {
+      Services.obs.notifyObservers(
+        null,
+        "zen-workspace-item-changed",
+        `f~${folder.id}`
+      );
+    }
     return folder;
   }
 

src/zen/live-folders/ZenLiveFoldersManager.sys.mjs

@@ -467,9 +467,6 @@ class nsZenLiveFoldersManager {
         });
         // createLazyBrowser can't be pinned by default
         this.window.gBrowser.pinTab(tab);
-        if (userContextId) {
-          tab.setAttribute("zenDefaultUserContextId", "true");
-        }
         if (item.icon) {
           this.window.gBrowser.setIcon(tab, item.icon);
           if (tab.linkedBrowser) {
@@ -496,6 +493,9 @@ class nsZenLiveFoldersManager {
     // Wait for tabs to (hopefully) be initialized on all windows
     lazy.setTimeout(() => {
       folder.addTabs(newItems);
+      for (const tab of newItems) {
+        this.window.gZenPinnedTabManager?.syncDefaultUserContextId(tab);
+      }
       this.saveState();
     }, 0);
   }

src/zen/moz.build

@@ -19,4 +19,5 @@ DIRS += [
     "sessionstore",
     "share",
     "spaces",
+    "sync"
 ]

src/zen/sessionstore/ZenSessionManager.sys.mjs

@@ -10,6 +10,7 @@ const lazy = {};
 ChromeUtils.defineESModuleGetters(lazy, {
   ZenLiveFoldersManager:
     "resource:///modules/zen/ZenLiveFoldersManager.sys.mjs",
+  ZenSyncStore: "resource:///modules/zen/ZenSyncManager.sys.mjs",
   PrivateBrowsingUtils: "resource://gre/modules/PrivateBrowsingUtils.sys.mjs",
   SessionStore: "resource:///modules/sessionstore/SessionStore.sys.mjs",
   SessionStartup: "resource:///modules/sessionstore/SessionStartup.sys.mjs",
@@ -312,6 +313,7 @@ export class nsZenSessionManager {
       }
     }
     delete this._dataFromFile;
+    lazy.ZenSyncStore.seedSnapshot(this.#sidebar);
   }
 
   get #shouldRestoreOnlyPinned() {
@@ -609,7 +611,7 @@ export class nsZenSessionManager {
       }
     );
     this.#collectWindowData(windows);
-    // This would save the data to disk asynchronously or when quitting the app.
+    lazy.ZenSyncStore.noteSidebarDataChanged(this.#sidebar);
     let sidebar = this.#sidebarWithoutCloning;
     this.#file.data = sidebar;
     if (soon) {
@@ -724,6 +726,7 @@ export class nsZenSessionManager {
 
     sidebarData.lastCollected = Date.now();
     this.#collectTabsData(sidebarData, aStateWindows);
+
     this.#sidebar = sidebarData;
   }
 
@@ -933,6 +936,43 @@ export class nsZenSessionManager {
     }
     return Cu.cloneInto(sidebar.spaces, {});
   }
+
+  /**
+   * Returns a deep clone of the full sidebar object (spaces, tabs, folders, etc.).
+   * Used by the ZenWorkspacesSync engine to build the sync payload.
+   *
+   * @returns {object} A deep clone of the sidebar data.
+   */
+  getSidebarData() {
+    const sidebar = this.#sidebar;
+    if (!sidebar) {
+      return {};
+    }
+    return JSON.parse(JSON.stringify(sidebar));
+  }
+
+  replaceSidebarData(sidebar, soon = true) {
+    this.#sidebar = sidebar || {};
+    this.#file.data = this.#sidebarWithoutCloning;
+    if (soon) {
+      this.#file.saveSoon();
+    } else {
+      this.#file._save();
+    }
+  }
+
+  getCurrentSidebarData() {
+    const state = lazy.SessionStore.getCurrentState(true);
+    let windows = state?.windows || [];
+    windows = windows.filter(win => this.#isWindowSaveable(win));
+    if (!windows.length) {
+      return this.getSidebarData();
+    }
+
+    const sidebarData = { lastCollected: Date.now() };
+    this.#collectTabsData(sidebarData, windows);
+    return JSON.parse(JSON.stringify(sidebarData));
+  }
 }
 
 export const ZenSessionStore = new nsZenSessionManager();