neondeck 1.0.0-beta.10

package/src/modules/github/pr-file-cache.ts

@@ -0,0 +1,264 @@
+import * as v from 'valibot';
+import { openDb } from '../../lib/sqlite';
+import { errorMessage } from './errors';
+import {
+  fetchPullRequestDetail,
+  fetchPullRequestFiles,
+  summarizePullRequestFiles,
+} from './pull-requests';
+import { githubPullRequestFileSchema } from './schemas';
+import type { GitHubPullRequestFile, GitHubPullRequestFiles } from './schemas';
+
+const CACHE_ROWS_PER_PULL_REQUEST = 3;
+const CACHE_MAX_AGE_MS = 30 * 24 * 60 * 60 * 1000;
+
+type CacheRow = {
+  payload: string;
+  fetched_at: string;
+};
+
+type PullRequestHeadShaFetcher = (options: {
+  token: string;
+  owner: string;
+  repo: string;
+  number: number;
+}) => Promise<string | null | undefined>;
+
+export async function fetchPullRequestFilesWithCache(options: {
+  token: string;
+  owner: string;
+  repo: string;
+  number: number;
+  headSha?: string | null;
+  patches?: 'all' | 'none';
+  databasePath: string;
+  fetcher?: typeof fetchPullRequestFiles;
+  fetchHeadSha?: PullRequestHeadShaFetcher;
+  now?: Date;
+}): Promise<GitHubPullRequestFiles> {
+  const fetcher = options.fetcher ?? fetchPullRequestFiles;
+  const fetchHeadSha = options.fetchHeadSha ?? fetchCurrentPullRequestHeadSha;
+  const repoFullName = `${options.owner}/${options.repo}`;
+  const headSha = options.headSha?.trim() || null;
+  if (!headSha) {
+    return maybeStripPatches(
+      await fetcher({
+        token: options.token,
+        owner: options.owner,
+        repo: options.repo,
+        number: options.number,
+      }),
+      options.patches,
+    );
+  }
+
+  const cached = readCachedPullRequestFiles({
+    databasePath: options.databasePath,
+    repo: repoFullName,
+    number: options.number,
+    headSha,
+  });
+  if (cached) return maybeStripPatches(cached, options.patches);
+
+  const request = {
+    token: options.token,
+    owner: options.owner,
+    repo: options.repo,
+    number: options.number,
+  };
+  const diff = await fetcher(request);
+  let currentHeadSha: string | null | undefined = null;
+  try {
+    currentHeadSha = await fetchHeadSha(request);
+  } catch (error) {
+    console.warn(
+      `[neondeck] Skipping GitHub PR file cache write because head verification failed for ${repoFullName}#${options.number}: ${errorMessage(error)}`,
+    );
+  }
+  if (diff.files.length > 0 && currentHeadSha === headSha) {
+    writeCachedPullRequestFiles({
+      databasePath: options.databasePath,
+      repo: repoFullName,
+      number: options.number,
+      headSha,
+      files: diff.files,
+      fetchedAt: diff.fetchedAt,
+      now: options.now ?? new Date(),
+    });
+  }
+
+  return maybeStripPatches(diff, options.patches);
+}
+
+export function stripPullRequestPatches(
+  diff: GitHubPullRequestFiles,
+): GitHubPullRequestFiles {
+  return {
+    ...diff,
+    files: diff.files.map((file) => ({
+      ...file,
+      patch: null,
+      message: file.message,
+    })),
+  };
+}
+
+function maybeStripPatches(
+  diff: GitHubPullRequestFiles,
+  patches: 'all' | 'none' | undefined,
+) {
+  return patches === 'none' ? stripPullRequestPatches(diff) : diff;
+}
+
+async function fetchCurrentPullRequestHeadSha(options: {
+  token: string;
+  owner: string;
+  repo: string;
+  number: number;
+}) {
+  const detail = await fetchPullRequestDetail(options);
+  return detail.headSha;
+}
+
+export function readCachedPullRequestFiles(options: {
+  databasePath: string;
+  repo: string;
+  number: number;
+  headSha: string;
+}): GitHubPullRequestFiles | null {
+  const database = openDb(options.databasePath);
+  try {
+    const row = database
+      .prepare(
+        `
+          SELECT payload, fetched_at
+          FROM github_pr_file_cache
+          WHERE repo = ?
+            AND pr_number = ?
+            AND head_sha = ?
+        `,
+      )
+      .get(options.repo, options.number, options.headSha) as
+      CacheRow | undefined;
+    if (!row) return null;
+
+    const files = parseCachedFiles(row.payload);
+    if (!files) {
+      deleteCachedPullRequestFiles(database, options);
+      return null;
+    }
+
+    return {
+      repo: options.repo,
+      number: options.number,
+      files,
+      diffSummary: summarizePullRequestFiles(files),
+      fetchedAt: row.fetched_at,
+    };
+  } finally {
+    database.close();
+  }
+}
+
+function writeCachedPullRequestFiles(options: {
+  databasePath: string;
+  repo: string;
+  number: number;
+  headSha: string;
+  files: GitHubPullRequestFile[];
+  fetchedAt: string;
+  now: Date;
+}) {
+  const payload = JSON.stringify(options.files);
+  const database = openDb(options.databasePath);
+  try {
+    database
+      .prepare(
+        `
+          INSERT OR REPLACE INTO github_pr_file_cache (
+            repo,
+            pr_number,
+            head_sha,
+            payload,
+            byte_size,
+            fetched_at
+          )
+          VALUES (?, ?, ?, ?, ?, ?)
+        `,
+      )
+      .run(
+        options.repo,
+        options.number,
+        options.headSha,
+        payload,
+        Buffer.byteLength(payload, 'utf8'),
+        options.fetchedAt,
+      );
+    prunePullRequestFileCache(
+      database,
+      options.repo,
+      options.number,
+      options.now,
+    );
+  } finally {
+    database.close();
+  }
+}
+
+function parseCachedFiles(payload: string): GitHubPullRequestFile[] | null {
+  try {
+    return v.parse(v.array(githubPullRequestFileSchema), JSON.parse(payload));
+  } catch {
+    return null;
+  }
+}
+
+function deleteCachedPullRequestFiles(
+  database: ReturnType<typeof openDb>,
+  options: { repo: string; number: number; headSha: string },
+) {
+  database
+    .prepare(
+      `
+        DELETE FROM github_pr_file_cache
+        WHERE repo = ?
+          AND pr_number = ?
+          AND head_sha = ?
+      `,
+    )
+    .run(options.repo, options.number, options.headSha);
+}
+
+function prunePullRequestFileCache(
+  database: ReturnType<typeof openDb>,
+  repo: string,
+  number: number,
+  now: Date,
+) {
+  const cutoff = new Date(now.getTime() - CACHE_MAX_AGE_MS).toISOString();
+  database
+    .prepare(
+      `
+        DELETE FROM github_pr_file_cache
+        WHERE fetched_at < ?
+      `,
+    )
+    .run(cutoff);
+  database
+    .prepare(
+      `
+        DELETE FROM github_pr_file_cache
+        WHERE repo = ?
+          AND pr_number = ?
+          AND head_sha NOT IN (
+            SELECT head_sha
+            FROM github_pr_file_cache
+            WHERE repo = ?
+              AND pr_number = ?
+            ORDER BY fetched_at DESC, head_sha DESC
+            LIMIT ?
+          )
+      `,
+    )
+    .run(repo, number, repo, number, CACHE_ROWS_PER_PULL_REQUEST);
+}

package/src/modules/github/pull-requests.ts

@@ -0,0 +1,411 @@
+import * as v from 'valibot';
+import { encodePathSegment, githubFetch, nextLink } from './client';
+import {
+  fetchCheckRunDetailsWithMetadata,
+  fetchCheckSuitesWithMetadata,
+} from './checks';
+import { fetchPullRequestReviewThreadsWithMetadata } from './comments';
+import {
+  fetchPullRequestReviewsWithMetadata,
+  requestedChangesStateFromReviews,
+} from './reviews';
+import {
+  githubPullRequestApiResponseSchema,
+  githubPullRequestCommitApiItemSchema,
+  githubPullRequestFileApiItemSchema,
+  githubRepositoryApiResponseSchema,
+} from './schemas';
+import type {
+  GitHubBranchPushPermissions,
+  GitHubDiffSummary,
+  GitHubPullRequestCommit,
+  GitHubPullRequestCommitApiItem,
+  GitHubPullRequestDetail,
+  GitHubPullRequestEventState,
+  GitHubPullRequestFile,
+  GitHubPullRequestFileApiItem,
+  GitHubPullRequestFiles,
+} from './schemas';
+
+export async function fetchPullRequestDetail(options: {
+  token: string;
+  owner: string;
+  repo: string;
+  number: number;
+}): Promise<GitHubPullRequestDetail> {
+  const response = await githubFetch(
+    options.token,
+    `https://api.github.com/repos/${encodePathSegment(options.owner)}/${encodePathSegment(options.repo)}/pulls/${options.number}`,
+  );
+  const data = v.parse(
+    githubPullRequestApiResponseSchema,
+    await response.json(),
+  );
+
+  return {
+    id: data.id,
+    number: data.number,
+    title: data.title,
+    body: data.body ?? null,
+    repo: `${options.owner}/${options.repo}`,
+    url: data.html_url,
+    state: data.state,
+    draft: data.draft ?? false,
+    author: data.user?.login ?? 'unknown',
+    labels: (data.labels ?? [])
+      .map((label) => label.name)
+      .filter((name): name is string => Boolean(name)),
+    comments: data.comments ?? 0,
+    merged: data.merged,
+    mergeCommitSha: data.merge_commit_sha,
+    headSha: data.head.sha,
+    headRef: data.head.ref ?? data.head.sha,
+    headOwner: data.head.repo?.owner?.login ?? options.owner,
+    headName: data.head.repo?.name ?? options.repo,
+    headRepoFullName: data.head.repo?.full_name ?? null,
+    baseRef: data.base.ref,
+    baseSha: data.base.sha ?? null,
+    baseRepoFullName: data.base.repo?.full_name ?? null,
+    mergeable: data.mergeable ?? null,
+    mergeableState: data.mergeable_state ?? null,
+    maintainerCanModify: data.maintainer_can_modify ?? false,
+    createdAt: data.created_at ?? data.updated_at,
+    updatedAt: data.updated_at,
+  };
+}
+
+export async function fetchPullRequestEventState(options: {
+  token: string;
+  owner: string;
+  repo: string;
+  number: number;
+}): Promise<GitHubPullRequestEventState> {
+  const detail = await fetchPullRequestDetail(options);
+  const [
+    commitDetails,
+    reviewDetails,
+    reviewThreadDetails,
+    checkSuiteDetails,
+    checkRunDetails,
+    branchPermissions,
+    behindBy,
+  ] = await Promise.all([
+    fetchPullRequestCommitsWithMetadata(options),
+    fetchPullRequestReviewsWithMetadata(options),
+    fetchPullRequestReviewThreadsWithMetadata(options),
+    fetchCheckSuitesWithMetadata({
+      token: options.token,
+      owner: options.owner,
+      repo: options.repo,
+      ref: detail.headSha,
+    }),
+    fetchCheckRunDetailsWithMetadata({
+      token: options.token,
+      owner: options.owner,
+      repo: options.repo,
+      ref: detail.headSha,
+    }),
+    fetchBranchPushPermissions({
+      token: options.token,
+      owner: options.owner,
+      repo: options.repo,
+      detail,
+    }),
+    fetchPullRequestBehindBy(options, detail).catch(() => null),
+  ]);
+  const requestedChangesState = requestedChangesStateFromReviews(
+    reviewDetails.reviews,
+  );
+
+  return {
+    repo: detail.repo,
+    number: detail.number,
+    url: detail.url,
+    title: detail.title,
+    body: detail.body ?? null,
+    state: detail.state,
+    draft: detail.draft ?? false,
+    merged: detail.merged,
+    mergeCommitSha: detail.mergeCommitSha,
+    headSha: detail.headSha,
+    headRef: detail.headRef ?? null,
+    baseRef: detail.baseRef,
+    baseSha: detail.baseSha ?? null,
+    mergeable: detail.mergeable ?? null,
+    mergeableState: detail.mergeableState ?? null,
+    maintainerCanModify: detail.maintainerCanModify ?? false,
+    commits: commitDetails.commits,
+    commitsTruncated: commitDetails.truncated,
+    reviewThreads: reviewThreadDetails.reviewThreads,
+    reviewThreadsTruncated:
+      reviewThreadDetails.truncated ||
+      reviewThreadDetails.reviewThreads.some(
+        (thread) => thread.commentsTruncated,
+      ),
+    requestedChangesReviews: requestedChangesState.active,
+    requestedChangesState,
+    reviewsTruncated: reviewDetails.truncated,
+    checkSuites: checkSuiteDetails.checkSuites,
+    checkSuitesTruncated: checkSuiteDetails.truncated,
+    checkRuns: checkRunDetails.checkRuns,
+    checkRunsTruncated: checkRunDetails.truncated,
+    branchPermissions,
+    isOutOfDate: isOutOfDateState(behindBy, detail.mergeableState),
+    fetchedAt: new Date().toISOString(),
+  };
+}
+
+export async function fetchPullRequestCommits(options: {
+  token: string;
+  owner: string;
+  repo: string;
+  number: number;
+}): Promise<GitHubPullRequestCommit[]> {
+  return (await fetchPullRequestCommitsWithMetadata(options)).commits;
+}
+
+export async function fetchPullRequestCommitsWithMetadata(options: {
+  token: string;
+  owner: string;
+  repo: string;
+  number: number;
+}): Promise<{ commits: GitHubPullRequestCommit[]; truncated: boolean }> {
+  const commits: GitHubPullRequestCommitApiItem[] = [];
+  let nextUrl: string | undefined =
+    `https://api.github.com/repos/${encodePathSegment(options.owner)}/${encodePathSegment(options.repo)}/pulls/${options.number}/commits?per_page=100`;
+  let pageCount = 0;
+
+  while (nextUrl && pageCount < 3) {
+    pageCount += 1;
+    const response = await githubFetch(options.token, nextUrl);
+    const data = v.parse(
+      v.array(githubPullRequestCommitApiItemSchema),
+      await response.json(),
+    );
+    commits.push(...data);
+    nextUrl = nextLink(response.headers.get('link'));
+  }
+
+  return {
+    commits: commits.map((commit) => ({
+      sha: commit.sha,
+      url: commit.html_url,
+      authorLogin: commit.author?.login ?? null,
+      committedAt:
+        commit.commit.committer?.date ?? commit.commit.author?.date ?? null,
+    })),
+    truncated: Boolean(nextUrl),
+  };
+}
+
+export async function fetchPullRequestFiles(options: {
+  token: string;
+  owner: string;
+  repo: string;
+  number: number;
+}): Promise<GitHubPullRequestFiles> {
+  const files: GitHubPullRequestFile[] = [];
+  let nextUrl: string | undefined =
+    `https://api.github.com/repos/${encodePathSegment(options.owner)}/${encodePathSegment(options.repo)}/pulls/${options.number}/files?per_page=100`;
+
+  while (nextUrl) {
+    const response = await githubFetch(options.token, nextUrl);
+    const data = v.parse(
+      v.array(githubPullRequestFileApiItemSchema),
+      await response.json(),
+    );
+    files.push(...data.map(normalizePullRequestFile));
+    nextUrl = nextLink(response.headers.get('link'));
+  }
+
+  return {
+    repo: `${options.owner}/${options.repo}`,
+    number: options.number,
+    files,
+    diffSummary: summarizePullRequestFiles(files),
+    fetchedAt: new Date().toISOString(),
+  };
+}
+
+async function fetchBranchPushPermissions(options: {
+  token: string;
+  owner: string;
+  repo: string;
+  detail: GitHubPullRequestDetail;
+}): Promise<GitHubBranchPushPermissions> {
+  const headRepoFullName = options.detail.headRepoFullName ?? null;
+  const baseRepoFullName =
+    options.detail.baseRepoFullName ?? `${options.owner}/${options.repo}`;
+  const isFork =
+    headRepoFullName !== null &&
+    headRepoFullName.toLowerCase() !== baseRepoFullName.toLowerCase();
+  const [headRepo, baseRepo] = await Promise.all([
+    headRepoFullName
+      ? fetchRepositoryPermissions(options.token, headRepoFullName).catch(
+          () => null,
+        )
+      : Promise.resolve(null),
+    fetchRepositoryPermissions(options.token, baseRepoFullName).catch(
+      () => null,
+    ),
+  ]);
+  const headRepoPush = headRepo?.permissions?.push ?? null;
+  const baseRepoPush = baseRepo?.permissions?.push ?? null;
+  const maintainerCanModify = options.detail.maintainerCanModify ?? false;
+  const canLikelyPush =
+    headRepoPush === true ||
+    (isFork && maintainerCanModify && baseRepoPush === true)
+      ? true
+      : headRepoPush === false || baseRepoPush === false
+        ? false
+        : null;
+
+  return {
+    headRepoFullName,
+    baseRepoFullName,
+    isFork,
+    maintainerCanModify,
+    headRepoPush,
+    baseRepoPush,
+    canLikelyPush,
+    checkedAt: new Date().toISOString(),
+  };
+}
+
+async function fetchRepositoryPermissions(token: string, fullName: string) {
+  const [owner, repo] = fullName.split('/');
+  if (!owner || !repo) return null;
+  const response = await githubFetch(
+    token,
+    `https://api.github.com/repos/${encodePathSegment(owner)}/${encodePathSegment(repo)}`,
+  );
+  return v.parse(githubRepositoryApiResponseSchema, await response.json());
+}
+
+export function isOutOfDateMergeState(value: string | null | undefined) {
+  return value === 'behind';
+}
+
+export function isOutOfDateState(
+  behindBy: number | null,
+  mergeableState: string | null | undefined,
+) {
+  return behindBy === null
+    ? isOutOfDateMergeState(mergeableState)
+    : behindBy > 0;
+}
+
+async function fetchPullRequestBehindBy(
+  options: { token: string; owner: string; repo: string },
+  detail: GitHubPullRequestDetail,
+) {
+  if (!detail.baseSha || !detail.headSha) return null;
+  const response = await githubFetch(
+    options.token,
+    `https://api.github.com/repos/${encodePathSegment(options.owner)}/${encodePathSegment(options.repo)}/compare/${encodePathSegment(detail.baseSha)}...${encodePathSegment(detail.headSha)}`,
+  );
+  const comparison = v.parse(
+    v.object({ behind_by: v.pipe(v.number(), v.integer(), v.minValue(0)) }),
+    await response.json(),
+  );
+  return comparison.behind_by;
+}
+
+function normalizePullRequestFile(
+  file: GitHubPullRequestFileApiItem,
+): GitHubPullRequestFile {
+  const patch = file.patch ? unifiedPatchFromGitHubFile(file) : null;
+  const renameOnly = patch === null && isRenameOnlyPullRequestFile(file);
+  const binary =
+    patch === null && !renameOnly && isLikelyBinaryPullRequestFile(file);
+  const truncated = patch === null && !binary && !renameOnly;
+  return {
+    path: file.filename,
+    previousPath: file.previous_filename ?? null,
+    status: file.status,
+    additions: file.additions,
+    deletions: file.deletions,
+    changes: file.changes,
+    binary,
+    generatedLike: false,
+    patch,
+    truncated,
+    sha: file.sha ?? null,
+    htmlUrl: file.blob_url ?? null,
+    rawUrl: file.raw_url ?? null,
+    contentsUrl: file.contents_url ?? null,
+    message:
+      patch === null ? missingPatchMessage(file, { binary, renameOnly }) : null,
+  };
+}
+
+function isRenameOnlyPullRequestFile(file: GitHubPullRequestFileApiItem) {
+  return (
+    file.status === 'renamed' &&
+    Boolean(file.previous_filename) &&
+    file.additions === 0 &&
+    file.deletions === 0 &&
+    file.changes === 0
+  );
+}
+
+function isLikelyBinaryPullRequestFile(file: GitHubPullRequestFileApiItem) {
+  return file.additions === 0 && file.deletions === 0 && file.changes === 0;
+}
+
+function missingPatchMessage(
+  file: GitHubPullRequestFileApiItem,
+  options: { binary: boolean; renameOnly: boolean },
+) {
+  if (options.renameOnly) {
+    return `File was renamed from ${file.previous_filename ?? 'its previous path'} with no content changes.`;
+  }
+  return options.binary
+    ? 'GitHub did not include a patch for this binary file.'
+    : 'GitHub omitted the text patch for this file, likely because the diff is too large.';
+}
+
+function unifiedPatchFromGitHubFile(file: GitHubPullRequestFileApiItem) {
+  const previousPath = file.previous_filename ?? file.filename;
+  const currentPath = file.filename;
+  const deleted = isDeletedFileStatus(file.status);
+  const added = isAddedFileStatus(file.status);
+  const header = [`diff --git a/${previousPath} b/${currentPath}`];
+
+  if (added) {
+    header.push('new file mode 100644');
+  } else if (deleted) {
+    header.push('deleted file mode 100644');
+  } else if (
+    file.previous_filename &&
+    file.previous_filename !== file.filename
+  ) {
+    header.push(`rename from ${file.previous_filename}`);
+    header.push(`rename to ${file.filename}`);
+  }
+
+  header.push(added ? '--- /dev/null' : `--- a/${previousPath}`);
+  header.push(deleted ? '+++ /dev/null' : `+++ b/${currentPath}`);
+  header.push(file.patch?.trimEnd() ?? '');
+
+  return `${header.join('\n')}\n`;
+}
+
+function isAddedFileStatus(status: string) {
+  return status === 'added' || status === 'new';
+}
+
+function isDeletedFileStatus(status: string) {
+  return status === 'removed' || status === 'deleted';
+}
+
+export function summarizePullRequestFiles(
+  files: GitHubPullRequestFile[],
+): GitHubDiffSummary {
+  return {
+    files: files.length,
+    additions: files.reduce((sum, file) => sum + file.additions, 0),
+    deletions: files.reduce((sum, file) => sum + file.deletions, 0),
+    binaryFiles: files.filter((file) => file.binary).length,
+  };
+}