[Usage Collection] [schema] reporting + add MappedType support (#…

…78591)
elastic · Sep 29, 2020 · 66866d0 · 66866d0
1 parent 8282dd7
commit 66866d0
Show file tree

Hide file tree

Showing 10 changed files with 1,403 additions and 9 deletions.
diff --git a/packages/kbn-telemetry-tools/src/tools/serializer.test.ts b/packages/kbn-telemetry-tools/src/tools/serializer.test.ts
@@ -124,4 +124,18 @@ describe('getDescriptor', () => {
       '@@INDEX@@': { kind: ts.SyntaxKind.NumberKeyword, type: 'NumberKeyword' },
     });
   });
+
+  it('serializes MappedTypes', () => {
+    const usageInterface = usageInterfaces.get('MappedTypes')!;
+    const descriptor = getDescriptor(usageInterface, tsProgram);
+    expect(descriptor).toEqual({
+      mappedTypeWithExternallyDefinedProps: {
+        prop1: { kind: ts.SyntaxKind.NumberKeyword, type: 'NumberKeyword' },
+        prop2: { kind: ts.SyntaxKind.NumberKeyword, type: 'NumberKeyword' },
+      },
+      mappedTypeWithOneInlineProp: {
+        prop3: { kind: ts.SyntaxKind.NumberKeyword, type: 'NumberKeyword' },
+      },
+    });
+  });
 });
diff --git a/packages/kbn-telemetry-tools/src/tools/serializer.ts b/packages/kbn-telemetry-tools/src/tools/serializer.ts
@@ -71,6 +71,33 @@ export function kindToDescriptorName(kind: number) {
   }
 }
 
+export function getConstraints(node: ts.Node, program: ts.Program): any {
+  if (ts.isTypeReferenceNode(node)) {
+    const typeChecker = program.getTypeChecker();
+    const symbol = typeChecker.getSymbolAtLocation(node.typeName);
+    const declaration = (symbol?.getDeclarations() || [])[0];
+    if (declaration) {
+      return getConstraints(declaration, program);
+    }
+    return getConstraints(node.typeName, program);
+  }
+
+  if (ts.isTypeAliasDeclaration(node)) {
+    return getConstraints(node.type, program);
+  }
+
+  if (ts.isUnionTypeNode(node)) {
+    const types = node.types.filter(discardNullOrUndefined);
+    return types.map((typeNode) => getConstraints(typeNode, program));
+  }
+
+  if (ts.isLiteralTypeNode(node) && ts.isLiteralExpression(node.literal)) {
+    return node.literal.text;
+  }
+
+  throw Error(`Unsupported constraint`);
+}
+
 export function getDescriptor(node: ts.Node, program: ts.Program): Descriptor | DescriptorValue {
   if (ts.isMethodSignature(node) || ts.isPropertySignature(node)) {
     if (node.type) {
@@ -89,8 +116,19 @@ export function getDescriptor(node: ts.Node, program: ts.Program): Descriptor |
   }
 
   // If it's defined as signature { [key: string]: OtherInterface }
-  if (ts.isIndexSignatureDeclaration(node) && node.type) {
-    return { '@@INDEX@@': getDescriptor(node.type, program) };
+  if ((ts.isIndexSignatureDeclaration(node) || ts.isMappedTypeNode(node)) && node.type) {
+    const descriptor = getDescriptor(node.type, program);
+
+    // If we know the constraints of `string` ({ [key in 'prop1' | 'prop2']: value })
+    const constraint = (node as ts.MappedTypeNode).typeParameter?.constraint;
+    if (constraint) {
+      const constraints = getConstraints(constraint, program);
+      const constraintsArray = Array.isArray(constraints) ? constraints : [constraints];
+      if (typeof constraintsArray[0] === 'string') {
+        return constraintsArray.reduce((acc, c) => ({ ...acc, [c]: descriptor }), {});
+      }
+    }
+    return { '@@INDEX@@': descriptor };
   }
 
   if (ts.SyntaxKind.FirstNode === node.kind) {

diff --git a/packages/kbn-telemetry-tools/src/tools/utils.ts b/packages/kbn-telemetry-tools/src/tools/utils.ts
@@ -124,7 +124,9 @@ export function getVariableValue(node: ts.Node, program: ts.Program): string | R
   }
 
   throw Error(
-    `Unsupported Node: cannot get value of node (${node.getText()}) of kind ${node.kind}`
+    `Unsupported Node: cannot get value of node (${node.getText()}) of kind ${node.kind} [${
+      ts.SyntaxKind[node.kind]
+    }]`
   );
 }
 

diff --git a/src/fixtures/telemetry_collectors/constants.ts b/src/fixtures/telemetry_collectors/constants.ts
@@ -55,3 +55,14 @@ export const externallyDefinedSchema: MakeSchemaFrom<{ locale: string }> = {
 export type TypeAliasWithUnion = Usage & WithUnion;
 
 export type TypeAliasWithRecord = Usage & Record<string, number>;
+
+export type MappedTypeProps = 'prop1' | 'prop2';
+
+export interface MappedTypes {
+  mappedTypeWithExternallyDefinedProps: {
+    [key in MappedTypeProps]: number;
+  };
+  mappedTypeWithOneInlineProp: {
+    [key in 'prop3']: number;
+  };
+}
diff --git a/x-pack/.telemetryrc.json b/x-pack/.telemetryrc.json
@@ -6,7 +6,6 @@
     "plugins/alerts/server/usage/alerts_usage_collector.ts",
     "plugins/apm/server/lib/apm_telemetry/index.ts",
     "plugins/infra/server/usage/usage_collector.ts",
-    "plugins/reporting/server/usage/reporting_usage_collector.ts",
     "plugins/maps/server/maps_telemetry/collectors/register.ts"
   ]
 }