Bump Octokit Rest to v21, add retry/throttle plugins, and fix Variables breaking change

Author: JustinGrote

package-lock.json

@@ -564,7 +564,9 @@
   "dependencies": {
     "@actions/languageserver": "*",
     "@actions/workflow-parser": "*",
-    "@octokit/rest": "^19.0.7",
+    "@octokit/plugin-retry": "^7.1.4",
+    "@octokit/plugin-throttling": "^9.4.0",
+    "@octokit/rest": "^21.1.1",
     "@vscode/vsce": "^2.19.0",
     "buffer": "^6.0.3",
     "crypto-browserify": "^3.12.0",

package.json

@@ -1,13 +1,36 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
 import {Octokit} from "@octokit/rest";
 import {version} from "../../package.json";
 import {getGitHubApiUri} from "../configuration/configuration";
+import {throttling} from "@octokit/plugin-throttling";
+import {retry} from "@octokit/plugin-retry";
 
 export const userAgent = `VS Code GitHub Actions (${version})`;
 
-export function getClient(token: string): Octokit {
-  return new Octokit({
+const GhaOctokit = Octokit.plugin(throttling, retry);
+export type GhaOctokit = InstanceType<typeof GhaOctokit>;
+
+export function getClient(token: string) {
+  return new GhaOctokit({
     auth: token,
     userAgent: userAgent,
-    baseUrl: getGitHubApiUri()
+    baseUrl: getGitHubApiUri(),
+    throttle: {
+      onRateLimit: (retryAfter, options, octokit) => {
+        octokit.log.warn(
+          `Request quota exhausted for request ${options.method} ${options.url}. Retrying after ${retryAfter} seconds.`
+        );
+
+        if (options.request.retryCount === 0) {
+          // only retries once
+          return true;
+        }
+      },
+      onSecondaryRateLimit: (retryAfter, options, octokit) => {
+        octokit.log.warn(
+          `Abuse detected for request ${options.method} ${options.url}. Retrying after ${retryAfter} seconds.`
+        );
+      }
+    }
   });
 }

src/api/api.ts

@@ -1,13 +1,12 @@
-import {Octokit} from "@octokit/rest";
 import {AuthenticationSession} from "vscode";
 
 import {newSession} from "../auth/auth";
 import {logDebug} from "../log";
-import {getClient} from "./api";
+import {getClient, GhaOctokit} from "./api";
 
 export async function handleSamlError<T>(
   session: AuthenticationSession,
-  request: (client: Octokit) => Promise<T>
+  request: (client: GhaOctokit) => Promise<T>
 ): Promise<T> {
   try {
     const client = getClient(session.accessToken);

src/api/handleSamlError.ts

@@ -66,12 +66,14 @@ export async function createOrUpdateEnvSecret(
   value: string
 ) {
   const keyResponse = await context.client.actions.getEnvironmentPublicKey({
-    repository_id: context.id,
+    owner: context.owner,
+    repo: context.name,
     environment_name: environment
   });
 
   await context.client.actions.createOrUpdateEnvironmentSecret({
-    repository_id: context.id,
+    owner: context.owner,
+    repo: context.name,
     environment_name: environment,
     secret_name: name,
     key_id: keyResponse.data.key_id,

src/commands/secrets/addSecret.ts

@@ -18,7 +18,8 @@ export function registerDeleteSecret(context: vscode.ExtensionContext) {
             if (answer === acceptText) {
               if (environment) {
                 await gitHubRepoContext.client.actions.deleteEnvironmentSecret({
-                  repository_id: gitHubRepoContext.id,
+                  owner: gitHubRepoContext.owner,
+                  repo: gitHubRepoContext.name,
                   environment_name: environment.name,
                   secret_name: secret.name
                 });

src/commands/secrets/deleteSecret.ts

@@ -31,7 +31,8 @@ export function registerAddVariable(context: vscode.ExtensionContext) {
       try {
         if ("environment" in args) {
           await gitHubRepoContext.client.actions.createEnvironmentVariable({
-            repository_id: gitHubRepoContext.id,
+            owner: gitHubRepoContext.owner,
+            repo: gitHubRepoContext.name,
             environment_name: args.environment.name,
             name,
             value

src/commands/variables/addVariable.ts

@@ -1,6 +1,5 @@
 import * as vscode from "vscode";
-import {Octokit} from "@octokit/rest";
-
+import {type GhaOctokit} from "../api/api";
 import {canReachGitHubAPI} from "../api/canReachGitHubAPI";
 import {handleSamlError} from "../api/handleSamlError";
 import {getSession} from "../auth/auth";
@@ -131,7 +130,7 @@ export async function getGitHubUrls(): Promise<GitHubUrls[] | null> {
 }
 
 export interface GitHubRepoContext {
-  client: Octokit;
+  client: GhaOctokit;
   repositoryState: RepositoryState | undefined;
 
   workspaceUri: vscode.Uri;
@@ -186,7 +185,7 @@ export async function getGitHubContext(): Promise<GitHubContext | undefined> {
     }
     const username = session.account.label;
 
-    const repos = await handleSamlError(session, async (client: Octokit) => {
+    const repos = await handleSamlError(session, async (client: GhaOctokit) => {
       return await Promise.all(
         protocolInfos.map(async (protocolInfo): Promise<GitHubRepoContext> => {
           logDebug("Getting infos for repository", protocolInfo.url);

src/git/repository.ts

@@ -21,7 +21,8 @@ export class EnvironmentSecretsNode extends vscode.TreeItem {
       secrets = await this.gitHubRepoContext.client.paginate(
         this.gitHubRepoContext.client.actions.listEnvironmentSecrets,
         {
-          repository_id: this.gitHubRepoContext.id,
+          owner: this.gitHubRepoContext.owner,
+          repo: this.gitHubRepoContext.name,
           environment_name: this.environment.name,
           per_page: 100
         },

src/treeViews/settings/environmentSecretsNode.ts

@@ -21,12 +21,15 @@ export class EnvironmentVariablesNode extends vscode.TreeItem {
       variables = await this.gitHubRepoContext.client.paginate(
         this.gitHubRepoContext.client.actions.listEnvironmentVariables,
         {
-          repository_id: this.gitHubRepoContext.id,
-          environment_name: this.environment.name,
-          per_page: 100
+          owner: this.gitHubRepoContext.owner,
+          repo: this.gitHubRepoContext.name,
+          environment_name: this.environment.name
         },
-        response => response.data.map(v => new VariableNode(this.gitHubRepoContext, v, this.environment))
+        response => {
+          return response.data.map(variable => new VariableNode(this.gitHubRepoContext, variable, this.environment));
+        }
       );
+
     } catch (e) {
       await vscode.window.showErrorMessage((e as Error).message);
     }