Bug 1940476 - Add triggers for "Tab group created" and "Tab group closed" events; and targeting for counting tab groups r=dao,omc-reviewers,aminomancer,negin

Differential Revision: https://phabricator.services.mozilla.com/D233953

Author: AllegroFox

browser/components/asrouter/docs/targeting-attributes.md

@@ -21,6 +21,7 @@ Please note that some targeting attributes require stricter controls on the tele
 * [canCreateSelectableProfiles](#cancreateselectableprofiles)
 * [creditCardsSaved](#creditcardssaved)
 * [currentDate](#currentdate)
+* [currentTabGroups](#currentTabGroups)
 * [defaultPDFHandler](#defaultpdfhandler)
 * [devToolsOpenedCount](#devtoolsopenedcount)
 * [distributionId](#distributionid)
@@ -67,6 +68,7 @@ Please note that some targeting attributes require stricter controls on the tele
 * [providerCohorts](#providercohorts)
 * [recentBookmarks](#recentbookmarks)
 * [region](#region)
+* [savedTabGroups](#savedtabgroups)
 * [screenImpressions](#screenimpressions)
 * [searchEngines](#searchengines)
 * [sync](#sync)
@@ -620,6 +622,13 @@ Pref used by system administrators to disallow add-ons from installed altogether
 ```ts
 declare const xpinstallEnabled: boolean;
 ```
+### `currentTabGroups`
+
+Returns the number of currently open tab groups.
+
+### `savedTabGroups`
+
+Returns the number of tab groups the user has saved.
 
 ### `hasPinnedTabs`
 

browser/components/asrouter/modules/ASRouterTargeting.sys.mjs

@@ -53,6 +53,7 @@ ChromeUtils.defineESModuleGetters(lazy, {
   // eslint-disable-next-line mozilla/no-browser-refs-in-toolkit
   SelectableProfileService:
     "resource:///modules/profiles/SelectableProfileService.sys.mjs",
+  SessionStore: "resource:///modules/sessionstore/SessionStore.sys.mjs",
   TargetingContext: "resource://messaging-system/targeting/Targeting.sys.mjs",
   TelemetryEnvironment: "resource://gre/modules/TelemetryEnvironment.sys.mjs",
   TelemetrySession: "resource://gre/modules/TelemetrySession.sys.mjs",
@@ -748,6 +749,18 @@ const TargetingGetters = {
   get needsUpdate() {
     return QueryCache.queries.CheckBrowserNeedsUpdate.get();
   },
+  get savedTabGroups() {
+    return lazy.SessionStore.getSavedTabGroups().length;
+  },
+  get currentTabGroups() {
+    let win = lazy.BrowserWindowTracker.getTopWindow();
+    // If there's no window, there can't be any current tab groups.
+    if (!win) {
+      return 0;
+    }
+    let totalTabGroups = win.gBrowser.getAllTabGroups().length;
+    return totalTabGroups;
+  },
   get hasPinnedTabs() {
     for (let win of Services.wm.getEnumerator("navigator:browser")) {
       if (win.closed || !win.ownerGlobal.gBrowser) {

browser/components/asrouter/modules/ASRouterTriggerListeners.sys.mjs

@@ -865,6 +865,104 @@ export const ASRouterTriggerListeners = new Map([
       },
     },
   ],
+  [
+    "tabGroupCreated",
+    {
+      id: "tabGroupCreated",
+      _initialized: false,
+      _triggerHandler: null,
+      // Number of tab groups the user created this session
+      _tabGroupsCreated: 0,
+
+      init(triggerHandler) {
+        this._triggerHandler = triggerHandler;
+        if (!this._initialized) {
+          lazy.EveryWindow.registerCallback(
+            this.id,
+            win => {
+              win.addEventListener("TabGroupCreateDone", this);
+            },
+            win => {
+              win.removeEventListener("TabGroupCreateDone", this);
+            }
+          );
+          this._initialized = true;
+        }
+      },
+      handleEvent(event) {
+        if (this._initialized) {
+          if (!event.target.ownerGlobal.gBrowser) {
+            return;
+          }
+          const { gBrowser } = event.target.ownerGlobal;
+          this._tabGroupsCreated++;
+          this._triggerHandler(gBrowser.selectedBrowser, {
+            id: this.id,
+            context: {
+              tabGroupsCreatedCount: this._tabGroupsCreated,
+            },
+          });
+        }
+      },
+      uninit() {
+        if (this._initialized) {
+          lazy.EveryWindow.unregisterCallback(this.id);
+          this._initialized = false;
+          this._triggerHandler = null;
+          this._tabGroupsCreated = 0;
+        }
+      },
+    },
+  ],
+  [
+    "tabGroupClosed",
+    {
+      id: "tabGroupClosed",
+      _initialized: false,
+      _triggerHandler: null,
+      // Number of tab groups the user closed this session
+      _tabGroupsClosed: 0,
+
+      init(triggerHandler) {
+        this._triggerHandler = triggerHandler;
+        if (!this._initialized) {
+          lazy.EveryWindow.registerCallback(
+            this.id,
+            win => {
+              win.addEventListener("TabGroupRemoved", this);
+            },
+            win => {
+              win.removeEventListener("TabGroupRemoved", this);
+            }
+          );
+          this._initialized = true;
+        }
+      },
+      handleEvent(event) {
+        if (this._initialized) {
+          if (!event.target.ownerGlobal.gBrowser) {
+            return;
+          }
+          const { gBrowser } = event.target.ownerGlobal;
+          this._tabGroupsClosed++;
+          this._triggerHandler(gBrowser.selectedBrowser, {
+            id: this.id,
+            context: {
+              tabGroupsClosedCount: this._tabGroupsClosed,
+            },
+          });
+        }
+      },
+      uninit() {
+        if (this._initialized) {
+          lazy.EveryWindow.unregisterCallback(this.id);
+          this._initialized = false;
+          this._triggerHandler = null;
+          this._tabGroupsClosed = 0;
+        }
+      },
+    },
+  ],
   [
     "activityAfterIdle",
     {

browser/components/asrouter/modules/PanelTestProvider.sys.mjs

@@ -19,6 +19,61 @@ const isMSIX =
   Services.sysinfo.getProperty("hasWinPackageId", false);
 
 const MESSAGES = () => [
+  {
+    id: "CLOSE_TAB_GROUP_TEST_CALLOUT",
+    template: "feature_callout",
+    groups: ["cfr"],
+    content: {
+      id: "CLOSE_TAB_GROUP_TEST_CALLOUT",
+      template: "multistage",
+      backdrop: "transparent",
+      transitions: false,
+      screens: [
+        {
+          id: "CLOSE_TAB_GROUP_TEST_CALLOUT",
+          anchors: [
+            {
+              selector: "#alltabs-button",
+              panel_position: {
+                anchor_attachment: "bottomcenter",
+                callout_attachment: "topright",
+              },
+            },
+          ],
+          content: {
+            position: "callout",
+            padding: 16,
+            width: "412px",
+            title_logo: {
+              imageURL:
+                "chrome://browser/content/asrouter/assets/smiling-fox-icon.svg",
+              width: "24px",
+              height: "24px",
+              marginInline: "0 16px",
+            },
+            title: {
+              raw: "If you close a tab group, you can reopen it here anytime.",
+            },
+            primary_button: {
+              label: {
+                raw: "Got it",
+              },
+              action: {
+                dismiss: true,
+              },
+            },
+          },
+        },
+      ],
+    },
+    targeting: "tabGroupsClosedCount == 1",
+    trigger: {
+      id: "tabGroupClosed",
+    },
+    frequency: {
+      lifetime: 1,
+    },
+  },
   {
     id: "CONTENT_TILES_TEST",
     targeting: 'providerCohorts.panel_local_testing == "SHOW_TEST"',

browser/components/asrouter/tests/xpcshell/test_PanelTestProvider.js

@@ -23,7 +23,7 @@ add_task(async function test_PanelTestProvider() {
     milestone_message: 0,
     update_action: 1,
     spotlight: 6,
-    feature_callout: 4,
+    feature_callout: 5,
     pb_newtab: 2,
     toast_notification: 3,
     bookmarks_bar_button: 1,

toolkit/components/messaging-system/schemas/TriggerActionSchemas/index.md

@@ -52,6 +52,8 @@ let patterns: string[];
 - [`newtabFeatureCalloutCheck`](#newtabfeaturecalloutcheck)
 - [`nthTabClosed`](#nthtabclosed)
 - [`nthTabOpened`](#nthtabopened)
+- [`tabGroupCreated`](#tabgroupcreated)
+- [`tabGroupClosed`](#tabgroupclosed)
 - [`activityAfterIdle`](#activityafteridle)
 - [`cookieBannerDetected`](#cookiebannerdetected)
 - [`cookieBannerHandled`](#cookiebannerhandled)
@@ -254,6 +256,45 @@ Happens when the user opens n or more tabs in a session
 }
 ```
 
+### `tabGroupCreated`
+
+Happens whenever a user creates a tab group.
+
+```js
+{
+  trigger: { id: "tabGroupCreated" }
+}
+```
+```js
+// The trigger can also track the number or tab groups created in a
+// session, by including the tabGroupsCreatedCount context variable in targeting.
+// Here, the message triggers once two or more tab groups have been created,
+// even if the tabs were closed in between.
+{
+  trigger: { id: "tabGroupCreated" },
+  targeting: { "tabGroupsCreatedCount >= 2" }
+}
+```
+
+### `tabGroupClosed`
+
+Happens whenever a user uses the "Save and Close" action on a tab group.
+
+```js
+{
+  trigger: { id: "tabGroupClosed" }
+}
+```
+```js
+// The trigger can also track the number or tab groups closed in a
+// session, by including the tabGroupsClosedCount context variable in targeting.
+// Here, the message triggers once two tab groups have been saved and closed.
+{
+  trigger: { id: "tabGroupClosed" },
+  targeting: { "tabGroupsClosedCount >= 2" }
+}
+```
+
 ### `activityAfterIdle`
 
 Happens when the user resumes activity after n milliseconds of inactivity. Keyboard/mouse interactions and audio playback count as activity. The idle timer is reset when the OS is put to sleep or wakes from sleep.