feat(cli): [STENCIL-12] Adding Telemetry and CLI features.

src/cli/state/stencil-cli-config.ts

@@ -38,6 +38,10 @@ export default class StencilCLIConfig {
     return StencilCLIConfig.instance;
   }
 
+  public resetInstance() {
+    delete StencilCLIConfig.instance;
+  }
+
   public get logger() {
     return this._logger;
   }

src/cli/telemetry/telemetry.ts

@@ -47,37 +47,16 @@ export interface TrackableData {
  * @param result The results of a compiler build.
  */
 export async function telemetryBuildFinishedAction(result: CompilerBuildResults) {
-  const { sys, flags, logger } = getStencilCLIConfig();
+  const { flags, logger } = getStencilCLIConfig();
   const tracking = await shouldTrack(flags.ci);
 
   if (!tracking) {
     return;
   }
 
-  const details = sys.details;
-  const packages = await getInstalledPackages();
-  const targets = await getActiveTargets();
-  const versions = getCoreCompiler()?.versions || { typescript: 'unknown', rollup: 'unknown' };
   const component_count = Object.keys(result.componentGraph).length;
 
-  const data: TrackableData = {
-    yarn: isUsingYarn(),
-    duration_ms: result.duration,
-    component_count,
-    targets,
-    packages: packages || [],
-    arguments: flags.args,
-    task: flags.task,
-    stencil: getCoreCompiler()?.version || 'unknown',
-    system: `${sys.name} ${sys.version}`,
-    os_name: details.platform,
-    os_version: details.release,
-    cpu_model: `${details.cpuModel}`,
-    build: getCoreCompiler()?.buildId || 'unknown',
-    typescript: versions.typescript,
-    rollup: versions.rollup,
-    has_app_pwa_config: hasAppTarget(),
-  };
+  const data = await prepareData(result.duration, component_count);
 
   await sendMetric('stencil_cli_command', data);
   logger.debug(`${logger.blue('Telemetry')}: ${logger.gray(JSON.stringify(data))}`);
@@ -89,11 +68,9 @@ export async function telemetryBuildFinishedAction(result: CompilerBuildResults)
  * @returns void
  */
 export async function telemetryAction(action?: TelemetryCallback) {
-  const { sys, flags, logger } = getStencilCLIConfig();
+  const { flags, logger } = getStencilCLIConfig();
   const tracking = await shouldTrack(!!flags.ci);
 
-  const details = sys.details;
-  const versions = getCoreCompiler()?.versions || { typescript: 'unknown', rollup: 'unknown' };
   let duration = undefined;
   let error: any;
 
@@ -115,26 +92,7 @@ export async function telemetryAction(action?: TelemetryCallback) {
     return;
   }
 
-  const packages = await getInstalledPackages();
-  const targets = await getActiveTargets();
-
-  const data: TrackableData = {
-    yarn: isUsingYarn(),
-    duration_ms: duration,
-    targets,
-    packages: packages || [],
-    arguments: flags.args,
-    task: flags.task,
-    stencil: getCoreCompiler()?.version || 'unknown',
-    system: `${sys.name} ${sys.version}`,
-    os_name: details.platform,
-    os_version: details.release,
-    cpu_model: `${details.cpuModel}`,
-    build: getCoreCompiler()?.buildId || 'unknown',
-    typescript: versions.typescript,
-    rollup: versions.rollup,
-    has_app_pwa_config: hasAppTarget(),
-  };
+  const data = await prepareData(duration);
 
   await sendMetric('stencil_cli_command', data);
   logger.debug(`${logger.blue('Telemetry')}: ${logger.gray(JSON.stringify(data))}`);
@@ -144,21 +102,55 @@ export async function telemetryAction(action?: TelemetryCallback) {
   }
 }
 
-function hasAppTarget(): boolean {
+export function hasAppTarget(): boolean {
   return getStencilCLIConfig().validatedConfig.config.outputTargets.some(
-    target => target.type === 'www' && (!!target.serviceWorker || target.baseUrl !== '/'),
+    target => target.type === 'www' && (!!target.serviceWorker || (!!target.baseUrl && target.baseUrl !== '/')),
   );
 }
 
-function isUsingYarn() {
+export function isUsingYarn() {
   return getCompilerSystem().getEnvironmentVar('npm_execpath')?.includes('yarn') || false;
 }
 
-async function getActiveTargets(): Promise<string[]> {
+export async function getActiveTargets(): Promise<string[]> {
   const result = getStencilCLIConfig().validatedConfig.config.outputTargets.map(t => t.type);
   return Array.from(new Set(result));
 }
 
+export const prepareData = async (duration_ms: number, component_count: number = undefined): Promise<TrackableData> => {
+  const { flags, sys } = getStencilCLIConfig();
+  const { typescript, rollup } = getCoreCompiler()?.versions || { typescript: 'unknown', rollup: 'unknown' };
+  const packages = await getInstalledPackages() || [];
+  const targets = await getActiveTargets();
+  const yarn = isUsingYarn()
+  const stencil = getCoreCompiler()?.version || 'unknown';
+  const system = `${sys.name} ${sys.version}`;
+  const os_name = sys.details.platform;
+  const os_version = sys.details.release;
+  const cpu_model = sys.details.cpuModel;
+  const build = getCoreCompiler()?.buildId || 'unknown';
+  const has_app_pwa_config = hasAppTarget();
+
+  return {
+    yarn,
+    duration_ms,
+    component_count,
+    targets,
+    packages,
+    arguments: flags.args,
+    task: flags.task,
+    stencil,
+    system,
+    os_name,
+    os_version,
+    cpu_model,
+    build,
+    typescript,
+    rollup,
+    has_app_pwa_config,
+  };
+}
+
 /**
  * Reads package-lock.json and package.json files in order to cross references the dependencies and devDependencies properties. Pull the current installed version of each package under the @stencil, @ionic, and @capacitor scopes.
  * @returns string[]

src/cli/telemetry/test/telemetry.spec.ts

@@ -1,4 +1,4 @@
-import { initializeStencilCLIConfig } from '../../state/stencil-cli-config';
+import { getStencilCLIConfig, initializeStencilCLIConfig } from '../../state/stencil-cli-config';
 import * as telemetry from '../telemetry';
 import * as shouldTrack from '../shouldTrack';
 import { createSystem } from '../../../compiler/sys/stencil-sys';
@@ -76,3 +76,132 @@ describe('checkTelemetry', () => {
     expect(await telemetry.checkTelemetry()).toBe(true);
   });
 });
+
+describe('hasAppTarget', () => {
+
+  beforeEach(() => {
+    getStencilCLIConfig()?.resetInstance();
+
+    initializeStencilCLIConfig({
+      sys: createSystem(),
+      logger: mockLogger(),
+      flags: { ci: false },
+      validatedConfig: { config: { outputTargets: [] } } as LoadConfigResults,
+      args: [],
+    });
+  });
+
+
+  it('Result is correct when outputTargets are empty', () => {
+    getStencilCLIConfig().validatedConfig = { config: { outputTargets: [] } } as LoadConfigResults
+    expect(telemetry.hasAppTarget()).toBe(false)
+  });
+
+  it('Result is correct when outputTargets contains www with no baseUrl or serviceWorker', () => {
+    getStencilCLIConfig().validatedConfig = { config: { outputTargets: [{ type: "www" }] } } as LoadConfigResults;
+    expect(telemetry.hasAppTarget()).toBe(false)
+  });
+
+  it('Result is correct when outputTargets contains www with default baseUrl value', () => {
+    getStencilCLIConfig().validatedConfig = { config: { outputTargets: [{ type: "www", baseUrl: "/" }] } } as LoadConfigResults;
+    expect(telemetry.hasAppTarget()).toBe(false)
+  });
+
+  it('Result is correct when outputTargets contains www with serviceWorker', () => {
+    getStencilCLIConfig().validatedConfig = { config: { outputTargets: [{ type: "www", serviceWorker: { swDest: "./tmp" }, }] } } as LoadConfigResults
+    expect(telemetry.hasAppTarget()).toBe(true)
+  });
+
+  it('Result is correct when outputTargets contains www with serviceWorker', () => {
+    getStencilCLIConfig().validatedConfig = { config: { outputTargets: [{ type: "www", baseUrl: "https://example.com" }] } } as LoadConfigResults
+    expect(telemetry.hasAppTarget()).toBe(true)
+  });
+
+  it('Result is correct when outputTargets contains www with serviceWorker', () => {
+    getStencilCLIConfig().validatedConfig = { config: { outputTargets: [{ type: "www", baseUrl: "https://example.com", serviceWorker: { swDest: "./tmp" } }] } } as LoadConfigResults
+    expect(telemetry.hasAppTarget()).toBe(true)
+  });
+});
+
+describe('hasAppTarget', () => {
+
+  beforeEach(() => {
+    getStencilCLIConfig()?.resetInstance();
+
+    initializeStencilCLIConfig({
+      sys: createSystem(),
+      logger: mockLogger(),
+      flags: { ci: false },
+      validatedConfig: { config: { outputTargets: [] } } as LoadConfigResults,
+      args: [],
+    });
+  });
+
+  it('provides an object', async () => {
+    const data = await telemetry.prepareData(1000);
+    expect(data).toEqual({
+      "arguments": undefined,
+      "build": "unknown",
+      "component_count": undefined,
+      "cpu_model": "",
+      "duration_ms": 1000,
+      "has_app_pwa_config": false,
+      "os_name": "",
+      "os_version": "",
+      "packages": [],
+      "rollup": "unknown",
+      "stencil": "unknown",
+      "system": "in-memory __VERSION:STENCIL__",
+      "targets": [],
+      "task": undefined,
+      "typescript": "unknown",
+      "yarn": false
+    })
+  })
+
+  it('updates when there is a PWA config', async () => {
+    getStencilCLIConfig().validatedConfig = { config: { outputTargets: [{ type: "www", baseUrl: "https://example.com", serviceWorker: {swDest: "./tmp" } }] } } as LoadConfigResults
+    const data = await telemetry.prepareData(1000);
+    expect(data).toEqual({
+      "arguments": undefined,
+      "build": "unknown",
+      "component_count": undefined,
+      "cpu_model": "",
+      "duration_ms": 1000,
+      "has_app_pwa_config": true,
+      "os_name": "",
+      "os_version": "",
+      "packages": [],
+      "rollup": "unknown",
+      "stencil": "unknown",
+      "system": "in-memory __VERSION:STENCIL__",
+      "targets": ["www"],
+      "task": undefined,
+      "typescript": "unknown",
+      "yarn": false
+    })
+  })
+
+  it('updates when there is a component count passed in', async () => {
+    getStencilCLIConfig().validatedConfig = { config: { outputTargets: [{ type: "www", baseUrl: "https://example.com", serviceWorker: {swDest: "./tmp" } }] } } as LoadConfigResults
+    const data = await telemetry.prepareData(1000, 12);
+    expect(data).toEqual({
+      "arguments": undefined,
+      "build": "unknown",
+      "component_count": 12,
+      "cpu_model": "",
+      "duration_ms": 1000,
+      "has_app_pwa_config": true,
+      "os_name": "",
+      "os_version": "",
+      "packages": [],
+      "rollup": "unknown",
+      "stencil": "unknown",
+      "system": "in-memory __VERSION:STENCIL__",
+      "targets": ["www"],
+      "task": undefined,
+      "typescript": "unknown",
+      "yarn": false
+    })
+  })
+})