refactor: Remove ngcc from extension

NGCC is being removed in Angular v16. The language service should not longer attempt to run it. angular/angular-cli#24720 As a result, we can now set the support for running in untrusted workspaces to "true" since we don't have to execute ngcc from the `node_modules` folder.
atscott · Feb 15, 2023 · fc03b58 · fc03b58
1 parent 86292ea
commit fc03b58
Show file tree

Hide file tree

Showing 13 changed files with 36 additions and 400 deletions.
diff --git a/.github/workflows/node.js.yml b/.github/workflows/node.js.yml
@@ -23,7 +23,7 @@ jobs:
         node-version: 14.x
     - run: yarn install
     - run: yarn install --cwd integration/project
-    - run: cd integration/project && yarn ngcc
+    - run: cd integration/project
     - run: scripts/build.sh package.json
     - run: xvfb-run -a yarn run test:e2e
       if: runner.os == 'Linux'

diff --git a/client/src/client.ts b/client/src/client.ts
@@ -12,7 +12,7 @@ import * as vscode from 'vscode';
 import * as lsp from 'vscode-languageclient/node';
 
 import {OpenOutputChannel, ProjectLoadingFinish, ProjectLoadingStart, SuggestStrictMode, SuggestStrictModeParams} from '../../common/notifications';
-import {GetComponentsWithTemplateFile, GetTcbRequest, GetTemplateLocationForComponent, IsInAngularProject, RunNgccRequest} from '../../common/requests';
+import {GetComponentsWithTemplateFile, GetTcbRequest, GetTemplateLocationForComponent, IsInAngularProject} from '../../common/requests';
 import {resolve, Version} from '../../common/resolver';
 
 import {isInsideComponentDecorator, isInsideInlineTemplateRegion, isInsideStringLiteral} from './embedded_support';
@@ -281,16 +281,6 @@ export class AngularLanguageClient implements vscode.Disposable {
     };
   }
 
-  runNgcc(textEditor: vscode.TextEditor): void {
-    if (this.client === null) {
-      return;
-    }
-    this.client.sendRequest(RunNgccRequest, {
-      textDocument:
-          this.client.code2ProtocolConverter.asTextDocumentIdentifier(textEditor.document),
-    });
-  }
-
   get initializeResult(): lsp.InitializeResult|undefined {
     return this.client?.initializeResult;
   }
@@ -448,10 +438,6 @@ function constructArgs(
     args.push('--includeCompletionsWithSnippetText');
   }
 
-  const disableAutomaticNgcc = config.get<boolean>('angular.disableAutomaticNgcc');
-  if (disableAutomaticNgcc) {
-    args.push('--disableAutomaticNgcc');
-  }
   const disableCodeActions = config.get<boolean>('angular.disableCodeActions');
   if (disableCodeActions) {
     args.push('--disableCodeActions');

diff --git a/client/src/commands.ts b/client/src/commands.ts
@@ -115,15 +115,6 @@ function getTemplateTcb(
     }
   };
 }
-function runNgcc(ngClient: AngularLanguageClient): Command {
-  return {
-    id: 'angular.runNgcc',
-    isTextEditorCommand: true,
-    async execute(textEditor: vscode.TextEditor) {
-      ngClient.runNgcc(textEditor);
-    }
-  };
-}
 
 /**
  * Command goToComponentWithTemplateFile finds components which reference an external template in
@@ -189,7 +180,6 @@ export function registerCommands(
     restartNgServer(client),
     openLogFile(client),
     getTemplateTcb(client, context),
-    runNgcc(client),
     goToComponentWithTemplateFile(client),
     goToTemplateForComponent(client),
   ];

diff --git a/common/notifications.ts b/common/notifications.ts
@@ -27,8 +27,4 @@ export interface SuggestStrictModeParams {
 export const SuggestStrictMode =
     new NotificationType<SuggestStrictModeParams>('angular/suggestStrictMode');
 
-// Report the end of `NGCC` progress and Only used by the `ivy_spec.ts`.
-export const NgccProgressEnd =
-    new NotificationType<{configFilePath: string}>('angular/NgccProgressEnd');
-
 export const OpenOutputChannel = new NotificationType('angular/OpenOutputChannel');
diff --git a/common/requests.ts b/common/requests.ts
@@ -30,16 +30,9 @@ export interface GetTcbParams {
   position: lsp.Position;
 }
 
-export interface RunNgccParams {
-  textDocument: lsp.TextDocumentIdentifier;
-}
-
 export const GetTcbRequest =
     new lsp.RequestType<GetTcbParams, GetTcbResponse|null, /* error */ void>('angular/getTcb');
 
-export const RunNgccRequest =
-    new lsp.RequestType<RunNgccParams, void, /* error */ void>('angular/runNgcc');
-
 export interface GetTcbResponse {
   uri: lsp.DocumentUri;
   content: string;

diff --git a/integration/lsp/ivy_spec.ts b/integration/lsp/ivy_spec.ts
@@ -12,7 +12,7 @@ import {MessageConnection} from 'vscode-jsonrpc';
 import * as lsp from 'vscode-languageserver-protocol';
 import {URI} from 'vscode-uri';
 
-import {NgccProgressEnd, ProjectLanguageService, ProjectLanguageServiceParams, SuggestStrictMode, SuggestStrictModeParams} from '../../common/notifications';
+import {ProjectLanguageService, ProjectLanguageServiceParams, SuggestStrictMode, SuggestStrictModeParams} from '../../common/notifications';
 import {GetComponentsWithTemplateFile, GetTcbRequest, GetTemplateLocationForComponent, IsInAngularProject} from '../../common/requests';
 import {APP_COMPONENT, APP_COMPONENT_URI, FOO_COMPONENT, FOO_COMPONENT_URI, FOO_TEMPLATE, FOO_TEMPLATE_URI, IS_BAZEL, PROJECT_PATH, TSCONFIG} from '../test_constants';
 
@@ -41,27 +41,9 @@ describe('Angular Ivy language server', () => {
     client.dispose();
   });
 
-  it('should send ngcc progress after a project has finished loading', async () => {
-    openTextDocument(client, APP_COMPONENT);
-    const configFilePath = await onNgccProgress(client);
-    expect(configFilePath.endsWith('integration/project/tsconfig.json')).toBeTrue();
-  });
-
-  it('should disable language service until ngcc has completed', async () => {
-    openTextDocument(client, APP_COMPONENT);
-    const languageServiceEnabled = await onLanguageServiceStateNotification(client);
-    expect(languageServiceEnabled).toBeFalse();
-  });
-
-  it('should re-enable language service once ngcc has completed', async () => {
-    openTextDocument(client, APP_COMPONENT);
-    const languageServiceEnabled = await waitForNgcc(client);
-    expect(languageServiceEnabled).toBeTrue();
-  });
-
   it('should handle hover on inline template', async () => {
     openTextDocument(client, APP_COMPONENT);
-    const languageServiceEnabled = await waitForNgcc(client);
+    const languageServiceEnabled = await waitForLanguageService(client);
     expect(languageServiceEnabled).toBeTrue();
     const response = await client.sendRequest(lsp.HoverRequest.type, {
       textDocument: {
@@ -77,7 +59,7 @@ describe('Angular Ivy language server', () => {
 
   it('should show diagnostics for inline template on open', async () => {
     openTextDocument(client, APP_COMPONENT);
-    const languageServiceEnabled = await waitForNgcc(client);
+    const languageServiceEnabled = await waitForLanguageService(client);
     expect(languageServiceEnabled).toBeTrue();
     const diagnostics = await getDiagnosticsForFile(client, APP_COMPONENT);
     expect(diagnostics.length).toBe(0);
@@ -92,7 +74,7 @@ describe('Angular Ivy language server', () => {
         text: `{{ doesnotexist }}`,
       },
     });
-    const languageServiceEnabled = await waitForNgcc(client);
+    const languageServiceEnabled = await waitForLanguageService(client);
     expect(languageServiceEnabled).toBeTrue();
     const diagnostics = await getDiagnosticsForFile(client, FOO_TEMPLATE);
     expect(diagnostics.length).toBe(1);
@@ -107,7 +89,7 @@ describe('Angular Ivy language server', () => {
 
   it('should support request cancellation', async () => {
     openTextDocument(client, APP_COMPONENT);
-    const languageServiceEnabled = await waitForNgcc(client);
+    const languageServiceEnabled = await waitForLanguageService(client);
     expect(languageServiceEnabled).toBeTrue();
     // Send a request and immediately cancel it
     const promise = client.sendRequest(lsp.HoverRequest.type, {
@@ -132,7 +114,7 @@ describe('Angular Ivy language server', () => {
         text: `<div *ngIf="false"></div>`,
       },
     });
-    const languageServiceEnabled = await waitForNgcc(client);
+    const languageServiceEnabled = await waitForLanguageService(client);
     expect(languageServiceEnabled).toBeTrue();
     const response = await client.sendRequest(lsp.DefinitionRequest.type, {
       textDocument: {
@@ -168,7 +150,7 @@ describe('Angular Ivy language server', () => {
         text: `<lib-post></lib-post>`,
       },
     });
-    const languageServiceEnabled = await waitForNgcc(client);
+    const languageServiceEnabled = await waitForLanguageService(client);
     expect(languageServiceEnabled).toBeTrue();
     const response = await client.sendRequest(lsp.DefinitionRequest.type, {
       textDocument: {
@@ -199,7 +181,7 @@ export class AppComponent {
   @Input() appInput = '';
   @Output() appOutput = new EventEmitter<string>();
 }`);
-    const languageServiceEnabled = await waitForNgcc(client);
+    const languageServiceEnabled = await waitForLanguageService(client);
     expect(languageServiceEnabled).toBeTrue();
     const response = await client.sendRequest(lsp.FoldingRangeRequest.type, {
       textDocument: {
@@ -223,7 +205,7 @@ export class AppComponent {
           text: `{{ title.toString() }}`,
         },
       });
-      const languageServiceEnabled = await waitForNgcc(client);
+      const languageServiceEnabled = await waitForLanguageService(client);
       expect(languageServiceEnabled).toBeTrue();
       const response = (await client.sendRequest(lsp.SignatureHelpRequest.type, {
         textDocument: {
@@ -245,7 +227,7 @@ export class AppComponent {
           text: `{{ title.substr(0, ) }}`,
         },
       });
-      const languageServiceEnabled = await waitForNgcc(client);
+      const languageServiceEnabled = await waitForLanguageService(client);
       expect(languageServiceEnabled).toBeTrue();
       const response = (await client.sendRequest(lsp.SignatureHelpRequest.type, {
         textDocument: {
@@ -278,7 +260,7 @@ export class AppComponent {
 
     it('should retain typecheck files', async () => {
       openTextDocument(client, APP_COMPONENT);
-      const languageServiceEnabled = await waitForNgcc(client);
+      const languageServiceEnabled = await waitForLanguageService(client);
       expect(languageServiceEnabled).toBeTrue();
       // Create a file in node_modules, this will trigger a project reload via
       // the directory watcher
@@ -296,7 +278,7 @@ export class AppComponent {
   describe('completions', () => {
     it('for events', async () => {
       openTextDocument(client, FOO_TEMPLATE, `<my-app ()></my-app>`);
-      const languageServiceEnabled = await waitForNgcc(client);
+      const languageServiceEnabled = await waitForLanguageService(client);
       expect(languageServiceEnabled).toBeTrue();
       const response = await client.sendRequest(lsp.CompletionRequest.type, {
         textDocument: {
@@ -316,7 +298,7 @@ export class AppComponent {
     describe('from template files', () => {
       beforeEach(async () => {
         openTextDocument(client, FOO_TEMPLATE);
-        const languageServiceEnabled = await waitForNgcc(client);
+        const languageServiceEnabled = await waitForLanguageService(client);
         expect(languageServiceEnabled).toBeTrue();
       });
 
@@ -368,7 +350,7 @@ export class AppComponent {
     describe('from typescript files', () => {
       beforeEach(async () => {
         openTextDocument(client, APP_COMPONENT);
-        const languageServiceEnabled = await waitForNgcc(client);
+        const languageServiceEnabled = await waitForLanguageService(client);
         expect(languageServiceEnabled).toBeTrue();
       });
 
@@ -455,7 +437,7 @@ export class AppComponent {
         fs.writeFileSync(TSCONFIG, JSON.stringify(config, null, 2));
 
         openTextDocument(client, APP_COMPONENT);
-        const languageServiceEnabled = await waitForNgcc(client);
+        const languageServiceEnabled = await waitForLanguageService(client);
         expect(languageServiceEnabled).toBeTrue();
       });
 
@@ -489,7 +471,7 @@ export class AppComponent {
 
   it('should handle getTcb request', async () => {
     openTextDocument(client, FOO_TEMPLATE);
-    await waitForNgcc(client);
+    await waitForLanguageService(client);
     const response = await client.sendRequest(GetTcbRequest, {
       textDocument: {
         uri: FOO_TEMPLATE_URI,
@@ -501,7 +483,7 @@ export class AppComponent {
 
   it('should handle goToComponent request', async () => {
     openTextDocument(client, FOO_TEMPLATE);
-    await waitForNgcc(client);
+    await waitForLanguageService(client);
     const response = await client.sendRequest(GetComponentsWithTemplateFile, {
       textDocument: {
         uri: FOO_TEMPLATE_URI,
@@ -512,7 +494,7 @@ export class AppComponent {
 
   it('should handle GetTemplateLocationForComponent request', async () => {
     openTextDocument(client, FOO_TEMPLATE);
-    await waitForNgcc(client);
+    await waitForLanguageService(client);
     const response = await client.sendRequest(GetTemplateLocationForComponent, {
       textDocument: {
         uri: FOO_COMPONENT_URI,
@@ -525,7 +507,7 @@ export class AppComponent {
 
   it('should handle GetTemplateLocationForComponent request when not in component', async () => {
     openTextDocument(client, FOO_TEMPLATE);
-    await waitForNgcc(client);
+    await waitForLanguageService(client);
     const response = await client.sendRequest(GetTemplateLocationForComponent, {
       textDocument: {
         uri: FOO_COMPONENT_URI,
@@ -537,7 +519,7 @@ export class AppComponent {
 
   it('should provide a "go to component" codelens', async () => {
     openTextDocument(client, FOO_TEMPLATE);
-    await waitForNgcc(client);
+    await waitForLanguageService(client);
     const codeLensResponse = await client.sendRequest(lsp.CodeLensRequest.type, {
       textDocument: {
         uri: FOO_TEMPLATE_URI,
@@ -555,7 +537,7 @@ export class AppComponent {
 
   it('detects an Angular project', async () => {
     openTextDocument(client, FOO_TEMPLATE);
-    await waitForNgcc(client);
+    await waitForLanguageService(client);
     const templateResponse = await client.sendRequest(IsInAngularProject, {
       textDocument: {
         uri: FOO_TEMPLATE_URI,
@@ -603,7 +585,7 @@ describe('auto-apply optional chaining', () => {
     }
     `);
     openTextDocument(client, FOO_TEMPLATE, `{{ person.n }}`);
-    const languageServiceEnabled = await waitForNgcc(client);
+    const languageServiceEnabled = await waitForLanguageService(client);
     expect(languageServiceEnabled).toBeTrue();
     const response = await client.sendRequest(lsp.CompletionRequest.type, {
       textDocument: {
@@ -618,7 +600,7 @@ describe('auto-apply optional chaining', () => {
 
   it('should work on NonNullable symbol', async () => {
     openTextDocument(client, FOO_TEMPLATE, `{{ title.substr }}`);
-    const languageServiceEnabled = await waitForNgcc(client);
+    const languageServiceEnabled = await waitForLanguageService(client);
     expect(languageServiceEnabled).toBeTrue();
     const response = await client.sendRequest(lsp.CompletionRequest.type, {
       textDocument: {
@@ -655,7 +637,7 @@ describe('insert snippet text', () => {
 
   it('should be able to complete for an attribute with the value is empty', async () => {
     openTextDocument(client, FOO_TEMPLATE, `<my-app appOut></my-app>`);
-    const languageServiceEnabled = await waitForNgcc(client);
+    const languageServiceEnabled = await waitForLanguageService(client);
     expect(languageServiceEnabled).toBeTrue();
     const response = await client.sendRequest(lsp.CompletionRequest.type, {
       textDocument: {
@@ -671,7 +653,7 @@ describe('insert snippet text', () => {
 
   it('should not be included in the completion for an attribute with a value', async () => {
     openTextDocument(client, FOO_TEMPLATE, `<my-app [appInput]="1"></my-app>`);
-    const languageServiceEnabled = await waitForNgcc(client);
+    const languageServiceEnabled = await waitForLanguageService(client);
     expect(languageServiceEnabled).toBeTrue();
     const response = await client.sendRequest(lsp.CompletionRequest.type, {
       textDocument: {
@@ -709,7 +691,7 @@ describe('code fixes', () => {
 
   it('should fix error when property does not exist on type', async () => {
     openTextDocument(client, FOO_TEMPLATE, `{{titl}}`);
-    const languageServiceEnabled = await waitForNgcc(client);
+    const languageServiceEnabled = await waitForLanguageService(client);
     expect(languageServiceEnabled).toBeTrue();
     const diags = await getDiagnosticsForFile(client, FOO_TEMPLATE);
     const codeActions = await client.sendRequest(lsp.CodeActionRequest.type, {
@@ -735,7 +717,7 @@ describe('code fixes', () => {
   it('should fix error when the range the user selects is larger than the diagnostic', async () => {
     const template = `<span>{{titl}}</span>`;
     openTextDocument(client, FOO_TEMPLATE, template);
-    const languageServiceEnabled = await waitForNgcc(client);
+    const languageServiceEnabled = await waitForLanguageService(client);
     expect(languageServiceEnabled).toBeTrue();
     const diags = await getDiagnosticsForFile(client, FOO_TEMPLATE);
     const codeActions = await client.sendRequest(lsp.CodeActionRequest.type, {
@@ -771,7 +753,7 @@ describe('code fixes', () => {
         banner = '';
       }
     `);
-      const languageServiceEnabled = await waitForNgcc(client);
+      const languageServiceEnabled = await waitForLanguageService(client);
       expect(languageServiceEnabled).toBeTrue();
     });
 
@@ -838,14 +820,6 @@ describe('code fixes', () => {
   });
 });
 
-function onNgccProgress(client: MessageConnection): Promise<string> {
-  return new Promise(resolve => {
-    client.onNotification(NgccProgressEnd, (params) => {
-      resolve(params.configFilePath);
-    });
-  });
-}
-
 function onSuggestStrictMode(client: MessageConnection): Promise<string> {
   return new Promise(resolve => {
     client.onNotification(SuggestStrictMode, (params: SuggestStrictModeParams) => {
@@ -874,7 +848,6 @@ function getDiagnosticsForFile(
   });
 }
 
-async function waitForNgcc(client: MessageConnection): Promise<boolean> {
-  await onNgccProgress(client);
+async function waitForLanguageService(client: MessageConnection): Promise<boolean> {
   return onLanguageServiceStateNotification(client);
 }