Add path option to @nx/s3-cache

[j3tan]

The @nx/s3-cache plugin (as of 1.3.2.) does not provide a way to prepend a path to the Key for the s3 object.

In nx-aws-cache, this was done by overloading the awsBucket option which would extract out the bucket name (first slug) and use the rest of the path when creating the key.

For example,

bucket: 'my-bucket/some/path'`

would result in a put/retrieve payload that looks like:

params: {
  Bucket: 'my-bucket',
  Key: path.join('some/path', hash),
  Body: stream
}

Having a path or cacheKeyPrefix option that is prepended to the cache key would enable better organization of Nx-specific cache objects and granular security/network rules for S3 bucket access. Or simply do what nx-aws-cache does and overload the bucket option in the s3 configuration object.

[cuddlecake]

Would like to add, another communit plugin (https://www.npmjs.com/package/@pellegrims/nx-remotecache-s3) also had an option for prefixes which we found very useful in our org.

That way, we had to manage only one S3 bucket that multiple projects / repositories used, and retain the ability to purge the cache for specific projects.

[jakemhiller]

I previously brought this up in discord and @altan mentioned he would raise it to the team.

[rathpc]

I am also very interested in this being added as we were previously using the prefix option with nx-remotecache-s3 and the absence of this is blocking our upgrade to use the Nx provided s3 package and latest version of Nx.