Review

Author: schmidt-sebastian

packages/firestore/exp/test/deps/dependencies.json

@@ -1,15 +1,23 @@
 {
-    "foo": {
-        "dependencies": [
-            "bar",
-            "foo"
-        ],
-        "sizeInBytes": 67
-    },
     "bar": {
-        "dependencies": [
-            "bar"
-        ],
+        "dependencies": {
+            "functions": [
+                "bar"
+            ],
+            "classes": [],
+            "variables": []
+        },
         "sizeInBytes": 39
+    },
+    "foo": {
+        "dependencies": {
+            "functions": [
+                "bar",
+                "foo"
+            ],
+            "classes": [],
+            "variables": []
+        },
+        "sizeInBytes": 67
     }
-}
+}

packages/firestore/exp/test/deps/verify_dependencies.test.ts

@@ -27,8 +27,9 @@ describe('Dependencies', () => {
   forEach(dependencies, (api, { dependencies }) => {
     it(api, () => {
       return extractDependencies(api, pkg.exp).then(extractedDependencies => {
-        dependencies.sort();
-        expect(extractedDependencies).to.have.members(dependencies);
+        expect(extractedDependencies.classes).to.have.members(dependencies.classes, "for classes");
+        expect(extractedDependencies.functions).to.have.members(dependencies.functions, "for functions");
+        expect(extractedDependencies.variables).to.have.members(dependencies.variables, "for variables");
       });
     });
   });

scripts/exp/extract-deps.helpers.ts

@@ -22,8 +22,14 @@ import * as rollup from 'rollup';
 import * as terser from 'terser';
 import * as ts from 'typescript';
 
+/** Contains a list of members by type. */
+export type MemberList = {
+  classes: string[],
+  functions: string[],
+  variables:  string[]
+};
 /** Contains the dependencies and the size of their code for a single export. */
-export type ExportData = { dependencies: string[]; sizeInBytes: number };
+export type ExportData = { dependencies: MemberList; sizeInBytes: number };
 
 /**
  * This functions builds a simple JS app that only depends on the provided
@@ -37,7 +43,7 @@ export type ExportData = { dependencies: string[]; sizeInBytes: number };
 export async function extractDependencies(
   exportName: string,
   jsBundle: string
-): Promise<string[]> {
+): Promise<MemberList> {
   const { dependencies } = await extractDependenciesAndSize(
     exportName,
     jsBundle
@@ -69,8 +75,7 @@ export async function extractDependenciesAndSize(
   });
   await bundle.write({ file: output, format: 'es' });
 
-  const dependencies = extractFunctionsAndClasses(output);
-  dependencies.sort();
+  const dependencies = extractDeclarations(output);;
 
   // Extract size of minified build
   const afterContent = fs.readFileSync(output, 'utf-8');
@@ -89,23 +94,31 @@ export async function extractDependenciesAndSize(
 }
 
 /**
- * Extracts all top-level function and classes using the TypeScript compiler
- * API.
+ * Extracts all function, class and variable declarations using the TypeScript 
+ * compiler API.
  */
-export function extractFunctionsAndClasses(jsFile: string): string[] {
+export function extractDeclarations(jsFile: string): MemberList {
   const program = ts.createProgram([jsFile], { allowJs: true });
   const sourceFile = program.getSourceFile(jsFile);
   if (!sourceFile) {
     throw new Error('Failed to parse file: ' + jsFile);
   }
 
-  const exports: string[] = [];
+  const declarations: MemberList = { functions: [], classes: [], variables: []}
   ts.forEachChild(sourceFile, node => {
     if (ts.isFunctionDeclaration(node)) {
-      exports.push(node.name!.text);
+      declarations.functions.push(node.name!.text);
     } else if (ts.isClassDeclaration(node)) {
-      exports.push(node.name!.text);
+      declarations.classes.push(node.name!.text);
+    } else if (ts.isVariableDeclaration(node)) {
+      declarations.variables.push(node.name!.getText());
     }
   });
-  return exports;
+  
+  // Sort to ensure stable output
+  declarations.functions.sort();
+  declarations.classes.sort();
+  declarations.variables.sort();
+  
+  return declarations;
 }

scripts/exp/extract-deps.ts

@@ -21,7 +21,7 @@ import * as yargs from 'yargs';
 import {
   ExportData,
   extractDependenciesAndSize,
-  extractFunctionsAndClasses
+  extractDeclarations, MemberList
 } from './extract-deps.helpers';
 
 // Small command line app that builds a JSON file with a list of the
@@ -47,15 +47,21 @@ const argv = yargs.options({
   }
 }).argv;
 
-async function buildJson(publicApi: string[], jsFile: string): Promise<string> {
+async function buildJson(publicApi: MemberList, jsFile: string): Promise<string> {
   const result: { [key: string]: ExportData } = {};
-  for (const exp of publicApi) {
+  for (const exp of publicApi.classes) {
+    result[exp] = await extractDependenciesAndSize(exp, jsFile);
+  }
+  for (const exp of publicApi.functions) {
+    result[exp] = await extractDependenciesAndSize(exp, jsFile);
+  }
+  for (const exp of publicApi.variables) {
     result[exp] = await extractDependenciesAndSize(exp, jsFile);
   }
   return JSON.stringify(result, null, 4);
 }
 
-const publicApi = extractFunctionsAndClasses(path.resolve(argv.types));
+const publicApi = extractDeclarations(path.resolve(argv.types));
 buildJson(publicApi, path.resolve(argv.bundle)).then(json => {
   fs.writeFileSync(path.resolve(argv.output), json);
 });