Add global ai toggle to omnibar config (#1845)

Author: noisysocks

special-pages/pages/new-tab/app/omnibar/components/OmnibarConsumer.js

@@ -35,13 +35,17 @@ export function OmnibarConsumer() {
  * @param {object} props
  * @param {OmnibarConfig} props.config
  */
-function OmnibarReadyState({ config: { enableAi = true, mode } }) {
+function OmnibarReadyState({ config: { enableAi = true, showAiSetting = true, mode } }) {
     const { t } = useTypedTranslationWith(/** @type {Strings} */ ({}));
 
     const { settingsLinks } = useContext(CustomizerContext);
     const { setMode, setEnableAi } = useContext(OmnibarContext);
 
     useEffect(() => {
+        if (!showAiSetting) {
+            return;
+        }
+
         settingsLinks.value = {
             ...settingsLinks.value,
             duckAi: {
@@ -54,7 +58,7 @@ function OmnibarReadyState({ config: { enableAi = true, mode } }) {
             const { duckAi: _, ...rest } = settingsLinks.value;
             settingsLinks.value = rest;
         };
-    }, [enableAi]);
+    }, [enableAi, showAiSetting]);
 
     return <Omnibar mode={mode} setMode={setMode} enableAi={enableAi} />;
 }

special-pages/pages/new-tab/app/omnibar/integration-tests/omnibar.spec.js

@@ -272,6 +272,22 @@ test.describe('omnibar widget', () => {
         await expect(omnibar.hideDuckAiButton()).toHaveCount(0);
     });
 
+    test('Duck.ai toggle is hidden when showAiSetting is false', async ({ page }, workerInfo) => {
+        const ntp = NewtabPage.create(page, workerInfo);
+        const omnibar = new OmnibarPage(ntp);
+        await ntp.reducedMotion();
+
+        await ntp.openPage({ additional: { omnibar: true, 'omnibar.showAiSetting': false } });
+        await omnibar.ready();
+
+        // Open Customize panel
+        await omnibar.customizeButton().click();
+
+        // The Duck.ai toggle button should not be visible
+        await expect(omnibar.hideDuckAiButton()).toHaveCount(0);
+        await expect(omnibar.showDuckAiButton()).toHaveCount(0);
+    });
+
     test('suggestions list arrow down navigation', async ({ page }, workerInfo) => {
         const ntp = NewtabPage.create(page, workerInfo);
         const omnibar = new OmnibarPage(ntp);

special-pages/pages/new-tab/app/omnibar/mocks/omnibar.mock-transport.js

@@ -50,6 +50,10 @@ export function omnibarMockTransport() {
                     if (enableAiOverride === 'true' || enableAiOverride === 'false') {
                         config.enableAi = enableAiOverride === 'true';
                     }
+                    const showAiSettingOverride = url.searchParams.get('omnibar.showAiSetting');
+                    if (showAiSettingOverride === 'true' || showAiSettingOverride === 'false') {
+                        config.showAiSetting = showAiSettingOverride === 'true';
+                    }
                     return config;
                 }
                 case 'omnibar_getSuggestions': {

special-pages/pages/new-tab/integration-tests/new-tab.page.js

@@ -49,7 +49,7 @@ export class NewtabPage {
             nextSteps_getData: {},
             rmf_getData: {},
             widgets_setConfig: {},
-            omnibar_getConfig: { mode: 'search', enableAi: false },
+            omnibar_getConfig: { mode: 'search', enableAi: false, showAiSetting: true },
             omnibar_getSuggestions: { suggestions: { topHits: [], duckduckgoSuggestions: [], localSuggestions: [] } },
             omnibar_setConfig: {},
             omnibar_openSuggestion: {},

special-pages/pages/new-tab/messages/types/omnibar-config.json

@@ -15,6 +15,11 @@
       "title": "Enable Duck.ai",
       "type": "boolean",
       "default": true
+    },
+    "showAiSetting": {
+      "title": "Show Duck.ai Setting",
+      "type": "boolean",
+      "default": true
     }
   }
 }

special-pages/pages/new-tab/types/new-tab.ts

@@ -64,6 +64,7 @@ export type Suggestion =
   | InternalPageSuggestion;
 export type OmnibarMode = "search" | "ai";
 export type EnableDuckAi = boolean;
+export type ShowDuckAiSetting = boolean;
 export type FeedType = "privacy-stats" | "activity";
 /**
  * The visibility state of the widget, as configured by the user
@@ -507,6 +508,7 @@ export interface OmnibarSetConfigNotification {
 export interface OmnibarConfig {
   mode: OmnibarMode;
   enableAi?: EnableDuckAi;
+  showAiSetting?: ShowDuckAiSetting;
 }
 /**
  * Generated from @see "../messages/omnibar_submitChat.notify.json"