feat: move all workspace retrieval to the language server (#1402)

.eslintrc.json

@@ -12,10 +12,6 @@
             "enforceBuildableLibDependency": true,
             "allow": [],
             "depConstraints": [
-              {
-                "sourceTag": "*",
-                "onlyDependOnLibsWithTags": ["*"]
-              },
               {
                 "sourceTag": "type:vscode",
                 "onlyDependOnLibsWithTags": ["type:shared", "type:vscode"]
@@ -29,6 +25,10 @@
                 "sourceTag": "type:shared",
                 "onlyDependOnLibsWithTags": ["type:shared"],
                 "bannedExternalImports": ["vscode"]
+              },
+              {
+                "sourceTag": "type:vscode-ui",
+                "onlyDependOnLibsWithTags": ["type:shared", "type:vscode-ui"]
               }
             ]
           }

.github/workflows/ci_checks.yml

@@ -43,6 +43,8 @@ jobs:
     runs-on: ubuntu-latest
     name: Nx Cloud - Agent E2E
     timeout-minutes: 15
+    env:
+      NX_VERBOSE_LOGGING: 'false'
     steps:
       - name: Set nx run variable
         run: echo "NX_RUN_GROUP=run-group-e2e-${{ github.run_id}}-${{ github.run_attempt }}" >> $GITHUB_ENV

.github/workflows/nx-run/action.yml

@@ -9,7 +9,7 @@ runs:
       shell: bash
     - name: Workspace Lint
       run: |
-        yarn exec nx-cloud record -- yarn exec nx workspace-lint 
+        yarn exec nx-cloud record -- yarn exec nx workspace-lint
         yarn exec nx-cloud record -- yarn exec nx format:check
       shell: bash
       env:
@@ -26,6 +26,7 @@ runs:
     - name: E2E
       env:
         NX_RUN_GROUP: run-group-e2e-${{ github.run_id}}-${{ github.run_attempt }}
+        NX_VERBOSE_LOGGING: 'false'
       run: yarn exec nx affected --target=e2e --parallel=3 --configuration=ci
       shell: bash
     - name: Stopping nx-cloud ci agents

apps/nxls/project.json

@@ -40,7 +40,10 @@
       "options": {},
       "configurations": {
         "ci": {
-          "commands": ["yarn tsc -p ./apps/nxls/tsconfig.app.json --noEmit"]
+          "commands": [
+            "yarn tsc -p ./apps/nxls/tsconfig.app.json --noEmit",
+            "node ./apps/nxls/esbuild.js"
+          ]
         },
         "production": {
           "command": "node ./apps/nxls/esbuild.js"

apps/nxls/src/main.ts

@@ -3,6 +3,7 @@ import './global-polyfills';
 import { getCompletionItems } from '@nx-console/language-server/capabilities/code-completion';
 import { getDocumentLinks } from '@nx-console/language-server/capabilities/document-links';
 import {
+  NxChangeWorkspace,
   NxWorkspaceRefreshNotification,
   NxWorkspaceRequest,
 } from '@nx-console/language-server/types';
@@ -22,7 +23,7 @@ import {
   getProjectJsonSchema,
   getWorkspaceJsonSchema,
 } from '@nx-console/shared/json-schema';
-import { nxWorkspace } from '@nx-console/shared/workspace';
+import { nxWorkspace } from '@nx-console/language-server/workspace';
 import {
   ClientCapabilities,
   CompletionList,
@@ -68,17 +69,18 @@ connection.onInitialize(async (params) => {
   const { workspacePath } = params.initializationOptions ?? {};
   try {
     WORKING_PATH =
-      workspacePath ??
-      params.rootPath ??
-      URI.parse(params.rootUri ?? '').fsPath;
+      workspacePath ||
+      params.rootPath ||
+      URI.parse(params.rootUri ?? '').fsPath ||
+      params.workspaceFolders?.[0]?.uri;
 
     if (!WORKING_PATH) {
       throw 'Unable to determine workspace path';
     }
 
     CLIENT_CAPABILITIES = params.capabilities;
 
-    await configureSchemas(WORKING_PATH, CLIENT_CAPABILITIES);
+    configureSchemas(WORKING_PATH, CLIENT_CAPABILITIES);
   } catch (e) {
     lspLogger.log('Unable to get Nx info: ' + e.toString());
   }
@@ -182,25 +184,32 @@ connection.onShutdown(() => {
   jsonDocumentMapper.dispose();
 });
 
-connection.onRequest(NxWorkspaceRequest, async () => {
+connection.onRequest(NxWorkspaceRequest, async ({ reset }) => {
   if (!WORKING_PATH) {
     return new ResponseError(1000, 'Unable to get Nx info: no workspace path');
   }
 
-  const workspace = await nxWorkspace(WORKING_PATH, lspLogger);
-
-  return workspace.workspace;
+  return nxWorkspace(WORKING_PATH, lspLogger, reset);
 });
 
 connection.onNotification(NxWorkspaceRefreshNotification, async () => {
   if (!WORKING_PATH) {
-    return new ResponseError(1000, 'Unable to get Nx info: no workspace path');
+    return new ResponseError(1001, 'Unable to get Nx info: no workspace path');
   }
 
-  await nxWorkspace(WORKING_PATH, lspLogger, true);
-  await configureSchemas(WORKING_PATH, CLIENT_CAPABILITIES);
+  await reconfigure(WORKING_PATH);
+});
+
+connection.onNotification(NxChangeWorkspace, async (workspacePath) => {
+  WORKING_PATH = workspacePath;
+  await reconfigure(WORKING_PATH);
 });
 
+async function reconfigure(workingPath: string) {
+  await nxWorkspace(workingPath, lspLogger, true);
+  await configureSchemas(workingPath, CLIENT_CAPABILITIES);
+}
+
 async function configureSchemas(
   workingPath: string | undefined,
   capabilities: ClientCapabilities | undefined

apps/vscode-e2e/project.json

@@ -24,6 +24,6 @@
       "dependsOn": ["^build"]
     }
   },
-  "implicitDependencies": ["vscode", "nxls"],
+  "implicitDependencies": ["vscode"],
   "tags": []
 }

apps/vscode-e2e/specs/language-server/language-server.e2e.ts

@@ -0,0 +1,23 @@
+import { openWorkspace } from '../utils';
+
+describe('Nx Console should have the language server running', () => {
+  before(async () => {
+    await openWorkspace('nx');
+  });
+
+  it('should start the ls', async () => {
+    const workbench = await browser.getWorkbench();
+    const bottomBar = await workbench.getBottomBar();
+    await bottomBar.maximize();
+    const outputView = await bottomBar.openOutputView();
+    await outputView.wait();
+    await outputView.selectChannel('Nx Console Client');
+    const output = await outputView.getText();
+    console.log(output);
+    expect(
+      output.some((element) =>
+        element.toLowerCase().includes('createProjectGraphAsync'.toLowerCase())
+      )
+    ).toBeTruthy();
+  });
+});

apps/vscode-e2e/wdio.conf.ts

@@ -96,6 +96,8 @@ export const config: Options.Testrunner = {
       'wdio:vscodeOptions': {
         // point to the root directory of your project
         vscodeArgs: { 'disable-extensions': true },
+        userSettings: { 'NxConsoleClient.trace.server': 'info' },
+        verboseLogging: true,
         extensionPath: join(__dirname, '../..', 'dist/apps/vscode'),
       },
 

apps/vscode-ui-e2e/project.json

@@ -28,6 +28,6 @@
       }
     }
   },
-  "tags": [],
+  "tags": ["type:vscode-ui"],
   "implicitDependencies": ["vscode-ui-feature-task-execution-form"]
 }

apps/vscode-ui/project.json

@@ -99,5 +99,5 @@
       "outputs": ["coverage/apps/vscode-ui"]
     }
   },
-  "tags": []
+  "tags": ["type:vscode-ui"]
 }

apps/vscode/project.json

@@ -140,5 +140,5 @@
       "outputs": ["dist/apps/vscode"]
     }
   },
-  "tags": []
+  "tags": ["type:vscode"]
 }

apps/vscode/src/commands/refresh-workspace.ts

@@ -1,6 +1,7 @@
 import { NxWorkspaceRefreshNotification } from '@nx-console/language-server/types';
 import { sendNotification } from '@nx-console/vscode/lsp-client';
-import { getWorkspacePath, outputLogger } from '@nx-console/vscode/utils';
+import { getNxWorkspace } from '@nx-console/vscode/nx-workspace';
+import { outputLogger } from '@nx-console/vscode/utils';
 import { debounceTime, Subject } from 'rxjs';
 import { commands } from 'vscode';
 
@@ -9,12 +10,7 @@ export const REFRESH_WORKSPACE = 'nxConsole.refreshWorkspace';
 const refresh = new Subject();
 
 refresh.pipe(debounceTime(150)).subscribe(async () => {
-  const { nxWorkspace } = await import('@nx-console/shared/workspace');
-  const { daemonEnabled, workspaceType } = await nxWorkspace(
-    getWorkspacePath(),
-    outputLogger,
-    true
-  );
+  const { daemonEnabled, workspaceType } = await getNxWorkspace();
 
   if (!daemonEnabled && workspaceType === 'nx') {
     outputLogger.log('Nx Daemon is not enabled.');

apps/vscode/src/main.ts

@@ -67,6 +67,7 @@ import {
   REFRESH_WORKSPACE,
 } from './commands/refresh-workspace';
 import {
+  getNxWorkspace,
   stopDaemon,
   WorkspaceCodeLensProvider,
 } from '@nx-console/vscode/nx-workspace';
@@ -131,8 +132,7 @@ export async function activate(c: ExtensionContext) {
       revealWebViewPanelCommand,
       manuallySelectWorkspaceDefinitionCommand,
       refreshWorkspace(),
-      projectGraph(),
-      await configureLspClient(context)
+      projectGraph()
     );
 
     //   registers itself as a CodeLensProvider and watches config to dispose/re-register
@@ -226,6 +226,8 @@ async function setWorkspace(workspacePath: string) {
 
   WorkspaceConfigurationStore.instance.set('nxWorkspacePath', workspacePath);
 
+  const lspContext = configureLspClient(context);
+
   // Set the NX_WORKSPACE_ROOT_PATH as soon as possible so that the nx utils can get this.
   process.env.NX_WORKSPACE_ROOT_PATH = workspacePath;
 
@@ -258,7 +260,8 @@ async function setWorkspace(workspacePath: string) {
     context.subscriptions.push(
       nxCommandsTreeView,
       nxProjectTreeView,
-      nxHelpAndFeedbackTreeView
+      nxHelpAndFeedbackTreeView,
+      lspContext
     );
   } else {
     WorkspaceConfigurationStore.instance.set('nxWorkspacePath', workspacePath);
@@ -300,9 +303,7 @@ async function setWorkspace(workspacePath: string) {
 }
 
 async function setApplicationAndLibraryContext(workspacePath: string) {
-  const { nxWorkspace } = await import('@nx-console/shared/workspace');
-
-  const { workspaceLayout } = await nxWorkspace(workspacePath, outputLogger);
+  const { workspaceLayout } = await getNxWorkspace();
 
   commands.executeCommand('setContext', 'nxAppsDir', [
     join(workspacePath, workspaceLayout.appsDir),
@@ -346,9 +347,7 @@ async function registerWorkspaceFileWatcher(
     workspaceFileWatcher.dispose();
   }
 
-  const { nxWorkspace } = await import('@nx-console/shared/workspace');
-
-  const { workspaceLayout } = await nxWorkspace(workspacePath, outputLogger);
+  const { workspaceLayout } = await getNxWorkspace();
   const workspacePackageDirs = new Set<string>();
   workspacePackageDirs.add(workspaceLayout.appsDir);
   workspacePackageDirs.add(workspaceLayout.libsDir);

libs/language-server/capabilities/code-completion/src/lib/get-completion-items.spec.ts

@@ -1,25 +1,23 @@
-import {
-  configureJsonLanguageService,
-  getJsonLanguageService,
-} from '@nx-console/language-server/utils';
+import { configureJsonLanguageService } from '@nx-console/language-server/utils';
 import {
   CompletionType,
   EnhancedJsonSchema,
 } from '@nx-console/shared/json-schema';
-import * as workspace from '@nx-console/shared/workspace';
+import * as workspace from '@nx-console/language-server/workspace';
 import { vol } from 'memfs';
 import {
   ClientCapabilities,
   Position,
   TextDocument,
 } from 'vscode-json-languageservice';
 import { getCompletionItems } from './get-completion-items';
+import { NxWorkspace } from '@nx-console/shared/types';
 
 jest.mock(
-  '@nx-console/shared/workspace',
+  '@nx-console/language-server/workspace',
   (): Partial<typeof workspace> => ({
     nxWorkspace: jest.fn(() =>
-      Promise.resolve<workspace.NxWorkspace>({
+      Promise.resolve<NxWorkspace>({
         configurationFilePath: '/workspace.json',
         isLerna: false,
         validWorkspaceJson: true,

libs/language-server/capabilities/code-completion/src/lib/input-name-completion.ts

@@ -1,4 +1,4 @@
-import { nxWorkspace } from '@nx-console/shared/workspace';
+import { nxWorkspace } from '@nx-console/language-server/workspace';
 import {
   ASTNode,
   CompletionItem,

libs/language-server/capabilities/code-completion/src/lib/project-completion.ts

@@ -1,4 +1,4 @@
-import { nxWorkspace } from '@nx-console/shared/workspace';
+import { nxWorkspace } from '@nx-console/language-server/workspace';
 import {
   ASTNode,
   CompletionItem,

libs/language-server/capabilities/code-completion/src/lib/project-target-completion.ts

@@ -1,4 +1,4 @@
-import { nxWorkspace } from '@nx-console/shared/workspace';
+import { nxWorkspace } from '@nx-console/language-server/workspace';
 import {
   ASTNode,
   CompletionItem,

libs/language-server/capabilities/code-completion/src/lib/tags-completion.ts

@@ -1,5 +1,5 @@
 import { isArrayNode } from '@nx-console/language-server/utils';
-import { nxWorkspace } from '@nx-console/shared/workspace';
+import { nxWorkspace } from '@nx-console/language-server/workspace';
 import {
   ASTNode,
   CompletionItem,

libs/language-server/capabilities/code-completion/src/lib/targets-completion.ts

@@ -1,5 +1,5 @@
 import { isArrayNode } from '@nx-console/language-server/utils';
-import { nxWorkspace } from '@nx-console/shared/workspace';
+import { nxWorkspace } from '@nx-console/language-server/workspace';
 import {
   ASTNode,
   CompletionItem,

libs/language-server/capabilities/document-links/src/lib/target-link.ts

@@ -6,7 +6,7 @@ import {
   isStringNode,
   lspLogger,
 } from '@nx-console/language-server/utils';
-import { nxWorkspace } from '@nx-console/shared/workspace';
+import { nxWorkspace } from '@nx-console/language-server/workspace';
 import { join } from 'path';
 import {
   ASTNode,

libs/language-server/types/src/index.ts

@@ -1,11 +1,15 @@
-import { RequestType, NotificationType } from 'vscode-languageserver/node';
-import type { NxWorkspaceConfiguration } from '@nx-console/shared/workspace';
+import { NotificationType, RequestType } from 'vscode-languageserver/node';
+import { NxWorkspace } from '@nx-console/shared/types';
+
+export const NxChangeWorkspace: NotificationType<string> = new NotificationType(
+  'nx/changeWorkspace'
+);
 
 export const NxWorkspaceRefreshNotification: NotificationType<void> =
   new NotificationType('nx/refreshWorkspace');
 
 export const NxWorkspaceRequest: RequestType<
-  void,
-  NxWorkspaceConfiguration,
+  { reset: boolean },
+  NxWorkspace,
   unknown
 > = new RequestType('nx/workspace');

libs/language-server/utils/src/lib/lsp-log.ts

@@ -13,6 +13,9 @@ export function setLspLogger(connection: Connection) {
 
 export const lspLogger: Logger = {
   log(message: string, ...args: any[]) {
-    log?.(message, ...args);
+    log?.(
+      `[Nxls] - ${new Date(Date.now()).toISOString()} - ${message}\n`,
+      ...args
+    );
   },
 };

libs/language-server/workspace/README.md

@@ -0,0 +1,11 @@
+# language-server-workspace
+
+This library was generated with [Nx](https://nx.dev).
+
+## Running unit tests
+
+Run `nx test language-server-workspace` to execute the unit tests via [Jest](https://jestjs.io).
+
+## Running lint
+
+Run `nx lint language-server-workspace` to execute the lint via [ESLint](https://eslint.org/).