Make survey link configurable

User can disable the display of the survey in the helper menu.

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

config/opensearch_dashboards.yml

@@ -237,3 +237,5 @@
 #data_source.encryption.wrappingKeyName: 'changeme'
 #data_source.encryption.wrappingKeyNamespace: 'changeme'
 #data_source.encryption.wrappingKey: [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]
+
+#opensearchDashboards.isSurveyAllowed: true

src/core/public/chrome/chrome_service.tsx

@@ -262,6 +262,7 @@ export class ChromeService {
           onIsLockedUpdate={setIsNavDrawerLocked}
           isLocked$={getIsNavDrawerLocked$}
           branding={injectedMetadata.getBranding()}
+          isSurveyAllowed={injectedMetadata.getIsSurveyAllowed()}
         />
       ),
 

src/core/public/chrome/ui/header/header.test.tsx

@@ -75,6 +75,7 @@ function mockProps() {
       mark: { defaultUrl: '/' },
       applicationTitle: 'OpenSearch Dashboards',
     },
+    isSurveyAllowed: true,
   };
 }
 

src/core/public/chrome/ui/header/header.tsx

@@ -89,6 +89,7 @@ export interface HeaderProps {
   loadingCount$: ReturnType<HttpStart['getLoadingCount$']>;
   onIsLockedUpdate: OnIsLockedUpdate;
   branding: ChromeBranding;
+  isSurveyAllowed: boolean;
 }
 
 export function Header({
@@ -99,6 +100,7 @@ export function Header({
   onIsLockedUpdate,
   homeHref,
   branding,
+  isSurveyAllowed,
   ...observables
 }: HeaderProps) {
   const isVisible = useObservable(observables.isVisible$, false);
@@ -220,6 +222,7 @@ export function Header({
                   helpSupportUrl$={observables.helpSupportUrl$}
                   opensearchDashboardsDocLink={opensearchDashboardsDocLink}
                   opensearchDashboardsVersion={opensearchDashboardsVersion}
+                  isSurveyAllowed={isSurveyAllowed}
                 />
               </EuiHeaderSectionItem>
             </EuiHeaderSection>

src/core/public/chrome/ui/header/header_help_menu.tsx

@@ -126,6 +126,7 @@ interface Props {
   opensearchDashboardsVersion: string;
   useDefaultContent?: boolean;
   opensearchDashboardsDocLink: string;
+  isSurveyAllowed: boolean;
 }
 
 interface State {
@@ -202,8 +203,21 @@ class HeaderHelpMenuUI extends Component<Props, State> {
       opensearchDashboardsVersion,
       useDefaultContent,
       opensearchDashboardsDocLink,
+      isSurveyAllowed,
     } = this.props;
     const { helpExtension, helpSupportUrl } = this.state;
+    const opensearchSurvey = isSurveyAllowed ? (
+      <div>
+        <EuiButtonEmpty href={SATISFACTION_SURVEY_LINK} target="_blank" size="xs" flush="left">
+          <FormattedMessage
+            id="core.ui.chrome.headerGlobalNav.helpMenuSatisfactionSurveyTitle"
+            defaultMessage="Satisfaction Survey"
+          />
+        </EuiButtonEmpty>
+
+        <EuiSpacer size="xs" />
+      </div>
+    ) : null;
 
     const defaultContent = useDefaultContent ? (
       <Fragment>
@@ -225,14 +239,7 @@ class HeaderHelpMenuUI extends Component<Props, State> {
 
         <EuiSpacer size="xs" />
 
-        <EuiButtonEmpty href={SATISFACTION_SURVEY_LINK} target="_blank" size="xs" flush="left">
-          <FormattedMessage
-            id="core.ui.chrome.headerGlobalNav.helpMenuSatisfactionSurveyTitle"
-            defaultMessage="Satisfaction Survey"
-          />
-        </EuiButtonEmpty>
-
-        <EuiSpacer size="xs" />
+        {opensearchSurvey}
 
         <EuiButtonEmpty
           href={OPENSEARCH_DASHBOARDS_FEEDBACK_LINK}

src/core/public/injected_metadata/injected_metadata_service.mock.ts

@@ -45,6 +45,7 @@ const createSetupContractMock = () => {
     getInjectedVars: jest.fn(),
     getOpenSearchDashboardsBuildNumber: jest.fn(),
     getBranding: jest.fn(),
+    getIsSurveyAllowed: jest.fn(),
   };
   setupContract.getCspConfig.mockReturnValue({ warnLegacyBrowsers: true });
   setupContract.getOpenSearchDashboardsVersion.mockReturnValue('opensearchDashboardsVersion');

src/core/public/injected_metadata/injected_metadata_service.ts

@@ -75,6 +75,7 @@ export interface InjectedMetadataParams {
       };
     };
     branding: Branding;
+    isSurveyAllowed: boolean;
   };
 }
 
@@ -146,6 +147,10 @@ export class InjectedMetadataService {
       getBranding: () => {
         return this.state.branding;
       },
+
+      getIsSurveyAllowed: () => {
+        return this.state.isSurveyAllowed;
+      },
     };
   }
 }
@@ -180,6 +185,7 @@ export interface InjectedMetadataSetup {
     [key: string]: unknown;
   };
   getBranding: () => Branding;
+  getIsSurveyAllowed: () => boolean;
 }
 
 /** @internal */

src/core/server/opensearch_dashboards_config.ts

@@ -85,6 +85,9 @@ export const config = {
         defaultValue: true,
       }),
     }),
+    isSurveyAllowed: schema.boolean({
+      defaultValue: true,
+    }),
   }),
   deprecations,
 };

src/core/server/rendering/rendering_service.tsx

@@ -153,6 +153,7 @@ export class RenderingService {
               applicationTitle: brandingAssignment.applicationTitle,
               useExpandedHeader: brandingAssignment.useExpandedHeader,
             },
+            isSurveyAllowed: opensearchDashboardsConfig.isSurveyAllowed,
           },
         };
 

src/core/server/rendering/types.ts

@@ -74,6 +74,7 @@ export interface RenderingMetadata {
       };
     };
     branding: Branding;
+    isSurveyAllowed: boolean;
   };
 }
 

src/core/server/rendering/views/template.test.tsx

@@ -52,6 +52,7 @@ function mockProps() {
         },
       },
       branding: injectedMetadata.getBranding(),
+      isSurveyAllowed: injectedMetadata.getIsSurveyAllowed(),
     },
   };
 }

src/legacy/server/config/schema.js

@@ -247,6 +247,7 @@ export default () =>
         applicationTitle: Joi.any().default(''),
         useExpandedHeader: Joi.boolean().default(true),
       }),
+      isSurveyAllowed: Joi.boolean().default(true),
     }).default(),
 
     savedObjects: HANDLED_IN_NEW_PLATFORM,