feat(cache): add support for storing and retrieving metadata with remote cache entries

[titan-ron]

Feature Request: Support for Metadata in HttpRemoteCache

Context:
Currently, the Nx native HttpRemoteCache stores and retrieves terminal output, exit code, and cache artifacts for task results. However, some users need to attach additional metadata (e.g., target task, project name, and task duration) for better observability, debugging, and analytics.

Request:

• Add the ability to include extra metadata with each cache upload and download, specifically:
  • Target task (e.g., build, test, lint)
  • Project name
  • Task duration (for uploads only, preferably in milliseconds)
• On retrieval, make this metadata available to consumers of the cache result (e.g., extend CachedResult).
• Maintain backward compatibility (e.g., fail gracefully if fields are missing in older cache results).

Rationale:

• Improves remote cache transparency and diagnostic capabilities.
• Makes it easier to analyze, build performance, and remote cache usage.
• No changes to the underlying hash calculation are necessary since the metadata are supplementary.

Example Implementation Outline:

• Update HttpRemoteCache::store to accept and archive metadata fields.
• Update HttpRemoteCache::retrieve to extract metadata as part of the result.
• Extend CachedResult to include this metadata.

Thanks for considering this improvement!

[danielgel]

+1