@devicecloud.dev/dcd 5.7.1 → 5.8.0-beta.1

package/dist/gateways/api-gateway.d.ts

@@ -1,7 +1,7 @@
 import { TAppMetadata } from '../types.js';
 import type { AuthContext } from '../types/domain/auth.types.js';
 import type { LiveCommandStatus, LiveExecResult, LiveSession, LiveSessionSummary } from '../types/domain/live.types.js';
-import { components } from '../types/generated/schema.types.js';
+import { components, paths } from '../types/generated/schema.types.js';
 /**
  * Error thrown for non-OK API responses, carrying the HTTP status so callers
  * can branch on auth failures etc. without string matching.
@@ -10,6 +10,17 @@ export declare class ApiError extends Error {
     status: number;
     constructor(message: string, status: number);
 }
+type ResultsResponse = paths['/results/{uploadId}']['get']['responses']['200']['content']['application/json'];
+/**
+ * The last results body a poll loop received and the ETag it came with, so
+ * the next poll can revalidate with `If-None-Match` and get an empty 304 back
+ * when nothing changed. Create one per poll loop; `getResultsForUpload` fills
+ * and clears it.
+ */
+export interface ResultsPollCache {
+    body?: ResultsResponse;
+    etag?: string;
+}
 export declare const ApiGateway: {
     /**
      * Enhances generic "fetch failed" errors with more specific diagnostic information
@@ -98,7 +109,23 @@ export declare const ApiGateway: {
         token?: string;
     }>;
     finishLargeFile(baseUrl: string, auth: AuthContext, fileId: string, partSha1Array: string[]): Promise<unknown>;
-    getResultsForUpload(baseUrl: string, auth: AuthContext, uploadId: string): Promise<{
+    /**
+     * Fetch the result rows for an upload, for the `dcd cloud` poll loop.
+     *
+     * Asks for `?view=summary`, which leaves out `result_files` and the rest of
+     * the columns the CLI never reads. An API that predates the view ignores
+     * the parameter and returns the full rows, a superset, so this works
+     * against either.
+     *
+     * With a `cache`, a repeat poll revalidates with `If-None-Match` and a 304
+     * hands back the cached body.
+     * @param baseUrl API base URL
+     * @param auth AuthContext carrying request headers
+     * @param uploadId Upload ID to fetch results for
+     * @param cache Optional per-poll-loop cache, filled and cleared here
+     * @returns The results response body
+     */
+    getResultsForUpload(baseUrl: string, auth: AuthContext, uploadId: string, cache?: ResultsPollCache): Promise<{
         statusCode?: number;
         results?: components["schemas"]["TResultResponse"][];
     }>;
@@ -209,3 +236,4 @@ export declare const ApiGateway: {
     stopLiveSession(baseUrl: string, auth: AuthContext, sessionName: string): Promise<void>;
     getLiveSession(baseUrl: string, auth: AuthContext, sessionName: string): Promise<LiveSession>;
 };
+export {};

package/dist/gateways/api-gateway.js

@@ -347,20 +347,73 @@ export const ApiGateway = {
             throw error;
         }
     },
-    async getResultsForUpload(baseUrl, auth, uploadId) {
+    /**
+     * Fetch the result rows for an upload, for the `dcd cloud` poll loop.
+     *
+     * Asks for `?view=summary`, which leaves out `result_files` and the rest of
+     * the columns the CLI never reads. An API that predates the view ignores
+     * the parameter and returns the full rows, a superset, so this works
+     * against either.
+     *
+     * With a `cache`, a repeat poll revalidates with `If-None-Match` and a 304
+     * hands back the cached body.
+     * @param baseUrl API base URL
+     * @param auth AuthContext carrying request headers
+     * @param uploadId Upload ID to fetch results for
+     * @param cache Optional per-poll-loop cache, filled and cleared here
+     * @returns The results response body
+     */
+    async getResultsForUpload(baseUrl, auth, uploadId, cache) {
         // TODO: merge with getUploadStatus
+        const url = `${baseUrl}/results/${uploadId}?view=summary`;
         try {
-            const res = await fetch(`${baseUrl}/results/${uploadId}`, {
-                headers: { ...auth.headers },
-            });
+            const headers = { ...auth.headers };
+            if (cache?.body && cache.etag) {
+                headers['if-none-match'] = cache.etag;
+                // Per the Fetch spec, undici appends `Cache-Control: no-cache` to any
+                // request that carries a conditional header and no Cache-Control of
+                // its own, and Express's `fresh` never answers 304 to a no-cache
+                // request. So every poll would get a full 200. max-age=0 still asks
+                // for revalidation, and keeps undici from adding no-cache.
+                headers['cache-control'] = 'max-age=0';
+            }
+            const res = await fetch(url, { headers });
+            // Before the `!res.ok` check, since a 304 is not `ok`.
+            if (res.status === 304) {
+                if (cache?.body) {
+                    return cache.body;
+                }
+                // We sent no If-None-Match, so there is nothing to reuse. Start over
+                // with an unconditional request on the next poll.
+                if (cache) {
+                    delete cache.body;
+                    delete cache.etag;
+                }
+                throw new Error('Failed to get results: API returned 304 Not Modified to an unconditional request');
+            }
             if (!res.ok) {
                 await this.handleApiError(res, 'Failed to get results');
             }
-            return await parseJsonResponse(res, 'Failed to get results');
+            const body = await parseJsonResponse(res, 'Failed to get results');
+            if (cache) {
+                // Only pin a real result set. The API reports some errors as a 200
+                // with a `{ statusCode, message }` envelope, and an empty set is
+                // rejected by the poll loop; caching either would replay it on 304.
+                const etag = res.headers.get('etag');
+                if (etag && Array.isArray(body.results) && body.results.length > 0) {
+                    cache.body = body;
+                    cache.etag = etag;
+                }
+                else {
+                    delete cache.body;
+                    delete cache.etag;
+                }
+            }
+            return body;
         }
         catch (error) {
             if (error instanceof TypeError && error.message === 'fetch failed') {
-                throw this.enhanceFetchError(error, `${baseUrl}/results/${uploadId}`);
+                throw this.enhanceFetchError(error, url);
             }
             throw error;
         }

package/dist/services/results-polling.service.d.ts

@@ -118,6 +118,7 @@ export declare class ResultsPollingService {
      * @param apiUrl API base URL
      * @param auth AuthContext carrying request headers
      * @param uploadId Upload ID to fetch results for
+     * @param cache The poll loop's results cache, for ETag revalidation
      * @param debug Whether debug logging is enabled
      * @param logger Optional logger function
      * @returns Promise resolving to test results

package/dist/services/results-polling.service.js

@@ -133,6 +133,9 @@ export class ResultsPollingService {
         let { auth } = options;
         this.initializePollingDisplay(json, logger);
         let sequentialPollFailures = 0;
+        // The last result set and its ETag, so a poll that finds nothing changed
+        // gets an empty 304 instead of the whole set again.
+        const resultsCache = {};
         const pollIntervalMs = auth.mode === 'bearer'
             ? this.BEARER_POLL_INTERVAL_MS
             : this.APIKEY_POLL_INTERVAL_MS;
@@ -229,7 +232,7 @@ export class ResultsPollingService {
                     nextPollAt = null;
                     renderStatus();
                     auth = await this.refreshPollingAuth(auth, uploadId, subscription, debug, logger);
-                    const updatedResults = await this.fetchAndLogResults(apiUrl, auth, uploadId, debug, logger);
+                    const updatedResults = await this.fetchAndLogResults(apiUrl, auth, uploadId, resultsCache, debug, logger);
                     const { summary } = this.calculateStatusSummary(updatedResults);
                     if (!json) {
                         statusBody = this.buildStatusBody(updatedResults, quiet, summary);
@@ -395,21 +398,28 @@ export class ResultsPollingService {
      * @param apiUrl API base URL
      * @param auth AuthContext carrying request headers
      * @param uploadId Upload ID to fetch results for
+     * @param cache The poll loop's results cache, for ETag revalidation
      * @param debug Whether debug logging is enabled
      * @param logger Optional logger function
      * @returns Promise resolving to test results
      */
-    async fetchAndLogResults(apiUrl, auth, uploadId, debug, logger) {
+    async fetchAndLogResults(apiUrl, auth, uploadId, cache, debug, logger) {
         if (debug && logger) {
             logger(`[DEBUG] Polling for results: ${uploadId}`);
         }
-        const { results: updatedResults } = await ApiGateway.getResultsForUpload(apiUrl, auth, uploadId);
+        // A 304 hands back the cached body itself; a 200 is always a new object.
+        const cachedBody = cache.body;
+        const response = await ApiGateway.getResultsForUpload(apiUrl, auth, uploadId, cache);
+        const notModified = cachedBody !== undefined && response === cachedBody;
+        const { results: updatedResults } = response;
         // An empty array would otherwise read as "all complete, all passed".
         if (!updatedResults || updatedResults.length === 0) {
             throw new Error('no results');
         }
         if (debug && logger) {
-            logger(`[DEBUG] Poll received ${updatedResults.length} results`);
+            logger(notModified
+                ? `[DEBUG] Poll not modified (304), reusing ${updatedResults.length} cached results`
+                : `[DEBUG] Poll received ${updatedResults.length} results`);
             for (const result of updatedResults) {
                 logger(`[DEBUG] Result status: ${result.test_file_name} - ${result.status}`);
             }

package/package.json

@@ -68,7 +68,7 @@
     "test:unit": "node scripts/test-runner.mjs --unit",
     "typecheck": "tsc --noEmit -p tsconfig.test.json"
   },
-  "version": "5.7.1",
+  "version": "5.8.0-beta.1",
   "bugs": {
     "url": "https://discord.gg/gm3mJwcNw8"
   },