@remogram/provider-gitlab-api 0.1.0-beta.6 → 0.1.0-beta.9

package/branch-protection-internal.js

@@ -0,0 +1,13 @@
+/** @type {((ctx: object, opts: { branchRef: string }) => Promise<object>) | null} */
+let branchProtectionImpl = null;
+
+export function setBranchProtectionImpl(fn) {
+  branchProtectionImpl = fn;
+}
+
+export async function resolveBranchProtection(ctx, opts) {
+  if (typeof branchProtectionImpl !== 'function') {
+    throw new Error('branch protection impl not registered');
+  }
+  return branchProtectionImpl(ctx, opts);
+}

package/index.js

@@ -13,6 +13,7 @@ import {
   buildMergePlanFromProviderFacts,
   ERROR_CODES,
   forgeError,
+  LIVE_REACHABILITY_TIMEOUT_MS,
   forgeIngestCapabilityFacts,
   checkPaginationCapabilityFacts,
   openPullListCapabilityFacts,
@@ -39,6 +40,7 @@ import {
   appendSortQuery,
   buildProviderIdentityFromGitLabUser,
   buildBranchProtectionFromGitLabProtection,
+  buildPrChecksBody,
   buildCrFilesFromGitLabChanges,
   buildCrCommentsBody,
   buildCrCommentsFromGitLabDiscussions,
@@ -48,11 +50,16 @@ import {
   appendForgeChangeEvents,
   parseStatusSetArgs,
   buildCommitStatusSetBody,
+  idempotencyPacketFields,
   normalizeStatusSetState,
   MAX_OPEN_PULL_IDEMPOTENCY_PAGES,
   statusSetIdempotencyScanCapabilityFacts,
   assertWriteCommandConfigured,
 } from '@remogram/core';
+import {
+  resolveBranchProtection,
+  setBranchProtectionImpl,
+} from './branch-protection-internal.js';
 
 const PUBLIC_GITLAB_HOST = 'gitlab.com';
 const PUBLIC_GITLAB_API = 'https://gitlab.com/api/v4';
@@ -177,6 +184,22 @@ export async function gitlabFetchWithMeta(config, parsed, path, options = {}) {
   });
 }
 
+export async function apiReachability(ctx) {
+  if (!gitlabToken()) {
+    throw Object.assign(new Error('GITLAB_TOKEN not set'), {
+      forgeError: forgeError(ERROR_CODES.UNAUTHENTICATED_PROVIDER, 'GITLAB_TOKEN not set'),
+    });
+  }
+  const token = requireToken();
+  const url = `${apiBase(ctx.config, ctx.parsed)}${projectApiPath(ctx.config)}`;
+  await fetchJson(
+    url,
+    { headers: authHeaders(token) },
+    LIVE_REACHABILITY_TIMEOUT_MS,
+  );
+  return { repo_accessible: true };
+}
+
 const MAX_CHECK_PAGES = MAX_CHECK_STATUS_PAGES;
 const GITLAB_PAGE_SIZE = 100;
 
@@ -246,10 +269,10 @@ export async function refsCompare(ctx, baseRef, headRef) {
     });
   }
   return {
-    base_ref: sanitizeField(baseRef),
-    base_sha: baseSha,
-    head_ref: sanitizeField(headRef),
-    head_sha: headSha,
+    compare_base_ref: sanitizeField(baseRef),
+    compare_base_sha: baseSha,
+    compare_head_ref: sanitizeField(headRef),
+    compare_head_sha: headSha,
     ...gitAheadBehind(ctx.cwd, baseSha, headSha),
   };
 }
@@ -286,10 +309,10 @@ export async function prView(ctx, opts) {
     url: sanitizeUrl(mr.web_url ?? mr.url),
     title: sanitizeField(mr.title),
     state: normalizeMrState(mr.state),
-    base_ref: sanitizeField(mr.target_branch),
-    base_sha: sanitizeField(mr.diff_refs?.base_sha),
-    head_ref: sanitizeField(mr.source_branch),
-    head_sha: sanitizeField(mr.sha ?? mr.diff_refs?.head_sha),
+    forge_target_branch_ref: sanitizeField(mr.target_branch),
+    forge_target_sha: sanitizeField(mr.diff_refs?.base_sha),
+    forge_source_branch_ref: sanitizeField(mr.source_branch),
+    forge_source_sha: sanitizeField(mr.sha ?? mr.diff_refs?.head_sha),
     mergeability: mergeability(mr),
   };
 }
@@ -313,6 +336,7 @@ export async function prChecks(ctx, opts) {
   apiBase(ctx.config, ctx.parsed);
   requireToken();
   let sha;
+  let requiredContexts = [];
   if (opts.ref) {
     assertGitRef(opts.ref, 'ref');
     sha = gitRevParse(ctx.cwd, opts.ref);
@@ -324,6 +348,11 @@ export async function prChecks(ctx, opts) {
   } else {
     const mr = await getMergeRequest(ctx, opts);
     sha = mr.sha ?? mr.diff_refs?.head_sha;
+    const targetBranch = mr.target_branch;
+    if (targetBranch) {
+      const protection = await resolveBranchProtection(ctx, { branchRef: targetBranch });
+      requiredContexts = protection.required_status_contexts ?? [];
+    }
   }
   if (!sha) {
     throw Object.assign(new Error('No SHA'), {
@@ -349,20 +378,26 @@ export async function prChecks(ctx, opts) {
     context: sanitizeField(status.name || status.context),
     state: normalizeStatusState(status.status),
     description: sanitizeField(status.description || status.status),
+    ...(status.target_url ? { target_url: sanitizeField(status.target_url) } : {}),
+    sha,
+    source: 'commit_status',
   }));
   const mappedPipelines = pipelineRecords.map((pipeline) => ({
     context: sanitizeField(pipeline.name || `pipeline:${pipeline.id}`),
     state: normalizeStatusState(pipeline.status),
     description: sanitizeField(pipeline.status),
+    sha,
+    source: 'pipeline',
   }));
   const mapped = [...mappedStatuses, ...mappedPipelines];
   const checks_truncated = statusResult.truncated || pipelineResult.truncated;
-  return {
-    head_sha: sha,
+  return buildPrChecksBody({
+    forge_source_sha: sha,
     check_conclusion: summarizeChecks(mapped),
     checks_truncated,
     statuses: mapped,
-  };
+    required_contexts: requiredContexts,
+  });
 }
 
 export async function mergePlan(ctx, opts) {
@@ -857,7 +892,8 @@ export async function findCommitStatusByContext(ctx, sha, context) {
 
 export async function statusSet(ctx, args) {
   assertWriteCommandConfigured(ctx.config, 'status_set');
-  const parsed = parseStatusSetArgs(args);
+  const { idempotencyFingerprint = null, ...rest } = args;
+  const parsed = parseStatusSetArgs(rest);
   const existing = await findCommitStatusByContext(ctx, parsed.sha, parsed.context);
   if (existing) {
     const requestedGitlabState = remogramStateToGitlabPostState(parsed.state);
@@ -867,7 +903,12 @@ export async function statusSet(ctx, args) {
       return buildCommitStatusSetBody(
         { ...existing, status: remogramState },
         parsed,
-        { reusedExisting: true },
+        {
+          reusedExisting: true,
+          idempotencyFields: idempotencyFingerprint
+            ? idempotencyPacketFields(idempotencyFingerprint, { reusedExisting: true })
+            : null,
+        },
       );
     }
   }
@@ -893,12 +934,18 @@ export async function statusSet(ctx, args) {
       status: gitlabStatusAsRemogramState(response?.status ?? response?.state ?? parsed.state),
     },
     parsed,
+    {
+      idempotencyFields: idempotencyFingerprint
+        ? idempotencyPacketFields(idempotencyFingerprint, { reusedExisting: false })
+        : null,
+    },
   );
 }
 
 export const provider = {
   id: 'gitlab-api',
   providerCapabilities,
+  apiReachability,
   repoStatus,
   refsCompare,
   refsInventory,
@@ -915,3 +962,5 @@ export const provider = {
   forgeChanges,
   statusSet,
 };
+
+setBranchProtectionImpl(branchProtection);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remogram/provider-gitlab-api",
-  "version": "0.1.0-beta.6",
+  "version": "0.1.0-beta.9",
   "description": "GitLab API provider for remogram",
   "type": "module",
   "license": "MIT",
@@ -16,12 +16,13 @@
     "*.js"
   ],
   "exports": {
-    ".": "./index.js"
+    ".": "./index.js",
+    "./branch-protection-internal.js": "./branch-protection-internal.js"
   },
   "engines": {
     "node": ">=20"
   },
   "dependencies": {
-    "@remogram/core": "0.1.0-beta.6"
+    "@remogram/core": "0.1.0-beta.9"
   }
 }