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);
     }
@@ -33,8 +36,10 @@ class ZenSessionStore extends nsZenPreloadedFeature {
     if (tabData.zenEssential) {
       tab.setAttribute("zen-essential", "true");
     }
-    if (tabData.zenDefaultUserContextId) {
+    if (tabData.zenDefaultUserContextId && !(tabData.userContextId || 0)) {
       tab.setAttribute("zenDefaultUserContextId", "true");
+    } else {
+      tab.removeAttribute("zenDefaultUserContextId");
     }
     if (tabData._zenPinnedInitialState) {
       tab._zenPinnedInitialState = tabData._zenPinnedInitialState;

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,13 @@ export class nsZenFolder extends MozTabbrowserTabGroup {
   }
 
   async delete() {
+    if (this.id) {
+      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

@@ -4,6 +4,11 @@
 
 import { nsZenDOMOperatedFeature } from "chrome://browser/content/zen-components/ZenCommonUtils.mjs";
 
+const lazy = {};
+ChromeUtils.defineESModuleGetters(lazy, {
+  SessionSaver: "resource:///modules/sessionstore/SessionSaver.sys.mjs",
+});
+
 function formatRelativeTime(timestamp) {
   const now = Date.now();
 
@@ -317,6 +322,14 @@ class nsZenFolders extends nsZenDOMOperatedFeature {
     if (groupIsCollapsiblePins(group)) {
       return;
     }
+    // Mark tab as modified for sync when its folder membership changes.
+    if (tab.id && group?.isZenFolder) {
+      Services.obs.notifyObservers(
+        null,
+        "zen-workspace-item-changed",
+        `t~${tab.id}`
+      );
+    }
     group.pinned = tab.pinned;
     const isActiveFolder = group?.activeGroups?.length > 0;
 
@@ -361,6 +374,15 @@ class nsZenFolders extends nsZenDOMOperatedFeature {
       ].sort((a, b) => a._tPos > b._tPos);
     }
     parentFolder.collapsed = isActiveFolder;
+    if (folder?.id) {
+      Services.obs.notifyObservers(
+        null,
+        "zen-workspace-item-changed",
+        `f~${folder.id}`
+      );
+      folder.dispatchEvent(new CustomEvent("TabGroupMoved", { bubbles: true }));
+      void lazy.SessionSaver.run();
+    }
   }
 
   on_FolderUngrouped(event) {
@@ -372,6 +394,15 @@ class nsZenFolders extends nsZenDOMOperatedFeature {
     for (const tab of folder.tabs) {
       this.animateUnload(parentFolder, tab, true);
     }
+    if (folder?.id) {
+      Services.obs.notifyObservers(
+        null,
+        "zen-workspace-item-changed",
+        `f~${folder.id}`
+      );
+      folder.dispatchEvent(new CustomEvent("TabGroupMoved", { bubbles: true }));
+      void lazy.SessionSaver.run();
+    }
   }
 
   async on_TabSelect(event) {
@@ -412,6 +443,14 @@ class nsZenFolders extends nsZenDOMOperatedFeature {
   async on_TabUngrouped(event) {
     const tab = event.detail;
     const group = event.target;
+    // Mark tab as modified for sync when its folder membership changes.
+    if (tab.id && group?.isZenFolder) {
+      Services.obs.notifyObservers(
+        null,
+        "zen-workspace-item-changed",
+        `t~${tab.id}`
+      );
+    }
     if (
       group.hasAttribute("split-view-group") &&
       tab.hasAttribute("had-zen-pinned-changed")
@@ -641,16 +680,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 +725,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/moz.build

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