wip

actions · bryanmacfarlane · May 19, 2020 · Apr 24, 2020 · May 2, 2020 · May 2, 2020
commit ecf0ce62f9fc44aa8a7c932625b9335ed461e377
diff --git a/.gitignore b/.gitignore
@@ -2,6 +2,9 @@ node_modules/
 lib/
 __tests__/runner/*
 
+validate/temp
+validate/node
+
 # Rest of the file pulled from https://github.com/github/gitignore/blob/master/Node.gitignore
 # Logs
 logs

diff --git a/action.yml b/action.yml
@@ -1,17 +1,21 @@
 name: 'Setup Node.js environment'
-description: 'Setup a Node.js environment and add it to the PATH, additionally providing proxy support'
+description: 'Setup a Node.js environment by adding problem matchers and optionally downloading and adding it to the PATH'
 author: 'GitHub'
 inputs:
   always-auth:
     description: 'Set always-auth in npmrc'
     default: 'false'
   node-version:
-    description: 'Version Spec of the version to use.  Examples: 10.x, 10.15.1, >=10.15.0'
-    default: '10.x'
+    description: 'Version Spec of the version to use.  Examples: 12.x, 10.15.1, >=10.15.0'
   registry-url:
     description: 'Optional registry to set up for auth. Will set the registry in a project level .npmrc and .yarnrc file, and set up auth to read in from env.NODE_AUTH_TOKEN'
   scope:
     description: 'Optional scope for authenticating against scoped registries'
+  token:
+    description: Used to pull node distributions from node-versions.  Since there's a default, this is typically not supplied by the user.
+    default: ${{ github.token }}
+# TODO: add input to control forcing to pull from cloud or dist. 
+#       escape valve for someone having issues or needing the absolute latest which isn't cached yet
 # Deprecated option, do not use. Will not be supported after October 1, 2019
   version:
     description: 'Deprecated. Use node-version instead. Will not be supported after October 1, 2019'

diff --git a/dist/index.js b/dist/index.js
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "setup-node",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "private": true,
   "description": "setup node action",
   "main": "lib/setup-node.js",
@@ -27,7 +27,7 @@
     "@actions/github": "^1.1.0",
     "@actions/http-client": "^1.0.6",
     "@actions/io": "^1.0.2",
-    "@actions/tool-cache": "^1.3.3",
+    "@actions/tool-cache": "^1.5.2",
     "semver": "^6.1.1"
   },
   "devDependencies": {

diff --git a/src/installer.ts b/src/installer.ts
@@ -6,6 +6,7 @@ import * as tc from '@actions/tool-cache';
 import * as os from 'os';
 import * as path from 'path';
 import * as semver from 'semver';
+import { Url } from 'url';
 
 let osPlat: string = os.platform();
 let osArch: string = translateArchToDistUrl(os.arch());
@@ -19,36 +20,64 @@ interface INodeVersion {
   files: string[];
 }
 
-export async function getNode(versionSpec: string) {
+interface INodeVersionInfo {
+  downloadUrl: string;
+  token: string | null;
+  resolvedVersion: string;
+  fileName: string;
+}
+
+export async function getNode(versionSpec: string, stable: boolean, token: string) {
   // check cache
+  let info: INodeVersionInfo | null = null;
   let toolPath: string;
   toolPath = tc.find('node', versionSpec);
 
   // If not found in cache, download
-  if (!toolPath) {
-    let version: string;
-    const c = semver.clean(versionSpec) || '';
-    // If explicit version
-    if (semver.valid(c) != null) {
-      // version to download
-      version = versionSpec;
-    } else {
-      // query nodejs.org for a matching version
-      version = await queryLatestMatch(versionSpec);
-      if (!version) {
-        throw new Error(
-          `Unable to find Node version '${versionSpec}' for platform ${osPlat} and architecture ${osArch}.`
-        );
+  if (toolPath) {
+    console.log(`Found in cache @ ${toolPath}`);
+  } else {
+    console.log(`Attempting to download ${versionSpec}...`)
+    let info = await getInfoFromManifest(versionSpec, stable, token);
+    if (!info) {
+      console.log('Not found in manifest.  Falling back to download directly from Node')
+      info = await getInfoFromDist(versionSpec);
+    }   
+
+    if (!info) {
+      throw new Error(
+        `Unable to find Node version '${versionSpec}' for platform ${osPlat} and architecture ${osArch}.`
+      );
+    }
+
+    console.log(`Acquiring ${info.resolvedVersion} from ${info.downloadUrl}`);
+
+    let downloadPath = ""
+    try {
+      downloadPath = await tc.downloadTool(info.downloadUrl, undefined, token);
+    } catch (err) {
+      if (err instanceof tc.HTTPError && err.httpStatusCode == 404) {
+        return await acquireNodeFromFallbackLocation(info.resolvedVersion);
       }
 
-      // check cache
-      toolPath = tc.find('node', version);
+      throw err;
     }
 
-    if (!toolPath) {
-      // download, extract, cache
-      toolPath = await acquireNode(version);
+    //
+    // Extract
+    //
+    let extPath: string;
+    if (osPlat == 'win32') {
+      let _7zPath = path.join(__dirname, '..', 'externals', '7zr.exe');
+      extPath = await tc.extract7z(downloadPath, undefined, _7zPath);
+    } else {
+      extPath = await tc.extractTar(downloadPath);
     }
+
+    //
+    // Install into the local tool cache - node extracts with a root folder that matches the fileName downloaded
+    //
+    toolPath = await tc.cacheDir(extPath, 'node', info.resolvedVersion);    
   }
 
   //
@@ -65,41 +94,56 @@ export async function getNode(versionSpec: string) {
   core.addPath(toolPath);
 }
 
-async function queryLatestMatch(versionSpec: string): Promise<string> {
-  // node offers a json list of versions
-  let dataFileName: string;
-  switch (osPlat) {
-    case 'linux':
-      dataFileName = `linux-${osArch}`;
-      break;
-    case 'darwin':
-      dataFileName = `osx-${osArch}-tar`;
-      break;
-    case 'win32':
-      dataFileName = `win-${osArch}-exe`;
-      break;
-    default:
-      throw new Error(`Unexpected OS '${osPlat}'`);
+async function getInfoFromManifest(versionSpec: string, stable: boolean, token: string): Promise<INodeVersionInfo | null> {
+  let info: INodeVersionInfo | null = null;
+  const releases = await tc.getManifestFromRepo("actions", "node-versions", token)
+  console.log(`matching ${versionSpec}...`)
+  const rel = await tc.findFromManifest(versionSpec, stable, releases);
+
+  if (rel && rel.files.length > 0) {
+    info = <INodeVersionInfo>{};
+    info.resolvedVersion = rel.version;
+    info.downloadUrl = rel.files[0].download_url;
+    info.fileName = rel.files[0].filename;
+    info.token = token;
   }
 
-  let versions: string[] = [];
-  let dataUrl = 'https://nodejs.org/dist/index.json';
-  let httpClient = new hc.HttpClient('setup-node', [], {
-    allowRetries: true,
-    maxRetries: 3
-  });
-  let response = await httpClient.getJson<INodeVersion[]>(dataUrl);
-  let nodeVersions = response.result || [];
-  nodeVersions.forEach((nodeVersion: INodeVersion) => {
-    // ensure this version supports your os and platform
-    if (nodeVersion.files.indexOf(dataFileName) >= 0) {
-      versions.push(nodeVersion.version);
+  return info;
+}
+
+async function getInfoFromDist(versionSpec: string): Promise<INodeVersionInfo | null> {
+  let info: INodeVersionInfo | null = null;
+  let version: string;
+
+  // If explicit version don't query
+  if (semver.clean(versionSpec) != null) {
+    // version to download
+    version = versionSpec;
+  } else {
+    // query nodejs.org for a matching version
+    version = await queryDistForMatch(versionSpec);
+    if (!version) {
+      return null;
     }
-  });
+  }
 
-  // get the latest version that matches the version spec
-  let version: string = evaluateVersions(versions, versionSpec);
-  return version;
+  //
+  // Download - a tool installer intimately knows how to get the tool (and construct urls)
+  //
+  version = semver.clean(version) || '';
+  let fileName: string =
+    osPlat == 'win32'
+      ? `node-v${version}-win-${osArch}`
+      : `node-v${version}-${osPlat}-${osArch}`;
+  let urlFileName: string =
+    osPlat == 'win32' ? `${fileName}.7z` : `${fileName}.tar.gz`;
+  let url = `https://nodejs.org/dist/v${version}/${urlFileName}`;
+
+  return <INodeVersionInfo>{
+    downloadUrl: url,
+    resolvedVersion: version,
+    fileName: fileName
+  }
 }
 
 // TODO - should we just export this from @actions/tool-cache? Lifted directly from there
@@ -130,47 +174,41 @@ function evaluateVersions(versions: string[], versionSpec: string): string {
   return version;
 }
 
-async function acquireNode(version: string): Promise<string> {
-  //
-  // Download - a tool installer intimately knows how to get the tool (and construct urls)
-  //
-  version = semver.clean(version) || '';
-  let fileName: string =
-    osPlat == 'win32'
-      ? `node-v${version}-win-${osArch}`
-      : `node-v${version}-${osPlat}-${osArch}`;
-  let urlFileName: string =
-    osPlat == 'win32' ? `${fileName}.7z` : `${fileName}.tar.gz`;
-  let downloadUrl = `https://nodejs.org/dist/v${version}/${urlFileName}`;
-
-  let downloadPath: string;
-
-  try {
-    downloadPath = await tc.downloadTool(downloadUrl);
-  } catch (err) {
-    if (err instanceof tc.HTTPError && err.httpStatusCode == 404) {
-      return await acquireNodeFromFallbackLocation(version);
-    }
-
-    throw err;
+async function queryDistForMatch(versionSpec: string): Promise<string> {
+  // node offers a json list of versions
+  let dataFileName: string;
+  switch (osPlat) {
+    case 'linux':
+      dataFileName = `linux-${osArch}`;
+      break;
+    case 'darwin':
+      dataFileName = `osx-${osArch}-tar`;
+      break;
+    case 'win32':
+      dataFileName = `win-${osArch}-exe`;
+      break;
+    default:
+      throw new Error(`Unexpected OS '${osPlat}'`);
   }
 
-  //
-  // Extract
-  //
-  let extPath: string;
-  if (osPlat == 'win32') {
-    let _7zPath = path.join(__dirname, '..', 'externals', '7zr.exe');
-    extPath = await tc.extract7z(downloadPath, undefined, _7zPath);
-  } else {
-    extPath = await tc.extractTar(downloadPath);
-  }
+  let versions: string[] = [];
+  let dataUrl = 'https://nodejs.org/dist/index.json';
+  let httpClient = new hc.HttpClient('setup-node', [], {
+    allowRetries: true,
+    maxRetries: 3
+  });
+  let response = await httpClient.getJson<INodeVersion[]>(dataUrl);
+  let nodeVersions = response.result || [];
+  nodeVersions.forEach((nodeVersion: INodeVersion) => {
+    // ensure this version supports your os and platform
+    if (nodeVersion.files.indexOf(dataFileName) >= 0) {
+      versions.push(nodeVersion.version);
+    }
+  });
 
-  //
-  // Install into the local tool cache - node extracts with a root folder that matches the fileName downloaded
-  //
-  let toolRoot = path.join(extPath, fileName);
-  return await tc.cacheDir(toolRoot, 'node', version);
+  // get the latest version that matches the version spec
+  let version: string = evaluateVersions(versions, versionSpec);
+  return version;
 }
 
 // For non LTS versions of Node, the files we need (for Windows) are sometimes located

diff --git a/src/setup-node.ts b/src/setup-node.ts
@@ -9,12 +9,16 @@ async function run() {
     // Version is optional.  If supplied, install / use from the tool cache
     // If not supplied then task is still used to setup proxy, auth, etc...
     //
-    let version = core.getInput('version');
+    let version = core.getInput('node-version');
     if (!version) {
-      version = core.getInput('node-version');
+      version = core.getInput('version');  
     }
+
+    console.log(`version: ${version}`);
     if (version) {
-      await installer.getNode(version);
+      let token = core.getInput('token');
+      let stable = (core.getInput('stable') || 'true').toUpperCase() === 'TRUE';
+      await installer.getNode(version, stable, token);
     }
 
     const registryUrl: string = core.getInput('registry-url');

diff --git a/validate/test.sh b/validate/test.sh
@@ -0,0 +1,22 @@
+
+#/bin/bash
+
+set -e
+
+rm -rf ./temp
+rm -rf ./node
+
+# uncomment to use charles proxy or other debugging proxy
+# export NODE_TLS_REJECT_UNAUTHORIZED=0
+# export https_proxy=http://127.0.0.1:8888
+
+export RUNNER_TOOL_CACHE=$(pwd)
+export RUNNER_TEMP="${RUNNER_TOOL_CACHE}/temp"
+export INPUT_STABLE=true
+export INPUT_VERSION="12.x"
+# export your PAT with repo scope before running
+export INPUT_TOKEN=$GITHUB_TOKEN
+
+echo "Getting ${INPUT_VERSION} ($INPUT_STABLE) with ${INPUT_TOKEN}..."
+
+node ../dist/index.js