fixed merge conflicts

src/authutil.ts

@@ -53,6 +53,9 @@ function writeRegistryToFile(
   newContents += `${authString}${os.EOL}${registryString}${os.EOL}${alwaysAuthString}`;
   fs.writeFileSync(fileLocation, newContents);
   core.exportVariable('NPM_CONFIG_USERCONFIG', fileLocation);
-  // Export empty node_auth_token so npm doesn't complain about not being able to find it
-  core.exportVariable('NODE_AUTH_TOKEN', 'XXXXX-XXXXX-XXXXX-XXXXX');
+  // Export empty node_auth_token if didn't exist so npm doesn't complain about not being able to find it
+  core.exportVariable(
+    'NODE_AUTH_TOKEN',
+    process.env.NODE_AUTH_TOKEN || 'XXXXX-XXXXX-XXXXX-XXXXX'
+  );
 }

src/cache-restore.ts

@@ -0,0 +1,69 @@
+import * as cache from '@actions/cache';
+import * as core from '@actions/core';
+import * as glob from '@actions/glob';
+import path from 'path';
+import fs from 'fs';
+
+import {State, Outputs} from './constants';
+import {
+  getCacheDirectoryPath,
+  getPackageManagerInfo,
+  PackageManagerInfo
+} from './cache-utils';
+
+export const restoreCache = async (
+  packageManager: string,
+  cacheDependencyPath?: string
+) => {
+  const packageManagerInfo = await getPackageManagerInfo(packageManager);
+  if (!packageManagerInfo) {
+    throw new Error(`Caching for '${packageManager}' is not supported`);
+  }
+  const platform = process.env.RUNNER_OS;
+
+  const cachePath = await getCacheDirectoryPath(
+    packageManagerInfo,
+    packageManager
+  );
+  const lockFilePath = cacheDependencyPath
+    ? cacheDependencyPath
+    : findLockFile(packageManagerInfo);
+  const fileHash = await glob.hashFiles(lockFilePath);
+
+  if (!fileHash) {
+    throw new Error(
+      'Some specified paths were not resolved, unable to cache dependencies.'
+    );
+  }
+
+  const primaryKey = `node-cache-${platform}-${packageManager}-${fileHash}`;
+  core.debug(`primary key is ${primaryKey}`);
+
+  core.saveState(State.CachePrimaryKey, primaryKey);
+
+  const cacheKey = await cache.restoreCache([cachePath], primaryKey);
+  core.setOutput('cache-hit', Boolean(cacheKey));
+
+  if (!cacheKey) {
+    core.info(`${packageManager} cache is not found`);
+    return;
+  }
+
+  core.saveState(State.CacheMatchedKey, cacheKey);
+  core.info(`Cache restored from key: ${cacheKey}`);
+};
+
+const findLockFile = (packageManager: PackageManagerInfo) => {
+  let lockFiles = packageManager.lockFilePatterns;
+  const workspace = process.env.GITHUB_WORKSPACE!;
+  const rootContent = fs.readdirSync(workspace);
+
+  const lockFile = lockFiles.find(item => rootContent.includes(item));
+  if (!lockFile) {
+    throw new Error(
+      `Dependencies lock file is not found in ${workspace}. Supported file patterns: ${lockFiles.toString()}`
+    );
+  }
+
+  return path.join(workspace, lockFile);
+};

src/cache-save.ts

@@ -0,0 +1,58 @@
+import * as core from '@actions/core';
+import * as cache from '@actions/cache';
+import fs from 'fs';
+import {State} from './constants';
+import {getCacheDirectoryPath, getPackageManagerInfo} from './cache-utils';
+
+export async function run() {
+  try {
+    const cacheLock = core.getInput('cache');
+    await cachePackages(cacheLock);
+  } catch (error) {
+    core.setFailed(error.message);
+  }
+}
+
+const cachePackages = async (packageManager: string) => {
+  const state = core.getState(State.CacheMatchedKey);
+  const primaryKey = core.getState(State.CachePrimaryKey);
+
+  const packageManagerInfo = await getPackageManagerInfo(packageManager);
+  if (!packageManagerInfo) {
+    core.debug(`Caching for '${packageManager}' is not supported`);
+    return;
+  }
+
+  const cachePath = await getCacheDirectoryPath(
+    packageManagerInfo,
+    packageManager
+  );
+
+  if (!fs.existsSync(cachePath)) {
+    throw new Error(
+      `Cache folder path is retrieved for ${packageManager} but doesn't exist on disk: ${cachePath}`
+    );
+  }
+
+  if (primaryKey === state) {
+    core.info(
+      `Cache hit occurred on the primary key ${primaryKey}, not saving cache.`
+    );
+    return;
+  }
+
+  try {
+    await cache.saveCache([cachePath], primaryKey);
+    core.info(`Cache saved with the key: ${primaryKey}`);
+  } catch (error) {
+    if (error.name === cache.ValidationError.name) {
+      throw error;
+    } else if (error.name === cache.ReserveCacheError.name) {
+      core.info(error.message);
+    } else {
+      core.warning(`${error.message}`);
+    }
+  }
+};
+
+run();

src/cache-utils.ts

@@ -0,0 +1,90 @@
+import * as core from '@actions/core';
+import * as exec from '@actions/exec';
+
+type SupportedPackageManagers = {
+  [prop: string]: PackageManagerInfo;
+};
+
+export interface PackageManagerInfo {
+  lockFilePatterns: Array<string>;
+  getCacheFolderCommand: string;
+}
+
+export const supportedPackageManagers: SupportedPackageManagers = {
+  npm: {
+    lockFilePatterns: ['package-lock.json', 'yarn.lock'],
+    getCacheFolderCommand: 'npm config get cache'
+  },
+  pnpm: {
+    lockFilePatterns: ['pnpm-lock.yaml'],
+    getCacheFolderCommand: 'pnpm store path'
+  },
+  yarn1: {
+    lockFilePatterns: ['yarn.lock'],
+    getCacheFolderCommand: 'yarn cache dir'
+  },
+  yarn2: {
+    lockFilePatterns: ['yarn.lock'],
+    getCacheFolderCommand: 'yarn config get cacheFolder'
+  }
+};
+
+export const getCommandOutput = async (toolCommand: string) => {
+  const {stdout, stderr, exitCode} = await exec.getExecOutput(toolCommand);
+
+  if (stderr) {
+    throw new Error(stderr);
+  }
+
+  return stdout.trim();
+};
+
+const getPackageManagerVersion = async (
+  packageManager: string,
+  command: string
+) => {
+  const stdOut = await getCommandOutput(`${packageManager} ${command}`);
+
+  if (!stdOut) {
+    throw new Error(`Could not retrieve version of ${packageManager}`);
+  }
+
+  return stdOut;
+};
+
+export const getPackageManagerInfo = async (packageManager: string) => {
+  if (packageManager === 'npm') {
+    return supportedPackageManagers.npm;
+  } else if (packageManager === 'pnpm') {
+    return supportedPackageManagers.pnpm;
+  } else if (packageManager === 'yarn') {
+    const yarnVersion = await getPackageManagerVersion('yarn', '--version');
+
+    core.debug(`Consumed yarn version is ${yarnVersion}`);
+
+    if (yarnVersion.startsWith('1.')) {
+      return supportedPackageManagers.yarn1;
+    } else {
+      return supportedPackageManagers.yarn2;
+    }
+  } else {
+    return null;
+  }
+};
+
+export const getCacheDirectoryPath = async (
+  packageManagerInfo: PackageManagerInfo,
+  packageManager: string
+) => {
+  const stdOut = await getCommandOutput(
+    packageManagerInfo.getCacheFolderCommand
+  );
+
+  if (!stdOut) {
+    throw new Error(`Could not get cache folder path for ${packageManager}`);
+  }
+
+  core.debug(`${packageManager} path is ${stdOut}`);
+
+  return stdOut;
+};

src/constants.ts

@@ -0,0 +1,14 @@
+export enum LockType {
+  Npm = 'npm',
+  Pnpm = 'pnpm',
+  Yarn = 'yarn'
+}
+
+export enum State {
+  CachePrimaryKey = 'CACHE_KEY',
+  CacheMatchedKey = 'CACHE_RESULT'
+}
+
+export enum Outputs {
+  CacheHit = 'cache-hit'
+}

src/installer.ts

@@ -11,24 +11,43 @@ import {INodeVersion, getVersionsFromDist} from './node-version';
 interface INodeVersionInfo {
   downloadUrl: string;
   resolvedVersion: string;
+  arch: string;
   fileName: string;
 }
 
+interface INodeRelease extends tc.IToolRelease {
+  lts?: string;
+}
+
 export async function getNode(
   versionSpec: string,
   stable: boolean,
   checkLatest: boolean,
-  auth: string | undefined
+  auth: string | undefined,
+  arch: string = os.arch()
 ) {
+  // Store manifest data to avoid multiple calls
+  let manifest: INodeRelease[] | undefined;
   let osPlat: string = os.platform();
-  let osArch: string = translateArchToDistUrl(os.arch());
+  let osArch: string = translateArchToDistUrl(arch);
+
+  if (isLtsAlias(versionSpec)) {
+    core.info('Attempt to resolve LTS alias from manifest...');
+
+    // No try-catch since it's not possible to resolve LTS alias without manifest
+    manifest = await getManifest(auth);
+
+    versionSpec = resolveLtsAliasFromManifest(versionSpec, stable, manifest);
+  }
 
   if (checkLatest) {
     core.info('Attempt to resolve the latest version from manifest...');
     const resolvedVersion = await resolveVersionFromManifest(
       versionSpec,
       stable,
-      auth
+      auth,
+      osArch,
+      manifest
     );
     if (resolvedVersion) {
       versionSpec = resolvedVersion;
@@ -40,7 +59,7 @@ export async function getNode(
 
   // check cache
   let toolPath: string;
-  toolPath = tc.find('node', versionSpec);
+  toolPath = tc.find('node', versionSpec, osArch);
 
   // If not found in cache, download
   if (toolPath) {
@@ -54,9 +73,17 @@ export async function getNode(
     // Try download from internal distribution (popular versions only)
     //
     try {
-      info = await getInfoFromManifest(versionSpec, stable, auth);
+      info = await getInfoFromManifest(
+        versionSpec,
+        stable,
+        auth,
+        osArch,
+        manifest
+      );
       if (info) {
-        core.info(`Acquiring ${info.resolvedVersion} from ${info.downloadUrl}`);
+        core.info(
+          `Acquiring ${info.resolvedVersion} - ${info.arch} from ${info.downloadUrl}`
+        );
         downloadPath = await tc.downloadTool(info.downloadUrl, undefined, auth);
       } else {
         core.info(
@@ -83,19 +110,24 @@ export async function getNode(
     // Download from nodejs.org
     //
     if (!downloadPath) {
-      info = await getInfoFromDist(versionSpec);
+      info = await getInfoFromDist(versionSpec, arch);
       if (!info) {
         throw new Error(
           `Unable to find Node version '${versionSpec}' for platform ${osPlat} and architecture ${osArch}.`
         );
       }
 
-      core.info(`Acquiring ${info.resolvedVersion} from ${info.downloadUrl}`);
+      core.info(
+        `Acquiring ${info.resolvedVersion} - ${info.arch} from ${info.downloadUrl}`
+      );
       try {
         downloadPath = await tc.downloadTool(info.downloadUrl);
       } catch (err) {
         if (err instanceof tc.HTTPError && err.httpStatusCode == 404) {
-          return await acquireNodeFromFallbackLocation(info.resolvedVersion);
+          return await acquireNodeFromFallbackLocation(
+            info.resolvedVersion,
+            info.arch
+          );
         }
 
         throw err;
@@ -109,7 +141,7 @@ export async function getNode(
     let extPath: string;
     info = info || ({} as INodeVersionInfo); // satisfy compiler, never null when reaches here
     if (osPlat == 'win32') {
-      let _7zPath = path.join(__dirname, '..', 'externals', '7zr.exe');
+      let _7zPath = path.join(__dirname, '../..', 'externals', '7zr.exe');
       extPath = await tc.extract7z(downloadPath, undefined, _7zPath);
       // 7z extracts to folder matching file name
       let nestedPath = path.join(extPath, path.basename(info.fileName, '.7z'));
@@ -128,7 +160,12 @@ export async function getNode(
     // Install into the local tool cache - node extracts with a root folder that matches the fileName downloaded
     //
     core.info('Adding to the cache ...');
-    toolPath = await tc.cacheDir(extPath, 'node', info.resolvedVersion);
+    toolPath = await tc.cacheDir(
+      extPath,
+      'node',
+      info.resolvedVersion,
+      info.arch
+    );
     core.info('Done');
   }
 
@@ -146,23 +183,70 @@ export async function getNode(
   core.addPath(toolPath);
 }
 
+function isLtsAlias(versionSpec: string): boolean {
+  return versionSpec.startsWith('lts/');
+}
+
+function getManifest(auth: string | undefined): Promise<tc.IToolRelease[]> {
+  core.debug('Getting manifest from actions/node-versions@main');
+  return tc.getManifestFromRepo('actions', 'node-versions', auth, 'main');
+}
+
+function resolveLtsAliasFromManifest(
+  versionSpec: string,
+  stable: boolean,
+  manifest: INodeRelease[]
+): string {
+  const alias = versionSpec.split('lts/')[1]?.toLowerCase();
+
+  if (!alias) {
+    throw new Error(
+      `Unable to parse LTS alias for Node version '${versionSpec}'`
+    );
+  }
+
+  core.debug(`LTS alias '${alias}' for Node version '${versionSpec}'`);
+
+  // Supported formats are `lts/<alias>` and `lts/*`. Where asterisk means highest possible LTS.
+  const release =
+    alias === '*'
+      ? manifest.find(x => !!x.lts && x.stable === stable)
+      : manifest.find(
+          x => x.lts?.toLowerCase() === alias && x.stable === stable
+        );
+
+  if (!release) {
+    throw new Error(
+      `Unable to find LTS release '${alias}' for Node version '${versionSpec}'.`
+    );
+  }
+
+  core.debug(
+    `Found LTS release '${release.version}' for Node version '${versionSpec}'`
+  );
+
+  return release.version.split('.')[0];
+}
+
 async function getInfoFromManifest(
   versionSpec: string,
   stable: boolean,
-  auth: string | undefined
+  auth: string | undefined,
+  osArch: string = translateArchToDistUrl(os.arch()),
+  manifest: tc.IToolRelease[] | undefined
 ): Promise<INodeVersionInfo | null> {
   let info: INodeVersionInfo | null = null;
-  const releases = await tc.getManifestFromRepo(
-    'actions',
-    'node-versions',
-    auth,
-    'main'
-  );
-  const rel = await tc.findFromManifest(versionSpec, stable, releases);
+  if (!manifest) {
+    core.debug('No manifest cached');
+    manifest = await getManifest(auth);
+  }
+
+  const rel = await tc.findFromManifest(versionSpec, stable, manifest, osArch);
 
   if (rel && rel.files.length > 0) {
     info = <INodeVersionInfo>{};
     info.resolvedVersion = rel.version;
+    info.arch = rel.files[0].arch;
     info.downloadUrl = rel.files[0].download_url;
     info.fileName = rel.files[0].filename;
   }
@@ -171,14 +255,15 @@ async function getInfoFromManifest(
 }
 
 async function getInfoFromDist(
-  versionSpec: string
+  versionSpec: string,
+  arch: string = os.arch()
 ): Promise<INodeVersionInfo | null> {
   let osPlat: string = os.platform();
-  let osArch: string = translateArchToDistUrl(os.arch());
+  let osArch: string = translateArchToDistUrl(arch);
 
   let version: string;
 
-  version = await queryDistForMatch(versionSpec);
+  version = await queryDistForMatch(versionSpec, arch);
   if (!version) {
     return null;
   }
@@ -198,6 +283,7 @@ async function getInfoFromDist(
   return <INodeVersionInfo>{
     downloadUrl: url,
     resolvedVersion: version,
+    arch: arch,
     fileName: fileName
   };
 }
@@ -205,10 +291,18 @@ async function getInfoFromDist(
 async function resolveVersionFromManifest(
   versionSpec: string,
   stable: boolean,
-  auth: string | undefined
+  auth: string | undefined,
+  osArch: string = translateArchToDistUrl(os.arch()),
+  manifest: tc.IToolRelease[] | undefined
 ): Promise<string | undefined> {
   try {
-    const info = await getInfoFromManifest(versionSpec, stable, auth);
+    const info = await getInfoFromManifest(
+      versionSpec,
+      stable,
+      auth,
+      osArch,
+      manifest
+    );
     return info?.resolvedVersion;
   } catch (err) {
     core.info('Unable to resolve version from manifest...');
@@ -244,9 +338,12 @@ function evaluateVersions(versions: string[], versionSpec: string): string {
   return version;
 }
 
-async function queryDistForMatch(versionSpec: string): Promise<string> {
+async function queryDistForMatch(
+  versionSpec: string,
+  arch: string = os.arch()
+): Promise<string> {
   let osPlat: string = os.platform();
-  let osArch: string = translateArchToDistUrl(os.arch());
+  let osArch: string = translateArchToDistUrl(arch);
 
   // node offers a json list of versions
   let dataFileName: string;
@@ -292,10 +389,11 @@ async function queryDistForMatch(versionSpec: string): Promise<string> {
 // Note also that the files are normally zipped but in this case they are just an exe
 // and lib file in a folder, not zipped.
 async function acquireNodeFromFallbackLocation(
-  version: string
+  version: string,
+  arch: string = os.arch()
 ): Promise<string> {
   let osPlat: string = os.platform();
-  let osArch: string = translateArchToDistUrl(os.arch());
+  let osArch: string = translateArchToDistUrl(arch);
 
   // Create temporary folder to download in to
   const tempDownloadFolder: string =
@@ -329,7 +427,7 @@ async function acquireNodeFromFallbackLocation(
       throw err;
     }
   }
-  let toolPath = await tc.cacheDir(tempDir, 'node', version);
+  let toolPath = await tc.cacheDir(tempDir, 'node', version, arch);
   core.addPath(toolPath);
   return toolPath;
 }

src/main.ts

@@ -3,8 +3,10 @@ import * as installer from './installer';
 import * as auth from './authutil';
 import fs = require('fs');
 import * as path from 'path';
+import {restoreCache} from './cache-restore';
 import {URL} from 'url';
 import {parseNodeVersionFile} from './node-version-file';
+import os = require('os');
 
 export async function run() {
   try {
@@ -28,6 +30,20 @@ export async function run() {
         core.info(`Resolved ${versionFile} as ${version}`);
       }
     }
+    let arch = core.getInput('architecture');
+    const cache = core.getInput('cache');
+
+    // if architecture supplied but node-version is not
+    // if we don't throw a warning, the already installed x64 node will be used which is not probably what user meant.
+    if (arch && !version) {
+      core.warning(
+        '`architecture` is provided but `node-version` is missing. In this configuration, the version/architecture of Node will not be changed. To fix this, provide `architecture` in combination with `node-version`'
+      );
+    }
+
+    if (!arch) {
+      arch = os.arch();
+    }
 
     if (version) {
       let token = core.getInput('token');
@@ -35,7 +51,7 @@ export async function run() {
       let stable = (core.getInput('stable') || 'true').toUpperCase() === 'TRUE';
       const checkLatest =
         (core.getInput('check-latest') || 'false').toUpperCase() === 'TRUE';
-      await installer.getNode(version, stable, checkLatest, auth);
+      await installer.getNode(version, stable, checkLatest, auth, arch);
     }
 
     const registryUrl: string = core.getInput('registry-url');
@@ -44,12 +60,20 @@ export async function run() {
       auth.configAuthentication(registryUrl, alwaysAuth);
     }
 
-    const matchersPath = path.join(__dirname, '..', '.github');
-    console.log(`##[add-matcher]${path.join(matchersPath, 'tsc.json')}`);
-    console.log(
+    if (cache) {
+      if (isGhes()) {
+        throw new Error('Caching is not supported on GHES');
+      }
+      const cacheDependencyPath = core.getInput('cache-dependency-path');
+      await restoreCache(cache, cacheDependencyPath);
+    }
+
+    const matchersPath = path.join(__dirname, '../..', '.github');
+    core.info(`##[add-matcher]${path.join(matchersPath, 'tsc.json')}`);
+    core.info(
       `##[add-matcher]${path.join(matchersPath, 'eslint-stylish.json')}`
     );
-    console.log(
+    core.info(
       `##[add-matcher]${path.join(matchersPath, 'eslint-compact.json')}`
     );
   } catch (error) {