feat(language-service): support migrating full classes to signal queries (#58263)

devversion · devversion · commit 6342befff8ee · 2024-10-18T14:34:47.000Z
Adds a similar code action as for inputs, where users can migrate full classes to signal queries. PR Close #58263
diff --git a/packages/language-service/src/refactorings/convert_to_signal_queries/apply_query_refactoring.ts b/packages/language-service/src/refactorings/convert_to_signal_queries/apply_query_refactoring.ts
@@ -106,7 +106,7 @@ export async function applySignalQueriesRefactoring(
   } else if (incompatibilityMessages.size > 0) {
     const queryPlural = incompatibilityMessages.size === 1 ? 'query' : `queries`;
     message = `${incompatibilityMessages.size} ${queryPlural} could not be migrated.\n`;
-    message += `For more details, click on the skipped inputs and try to migrate individually.\n`;
+    message += `For more details, click on the skipped queries and try to migrate individually.\n`;
   }
 
   // Only suggest the "force ignoring" option if there are actually
diff --git a/packages/language-service/src/refactorings/convert_to_signal_queries/full_class_query_refactoring.ts b/packages/language-service/src/refactorings/convert_to_signal_queries/full_class_query_refactoring.ts
@@ -0,0 +1,117 @@
+/**
+ * @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 {CompilerOptions} from '@angular/compiler-cli';
+import {NgCompiler} from '@angular/compiler-cli/src/ngtsc/core';
+import {MigrationConfig} from '@angular/core/schematics/migrations/signal-migration/src';
+import {ApplyRefactoringProgressFn, ApplyRefactoringResult} from '@angular/language-service/api';
+import ts from 'typescript';
+import {isTypeScriptFile} from '../../utils';
+import {findTightestNode, getParentClassDeclaration} from '../../utils/ts_utils';
+import type {ActiveRefactoring} from '../refactoring';
+import {isDecoratorQueryClassField, isDirectiveOrComponentWithQueries} from './decorators';
+import {applySignalQueriesRefactoring} from './apply_query_refactoring';
+
+/**
+ * Base language service refactoring action that can convert decorator
+ * queries of a full class to signal queries.
+ *
+ * The user can click on an class with decorator queries and ask for all the queries
+ * to be migrated. All references, imports and the declaration are updated automatically.
+ */
+abstract class BaseConvertFullClassToSignalQueriesRefactoring implements ActiveRefactoring {
+  abstract config: MigrationConfig;
+
+  constructor(private project: ts.server.Project) {}
+
+  static isApplicable(
+    compiler: NgCompiler,
+    fileName: string,
+    positionOrRange: number | ts.TextRange,
+  ): boolean {
+    if (!isTypeScriptFile(fileName)) {
+      return false;
+    }
+
+    const sf = compiler.getCurrentProgram().getSourceFile(fileName);
+    if (sf === undefined) {
+      return false;
+    }
+
+    const start = typeof positionOrRange === 'number' ? positionOrRange : positionOrRange.pos;
+    const node = findTightestNode(sf, start);
+    if (node === undefined) {
+      return false;
+    }
+
+    const classDecl = getParentClassDeclaration(node);
+    if (classDecl === undefined) {
+      return false;
+    }
+    const {reflector} = compiler['ensureAnalyzed']();
+    if (!isDirectiveOrComponentWithQueries(classDecl, reflector)) {
+      return false;
+    }
+
+    const parentClassElement = ts.findAncestor(node, (n) => ts.isClassElement(n) || ts.isBlock(n));
+    if (parentClassElement === undefined) {
+      return true;
+    }
+    // If we are inside a body of e.g. an accessor, this action should not show up.
+    if (ts.isBlock(parentClassElement)) {
+      return false;
+    }
+    return isDecoratorQueryClassField(parentClassElement, reflector);
+  }
+
+  async computeEditsForFix(
+    compiler: NgCompiler,
+    compilerOptions: CompilerOptions,
+    fileName: string,
+    positionOrRange: number | ts.TextRange,
+    reportProgress: ApplyRefactoringProgressFn,
+  ): Promise<ApplyRefactoringResult> {
+    const sf = compiler.getCurrentProgram().getSourceFile(fileName);
+    if (sf === undefined) {
+      return {edits: []};
+    }
+
+    const start = typeof positionOrRange === 'number' ? positionOrRange : positionOrRange.pos;
+    const node = findTightestNode(sf, start);
+    if (node === undefined) {
+      return {edits: []};
+    }
+
+    const containingClass = getParentClassDeclaration(node);
+    if (containingClass === null) {
+      return {edits: [], errorMessage: 'Could not find a class for the refactoring.'};
+    }
+
+    return await applySignalQueriesRefactoring(
+      compiler,
+      compilerOptions,
+      this.config,
+      this.project,
+      reportProgress,
+      (queryID) => queryID.node.parent === containingClass,
+      /** allowPartialMigration */ true,
+    );
+  }
+}
+
+export class ConvertFullClassToSignalQueriesRefactoring extends BaseConvertFullClassToSignalQueriesRefactoring {
+  static id = 'convert-full-class-to-signal-queries-safe-mode';
+  static description = 'Full class: Convert all decorator queries to signal queries (safe)';
+  override config: MigrationConfig = {};
+}
+export class ConvertFullClassToSignalQueriesBestEffortRefactoring extends BaseConvertFullClassToSignalQueriesRefactoring {
+  static id = 'convert-full-class-to-signal-queries-best-effort-mode';
+  static description =
+    'Full class: Convert all decorator queries to signal queries (forcibly, ignoring errors)';
+  override config: MigrationConfig = {bestEffortMode: true};
+}
diff --git a/packages/language-service/src/refactorings/refactoring.ts b/packages/language-service/src/refactorings/refactoring.ts
@@ -22,6 +22,10 @@ import {
   ConvertFieldToSignalQueryBestEffortRefactoring,
   ConvertFieldToSignalQueryRefactoring,
 } from './convert_to_signal_queries/individual_query_refactoring';
+import {
+  ConvertFullClassToSignalQueriesBestEffortRefactoring,
+  ConvertFullClassToSignalQueriesRefactoring,
+} from './convert_to_signal_queries/full_class_query_refactoring';
 
 /**
  * Interface exposing static metadata for a {@link Refactoring},
@@ -80,4 +84,6 @@ export const allRefactorings: Refactoring[] = [
   // Queries migration
   ConvertFieldToSignalQueryRefactoring,
   ConvertFieldToSignalQueryBestEffortRefactoring,
+  ConvertFullClassToSignalQueriesRefactoring,
+  ConvertFullClassToSignalQueriesBestEffortRefactoring,
 ];
diff --git a/packages/language-service/test/signal_queries_refactoring_action_spec.ts b/packages/language-service/test/signal_queries_refactoring_action_spec.ts

Original file line number	Diff line number	Diff line change
`@@ -106,7 +106,7 @@ export async function applySignalQueriesRefactoring(`
`106`	`106`	`} else if (incompatibilityMessages.size > 0) {`
`107`	`107`	const queryPlural = incompatibilityMessages.size === 1 ? 'query' : `queries`;
`108`	`108`	message = `${incompatibilityMessages.size} ${queryPlural} could not be migrated.\n`;
`109`		- message += `For more details, click on the skipped inputs and try to migrate individually.\n`;
	`109`	+ message += `For more details, click on the skipped queries and try to migrate individually.\n`;
`110`	`110`	`}`
`111`	`111`
`112`	`112`	`// Only suggest the "force ignoring" option if there are actually`