vercel / remote-cache

The Vercel Remote Cache SDK

Vercel Remote Cache SDK

An SDK for Remote Caching on Vercel

Table of Contents

• Summary
• Examples
• Packages
• Contributing

Summary

Remote Computation Caching (or just Remote Caching) is a feature of advanced build tools like Turborepo, Bazel, and Buck to cache compiled computations and code artifacts in the cloud with the hope of recycling them across machines to reduce overall build/computation time. The key idea is that you "never recompute work that’s already been done before."

Through Vercel's Remote Caching API, teams can leverage this advanced primitive without needing to think about hosting, infrastructure, or maintenance.

This repository holds the source code to the Vercel Remote Caching SDK as well as examples of build systems that leverage it. For those looking to integrate their build systems with Vercel Remote Caching, you've come to the right place. The @vercel/remote SDK is a thin layer over our existing REST API. We've provided packages that implement this SDK for Nx and Rush build tools. See our examples list of build systems using the Vercel Remote Cache.

Examples

Build systems and tools that integrate with Vercel Remote Caching.

• Turborepo
• Rush
• Nx

Packages

Name	Description	Package
@vercel/remote	An SDK for remote artifact caching on Vercel
@vercel/remote-nx	Remote caching plugin for Nx using Vercel Remote Cache
@vercel/remote-rush	Remote caching plugin for Rush using Vercel Remote Cache

Contributing

To develop on this package see the CONTRIBUTING.md.

remote-cache's Issues

nx-remote-cache reuses the ENV from the intial build

Which package / area of the repo does the bug impact?

No response

What version are you using?

@vercel/[email protected]

What package manager are you using / does the bug impact?

npm, pnpm, Yarn v1, Yarn v2/v3

What operating system are you using?

Mac

Describe the Bug

As stated above.
Building a project on develop and then committing that branch to main
makes vercel reuse the existing build,
with existing ENV variables from the other environment.

This might be the intended behaviour but a heads-up warning on your documentation would be nice indeed.

Expected Behavior

Inform users about this behaviour

To Reproduce

Build

Could @vercel-remote-nx use the credentials from the Vercel CLI?

Instead of having to provide this manually via an environment var or .env file, could the runner pick this up from the credentials saved after I vercel login?

Report duration to `@vercel/remote-nx`

Using @vercel/remote-nx right now doesn't show time saved in the Vercel usage. Looking at the code I can see no duration is being passed in remote.put().

@vercel/remote-nx is incompatible with nx@16

Which package / area of the repo does the bug impact?

@vercel/remote-nx

What version are you using?

@vercel/[email protected]

What package manager are you using / does the bug impact?

pnpm

What operating system are you using?

Mac

Describe the Bug

After migrating to nx@16 (using the nx migrate command) and trying to run any cachable nx command with @vercel/remote-nx configured, it errors out with (0 , default_1.default) is not a function.

Nx has changed their package name scopes to from @nrwl/* to @nx/*. (https://blog.nrwl.io/nx-16-is-here-69584ec87053#8e44)
The new package is now called @nx/workspace. This package (@vercel/remote-nx) still depends on @nrwl/workspace, which causes the error.

As a workaround, I used pnpm add @nrwl/workspace@npm:@nx/workspace to alias the old package name to the new.

Expected Behavior

Should work with nx@16.

To Reproduce

Configure @vercel/remote-nx with the latest version of nx (16.x). Run any cachable command (e.g. nx build my-app).