fix(nextls): allow extension to force a download

In the case that the auto updater in Next LS has a bug, this
patch allows the extension to force a fresh download through the
extension.

It sets a key in the extensions globalState, which is persisted across
restarts. If the key isn't there, then it forces the download.

To force a download a second time, you need to increment the key
version, which is basically setting a new key to use as a sentinel.

.gitignore

@@ -4,3 +4,4 @@ node_modules
 .vscode-test/
 *.vsix
 test-bin
+.elixir-tools

package.json

@@ -198,7 +198,7 @@
     "build-base": "esbuild ./src/extension.ts --bundle --outfile=out/extension.js --external:vscode --format=cjs --platform=node --target=node16",
     "build": "yarn build-base --sourcemap",
     "watch": "yarn build-base --sourcemap --watch",
-    "pretest": "yarn typecheck && yarn run build",
+    "pretest": "yarn typecheck && yarn compile-dist && yarn build",
     "test": "node ./out/test/runTest.js"
   },
   "dependencies": {
@@ -225,4 +225,4 @@
     "sinon": "^17.0.1",
     "typescript": "^4.9.5"
   }
-}
+}

src/extension.ts

@@ -101,10 +101,29 @@ async function activateCredo(
   }
 }
 
+// In case the auto updater gets busted, we want the ability to force a download.
+// By incremented the key here, we should be able to force a download when the extension updates.
+export function forceDownload(context: vscode.ExtensionContext): boolean {
+  let forceDownload: boolean = context.globalState.get(
+    "elixir-tools-force-next-ls-download-v1"
+  );
+  channel.info(
+    `value of elixir-tools-force-next-ls-download-v1: ${forceDownload}`
+  );
+  if (forceDownload === undefined) {
+    forceDownload = true;
+  }
+
+  context.globalState.update("elixir-tools-force-next-ls-download-v1", false);
+
+  return forceDownload;
+}
+
 async function activateNextLS(
   context: vscode.ExtensionContext,
   _mixfile: vscode.Uri
 ) {
+  channel.info("activating next ls");
   let config = vscode.workspace.getConfiguration("elixir-tools.nextLS");
 
   if (config.get("enable")) {
@@ -113,12 +132,11 @@ async function activateNextLS(
     switch (config.get("adapter")) {
       case "stdio":
         let cacheDir: string = config.get("installationDirectory")!;
-
         if (cacheDir[0] === "~") {
           cacheDir = path.join(os.homedir(), cacheDir.slice(1));
         }
         const command = await ensureNextLSDownloaded(cacheDir, {
-          force: false,
+          force: forceDownload(context),
         });
 
         serverOptions = {
@@ -181,13 +199,18 @@ async function activateNextLS(
   }
 }
 
-export async function activate(context: vscode.ExtensionContext) {
+export async function activate(
+  context: vscode.ExtensionContext
+): Promise<vscode.ExtensionContext> {
   let files = await vscode.workspace.findFiles("mix.exs");
+  channel.info(`files: ${files[0]}`);
 
   if (files[0]) {
     await activateCredo(context, files[0]);
     await activateNextLS(context, files[0]);
   }
+
+  return context;
 }
 
 export function deactivate() {

src/test/fixtures/basic/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "elixir-tools.nextLS.installationDirectory": "./src/test/fixtures/basic/test-bin"
+}

src/test/fixtures/basic/lib/basic.ex

@@ -0,0 +1,5 @@
+defmodule Basic do
+  def run do
+    Enum.map([:one, :two], &Function.identity/1)
+  end
+end

src/test/fixtures/basic/mix.exs

@@ -0,0 +1,32 @@
+defmodule Basic.MixProject do
+  use Mix.Project
+
+  @version "0.1.0"
+
+  def project do
+    [
+      app: :basic,
+      description: "Basic app",
+      version: @version,
+      elixir: "~> 1.13",
+      elixirc_paths: elixirc_paths(Mix.env()),
+      start_permanent: Mix.env() == :prod,
+      deps: deps()
+    ]
+  end
+
+  # Run "mix help compile.app" to learn about applications.
+  def application do
+    [
+      extra_applications: [:logger, :crypto]
+    ]
+  end
+
+  defp elixirc_paths(:test), do: ["lib", "test/support"]
+  defp elixirc_paths(_), do: ["lib"]
+
+  # Run "mix help deps" to learn about dependencies.
+  defp deps do
+    []
+  end
+end

src/test/runTest.ts

@@ -11,9 +11,14 @@ async function main() {
     // The path to test runner
     // Passed to --extensionTestsPath
     const extensionTestsPath = path.resolve(__dirname, "./suite/index");
+    const testWorkspace = path.resolve(__dirname, "../../src/test/fixtures/basic");
 
     // Download VS Code, unzip it and run the integration test
-    await runTests({ extensionDevelopmentPath, extensionTestsPath });
+    await runTests({
+      extensionDevelopmentPath,
+      extensionTestsPath,
+      launchArgs: [testWorkspace],
+    });
   } catch (err) {
     console.error("Failed to run tests", err);
     process.exit(1);

src/test/suite/extension.test.ts

@@ -14,30 +14,27 @@ suite("Extension Test Suite", () => {
   vscode.window.showInformationMessage("Start all tests.");
   let showInformationMessage;
 
-  setup(function () {
+  setup(function() {
     fs.rmSync("./test-bin", { recursive: true, force: true });
-    showInformationMessage = sinon
-      .stub(vscode.window, "showInformationMessage")
-      .returns(
-        new Promise((resolve) => {
-          return resolve({ title: "Yes" });
-        })
-      );
+    showInformationMessage = sinon.stub(
+      vscode.window,
+      "showInformationMessage"
+    );
   });
 
-  teardown(function () {
+  teardown(function() {
     sinon.restore();
   });
 
   // TODO: should probably mock out the api calls to github
-  test("downloads Next LS", async function () {
+  test("downloads Next LS", async function() {
     fs.mkdirSync("./test-bin", { recursive: true });
 
     let result = await myExtension.ensureNextLSDownloaded("test-bin");
     assert.equal(path.normalize(result), path.normalize("test-bin/nextls"));
   });
 
-  test("uninstalls Next LS", async function () {
+  test("uninstalls Next LS", async function() {
     fs.mkdirSync("./test-bin", { recursive: true });
     fs.writeFileSync("./test-bin/nextls", "hello word");
 
@@ -49,7 +46,7 @@ suite("Extension Test Suite", () => {
     );
   });
 
-  test("fails to uninstalls Next LS", async function () {
+  test("fails to uninstalls Next LS", async function() {
     let showErrorMessage = sinon.stub(vscode.window, "showErrorMessage");
     await uninstall.run("./test-bin");
 
@@ -62,4 +59,26 @@ suite("Extension Test Suite", () => {
       /due to Error: ENOENT: no such file or directory, lstat/
     );
   });
+
+  // TODO: make a test for the opposite case. As of right now, I'm not entirely
+  // sure how to set globalState inside a test before the extension activates.
+  test("forces a download if the special key is not set", async function() {
+    let fixpath = path.join(__dirname, "../../../src/test/fixtures/basic")
+    let binpath = path.join(fixpath, "test-bin")
+    fs.mkdirSync(binpath, { recursive: true });
+    fs.writeFileSync(path.join(binpath, "nextls"), "hello world");
+    let ext = vscode.extensions.getExtension("elixir-tools.elixir-tools");
+
+    await ext.activate();
+
+    const doc = await vscode.workspace.openTextDocument(
+      path.join(fixpath, "mix.exs")
+    );
+    await vscode.window.showTextDocument(doc);
+    await new Promise((resolve) => setTimeout(resolve, 1000));
+
+    let nextls = fs.readFileSync(path.join(binpath, "nextls"));
+    assert.notEqual("hello world", nextls);
+
+  }).timeout(5000);
 });