refactor(@angular/cli): remove most of getWorkspaceRaw usages

This changes removes most of the usage of `getWorkspaceRaw` in the Angular CLI. This is needed to eventually drop the direct dependency on `jsonc-parser`.

Author: alan-agius4

packages/angular/cli/src/analytics/analytics.ts

@@ -10,7 +10,7 @@ import { analytics, json, tags } from '@angular-devkit/core';
 import debug from 'debug';
 import { v4 as uuidV4 } from 'uuid';
 import { colors } from '../utilities/color';
-import { getWorkspace, getWorkspaceRaw } from '../utilities/config';
+import { AngularWorkspace, getWorkspace } from '../utilities/config';
 import { analyticsDisabled, analyticsShareDisabled } from '../utilities/environment-options';
 import { isTTY } from '../utilities/tty';
 import { VERSION } from '../utilities/version';
@@ -64,27 +64,21 @@ export function isPackageNameSafeForAnalytics(name: string): boolean {
  * @param global Which config to use. "global" for user-level, and "local" for project-level.
  * @param value Either a user ID, true to generate a new User ID, or false to disable analytics.
  */
-export function setAnalyticsConfig(global: boolean, value: string | boolean): void {
+export async function setAnalyticsConfig(global: boolean, value: string | boolean): Promise<void> {
   const level = global ? 'global' : 'local';
   analyticsDebug('setting %s level analytics to: %s', level, value);
-  const [config, configPath] = getWorkspaceRaw(level);
-  if (!config || !configPath) {
+  const workspace = await getWorkspace(level);
+  if (!workspace) {
     throw new Error(`Could not find ${level} workspace.`);
   }
 
-  const cli = config.get(['cli']);
-
-  if (cli !== undefined && !json.isJsonObject(cli as json.JsonValue)) {
-    throw new Error(`Invalid config found at ${configPath}. CLI should be an object.`);
-  }
-
-  if (value === true) {
-    value = uuidV4();
+  const cli = (workspace.extensions['cli'] ??= {});
+  if (!workspace || !json.isJsonObject(cli)) {
+    throw new Error(`Invalid config found at ${workspace.filePath}. CLI should be an object.`);
   }
 
-  config.modify(['cli', 'analytics'], value);
-  config.save();
-
+  cli.analytics = value === true ? uuidV4() : value;
+  await workspace.save();
   analyticsDebug('done');
 }
 
@@ -96,8 +90,8 @@ export function setAnalyticsConfig(global: boolean, value: string | boolean): vo
 export async function promptAnalytics(global: boolean, force = false): Promise<boolean> {
   analyticsDebug('prompting user');
   const level = global ? 'global' : 'local';
-  const [config, configPath] = getWorkspaceRaw(level);
-  if (!config || !configPath) {
+  const workspace = await getWorkspace(level);
+  if (!workspace) {
     throw new Error(`Could not find a ${level} workspace. Are you in a project?`);
   }
 
@@ -117,7 +111,7 @@ export async function promptAnalytics(global: boolean, force = false): Promise<b
       },
     ]);
 
-    setAnalyticsConfig(global, answers.analytics);
+    await setAnalyticsConfig(global, answers.analytics);
 
     if (answers.analytics) {
       console.log('');
@@ -172,7 +166,7 @@ export async function getAnalytics(
   try {
     const workspace = await getWorkspace(level);
     const analyticsConfig: string | undefined | null | { uid?: string } =
-      workspace?.getCli()['analytics'];
+      workspace?.getCli()?.['analytics'];
     analyticsDebug('Workspace Analytics config found: %j', analyticsConfig);
 
     if (analyticsConfig === false) {
@@ -218,7 +212,7 @@ export async function getSharedAnalytics(): Promise<AnalyticsCollector | undefin
   // If anything happens we just keep the NOOP analytics.
   try {
     const globalWorkspace = await getWorkspace('global');
-    const analyticsConfig = globalWorkspace?.getCli()['analyticsSharing'];
+    const analyticsConfig = globalWorkspace?.getCli()?.['analyticsSharing'];
 
     if (!analyticsConfig || !analyticsConfig.tracking || !analyticsConfig.uuid) {
       return undefined;
@@ -294,10 +288,10 @@ function analyticsConfigValueToHumanFormat(value: unknown): 'enabled' | 'disable
 }
 
 export async function getAnalyticsInfoString(): Promise<string> {
-  const [globalWorkspace] = getWorkspaceRaw('global');
-  const [localWorkspace] = getWorkspaceRaw('local');
-  const globalSetting = globalWorkspace?.get(['cli', 'analytics']);
-  const localSetting = localWorkspace?.get(['cli', 'analytics']);
+  const globalWorkspace = await getWorkspace('global');
+  const localWorkspace = await getWorkspace('local');
+  const globalSetting = globalWorkspace?.getCli()?.['analytics'];
+  const localSetting = localWorkspace?.getCli()?.['analytics'];
 
   const analyticsInstance = await createAnalytics(
     !!localWorkspace /** workspace */,

packages/angular/cli/src/commands/analytics/settings/cli.ts

@@ -51,7 +51,7 @@ export class AnalyticsDisableModule
   describe = 'Disables analytics gathering and reporting for the user.';
 
   async run({ global }: Options<AnalyticsCommandArgs>): Promise<void> {
-    setAnalyticsConfig(global, false);
+    await setAnalyticsConfig(global, false);
     process.stderr.write(await getAnalyticsInfoString());
   }
 }
@@ -64,7 +64,7 @@ export class AnalyticsEnableModule
   aliases = 'on';
   describe = 'Enables analytics gathering and reporting for the user.';
   async run({ global }: Options<AnalyticsCommandArgs>): Promise<void> {
-    setAnalyticsConfig(global, true);
+    await setAnalyticsConfig(global, true);
     process.stderr.write(await getAnalyticsInfoString());
   }
 }

packages/angular/cli/src/commands/cache/settings/cli.ts

@@ -25,8 +25,8 @@ export class CacheDisableModule extends CommandModule implements CommandModuleIm
     return localYargs;
   }
 
-  run(): void {
-    updateCacheConfig('enabled', false);
+  run(): Promise<void> {
+    return updateCacheConfig(this.getWorkspaceOrThrow(), 'enabled', false);
   }
 }
 
@@ -41,7 +41,7 @@ export class CacheEnableModule extends CommandModule implements CommandModuleImp
     return localYargs;
   }
 
-  run(): void {
-    updateCacheConfig('enabled', true);
+  run(): Promise<void> {
+    return updateCacheConfig(this.getWorkspaceOrThrow(), 'enabled', true);
   }
 }

packages/angular/cli/src/commands/cache/utilities.ts

@@ -9,16 +9,18 @@
 import { isJsonObject } from '@angular-devkit/core';
 import { resolve } from 'path';
 import { Cache, Environment } from '../../../lib/config/workspace-schema';
-import { AngularWorkspace, getWorkspaceRaw } from '../../utilities/config';
-
-export function updateCacheConfig<K extends keyof Cache>(key: K, value: Cache[K]): void {
-  const [localWorkspace] = getWorkspaceRaw('local');
-  if (!localWorkspace) {
-    throw new Error('Cannot find workspace configuration file.');
-  }
-
-  localWorkspace.modify(['cli', 'cache', key], value);
-  localWorkspace.save();
+import { AngularWorkspace } from '../../utilities/config';
+
+export function updateCacheConfig<K extends keyof Cache>(
+  workspace: AngularWorkspace,
+  key: K,
+  value: Cache[K],
+): Promise<void> {
+  const cli = (workspace.extensions['cli'] ??= {}) as Record<string, Record<string, unknown>>;
+  const cache = (cli['cache'] ??= {});
+  cache[key] = value;
+
+  return workspace.save();
 }
 
 export function getCacheConfig(workspace: AngularWorkspace | undefined): Required<Cache> {

packages/angular/cli/src/utilities/config.ts

@@ -117,7 +117,10 @@ function globalFilePath(): string | null {
 export class AngularWorkspace {
   readonly basePath: string;
 
-  constructor(private workspace: workspaces.WorkspaceDefinition, readonly filePath: string) {
+  constructor(
+    private readonly workspace: workspaces.WorkspaceDefinition,
+    readonly filePath: string,
+  ) {
     this.basePath = path.dirname(filePath);
   }
 
@@ -132,15 +135,19 @@ export class AngularWorkspace {
   // Temporary helper functions to support refactoring
 
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  getCli(): Record<string, any> {
-    return (this.workspace.extensions['cli'] as Record<string, unknown>) || {};
+  getCli(): Record<string, any> | undefined {
+    return this.workspace.extensions['cli'] as Record<string, unknown>;
   }
 
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  getProjectCli(projectName: string): Record<string, any> {
+  getProjectCli(projectName: string): Record<string, any> | undefined {
     const project = this.workspace.projects.get(projectName);
 
-    return (project?.extensions['cli'] as Record<string, unknown>) || {};
+    return project?.extensions['cli'] as Record<string, unknown>;
+  }
+
+  save(): Promise<void> {
+    return workspaces.writeWorkspace(this.workspace, createWorkspaceHost(), this.filePath);
   }
 
   static async load(workspaceFilePath: string): Promise<AngularWorkspace> {
@@ -162,12 +169,15 @@ export async function getWorkspace(
     return cachedWorkspaces.get(level);
   }
 
-  const configPath = level === 'local' ? projectFilePath() : globalFilePath();
-
+  let configPath = level === 'local' ? projectFilePath() : globalFilePath();
   if (!configPath) {
-    cachedWorkspaces.set(level, undefined);
+    if (level === 'local') {
+      cachedWorkspaces.set(level, undefined);
+
+      return undefined;
+    }
 
-    return undefined;
+    configPath = createGlobalSettings();
   }
 
   try {