@remogram/provider-gitlab-api 0.1.0-beta.4 → 0.1.0-beta.5

package/index.js

@@ -37,6 +37,20 @@ import {
   buildOpenPullListMeta,
   gitlabOpenPullSortQuery,
   appendSortQuery,
+  buildProviderIdentityFromGitLabUser,
+  buildBranchProtectionFromGitLabProtection,
+  buildCrFilesFromGitLabChanges,
+  buildCrCommentsBody,
+  buildCrCommentsFromGitLabDiscussions,
+  parseSinceObservedAt,
+  buildForgeChangesFromGiteaPulls,
+  buildChecksConclusionObservedEvent,
+  appendForgeChangeEvents,
+  parseStatusSetArgs,
+  buildCommitStatusSetBody,
+  normalizeStatusSetState,
+  MAX_OPEN_PULL_IDEMPOTENCY_PAGES,
+  statusSetIdempotencyScanCapabilityFacts,
 } from '@remogram/core';
 
 const PUBLIC_GITLAB_HOST = 'gitlab.com';
@@ -50,8 +64,16 @@ const AUTH_CAPABILITIES = [
   'pr_checks',
   'merge_plan',
   'sync_plan',
+  'status_set',
+  'whoami',
 ];
-const STRUCTURED_COMMANDS = apiProviderCommands();
+const STRUCTURED_COMMANDS = apiProviderCommands({
+  branchProtectionImplemented: true,
+  crFilesImplemented: true,
+  crCommentsImplemented: true,
+  forgeChangesImplemented: true,
+  statusSetImplemented: true,
+});
 
 export function gitlabToken() {
   return process.env.GITLAB_TOKEN || null;
@@ -180,8 +202,10 @@ export function providerCapabilities() {
     mergeability_confidence: 'derived',
     host_binding: 'verified_remote_host',
     pagination: 'supported',
-    write_support: false,
+    write_support: true,
+    write_commands: ['status_set'],
     ...forgeIngestCapabilityFacts(),
+    ...statusSetIdempotencyScanCapabilityFacts(),
     ...checkPaginationCapabilityFacts({
       strategy: 'offset_limit',
       pageSizeParam: 'per_page',
@@ -343,7 +367,171 @@ export async function prChecks(ctx, opts) {
 export async function mergePlan(ctx, opts) {
   const view = await prView(ctx, opts);
   const checks = await prChecks(ctx, { number: view.pr_number });
-  return buildMergePlanBodyFromFacts(ctx, view, checks, opts);
+  let mergeOpts = opts;
+  if (opts.allowed_paths) {
+    try {
+      const crFilesBody = await crFiles(ctx, { number: view.pr_number });
+      mergeOpts = { ...opts, changed_paths: crFilesBody.changed_paths };
+    } catch {
+      // Fall back to local git diff in resolveMergePlanPathScope.
+    }
+  }
+  return buildMergePlanBodyFromFacts(ctx, view, checks, mergeOpts);
+}
+
+export async function crFiles(ctx, { number }) {
+  requireToken();
+  if (number == null) {
+    throw Object.assign(new Error('--number required'), {
+      forgeError: forgeError(ERROR_CODES.INVALID_ARGS, 'Provide --number for MR changed paths'),
+    });
+  }
+  const data = await gitlabFetch(
+    ctx.config,
+    ctx.parsed,
+    projectApiPath(ctx.config, 'merge_requests', number, 'changes'),
+  );
+  return buildCrFilesFromGitLabChanges(number, data?.changes);
+}
+
+export async function crComments(ctx, { number }) {
+  requireToken();
+  if (number == null) {
+    throw Object.assign(new Error('--number required'), {
+      forgeError: forgeError(ERROR_CODES.INVALID_ARGS, 'Provide --number for MR review comments'),
+    });
+  }
+  const path = projectApiPath(ctx.config, 'merge_requests', number, 'discussions');
+  const pageSep = path.includes('?') ? '&' : '?';
+  let activeLimit = DEFAULT_CHECK_STATUS_PAGE_SIZE;
+  const allDiscussions = [];
+  let listTruncated = false;
+  let entryCount = 0;
+
+  for (let page = 1; page <= MAX_CHECK_STATUS_PAGES; page += 1) {
+    const { items, usedLimit } = await fetchPageWithIngestBackoff(
+      async ({ page: pageNum, limit }) => {
+        const body = await gitlabFetch(
+          ctx.config,
+          ctx.parsed,
+          `${path}${pageSep}per_page=${limit}&page=${pageNum}`,
+        );
+        if (!Array.isArray(body)) {
+          throw Object.assign(new Error('Provider returned non-array MR discussions list'), {
+            forgeError: forgeError(
+              ERROR_CODES.UNPARSEABLE_PROVIDER_OUTPUT,
+              'Provider returned non-array MR discussions list',
+            ),
+          });
+        }
+        return body;
+      },
+      page,
+      activeLimit,
+    );
+    activeLimit = usedLimit;
+    for (const discussion of items) {
+      const notes = Array.isArray(discussion?.notes) ? discussion.notes : [];
+      for (const note of notes) {
+        if (note?.system === true) continue;
+        entryCount += 1;
+      }
+    }
+    allDiscussions.push(...items);
+    if (items.length < usedLimit) break;
+    if (page === MAX_CHECK_STATUS_PAGES) {
+      listTruncated = true;
+    }
+  }
+
+  const body = buildCrCommentsFromGitLabDiscussions(number, allDiscussions);
+  if (listTruncated) {
+    return buildCrCommentsBody({
+      pr_number: body.pr_number,
+      comments: body.comments,
+      comments_truncated: true,
+      comment_count: entryCount,
+    });
+  }
+  return body;
+}
+
+function gitlabMergeRequestAsPull(mr) {
+  if (mr == null || mr.iid == null) return null;
+  let state = 'unknown';
+  if (mr.state === 'opened') state = 'open';
+  else if (mr.state === 'merged' || mr.state === 'closed') state = 'closed';
+  return {
+    number: mr.iid,
+    title: mr.title,
+    html_url: mr.web_url,
+    state,
+    created_at: mr.created_at,
+    updated_at: mr.updated_at,
+    closed_at: mr.closed_at,
+    merged_at: mr.merged_at,
+    head: { sha: mr.sha ?? mr.diff_refs?.head_sha ?? null },
+  };
+}
+
+export async function forgeChanges(ctx, { since }) {
+  requireToken();
+  const sinceIso = parseSinceObservedAt(since);
+  const path = `${projectApiPath(ctx.config, 'merge_requests')}?state=all&order_by=updated_at&sort=desc`;
+  const pageSep = '&';
+  let activeLimit = DEFAULT_CHECK_STATUS_PAGE_SIZE;
+  const allMrs = [];
+  let listTruncated = false;
+
+  for (let page = 1; page <= MAX_CHECK_STATUS_PAGES; page += 1) {
+    const { items, usedLimit } = await fetchPageWithIngestBackoff(
+      async ({ page: pageNum, limit }) => {
+        const body = await gitlabFetch(
+          ctx.config,
+          ctx.parsed,
+          `${path}${pageSep}per_page=${limit}&page=${pageNum}`,
+        );
+        if (!Array.isArray(body)) {
+          throw Object.assign(new Error('Provider returned non-array merge request list'), {
+            forgeError: forgeError(
+              ERROR_CODES.UNPARSEABLE_PROVIDER_OUTPUT,
+              'Provider returned non-array merge request list',
+            ),
+          });
+        }
+        return body;
+      },
+      page,
+      activeLimit,
+    );
+    activeLimit = usedLimit;
+    allMrs.push(...items);
+    if (items.length < usedLimit) break;
+    if (page === MAX_CHECK_STATUS_PAGES) {
+      listTruncated = true;
+    }
+  }
+
+  const pulls = allMrs.map(gitlabMergeRequestAsPull).filter(Boolean);
+  let body = buildForgeChangesFromGiteaPulls(sinceIso, pulls, { listTruncated });
+  const checkNumbers = new Set();
+  for (const event of body.events) {
+    if (event.kind === 'pr_opened' || event.kind === 'head_sha_moved') {
+      checkNumbers.add(event.pr_number);
+    }
+  }
+
+  const checkEvents = [];
+  for (const number of checkNumbers) {
+    const checks = await prChecks(ctx, { number });
+    checkEvents.push(buildChecksConclusionObservedEvent(number, checks));
+  }
+
+  if (checkEvents.length > 0) {
+    body = appendForgeChangeEvents(body, checkEvents, { listTruncated });
+  }
+
+  return body;
 }
 
 const GITLAB_OPEN_PULL_COMPLIANT_MAX =
@@ -533,6 +721,190 @@ export async function syncPlan(ctx, remoteName = 'origin') {
   };
 }
 
+async function fetchGitLabPatSelf(ctx) {
+  try {
+    return await gitlabFetch(ctx.config, ctx.parsed, '/personal_access_tokens/self');
+  } catch {
+    return null;
+  }
+}
+
+export async function whoami(ctx) {
+  requireToken();
+  const user = await gitlabFetch(ctx.config, ctx.parsed, '/user');
+  const patSelf = await fetchGitLabPatSelf(ctx);
+  return buildProviderIdentityFromGitLabUser(user, patSelf);
+}
+
+function approvalRulesForBranch(rules, branchRef) {
+  if (!Array.isArray(rules)) return [];
+  return rules.filter((rule) => {
+    const branches = rule?.protected_branches;
+    if (!Array.isArray(branches)) return false;
+    return branches.some((branch) => branch?.name === branchRef);
+  });
+}
+
+export async function branchProtection(ctx, { branchRef }) {
+  assertGitRef(branchRef, '--branch-ref');
+  requireToken();
+  let protectedBranch = null;
+  try {
+    protectedBranch = await gitlabFetch(
+      ctx.config,
+      ctx.parsed,
+      projectApiPath(ctx.config, 'protected_branches', branchRef),
+    );
+  } catch (err) {
+    if (err?.status !== 404) throw err;
+  }
+  let approvalRules = [];
+  if (protectedBranch != null) {
+    try {
+      const allRules = await gitlabFetch(
+        ctx.config,
+        ctx.parsed,
+        projectApiPath(ctx.config, 'approval_rules'),
+      );
+      approvalRules = approvalRulesForBranch(allRules, branchRef);
+    } catch {
+      approvalRules = [];
+    }
+  }
+  return buildBranchProtectionFromGitLabProtection(branchRef, { protectedBranch, approvalRules });
+}
+
+function gitlabStatusRecordOrder(a, b) {
+  const aUpdated = Date.parse(a.updated_at ?? a.created_at ?? '') || 0;
+  const bUpdated = Date.parse(b.updated_at ?? b.created_at ?? '') || 0;
+  if (aUpdated !== bUpdated) return aUpdated - bUpdated;
+  const aId = Number(a.id) || 0;
+  const bId = Number(b.id) || 0;
+  return aId - bId;
+}
+
+function gitlabStatusAsRemogramState(status) {
+  const normalized = String(status ?? '').toLowerCase();
+  if (normalized === 'failed' || normalized === 'canceled') return 'failure';
+  if (
+    normalized === 'running'
+    || normalized === 'created'
+    || normalized === 'waiting_for_resource'
+    || normalized === 'preparing'
+  ) {
+    return 'pending';
+  }
+  return normalizeStatusSetState(normalized);
+}
+
+function remogramStateToGitlabPostState(state) {
+  if (state === 'failure' || state === 'error') return 'failed';
+  return state;
+}
+
+function statusSetIdempotencyScanIncompleteError(pagesScanned, pageSizeUsed) {
+  return forgeError(
+    ERROR_CODES.IDEMPOTENCY_SCAN_INCOMPLETE,
+    'Cannot prove no commit status exists for sha+context within scan limit; retry or set manually',
+    null,
+    {
+      idempotency_scan: {
+        pages: pagesScanned,
+        max_pages: MAX_OPEN_PULL_IDEMPOTENCY_PAGES,
+        page_size: pageSizeUsed,
+      },
+    },
+  );
+}
+
+/** Paginated commit-status scan for idempotent status set; fail-closed when scan cap prevents proof of absence. */
+export async function findCommitStatusByContext(ctx, sha, context) {
+  requireToken();
+  const path = projectApiPath(ctx.config, 'repository', 'commits', sha, 'statuses');
+  const pageSep = path.includes('?') ? '&' : '?';
+  let activeLimit = DEFAULT_CHECK_STATUS_PAGE_SIZE;
+  let bestMatch = null;
+
+  for (let page = 1; page <= MAX_OPEN_PULL_IDEMPOTENCY_PAGES; page += 1) {
+    const { items, usedLimit } = await fetchPageWithIngestBackoff(
+      async ({ page: pageNum, limit }) => {
+        const body = await gitlabFetch(
+          ctx.config,
+          ctx.parsed,
+          `${path}${pageSep}per_page=${limit}&page=${pageNum}`,
+        );
+        if (!Array.isArray(body)) {
+          throw Object.assign(new Error('Provider returned non-array commit status list'), {
+            forgeError: forgeError(
+              ERROR_CODES.UNPARSEABLE_PROVIDER_OUTPUT,
+              'Provider returned non-array commit status list',
+            ),
+          });
+        }
+        return body;
+      },
+      page,
+      activeLimit,
+    );
+    activeLimit = usedLimit;
+
+    for (const record of items) {
+      if (record?.name !== context) continue;
+      if (!bestMatch || gitlabStatusRecordOrder(record, bestMatch) > 0) {
+        bestMatch = record;
+      }
+    }
+
+    if (items.length < usedLimit) return bestMatch;
+    if (page === MAX_OPEN_PULL_IDEMPOTENCY_PAGES) {
+      throw Object.assign(new Error('Commit status idempotency scan incomplete'), {
+        forgeError: statusSetIdempotencyScanIncompleteError(page, usedLimit),
+      });
+    }
+  }
+  return bestMatch;
+}
+
+export async function statusSet(ctx, args) {
+  const parsed = parseStatusSetArgs(args);
+  const existing = await findCommitStatusByContext(ctx, parsed.sha, parsed.context);
+  if (existing) {
+    const requestedGitlabState = remogramStateToGitlabPostState(parsed.state);
+    const existingGitlabState = String(existing.status ?? existing.state ?? '').toLowerCase();
+    if (existingGitlabState === requestedGitlabState) {
+      const remogramState = gitlabStatusAsRemogramState(existing.status ?? existing.state);
+      return buildCommitStatusSetBody(
+        { ...existing, status: remogramState },
+        parsed,
+        { reusedExisting: true },
+      );
+    }
+  }
+  const payload = {
+    state: remogramStateToGitlabPostState(parsed.state),
+    name: parsed.context,
+  };
+  if (parsed.description != null) payload.description = parsed.description;
+  if (parsed.target_url != null) payload.target_url = parsed.target_url;
+  const response = await gitlabFetch(
+    ctx.config,
+    ctx.parsed,
+    projectApiPath(ctx.config, 'statuses', parsed.sha),
+    {
+      method: 'POST',
+      headers: { 'Content-Type': 'application/json' },
+      body: JSON.stringify(payload),
+    },
+  );
+  return buildCommitStatusSetBody(
+    {
+      ...response,
+      status: gitlabStatusAsRemogramState(response?.status ?? response?.state ?? parsed.state),
+    },
+    parsed,
+  );
+}
+
 export const provider = {
   id: 'gitlab-api',
   providerCapabilities,
@@ -545,4 +917,10 @@ export const provider = {
   prChecks,
   mergePlan,
   syncPlan,
+  whoami,
+  branchProtection,
+  crFiles,
+  crComments,
+  forgeChanges,
+  statusSet,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remogram/provider-gitlab-api",
-  "version": "0.1.0-beta.4",
+  "version": "0.1.0-beta.5",
   "description": "GitLab API provider for remogram",
   "type": "module",
   "license": "MIT",
@@ -22,6 +22,6 @@
     "node": ">=20"
   },
   "dependencies": {
-    "@remogram/core": "0.1.0-beta.4"
+    "@remogram/core": "0.1.0-beta.5"
   }
 }