[TS] Allow Collector to be extended via options

Author: afharo

src/plugins/usage_collection/server/collector/collector.ts

@@ -82,8 +82,12 @@ export type CollectorFetchContext<WithKibanaRequest extends boolean | undefined
     }
   : {});
 
-export type CollectorFetchMethod<WithKibanaRequest extends boolean | undefined, TReturn> = (
-  this: Collector<TReturn, unknown>, // Specify the context of `this` for this.log and others to become available
+export type CollectorFetchMethod<
+  WithKibanaRequest extends boolean | undefined,
+  TReturn,
+  ExtraOptions extends object = {}
+> = (
+  this: Collector<TReturn, unknown> & ExtraOptions, // Specify the context of `this` for this.log and others to become available
   context: CollectorFetchContext<WithKibanaRequest>
 ) => Promise<TReturn> | TReturn;
 
@@ -105,7 +109,8 @@ export type CollectorOptionsFetchExtendedContext<
 export type CollectorOptions<
   TFetchReturn = unknown,
   UFormatBulkUploadPayload = TFetchReturn, // TODO: Once we remove bulk_uploader's dependency on usageCollection, we'll be able to remove this type
-  WithKibanaRequest extends boolean = boolean
+  WithKibanaRequest extends boolean = boolean,
+  ExtraOptions extends object = {}
 > = {
   /**
    * Unique string identifier for the collector
@@ -124,27 +129,32 @@ export type CollectorOptions<
    * The method that will collect and return the data in the final format.
    * @param collectorFetchContext {@link CollectorFetchContext}
    */
-  fetch: CollectorFetchMethod<WithKibanaRequest, TFetchReturn>;
+  fetch: CollectorFetchMethod<WithKibanaRequest, TFetchReturn, ExtraOptions>;
   /**
    * A hook for allowing the fetched data payload to be organized into a typed
    * data model for internal bulk upload. See defaultFormatterForBulkUpload for
    * a generic example.
    * @deprecated Used only by the Legacy Monitoring collection (to be removed in 8.0)
    */
   formatForBulkUpload?: CollectorFormatForBulkUpload<TFetchReturn, UFormatBulkUploadPayload>;
-} & (WithKibanaRequest extends true // If enforced to true via Types, the config must be enforced
-  ? {
-      extendFetchContext: CollectorOptionsFetchExtendedContext<WithKibanaRequest>;
-    }
-  : {
-      extendFetchContext?: CollectorOptionsFetchExtendedContext<WithKibanaRequest>;
-    });
-
-export class Collector<TFetchReturn, UFormatBulkUploadPayload = TFetchReturn> {
+} & ExtraOptions &
+  (WithKibanaRequest extends true // If enforced to true via Types, the config must be enforced
+    ? {
+        extendFetchContext: CollectorOptionsFetchExtendedContext<WithKibanaRequest>;
+      }
+    : {
+        extendFetchContext?: CollectorOptionsFetchExtendedContext<WithKibanaRequest>;
+      });
+
+export class Collector<
+  TFetchReturn,
+  UFormatBulkUploadPayload = TFetchReturn,
+  ExtraOptions extends object = {}
+> {
   public readonly extendFetchContext: CollectorOptionsFetchExtendedContext<any>;
   public readonly type: CollectorOptions<TFetchReturn, UFormatBulkUploadPayload, any>['type'];
   public readonly init?: CollectorOptions<TFetchReturn, UFormatBulkUploadPayload, any>['init'];
-  public readonly fetch: CollectorFetchMethod<any, TFetchReturn>;
+  public readonly fetch: CollectorFetchMethod<any, TFetchReturn, ExtraOptions>;
   public readonly isReady: CollectorOptions<TFetchReturn, UFormatBulkUploadPayload, any>['isReady'];
   private readonly _formatForBulkUpload?: CollectorFormatForBulkUpload<
     TFetchReturn,
@@ -169,7 +179,7 @@ export class Collector<TFetchReturn, UFormatBulkUploadPayload = TFetchReturn> {
       isReady,
       extendFetchContext = {},
       ...options
-    }: CollectorOptions<TFetchReturn, UFormatBulkUploadPayload, any>
+    }: CollectorOptions<TFetchReturn, UFormatBulkUploadPayload, any, ExtraOptions>
   ) {
     if (type === undefined) {
       throw new Error('Collector must be instantiated with a options.type string property');

src/plugins/usage_collection/server/collector/collector_set.ts

@@ -49,37 +49,58 @@ export class CollectorSet {
     this.maximumWaitTimeForAllCollectorsInS = maximumWaitTimeForAllCollectorsInS || 60;
   }
 
+  /**
+   * Instantiates a stats collector with the definition provided in the options
+   * @param options Definition of the collector {@link CollectorOptions}
+   */
   public makeStatsCollector = <
     TFetchReturn,
     TFormatForBulkUpload,
-    WithKibanaRequest extends boolean
+    WithKibanaRequest extends boolean,
+    ExtraOptions extends object = {}
   >(
-    options: CollectorOptions<TFetchReturn, TFormatForBulkUpload, WithKibanaRequest>
+    options: CollectorOptions<TFetchReturn, TFormatForBulkUpload, WithKibanaRequest, ExtraOptions>
   ) => {
-    return new Collector<TFetchReturn, TFormatForBulkUpload>(this.logger, options);
+    return new Collector<TFetchReturn, TFormatForBulkUpload, ExtraOptions>(this.logger, options);
   };
+
+  /**
+   * Instantiates an usage collector with the definition provided in the options
+   * @param options Definition of the collector {@link CollectorOptions}
+   */
   public makeUsageCollector = <
     TFetchReturn,
     TFormatForBulkUpload = { usage: { [key: string]: TFetchReturn } },
     // TODO: Right now, users will need to explicitly claim `true` for TS to allow `kibanaRequest` usage.
     //  If we improve `telemetry-check-tools` so plugins do not need to specify TFetchReturn,
     //  we'll be able to remove the type defaults and TS will successfully infer the config value as provided in JS.
-    WithKibanaRequest extends boolean = false
+    WithKibanaRequest extends boolean = false,
+    ExtraOptions extends object = {}
   >(
-    options: UsageCollectorOptions<TFetchReturn, TFormatForBulkUpload, WithKibanaRequest>
+    options: UsageCollectorOptions<
+      TFetchReturn,
+      TFormatForBulkUpload,
+      WithKibanaRequest,
+      ExtraOptions
+    >
   ) => {
-    return new UsageCollector<TFetchReturn, TFormatForBulkUpload>(this.logger, options);
+    return new UsageCollector<TFetchReturn, TFormatForBulkUpload, ExtraOptions>(
+      this.logger,
+      options
+    );
   };
 
-  /*
-   * @param collector {Collector} collector object
+  /**
+   * Registers a collector to be used when collecting all the usage and stats data
+   * @param collector Collector to be added to the set (previously created via `makeUsageCollector` or `makeStatsCollector`)
    */
   public registerCollector = <
     TFetchReturn,
     TFormatForBulkUpload,
-    WithKibanaRequest extends boolean
+    WithKibanaRequest extends boolean,
+    ExtraOptions extends object
   >(
-    collector: Collector<TFetchReturn, TFormatForBulkUpload>
+    collector: Collector<TFetchReturn, TFormatForBulkUpload, ExtraOptions>
   ) => {
     // check instanceof
     if (!(collector instanceof Collector)) {

src/plugins/usage_collection/server/collector/usage_collector.ts

@@ -25,17 +25,24 @@ import { Collector, CollectorOptions } from './collector';
 export type UsageCollectorOptions<
   TFetchReturn = unknown,
   UFormatBulkUploadPayload = { usage: { [key: string]: TFetchReturn } },
-  WithKibanaRequest extends boolean = false
-> = CollectorOptions<TFetchReturn, UFormatBulkUploadPayload, WithKibanaRequest> &
+  WithKibanaRequest extends boolean = false,
+  ExtraOptions extends object = {}
+> = CollectorOptions<TFetchReturn, UFormatBulkUploadPayload, WithKibanaRequest, ExtraOptions> &
   Required<Pick<CollectorOptions<TFetchReturn, UFormatBulkUploadPayload, boolean>, 'schema'>>;
 
 export class UsageCollector<
   TFetchReturn,
-  UFormatBulkUploadPayload = { usage: { [key: string]: TFetchReturn } }
-> extends Collector<TFetchReturn, UFormatBulkUploadPayload> {
+  UFormatBulkUploadPayload = { usage: { [key: string]: TFetchReturn } },
+  ExtraOptions extends object = {}
+> extends Collector<TFetchReturn, UFormatBulkUploadPayload, ExtraOptions> {
   constructor(
     public readonly log: Logger,
-    collectorOptions: UsageCollectorOptions<TFetchReturn, UFormatBulkUploadPayload, any>
+    collectorOptions: UsageCollectorOptions<
+      TFetchReturn,
+      UFormatBulkUploadPayload,
+      any,
+      ExtraOptions
+    >
   ) {
     super(log, collectorOptions);
   }

x-pack/plugins/monitoring/server/kibana_monitoring/collectors/get_settings_collector.ts

@@ -44,26 +44,25 @@ interface EmailSettingData {
   xpack: { default_admin_email: string | null };
 }
 
-function getEmailValueStructure(email: string | null): EmailSettingData {
-  return {
-    xpack: {
-      default_admin_email: email,
-    },
-  };
-}
-
-export interface KibanaSettingsCollector extends Collector<EmailSettingData | undefined> {
+export interface KibanaSettingsCollectorExtraOptions {
   getEmailValueStructure(email: string | null): EmailSettingData;
 }
 
+export type KibanaSettingsCollector = Collector<
+  EmailSettingData | undefined,
+  unknown,
+  KibanaSettingsCollectorExtraOptions
+>;
+
 export function getSettingsCollector(
   usageCollection: UsageCollectionSetup,
   config: MonitoringConfig
 ) {
-  const collector = usageCollection.makeStatsCollector<
+  return usageCollection.makeStatsCollector<
     EmailSettingData | undefined,
     unknown,
-    false
+    false,
+    KibanaSettingsCollectorExtraOptions
   >({
     type: KIBANA_SETTINGS_TYPE,
     isReady: () => true,
@@ -78,7 +77,7 @@ export function getSettingsCollector(
 
       // skip everything if defaultAdminEmail === undefined
       if (defaultAdminEmail || (defaultAdminEmail === null && shouldUseNull)) {
-        kibanaSettingsData = getEmailValueStructure(defaultAdminEmail);
+        kibanaSettingsData = this.getEmailValueStructure(defaultAdminEmail);
         this.log.debug(
           `[${defaultAdminEmail}] default admin email setting found, sending [${KIBANA_SETTINGS_TYPE}] monitoring document.`
         );
@@ -94,8 +93,12 @@ export function getSettingsCollector(
       // returns undefined if there was no result
       return kibanaSettingsData;
     },
+    getEmailValueStructure(email: string | null) {
+      return {
+        xpack: {
+          default_admin_email: email,
+        },
+      };
+    },
   });
-  // Attaching the method to the collector because we need to use it in `/api/settings`
-  (collector as KibanaSettingsCollector).getEmailValueStructure = getEmailValueStructure;
-  return collector;
 }