improve type safety for repo metadata json

Author: brendan-kellam

packages/backend/src/repoManager.ts

@@ -3,7 +3,7 @@ import { Redis } from 'ioredis';
 import { createLogger } from "./logger.js";
 import { Connection, PrismaClient, Repo, RepoToConnection, RepoIndexingStatus, StripeSubscriptionStatus } from "@sourcebot/db";
 import { GithubConnectionConfig, GitlabConnectionConfig, GiteaConnectionConfig } from '@sourcebot/schemas/v3/connection.type';
-import { AppContext, Settings, RepoMetadata } from "./types.js";
+import { AppContext, Settings, repoMetadataSchema } from "./types.js";
 import { getRepoPath, getTokenFromConfig, measure, getShardPrefix } from "./utils.js";
 import { cloneRepository, fetchRepository, upsertGitConfig } from "./git.js";
 import { existsSync, readdirSync, promises } from 'fs';
@@ -200,8 +200,7 @@ export class RepoManager implements IRepoManager {
         let cloneDuration_s: number | undefined = undefined;
 
         const repoPath = getRepoPath(repo, this.ctx);
-        const metadata = repo.metadata as RepoMetadata;
-
+        const metadata = repoMetadataSchema.parse(repo.metadata);
 
         // If the repo was already in the indexing state, this job was likely killed and picked up again. As a result,
         // to ensure the repo state is valid, we delete the repo if it exists so we get a fresh clone 

packages/backend/src/types.ts

@@ -1,4 +1,5 @@
 import { Settings as SettingsSchema } from "@sourcebot/schemas/v3/index.type";
+import { z } from "zod";
 
 export type AppContext = {
     /**
@@ -16,28 +17,32 @@ export type AppContext = {
 
 export type Settings = Required<SettingsSchema>;
 
-/**
- * Structure of the `metadata` field in the `Repo` table.
- */
-export type RepoMetadata = {
+// Structure of the `metadata` field in the `Repo` table.
+//
+// @WARNING: If you modify this schema, please make sure it is backwards
+// compatible with any prior versions of the schema!!
+// @NOTE: If you move this schema, please update the comment in schema.prisma
+// to point to the new location.
+export const repoMetadataSchema = z.object({
     /**
      * A set of key-value pairs that will be used as git config
      * variables when cloning the repo.
      * @see: https://git-scm.com/docs/git-clone#Documentation/git-clone.txt-code--configcodecodeltkeygtltvaluegtcode
      */
-    gitConfig?: Record<string, string>;
+    gitConfig: z.record(z.string(), z.string()).optional(),
 
     /**
      * A list of branches to index. Glob patterns are supported.
      */
-    branches?: string[];
+    branches: z.array(z.string()).optional(),
 
     /**
      * A list of tags to index. Glob patterns are supported.
      */
-    tags?: string[];
-}
+    tags: z.array(z.string()).optional(),
+});
 
+export type RepoMetadata = z.infer<typeof repoMetadataSchema>;
 
 // @see : https://stackoverflow.com/a/61132308
 export type DeepPartial<T> = T extends object ? {

packages/backend/src/zoekt.ts

@@ -1,5 +1,5 @@
 import { exec } from "child_process";
-import { AppContext, RepoMetadata, Settings } from "./types.js";
+import { AppContext, repoMetadataSchema, Settings } from "./types.js";
 import { Repo } from "@sourcebot/db";
 import { getRepoPath } from "./utils.js";
 import { getShardPrefix } from "./utils.js";
@@ -17,7 +17,7 @@ export const indexGitRepository = async (repo: Repo, settings: Settings, ctx: Ap
 
     const repoPath = getRepoPath(repo, ctx);
     const shardPrefix = getShardPrefix(repo.orgId, repo.id);
-    const metadata = repo.metadata as RepoMetadata;
+    const metadata = repoMetadataSchema.parse(repo.metadata);
 
     if (metadata.branches) {
         const branchGlobs = metadata.branches

packages/db/prisma/schema.prisma

@@ -43,7 +43,7 @@ model Repo {
   indexedAt          DateTime?
   isFork             Boolean
   isArchived         Boolean
-  metadata           Json
+  metadata           Json // For schema see repoMetadataSchema in packages/backend/src/types.ts
   cloneUrl           String
   webUrl             String?
   connections        RepoToConnection[]