@angular/cli 15.0.0-next.4 → 15.0.0-next.5

package/src/command-builder/command-module.d.ts

@@ -5,8 +5,10 @@
  * Use of this source code is governed by an MIT-style license that can be
  * found in the LICENSE file at https://angular.io/license
  */
-import { analytics, logging } from '@angular-devkit/core';
+import { logging } from '@angular-devkit/core';
 import { ArgumentsCamelCase, Argv, CamelCaseKey, CommandModule as YargsCommandModule } from 'yargs';
+import { AnalyticsCollector } from '../analytics/analytics-collector';
+import { EventCustomDimension, EventCustomMetric } from '../analytics/analytics-parameters';
 import { AngularWorkspace } from '../utilities/config';
 import { PackageManagerUtils } from '../utilities/package-manager';
 import { Option } from './utilities/json-schema';
@@ -74,8 +76,7 @@ export declare abstract class CommandModule<T extends {} = {}> implements Comman
     abstract builder(argv: Argv): Promise<Argv<T>> | Argv<T>;
     abstract run(options: Options<T> & OtherOptions): Promise<number | void> | number | void;
     handler(args: ArgumentsCamelCase<T> & OtherOptions): Promise<void>;
-    reportAnalytics(options: (Options<T> & OtherOptions) | OtherOptions, paths?: string[], dimensions?: (boolean | number | string)[], title?: string): Promise<void>;
-    protected getAnalytics(): Promise<analytics.Analytics>;
+    protected getAnalytics(): Promise<AnalyticsCollector | undefined>;
     /**
      * Adds schema options to a command also this keeps track of options that are required for analytics.
      * **Note:** This method should be called from the command bundler method.
@@ -88,7 +89,7 @@ export declare abstract class CommandModule<T extends {} = {}> implements Comman
      * @returns a method that when called will terminate the periodic
      * flush and call flush one last time.
      */
-    private periodicAnalyticsFlush;
+    protected getAnalyticsParameters(options: (Options<T> & OtherOptions) | OtherOptions): Partial<Record<EventCustomDimension | EventCustomMetric, string | boolean | number>>;
 }
 /**
  * Creates an known command module error.

package/src/command-builder/command-module.js

@@ -35,13 +35,19 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommandModuleError = exports.CommandModule = exports.CommandScope = void 0;
 const core_1 = require("@angular-devkit/core");
 const fs_1 = require("fs");
 const path = __importStar(require("path"));
+const yargs_1 = __importDefault(require("yargs"));
 const helpers_1 = require("yargs/helpers");
 const analytics_1 = require("../analytics/analytics");
+const analytics_collector_1 = require("../analytics/analytics-collector");
+const analytics_parameters_1 = require("../analytics/analytics-parameters");
 const completion_1 = require("../utilities/completion");
 const memoize_1 = require("../utilities/memoize");
 var CommandScope;
@@ -99,18 +105,25 @@ class CommandModule {
         }
         // Gather and report analytics.
         const analytics = await this.getAnalytics();
-        let stopPeriodicFlushes;
-        if (this.shouldReportAnalytics) {
-            await this.reportAnalytics(camelCasedOptions);
-            stopPeriodicFlushes = this.periodicAnalyticsFlush(analytics);
-        }
+        const stopPeriodicFlushes = analytics && analytics.periodFlush();
         let exitCode;
         try {
             // Run and time command.
-            const startTime = Date.now();
+            if (analytics) {
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                const internalMethods = yargs_1.default.getInternalMethods();
+                // $0 generate component [name] -> generate_component
+                // $0 add <collection> -> add
+                const fullCommand = internalMethods.getUsageInstance().getUsage()[0][0]
+                    .split(' ')
+                    .filter((x) => {
+                    const code = x.charCodeAt(0);
+                    return code >= 97 && code <= 122;
+                })
+                    .join('_');
+                analytics.reportCommandRunEvent(fullCommand);
+            }
             exitCode = await this.run(camelCasedOptions);
-            const endTime = Date.now();
-            analytics.timing(this.commandName, 'duration', endTime - startTime);
         }
         catch (e) {
             if (e instanceof core_1.schema.SchemaValidationException) {
@@ -128,24 +141,14 @@ class CommandModule {
             }
         }
     }
-    async reportAnalytics(options, paths = [], dimensions = [], title) {
-        for (const [name, ua] of this.optionsWithAnalytics) {
-            const value = options[name];
-            if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
-                dimensions[ua] = value;
-            }
+    async getAnalytics() {
+        if (!this.shouldReportAnalytics) {
+            return undefined;
         }
-        const analytics = await this.getAnalytics();
-        analytics.pageview('/command/' + [this.commandName, ...paths].join('/'), {
-            dimensions,
-            metrics: [],
-            title,
-        });
-    }
-    getAnalytics() {
-        return (0, analytics_1.createAnalytics)(!!this.context.workspace, 
+        const userId = await (0, analytics_1.getAnalyticsUserId)(this.context, 
         // Don't prompt for `ng update` and `ng analytics` commands.
         ['update', 'analytics'].includes(this.commandName));
+        return userId ? new analytics_collector_1.AnalyticsCollector(this.context, userId) : undefined;
     }
     /**
      * Adds schema options to a command also this keeps track of options that are required for analytics.
@@ -213,16 +216,20 @@ class CommandModule {
      * @returns a method that when called will terminate the periodic
      * flush and call flush one last time.
      */
-    periodicAnalyticsFlush(analytics) {
-        let analyticsFlushPromise = Promise.resolve();
-        const analyticsFlushInterval = setInterval(() => {
-            analyticsFlushPromise = analyticsFlushPromise.then(() => analytics.flush());
-        }, 2000);
-        return () => {
-            clearInterval(analyticsFlushInterval);
-            // Flush one last time.
-            return analyticsFlushPromise.then(() => analytics.flush());
-        };
+    getAnalyticsParameters(options) {
+        const parameters = {};
+        const validEventCustomDimensionAndMetrics = new Set([
+            ...Object.values(analytics_parameters_1.EventCustomDimension),
+            ...Object.values(analytics_parameters_1.EventCustomMetric),
+        ]);
+        for (const [name, ua] of this.optionsWithAnalytics) {
+            const value = options[name];
+            if ((typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') &&
+                validEventCustomDimensionAndMetrics.has(ua)) {
+                parameters[ua] = value;
+            }
+        }
+        return parameters;
     }
 }
 __decorate([

package/src/command-builder/schematics-command-module.d.ts

@@ -23,7 +23,6 @@ export interface SchematicsExecutionOptions extends Options<SchematicsCommandArg
 export declare abstract class SchematicsCommandModule extends CommandModule<SchematicsCommandArgs> implements CommandModuleImplementation<SchematicsCommandArgs> {
     scope: CommandScope;
     protected readonly allowPrivateSchematics: boolean;
-    protected readonly shouldReportAnalytics = false;
     builder(argv: Argv): Promise<Argv<SchematicsCommandArgs>>;
     /** Get schematic schema options.*/
     protected getSchematicOptions(collection: Collection<FileSystemCollectionDescription, FileSystemSchematicDescription>, schematicName: string, workflow: NodeWorkflow): Promise<Option[]>;

package/src/command-builder/schematics-command-module.js

@@ -41,6 +41,8 @@ const core_1 = require("@angular-devkit/core");
 const schematics_1 = require("@angular-devkit/schematics");
 const tools_1 = require("@angular-devkit/schematics/tools");
 const path_1 = require("path");
+const analytics_1 = require("../analytics/analytics");
+const analytics_parameters_1 = require("../analytics/analytics-parameters");
 const config_1 = require("../utilities/config");
 const error_1 = require("../utilities/error");
 const memoize_1 = require("../utilities/memoize");
@@ -55,7 +57,6 @@ class SchematicsCommandModule extends command_module_1.CommandModule {
         super(...arguments);
         this.scope = command_module_1.CommandScope.In;
         this.allowPrivateSchematics = false;
-        this.shouldReportAnalytics = false;
         this.defaultProjectDeprecationWarningShown = false;
     }
     async builder(argv) {
@@ -128,26 +129,18 @@ class SchematicsCommandModule extends command_module_1.CommandModule {
         workflow.registry.addSmartDefaultProvider('workingDirectory', () => workingDir === '' ? undefined : workingDir);
         let shouldReportAnalytics = true;
         workflow.engineHost.registerOptionsTransform(async (schematic, options) => {
+            // Report analytics
             if (shouldReportAnalytics) {
                 shouldReportAnalytics = false;
-                await this.reportAnalytics(options, undefined /** paths */, undefined /** dimensions */, schematic.collection.name + ':' + schematic.name);
-            }
-            // TODO: The below should be removed in version 15 when we change 1P schematics to use the `workingDirectory smart default`.
-            // Handle `"format": "path"` options.
-            const schema = schematic === null || schematic === void 0 ? void 0 : schematic.schemaJson;
-            if (!options || !schema || !(0, core_1.isJsonObject)(schema)) {
-                return options;
-            }
-            if (!('path' in options && options['path'] === undefined)) {
-                return options;
-            }
-            const properties = schema === null || schema === void 0 ? void 0 : schema['properties'];
-            if (!properties || !(0, core_1.isJsonObject)(properties)) {
-                return options;
-            }
-            const property = properties['path'];
-            if (!property || !(0, core_1.isJsonObject)(property)) {
-                return options;
+                const { collection: { name: collectionName }, name: schematicName, } = schematic;
+                const analytics = (0, analytics_1.isPackageNameSafeForAnalytics)(collectionName)
+                    ? await this.getAnalytics()
+                    : undefined;
+                analytics === null || analytics === void 0 ? void 0 : analytics.reportSchematicRunEvent({
+                    [analytics_parameters_1.EventCustomDimension.SchematicCollectionName]: collectionName,
+                    [analytics_parameters_1.EventCustomDimension.SchematicName]: schematicName,
+                    ...this.getAnalyticsParameters(options),
+                });
             }
             return options;
         });

package/src/command-builder/utilities/json-schema.d.ts

@@ -35,6 +35,6 @@ export interface Option extends yargs.Options {
      * Whether or not to report this option to the Angular Team, and which custom field to use.
      * If this is falsey, do not report this option.
      */
-    userAnalytics?: number;
+    userAnalytics?: string;
 }
 export declare function parseJsonSchemaToOptions(registry: json.schema.SchemaRegistry, schema: json.JsonObject, interactive?: boolean): Promise<Option[]>;

package/src/command-builder/utilities/json-schema.js

@@ -108,7 +108,7 @@ async function parseJsonSchemaToOptions(registry, schema, interactive = true) {
         const visible = current.visible === undefined || current.visible === true;
         const hidden = !!current.hidden || !visible;
         const xUserAnalytics = current['x-user-analytics'];
-        const userAnalytics = typeof xUserAnalytics == 'number' ? xUserAnalytics : undefined;
+        const userAnalytics = typeof xUserAnalytics === 'string' ? xUserAnalytics : undefined;
         // Deprecated is set only if it's true or a string.
         const xDeprecated = current['x-deprecated'];
         const deprecated = xDeprecated === true || typeof xDeprecated === 'string' ? xDeprecated : undefined;

package/src/commands/add/cli.d.ts

@@ -24,7 +24,6 @@ export declare class AddCommandModule extends SchematicsCommandModule implements
     builder(argv: Argv): Promise<Argv<AddCommandArgs>>;
     run(options: Options<AddCommandArgs> & OtherOptions): Promise<number | void>;
     private isProjectVersionValid;
-    reportAnalytics(options: OtherOptions, paths: string[]): Promise<void>;
     private getCollectionName;
     private isPackageInstalled;
     private executeSchematic;

package/src/commands/add/cli.js

@@ -18,7 +18,6 @@ const npm_package_arg_1 = __importDefault(require("npm-package-arg"));
 const path_1 = require("path");
 const semver_1 = require("semver");
 const workspace_schema_1 = require("../../../lib/config/workspace-schema");
-const analytics_1 = require("../../analytics/analytics");
 const schematics_command_module_1 = require("../../command-builder/schematics-command-module");
 const color_1 = require("../../utilities/color");
 const error_1 = require("../../utilities/error");
@@ -252,15 +251,6 @@ class AddCommandModule extends schematics_command_module_1.SchematicsCommandModu
         }
         return validVersion;
     }
-    async reportAnalytics(options, paths) {
-        const collection = await this.getCollectionName();
-        const dimensions = [];
-        // Add the collection if it's safe listed.
-        if (collection && (0, analytics_1.isPackageNameSafeForAnalytics)(collection)) {
-            dimensions[core_1.analytics.NgCliAnalyticsDimensions.NgAddCollection] = collection;
-        }
-        return super.reportAnalytics(options, paths, dimensions);
-    }
     async getCollectionName() {
         const [, collectionName] = this.context.args.positional;
         return collectionName;

package/src/commands/analytics/info/cli.js

@@ -20,7 +20,7 @@ class AnalyticsInfoCommandModule extends command_module_1.CommandModule {
         return localYargs.strict();
     }
     async run(_options) {
-        this.context.logger.info(await (0, analytics_1.getAnalyticsInfoString)());
+        this.context.logger.info(await (0, analytics_1.getAnalyticsInfoString)(this.context));
     }
 }
 exports.AnalyticsInfoCommandModule = AnalyticsInfoCommandModule;

package/src/commands/analytics/settings/cli.js

@@ -31,7 +31,7 @@ class AnalyticsDisableModule extends AnalyticsSettingModule {
     }
     async run({ global }) {
         await (0, analytics_1.setAnalyticsConfig)(global, false);
-        process.stderr.write(await (0, analytics_1.getAnalyticsInfoString)());
+        process.stderr.write(await (0, analytics_1.getAnalyticsInfoString)(this.context));
     }
 }
 exports.AnalyticsDisableModule = AnalyticsDisableModule;
@@ -44,7 +44,7 @@ class AnalyticsEnableModule extends AnalyticsSettingModule {
     }
     async run({ global }) {
         await (0, analytics_1.setAnalyticsConfig)(global, true);
-        process.stderr.write(await (0, analytics_1.getAnalyticsInfoString)());
+        process.stderr.write(await (0, analytics_1.getAnalyticsInfoString)(this.context));
     }
 }
 exports.AnalyticsEnableModule = AnalyticsEnableModule;
@@ -55,7 +55,7 @@ class AnalyticsPromptModule extends AnalyticsSettingModule {
         this.describe = 'Prompts the user to set the analytics gathering status interactively.';
     }
     async run({ global }) {
-        await (0, analytics_1.promptAnalytics)(global, true);
+        await (0, analytics_1.promptAnalytics)(this.context, global, true);
     }
 }
 exports.AnalyticsPromptModule = AnalyticsPromptModule;

package/src/commands/update/cli.js

@@ -145,11 +145,12 @@ class UpdateCommandModule extends command_module_1.CommandModule {
             .strict();
     }
     async run(options) {
-        var _a, _b;
+        var _a, _b, _c;
         const { logger, packageManager } = this.context;
         packageManager.ensureCompatibility();
         // Check if the current installed CLI version is older than the latest compatible version.
-        if (!environment_options_1.disableVersionCheck) {
+        // Skip when running `ng update` without a package name as this will not trigger an actual update.
+        if (!environment_options_1.disableVersionCheck && ((_a = options.packages) === null || _a === void 0 ? void 0 : _a.length)) {
             const cliVersionToInstall = await this.checkCLIVersion(options.packages, options.verbose, options.next);
             if (cliVersionToInstall) {
                 logger.warn('The installed Angular CLI version is outdated.\n' +
@@ -158,7 +159,7 @@ class UpdateCommandModule extends command_module_1.CommandModule {
             }
         }
         const packages = [];
-        for (const request of (_a = options.packages) !== null && _a !== void 0 ? _a : []) {
+        for (const request of (_b = options.packages) !== null && _b !== void 0 ? _b : []) {
             try {
                 const packageIdentifier = (0, npm_package_arg_1.default)(request);
                 // only registry identifiers are supported
@@ -210,7 +211,7 @@ class UpdateCommandModule extends command_module_1.CommandModule {
             return success ? 0 : 1;
         }
         return options.migrateOnly
-            ? this.migrateOnly(workflow, ((_b = options.packages) !== null && _b !== void 0 ? _b : [])[0], rootDependencies, options)
+            ? this.migrateOnly(workflow, ((_c = options.packages) !== null && _c !== void 0 ? _c : [])[0], rootDependencies, options)
             : this.updatePackagesAndMigrate(workflow, rootDependencies, options, packages);
     }
     async executeSchematic(workflow, collection, schematic, options = {}) {

package/src/commands/version/cli.js

@@ -18,7 +18,7 @@ const color_1 = require("../../utilities/color");
 /**
  * Major versions of Node.js that are officially supported by Angular.
  */
-const SUPPORTED_NODE_MAJORS = [14, 16];
+const SUPPORTED_NODE_MAJORS = [14, 16, 18];
 const PACKAGE_PATTERNS = [
     /^@angular\/.*/,
     /^@angular-devkit\/.*/,
@@ -100,7 +100,7 @@ class VersionCommandModule extends command_module_1.CommandModule {
         logger.info(`
       Angular CLI: ${ngCliVersion}
       Node: ${process.versions.node}${unsupportedNodeVersion ? ' (Unsupported)' : ''}
-      Package Manager: ${packageManager.name} ${(_a = packageManager.version) !== null && _a !== void 0 ? _a : '<error>'} 
+      Package Manager: ${packageManager.name} ${(_a = packageManager.version) !== null && _a !== void 0 ? _a : '<error>'}
       OS: ${process.platform} ${process.arch}
 
       Angular: ${angularCoreVersion}

package/src/utilities/completion.d.ts

@@ -21,10 +21,10 @@ export declare function considerSettingUpAutocompletion(command: string, logger:
  */
 export declare function initializeAutocomplete(): Promise<string>;
 /**
- * Returns whether the user has a global CLI install or `undefined` if this can't be determined.
+ * Returns whether the user has a global CLI install.
  * Execution from `npx` is *not* considered a global CLI install.
  *
  * This does *not* mean the current execution is from a global CLI install, only that a global
  * install exists on the system.
  */
-export declare function hasGlobalCliInstall(): Promise<boolean | undefined>;
+export declare function hasGlobalCliInstall(): Promise<boolean>;

package/src/utilities/completion.js

@@ -83,7 +83,7 @@ Appended \`source <(ng completion script)\` to \`${rcFile}\`. Restart your termi
 
     ${color_1.colors.yellow(`source <(ng completion script)`)}
     `.trim());
-    if ((await hasGlobalCliInstall()) === false) {
+    if (!(await hasGlobalCliInstall())) {
         logger.warn('Setup completed successfully, but there does not seem to be a global install of the' +
             ' Angular CLI. For autocompletion to work, the CLI will need to be on your `$PATH`, which' +
             ' is typically done with the `-g` flag in `npm install -g @angular/cli`.' +
@@ -234,27 +234,26 @@ function getShellRunCommandCandidates(shell, home) {
     }
 }
 /**
- * Returns whether the user has a global CLI install or `undefined` if this can't be determined.
+ * Returns whether the user has a global CLI install.
  * Execution from `npx` is *not* considered a global CLI install.
  *
  * This does *not* mean the current execution is from a global CLI install, only that a global
  * install exists on the system.
  */
-async function hasGlobalCliInstall() {
-    var _a;
+function hasGlobalCliInstall() {
     // List all binaries with the `ng` name on the user's `$PATH`.
-    const proc = (0, child_process_1.execFile)('which', ['-a', 'ng']);
-    let stdout = '';
-    (_a = proc.stdout) === null || _a === void 0 ? void 0 : _a.addListener('data', (content) => {
-        stdout += content;
-    });
-    const exitCode = await new Promise((resolve) => {
-        proc.addListener('exit', (exitCode) => {
-            resolve(exitCode);
-        });
-    });
-    switch (exitCode) {
-        case 0:
+    return new Promise((resolve) => {
+        (0, child_process_1.execFile)('which', ['-a', 'ng'], (error, stdout) => {
+            if (error) {
+                // No instances of `ng` on the user's `$PATH`
+                // `which` returns exit code 2 if an invalid option is specified and `-a` doesn't appear to be
+                // supported on all systems. Other exit codes mean unknown errors occurred. Can't tell whether
+                // CLI is globally installed, so treat this as inconclusive.
+                // `which` was killed by a signal and did not exit gracefully. Maybe it hung or something else
+                // went very wrong, so treat this as inconclusive.
+                resolve(false);
+                return;
+            }
             // Successfully listed all `ng` binaries on the `$PATH`. Look for at least one line which is a
             // global install. We can't easily identify global installs, but local installs are typically
             // placed in `node_modules/.bin` by NPM / Yarn. `npx` also currently caches files at
@@ -267,19 +266,8 @@ async function hasGlobalCliInstall() {
                 const localInstall = grandparent.base === 'node_modules' && parent.base === '.bin';
                 return !localInstall;
             });
-            return hasGlobalInstall;
-        case 1:
-            // No instances of `ng` on the user's `$PATH`.
-            return false;
-        case null:
-            // `which` was killed by a signal and did not exit gracefully. Maybe it hung or something else
-            // went very wrong, so treat this as inconclusive.
-            return undefined;
-        default:
-            // `which` returns exit code 2 if an invalid option is specified and `-a` doesn't appear to be
-            // supported on all systems. Other exit codes mean unknown errors occurred. Can't tell whether
-            // CLI is globally installed, so treat this as inconclusive.
-            return undefined;
-    }
+            return resolve(hasGlobalInstall);
+        });
+    });
 }
 exports.hasGlobalCliInstall = hasGlobalCliInstall;

package/src/utilities/environment-options.d.ts

@@ -6,7 +6,6 @@
  * found in the LICENSE file at https://angular.io/license
  */
 export declare const analyticsDisabled: boolean;
-export declare const analyticsShareDisabled: boolean;
 export declare const isCI: boolean;
 export declare const disableVersionCheck: boolean;
 export declare const ngDebug: boolean;

package/src/utilities/environment-options.js

@@ -7,7 +7,7 @@
  * found in the LICENSE file at https://angular.io/license
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.forceAutocomplete = exports.ngDebug = exports.disableVersionCheck = exports.isCI = exports.analyticsShareDisabled = exports.analyticsDisabled = void 0;
+exports.forceAutocomplete = exports.ngDebug = exports.disableVersionCheck = exports.isCI = exports.analyticsDisabled = void 0;
 function isPresent(variable) {
     return typeof variable === 'string' && variable !== '';
 }
@@ -24,7 +24,6 @@ function optional(variable) {
     return isEnabled(variable);
 }
 exports.analyticsDisabled = isDisabled(process.env['NG_CLI_ANALYTICS']);
-exports.analyticsShareDisabled = isDisabled(process.env['NG_CLI_ANALYTICS_SHARE']);
 exports.isCI = isEnabled(process.env['CI']);
 exports.disableVersionCheck = isEnabled(process.env['NG_DISABLE_VERSION_CHECK']);
 exports.ngDebug = isEnabled(process.env['NG_DEBUG']);

package/src/utilities/package-metadata.js

@@ -222,16 +222,11 @@ async function getNpmPackageJson(packageName, logger, options = {}) {
     const { usingYarn = false, verbose = false, registry } = options;
     ensureNpmrc(logger, usingYarn, verbose);
     const { packument } = await Promise.resolve().then(() => __importStar(require('pacote')));
-    const resultPromise = packument(packageName, {
+    const response = packument(packageName, {
         fullMetadata: true,
         ...npmrc,
         ...(registry ? { registry } : {}),
     });
-    // TODO: find some way to test this
-    const response = resultPromise.catch((err) => {
-        logger.warn(err.message || err);
-        return { requestedName: packageName };
-    });
     npmPackageJsonCache.set(packageName, response);
     return response;
 }