Graham/angular-cli
1
0
Fork 0
mirror of https://github.com/angular/angular-cli.git synced 2025-05-21 22:34:21 +08:00
Code Issues Packages Projects Releases Wiki Activity

refactor(@angular/cli): remove hasAnalyticsConfig analytics logic

Browse Source 
With this change we clean up further the analytics code and re-use the `getAnalytics` to determine if the config is set or not.

Also, this change inclused a refactor to the `createAnalytics` method to make it more readable.
This commit is contained in:
Alan Agius 2022-03-16 19:21:08 +01:00 committed by Douglas Parker
parent 1a36fd94a8
commit a497d12a6b
2 changed files with 48 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
packages/angular/cli/bin/postinstall/analytics-prompt.js vendored
View File

@ -17,7 +17,7 @@ try {
var analytics = require('../../src/analytics/analytics');
analytics
.hasAnalyticsConfig('global')
.getAnalytics('global')
.then((hasGlobalConfig) => {
if (!hasGlobalConfig) {
return analytics.promptAnalytics(true /** global */);

82
packages/angular/cli/src/analytics/analytics.ts
View File

@ -152,16 +152,21 @@ export async function promptAnalytics(global: boolean, force = false): Promise<b
/**
* Get the analytics object for the user.
*
* @returns
* - `AnalyticsCollector` when enabled.
* - `analytics.NoopAnalytics` when disabled.
* - `undefined` when not configured.
*/
export async function getAnalytics(
level: 'local' | 'global',
): Promise<AnalyticsCollector | undefined> {
): Promise<AnalyticsCollector | analytics.NoopAnalytics | undefined> {
analyticsDebug('getAnalytics');
if (analyticsDisabled) {
analyticsDebug('NG_CLI_ANALYTICS is false');
return undefined;
return new analytics.NoopAnalytics();
}
try {
@ -170,7 +175,9 @@ export async function getAnalytics(
workspace?.getCli()['analytics'];
analyticsDebug('Workspace Analytics config found: %j', analyticsConfig);
if (!analyticsConfig) {
if (analyticsConfig === false) {
return new analytics.NoopAnalytics();
} else if (analyticsConfig === undefined || analyticsConfig === null) {
return undefined;
} else {
let uid: string | undefined = undefined;
@ -231,33 +238,49 @@ export async function createAnalytics(
workspace: boolean,
skipPrompt = false,
): Promise<analytics.Analytics> {
let config: analytics.Analytics | undefined;
const isDisabledGlobally = (await getWorkspace('global'))?.getCli()['analytics'] === false;
// If in workspace and global analytics is enabled, defer to workspace level
if (workspace && !isDisabledGlobally) {
const skipAnalytics = skipPrompt || analyticsDisabled;
// TODO: This should honor the `no-interactive` option.
// It is currently not an `ng` option but rather only an option for specific commands.
// The concept of `ng`-wide options are needed to cleanly handle this.
if (!skipAnalytics && !(await hasAnalyticsConfig('local'))) {
await promptAnalytics(false);
}
config = await getAnalytics('local');
} else {
config = await getAnalytics('global');
// Global config takes precedence over local config only for the disabled check.
// IE:
// global: disabled & local: enabled = disabled
// global: id: 123 & local: id: 456 = 456
// check global
const globalConfig = await getAnalytics('global');
if (globalConfig instanceof analytics.NoopAnalytics) {
return globalConfig;
}
const maybeSharedAnalytics = await getSharedAnalytics();
let config = globalConfig;
// Not disabled globally, check locally.
if (workspace) {
let localConfig = await getAnalytics('local');
if (localConfig === undefined) {
if (!skipPrompt) {
// local is not unset, prompt user.
// TODO: This should honor the `no-interactive` option.
// It is currently not an `ng` option but rather only an option for specific commands.
// The concept of `ng`-wide options are needed to cleanly handle this.
await promptAnalytics(false);
localConfig = await getAnalytics('local');
}
}
if (localConfig instanceof analytics.NoopAnalytics) {
return localConfig;
} else if (localConfig) {
// Favor local settings over global when defined.
config = localConfig;
}
}
// Get shared analytics
// TODO: evalute if this should be completly removed.
const maybeSharedAnalytics = await getSharedAnalytics();
if (config && maybeSharedAnalytics) {
return new analytics.MultiAnalytics([config, maybeSharedAnalytics]);
} else if (config) {
return config;
} else if (maybeSharedAnalytics) {
return maybeSharedAnalytics;
} else {
return new analytics.NoopAnalytics();
}
return config ?? maybeSharedAnalytics ?? new analytics.NoopAnalytics();
}
function analyticsConfigValueToHumanFormat(value: unknown): 'enabled' | 'disabled' | 'not set' {
@ -295,14 +318,3 @@ export async function getAnalyticsInfoString(): Promise<string> {
` + '\n'
);
}
export async function hasAnalyticsConfig(level: 'local' | 'global'): Promise<boolean> {
try {
const workspace = await getWorkspace(level);
if (workspace?.getCli()['analytics'] !== undefined) {
return true;
}
} catch {}
return false;
}