@open-cr-agent/vcs-gitlab 0.5.0 → 0.6.0

package/dist/adapter.d.ts

@@ -1,15 +1,19 @@
 import { type FileDiff } from "@open-cr-agent/core";
-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 GitLabApi, type MergeRequest, type Position } from "./client.js";
 export interface GitLabAdapterOptions {
     iid: number;
     api: GitLabApi;
     code: CodeSource;
     history?: History;
-    snapshot?: MergeRequest;
+    snapshot?: MergeRequestSnapshot;
+}
+export interface MergeRequestSnapshot extends PlatformChangeRequest {
+    mergeBaseSha: string;
 }
 export declare class GitLabAdapter extends PlatformReview {
     constructor(options: GitLabAdapterOptions);
 }
+export declare function mergeRequestOf(mr: MergeRequest): MergeRequestSnapshot;
 export declare function positionOf(file: string, line: number, diffs: readonly FileDiff[], refs: NonNullable<MergeRequest["diff_refs"]>): Position | undefined;
 //# 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 { gitlabSuggestion, PlatformReview, } from "@open-cr-agent/vcs-platform";
 import { DEVELOPER, GitLabApiError, } from "./client.js";
 // A GitLab merge request as ocra's review conversation (vcs-platform).
 export class GitLabAdapter extends PlatformReview {
@@ -18,13 +17,14 @@ export class GitLabAdapter extends PlatformReview {
 // it rather than trust it. Parentheses cannot occur in a GitLab username.
 const UNKNOWN_EDITOR = "(unknown)";
 class GitLabPlatform {
-    options;
     text = { changeRequest: "merge request", authority: "the Developer role or higher" };
+    suggestionFence = gitlabSuggestion;
     mergeRequest;
     user;
     editors;
     // User ids by username, from the notes read, for membership lookups.
     ids = new Map();
+    options;
     constructor(options) {
         this.options = options;
     }
@@ -35,16 +35,8 @@ class GitLabPlatform {
         return { login: username, is: (other) => other === username };
     }
     async changeRequest() {
-        const mr = await this.mr();
-        const refs = diffRefs(mr);
-        return {
-            id: `${projectPath(mr.web_url)}!${mr.iid}`,
-            title: mr.title,
-            description: mr.description ?? "",
-            baseSha: refs.start_sha,
-            headSha: refs.head_sha,
-            ...(mr.author ? { author: mr.author.username } : {}),
-        };
+        const { mergeBaseSha: _, ...changeRequest } = await this.mr();
+        return changeRequest;
     }
     // Comments on the merge request as a whole: plain notes and the notes of
     // threads started on it, not notes on lines or system notes.
@@ -110,7 +102,8 @@ class GitLabPlatform {
     async publishFindings(_report, fresh) {
         if (fresh.length === 0)
             return { posted: [], warnings: [] };
-        const refs = diffRefs(await this.mr());
+        const mr = await this.mr();
+        const refs = { base_sha: mr.mergeBaseSha, start_sha: mr.baseSha, head_sha: mr.headSha };
         const diffs = await this.options.code.getDiff();
         const posted = [];
         const warnings = [];
@@ -151,15 +144,24 @@ class GitLabPlatform {
     mr() {
         this.mergeRequest ??= this.options.snapshot
             ? Promise.resolve(this.options.snapshot)
-            : this.options.api.getMergeRequest(this.options.iid);
+            : this.options.api.getMergeRequest(this.options.iid).then(mergeRequestOf);
         return this.mergeRequest;
     }
 }
-function diffRefs(mr) {
-    if (!mr.diff_refs) {
+export function mergeRequestOf(mr) {
+    const refs = mr.diff_refs;
+    if (!refs) {
         throw new OcraError("VCS_NOT_READY", `merge request !${mr.iid} has no diff yet; try again shortly`);
     }
-    return mr.diff_refs;
+    return {
+        id: `${projectPath(mr.web_url)}!${mr.iid}`,
+        title: mr.title,
+        description: mr.description ?? "",
+        baseSha: refs.start_sha,
+        headSha: refs.head_sha,
+        mergeBaseSha: refs.base_sha,
+        ...(mr.author ? { author: mr.author.username } : {}),
+    };
 }
 // "https://gitlab.example.com/group/sub/project/-/merge_requests/7" names
 // the project "group/sub/project".

package/dist/client.d.ts

@@ -78,10 +78,9 @@ export interface GitLabApiOptions {
 }
 export declare const DEVELOPER = 30;
 export declare class GitLabApi {
-    private readonly project;
-    private readonly options;
     private readonly baseUrl;
-    private readonly fetchImpl;
+    private readonly api;
+    private readonly project;
     constructor(project: string | number, options: GitLabApiOptions);
     currentUser(): Promise<{
         id: number;
@@ -102,7 +101,6 @@ export declare class GitLabApi {
     private pages;
     private graphql;
     private request;
-    private send;
 }
 export {};
 //# sourceMappingURL=client.d.ts.map

package/dist/client.js

@@ -1,5 +1,5 @@
 import { OcraError } from "@open-cr-agent/core";
-import { retryDecision } 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");
@@ -43,6 +43,7 @@ const PER_PAGE = 100;
 const MAX_NOTE_PAGES = 30;
 const MAX_DISCUSSION_PAGES = 10;
 const MAX_EDITOR_PAGES = 30;
+const REQUEST_TIMEOUT_MS = 30_000;
 // Developer: may push to unprotected branches, the nearest to GitHub's write.
 export const DEVELOPER = 30;
 const EDITORS_QUERY = `query($path: ID!, $iid: String!, $after: String) {
@@ -59,7 +60,7 @@ const editorsSchema = z.object({
     project: z.object({
         mergeRequest: z.object({
             notes: z.object({
-                pageInfo: z.object({ hasNextPage: z.boolean(), endCursor: z.string().nullable() }),
+                pageInfo: pageInfoSchema,
                 nodes: z.array(z.object({
                     id: z.string(),
                     lastEditedBy: z.object({ username: z.string() }).nullable().optional(),
@@ -71,19 +72,24 @@ const editorsSchema = z.object({
 // A thin REST and GraphQL client for one project: every response is
 // validated before it reaches the adapter, and errors never echo the token.
 export class GitLabApi {
-    project;
-    options;
     baseUrl;
-    fetchImpl;
+    api;
     // `project` is the numeric id or the full path ("group/project").
+    project;
     constructor(project, options) {
         this.project = project;
-        this.options = options;
         this.baseUrl = (options.baseUrl ?? "https://gitlab.com/api/v4").replace(/\/+$/, "");
-        this.fetchImpl = options.fetch ?? fetch;
+        this.api = {
+            platform: "GitLab",
+            headers: { Accept: "application/json", Authorization: `Bearer ${options.token}` },
+            fetch: options.fetch ?? fetch,
+            sleep: options.sleep,
+            timeoutMs: () => REQUEST_TIMEOUT_MS,
+            toError: (status, message) => new GitLabApiError(status, message),
+        };
     }
     async currentUser() {
-        return user.parse(await this.send("GET", `${this.baseUrl}/user`, "/user"));
+        return user.parse(await sendWithRetry(this.api, { method: "GET", url: `${this.baseUrl}/user`, path: "/user" }));
     }
     // The project's full path, which GraphQL takes instead of the id.
     async fullPath() {
@@ -135,9 +141,11 @@ export class GitLabApi {
         }
     }
     async findUser(username) {
-        const found = z
-            .array(user)
-            .parse(await this.send("GET", `${this.baseUrl}/users?username=${encodeURIComponent(username)}`, "/users"));
+        const found = z.array(user).parse(await sendWithRetry(this.api, {
+            method: "GET",
+            url: `${this.baseUrl}/users?username=${encodeURIComponent(username)}`,
+            path: "/users",
+        }));
         return found.find((u) => u.username === username)?.id;
     }
     // Who last edited each note of the merge request, by note id; REST does
@@ -182,7 +190,14 @@ export class GitLabApi {
             data: z.unknown().optional(),
             errors: z.array(z.object({ message: z.string() })).optional(),
         })
-            .parse(await this.send("POST", url, "/graphql", { query, variables }, true));
+            .parse(await sendWithRetry(this.api, {
+            method: "POST",
+            url,
+            path: "/graphql",
+            body: { query, variables },
+            // GraphQL queries are safe to repeat, although they are POSTs.
+            idempotent: true,
+        }));
         if (result.errors?.length) {
             throw new GitLabApiError(200, `GitLab GraphQL failed: ${result.errors.map((e) => e.message).join("; ")}`);
         }
@@ -190,46 +205,8 @@ export class GitLabApi {
     }
     request(method, path, body) {
         const project = encodeURIComponent(String(this.project));
-        return this.send(method, `${this.baseUrl}/projects/${project}${path}`, path, body);
-    }
-    // GraphQL queries are safe to repeat, although they are POSTs; REST POSTs
-    // create notes and threads, 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/json",
-                    Authorization: `Bearer ${this.options.token}`,
-                    "User-Agent": "open-cr-agent",
-                    ...(body === undefined ? {} : { "Content-Type": "application/json" }),
-                },
-                signal: AbortSignal.timeout(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 GitLabApiError(response.status, `GitLab ${method} ${path.split("?")[0]} failed with ${response.status}: ${detail}`);
-        }
+        const url = `${this.baseUrl}/projects/${project}${path}`;
+        return sendWithRetry(this.api, { method, url, path, body });
     }
 }
 //# sourceMappingURL=client.js.map

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export { GitLabApiError } from "./client.js";
 export { gitlabPlugin } from "./plugin.js";
+export { type GitLabSettings, resolveGitLabTarget } from "./target.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

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

package/dist/plugin.js

@@ -1,3 +1,4 @@
+import { changeRequestSchema, codeSourceSchema, commitIdSchema, fetchSchema, historySchema, } from "@open-cr-agent/vcs-platform";
 import { z } from "zod";
 import { GitLabAdapter } from "./adapter.js";
 import { GitLabApi } from "./client.js";
@@ -7,18 +8,10 @@ const optionsSchema = z.object({
     iid: z.number().int().positive(),
     token: z.string().min(1),
     apiUrl: z.string().url().optional(),
-    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 && "diff_refs" 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.extend({ mergeBaseSha: commitIdSchema }).optional(),
+    history: historySchema.optional(),
 });
 export const gitlabPlugin = {
     name: "vcs-gitlab",

package/dist/target.d.ts

@@ -0,0 +1,4 @@
+import type { PlatformTarget, ResolveTargetOptions } from "@open-cr-agent/vcs-platform";
+export type GitLabSettings = Record<string, never>;
+export declare function resolveGitLabTarget(options: ResolveTargetOptions): Promise<PlatformTarget<GitLabSettings>>;
+//# sourceMappingURL=target.d.ts.map

package/dist/target.js

@@ -0,0 +1,90 @@
+import { OcraError } from "@open-cr-agent/core";
+import { mergeRequestOf } from "./adapter.js";
+import { GitLabApi } from "./client.js";
+const GITLAB_API = "https://gitlab.com/api/v4";
+// A merge request on GitLab. GitLab CI sets CI_API_V4_URL and
+// CI_PROJECT_ID; GITLAB_TOKEN must be a token that may write notes, which
+// CI_JOB_TOKEN may not. The project is --project, else CI_PROJECT_ID, else
+// origin's.
+export async function resolveGitLabTarget(options) {
+    const { env, ref } = options;
+    const token = env.GITLAB_TOKEN;
+    if (!token) {
+        throw new OcraError("CONFIG_CREDENTIALS_MISSING", "--mr needs a GitLab token in GITLAB_TOKEN with the api scope and the Developer role: a project access token, or on GitLab.com Free a personal access token of a dedicated account (CI_JOB_TOKEN cannot post comments)");
+    }
+    const origin = await options.origin();
+    const project = ref.repository ?? env.CI_PROJECT_ID ?? gitlabProject(origin);
+    const apiUrl = gitlabApi(env.CI_API_V4_URL, remoteHost(origin), options.warn);
+    const fetchImpl = options.fetch;
+    const api = new GitLabApi(project, {
+        token,
+        baseUrl: apiUrl,
+        ...(fetchImpl ? { fetch: fetchImpl } : {}),
+    });
+    const iid = ref.number;
+    const merge = await api.getMergeRequest(iid);
+    const snapshot = mergeRequestOf(merge);
+    return {
+        platform: "gitlab",
+        baseSha: snapshot.baseSha,
+        headSha: snapshot.headSha,
+        headRefs: [`refs/merge-requests/${iid}/head`],
+        webUrl: merge.web_url,
+        createVcs: (registry, local) => registry.createVcs("gitlab", {
+            project: /^\d+$/.test(project) ? Number(project) : project,
+            iid,
+            token,
+            apiUrl,
+            code: local.code,
+            snapshot,
+            history: local.history,
+            ...(fetchImpl ? { fetch: fetchImpl } : {}),
+        }),
+    };
+}
+// Where GITLAB_TOKEN goes: to CI_API_V4_URL, which GitLab CI sets, or else
+// to gitlab.com, but only when origin is there too or is no remote host. A
+// token for a self-managed instance must not travel to gitlab.com because
+// the address was left out.
+function gitlabApi(configured, origin, warn) {
+    if (configured) {
+        const api = remoteHost(configured);
+        if (api && origin && site(api) !== site(origin)) {
+            warn(`CI_API_V4_URL is on ${api} but origin is on ${origin}; GITLAB_TOKEN goes to ${api}`);
+        }
+        return configured;
+    }
+    if (origin && site(origin) !== "gitlab.com") {
+        throw new OcraError("CONFIG_INVALID", `origin is on ${origin}, not gitlab.com: set CI_API_V4_URL to its API, such as https://${origin}/api/v4, so that GITLAB_TOKEN goes only there`);
+    }
+    return GITLAB_API;
+}
+// GitLab.com answers on subdomains too, such as altssh.gitlab.com for SSH.
+function site(host) {
+    return host === "gitlab.com" || host.endsWith(".gitlab.com") ? "gitlab.com" : host;
+}
+// The host of https://host/…, ssh://user@host:port/… or user@host:path; none
+// for a local path, including C:\ on Windows.
+function remoteHost(url) {
+    if (!url)
+        return undefined;
+    if (/^[\w+.-]+:\/\//.test(url)) {
+        try {
+            const parsed = new URL(url);
+            return parsed.protocol === "file:" ? undefined : parsed.hostname.toLowerCase() || undefined;
+        }
+        catch {
+            return undefined;
+        }
+    }
+    return /^(?:[^@\s/]+@)?([^:/\s\\]+):(?![\\/])/.exec(url)?.[1]?.toLowerCase();
+}
+// The project behind the origin remote: any host, since GitLab runs on many.
+function gitlabProject(url) {
+    const match = url && /^(?:[\w+.-]+:\/\/[^/]+\/|[^@\s]+@[^:]+:)(.+?)(?:\.git)?\/?$/.exec(url);
+    if (!match?.[1]) {
+        throw new OcraError("CONFIG_INVALID", "Cannot tell which GitLab project this is; pass --project <id|path>");
+    }
+    return match[1];
+}
+//# sourceMappingURL=target.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-cr-agent/vcs-gitlab",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "GitLab merge 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.5.0",
-    "@open-cr-agent/vcs-platform": "0.5.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,2 +0,0 @@
-export { GitLabApi } from "./client.js";
-//# sourceMappingURL=internal.d.ts.map

package/dist/internal.js

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