Orb behaviour with restore_cache does not match what source code says it should be doing

[jamesrwu]

Orb version: 5.0.0

What happened:

In our node/install-packages step, I notice the restore_cache output to be something like this:

No cache is found for key: node-deps-arch1-linux-amd64-6_85-v1-WEBPLAT-1424-otawg9WNM0SS_vutk39ZUPxQPgxUCFt5g4TXo9whdYs=
Found a cache from build 188495 at node-deps-arch1-linux-amd64-6_85-v1-WEBPLAT-1424-3zVE04aLnLzo5ttkKIxeRB9NIhoXVIiqLiwkGMKBONA=

After which npm ci runs for 5 minutes or so. After that is done, I notice that it is skipping cache generation with such a message

Skipping cache generation, cache already exists for key: node-deps-arch1-linux-amd64-6_85-v1-WEBPLAT-1424-3zVE04aLnLzo5ttkKIxeRB9NIhoXVIiqLiwkGMKBONA=-otawg9WNM0SS_vutk39ZUPxQPgxUCFt5g4TXo9whdYs=

Expected behavior:

Based on the source code as I see here:

node-orb/src/commands/install-packages.yml

Lines 68 to 72 in ccf5f1a

	- restore_cache: # Include branch and package.json checksum if defined. Prioritize lock-file as it is a more definitive version of dependency cache.
	keys:
	- node-deps-{{ arch }}-<<parameters.cache-version>>-<<#parameters.include-branch-in-cache-key>>{{ .Branch }}-<</parameters.include-branch-in-cache-key>><<^parameters.cache-only-lockfile>>{{ checksum "/tmp/node-project-package.json" }}-<</parameters.cache-only-lockfile>>{{ checksum "/tmp/node-project-lockfile" }}
	- node-deps-{{ arch }}-<<parameters.cache-version>>-<<#parameters.include-branch-in-cache-key>>{{ .Branch }}-<</parameters.include-branch-in-cache-key>>{{ checksum "/tmp/node-project-package.json" }}
	- node-deps-{{ arch }}-<<parameters.cache-version>>-<<#parameters.include-branch-in-cache-key>>{{ .Branch }}-<</parameters.include-branch-in-cache-key>>

My expectation
is that during the cache restore step, it would have searched for the same cache key that eventually got generated npm ci step.

Additional Information:

Additional context from our config.yaml:

  node: circleci/[email protected]

We're running node/install-packages with no custom parameters.

[Jaryt]

Hi James!

Thanks for bringing this up. Can you increment the cache-version parameter to "v2" and see if this behavior persists?

[nicklozon]

Ran into this too - the cache key when saving is not respecting the cache-only-lockfile parameter when set to true which is the default.

#129 attempts to solve the issue

Workaround: Set cache-only-lockfile: false