Add API to get contributor list (#285)

Author: dtinth

Dockerfile.creatorsgarten

@@ -1,5 +1,5 @@
 FROM node:hydrogen AS base
-RUN yarn global add pnpm turbo
+RUN yarn global add pnpm turbo@^1.8.3
 WORKDIR /app
 
 # Generate a pruned workspace

packages/contentsgarten/src/ContentsgartenRouter.ts

@@ -6,6 +6,7 @@ import { AuthState, User } from './ContentsgartenAuth'
 import type { ContentsgartenRequestContext } from './ContentsgartenContext'
 import { PageDatabaseSearch } from './ContentsgartenPageDatabase'
 import { LaxPageRefRegex, PageRefRegex } from './PageRefRegex'
+import { cache } from './cache'
 import {
   GetPageResult,
   getPage,
@@ -14,7 +15,6 @@ import {
   savePageToDatabase,
 } from './getPage'
 import { t } from './trpc'
-import { cache } from './cache'
 
 export { GetPageResult } from './getPage'
 export { PageRefRegex }
@@ -70,6 +70,37 @@ export const ContentsgartenRouter = t.router({
         return { ...result, perf: ctx.perf.toMessageArray() }
       },
     ),
+  getContributors: t.procedure
+    .meta({ summary: 'Returns the contributors of a page' })
+    .input(
+      z.object({
+        pageRef: LaxPageRef,
+      }),
+    )
+    .output(
+      z.object({
+        contributors: z.array(
+          z.object({
+            login: z.string(),
+            avatarUrl: z.string(),
+            contributions: z.number(),
+          }),
+        ),
+        perf: z.array(z.string()),
+      }),
+    )
+    .query(async ({ input: { pageRef }, ctx }) => {
+      const filePath = pageRefToFilePath(ctx, pageRef)
+      const result = await cache(
+        ctx,
+        `contributors:${filePath}`,
+        async () => {
+          return ctx.app.storage.listContributors(ctx, filePath)
+        },
+        300e3,
+      )
+      return { ...result, perf: ctx.perf.toMessageArray() }
+    }),
   getEditPermission: t.procedure
     .meta({
       summary:

packages/contentsgarten/src/ContentsgartenStorage.ts

@@ -1,7 +1,7 @@
 import type { GitHubApp } from './GitHubApp'
 import type { RequestContext } from './RequestContext'
 import { resolveGitHubUsernameFromId } from './resolveGitHubUsernameFromId'
-import { resolveOctokit, ContentsgartenOctokit } from './resolveOctokit'
+import { ContentsgartenOctokit, resolveOctokit } from './resolveOctokit'
 
 export interface ContentsgartenStorage {
   getFile(ctx: RequestContext, path: string): Promise<GetFileResult | undefined>
@@ -10,8 +10,13 @@ export interface ContentsgartenStorage {
     path: string,
     options: PutFileOptions,
   ): Promise<PutFileResult>
+  listContributors(
+    ctx: RequestContext,
+    path: string,
+  ): Promise<ListContributorsResult>
   listFiles(ctx: RequestContext): Promise<string[]>
 }
+
 export interface GetFileResult {
   content: Buffer
   lastModified?: string
@@ -32,6 +37,16 @@ export interface PutFileResult {
   lastModifiedBy: string[]
 }
 
+export interface ListContributorsResult {
+  contributors: Contributor[]
+}
+
+export interface Contributor {
+  login: string
+  avatarUrl: string
+  contributions: number
+}
+
 export class GitHubStorage implements ContentsgartenStorage {
   owner: string
   repo: string
@@ -128,6 +143,63 @@ export class GitHubStorage implements ContentsgartenStorage {
       .filter((item) => item.type === 'blob')
       .map((item) => item.path!)
   }
+
+  async listContributors(
+    ctx: RequestContext,
+    path: string,
+  ): Promise<ListContributorsResult> {
+    const octokit = await resolveOctokit(ctx, this.config.app, this.config.repo)
+    const { owner, repo } = this
+    const { data } = await octokit.request('POST /graphql', {
+      query: `query($path: String!) {
+        repository(owner: "${owner}", name: "${repo}") {
+          object(expression: "${this.config.branch}") {
+            ... on Commit {
+              history(first: 100, path: $path) {
+                nodes {
+                  oid
+                  committedDate
+                  authors(first: 2) {
+                    nodes {
+                      user {
+                        avatarUrl(size: 64)
+                        login
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }`,
+      variables: {
+        path,
+      },
+    })
+    const commits = data.data.repository.object.history.nodes
+    const profileMap = new Map<string, Contributor>()
+    for (const commit of commits) {
+      for (const { user } of commit.authors.nodes) {
+        if (user.login.endsWith('[bot]')) continue
+        const profile = profileMap.get(user.login)
+        if (profile) {
+          profile.contributions++
+        } else {
+          profileMap.set(user.login, {
+            login: user.login,
+            avatarUrl: user.avatarUrl,
+            contributions: 1,
+          })
+        }
+      }
+    }
+    return {
+      contributors: Array.from(profileMap.values()).sort(
+        (a, b) => b.contributions - a.contributions,
+      ),
+    }
+  }
 }
 
 export interface GitHubStorageConfig {

packages/contentsgarten/src/testing.ts

@@ -1,11 +1,11 @@
+import { createHash } from 'crypto'
 import fs from 'fs'
 import path from 'path'
-import { createHash } from 'crypto'
-import { ContentsgartenStorage } from './ContentsgartenStorage'
-import { ContentsgartenAuth } from './ContentsgartenAuth'
-import { ContentsgartenTeamResolver } from './ContentsgartenTeamResolver'
 import { Contentsgarten } from './Contentsgarten'
+import { ContentsgartenAuth } from './ContentsgartenAuth'
 import { ContentsgartenPageDatabase } from './ContentsgartenPageDatabase'
+import { ContentsgartenStorage } from './ContentsgartenStorage'
+import { ContentsgartenTeamResolver } from './ContentsgartenTeamResolver'
 
 export namespace testing {
   export function createFakeStorage(): ContentsgartenStorage {
@@ -37,6 +37,9 @@ export namespace testing {
           lastModifiedBy: [],
         }
       },
+      async listContributors(ctx, filePath) {
+        return { contributors: [] }
+      },
     }
 
     function getFsPath(filePath: string) {