Vercel/src/admin/github/index.ts

import {
  TEMPLATE_BASE_OWNER,
  TEMPLATE_BASE_REPO,
  TEMPLATE_BASE_BRANCH,
} from '@/site/config';

const DEFAULT_BRANCH = 'main';

const FALLBACK_TEXT = 'Unknown';

// Cache all results for 2 minutes to avoid rate limiting
// GitHub API requests limited to 60 requests per hour
const FETCH_CONFIG: RequestInit = {
  next: { revalidate: 120 },
};

interface RepoParams {
  owner?: string
  repo?: string
  branch?: string
  commit?: string
};

// Website urls

export const getGitHubRepoUrl = ({
  owner = TEMPLATE_BASE_OWNER,
  repo = TEMPLATE_BASE_REPO,
}: RepoParams = {}) =>
  `https://github.com/${owner}/${repo}`;

export const getGitHubCompareUrl = ({
  owner,
  repo,
  branch = DEFAULT_BRANCH,
}: RepoParams = {}) =>
  // eslint-disable-next-line max-len
  `${getGitHubRepoUrl({ owner, repo })}/compare/${branch}...${TEMPLATE_BASE_OWNER}:${TEMPLATE_BASE_REPO}:${TEMPLATE_BASE_BRANCH}`;

// API urls

const getGitHubApiRepoUrl = ({
  owner = TEMPLATE_BASE_OWNER,
  repo = TEMPLATE_BASE_REPO,
}: RepoParams = {}) =>
  `https://api.github.com/repos/${owner}/${repo}`;

const getGitHubApiCommitsUrl = (params?: RepoParams) =>
  `${getGitHubApiRepoUrl(params)}/commits/${params?.branch || DEFAULT_BRANCH}`;

const getGitHubApiForksUrl = (params?: RepoParams) =>
  `${getGitHubApiRepoUrl(params)}/forks`;

const getGitHubApiCompareToRepoUrl = ({
  owner,
  repo,
  branch = DEFAULT_BRANCH,
}: RepoParams = {}) =>
  // eslint-disable-next-line max-len
  `${getGitHubApiRepoUrl()}/compare/${TEMPLATE_BASE_BRANCH}...${owner}:${repo}:${branch}`;

const getGitHubApiCompareToCommitUrl = ({ commit }: RepoParams = {}) =>
  `${getGitHubApiRepoUrl()}/compare/${TEMPLATE_BASE_BRANCH}...${commit}`;

// Requests

export const getLatestBaseRepoCommitSha = async () => {
  const response = await fetch(getGitHubApiCommitsUrl(), FETCH_CONFIG);
  const data = await response.json();
  return data.sha ? data.sha.slice(0, 7) as string : undefined;
};

const getIsRepoForkedFromBase = async (params: RepoParams) => {
  const response = await fetch(getGitHubApiRepoUrl(params), FETCH_CONFIG);
  const data = await response.json();
  return (
    Boolean(data.fork) &&
    data.source?.full_name === `${TEMPLATE_BASE_OWNER}/${TEMPLATE_BASE_REPO}`
  );
};

const getGitHubCommitsBehindFromRepo = async (params?: RepoParams) => {
  const response = await fetch(
    getGitHubApiCompareToRepoUrl(params),
    FETCH_CONFIG,
  );
  const data = await response.json();
  return data.behind_by as number;
};

const getGitHubCommitsBehindFromCommit = async (params?: RepoParams) => {
  const response = await fetch(
    getGitHubApiCompareToCommitUrl(params),
    FETCH_CONFIG,
  );
  const data = await response.json();
  return data.behind_by as number;
};

const isRepoBaseRepo = ({ owner, repo }: RepoParams) =>
  owner?.toLowerCase() === TEMPLATE_BASE_OWNER &&
  repo?.toLowerCase() === TEMPLATE_BASE_REPO;

export const getGitHubPublicFork = async (
  params?: RepoParams,
): Promise<RepoParams> => {
  const response = await fetch(getGitHubApiForksUrl(params), FETCH_CONFIG);
  const fork = (await response.json())[0];
  return {
    owner: fork.owner.login,
    repo: fork.name,
  };
};

const getGitHubMeta = async (params: RepoParams) => {
  const url = getGitHubRepoUrl(params);
  const isBaseRepo = isRepoBaseRepo(params);

  console.log(getGitHubApiCompareToCommitUrl({
    ...params,
    commit: 'e3745e24e8c54e35aee1f54b66d1ee710e7803e0',
  }));

  const [
    isForkedFromBase,
    behindBy,
  ] = await Promise.all([
    getIsRepoForkedFromBase(params),
    isBaseRepo && params.commit
      ? getGitHubCommitsBehindFromCommit(params)
      : getGitHubCommitsBehindFromRepo(params),
  ]);

  const isBehind = behindBy === undefined
    ? undefined
    : behindBy > 0;

  const label = isBehind === undefined
    ? FALLBACK_TEXT
    : isBehind
      ? `${behindBy} Behind`
      : 'Synced';

  const description = isBehind === undefined
    ? FALLBACK_TEXT
    : isBehind
      ? `This fork is ${behindBy} commit${behindBy === 1 ? '' : 's'} behind.`
      : 'This fork is up to date.';

  return {
    url,
    isForkedFromBase,
    isBaseRepo,
    behindBy,
    isBehind,
    label,
    description,
  };
};

export const getGitHubMetaWithFallback = (params: RepoParams) =>
  getGitHubMeta(params)
    .catch(e => {
      console.error('Error retrieving GitHub meta', { params, error: e });
      return {
        url: undefined,
        isForkedFromBase: false,
        isBaseRepo: undefined,
        behindBy: undefined,
        isBehind: undefined,
        label: FALLBACK_TEXT,
        description: FALLBACK_TEXT,
      };
    });