fix: Avoid warning user if no new launcher exists

Allow extension to remain on the deprecated launcher.

Author: aeisenberg

extensions/ql-vscode/src/distribution.ts

@@ -112,7 +112,13 @@ export class DistributionManager implements DistributionProvider {
           "that a CodeQL executable exists at the specified path or remove the setting.");
         return undefined;
       }
-      if (deprecatedCodeQlLauncherName() && this._config.customCodeQlPath.endsWith(deprecatedCodeQlLauncherName()!)) {
+
+      // emit a warning if using a deprecated launcher and a non-deprecated launcher exists
+      if (
+        deprecatedCodeQlLauncherName() &&
+        this._config.customCodeQlPath.endsWith(deprecatedCodeQlLauncherName()!) &&
+        await this.hasNewLauncherName()
+      ) {
         warnDeprecatedLauncher();
       }
       return this._config.customCodeQlPath;
@@ -173,6 +179,21 @@ export class DistributionManager implements DistributionProvider {
     return this._onDidChangeDistribution;
   }
 
+  /**
+   * @return true if the non-deprecated launcher name exists on the file system
+   * in the same directory as the specified launcher only if using an external
+   * installation. False otherwise.
+   */
+  private async hasNewLauncherName(): Promise<boolean> {
+    if (!this._config.customCodeQlPath) {
+      // not managed externally
+      return false;
+    }
+    const dir = path.dirname(this._config.customCodeQlPath);
+    const newLaunderPath = path.join(dir, codeQlLauncherName());
+    return await fs.pathExists(newLaunderPath);
+  }
+
   private readonly _config: DistributionConfig;
   private readonly _extensionSpecificDistributionManager: ExtensionSpecificDistributionManager;
   private readonly _updateCheckRateLimiter: InvocationRateLimiter<DistributionUpdateCheckResult>;

extensions/ql-vscode/src/vscode-tests/no-workspace/distribution.test.ts

@@ -188,8 +188,12 @@ describe("Release version ordering", () => {
 });
 
 describe('Launcher path', () => {
+  const pathToCmd = `abc${path.sep}codeql.cmd`;
+  const pathToExe = `abc${path.sep}codeql.exe`;
+
   let sandbox: sinon.SinonSandbox;
   let warnSpy: sinon.SinonSpy;
+  let errorSpy: sinon.SinonSpy;
   let logSpy: sinon.SinonSpy;
   let fsSpy: sinon.SinonSpy;
   let platformSpy: sinon.SinonSpy;
@@ -209,37 +213,37 @@ describe('Launcher path', () => {
   it('should not warn with proper launcher name', async () => {
     launcherThatExists = 'codeql.exe';
     const result = await getExecutableFromDirectory('abc');
-    expect(fsSpy).to.have.been.calledWith(`abc${path.sep}codeql.exe`);
+    expect(fsSpy).to.have.been.calledWith(pathToExe);
 
     // correct launcher has been found, so alternate one not looked for
-    expect(fsSpy).not.to.have.been.calledWith(`abc${path.sep}codeql.cmd`);
+    expect(fsSpy).not.to.have.been.calledWith(pathToCmd);
 
     // no warning message
     expect(warnSpy).not.to.have.been.calledWith(sinon.match.string);
     // No log message
     expect(logSpy).not.to.have.been.calledWith(sinon.match.string);
-    expect(result).to.equal(`abc${path.sep}codeql.exe`);
+    expect(result).to.equal(pathToExe);
   });
 
   it('should warn when using a hard-coded deprecated launcher name', async () => {
     launcherThatExists = 'codeql.cmd';
     path.sep;
     const result = await getExecutableFromDirectory('abc');
-    expect(fsSpy).to.have.been.calledWith(`abc${path.sep}codeql.exe`);
-    expect(fsSpy).to.have.been.calledWith(`abc${path.sep}codeql.cmd`);
+    expect(fsSpy).to.have.been.calledWith(pathToExe);
+    expect(fsSpy).to.have.been.calledWith(pathToCmd);
 
     // Should have opened a warning message
     expect(warnSpy).to.have.been.calledWith(sinon.match.string);
     // No log message
     expect(logSpy).not.to.have.been.calledWith(sinon.match.string);
-    expect(result).to.equal(`abc${path.sep}codeql.cmd`);
+    expect(result).to.equal(pathToCmd);
   });
 
   it('should avoid warn when no launcher is found', async () => {
     launcherThatExists = 'xxx';
     const result = await getExecutableFromDirectory('abc', false);
-    expect(fsSpy).to.have.been.calledWith(`abc${path.sep}codeql.exe`);
-    expect(fsSpy).to.have.been.calledWith(`abc${path.sep}codeql.cmd`);
+    expect(fsSpy).to.have.been.calledWith(pathToExe);
+    expect(fsSpy).to.have.been.calledWith(pathToCmd);
 
     // no warning message
     expect(warnSpy).not.to.have.been.calledWith(sinon.match.string);
@@ -251,8 +255,8 @@ describe('Launcher path', () => {
   it('should warn when no launcher is found', async () => {
     launcherThatExists = 'xxx';
     const result = await getExecutableFromDirectory('abc', true);
-    expect(fsSpy).to.have.been.calledWith(`abc${path.sep}codeql.exe`);
-    expect(fsSpy).to.have.been.calledWith(`abc${path.sep}codeql.cmd`);
+    expect(fsSpy).to.have.been.calledWith(pathToExe);
+    expect(fsSpy).to.have.been.calledWith(pathToCmd);
 
     // no warning message
     expect(warnSpy).not.to.have.been.calledWith(sinon.match.string);
@@ -261,17 +265,55 @@ describe('Launcher path', () => {
     expect(result).to.equal(undefined);
   });
 
+  it('should not warn when deprecated launcher is used, but no new launcher is available', async () => {
+    const manager = new (createModule().DistributionManager)(undefined as any, { customCodeQlPath: pathToCmd } as any, undefined as any);
+    launcherThatExists = 'codeql.cmd';
+
+    const result = await manager.getCodeQlPathWithoutVersionCheck();
+    expect(result).to.equal(pathToCmd);
+
+    // no warning or error message
+    expect(warnSpy).to.have.callCount(0);
+    expect(errorSpy).to.have.callCount(0);
+  });
+
+  it('should warn when deprecated launcher is used, and new launcher is available', async () => {
+    const manager = new (createModule().DistributionManager)(undefined as any, { customCodeQlPath: pathToCmd } as any, undefined as any);
+    launcherThatExists = ''; // pretend both launchers exist
+
+    const result = await manager.getCodeQlPathWithoutVersionCheck();
+    expect(result).to.equal(pathToCmd);
+
+    // has warning message
+    expect(warnSpy).to.have.callCount(1);
+    expect(errorSpy).to.have.callCount(0);
+  });
+
+  it('should warn when launcher path is incorrect', async () => {
+    const manager = new (createModule().DistributionManager)(undefined as any, { customCodeQlPath: pathToCmd } as any, undefined as any);
+    launcherThatExists = 'xxx'; // pretend neither launcher exists
+
+    const result = await manager.getCodeQlPathWithoutVersionCheck();
+    expect(result).to.equal(undefined);
+
+    // no error message
+    expect(warnSpy).to.have.callCount(0);
+    expect(errorSpy).to.have.callCount(1);
+  });
+
   function createModule() {
     sandbox = sinon.createSandbox();
     warnSpy = sandbox.spy();
+    errorSpy = sandbox.spy();
     logSpy = sandbox.spy();
     // pretend that only the .cmd file exists
     fsSpy = sandbox.stub().callsFake(arg => arg.endsWith(launcherThatExists) ? true : false);
     platformSpy = sandbox.stub().returns('win32');
 
     return proxyquire('../../distribution', {
       './helpers': {
-        showAndLogWarningMessage: warnSpy
+        showAndLogWarningMessage: warnSpy,
+        showAndLogErrorMessage: errorSpy
       },
       './logging': {
         'logger': {