@remogram/provider-gitlab-api 0.1.0-beta.1 → 0.1.0-beta.3

package/index.js

@@ -7,9 +7,21 @@ import {
   gitRevParse,
   gitCurrentBranch,
   gitAheadBehind,
+  refsInventory,
+  crInventory,
+  mergeBlockersFromFacts,
   ERROR_CODES,
   forgeError,
   forgeIngestCapabilityFacts,
+  checkPaginationCapabilityFacts,
+  DEFAULT_CHECK_STATUS_PAGE_SIZE,
+  MAX_CHECK_STATUS_PAGES,
+  paginateCheckStatusPages,
+  paginateOffsetListPages,
+  fetchWithIngestPageBackoff,
+  fetchPageWithIngestBackoff,
+  withPerPageParam,
+  apiProviderCommands,
 } from '@remogram/core';
 
 const PUBLIC_GITLAB_HOST = 'gitlab.com';
@@ -17,12 +29,14 @@ const PUBLIC_GITLAB_API = 'https://gitlab.com/api/v4';
 const AUTH_CAPABILITIES = [
   'repo_status',
   'ref_compare',
+  'ref_inventory',
+  'cr_inventory',
   'pr_status',
   'pr_checks',
   'merge_plan',
   'sync_plan',
 ];
-const STRUCTURED_COMMANDS = AUTH_CAPABILITIES.map((name) => ({ name, implemented: true }));
+const STRUCTURED_COMMANDS = apiProviderCommands();
 
 export function gitlabToken() {
   return process.env.GITLAB_TOKEN || null;
@@ -115,35 +129,39 @@ export async function gitlabFetch(config, parsed, path, options = {}) {
   });
 }
 
-const MAX_CHECK_PAGES = 50;
+const MAX_CHECK_PAGES = MAX_CHECK_STATUS_PAGES;
 const GITLAB_PAGE_SIZE = 100;
 
 export async function gitlabFetchPaginated(config, parsed, path) {
-  const all = [];
-  for (let page = 1; page <= MAX_CHECK_PAGES; page += 1) {
-    const separator = path.includes('?') ? '&' : '?';
-    const body = await gitlabFetch(
-      config,
-      parsed,
-      `${path}${separator}per_page=${GITLAB_PAGE_SIZE}&page=${page}`,
-    );
-    const items = Array.isArray(body) ? body : [];
-    all.push(...items);
-    if (items.length < GITLAB_PAGE_SIZE) break;
-  }
-  return all;
+  return paginateCheckStatusPages({
+    fetchPage: async ({ page, limit }) => {
+      const separator = path.includes('?') ? '&' : '?';
+      const body = await gitlabFetch(
+        config,
+        parsed,
+        `${path}${separator}per_page=${limit}&page=${page}`,
+      );
+      return Array.isArray(body) ? body : [];
+    },
+  });
 }
 
 export function providerCapabilities() {
+  const check_sources = ['commit_statuses', 'pipelines'];
   return {
     commands: STRUCTURED_COMMANDS,
     auth_envs: ['GITLAB_TOKEN'],
-    check_sources: ['commit_statuses', 'pipelines'],
+    check_sources,
     mergeability_confidence: 'derived',
     host_binding: 'verified_remote_host',
     pagination: 'supported',
     write_support: false,
     ...forgeIngestCapabilityFacts(),
+    ...checkPaginationCapabilityFacts({
+      strategy: 'offset_limit',
+      pageSizeParam: 'per_page',
+      sourceCount: check_sources.length,
+    }),
   };
 }
 
@@ -259,7 +277,7 @@ export async function prChecks(ctx, opts) {
     });
   }
 
-  const [statusRecords, pipelineRecords] = await Promise.all([
+  const [statusResult, pipelineResult] = await Promise.all([
     gitlabFetchPaginated(
       ctx.config,
       ctx.parsed,
@@ -271,6 +289,8 @@ export async function prChecks(ctx, opts) {
       `${projectApiPath(ctx.config, 'pipelines')}?sha=${encodeURIComponent(sha)}`,
     ),
   ]);
+  const statusRecords = statusResult.items;
+  const pipelineRecords = pipelineResult.items;
   const mappedStatuses = statusRecords.map((status) => ({
     context: sanitizeField(status.name || status.context),
     state: normalizeStatusState(status.status),
@@ -282,18 +302,19 @@ export async function prChecks(ctx, opts) {
     description: sanitizeField(pipeline.status),
   }));
   const mapped = [...mappedStatuses, ...mappedPipelines];
-  return { head_sha: sha, check_conclusion: summarizeChecks(mapped), statuses: mapped };
+  const checks_truncated = statusResult.truncated || pipelineResult.truncated;
+  return {
+    head_sha: sha,
+    check_conclusion: summarizeChecks(mapped),
+    checks_truncated,
+    statuses: mapped,
+  };
 }
 
 export async function mergePlan(ctx, opts) {
   const view = await prView(ctx, opts);
   const checks = await prChecks(ctx, { number: view.pr_number });
-  const blockers = [];
-  if (view.mergeability === 'conflicted') blockers.push('merge_conflict');
-  if (view.state !== 'open') blockers.push('pr_not_open');
-  if (checks.check_conclusion === 'failure') blockers.push('checks_failed');
-  if (checks.check_conclusion === 'missing') blockers.push('checks_missing');
-  if (checks.check_conclusion === 'pending') blockers.push('checks_pending');
+  const blockers = mergeBlockersFromFacts(view, checks);
   return {
     pr_number: view.pr_number,
     mergeability: view.mergeability,
@@ -302,6 +323,47 @@ export async function mergePlan(ctx, opts) {
   };
 }
 
+export async function listOpenPullsWithMeta(ctx, opts = {}) {
+  apiBase(ctx.config, ctx.parsed);
+  requireToken();
+  const listLimit =
+    opts.limit != null && Number.isInteger(Number(opts.limit)) && Number(opts.limit) > 0
+      ? Number(opts.limit)
+      : null;
+  const path = `${projectApiPath(ctx.config, 'merge_requests')}?state=opened`;
+  const separator = path.includes('?') ? '&' : '?';
+  const { items: all, list_truncated: listTruncated } = await paginateOffsetListPages({
+    pageSize: GITLAB_PAGE_SIZE,
+    listLimit,
+    ...(listLimit != null ? { maxPagesTruncatesWithLimit: true } : {}),
+    fetchPage: async ({ page, limit }) => {
+      const body = await gitlabFetch(
+        ctx.config,
+        ctx.parsed,
+        `${path}${separator}per_page=${limit}&page=${page}`,
+      );
+      return Array.isArray(body) ? body : [];
+    },
+  });
+  let numbers = all
+    .map((mr) => mr.iid)
+    .filter((number) => Number.isInteger(number))
+    .sort((a, b) => a - b);
+  if (listLimit != null && numbers.length > listLimit) {
+    numbers = numbers.slice(0, listLimit);
+  }
+  return { numbers, list_truncated: listTruncated };
+}
+
+export async function listOpenPulls(ctx, opts = {}) {
+  const meta = await listOpenPullsWithMeta(ctx, opts);
+  return meta.numbers;
+}
+
+export async function crInventorySlice(ctx, opts = {}) {
+  return crInventory(ctx, { listOpenPulls, listOpenPullsWithMeta, prView, prChecks }, opts);
+}
+
 export async function syncPlan(ctx, remoteName = 'origin') {
   assertGitRemote(remoteName, 'remote');
   apiBase(ctx.config, ctx.parsed);
@@ -335,6 +397,9 @@ export const provider = {
   providerCapabilities,
   repoStatus,
   refsCompare,
+  refsInventory,
+  listOpenPulls,
+  crInventory: crInventorySlice,
   prView,
   prChecks,
   mergePlan,

package/package.json

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