Ensure Language Server can start without ICU (#5196)

For #5043

Author: DonJayamanne

news/1 Enhancements/5043.md

@@ -0,0 +1 @@
+Ensure `Language Server` can start without [ICU](http://site.icu-project.org/home).

src/client/activation/languageServer/activator.ts

@@ -50,7 +50,7 @@ export class LanguageServerExtensionActivator implements ILanguageServerActivato
         this.manager.dispose();
     }
     @traceDecorators.error('Failed to ensure language server is available')
-    protected async ensureLanguageServerIsAvailable(resource: Resource) {
+    public async ensureLanguageServerIsAvailable(resource: Resource) {
         const settings = this.configurationService.getSettings(resource);
         if (!settings.downloadLanguageServer) {
             return;
@@ -60,6 +60,15 @@ export class LanguageServerExtensionActivator implements ILanguageServerActivato
         const mscorlib = path.join(languageServerFolderPath, 'mscorlib.dll');
         if (!(await this.fs.fileExists(mscorlib))) {
             await this.lsDownloader.downloadLanguageServer(languageServerFolderPath, this.resource);
+            await this.prepareLanguageServerForNoICU(languageServerFolderPath);
         }
     }
+    public async prepareLanguageServerForNoICU(languageServerFolderPath: string): Promise<void> {
+        const targetJsonFile = path.join(languageServerFolderPath, 'Microsoft.Python.LanguageServer.runtimeconfig.json');
+        if (await this.fs.fileExists(targetJsonFile)) {
+            return;
+        }
+        const json = { runtimeOptions: { configProperties: { 'System.Globalization.Invariant': true } } };
+        await this.fs.writeFile(targetJsonFile, JSON.stringify(json));
+    }
 }

src/test/activation/languageServer/activator.unit.test.ts

@@ -11,7 +11,6 @@ import { LanguageServerDownloader } from '../../../client/activation/languageSer
 import { LanguageServerFolderService } from '../../../client/activation/languageServer/languageServerFolderService';
 import { LanguageServerManager } from '../../../client/activation/languageServer/manager';
 import {
-    ILanguageServerActivator,
     ILanguageServerDownloader,
     ILanguageServerFolderService,
     ILanguageServerManager
@@ -30,7 +29,7 @@ import { sleep } from '../../core';
 // tslint:disable:max-func-body-length
 
 suite('Language Server - Activator', () => {
-    let activator: ILanguageServerActivator;
+    let activator: LanguageServerExtensionActivator;
     let workspaceService: IWorkspaceService;
     let manager: ILanguageServerManager;
     let fs: IFileSystem;
@@ -150,4 +149,59 @@ suite('Language Server - Activator', () => {
 
         verify(manager.dispose()).once();
     });
+    test('Download and check if ICU config exists', async () => {
+        const languageServerFolder = 'Some folder name';
+        const languageServerFolderPath = path.join(EXTENSION_ROOT_DIR, languageServerFolder);
+        const mscorlib = path.join(languageServerFolderPath, 'mscorlib.dll');
+        const targetJsonFile = path.join(languageServerFolderPath, 'Microsoft.Python.LanguageServer.runtimeconfig.json');
+
+        when(settings.downloadLanguageServer).thenReturn(true);
+        when(lsFolderService.getLanguageServerFolderName(undefined)).thenResolve(languageServerFolder);
+        when(fs.fileExists(mscorlib)).thenResolve(false);
+        when(lsDownloader.downloadLanguageServer(languageServerFolderPath, undefined)).thenResolve();
+        when(fs.fileExists(targetJsonFile)).thenResolve(false);
+
+        await activator.ensureLanguageServerIsAvailable(undefined);
+
+        verify(lsFolderService.getLanguageServerFolderName(undefined)).once();
+        verify(lsDownloader.downloadLanguageServer(anything(), undefined)).once();
+        verify(fs.fileExists(targetJsonFile)).once();
+    });
+    test('Do not download nor check if ICU config exists after downloading', async () => {
+        const languageServerFolder = 'Some folder name';
+        const languageServerFolderPath = path.join(EXTENSION_ROOT_DIR, languageServerFolder);
+        const mscorlib = path.join(languageServerFolderPath, 'mscorlib.dll');
+        const targetJsonFile = path.join(languageServerFolderPath, 'Microsoft.Python.LanguageServer.runtimeconfig.json');
+
+        when(settings.downloadLanguageServer).thenReturn(true);
+        when(lsFolderService.getLanguageServerFolderName(undefined)).thenResolve(languageServerFolder);
+        when(fs.fileExists(mscorlib)).thenResolve(true);
+
+        await activator.ensureLanguageServerIsAvailable(undefined);
+
+        verify(lsFolderService.getLanguageServerFolderName(undefined)).once();
+        verify(lsDownloader.downloadLanguageServer(anything(), undefined)).never();
+        verify(fs.fileExists(targetJsonFile)).never();
+    });
+    test('JSON file is created to ensure LS can start without ICU', async () => {
+        const targetJsonFile = path.join('some folder', 'Microsoft.Python.LanguageServer.runtimeconfig.json');
+        const contents = { runtimeOptions: { configProperties: { 'System.Globalization.Invariant': true } } };
+        when(fs.fileExists(targetJsonFile)).thenResolve(false);
+        when(fs.writeFile(targetJsonFile, JSON.stringify(contents))).thenResolve();
+
+        await activator.prepareLanguageServerForNoICU('some folder');
+
+        verify(fs.fileExists(targetJsonFile)).atLeast(1);
+        verify(fs.writeFile(targetJsonFile, JSON.stringify(contents))).once();
+    });
+    test('JSON file is not created if it already exists', async () => {
+        const targetJsonFile = path.join('some folder', 'Microsoft.Python.LanguageServer.runtimeconfig.json');
+        const contents = { runtimeOptions: { configProperties: { 'System.Globalization.Invariant': true } } };
+        when(fs.fileExists(targetJsonFile)).thenResolve(true);
+
+        await activator.prepareLanguageServerForNoICU('some folder');
+
+        verify(fs.fileExists(targetJsonFile)).atLeast(1);
+        verify(fs.writeFile(targetJsonFile, JSON.stringify(contents))).never();
+    });
 });