Detect cached folders from multiple directories

.github/workflows/yarn-subprojects.yml

@@ -0,0 +1,81 @@
+# This is a basic workflow to help you get started with Actions
+
+name: CI
+
+on:
+  push:
+
+  workflow_dispatch:
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        node-version: [16]
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: prepare sub-projects
+        env:
+          YARN_ENABLE_IMMUTABLE_INSTALLS: false
+        run: |
+          echo "create yarn2 project in the sub2"
+          mkdir sub2
+          cd sub2
+          cat <<EOT >package.json
+          {
+            "name": "subproject",
+            "dependencies": {
+              "random": "^3.0.6",
+              "uuid": "^9.0.0"
+            }
+          }
+          EOT
+          yarn set version 2.4.3
+          yarn install
+
+          echo "create yarn3 project in the sub3"
+          cd ..
+          mkdir sub3
+          cd sub3
+          cat <<EOT >package.json
+          {
+            "name": "subproject",
+            "dependencies": {
+              "random": "^3.0.6",
+              "uuid": "^9.0.0"
+            }
+          }
+          EOT
+          yarn set version 3.5.1
+          yarn install
+
+          echo "create yarn1 project in the root"
+          cd ..
+          cat <<EOT >package.json
+          {
+            "name": "subproject",
+            "dependencies": {
+              "random": "^3.0.6",
+              "uuid": "^9.0.0"
+            }
+          }
+          EOT
+          yarn set version 1.22.19
+          yarn install
+
+      # expect
+      #  - no errors
+      #  - log
+      #    ##[debug]Cache Paths:
+      #    ##[debug]["sub2/.yarn/cache","sub3/.yarn/cache","../../../.cache/yarn/v6"]
+      - name: Setup Node
+        uses: ./
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'yarn'
+          cache-dependency-path: |
+            **/*.lock
+            yarn.lock

__tests__/authutil.test.ts

@@ -1,9 +1,10 @@
 import os from 'os';
-import * as fs from 'fs';
+import fs from 'fs';
 import * as path from 'path';
 import * as core from '@actions/core';
 import * as io from '@actions/io';
 import * as auth from '../src/authutil';
+import * as cacheUtils from '../src/cache-utils';
 
 let rcFile: string;
 

__tests__/cache-restore.test.ts

@@ -32,13 +32,13 @@ describe('cache-restore', () => {
 
   function findCacheFolder(command: string) {
     switch (command) {
-      case utils.supportedPackageManagers.npm.getCacheFolderCommand:
+      case 'npm config get cache':
         return npmCachePath;
-      case utils.supportedPackageManagers.pnpm.getCacheFolderCommand:
+      case 'pnpm store path --silent':
         return pnpmCachePath;
-      case utils.supportedPackageManagers.yarn1.getCacheFolderCommand:
+      case 'yarn cache dir':
         return yarn1CachePath;
-      case utils.supportedPackageManagers.yarn2.getCacheFolderCommand:
+      case 'yarn config get cacheFolder':
         return yarn2CachePath;
       default:
         return 'packge/not/found';
@@ -108,7 +108,7 @@ describe('cache-restore', () => {
     it.each([['npm7'], ['npm6'], ['pnpm6'], ['yarn1'], ['yarn2'], ['random']])(
       'Throw an error because %s is not supported',
       async packageManager => {
-        await expect(restoreCache(packageManager)).rejects.toThrow(
+        await expect(restoreCache(packageManager, '')).rejects.toThrow(
           `Caching for '${packageManager}' is not supported`
         );
       }
@@ -132,10 +132,10 @@ describe('cache-restore', () => {
           }
         });
 
-        await restoreCache(packageManager);
+        await restoreCache(packageManager, '');
         expect(hashFilesSpy).toHaveBeenCalled();
         expect(infoSpy).toHaveBeenCalledWith(
-          `Cache restored from key: node-cache-${platform}-${packageManager}-${fileHash}`
+          `Cache restored from key: node-cache-${platform}-${packageManager}-v2-${fileHash}`
         );
         expect(infoSpy).not.toHaveBeenCalledWith(
           `${packageManager} cache is not found`
@@ -163,7 +163,7 @@ describe('cache-restore', () => {
         });
 
         restoreCacheSpy.mockImplementationOnce(() => undefined);
-        await restoreCache(packageManager);
+        await restoreCache(packageManager, '');
         expect(hashFilesSpy).toHaveBeenCalled();
         expect(infoSpy).toHaveBeenCalledWith(
           `${packageManager} cache is not found`

__tests__/cache-save.test.ts

@@ -117,8 +117,12 @@ describe('run', () => {
       expect(getInputSpy).toHaveBeenCalled();
       expect(getStateSpy).toHaveBeenCalledTimes(2);
       expect(getCommandOutputSpy).toHaveBeenCalledTimes(2);
-      expect(debugSpy).toHaveBeenCalledWith(`yarn path is ${commonPath}/yarn1`);
-      expect(debugSpy).toHaveBeenCalledWith('Consumed yarn version is 1.2.3');
+      expect(debugSpy).toHaveBeenCalledWith(
+        'Consumed yarn version is 1.2.3 (working dir: "")'
+      );
+      expect(debugSpy).toHaveBeenCalledWith(
+        'yarn\'s cache folder "/some/random/path/yarn1" configured for the root directory'
+      );
       expect(infoSpy).toHaveBeenCalledWith(
         `Cache hit occurred on the primary key ${yarnFileHash}, not saving cache.`
       );
@@ -137,8 +141,12 @@ describe('run', () => {
       expect(getInputSpy).toHaveBeenCalled();
       expect(getStateSpy).toHaveBeenCalledTimes(2);
       expect(getCommandOutputSpy).toHaveBeenCalledTimes(2);
-      expect(debugSpy).toHaveBeenCalledWith(`yarn path is ${commonPath}/yarn2`);
-      expect(debugSpy).toHaveBeenCalledWith('Consumed yarn version is 2.2.3');
+      expect(debugSpy).toHaveBeenCalledWith(
+        'Consumed yarn version is 2.2.3 (working dir: "")'
+      );
+      expect(debugSpy).toHaveBeenCalledWith(
+        'yarn\'s cache folder "/some/random/path/yarn2" configured for the root directory'
+      );
       expect(infoSpy).toHaveBeenCalledWith(
         `Cache hit occurred on the primary key ${yarnFileHash}, not saving cache.`
       );
@@ -155,7 +163,9 @@ describe('run', () => {
       expect(getInputSpy).toHaveBeenCalled();
       expect(getStateSpy).toHaveBeenCalledTimes(2);
       expect(getCommandOutputSpy).toHaveBeenCalledTimes(1);
-      expect(debugSpy).toHaveBeenCalledWith(`npm path is ${commonPath}/npm`);
+      expect(debugSpy).toHaveBeenCalledWith(
+        `npm's cache folder "${commonPath}/npm" configured for the root directory`
+      );
       expect(infoSpy).toHaveBeenCalledWith(
         `Cache hit occurred on the primary key ${npmFileHash}, not saving cache.`
       );
@@ -172,7 +182,9 @@ describe('run', () => {
       expect(getInputSpy).toHaveBeenCalled();
       expect(getStateSpy).toHaveBeenCalledTimes(2);
       expect(getCommandOutputSpy).toHaveBeenCalledTimes(1);
-      expect(debugSpy).toHaveBeenCalledWith(`pnpm path is ${commonPath}/pnpm`);
+      expect(debugSpy).toHaveBeenCalledWith(
+        `pnpm's cache folder "${commonPath}/pnpm" configured for the root directory`
+      );
       expect(infoSpy).toHaveBeenCalledWith(
         `Cache hit occurred on the primary key ${pnpmFileHash}, not saving cache.`
       );
@@ -199,8 +211,12 @@ describe('run', () => {
       expect(getInputSpy).toHaveBeenCalled();
       expect(getStateSpy).toHaveBeenCalledTimes(2);
       expect(getCommandOutputSpy).toHaveBeenCalledTimes(2);
-      expect(debugSpy).toHaveBeenCalledWith(`yarn path is ${commonPath}/yarn1`);
-      expect(debugSpy).toHaveBeenCalledWith('Consumed yarn version is 1.2.3');
+      expect(debugSpy).toHaveBeenCalledWith(
+        'Consumed yarn version is 1.2.3 (working dir: "")'
+      );
+      expect(debugSpy).toHaveBeenCalledWith(
+        'yarn\'s cache folder "/some/random/path/yarn1" configured for the root directory'
+      );
       expect(infoSpy).not.toHaveBeenCalledWith(
         `Cache hit occurred on the primary key ${yarnFileHash}, not saving cache.`
       );
@@ -229,8 +245,12 @@ describe('run', () => {
       expect(getInputSpy).toHaveBeenCalled();
       expect(getStateSpy).toHaveBeenCalledTimes(2);
       expect(getCommandOutputSpy).toHaveBeenCalledTimes(2);
-      expect(debugSpy).toHaveBeenCalledWith(`yarn path is ${commonPath}/yarn2`);
-      expect(debugSpy).toHaveBeenCalledWith('Consumed yarn version is 2.2.3');
+      expect(debugSpy).toHaveBeenCalledWith(
+        'Consumed yarn version is 2.2.3 (working dir: "")'
+      );
+      expect(debugSpy).toHaveBeenCalledWith(
+        'yarn\'s cache folder "/some/random/path/yarn2" configured for the root directory'
+      );
       expect(infoSpy).not.toHaveBeenCalledWith(
         `Cache hit occurred on the primary key ${yarnFileHash}, not saving cache.`
       );
@@ -257,7 +277,9 @@ describe('run', () => {
       expect(getInputSpy).toHaveBeenCalled();
       expect(getStateSpy).toHaveBeenCalledTimes(2);
       expect(getCommandOutputSpy).toHaveBeenCalledTimes(1);
-      expect(debugSpy).toHaveBeenCalledWith(`npm path is ${commonPath}/npm`);
+      expect(debugSpy).toHaveBeenCalledWith(
+        `npm's cache folder "${commonPath}/npm" configured for the root directory`
+      );
       expect(infoSpy).not.toHaveBeenCalledWith(
         `Cache hit occurred on the primary key ${npmFileHash}, not saving cache.`
       );
@@ -284,7 +306,9 @@ describe('run', () => {
       expect(getInputSpy).toHaveBeenCalled();
       expect(getStateSpy).toHaveBeenCalledTimes(2);
       expect(getCommandOutputSpy).toHaveBeenCalledTimes(1);
-      expect(debugSpy).toHaveBeenCalledWith(`pnpm path is ${commonPath}/pnpm`);
+      expect(debugSpy).toHaveBeenCalledWith(
+        `pnpm's cache folder "${commonPath}/pnpm" configured for the root directory`
+      );
       expect(infoSpy).not.toHaveBeenCalledWith(
         `Cache hit occurred on the primary key ${pnpmFileHash}, not saving cache.`
       );
@@ -314,7 +338,9 @@ describe('run', () => {
       expect(getInputSpy).toHaveBeenCalled();
       expect(getStateSpy).toHaveBeenCalledTimes(2);
       expect(getCommandOutputSpy).toHaveBeenCalledTimes(1);
-      expect(debugSpy).toHaveBeenCalledWith(`npm path is ${commonPath}/npm`);
+      expect(debugSpy).toHaveBeenCalledWith(
+        `npm's cache folder "${commonPath}/npm" configured for the root directory`
+      );
       expect(infoSpy).not.toHaveBeenCalledWith(
         `Cache hit occurred on the primary key ${npmFileHash}, not saving cache.`
       );
@@ -344,7 +370,9 @@ describe('run', () => {
       expect(getInputSpy).toHaveBeenCalled();
       expect(getStateSpy).toHaveBeenCalledTimes(2);
       expect(getCommandOutputSpy).toHaveBeenCalledTimes(1);
-      expect(debugSpy).toHaveBeenCalledWith(`npm path is ${commonPath}/npm`);
+      expect(debugSpy).toHaveBeenCalledWith(
+        `npm's cache folder "${commonPath}/npm" configured for the root directory`
+      );
       expect(infoSpy).not.toHaveBeenCalledWith(
         `Cache hit occurred on the primary key ${npmFileHash}, not saving cache.`
       );