refactor(@schematics/angular): add Karma configuration analyzer and comparer

packages/schematics/angular/migrations/karma/karma-config-analyzer.ts

@@ -0,0 +1,159 @@
+/**
+ * @license
+ * Copyright Google LLC All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.dev/license
+ */
+
+import ts from '../../third_party/github.com/Microsoft/TypeScript/lib/typescript';
+
+export interface RequireInfo {
+  module: string;
+  export?: string;
+  isCall?: boolean;
+  arguments?: KarmaConfigValue[];
+}
+
+export type KarmaConfigValue =
+  | string
+  | boolean
+  | number
+  | KarmaConfigValue[]
+  | { [key: string]: KarmaConfigValue }
+  | RequireInfo
+  | undefined;
+
+export interface KarmaConfigAnalysis {
+  settings: Map<string, KarmaConfigValue>;
+  hasUnsupportedValues: boolean;
+}
+
+function isRequireInfo(value: KarmaConfigValue): value is RequireInfo {
+  return typeof value === 'object' && value !== null && !Array.isArray(value) && 'module' in value;
+}
+
+function isSupportedPropertyAssignment(
+  prop: ts.ObjectLiteralElementLike,
+): prop is ts.PropertyAssignment & { name: ts.Identifier | ts.StringLiteral } {
+  return (
+    ts.isPropertyAssignment(prop) && (ts.isIdentifier(prop.name) || ts.isStringLiteral(prop.name))
+  );
+}
+
+/**
+ * Analyzes the content of a Karma configuration file to extract its settings.
+ *
+ * @param content The string content of the `karma.conf.js` file.
+ * @returns An object containing the configuration settings and a flag indicating if unsupported values were found.
+ */
+export function analyzeKarmaConfig(content: string): KarmaConfigAnalysis {
+  const sourceFile = ts.createSourceFile('karma.conf.js', content, ts.ScriptTarget.Latest, true);
+  const settings = new Map<string, KarmaConfigValue>();
+  let hasUnsupportedValues = false;
+
+  function visit(node: ts.Node) {
+    // The Karma configuration is defined within a `config.set({ ... })` call.
+    if (
+      ts.isCallExpression(node) &&
+      ts.isPropertyAccessExpression(node.expression) &&
+      node.expression.expression.getText(sourceFile) === 'config' &&
+      node.expression.name.text === 'set' &&
+      node.arguments.length === 1 &&
+      ts.isObjectLiteralExpression(node.arguments[0])
+    ) {
+      // We found `config.set`, now we extract the properties from the object literal.
+      for (const prop of node.arguments[0].properties) {
+        if (isSupportedPropertyAssignment(prop)) {
+          const key = prop.name.text;
+          const value = extractValue(prop.initializer);
+          settings.set(key, value);
+        } else {
+          hasUnsupportedValues = true;
+        }
+      }
+    } else {
+      ts.forEachChild(node, visit);
+    }
+  }
+
+  function extractValue(node: ts.Expression): KarmaConfigValue {
+    switch (node.kind) {
+      case ts.SyntaxKind.StringLiteral:
+        return (node as ts.StringLiteral).text;
+      case ts.SyntaxKind.NumericLiteral:
+        return Number((node as ts.NumericLiteral).text);
+      case ts.SyntaxKind.TrueKeyword:
+        return true;
+      case ts.SyntaxKind.FalseKeyword:
+        return false;
+      case ts.SyntaxKind.Identifier: {
+        const identifier = (node as ts.Identifier).text;
+        if (identifier === '__dirname' || identifier === '__filename') {
+          return identifier;
+        }
+        break;
+      }
+      case ts.SyntaxKind.CallExpression: {
+        const callExpr = node as ts.CallExpression;
+        // Handle require('...')
+        if (
+          ts.isIdentifier(callExpr.expression) &&
+          callExpr.expression.text === 'require' &&
+          callExpr.arguments.length === 1 &&
+          ts.isStringLiteral(callExpr.arguments[0])
+        ) {
+          return { module: callExpr.arguments[0].text };
+        }
+
+        // Handle calls on a require, e.g. require('path').join()
+        const calleeValue = extractValue(callExpr.expression);
+        if (isRequireInfo(calleeValue)) {
+          return {
+            ...calleeValue,
+            isCall: true,
+            arguments: callExpr.arguments.map(extractValue),
+          };
+        }
+        break;
+      }
+      case ts.SyntaxKind.PropertyAccessExpression: {
+        const propAccessExpr = node as ts.PropertyAccessExpression;
+        const value = extractValue(propAccessExpr.expression);
+        if (isRequireInfo(value)) {
+          const currentExport = value.export
+            ? `${value.export}.${propAccessExpr.name.text}`
+            : propAccessExpr.name.text;
+
+          return { ...value, export: currentExport };
+        }
+        break;
+      }
+      case ts.SyntaxKind.ArrayLiteralExpression:
+        return (node as ts.ArrayLiteralExpression).elements.map(extractValue);
+      case ts.SyntaxKind.ObjectLiteralExpression: {
+        const obj: { [key: string]: KarmaConfigValue } = {};
+        for (const prop of (node as ts.ObjectLiteralExpression).properties) {
+          if (isSupportedPropertyAssignment(prop)) {
+            // Recursively extract values for nested objects.
+            obj[prop.name.text] = extractValue(prop.initializer);
+          } else {
+            hasUnsupportedValues = true;
+          }
+        }
+
+        return obj;
+      }
+    }
+
+    // For complex expressions (like variables) that we don't need to resolve,
+    // we mark the analysis as potentially incomplete.
+    hasUnsupportedValues = true;
+
+    return undefined;
+  }
+
+  visit(sourceFile);
+
+  return { settings, hasUnsupportedValues };
+}