[Telemetry] Prepare for versioned HTTP APIs

src/plugins/telemetry/common/routes.ts

@@ -10,9 +10,3 @@
  * Fetch Telemetry Config
  */
 export const FetchTelemetryConfigRoute = '/api/telemetry/v2/config';
-export interface FetchTelemetryConfigResponse {
-  allowChangingOptInStatus: boolean;
-  optIn: boolean | null;
-  sendUsageFrom: 'server' | 'browser';
-  telemetryNotifyUserAboutOptInDefault: boolean;
-}

src/plugins/telemetry/common/types.ts → src/plugins/telemetry/common/types/index.ts

@@ -6,5 +6,6 @@
  * Side Public License, v 1.
  */
 
-export type EncryptedTelemetryPayload = Array<{ clusterUuid: string; stats: string }>;
-export type UnencryptedTelemetryPayload = Array<{ clusterUuid: string; stats: object }>;
+export * from './latest';
+
+export * as v2 from './v2';

src/plugins/telemetry/common/types/latest.ts

@@ -0,0 +1,9 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+export * from './v2';

src/plugins/telemetry/common/types/v2.ts

@@ -0,0 +1,71 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+export interface Telemetry {
+  /** Whether telemetry is enabled */
+  enabled?: boolean | null;
+  lastVersionChecked?: string;
+  /** Whether to send usage from the server or browser. */
+  sendUsageFrom?: 'browser' | 'server';
+  lastReported?: number;
+  allowChangingOptInStatus?: boolean;
+  userHasSeenNotice?: boolean;
+  reportFailureCount?: number;
+  reportFailureVersion?: string;
+}
+
+export interface FetchTelemetryConfigResponse {
+  allowChangingOptInStatus: boolean;
+  optIn: boolean | null;
+  sendUsageFrom: 'server' | 'browser';
+  telemetryNotifyUserAboutOptInDefault: boolean;
+}
+
+export interface FetchLastReportedResponse {
+  lastReported: undefined | number;
+}
+
+export type UpdateLastReportedResponse = undefined;
+
+export interface OptInStatsBody {
+  enabled: boolean;
+  /** @default true */
+  unencrypted?: boolean;
+}
+
+export interface StatsPayload {
+  cluster_uuid: string;
+  opt_in_status: boolean;
+}
+
+export type OptInStatsResponse = Array<{
+  clusterUuid: string;
+  stats: StatsPayload;
+}>;
+
+export interface OptInBody {
+  enabled: boolean;
+}
+
+export type OptInResponse = Array<{
+  clusterUuid: string;
+  stats: string;
+}>;
+
+export interface UsageStatsBody {
+  /** @default false */
+  unencrypted: boolean;
+  /** @default false */
+  refreshCache: boolean;
+}
+
+export type UseHasSeenNoticeResponse = Telemetry;
+
+export type EncryptedTelemetryPayload = Array<{ clusterUuid: string; stats: string }>;
+
+export type UnencryptedTelemetryPayload = Array<{ clusterUuid: string; stats: object }>;

src/plugins/telemetry/public/plugin.ts

@@ -21,7 +21,8 @@ import type { HomePublicPluginSetup } from '@kbn/home-plugin/public';
 import { ElasticV3BrowserShipper } from '@kbn/analytics-shippers-elastic-v3-browser';
 
 import { of } from 'rxjs';
-import { FetchTelemetryConfigResponse, FetchTelemetryConfigRoute } from '../common/routes';
+import { FetchTelemetryConfigRoute } from '../common/routes';
+import type { v2 } from '../common/types';
 import { TelemetrySender, TelemetryService, TelemetryNotifications } from './services';
 import { renderWelcomeTelemetryNotice } from './render_welcome_telemetry_notice';
 
@@ -322,7 +323,7 @@ export class TelemetryPlugin implements Plugin<TelemetryPluginSetup, TelemetryPl
    */
   private async fetchUpdatedConfig(http: HttpStart | HttpSetup): Promise<TelemetryPluginConfig> {
     const { allowChangingOptInStatus, optIn, sendUsageFrom, telemetryNotifyUserAboutOptInDefault } =
-      await http.get<FetchTelemetryConfigResponse>(FetchTelemetryConfigRoute);
+      await http.get<v2.FetchTelemetryConfigResponse>(FetchTelemetryConfigRoute);
 
     return {
       ...this.config,

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

@@ -12,7 +12,7 @@ import { exhaustMap } from 'rxjs/operators';
 import { Storage } from '@kbn/kibana-utils-plugin/public';
 import { LOCALSTORAGE_KEY, PAYLOAD_CONTENT_ENCODING } from '../../common/constants';
 import { TelemetryService } from './telemetry_service';
-import type { EncryptedTelemetryPayload } from '../../common/types';
+import type { EncryptedTelemetryPayload } from '../../common/types/latest';
 import { isReportIntervalExpired } from '../../common/is_report_interval_expired';
 
 export class TelemetrySender {

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

@@ -10,7 +10,10 @@ import { i18n } from '@kbn/i18n';
 import { CoreStart } from '@kbn/core/public';
 import { TelemetryPluginConfig } from '../plugin';
 import { getTelemetryChannelEndpoint } from '../../common/telemetry_config/get_telemetry_channel_endpoint';
-import type { UnencryptedTelemetryPayload, EncryptedTelemetryPayload } from '../../common/types';
+import type {
+  UnencryptedTelemetryPayload,
+  EncryptedTelemetryPayload,
+} from '../../common/types/latest';
 import { PAYLOAD_CONTENT_ENCODING } from '../../common/constants';
 
 interface TelemetryServiceConstructor {

src/plugins/telemetry/server/routes/telemetry_config.ts

@@ -9,7 +9,8 @@
 import { type Observable, firstValueFrom } from 'rxjs';
 import type { IRouter, SavedObjectsClient } from '@kbn/core/server';
 import type { TelemetryConfigType } from '../config';
-import { FetchTelemetryConfigResponse, FetchTelemetryConfigRoute } from '../../common/routes';
+import { v2 } from '../../common/types';
+import { FetchTelemetryConfigRoute } from '../../common/routes';
 import { getTelemetrySavedObject } from '../saved_objects';
 import {
   getNotifyUserAboutOptInDefault,
@@ -64,7 +65,7 @@ export function registerTelemetryConfigRoutes({
         telemetryOptedIn: optIn,
       });
 
-      const body: FetchTelemetryConfigResponse = {
+      const body: v2.FetchTelemetryConfigResponse = {
         allowChangingOptInStatus,
         optIn,
         sendUsageFrom,

src/plugins/telemetry/server/routes/telemetry_last_reported.ts

@@ -9,6 +9,7 @@
 import type { IRouter, SavedObjectsClient } from '@kbn/core/server';
 import type { Observable } from 'rxjs';
 import { firstValueFrom } from 'rxjs';
+import { v2 } from '../../common/types';
 import { getTelemetrySavedObject, updateTelemetrySavedObject } from '../saved_objects';
 
 export function registerTelemetryLastReported(
@@ -25,10 +26,12 @@ export function registerTelemetryLastReported(
       const savedObjectsInternalClient = await firstValueFrom(savedObjectsInternalClient$);
       const telemetrySavedObject = await getTelemetrySavedObject(savedObjectsInternalClient);
 
+      const body: v2.FetchLastReportedResponse = {
+        lastReported: telemetrySavedObject && telemetrySavedObject?.lastReported,
+      };
+
       return res.ok({
-        body: {
-          lastReported: telemetrySavedObject && telemetrySavedObject?.lastReported,
-        },
+        body,
       });
     }
   );

src/plugins/telemetry/server/routes/telemetry_opt_in.ts

@@ -14,6 +14,7 @@ import type {
   StatsGetterConfig,
   TelemetryCollectionManagerPluginSetup,
 } from '@kbn/telemetry-collection-manager-plugin/server';
+import { v2 } from '../../common/types';
 import { sendTelemetryOptInStatus } from './telemetry_opt_in_stats';
 import {
   getTelemetrySavedObject,
@@ -109,7 +110,9 @@ export function registerTelemetryOptInRoutes({
           return res.forbidden();
         }
       }
-      return res.ok({ body: optInStatus });
+
+      const body: v2.OptInResponse = optInStatus;
+      return res.ok({ body });
     }
   );
 }

src/plugins/telemetry/server/routes/telemetry_opt_in_stats.ts

@@ -14,6 +14,7 @@ import type {
   TelemetryCollectionManagerPluginSetup,
   StatsGetterConfig,
 } from '@kbn/telemetry-collection-manager-plugin/server';
+import type { v2 } from '../../common/types';
 import { EncryptedTelemetryPayload, UnencryptedTelemetryPayload } from '../../common/types';
 import { getTelemetryChannelEndpoint } from '../../common/telemetry_config';
 import { PAYLOAD_CONTENT_ENCODING } from '../../common/constants';
@@ -90,7 +91,8 @@ export function registerTelemetryOptInStatsRoutes(
           newOptInStatus,
           statsGetterConfig
         );
-        return res.ok({ body: optInStatus });
+        const body: v2.OptInStatsResponse = optInStatus;
+        return res.ok({ body });
       } catch (err) {
         return res.ok({ body: [] });
       }

src/plugins/telemetry/server/routes/telemetry_usage_stats.ts

@@ -13,6 +13,7 @@ import type {
   StatsGetterConfig,
 } from '@kbn/telemetry-collection-manager-plugin/server';
 import type { SecurityPluginStart } from '@kbn/security-plugin/server';
+import { v2 } from '../../common/types';
 
 export type SecurityGetter = () => SecurityPluginStart | undefined;
 
@@ -64,8 +65,10 @@ export function registerTelemetryUsageStatsRoutes(
           refreshCache: unencrypted || refreshCache,
         };
 
-        const stats = await telemetryCollectionManager.getStats(statsConfig);
-        return res.ok({ body: stats });
+        const body: v2.UnencryptedTelemetryPayload = await telemetryCollectionManager.getStats(
+          statsConfig
+        );
+        return res.ok({ body });
       } catch (err) {
         if (isDev) {
           // don't ignore errors when running in dev mode

src/plugins/telemetry/server/routes/telemetry_user_has_seen_notice.ts

@@ -8,6 +8,7 @@
 
 import type { IRouter } from '@kbn/core/server';
 import { TELEMETRY_SAVED_OBJECT_TYPE } from '../saved_objects';
+import { v2 } from '../../common/types';
 import {
   type TelemetrySavedObjectAttributes,
   getTelemetrySavedObject,
@@ -33,7 +34,17 @@ export function registerTelemetryUserHasSeenNotice(router: IRouter) {
       };
       await updateTelemetrySavedObject(soClient, updatedAttributes);
 
-      return res.ok({ body: updatedAttributes });
+      const body: v2.Telemetry = {
+        allowChangingOptInStatus: updatedAttributes.allowChangingOptInStatus,
+        enabled: updatedAttributes.enabled,
+        lastReported: updatedAttributes.lastReported,
+        lastVersionChecked: updatedAttributes.lastVersionChecked,
+        reportFailureCount: updatedAttributes.reportFailureCount,
+        reportFailureVersion: updatedAttributes.reportFailureVersion,
+        sendUsageFrom: updatedAttributes.sendUsageFrom,
+        userHasSeenNotice: updatedAttributes.userHasSeenNotice,
+      };
+      return res.ok({ body });
     }
   );
 }