Windows CI (#21)

* Update ci.yml

* Implements ls-remote without spawning the git binary

* Implements enable/disable for Windows

* Triggers CI

* Mocks HTTP calls

* Fixes the shell on Windows

* Increases the timeout, thanks Windows

Author: arcanis

.github/workflows/ci.yml

@@ -16,6 +16,7 @@ jobs:
         platform:
         - ubuntu-latest
         - macos-latest
+        - windows-latest
 
     name: '${{matrix.platform}} w/ Node.js ${{matrix.node}}.x'
     runs-on: ${{matrix.platform}}
@@ -31,4 +32,5 @@ jobs:
     - run: yarn install --immutable
     - run: yarn build # We need the stubs to run the tests
     - run: yarn eslint
-    - run: yarn jest
+    - run: NOCK_ENV=replay yarn jest
+      shell: bash

.pnp.js

@@ -1,3 +1,4 @@
 module.exports = {
-  testTimeout: 30000,
+  setupFilesAfterEnv: [`./tests/setupTests.js`],
+  testTimeout: 120000,
 };

.yarn/cache/lodash.set-npm-4.3.2-7586c942c2-4dfedacae1.zip

@@ -32,6 +32,7 @@
     "eslint": "^7.10.0",
     "eslint-plugin-arca": "^0.9.5",
     "jest": "^25.1.0",
+    "nock": "^13.0.4",
     "semver": "^7.1.3",
     "supports-color": "^7.1.0",
     "tar": "^6.0.1",

.yarn/cache/nock-npm-13.0.4-d232d43721-cc76d95178.zip

@@ -42,14 +42,6 @@ export class DisableCommand extends Command<Context> {
     if (typeof installDirectory === `undefined`)
       installDirectory = path.dirname(await which(`corepack`));
 
-    if (process.platform === `win32`) {
-      return this.executeWin32(installDirectory);
-    } else {
-      return this.executePosix(installDirectory);
-    }
-  }
-
-  async executePosix(installDirectory: string) {
     const names = this.names.length === 0
       ? SupportedPackageManagerSet
       : this.names;
@@ -59,19 +51,36 @@ export class DisableCommand extends Command<Context> {
         throw new UsageError(`Invalid package manager name '${name}'`);
 
       for (const binName of this.context.engine.getBinariesFor(name)) {
-        const file = path.join(installDirectory, binName);
-        try {
-          await fs.promises.unlink(file);
-        } catch (err) {
-          if (err.code !== `ENOENT`) {
-            throw err;
-          }
+        if (process.platform === `win32`) {
+          await this.removeWin32Link(installDirectory, binName);
+        } else {
+          await this.removePosixLink(installDirectory, binName);
         }
       }
     }
   }
 
-  async executeWin32(installDirectory: string) {
-    throw new UsageError(`This command isn't available on Windows at this time`);
+  async removePosixLink(installDirectory: string, binName: string) {
+    const file = path.join(installDirectory, binName);
+    try {
+      await fs.promises.unlink(file);
+    } catch (err) {
+      if (err.code !== `ENOENT`) {
+        throw err;
+      }
+    }
+  }
+
+  async removeWin32Link(installDirectory: string, binName: string) {
+    for (const ext of [``, `.ps1`, `.cmd`]) {
+      const file = path.join(installDirectory, `${binName}${ext}`);
+      try {
+        await fs.promises.unlink(file);
+      } catch (err) {
+        if (err.code !== `ENOENT`) {
+          throw err;
+        }
+      }
+    }
   }
 }

.yarn/cache/propagate-npm-2.0.1-2074bf76d3-dd67518106.zip

@@ -1,3 +1,4 @@
+import cmdShim                                                 from '@zkochan/cmd-shim';
 import {Command, UsageError}                                   from 'clipanion';
 import fs                                                      from 'fs';
 import path                                                    from 'path';
@@ -42,14 +43,6 @@ export class EnableCommand extends Command<Context> {
     if (typeof installDirectory === `undefined`)
       installDirectory = path.dirname(await which(`corepack`));
 
-    if (process.platform === `win32`) {
-      return this.executeWin32(installDirectory);
-    } else {
-      return this.executePosix(installDirectory);
-    }
-  }
-
-  async executePosix(installDirectory: string) {
     // We use `eval` so that Webpack doesn't statically transform it.
     const manifestPath = eval(`require`).resolve(`corepack/package.json`);
 
@@ -66,24 +59,35 @@ export class EnableCommand extends Command<Context> {
         throw new UsageError(`Invalid package manager name '${name}'`);
 
       for (const binName of this.context.engine.getBinariesFor(name)) {
-        const file = path.join(installDirectory, binName);
-        const symlink = path.relative(installDirectory, path.join(stubFolder, binName));
-
-        if (fs.existsSync(file)) {
-          const currentSymlink = await fs.promises.readlink(file);
-          if (currentSymlink !== symlink) {
-            await fs.promises.unlink(file);
-          } else {
-            return;
-          }
+        if (process.platform === `win32`) {
+          await this.generateWin32Link(installDirectory, stubFolder, binName);
+        } else {
+          await this.generatePosixLink(installDirectory, stubFolder, binName);
         }
+      }
+    }
+  }
 
-        await fs.promises.symlink(symlink, file);
+  async generatePosixLink(installDirectory: string, stubFolder: string, binName: string) {
+    const file = path.join(installDirectory, binName);
+    const symlink = path.relative(installDirectory, path.join(stubFolder, binName));
+
+    if (fs.existsSync(file)) {
+      const currentSymlink = await fs.promises.readlink(file);
+      if (currentSymlink !== symlink) {
+        await fs.promises.unlink(file);
+      } else {
+        return;
       }
     }
+
+    await fs.promises.symlink(symlink, file);
   }
 
-  async executeWin32(target: string) {
-    throw new UsageError(`This command isn't available on Windows at this time`);
+  async generateWin32Link(installDirectory: string, stubFolder: string, binName: string) {
+    const file = path.join(installDirectory, binName);
+    await cmdShim(path.join(stubFolder, binName), file, {
+      createCmdFile: true,
+    });
   }
 }

jest.config.js

@@ -0,0 +1,60 @@
+import * as httpUtils from './httpUtils';
+
+export async function lsRemote(url: string) {
+  const data = await httpUtils.fetchAsBuffer(`${url}/info/refs?service=git-upload-pack`);
+  const refs = new Set<string>();
+
+  let t = 0;
+  while (t < data.length) {
+    const lenMarker = data.slice(t, t + 4).toString();
+    const len = parseInt(lenMarker, 16);
+
+    // flush-pkt
+    if (len === 0) {
+      t += 4;
+      continue;
+    }
+
+    // Substract 1 to remove the trailing newline
+    const line = data.slice(t + 4, t + len - 1).toString();
+    t += len;
+
+    if (line.startsWith(`#`))
+      continue;
+
+    let nameEnd = line.indexOf(`\0`);
+    if (nameEnd === -1)
+      nameEnd = line.length;
+
+    const nameStart = line.indexOf(` `);
+    if (nameStart === -1 || nameStart >= nameEnd)
+      continue;
+
+    const name = line.slice(nameStart + 1, nameEnd);
+    if (name === `capabilities^{}`)
+      return new Set<string>();
+
+    refs.add(name);
+  }
+
+  return refs;
+}
+
+// smart_reply     =  PKT-LINE("# service=$servicename" LF)
+//                    ref_list
+//                    "0000"
+//
+// ref_list        =  empty_list / non_empty_list
+//
+// empty_list      =  PKT-LINE(zero-id SP "capabilities^{}" NUL cap-list LF)
+//
+// non_empty_list  =  PKT-LINE(obj-id SP name NUL cap_list LF)
+//                    *ref_record
+//
+// cap-list        =  capability *(SP capability)
+// capability      =  1*(LC_ALPHA / DIGIT / "-" / "_")
+// LC_ALPHA        =  %x61-7A
+
+// ref_record      =  any_ref / peeled_ref
+// any_ref         =  PKT-LINE(obj-id SP name LF)
+// peeled_ref      =  PKT-LINE(obj-id SP name LF)

package.json

@@ -3,19 +3,16 @@ import fs                                                 from 'fs';
 import path                                               from 'path';
 import semver                                             from 'semver';
 import tar                                                from 'tar';
-import {promisify}                                        from 'util';
 
 import * as debugUtils                                    from './debugUtils';
 import * as folderUtils                                   from './folderUtils';
 import * as fsUtils                                       from './fsUtils';
+import * as gitUtils                                      from './gitUtils';
 import * as httpUtils                                     from './httpUtils';
 import {Context}                                          from './main';
 import {TagSpec, Descriptor, Locator, PackageManagerSpec} from './types';
 
-const execFileP = promisify(execFile);
-
-const NL_REGEXP = /\n/;
-const REFS_TAGS_REGEXP = /^[a-f0-9]+\trefs\/tags\/(.*)\^\{\}$/;
+const REFS_TAGS_REGEXP = /^refs\/tags\/(.*)(?:\^\{\})?$/;
 
 export async function fetchAvailableVersions(spec: TagSpec) {
   switch (spec.type) {
@@ -25,14 +22,13 @@ export async function fetchAvailableVersions(spec: TagSpec) {
     } break;
 
     case `git`: {
-      const {stdout} = await execFileP(`git`, [`ls-remote`, `--tags`, spec.repository]);
-      const lines = stdout.split(NL_REGEXP);
+      const refs = await gitUtils.lsRemote(spec.repository);
 
       const regexp = new RegExp(`^${spec.pattern.replace(`{}`, `(.*)`)}$`);
 
       const results = [];
-      for (const line of lines) {
-        const lv1 = line.match(REFS_TAGS_REGEXP);
+      for (const ref of refs) {
+        const lv1 = ref.match(REFS_TAGS_REGEXP);
         if (!lv1)
           continue;