Adds ability to install a missing bsc version

.vscode/launch.json

@@ -75,7 +75,7 @@
             "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
             "args": [
                 "--timeout",
-                "0"
+                "987654"
             ],
             "internalConsoleOptions": "openOnSessionStart"
         }
@@ -104,4 +104,4 @@
             ]
         }
     ]
-}
+}

package.json

@@ -70,6 +70,7 @@
         "iconv-lite": "0.4.24",
         "jszip": "^3.10.1",
         "just-throttle": "^4.0.1",
+        "md5": "^2.3.0",
         "net": "^1.0.2",
         "node-cache": "^4.2.0",
         "node-ssdp": "^4.0.0",
@@ -98,7 +99,7 @@
         "@types/fs-extra": "^5.0.4",
         "@types/glob": "^7.1.1",
         "@types/mocha": "^7.0.2",
-        "@types/node": "^12.12.0",
+        "@types/node": "^20.14.10",
         "@types/node-ssdp": "^3.3.0",
         "@types/prompt": "^1.1.2",
         "@types/resolve": "^1.20.6",
@@ -114,7 +115,7 @@
         "chalk": "^4.1.2",
         "changelog-parser": "^2.8.0",
         "coveralls-next": "^4.2.0",
-        "dayjs": "^1.11.7",
+        "dayjs": "^1.11.12",
         "deferred": "^0.7.11",
         "eslint": "^8.10.0",
         "eslint-plugin-github": "^4.3.5",
@@ -3084,6 +3085,12 @@
                 "title": "Open SceneGraph Inspector In New Window",
                 "category": "BrighterScript",
                 "icon": "$(link-external)"
+            },
+            {
+                "command": "extension.brightscript.clearNpmPackageCache",
+                "title": "Clear the extension's local node_modules cache",
+                "category": "BrighterScript",
+                "icon": "$(link-external)"
             }
         ],
         "keybindings": [

src/ActiveDeviceManager.ts

@@ -261,8 +261,8 @@ class RokuFinder extends EventEmitter {
     }
 
     private readonly client: Client;
-    private intervalId: NodeJS.Timer | null = null;
-    private timeoutId: NodeJS.Timer | null = null;
+    private intervalId: NodeJS.Timeout | null = null;
+    private timeoutId: NodeJS.Timeout | null = null;
     private running = false;
 
     public start(timeout: number) {

src/BrightScriptCommands.spec.ts

@@ -22,7 +22,7 @@ describe('BrightScriptFileUtils ', () => {
     let languagesMock;
 
     beforeEach(() => {
-        commands = new BrightScriptCommands({} as any, {} as any, {} as any, {} as any, {} as any);
+        commands = new BrightScriptCommands({} as any, {} as any, {} as any, {} as any, {} as any, {} as any);
         commandsMock = sinon.mock(commands);
         languagesMock = sinon.mock(vscode.languages);
     });

src/BrightScriptCommands.ts

@@ -14,6 +14,8 @@ import type { ActiveDeviceManager } from './ActiveDeviceManager';
 import * as xml2js from 'xml2js';
 import { firstBy } from 'thenby';
 import type { UserInputManager } from './managers/UserInputManager';
+import { clearNpmPackageCacheCommand } from './commands/ClearNpmPackageCacheCommand';
+import type { LanguageServerManager } from './LanguageServerManager';
 
 export class BrightScriptCommands {
 
@@ -22,7 +24,8 @@ export class BrightScriptCommands {
         private whatsNewManager: WhatsNewManager,
         private context: vscode.ExtensionContext,
         private activeDeviceManager: ActiveDeviceManager,
-        private userInputManager: UserInputManager
+        private userInputManager: UserInputManager,
+        private languageServerManager: LanguageServerManager
     ) {
         this.fileUtils = new BrightScriptFileUtils();
     }
@@ -39,6 +42,7 @@ export class BrightScriptCommands {
         languageServerInfoCommand.register(this.context);
         captureScreenshotCommand.register(this.context, this);
         rekeyAndPackageCommand.register(this.context, this, this.userInputManager);
+        clearNpmPackageCacheCommand.register(this.context, this.languageServerManager);
 
         this.registerGeneralCommands();
 

src/LanguageServerManager.spec.ts

@@ -15,6 +15,7 @@ import {
     LanguageClient,
     State
 } from 'vscode-languageclient/node';
+import * as childProcess from 'child_process';
 const Module = require('module');
 const sinon = createSandbox();
 
@@ -33,6 +34,8 @@ Module.prototype.require = function hijacked(file) {
 const tempDir = s`${process.cwd()}/.tmp`;
 
 describe('LanguageServerManager', () => {
+    const storageDir = s`${tempDir}/brighterscript-storage`;
+
     let languageServerManager: LanguageServerManager;
 
     beforeEach(() => {
@@ -48,6 +51,10 @@ describe('LanguageServerManager', () => {
                 update: () => { }
             }
         } as unknown as ExtensionContext;
+
+        fsExtra.removeSync(storageDir);
+        (languageServerManager['context'] as any).globalStorageUri = URI.file(storageDir);
+
     });
 
     function stubConstructClient(processor?: (LanguageClient) => void) {
@@ -64,7 +71,10 @@ describe('LanguageServerManager', () => {
         });
     }
 
-    afterEach(() => {
+    afterEach(function() {
+        //deleting certain directories take a while
+        this.timeout(30_000);
+
         sinon.restore();
         fsExtra.removeSync(tempDir);
     });
@@ -323,4 +333,80 @@ describe('LanguageServerManager', () => {
             expect(bsdkPath).to.eql(null);
         });
     });
+
+    describe('ensureBscVersionInstalled', function() {
+        //these tests take a long time (due to running `npm install`)
+        this.timeout(20_000);
+
+        it('installs a bsc version when not present', async () => {
+            expect(
+                await languageServerManager['ensureBscVersionInstalled']('0.65.0')
+            ).to.eql(s`${storageDir}/packages/brighterscript-0.65.0/node_modules/brighterscript`);
+            expect(
+                fsExtra.pathExistsSync(s`${storageDir}/packages/brighterscript-0.65.0/node_modules/brighterscript`)
+            ).to.be.true;
+        });
+
+        it('reuses the same bsc version when already exists', async () => {
+            let spy = sinon.spy(childProcess, 'exec');
+            fsExtra.ensureDirSync(
+                s`${storageDir}/packages/brighterscript-0.65.0/node_modules/brighterscript/dist/index.js`
+            );
+            expect(
+                await languageServerManager['ensureBscVersionInstalled']('0.65.0')
+            ).to.eql(s`${storageDir}/packages/brighterscript-0.65.0/node_modules/brighterscript`);
+            expect(
+                fsExtra.pathExistsSync(s`${storageDir}/packages/brighterscript-0.65.0/node_modules/brighterscript`)
+            ).to.be.true;
+            expect(spy.called).to.be.false;
+        });
+
+        it('installs from url', async () => {
+            fsExtra.ensureDirSync(
+                s`${storageDir}/packages/brighterscript-0.65.0/node_modules/brighterscript/dist/index.js`
+            );
+            expect(
+                await languageServerManager['ensureBscVersionInstalled'](
+                    'https://github.com/rokucommunity/brighterscript/releases/download/v0.0.0-packages/brighterscript-0.67.5-lsp-refactor.20240806164122.tgz'
+                )
+            ).to.eql(s`${storageDir}/packages/brighterscript-028738851c072bf844c10c260d6d2c65/node_modules/brighterscript`);
+            expect(
+                fsExtra.pathExistsSync(s`${storageDir}/packages/brighterscript-028738851c072bf844c10c260d6d2c65/node_modules/brighterscript`)
+            ).to.be.true;
+        });
+
+        it('repairs a broken bsc version', async () => {
+            let stub = sinon.stub(fsExtra, 'remove');
+            fsExtra.ensureDirSync(
+                s`${storageDir}/packages/brighterscript-0.65.1/node_modules/brighterscript`
+            );
+            fsExtra.writeFileSync(
+                s`${storageDir}/packages/brighterscript-0.65.1/node_modules/brighterscript/package.json`,
+                'bad json'
+            );
+
+            expect(
+                await languageServerManager['ensureBscVersionInstalled']('0.65.1')
+            ).to.eql(s`${storageDir}/packages/brighterscript-0.65.1/node_modules/brighterscript`);
+            expect(
+                fsExtra.pathExistsSync(s`${storageDir}/packages/brighterscript-0.65.1/node_modules/brighterscript`)
+            ).to.be.true;
+
+            //make sure we deleted the bad folder
+            expect(
+                s`${stub.getCalls()[0].args[0]}`
+            ).to.eql(s`${storageDir}/packages/brighterscript-0.65.1`);
+        });
+    });
+
+    describe('clearNpmPackageCache', () => {
+        it('clears the cache', async () => {
+            fsExtra.ensureFileSync(`${storageDir}/packages/test.txt`);
+            expect(fsExtra.pathExistsSync(`${storageDir}/packages/test.txt`)).to.be.true;
+
+            await languageServerManager.clearNpmPackageCache();
+
+            expect(fsExtra.pathExistsSync(`${storageDir}/packages/test.txt`)).to.be.false;
+        });
+    });
 });