[Reporting/Telemetry] Do not send telemetry if we are in screenshot mode

src/plugins/telemetry/kibana.json

@@ -3,15 +3,7 @@
   "version": "kibana",
   "server": true,
   "ui": true,
-  "requiredPlugins": [
-    "telemetryCollectionManager",
-    "usageCollection"
-  ],
-  "extraPublicDirs": [
-    "common/constants"
-  ],
-  "requiredBundles": [
-    "kibanaUtils",
-    "kibanaReact"
-  ]
+  "requiredPlugins": ["telemetryCollectionManager", "usageCollection", "screenshotMode"],
+  "extraPublicDirs": ["common/constants"],
+  "requiredBundles": ["kibanaUtils", "kibanaReact"]
 }

src/plugins/telemetry/public/mocks.ts

@@ -22,12 +22,14 @@ import { TelemetryPluginStart, TelemetryPluginSetup, TelemetryPluginConfig } fro
 export interface TelemetryServiceMockOptions {
   reportOptInStatusChange?: boolean;
   currentKibanaVersion?: string;
+  isScreenshotMode?: boolean;
   config?: Partial<TelemetryPluginConfig>;
 }
 
 export function mockTelemetryService({
   reportOptInStatusChange,
   currentKibanaVersion = 'mockKibanaVersion',
+  isScreenshotMode = false,
   config: configOverride = {},
 }: TelemetryServiceMockOptions = {}) {
   const config = {
@@ -47,6 +49,7 @@ export function mockTelemetryService({
     config,
     http: httpServiceMock.createStartContract(),
     notifications: notificationServiceMock.createStartContract(),
+    isScreenshotMode,
     currentKibanaVersion,
     reportOptInStatusChange,
   });

src/plugins/telemetry/public/plugin.ts

@@ -17,6 +17,8 @@ import type {
   ApplicationStart,
 } from 'src/core/public';
 
+import { ScreenshotModePluginSetup } from 'src/plugins/screenshot_mode/public';
+
 import { TelemetrySender, TelemetryService, TelemetryNotifications } from './services';
 import type {
   TelemetrySavedObjectAttributes,
@@ -76,6 +78,10 @@ export interface TelemetryPluginStart {
   };
 }
 
+interface TelemetryPluginSetupDependencies {
+  screenshotMode: ScreenshotModePluginSetup;
+}
+
 /**
  * Public-exposed configuration
  */
@@ -113,11 +119,15 @@ export class TelemetryPlugin implements Plugin<TelemetryPluginSetup, TelemetryPl
     this.config = initializerContext.config.get();
   }
 
-  public setup({ http, notifications }: CoreSetup): TelemetryPluginSetup {
+  public setup(
+    { http, notifications }: CoreSetup,
+    { screenshotMode }: TelemetryPluginSetupDependencies
+  ): TelemetryPluginSetup {
     const config = this.config;
     const currentKibanaVersion = this.currentKibanaVersion;
     this.telemetryService = new TelemetryService({
       config,
+      isScreenshotMode: screenshotMode.isScreenshotMode(),
       http,
       notifications,
       currentKibanaVersion,

src/plugins/telemetry/public/services/telemetry_sender.ts

@@ -33,8 +33,7 @@ export class TelemetrySender {
   };
 
   private shouldSendReport = (): boolean => {
-    // check if opt-in for telemetry is enabled
-    if (this.telemetryService.getIsOptedIn()) {
+    if (this.telemetryService.canSendTelemetry()) {
       if (!this.lastReported) {
         return true;
       }

src/plugins/telemetry/public/services/telemetry_service.test.ts

@@ -256,4 +256,15 @@ describe('TelemetryService', () => {
       expect(mockFetch).toHaveBeenCalledTimes(1);
     });
   });
+
+  describe('shouldSendTelemetry', () => {
+    it('does not send telemetry if screenshotMode is true', () => {
+      const telemetryService = mockTelemetryService({
+        isScreenshotMode: true,
+        config: { optIn: true },
+      });
+
+      expect(telemetryService.canSendTelemetry()).toBe(false);
+    });
+  });
 });

src/plugins/telemetry/public/services/telemetry_service.ts

@@ -9,11 +9,13 @@
 import { i18n } from '@kbn/i18n';
 import { CoreStart } from 'kibana/public';
 import { TelemetryPluginConfig } from '../plugin';
+import { ScreenshotModePluginSetup } from '../../../screenshot_mode/public';
 
 interface TelemetryServiceConstructor {
   config: TelemetryPluginConfig;
   http: CoreStart['http'];
   notifications: CoreStart['notifications'];
+  isScreenshotMode: boolean;
   currentKibanaVersion: string;
   reportOptInStatusChange?: boolean;
 }
@@ -27,6 +29,7 @@ export class TelemetryService {
   private readonly reportOptInStatusChange: boolean;
   private readonly notifications: CoreStart['notifications'];
   private readonly defaultConfig: TelemetryPluginConfig;
+  private readonly isScreenshotMode: boolean;
   private updatedConfig?: TelemetryPluginConfig;
 
   /** Current version of Kibana */
@@ -35,11 +38,13 @@ export class TelemetryService {
   constructor({
     config,
     http,
+    isScreenshotMode,
     notifications,
     currentKibanaVersion,
     reportOptInStatusChange = true,
   }: TelemetryServiceConstructor) {
     this.defaultConfig = config;
+    this.isScreenshotMode = isScreenshotMode;
     this.reportOptInStatusChange = reportOptInStatusChange;
     this.notifications = notifications;
     this.currentKibanaVersion = currentKibanaVersion;
@@ -126,6 +131,10 @@ export class TelemetryService {
     return this.isOptedIn;
   };
 
+  public canSendTelemetry = (): boolean => {
+    return Boolean(this.getIsOptedIn() && !this.isScreenshotMode);
+  };
+
   /** Fetches an unencrypted telemetry payload so we can show it to the user **/
   public fetchExample = async () => {
     return await this.fetchTelemetry({ unencrypted: true });

src/plugins/telemetry/tsconfig.json

@@ -8,17 +8,13 @@
     "declarationMap": true,
     "isolatedModules": true
   },
-  "include": [
-    "public/**/**/*",
-    "server/**/**/*",
-    "common/**/*",
-    "../../../typings/**/*"
-  ],
+  "include": ["public/**/**/*", "server/**/**/*", "common/**/*", "../../../typings/**/*"],
   "references": [
     { "path": "../../core/tsconfig.json" },
-    { "path": "../../plugins/usage_collection/tsconfig.json" },
-    { "path": "../../plugins/telemetry_collection_manager/tsconfig.json" },
+    { "path": "../../plugins/kibana_react/tsconfig.json" },
     { "path": "../../plugins/kibana_utils/tsconfig.json" },
-    { "path": "../../plugins/kibana_react/tsconfig.json" }
+    { "path": "../../plugins/screenshot_mode/tsconfig.json" },
+    { "path": "../../plugins/telemetry_collection_manager/tsconfig.json" },
+    { "path": "../../plugins/usage_collection/tsconfig.json" }
   ]
 }