Enable caching by default if `packageManager` field is defined in package.json

[trivikr]

Description:
The action allows caching global packages data as per documentation in https://github.com/actions/setup-node#caching-global-packages-data

It's an amazing feature and reduces action execution time, but it has to be enabled in configuration.
Caching is not enabled in default setup. Users may not discover caching feature by default, and miss on the faster executions times enabled by caching.

The feature request is to enable caching by default if packageManager field is defined.
This can be enabled in a major version bump, say v4, to not affect existing users.

Justification:
Just want all users to get benefit of faster executions times allowed by caching without explicitly opting in, if they have set up packageManager field in their package.json

They can always explicitly opt-out by setting cache to empty string.

Are you willing to submit a PR?
Yes

[trivikr]

I think the implementation can be as simple as

-    if (cache && isCacheFeatureAvailable()) {
+    const packageManagerFromManifest = getNameFromPackageManagerField();
+    if ((cache !== "" || packageManagerFromManifest) && isCacheFeatureAvailable()) {
       const cacheDependencyPath = core.getInput('cache-dependency-path');
-      await restoreCache(cache, cacheDependencyPath);
+      const packageManager = cache !== "" ? cache : packageManagerFromManifest;
+      await restoreCache(packageManager, cacheDependencyPath);
     }

where getNameFromPackageManagerField returns the package manager name from packageManager field. That is:

• yarn if the value is yarn@X.Y.Z
• pnpm is the value is pnpm@X.Y.Z
• undefined otherwise

Other package managers can be added, once they are supported

[MaksimZhukov]

Hello @trivikr ! Thank you for the suggested idea!
We will consider adding this feature and will let you know as soon as we have any decision.

[Airkro]

This is what I doing before this feature landed:

jobs:
  steps:
    - name: Checkout
      uses: actions/checkout@v3

    - name: Detect package manager
      shell: bash
      run: node -p "'PACKAGE_MANAGER='+require('./package.json').packageManager?.split?.('@')?.[0]" >> "$GITHUB_ENV"

    - name: Install pnpm
      run: corepack enable pnpm
      if: ${{ env.PACKAGE_MANAGER == 'pnpm' }}
      # install pnpm before setup-node

    - name: Setup node
      uses: actions/setup-node@v3
      with:
        node-version: lts
        cache: ${{ env.PACKAGE_MANAGER }}

[trivikr]

Revisiting this, as devEngines has now appeared as a standard in Node.js ecosystem.
It'll be better to track devEngines.packageManager instead of (or in addition to) packageManager field.

It's implemented by npm@10.9.0 as well as corepack@0.32.0.

[HarithaVattikuti]

Hello Everyone,
We’ve raised PR #1348 to address the above request. Please validate it against the requirement, and confirm to proceed further.
Feel free to reach out if you have any questions or need further clarification.