Update insecure cluster warning message (#80344) (#80434)

elastic · Oct 14, 2020 · ce70009 · ce70009
1 parent 06a69b9
commit ce70009
Show file tree

Hide file tree

Showing 6 changed files with 75 additions and 16 deletions.
diff --git a/src/plugins/security_oss/public/insecure_cluster_service/components/default_alert.tsx b/src/plugins/security_oss/public/insecure_cluster_service/components/default_alert.tsx
@@ -32,7 +32,7 @@ import React, { useState } from 'react';
 import { render, unmountComponentAtNode } from 'react-dom';
 
 export const defaultAlertTitle = i18n.translate('security.checkup.insecureClusterTitle', {
-  defaultMessage: 'Please secure your installation',
+  defaultMessage: 'Your data is not secure',
 });
 
 export const defaultAlertText: (onDismiss: (persist: boolean) => void) => MountPoint = (
@@ -47,7 +47,7 @@ export const defaultAlertText: (onDismiss: (persist: boolean) => void) => MountP
           <EuiText size="s">
             <FormattedMessage
               id="security.checkup.insecureClusterMessage"
-              defaultMessage="Our free security features can protect against unauthorized access."
+              defaultMessage="Don't lose one bit. Secure your data for free with Elastic."
             />
           </EuiText>
           <EuiSpacer />
@@ -66,7 +66,7 @@ export const defaultAlertText: (onDismiss: (persist: boolean) => void) => MountP
                 size="s"
                 color="primary"
                 fill
-                href="https://www.elastic.co/what-is/elastic-stack-security"
+                href="https://www.elastic.co/what-is/elastic-stack-security?blade=kibanasecuritymessage"
                 target="_blank"
               >
                 {i18n.translate('security.checkup.learnMoreButtonText', {

diff --git a/x-pack/plugins/security/public/plugin.tsx b/x-pack/plugins/security/public/plugin.tsx
@@ -147,7 +147,7 @@ export class SecurityPlugin
   public start(core: CoreStart, { management, securityOss }: PluginStartDependencies) {
     this.sessionTimeout.start();
     this.navControlService.start({ core });
-    this.securityCheckupService.start({ securityOssStart: securityOss });
+    this.securityCheckupService.start({ securityOssStart: securityOss, docLinks: core.docLinks });
     if (management) {
       this.managementService.start({ capabilities: core.application.capabilities });
     }

diff --git a/x-pack/plugins/security/public/security_checkup/components/insecure_cluster_alert.tsx b/x-pack/plugins/security/public/security_checkup/components/insecure_cluster_alert.tsx
@@ -16,13 +16,17 @@ import {
   EuiFlexItem,
   EuiButton,
 } from '@elastic/eui';
+import { DocumentationLinksService } from '../documentation_links';
 
 export const insecureClusterAlertTitle = i18n.translate(
   'xpack.security.checkup.insecureClusterTitle',
-  { defaultMessage: 'Please secure your installation' }
+  { defaultMessage: 'Your data is not secure' }
 );
 
-export const insecureClusterAlertText = (onDismiss: (persist: boolean) => void) =>
+export const insecureClusterAlertText = (
+  getDocLinksService: () => DocumentationLinksService,
+  onDismiss: (persist: boolean) => void
+) =>
   ((e) => {
     const AlertText = () => {
       const [persist, setPersist] = useState(false);
@@ -33,7 +37,7 @@ export const insecureClusterAlertText = (onDismiss: (persist: boolean) => void)
             <EuiText size="s">
               <FormattedMessage
                 id="xpack.security.checkup.insecureClusterMessage"
-                defaultMessage="Our free security features can protect against unauthorized access."
+                defaultMessage="Don’t lose one bit. Enable our free security features."
               />
             </EuiText>
             <EuiSpacer />
@@ -52,8 +56,9 @@ export const insecureClusterAlertText = (onDismiss: (persist: boolean) => void)
                   size="s"
                   color="primary"
                   fill
-                  href="https://www.elastic.co/what-is/elastic-stack-security"
+                  href={getDocLinksService().getEnableSecurityDocUrl()}
                   target="_blank"
+                  data-test-subj="learnMoreButton"
                 >
                   {i18n.translate('xpack.security.checkup.enableButtonText', {
                     defaultMessage: `Enable security`,

diff --git a/x-pack/plugins/security/public/security_checkup/documentation_links.ts b/x-pack/plugins/security/public/security_checkup/documentation_links.ts
@@ -0,0 +1,19 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import { DocLinksStart } from 'src/core/public';
+
+export class DocumentationLinksService {
+  private readonly esDocBasePath: string;
+
+  constructor(docLinks: DocLinksStart) {
+    this.esDocBasePath = `${docLinks.ELASTIC_WEBSITE_URL}guide/en/elasticsearch/reference/${docLinks.DOC_LINK_VERSION}`;
+  }
+
+  public getEnableSecurityDocUrl() {
+    return `${this.esDocBasePath}/get-started-enable-security.html?blade=kibanasecuritymessage`;
+  }
+}
diff --git a/x-pack/plugins/security/public/security_checkup/security_checkup_service.test.ts b/x-pack/plugins/security/public/security_checkup/security_checkup_service.test.ts
@@ -4,6 +4,9 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
+import { MountPoint } from 'kibana/public';
+
+import { docLinksServiceMock } from '../../../../../src/core/public/mocks';
 import { mockSecurityOssPlugin } from '../../../../../src/plugins/security_oss/public/mocks';
 import { insecureClusterAlertTitle } from './components';
 import { SecurityCheckupService } from './security_checkup_service';
@@ -13,9 +16,12 @@ let mockOnDismiss = jest.fn();
 jest.mock('./components', () => {
   return {
     insecureClusterAlertTitle: 'mock insecure cluster title',
-    insecureClusterAlertText: (onDismiss: any) => {
+    insecureClusterAlertText: (getDocLinksService: any, onDismiss: any) => {
       mockOnDismiss = onDismiss;
-      return 'mock insecure cluster text';
+      const { insecureClusterAlertText } = jest.requireActual(
+        './components/insecure_cluster_alert'
+      );
+      return insecureClusterAlertText(getDocLinksService, onDismiss);
     },
   };
 });
@@ -31,9 +37,7 @@ describe('SecurityCheckupService', () => {
         insecureClusterAlertTitle
       );
 
-      expect(securityOssSetup.insecureCluster.setAlertText).toHaveBeenCalledWith(
-        'mock insecure cluster text'
-      );
+      expect(securityOssSetup.insecureCluster.setAlertText).toHaveBeenCalledTimes(1);
     });
   });
   describe('#start', () => {
@@ -42,13 +46,34 @@ describe('SecurityCheckupService', () => {
       const securityOssStart = mockSecurityOssPlugin.createStart();
       const service = new SecurityCheckupService();
       service.setup({ securityOssSetup });
-      service.start({ securityOssStart });
+      service.start({ securityOssStart, docLinks: docLinksServiceMock.createStartContract() });
 
       expect(securityOssStart.insecureCluster.hideAlert).toHaveBeenCalledTimes(0);
 
       mockOnDismiss();
 
       expect(securityOssStart.insecureCluster.hideAlert).toHaveBeenCalledTimes(1);
     });
+
+    it('configures the doc link correctly', async () => {
+      const securityOssSetup = mockSecurityOssPlugin.createSetup();
+      const securityOssStart = mockSecurityOssPlugin.createStart();
+      const service = new SecurityCheckupService();
+      service.setup({ securityOssSetup });
+      service.start({ securityOssStart, docLinks: docLinksServiceMock.createStartContract() });
+
+      const [alertText] = securityOssSetup.insecureCluster.setAlertText.mock.calls[0];
+
+      const container = document.createElement('div');
+      (alertText as MountPoint)(container);
+
+      const docLink = container
+        .querySelector('[data-test-subj="learnMoreButton"]')
+        ?.getAttribute('href');
+
+      expect(docLink).toMatchInlineSnapshot(
+        `"https://www.elastic.co/guide/en/elasticsearch/reference/mocked-test-branch/get-started-enable-security.html?blade=kibanasecuritymessage"`
+      );
+    });
   });
 });
diff --git a/x-pack/plugins/security/public/security_checkup/security_checkup_service.tsx b/x-pack/plugins/security/public/security_checkup/security_checkup_service.tsx
@@ -4,32 +4,42 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
+import { DocLinksStart } from 'kibana/public';
+
 import {
   SecurityOssPluginSetup,
   SecurityOssPluginStart,
 } from '../../../../../src/plugins/security_oss/public';
 import { insecureClusterAlertTitle, insecureClusterAlertText } from './components';
+import { DocumentationLinksService } from './documentation_links';
 
 interface SetupDeps {
   securityOssSetup: SecurityOssPluginSetup;
 }
 
 interface StartDeps {
   securityOssStart: SecurityOssPluginStart;
+  docLinks: DocLinksStart;
 }
 
 export class SecurityCheckupService {
   private securityOssStart?: SecurityOssPluginStart;
 
+  private docLinksService?: DocumentationLinksService;
+
   public setup({ securityOssSetup }: SetupDeps) {
     securityOssSetup.insecureCluster.setAlertTitle(insecureClusterAlertTitle);
     securityOssSetup.insecureCluster.setAlertText(
-      insecureClusterAlertText((persist: boolean) => this.onDismiss(persist))
+      insecureClusterAlertText(
+        () => this.docLinksService!,
+        (persist: boolean) => this.onDismiss(persist)
+      )
     );
   }
 
-  public start({ securityOssStart }: StartDeps) {
+  public start({ securityOssStart, docLinks }: StartDeps) {
     this.securityOssStart = securityOssStart;
+    this.docLinksService = new DocumentationLinksService(docLinks);
   }
 
   private onDismiss(persist: boolean) {