Report duraction when storing artifacts in remote-nx

.changeset/warm-hats-chew.md

@@ -0,0 +1,7 @@
+---
+'@vercel/remote-nx': major
+---
+
+Report duraction when storing artifacts in remote-nx. This allows "time saved" to be reported in the Vercel dashboard.
+
+Requires NX v17 or higher.

packages/remote-nx/package.json

@@ -29,15 +29,16 @@
   "author": "Vercel",
   "devDependencies": {
     "@babel/core": "^7.22.5",
-    "@nx/workspace": "^16.3.2",
+    "@nx/workspace": "^17.2.8",
     "@types/yargs": "^17.0.24",
+    "nx": "^17.2.8",
     "tsconfig": "workspace:*",
     "typescript": "5.1.3",
     "vitest": "^0.32.0"
   },
   "dependencies": {
     "@vercel/remote": "workspace:*",
     "chalk": "^4.1.0",
-    "nx-remotecache-custom": "^4.0.0"
+    "nx-remotecache-custom": "^17.1.1"
   }
 }

packages/remote-nx/src/setup-sdk.ts

@@ -1,19 +1,36 @@
+import type { Task } from 'nx/src/config/task-graph';
 import { initEnv } from 'nx-remotecache-custom';
 import { getVercelRemoteCacheClient } from './remote-client';
 import type { Readable } from 'stream';
 import type { VercelRemoteCacheOptions } from './remote-client';
 
 // eslint-disable-next-line @typescript-eslint/require-await
-const setupSDK = async (options: VercelRemoteCacheOptions) => {
+const setupSDK = async (options: VercelRemoteCacheOptions, tasks: Task[]) => {
   initEnv(options);
   const remote = getVercelRemoteCacheClient(options);
+
   return {
     name: 'Vercel Remote Cache',
     fileExists: (filename: string) => remote.exists(filename).send(),
     retrieveFile: (filename: string) => remote.get(filename).stream(),
     storeFile: (filename: string, stream: Readable) =>
-      remote.put(filename).stream(stream),
+      remote
+        .put(filename, {
+          duration: totalDuration(tasks),
+        })
+        .stream(stream),
   };
 };
 
+function totalDuration(tasks: Pick<Task, 'endTime' | 'startTime'>[]) {
+  let total = 0;
+  for (const task of tasks) {
+    if (task.startTime && task.endTime) {
+      total += task.endTime - task.startTime;
+    }
+  }
+
+  return total;
+}
+
 export { setupSDK };

packages/remote-nx/test/setup-sdk.test.ts

@@ -16,7 +16,7 @@ describe('sdk', () => {
       lifeCycle: {},
     };
 
-    const client = await setupSDK(options);
+    const client = await setupSDK(options, []);
     expect(client).toBeDefined();
   });
 
@@ -27,7 +27,7 @@ describe('sdk', () => {
       lifeCycle: {},
     };
 
-    const client = await setupSDK(options);
+    const client = await setupSDK(options, []);
     expect(client.fileExists).toBeInstanceOf(Function);
     expect(client.retrieveFile).toBeInstanceOf(Function);
     expect(client.storeFile).toBeInstanceOf(Function);
@@ -40,7 +40,7 @@ describe('sdk', () => {
       lifeCycle: {},
     };
 
-    await expect(setupSDK(options)).rejects.toThrowError(
+    await expect(setupSDK(options, [])).rejects.toThrowError(
       'Missing a Vercel access token',
     );
   });
@@ -52,6 +52,6 @@ describe('sdk', () => {
     };
     // eslint-disable-next-line turbo/no-undeclared-env-vars
     process.env.NX_VERCEL_REMOTE_CACHE_TOKEN = 'token';
-    await expect(setupSDK(options)).resolves.toBeDefined();
+    await expect(setupSDK(options, [])).resolves.toBeDefined();
   });
 });

packages/remote/src/remote-cache-client.ts

@@ -15,7 +15,7 @@ export interface RemoteClientOptions {
 export interface RemoteClient {
   exists: (hash: string) => ArtifactExistsRequest;
   get: (hash: string) => ArtifactGetRequest;
-  put: (hash: string) => ArtifactPutRequest;
+  put: (hash: string, options?: ArtifactOptions) => ArtifactPutRequest;
 }
 
 export class RemoteClientImpl implements RemoteClient {