@open-cr-agent/vcs-github 0.4.0 → 0.6.0

package/dist/adapter.d.ts

@@ -1,4 +1,4 @@
-import { type CodeSource, type History, PlatformReview } from "@open-cr-agent/vcs-platform";
+import { type CodeSource, type History, type PlatformChangeRequest, PlatformReview } from "@open-cr-agent/vcs-platform";
 import { type GitHubApi, type PullRequest } from "./client.js";
 export interface GitHubPullRequest {
     owner: string;
@@ -12,10 +12,11 @@ export interface GitHubAdapterOptions {
     botLogin: string;
     requestChanges?: boolean;
     history?: History;
-    snapshot?: PullRequest;
+    snapshot?: PlatformChangeRequest;
 }
 export declare const DEFAULT_BOT_LOGIN = "github-actions[bot]";
 export declare class GitHubAdapter extends PlatformReview {
     constructor(options: GitHubAdapterOptions);
 }
+export declare function pullRequestOf(pr: PullRequest, { owner, repo }: Pick<GitHubPullRequest, "owner" | "repo">): PlatformChangeRequest;
 //# sourceMappingURL=adapter.d.ts.map

package/dist/adapter.js

@@ -1,6 +1,5 @@
-import { OcraError } from "@open-cr-agent/core";
-import { errorMessage } from "@open-cr-agent/core/internal";
-import { PlatformReview, } from "@open-cr-agent/vcs-platform";
+import { errorMessage, OcraError } from "@open-cr-agent/core";
+import { githubSuggestion, PlatformReview, } from "@open-cr-agent/vcs-platform";
 import { GitHubApiError, } from "./client.js";
 export const DEFAULT_BOT_LOGIN = "github-actions[bot]";
 // A GitHub pull request as ocra's review conversation (vcs-platform).
@@ -15,11 +14,12 @@ export class GitHubAdapter extends PlatformReview {
     }
 }
 class GitHubPlatform {
-    options;
     text = { changeRequest: "pull request", authority: "write access" };
+    suggestionFence = githubSuggestion;
     pullRequest;
     // The REST comments behind the platform's, for their GraphQL node ids.
     listed = new Map();
+    options;
     constructor(options) {
         this.options = options;
     }
@@ -28,17 +28,14 @@ class GitHubPlatform {
         const login = this.options.botLogin;
         return { login, is: (other) => other === login || `${other}[bot]` === login };
     }
-    async changeRequest() {
-        const pr = await this.pr();
-        const { owner, repo } = this.options.pullRequest;
-        return {
-            id: `${owner}/${repo}#${pr.number}`,
-            title: pr.title,
-            description: pr.body ?? "",
-            baseSha: pr.base.sha,
-            headSha: pr.head.sha,
-            ...(pr.user ? { author: pr.user.login } : {}),
-        };
+    changeRequest() {
+        const { pullRequest } = this.options;
+        this.pullRequest ??= this.options.snapshot
+            ? Promise.resolve(this.options.snapshot)
+            : this.options.api
+                .getPullRequest(pullRequest.number)
+                .then((pr) => pullRequestOf(pr, pullRequest));
+        return this.pullRequest;
     }
     async comments() {
         const comments = await this.options.api.listIssueComments(this.options.pullRequest.number);
@@ -145,7 +142,7 @@ class GitHubPlatform {
         if (fresh.length === 0 && !requestChanges)
             return [];
         const review = {
-            commit_id: (await this.pr()).head.sha,
+            commit_id: (await this.changeRequest()).headSha,
             event: requestChanges ? "REQUEST_CHANGES" : "COMMENT",
             body: `ocra: ${report.findings.length} finding(s); details in the summary comment.`,
         };
@@ -167,12 +164,17 @@ class GitHubPlatform {
             return [];
         }
     }
-    pr() {
-        this.pullRequest ??= this.options.snapshot
-            ? Promise.resolve(this.options.snapshot)
-            : this.options.api.getPullRequest(this.options.pullRequest.number);
-        return this.pullRequest;
-    }
+}
+// The pull request as ocra's review conversation reads it.
+export function pullRequestOf(pr, { owner, repo }) {
+    return {
+        id: `${owner}/${repo}#${pr.number}`,
+        title: pr.title,
+        description: pr.body ?? "",
+        baseSha: pr.base.sha,
+        headSha: pr.head.sha,
+        ...(pr.user ? { author: pr.user.login } : {}),
+    };
 }
 function reviewComment({ finding, body }) {
     const { start, end } = finding.lineRange;

package/dist/client.d.ts

@@ -73,10 +73,10 @@ export interface ReviewThread {
     }[];
 }
 export declare class GitHubApi {
+    private readonly baseUrl;
+    private readonly api;
     private readonly repository;
     private readonly options;
-    private readonly baseUrl;
-    private readonly fetchImpl;
     constructor(repository: {
         owner: string;
         repo: string;
@@ -96,7 +96,6 @@ export declare class GitHubApi {
     private graphql;
     private graphqlUrl;
     private request;
-    private send;
 }
 export {};
 //# sourceMappingURL=client.d.ts.map

package/dist/client.js

@@ -1,5 +1,7 @@
+import { setTimeout as wait } from "node:timers/promises";
 import { OcraError } from "@open-cr-agent/core";
-import { MAX_ATTEMPTS, retryDecision } from "@open-cr-agent/vcs-platform";
+import { MAX_ATTEMPTS } from "@open-cr-agent/vcs-platform";
+import { pageInfoSchema, sendWithRetry, } from "@open-cr-agent/vcs-platform/internal";
 import { z } from "zod";
 // Commit ids reach git as arguments; anything else is refused at the boundary.
 const sha = z.string().regex(/^[0-9a-f]{40}([0-9a-f]{24})?$/, "not a commit id");
@@ -40,6 +42,8 @@ const MAX_REVIEW_PAGES = 10;
 const MAX_FILE_PAGES = 30;
 const pullRequestFileSchema = z.object({ filename: z.string(), patch: z.string().optional() });
 const MAX_COMMENT_PAGES = 30;
+const REQUEST_TIMEOUT_MS = 30_000;
+const REVIEW_TIMEOUT_MS = 120_000;
 const MAX_THREAD_PAGES = 10;
 const REVIEW_THREADS_QUERY = `query($owner: String!, $repo: String!, $number: Int!, $after: String) {
   repository(owner: $owner, name: $repo) {
@@ -74,7 +78,7 @@ const reviewThreadsSchema = z.object({
     repository: z.object({
         pullRequest: z.object({
             reviewThreads: z.object({
-                pageInfo: z.object({ hasNextPage: z.boolean(), endCursor: z.string().nullable() }),
+                pageInfo: pageInfoSchema,
                 nodes: z.array(z.object({
                     id: z.string(),
                     isResolved: z.boolean(),
@@ -90,15 +94,28 @@ const reviewThreadsSchema = z.object({
 // A thin REST client: every response is validated before it reaches the
 // adapter, and errors never echo the token.
 export class GitHubApi {
+    baseUrl;
+    api;
     repository;
     options;
-    baseUrl;
-    fetchImpl;
     constructor(repository, options) {
         this.repository = repository;
         this.options = options;
         this.baseUrl = (options.baseUrl ?? "https://api.github.com").replace(/\/$/, "");
-        this.fetchImpl = options.fetch ?? fetch;
+        this.api = {
+            platform: "GitHub",
+            headers: {
+                Accept: "application/vnd.github+json",
+                Authorization: `Bearer ${options.token}`,
+                "X-GitHub-Api-Version": "2022-11-28",
+            },
+            fetch: options.fetch ?? fetch,
+            sleep: options.sleep,
+            // Creating a review with many inline comments can take GitHub a while,
+            // and a POST that timed out after GitHub acted cannot be repeated.
+            timeoutMs: (method, path) => method === "POST" && path.endsWith("/reviews") ? REVIEW_TIMEOUT_MS : REQUEST_TIMEOUT_MS,
+            toError: (status, message) => new GitHubApiError(status, message),
+        };
     }
     async listReviewThreads(number) {
         const threads = [];
@@ -213,10 +230,18 @@ export class GitHubApi {
     // GraphQL reports its rate limit as an error in a 200 response, which the
     // HTTP retry does not see; it is retried here the same bounded way.
     async graphql(query, variables) {
-        const sleep = this.options.sleep ?? ((ms) => new Promise((r) => setTimeout(r, ms)));
+        const sleep = this.options.sleep ?? ((ms) => wait(ms));
         let result;
         for (let attempt = 1;; attempt += 1) {
-            result = graphqlResultSchema.parse(await this.send("POST", this.graphqlUrl(), "/graphql", { query, variables }, true));
+            result = graphqlResultSchema.parse(await sendWithRetry(this.api, {
+                method: "POST",
+                url: this.graphqlUrl(),
+                path: "/graphql",
+                body: { query, variables },
+                // GraphQL queries and resolving a thread are safe to repeat,
+                // although they are POSTs.
+                idempotent: true,
+            }));
             const limited = result.errors?.some((e) => e.type === "RATE_LIMITED");
             if (!limited || attempt >= MAX_ATTEMPTS)
                 break;
@@ -237,49 +262,7 @@ export class GitHubApi {
     request(method, path, body) {
         const { owner, repo } = this.repository;
         const url = `${this.baseUrl}/repos/${encodeURIComponent(owner)}/${encodeURIComponent(repo)}${path}`;
-        return this.send(method, url, path, body);
-    }
-    // GraphQL queries and resolving a thread are safe to repeat, although they
-    // are POSTs; REST POSTs create comments and reviews, and are not.
-    async send(method, url, path, body, idempotent = method !== "POST") {
-        const sleep = this.options.sleep ?? ((ms) => new Promise((r) => setTimeout(r, ms)));
-        for (let attempt = 1;; attempt += 1) {
-            const init = {
-                method,
-                headers: {
-                    Accept: "application/vnd.github+json",
-                    Authorization: `Bearer ${this.options.token}`,
-                    "X-GitHub-Api-Version": "2022-11-28",
-                    "User-Agent": "open-cr-agent",
-                    ...(body === undefined ? {} : { "Content-Type": "application/json" }),
-                },
-                // Creating a review with many inline comments can take GitHub a while,
-                // and a POST that timed out after GitHub acted cannot be repeated.
-                signal: AbortSignal.timeout(method === "POST" && path.endsWith("/reviews") ? 120_000 : 30_000),
-            };
-            if (body !== undefined)
-                init.body = JSON.stringify(body);
-            let response;
-            try {
-                response = await this.fetchImpl(url, init);
-            }
-            catch (error) {
-                const next = retryDecision(method, idempotent, "network_error", attempt);
-                if (!next.retry)
-                    throw error;
-                await sleep(next.waitMs);
-                continue;
-            }
-            if (response.ok)
-                return response.status === 204 ? undefined : response.json();
-            const detail = (await response.text().catch(() => "")).slice(0, 500);
-            const next = retryDecision(method, idempotent, { status: response.status, headers: response.headers, body: detail }, attempt);
-            if (next.retry) {
-                await sleep(next.waitMs);
-                continue;
-            }
-            throw new GitHubApiError(response.status, `GitHub ${method} ${path.split("?")[0]} failed with ${response.status}: ${detail}`);
-        }
+        return sendWithRetry(this.api, { method, url, path, body });
     }
 }
 //# sourceMappingURL=client.js.map

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export { GitHubApiError } from "./client.js";
 export { githubPlugin } from "./plugin.js";
+export { type GitHubSettings, resolveGitHubTarget } from "./target.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,3 +1,4 @@
 export { GitHubApiError } from "./client.js";
 export { githubPlugin } from "./plugin.js";
+export { resolveGitHubTarget } from "./target.js";
 //# sourceMappingURL=index.js.map

package/dist/plugin.js

@@ -1,3 +1,4 @@
+import { changeRequestSchema, codeSourceSchema, fetchSchema, historySchema, } from "@open-cr-agent/vcs-platform";
 import { z } from "zod";
 import { DEFAULT_BOT_LOGIN, GitHubAdapter } from "./adapter.js";
 import { GitHubApi } from "./client.js";
@@ -9,18 +10,10 @@ const optionsSchema = z.object({
     apiUrl: z.string().url().optional(),
     botLogin: z.string().min(1).default(DEFAULT_BOT_LOGIN),
     requestChanges: z.boolean().default(false),
-    fetch: z.custom((value) => typeof value === "function").optional(),
-    code: z.custom((value) => typeof value === "object" &&
-        value !== null &&
-        ["getDiff", "readFile", "searchCode"].every((m) => typeof value[m] === "function"), "code must provide getDiff, readFile and searchCode"),
-    snapshot: z
-        .custom((value) => typeof value === "object" && value !== null && "head" in value)
-        .optional(),
-    history: z
-        .custom((value) => typeof value === "object" &&
-        value !== null &&
-        typeof value.filesChangedSince === "function", "history must provide filesChangedSince")
-        .optional(),
+    fetch: fetchSchema.optional(),
+    code: codeSourceSchema,
+    snapshot: changeRequestSchema.optional(),
+    history: historySchema.optional(),
 });
 export const githubPlugin = {
     name: "vcs-github",

package/dist/target.d.ts

@@ -0,0 +1,7 @@
+import type { PlatformTarget, ResolveTargetOptions } from "@open-cr-agent/vcs-platform";
+export interface GitHubSettings {
+    botLogin?: string;
+    requestChanges?: boolean;
+}
+export declare function resolveGitHubTarget(options: ResolveTargetOptions): Promise<PlatformTarget<GitHubSettings>>;
+//# sourceMappingURL=target.d.ts.map

package/dist/target.js

@@ -0,0 +1,53 @@
+import { OcraError } from "@open-cr-agent/core";
+import { DEFAULT_BOT_LOGIN, pullRequestOf } from "./adapter.js";
+import { GitHubApi } from "./client.js";
+// A pull request on GitHub. GITHUB_TOKEN (or GH_TOKEN) is the credential,
+// GITHUB_API_URL the API of GitHub Enterprise Server; the repository is
+// --repo, else GITHUB_REPOSITORY, else origin's.
+export async function resolveGitHubTarget(options) {
+    const { env, ref } = options;
+    const token = env.GITHUB_TOKEN ?? env.GH_TOKEN;
+    if (!token) {
+        throw new OcraError("CONFIG_CREDENTIALS_MISSING", "--pr needs a GitHub token in GITHUB_TOKEN or GH_TOKEN");
+    }
+    const [owner = "", repo = ""] = (ref.repository ?? (await repositoryName(options))).split("/");
+    const apiUrl = env.GITHUB_API_URL;
+    const fetchImpl = options.fetch;
+    const api = new GitHubApi({ owner, repo }, {
+        token,
+        ...(apiUrl ? { baseUrl: apiUrl } : {}),
+        ...(fetchImpl ? { fetch: fetchImpl } : {}),
+    });
+    const pull = await api.getPullRequest(ref.number);
+    return {
+        platform: "github",
+        baseSha: pull.base.sha,
+        headSha: pull.head.sha,
+        headRefs: [`pull/${ref.number}/head`],
+        webUrl: pull.html_url,
+        createVcs: (registry, local, settings) => registry.createVcs("github", {
+            owner,
+            repo,
+            number: ref.number,
+            token,
+            ...(apiUrl ? { apiUrl } : {}),
+            botLogin: settings.botLogin ?? DEFAULT_BOT_LOGIN,
+            requestChanges: settings.requestChanges ?? false,
+            code: local.code,
+            snapshot: pullRequestOf(pull, { owner, repo }),
+            history: local.history,
+            ...(fetchImpl ? { fetch: fetchImpl } : {}),
+        }),
+    };
+}
+async function repositoryName(options) {
+    if (options.env.GITHUB_REPOSITORY)
+        return options.env.GITHUB_REPOSITORY;
+    const url = await options.origin();
+    const match = url && /github\.com[:/]([\w.-]+\/[\w.-]+?)(?:\.git)?$/.exec(url);
+    if (!match?.[1]) {
+        throw new OcraError("CONFIG_INVALID", "Cannot tell which GitHub repository this is; pass --repo owner/name");
+    }
+    return match[1];
+}
+//# sourceMappingURL=target.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-cr-agent/vcs-github",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "GitHub pull request adapter for Open-CR-Agent",
   "keywords": [
     "code-review",
@@ -26,11 +26,6 @@
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
     },
-    "./internal": {
-      "@open-cr-agent/source": "./src/internal.ts",
-      "types": "./dist/internal.d.ts",
-      "default": "./dist/internal.js"
-    },
     "./package.json": "./package.json"
   },
   "files": [
@@ -38,8 +33,8 @@
     "!dist/**/*.map"
   ],
   "dependencies": {
-    "@open-cr-agent/core": "0.4.0",
-    "@open-cr-agent/vcs-platform": "0.4.0",
+    "@open-cr-agent/core": "0.6.0",
+    "@open-cr-agent/vcs-platform": "0.6.0",
     "zod": "^4.6.5"
   },
   "publishConfig": {

package/dist/internal.d.ts

@@ -1,3 +0,0 @@
-export { DEFAULT_BOT_LOGIN } from "./adapter.js";
-export { GitHubApi } from "./client.js";
-//# sourceMappingURL=internal.d.ts.map

package/dist/internal.js

@@ -1,5 +0,0 @@
-// "@open-cr-agent/vcs-github/internal": what the CLI uses beyond the public
-// entry. Not a contract: any release may change it.
-export { DEFAULT_BOT_LOGIN } from "./adapter.js";
-export { GitHubApi } from "./client.js";
-//# sourceMappingURL=internal.js.map