Ensure configuration is init before service init (#820)

* Implement review comments and add unit test
* Update dependencies
* Added comments to unit test

Author: kaisalmen

.vscode/launch.json

@@ -28,7 +28,7 @@
           "request": "launch",
           "url": "http://localhost:20001",
           "webRoot": "${workspaceFolder}",
-          "userDataDir": "${workspaceFolder/.chrome/profile"
+          "userDataDir": "${workspaceFolder}/.chrome/profile"
         },
         {
           "name": "Chrome Preview",

package-lock.json

@@ -18,16 +18,16 @@
     "@eslint/js": "~9.17.0",
     "@stylistic/eslint-plugin": "~2.12.1",
     "@testing-library/react": "~16.1.0",
-    "@types/node": "~22.10.2",
+    "@types/node": "~22.10.5",
     "@types/react": "~18.3.14",
     "@types/react-dom": "~18.3.3",
     "@types/vscode": "~1.95.0",
-    "@typescript-eslint/eslint-plugin": "~8.18.1",
-    "@typescript-eslint/parser": "~8.18.1",
+    "@typescript-eslint/eslint-plugin": "~8.19.1",
+    "@typescript-eslint/parser": "~8.19.1",
     "@vitejs/plugin-react": "~4.3.4",
     "@vitest/browser": "~2.1.8",
     "editorconfig": "~2.0.0",
-    "esbuild": "~0.24.0",
+    "esbuild": "~0.24.2",
     "eslint": "~9.17.0",
     "eslint-plugin-header": "~3.1.1",
     "eslint-plugin-import": "~2.31.0",
@@ -37,7 +37,7 @@
     "minimatch": "~10.0.1",
     "playwright": "~1.49.1",
     "typescript": "~5.7.2",
-    "vite": "~6.0.3",
+    "vite": "~6.0.7",
     "vite-node": "~2.1.8",
     "vitest": "~2.1.8"
   },
@@ -79,6 +79,6 @@
     "packages/examples"
   ],
   "overrides": {
-    "vite": "~6.0.3"
+    "vite": "~6.0.7"
   }
 }

package.json

@@ -17,7 +17,7 @@ import { EnvironmentOverride } from 'vscode/workbench';
 import { Logger } from 'monaco-languageclient/tools';
 import { FakeWorker as Worker } from './fakeWorker.js';
 import { setUnexpectedErrorHandler } from 'vscode/monaco';
-import { updateUserConfiguration } from '@codingame/monaco-vscode-configuration-service-override';
+import { initUserConfiguration } from '@codingame/monaco-vscode-configuration-service-override';
 
 export interface MonacoEnvironmentEnhanced extends monaco.Environment {
     vscodeInitialising?: boolean;
@@ -94,25 +94,31 @@ export const mergeServices = (overrideServices: monaco.editor.IEditorOverrideSer
     }
 };
 
-export const initServices = async (vscodeApiConfig: VscodeApiConfig, instructions: InitServicesInstructions) => {
+export const initServices = async (vscodeApiConfig: VscodeApiConfig, instructions?: InitServicesInstructions) => {
     const envEnhanced = initEnhancedMonacoEnvironment();
 
     if (!(envEnhanced.vscodeInitialising ?? false)) {
+
         if (envEnhanced.vscodeApiInitialised ?? false) {
-            instructions.logger?.debug('Initialization of vscode services can only performed once!');
+            instructions?.logger?.debug('Initialization of vscode services can only performed once!');
         } else {
             envEnhanced.vscodeInitialising = true;
-            instructions.logger?.debug(`Initializing vscode services. Caller: ${instructions.caller ?? 'unknown'}`);
+            instructions?.logger?.debug(`Initializing vscode services. Caller: ${instructions.caller ?? 'unknown'}`);
 
+            if (vscodeApiConfig.userConfiguration?.json !== undefined) {
+                await initUserConfiguration(vscodeApiConfig.userConfiguration.json);
+            }
             await importAllServices(vscodeApiConfig, instructions);
+
             vscodeApiConfig.viewsConfig?.viewsInitFunc?.();
-            instructions.logger?.debug('Initialization of vscode services completed successfully.');
+            instructions?.logger?.debug('Initialization of vscode services completed successfully.');
 
             envEnhanced.vscodeApiInitialised = true;
+            envEnhanced.vscodeInitialising = false;
         }
-
-        await updateUserConfiguration(vscodeApiConfig.userConfiguration?.json ?? JSON.stringify({}));
     }
+
+    return envEnhanced.vscodeApiInitialised;
 };
 
 /**
@@ -126,25 +132,25 @@ export const initServices = async (vscodeApiConfig: VscodeApiConfig, instruction
  *   - languages
  *   - model
  */
-export const importAllServices = async (vscodeApiConfig: VscodeApiConfig, instructions: InitServicesInstructions) => {
+export const importAllServices = async (vscodeApiConfig: VscodeApiConfig, instructions?: InitServicesInstructions) => {
     const services = await supplyRequiredServices();
 
     mergeServices(services, vscodeApiConfig.serviceOverrides);
     await configureExtHostWorker(vscodeApiConfig.enableExtHostWorker === true, services);
 
-    reportServiceLoading(services, instructions.logger);
+    reportServiceLoading(services, instructions?.logger);
 
-    if (instructions.performServiceConsistencyChecks === undefined ||
+    if (instructions?.performServiceConsistencyChecks === undefined ||
         (typeof instructions.performServiceConsistencyChecks === 'function' && instructions.performServiceConsistencyChecks())) {
         if (vscodeApiConfig.viewsConfig?.viewServiceType === 'ViewsService' || vscodeApiConfig.viewsConfig?.viewServiceType === 'WorkspaceService') {
-            await initialize(services, instructions.htmlContainer, vscodeApiConfig.workspaceConfig, vscodeApiConfig.envOptions);
+            await initialize(services, instructions?.htmlContainer, vscodeApiConfig.workspaceConfig, vscodeApiConfig.envOptions);
         } else {
             await initialize(services, undefined, vscodeApiConfig.workspaceConfig, vscodeApiConfig.envOptions);
         }
     }
 
     setUnexpectedErrorHandler((e) => {
-        instructions.logger?.createErrorAndLog('Unexpected error', e);
+        instructions?.logger?.createErrorAndLog('Unexpected error', e);
     });
 };
 

packages/client/src/vscode/services.ts

@@ -0,0 +1,49 @@
+/* --------------------------------------------------------------------------------------------
+ * Copyright (c) 2024 TypeFox and others.
+ * Licensed under the MIT License. See LICENSE in the package root for license information.
+ * ------------------------------------------------------------------------------------------ */
+
+import { describe, expect, test } from 'vitest';
+import { initServices, MonacoEnvironmentEnhanced } from 'monaco-languageclient/vscode/services';
+import getConfigurationServiceOverride from '@codingame/monaco-vscode-configuration-service-override';
+
+describe('VSCde services Tests', () => {
+
+    test('initServices', async () => {
+        const vscodeApiConfig = {
+            serviceOverrides: {
+                ...getConfigurationServiceOverride()
+            },
+            userConfiguration: {
+                json: JSON.stringify({
+                    'workbench.colorTheme': 'Default Dark Modern'
+                })
+            }
+        };
+
+        let envEnhanced = (self as Window).MonacoEnvironment as MonacoEnvironmentEnhanced;
+        expect(envEnhanced).toBeUndefined();
+
+        // call initServices with userConfiguration
+        const promise = initServices(vscodeApiConfig);
+        envEnhanced = (self as Window).MonacoEnvironment as MonacoEnvironmentEnhanced;
+        expect(envEnhanced.vscodeInitialising).toBeTruthy();
+        expect(envEnhanced.vscodeApiInitialised).toBeFalsy();
+
+        // try a second time and expect that the api init is ongoing but not completed
+        const secondCallResult = await initServices(vscodeApiConfig);
+
+        expect(secondCallResult).toBeFalsy();
+        envEnhanced = (self as Window).MonacoEnvironment as MonacoEnvironmentEnhanced;
+        expect(envEnhanced.vscodeInitialising).toBeTruthy();
+        expect(envEnhanced.vscodeApiInitialised).toBeFalsy();
+
+        // wait for the initial promise to complete and expect that api init was completed and is no longer ongoing
+        const initialCallResult = await promise;
+        expect(initialCallResult).toBeTruthy();
+        envEnhanced = (self as Window).MonacoEnvironment as MonacoEnvironmentEnhanced;
+        expect(envEnhanced.vscodeInitialising).toBeFalsy();
+        expect(envEnhanced.vscodeApiInitialised).toBeTruthy();
+    });
+
+});

packages/client/test/vscode/services.test.ts

@@ -89,6 +89,7 @@
     "@codingame/monaco-vscode-standalone-json-language-features": "~11.1.2",
     "@codingame/monaco-vscode-standalone-languages": "~11.1.2",
     "@codingame/monaco-vscode-standalone-typescript-language-features": "~11.1.2",
+    "@codingame/monaco-vscode-storage-service-override": "~11.1.2",
     "@codingame/monaco-vscode-textmate-service-override": "~11.1.2",
     "@codingame/monaco-vscode-theme-defaults-default-extension": "~11.1.2",
     "@codingame/monaco-vscode-theme-service-override": "~11.1.2",

packages/examples/package.json

@@ -18,6 +18,7 @@ import { RegisteredFileSystemProvider, registerFileSystemOverlay, RegisteredMemo
 import getRemoteAgentServiceOverride from '@codingame/monaco-vscode-remote-agent-service-override';
 import getEnvironmentServiceOverride from '@codingame/monaco-vscode-environment-service-override';
 import getSecretStorageServiceOverride from '@codingame/monaco-vscode-secret-storage-service-override';
+import getStorageServiceOverride from '@codingame/monaco-vscode-storage-service-override';
 // this is required syntax highlighting
 import '@codingame/monaco-vscode-typescript-basics-default-extension';
 import '@codingame/monaco-vscode-typescript-language-features-default-extension';
@@ -53,7 +54,8 @@ export const runApplicationPlayground = async () => {
                 ...getExplorerServiceOverride(),
                 ...getRemoteAgentServiceOverride(),
                 ...getEnvironmentServiceOverride(),
-                ...getSecretStorageServiceOverride()
+                ...getSecretStorageServiceOverride(),
+                ...getStorageServiceOverride()
             },
             enableExtHostWorker: true,
             viewsConfig: {

packages/examples/src/appPlayground/main.ts

@@ -15,24 +15,24 @@ import { WebSocketMessageReader, WebSocketMessageWriter, toSocket } from 'vscode
 import { CloseAction, ErrorAction, MessageTransports } from 'vscode-languageclient/browser.js';
 import { configureMonacoWorkers } from '../common/client/utils.js';
 import { ConsoleLogger } from 'monaco-languageclient/tools';
-import { updateUserConfiguration } from '@codingame/monaco-vscode-configuration-service-override';
 
 export const runClient = async () => {
     const logger = new ConsoleLogger(LogLevel.Debug);
     const htmlContainer = document.getElementById('monaco-editor-root')!;
     await initServices({
         serviceOverrides: {
             ...getConfigurationServiceOverride()
-        }
+        },
+        userConfiguration: {
+            json: JSON.stringify({
+                'editor.experimental.asyncTokenization': true
+            })
+        },
     }, {
         htmlContainer,
         logger
     });
 
-    updateUserConfiguration(JSON.stringify({
-        'editor.experimental.asyncTokenization': true
-    }));
-
     // register the JSON language with Monaco
     monaco.languages.register({
         id: 'json',

packages/examples/src/bare/client.ts

@@ -5,7 +5,7 @@
 
 import { describe, expect, test } from 'vitest';
 import { LogLevel } from 'vscode/services';
-import { augmentVscodeApiConfig } from '../../src/vscode/services.js';
+import { augmentVscodeApiConfig } from 'monaco-editor-wrapper/vscode/services';
 
 describe('createUrl', () => {
 

packages/wrapper/test/vscode/services.test.ts

@@ -26,7 +26,10 @@ export const vitestBaseConfig = {
             }
         },
         include: [
+            '**/client/test/fs/emptyEndpoint.test.ts',
             '**/client/test/tools/index.test.ts',
+            '**/client/test/tools/utils.test.ts',
+            '**/client/test/vscode/services.test.ts',
             '**/wrapper/test/vscode/services.test.ts',
             '**/wrapper/test/editorApp.test.ts',
             '**/wrapper/test/languageClientWrapper.test.ts',