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

package/index.js

@@ -37,6 +37,21 @@ import {
   orderOpenPullNumbers,
   buildOpenPullListMeta,
   githubOpenPullSortQuery,
+  buildProviderIdentityFromGitHubUser,
+  buildBranchProtectionFromGitHubProtection,
+  buildCrFilesBody,
+  buildCrFilesFromGiteaFiles,
+  buildCrCommentsBody,
+  buildCrCommentsFromGiteaComments,
+  parseSinceObservedAt,
+  buildForgeChangesFromGiteaPulls,
+  buildChecksConclusionObservedEvent,
+  appendForgeChangeEvents,
+  buildCommitStatusSetBody,
+  parseStatusSetArgs,
+  normalizeStatusSetState,
+  statusSetIdempotencyScanCapabilityFacts,
+  MAX_OPEN_PULL_IDEMPOTENCY_PAGES,
 } from '@remogram/core';
 
 const PUBLIC_GITHUB_HOST = 'github.com';
@@ -70,9 +85,21 @@ const AUTH_CAPABILITIES = [
   'pr_checks',
   'merge_plan',
   'sync_plan',
+  'status_set',
+  'whoami',
+  'branch_protection',
+  'cr_files',
+  'cr_comments',
+  'forge_changes',
 ];
 
-const STRUCTURED_COMMANDS = apiProviderCommands();
+const STRUCTURED_COMMANDS = apiProviderCommands({
+  branchProtectionImplemented: true,
+  crFilesImplemented: true,
+  crCommentsImplemented: true,
+  forgeChangesImplemented: true,
+  statusSetImplemented: true,
+});
 
 export function githubToken() {
   if (process.env.GITHUB_TOKEN) return { token: process.env.GITHUB_TOKEN, env: 'GITHUB_TOKEN' };
@@ -379,8 +406,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: 'link_header',
       pageSizeParam: 'per_page',
@@ -530,7 +559,103 @@ 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 }) {
+  if (number == null) {
+    throw Object.assign(new Error('--number required'), {
+      forgeError: forgeError(ERROR_CODES.INVALID_ARGS, 'Provide --number for PR changed paths'),
+    });
+  }
+  const base = apiBase(ctx.config, ctx.parsed);
+  const trustedOrigin = new URL(base).origin;
+  const { token } = requireToken();
+  const startUrl = `${base}${repoApiPath(ctx.config, 'pulls', number, 'files')}?per_page=${DEFAULT_CHECK_STATUS_PAGE_SIZE}`;
+  const { items, truncated, walked_count } = await paginateGitHubLinkPages({
+    trustedOrigin,
+    startUrl,
+    token,
+    mapPageItems: (body) => (Array.isArray(body) ? body : []),
+  });
+  const body = buildCrFilesFromGiteaFiles(number, items);
+  if (truncated) {
+    return buildCrFilesBody({
+      pr_number: body.pr_number,
+      changed_paths: body.changed_paths,
+      paths_truncated: true,
+      path_count: walked_count,
+    });
+  }
+  return body;
+}
+
+export async function crComments(ctx, { number }) {
+  if (number == null) {
+    throw Object.assign(new Error('--number required'), {
+      forgeError: forgeError(ERROR_CODES.INVALID_ARGS, 'Provide --number for PR review comments'),
+    });
+  }
+  const base = apiBase(ctx.config, ctx.parsed);
+  const trustedOrigin = new URL(base).origin;
+  const { token } = requireToken();
+  const startUrl = `${base}${repoApiPath(ctx.config, 'pulls', number, 'comments')}?per_page=${DEFAULT_CHECK_STATUS_PAGE_SIZE}`;
+  const { items, truncated, walked_count } = await paginateGitHubLinkPages({
+    trustedOrigin,
+    startUrl,
+    token,
+    mapPageItems: (body) => (Array.isArray(body) ? body : []),
+  });
+  const body = buildCrCommentsFromGiteaComments(number, items);
+  if (truncated) {
+    return buildCrCommentsBody({
+      pr_number: body.pr_number,
+      comments: body.comments,
+      comments_truncated: true,
+      comment_count: walked_count,
+    });
+  }
+  return body;
+}
+
+export async function forgeChanges(ctx, { since }) {
+  requireToken();
+  const sinceIso = parseSinceObservedAt(since);
+  const base = apiBase(ctx.config, ctx.parsed);
+  const trustedOrigin = new URL(base).origin;
+  const { token } = requireToken();
+  const startUrl = `${base}${repoApiPath(ctx.config, 'pulls')}?state=all&sort=updated&direction=desc&per_page=${DEFAULT_CHECK_STATUS_PAGE_SIZE}`;
+  const { items, truncated } = await paginateGitHubLinkPages({
+    trustedOrigin,
+    startUrl,
+    token,
+    mapPageItems: (body) => (Array.isArray(body) ? body : []),
+  });
+  let body = buildForgeChangesFromGiteaPulls(sinceIso, items, { listTruncated: truncated });
+  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: truncated });
+  }
+  return body;
 }
 
 const GITHUB_OPEN_PULL_COMPLIANT_MAX =
@@ -802,6 +927,128 @@ export async function syncPlan(ctx, remoteName = 'origin') {
   };
 }
 
+export async function whoami(ctx) {
+  const base = apiBase(ctx.config, ctx.parsed);
+  const { token } = requireToken();
+  const url = `${base}/user`;
+  const { body, headers } = await fetchJsonWithMeta(url, {
+    headers: authHeaders(token),
+  });
+  const scopeHeader =
+    headers?.get?.('x-oauth-scopes') ?? headers?.get?.('X-OAuth-Scopes') ?? null;
+  return buildProviderIdentityFromGitHubUser(body, scopeHeader);
+}
+
+function githubStatusRecordOrder(a, b) {
+  const aUpdated = Date.parse(a?.updated_at ?? '') || 0;
+  const bUpdated = Date.parse(b?.updated_at ?? '') || 0;
+  if (aUpdated !== bUpdated) return aUpdated - bUpdated;
+  const aId = Number(a.id) || 0;
+  const bId = Number(b.id) || 0;
+  return aId - bId;
+}
+
+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) {
+  const { token } = requireToken();
+  const base = apiBase(ctx.config, ctx.parsed);
+  const trustedOrigin = new URL(base).origin;
+  const path = repoApiPath(ctx.config, 'commits', sha, 'statuses');
+  const pageQuery = `${path.includes('?') ? '&' : '?'}per_page=${DEFAULT_CHECK_STATUS_PAGE_SIZE}`;
+  let url = `${base}${path}${pageQuery}`;
+  let bestMatch = null;
+  const activeLimit = DEFAULT_CHECK_STATUS_PAGE_SIZE;
+
+  for (let page = 1; page <= MAX_OPEN_PULL_IDEMPOTENCY_PAGES; page += 1) {
+    const { body, headers } = await fetchJsonWithMeta(url, {
+      headers: authHeaders(token),
+    });
+    const items = Array.isArray(body) ? body : [];
+    for (const record of items) {
+      if (record?.context !== context) continue;
+      if (!bestMatch || githubStatusRecordOrder(record, bestMatch) > 0) {
+        bestMatch = record;
+      }
+    }
+    const linkPage = resolveGitHubLinkNextPage({
+      trustedOrigin,
+      currentUrl: url,
+      linkHeader: headers?.get?.('link') ?? headers?.get?.('Link'),
+      pageIndex: page - 1,
+      maxPages: MAX_OPEN_PULL_IDEMPOTENCY_PAGES,
+    });
+    if (items.length < activeLimit) {
+      return bestMatch;
+    }
+    if (page === MAX_OPEN_PULL_IDEMPOTENCY_PAGES) {
+      throw Object.assign(new Error('Commit status idempotency scan incomplete'), {
+        forgeError: statusSetIdempotencyScanIncompleteError(page, activeLimit),
+      });
+    }
+    if (!linkPage.nextUrl) {
+      return bestMatch;
+    }
+    url = withPerPageParam(linkPage.nextUrl, activeLimit);
+  }
+  return bestMatch;
+}
+
+export async function statusSet(ctx, args) {
+  const parsed = parseStatusSetArgs(args);
+  const existing = await findCommitStatusByContext(ctx, parsed.sha, parsed.context);
+  if (existing) {
+    const existingState = normalizeStatusSetState(existing.state ?? existing.status);
+    if (existingState === parsed.state) {
+      return buildCommitStatusSetBody(existing, parsed, { reusedExisting: true });
+    }
+  }
+  const payload = {
+    state: parsed.state,
+    context: parsed.context,
+  };
+  if (parsed.description != null) payload.description = parsed.description;
+  if (parsed.target_url != null) payload.target_url = parsed.target_url;
+  const response = await githubFetch(ctx.config, ctx.parsed, repoApiPath(ctx.config, 'statuses', parsed.sha), {
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json' },
+    body: JSON.stringify(payload),
+  });
+  return buildCommitStatusSetBody(response, parsed);
+}
+
+export async function branchProtection(ctx, { branchRef }) {
+  assertGitRef(branchRef, '--branch-ref');
+  const base = apiBase(ctx.config, ctx.parsed);
+  const { token } = requireToken();
+  const url = `${base}${repoApiPath(ctx.config, 'branches', branchRef, 'protection')}`;
+  try {
+    const { body } = await fetchJsonWithMeta(url, {
+      headers: authHeaders(token),
+    });
+    return buildBranchProtectionFromGitHubProtection(branchRef, body);
+  } catch (err) {
+    if (err?.status === 404) {
+      return buildBranchProtectionFromGitHubProtection(branchRef, null);
+    }
+    throw err;
+  }
+}
+
 export const provider = {
   id: 'github-api',
   providerCapabilities,
@@ -814,4 +1061,10 @@ export const provider = {
   prChecks,
   mergePlan,
   syncPlan,
+  whoami,
+  branchProtection,
+  crFiles,
+  crComments,
+  forgeChanges,
+  statusSet,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remogram/provider-github-api",
-  "version": "0.1.0-beta.4",
+  "version": "0.1.0-beta.5",
   "description": "GitHub 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"
   }
 }