[Telemetry] Add Application Usage Schema (#75283)

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

Author: afharo

.telemetryrc.json

@@ -7,7 +7,6 @@
       "src/plugins/testbed/",
       "src/plugins/kibana_utils/",
       "src/plugins/kibana_usage_collection/server/collectors/kibana/kibana_usage_collector.ts",
-      "src/plugins/kibana_usage_collection/server/collectors/application_usage/telemetry_application_usage_collector.ts",
       "src/plugins/kibana_usage_collection/server/collectors/management/telemetry_management_collector.ts",
       "src/plugins/kibana_usage_collection/server/collectors/ui_metric/telemetry_ui_metric_collector.ts",
       "src/plugins/telemetry/server/collectors/usage/telemetry_usage_collector.ts"

packages/kbn-telemetry-tools/src/tools/__fixture__/mock_schema.json

@@ -5,6 +5,22 @@
         "flat": {
           "type": "keyword"
         },
+        "my_index_signature_prop": {
+          "properties": {
+            "avg": {
+              "type": "number"
+            },
+            "count": {
+              "type": "number"
+            },
+            "max": {
+              "type": "number"
+            },
+            "min": {
+              "type": "number"
+            }
+          }
+        },
         "my_str": {
           "type": "text"
         },

packages/kbn-telemetry-tools/src/tools/__fixture__/parsed_indexed_interface_with_not_matching_schema.ts

@@ -0,0 +1,54 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { SyntaxKind } from 'typescript';
+import { ParsedUsageCollection } from '../ts_parser';
+
+export const parsedIndexedInterfaceWithNoMatchingSchema: ParsedUsageCollection = [
+  'src/fixtures/telemetry_collectors/indexed_interface_with_not_matching_schema.ts',
+  {
+    collectorName: 'indexed_interface_with_not_matching_schema',
+    schema: {
+      value: {
+        something: {
+          count_1: {
+            type: 'number',
+          },
+        },
+      },
+    },
+    fetch: {
+      typeName: 'Usage',
+      typeDescriptor: {
+        '': {
+          '@@INDEX@@': {
+            count_1: {
+              kind: SyntaxKind.NumberKeyword,
+              type: 'NumberKeyword',
+            },
+            count_2: {
+              kind: SyntaxKind.NumberKeyword,
+              type: 'NumberKeyword',
+            },
+          },
+        },
+      },
+    },
+  },
+];

packages/kbn-telemetry-tools/src/tools/__fixture__/parsed_working_collector.ts

@@ -32,6 +32,20 @@ export const parsedWorkingCollector: ParsedUsageCollection = [
         my_str: {
           type: 'text',
         },
+        my_index_signature_prop: {
+          avg: {
+            type: 'number',
+          },
+          count: {
+            type: 'number',
+          },
+          max: {
+            type: 'number',
+          },
+          min: {
+            type: 'number',
+          },
+        },
         my_objects: {
           total: {
             type: 'number',
@@ -60,6 +74,14 @@ export const parsedWorkingCollector: ParsedUsageCollection = [
           kind: SyntaxKind.StringKeyword,
           type: 'StringKeyword',
         },
+        my_index_signature_prop: {
+          '': {
+            '@@INDEX@@': {
+              kind: SyntaxKind.NumberKeyword,
+              type: 'NumberKeyword',
+            },
+          },
+        },
         my_objects: {
           total: {
             kind: SyntaxKind.NumberKeyword,

packages/kbn-telemetry-tools/src/tools/__snapshots__/extract_collectors.test.ts.snap

@@ -20,6 +20,7 @@
 import { cloneDeep } from 'lodash';
 import * as ts from 'typescript';
 import { parsedWorkingCollector } from './__fixture__/parsed_working_collector';
+import { parsedIndexedInterfaceWithNoMatchingSchema } from './__fixture__/parsed_indexed_interface_with_not_matching_schema';
 import { checkCompatibleTypeDescriptor, checkMatchingMapping } from './check_collector_integrity';
 import * as path from 'path';
 import { readFile } from 'fs';
@@ -82,6 +83,20 @@ describe('checkCompatibleTypeDescriptor', () => {
     expect(incompatibles).toHaveLength(0);
   });
 
+  it('returns diff on indexed interface with no matching schema', () => {
+    const incompatibles = checkCompatibleTypeDescriptor([
+      parsedIndexedInterfaceWithNoMatchingSchema,
+    ]);
+    expect(incompatibles).toHaveLength(1);
+    const { diff, message } = incompatibles[0];
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    expect(diff).toEqual({ '.@@INDEX@@.count_2.kind': 'number' });
+    expect(message).toHaveLength(1);
+    expect(message).toEqual([
+      'incompatible Type key (Usage..@@INDEX@@.count_2): expected (undefined) got ("number").',
+    ]);
+  });
+
   describe('Interface Change', () => {
     it('returns diff on incompatible type descriptor with mapping', () => {
       const malformedParsedCollector = cloneDeep(parsedWorkingCollector);

packages/kbn-telemetry-tools/src/tools/check_collector__integrity.test.ts

@@ -34,7 +34,7 @@ describe('extractCollectors', () => {
     const programPaths = await getProgramPaths(configs[0]);
 
     const results = [...extractCollectors(programPaths, tsConfig)];
-    expect(results).toHaveLength(6);
+    expect(results).toHaveLength(7);
     expect(results).toMatchSnapshot();
   });
 });

packages/kbn-telemetry-tools/src/tools/extract_collectors.test.ts

@@ -84,6 +84,11 @@ export function getDescriptor(node: ts.Node, program: ts.Program): Descriptor |
     }, {} as any);
   }
 
+  // If it's defined as signature { [key: string]: OtherInterface }
+  if (ts.isIndexSignatureDeclaration(node) && node.type) {
+    return { '@@INDEX@@': getDescriptor(node.type, program) };
+  }
+
   if (ts.SyntaxKind.FirstNode === node.kind) {
     return getDescriptor((node as any).right, program);
   }

packages/kbn-telemetry-tools/src/tools/serializer.ts

@@ -98,6 +98,14 @@ export function getVariableValue(node: ts.Node): string | Record<string, any> {
     return serializeObject(node);
   }
 
+  if (ts.isIdentifier(node)) {
+    const declaration = getIdentifierDeclaration(node);
+    if (ts.isVariableDeclaration(declaration) && declaration.initializer) {
+      return getVariableValue(declaration.initializer);
+    }
+    // TODO: If this is another imported value from another file, we'll need to go fetch it like in getPropertyValue
+  }
+
   throw Error(`Unsuppored Node: cannot get value of node (${node.getText()}) of kind ${node.kind}`);
 }
 
@@ -112,10 +120,11 @@ export function serializeObject(node: ts.Node) {
     if (typeof propertyName === 'undefined') {
       throw new Error(`Unable to get property name ${property.getText()}`);
     }
+    const cleanPropertyName = propertyName.replace(/["']/g, '');
     if (ts.isPropertyAssignment(property)) {
-      value[propertyName] = getVariableValue(property.initializer);
+      value[cleanPropertyName] = getVariableValue(property.initializer);
     } else {
-      value[propertyName] = getVariableValue(property);
+      value[cleanPropertyName] = getVariableValue(property);
     }
   }
 
@@ -222,9 +231,29 @@ export const flattenKeys = (obj: any, keyPath: any[] = []): any => {
 };
 
 export function difference(actual: any, expected: any) {
-  function changes(obj: any, base: any) {
+  function changes(obj: { [key: string]: any }, base: { [key: string]: any }) {
     return transform(obj, function (result, value, key) {
-      if (key && !isEqual(value, base[key])) {
+      if (key && /@@INDEX@@/.test(`${key}`)) {
+        // The type definition is an Index Signature, fuzzy searching for similar keys
+        const regexp = new RegExp(`${key}`.replace(/@@INDEX@@/g, '(.+)?'));
+        const keysInBase = Object.keys(base)
+          .map((k) => {
+            const match = k.match(regexp);
+            return match && match[0];
+          })
+          .filter((s): s is string => !!s);
+
+        if (keysInBase.length === 0) {
+          // Mark this key as wrong because we couldn't find any matching keys
+          result[key] = value;
+        }
+
+        keysInBase.forEach((k) => {
+          if (!isEqual(value, base[k])) {
+            result[k] = isObject(value) && isObject(base[k]) ? changes(value, base[k]) : value;
+          }
+        });
+      } else if (key && !isEqual(value, base[key])) {
         result[key] = isObject(value) && isObject(base[key]) ? changes(value, base[key]) : value;
       }
     });

packages/kbn-telemetry-tools/src/tools/utils.ts

@@ -0,0 +1,48 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import { CollectorSet } from '../../plugins/usage_collection/server/collector';
+import { loggerMock } from '../../core/server/logging/logger.mock';
+
+const { makeUsageCollector } = new CollectorSet({
+  logger: loggerMock.create(),
+  maximumWaitTimeForAllCollectorsInS: 0,
+});
+
+interface Usage {
+  [key: string]: {
+    count_1?: number;
+    count_2?: number;
+  };
+}
+
+export const myCollector = makeUsageCollector<Usage>({
+  type: 'indexed_interface_with_not_matching_schema',
+  isReady: () => true,
+  fetch() {
+    if (Math.random()) {
+      return { something: { count_1: 1 } };
+    }
+    return { something: { count_2: 2 } };
+  },
+  schema: {
+    something: {
+      count_1: { type: 'long' }, // Intentionally missing count_2
+    },
+  },
+});

src/fixtures/telemetry_collectors/indexed_interface_with_not_matching_schema.ts

@@ -35,6 +35,9 @@ interface Usage {
   my_objects: MyObject;
   my_array?: MyObject[];
   my_str_array?: string[];
+  my_index_signature_prop?: {
+    [key: string]: number;
+  };
 }
 
 const SOME_NUMBER: number = 123;
@@ -93,5 +96,11 @@ export const myCollector = makeUsageCollector<Usage>({
       type: { type: 'boolean' },
     },
     my_str_array: { type: 'keyword' },
+    my_index_signature_prop: {
+      count: { type: 'number' },
+      avg: { type: 'number' },
+      max: { type: 'number' },
+      min: { type: 'number' },
+    },
   },
 });