Add Pinned Workflow Refresh Etag Support

Author: JustinGrote

package.json

@@ -94,7 +94,7 @@
         "github-actions.workflows.pinned.refresh.interval": {
           "type": "number",
           "description": "Time to wait between calls to update pinned workflows in seconds",
-          "default": 30,
+          "default": 1,
           "scope": "window"
         },
         "github-actions.remote-name": {
@@ -527,6 +527,8 @@
   },
   "devDependencies": {
     "@eslint/js": "^9.30.1",
+    "@octokit/openapi-types": "^25.1.0",
+    "@octokit/plugin-rest-endpoint-methods": "^16.0.0",
     "@types/jest": "^29.5.14",
     "@types/libsodium-wrappers": "^0.7.14",
     "@types/node": "^20.19.4",

pnpm-lock.yaml

@@ -4,6 +4,7 @@ import {getGitHubApiUri} from "../configuration/configuration";
 import {throttling} from "@octokit/plugin-throttling";
 import {retry} from "@octokit/plugin-retry";
 import {conditionalRequest} from "./conditionalRequests";
+import {createOctokitLogger} from "../log";
 
 export const userAgent = `VS Code GitHub Actions (${version})`;
 
@@ -13,6 +14,7 @@ export type GhaOctokit = InstanceType<typeof GhaOctokit>;
 export function getClient(token: string) {
   return new GhaOctokit({
     auth: token,
+    log: createOctokitLogger(),
     userAgent: userAgent,
     baseUrl: getGitHubApiUri(),
     throttle: {

src/api/api.ts

@@ -1,4 +1,4 @@
-import {logError} from "../log";
+import {logDebug, logError, logTrace} from "../log";
 import {assertRequestError} from "../error";
 
 export const conditionalRequest = () => ({
@@ -41,15 +41,20 @@ async function returnIfChanged<TResponse, TParams>(
       : TParams & {headers: Record<string, string>};
 
     const cacheKey = cacheId ?? JSON.stringify(options);
+    logDebug("Performing conditional request for cache key:", cacheKey);
+
     // Add If-None-Match header if we have an ETag for this key
     const cacheMatch = timestamp ? timestampMap.get(cacheKey) : etagMap.get(cacheKey);
     const cacheHeader = timestamp ? "if-modified-since" : "if-none-match";
     if (cacheMatch) {
+      logTrace("Cache Key FOUND:", cacheKey);
       // Initialize headers if they don't exist
       if (!options.headers) {
         options.headers = {};
       }
       options.headers[cacheHeader] = cacheMatch;
+    } else {
+      logTrace("Cache Key MISS:", cacheKey);
     }
 
     // TODO: Figure out how to make this type safe
@@ -59,6 +64,7 @@ async function returnIfChanged<TResponse, TParams>(
     // Store the new ETag if provided
     const responseEtag = timestamp ? response.headers.last_modified : response.headers.etag;
     if (responseEtag) {
+      logTrace("Cache Key STORE:", cacheKey, responseEtag);
       if (timestamp) {
         timestampMap.set(cacheKey, responseEtag);
       } else {
@@ -72,6 +78,7 @@ async function returnIfChanged<TResponse, TParams>(
 
     // Resource not modified (304), return undefined.
     if (err.status === 304) {
+      logTrace("Content Not Modified:", cacheId);
       return undefined;
     }
 

src/api/conditionalRequests.ts

@@ -97,7 +97,7 @@ export function isPinnedWorkflowsRefreshEnabled(): boolean {
 }
 
 export function pinnedWorkflowsRefreshInterval(): number {
-  return getConfiguration().get<number>(getSettingsKey("workflows.pinned.refresh.interval"), 60);
+  return getConfiguration().get<number>(getSettingsKey("workflows.pinned.refresh.interval"), 1);
 }
 
 export function getRemoteName(): string {

src/configuration/configuration.ts

@@ -6,6 +6,14 @@ export function init() {
   logger = vscode.window.createOutputChannel("GitHub Actions", {log: true});
 }
 
+export function logError(e: Error, ...values: unknown[]) {
+  logger.error(e, values);
+}
+
+export function logWarn(...values: unknown[]) {
+  logger.warn(values.join(" "));
+}
+
 export function log(...values: unknown[]) {
   logger.info(values.join(" "));
 }
@@ -14,10 +22,28 @@ export function logDebug(...values: unknown[]) {
   logger.debug(values.join(" "));
 }
 
-export function logError(e: Error, ...values: unknown[]) {
-  logger.error(e, values);
+export function logTrace(...values: unknown[]) {
+  logger.trace(values.join(" "));
 }
 
 export function revealLog() {
   logger.show();
 }
+
+const octoPrefix = "[Octokit]";
+
+export function createOctokitLogger() {
+  return {
+    debug: (...args: unknown[]) => logTrace(octoPrefix, "[DBG]", ...args),
+    info: (...args: unknown[]) => logTrace(octoPrefix, "[INF]", ...args),
+    warn: (...args: unknown[]) => logTrace(octoPrefix, "[WRN]", ...args),
+    error: (...args: unknown[]) =>
+      logTrace(
+        octoPrefix,
+        "[ERR]",
+        args[0] instanceof Error ? (args[0] as Error) : new Error(octoPrefix + String(args[0])),
+        ...args.slice(1)
+      )
+  };
+}
+

src/log.ts

@@ -9,7 +9,7 @@ import {
 import {getGitHubContextForWorkspaceUri, GitHubRepoContext} from "../git/repository";
 
 import {sep} from "path";
-import {log, logError} from "../log";
+import {log, logDebug, logError} from "../log";
 import {Workflow} from "../model";
 import {RunStore} from "../store/store";
 import {WorkflowRun} from "../store/workflowRun";
@@ -114,7 +114,6 @@ async function updatePinnedWorkflows() {
     });
 
     const workflowByPath: {[id: string]: Workflow} = {};
-    // @ts-expect-error FIXME: Newer Typescript catches a problem that previous didn't. This will be fixed in Octokit bump.
     workflows.forEach(w => (workflowByPath[w.path] = w));
 
     for (const pinnedWorkflow of workflowsByWorkspace.get(workspaceName) || []) {
@@ -129,12 +128,6 @@ async function updatePinnedWorkflows() {
   }
 }
 
-async function refreshPinnedWorkflows() {
-  for (const pinnedWorkflow of pinnedWorkflows) {
-    await refreshPinnedWorkflow(pinnedWorkflow);
-  }
-}
-
 function clearPinnedWorkflows() {
   // Remove any existing pinned workflows
   for (const pinnedWorkflow of pinnedWorkflows) {
@@ -150,8 +143,8 @@ function createPinnedWorkflow(gitHubRepoContext: GitHubRepoContext, workflow: Wo
 
   const pinnedWorkflow = {
     gitHubRepoContext,
-    workflowId: workflow.id,
-    workflowName: workflow.name,
+    workflowId: (workflow as any).id,
+    workflowName: (workflow as any).name,
     lastRunId: undefined,
     statusBarItem
   };
@@ -161,20 +154,37 @@ function createPinnedWorkflow(gitHubRepoContext: GitHubRepoContext, workflow: Wo
   return pinnedWorkflow;
 }
 
+async function refreshPinnedWorkflows() {
+  for (const pinnedWorkflow of pinnedWorkflows) {
+    await refreshPinnedWorkflow(pinnedWorkflow);
+  }
+}
+
 async function refreshPinnedWorkflow(pinnedWorkflow: PinnedWorkflow) {
   const {gitHubRepoContext} = pinnedWorkflow;
   const {client} = gitHubRepoContext;
-
+  logDebug("Checking for updates to pinned workflow", pinnedWorkflow.workflowName, "in", gitHubRepoContext.name);
   try {
-    const run = await client.paginate(client.actions.listWorkflowRuns, {
-      owner: gitHubRepoContext.owner,
-      repo: gitHubRepoContext.name,
-      workflow_id: pinnedWorkflow.workflowId,
-      per_page: 1,
-      page: 1
-    });
+    const workflowRunCacheId = `MostRecentRun-${gitHubRepoContext.owner}/${gitHubRepoContext.name}/${pinnedWorkflow.workflowId}`;
+    const workflowRunResult = await client.conditionalRequest(
+      client.actions.listWorkflowRuns,
+      {
+        owner: gitHubRepoContext.owner,
+        repo: gitHubRepoContext.name,
+        workflow_id: pinnedWorkflow.workflowId,
+        per_page: 1,
+        page: 1
+      },
+      workflowRunCacheId
+    );
+
+    if (workflowRunResult === undefined) {
+      logDebug("No new runs detected for pinned workflow", pinnedWorkflow.workflowName);
+      return;
+    }
 
-    const mostRecentRun = run[0];
+    const mostRecentRun = workflowRunResult.data.workflow_runs[0];
+    logDebug("Updating pinned workflow", pinnedWorkflow.workflowName, "with most recent run id", mostRecentRun?.id);
 
     runStore.addRun(gitHubRepoContext, mostRecentRun);