Skip to content

experiment(ask_gh): Support on demand indexing of GitHub repositories #785

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brendan-kellam merged 7 commits into from
Jan 23, 2026
Merged

experiment(ask_gh): Support on demand indexing of GitHub repositories #785

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
fd9973a
wip on ondemand indexing
brendan-kellam Dec 3, 2025
9f9ce5f
wip
brendan-kellam Jan 21, 2026
db8adf5
wip
brendan-kellam Jan 21, 2026
f8e5a84
feedback
brendan-kellam Jan 23, 2026
a8dc2ae
put behind feature flag
brendan-kellam Jan 23, 2026
82a6616
feedback
brendan-kellam Jan 23, 2026
c10e10d
fix build
brendan-kellam Jan 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions packages/backend/src/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ import z from 'zod';
import { ConnectionManager } from './connectionManager.js';
import { PromClient } from './promClient.js';
import { RepoIndexManager } from './repoIndexManager.js';
import { createGitHubRepoRecord } from './repoCompileUtils.js';
import { Octokit } from '@octokit/rest';

const logger = createLogger('api');
const PORT = 3060;
Expand All @@ -33,6 +35,7 @@ export class Api {

app.post('/api/sync-connection', this.syncConnection.bind(this));
app.post('/api/index-repo', this.indexRepo.bind(this));
app.post(`/api/experimental/add-github-repo`, this.addGithubRepo.bind(this));

this.server = app.listen(PORT, () => {
logger.info(`API server is running on port ${PORT}`);
Expand Down Expand Up @@ -92,6 +95,39 @@ export class Api {
res.status(200).json({ jobId });
}

private async addGithubRepo(req: Request, res: Response) {
const schema = z.object({
owner: z.string(),
repo: z.string(),
}).strict();
Comment on lines +100 to +103
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

# First, let's examine the file around the specified lines
cat -n packages/backend/src/api.ts | sed -n '95,110p'

Repository: sourcebot-dev/sourcebot

Length of output: 698

🏁 Script executed:

# Let's also check the full context of this schema usage
cat -n packages/backend/src/api.ts | sed -n '90,120p'

Repository: sourcebot-dev/sourcebot

Length of output: 1265

🌐 Web query:

Zod string trim() min() validation API documentation

💡 Result:

In Zod, both .trim() and .min() are chainable methods on z.string() schemas:

  • .trim(): a transformation that trims leading/trailing whitespace. Example shown in the official “Strings” guide: z.string().trim(); (commented “trim whitespace”). [1]
  • .min(length, options?): a validation that enforces a minimum string length. Example: z.string().min(5); and with a custom message: z.string().min(5, { message: "Must be 5 or more characters long" });. [1]

Typical usage to require a non-empty string after trimming:

import { z } from "zod";

const schema = z.string().trim().min(1, { message: "Required" });

(Chaining is the standard Zod API style—e.g., z.string().min(5).max(10).toLowerCase()). [2]

Sources: Zod strings guide [1], Zod v4 package docs [2].

Tighten owner/repo validation.

Empty strings (including whitespace-only strings) currently pass validation and would fail when passed to the GitHub API. Add .trim().min(1) to both fields to validate early and prevent unnecessary API calls.

🔧 Suggested fix 
-        const schema = z.object({
-            owner: z.string(),
-            repo: z.string(),
-        }).strict();
+        const schema = z.object({
+            owner: z.string().trim().min(1),
+            repo: z.string().trim().min(1),
+        }).strict();
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
const schema = z.object({
owner: z.string(),
repo: z.string(),
}).strict();
const schema = z.object({
owner: z.string().trim().min(1),
repo: z.string().trim().min(1),
}).strict();
🤖 Prompt for AI Agents 
In `@packages/backend/src/api.ts` around lines 100 - 103, The schema for request
validation (the const schema = z.object({...}).strict()) currently allows empty
or whitespace-only owner/repo strings; update the owner and repo validators to
z.string().trim().min(1) so they reject blank input before calling the GitHub
API, keeping the surrounding z.object(...) and .strict() intact; ensure both the
owner and repo properties are changed.


const parsed = schema.safeParse(req.body);
if (!parsed.success) {
res.status(400).json({ error: parsed.error.message });
return;
}

const octokit = new Octokit();
const response = await octokit.rest.repos.get({
owner: parsed.data.owner,
repo: parsed.data.repo,
});

const record = createGitHubRepoRecord({
repo: response.data,
hostUrl: 'https://github.com',
isAutoCleanupDisabled: true,
});

const repo = await this.prisma.repo.create({
data: record,
});

const [jobId ] = await this.repoIndexManager.createJobs([repo], RepoIndexingJobType.INDEX);

res.status(200).json({ jobId, repoId: repo.id });
Comment on lines +111 to +137
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

# Check if file exists and view the content around lines 111-137
if [ -f "packages/backend/src/api.ts" ]; then
  echo "File found. Checking lines 111-137:"
  sed -n '111,137p' packages/backend/src/api.ts
  echo ""
  echo "Broader context (lines 100-150):"
  wc -l packages/backend/src/api.ts
else
  echo "File not found. Searching for api.ts files:"
  find . -name "api.ts" -type f 2>/dev/null | head -20
fi

Repository: sourcebot-dev/sourcebot

Length of output: 1094

🏁 Script executed:

# Check for imports and logger availability
if [ -f "packages/backend/src/api.ts" ]; then
  echo "=== Imports and class context ==="
  head -50 packages/backend/src/api.ts
fi

Repository: sourcebot-dev/sourcebot

Length of output: 1925

🏁 Script executed:

# Search for existing error handling patterns in the codebase
echo "=== Searching for octokit usage patterns ==="
rg -A 5 "new Octokit" --type ts packages/backend/src/

Repository: sourcebot-dev/sourcebot

Length of output: 805

🌐 Web query:

Octokit JavaScript error handling status codes 404 403 429 rate limit

💡 Result:

In Octokit JS, GitHub API failures are typically thrown as a RequestError with:

  • error.status = HTTP status code
  • error.response = { status, url, headers, data } (when a response exists) (npm.io)

How to interpret / handle the status codes

404 Not Found

  • Resource/route doesn’t exist or GitHub is intentionally hiding a private/inaccessible resource behind a 404 (common pattern). Handle as “missing or not accessible,” and double-check owner/repo names, endpoint, and auth scopes.

403 Forbidden

  • Usually “insufficient permissions / policy” or rate limiting (GitHub may return 403 or 429 when you exceed primary/secondary rate limits). (docs.github.com)
  • For rate limiting, inspect headers and message (see below).

429 Too Many Requests

  • Rate limiting (primary or secondary). GitHub documents that exceeding rate limits can return 403 or 429. (docs.github.com)

Rate limit signals to check (403/429)

GitHub’s guidance when rate-limited: (docs.github.com)

  • x-ratelimit-remaining: 0 ⇒ wait until x-ratelimit-reset (UTC epoch seconds)
  • retry-after (if present) ⇒ wait that many seconds (often for secondary rate limits)
  • Secondary rate limit responses include a message indicating you exceeded a secondary rate limit; if no retry-after, GitHub recommends waiting at least ~60 seconds, then backing off more if it persists. (docs.github.com)

Practical Octokit pattern

try {
  await octokit.request("GET /repos/{owner}/{repo}", { owner, repo });
} catch (error) {
  if (!error.status) throw error; // not an Octokit HTTP error

  const status = error.status;
  const headers = error.response?.headers || {};
  const message = error.response?.data?.message;

  if (status === 404) {
    // not found OR not accessible
  } else if (status === 403 || status === 429) {
    const remaining = headers["x-ratelimit-remaining"];
    const reset = headers["x-ratelimit-reset"];
    const retryAfter = headers["retry-after"];
    // decide whether this is rate limit vs permissions by checking remaining/message
  } else {
    // other HTTP errors
  }
}

Best practice: let Octokit throttle for you

If you want automatic handling/retries for rate limits, use @octokit/plugin-throttling, which provides hooks like onRateLimit and onSecondaryRateLimit and computes retryAfter from retry-after / x-ratelimit-reset. (github.com)

Citations:

Handle GitHub API failures explicitly and prefer authenticated Octokit.

The octokit.rest.repos.get() call at lines 116–119 has no error handling. GitHub API failures will surface as 500s instead of appropriate status codes, and unauthenticated calls are rate-limited to 60 requests/hour (vs. 5000 authenticated), which will cause silent failures. Use a configured GITHUB_TOKEN when available and catch specific status codes (404, 403, 429) to return correct HTTP responses.

🛠️ Proposed handling 
-        const octokit = new Octokit();
-        const response = await octokit.rest.repos.get({
-            owner: parsed.data.owner,
-            repo: parsed.data.repo,
-        });
+        const octokit = process.env.GITHUB_TOKEN
+            ? new Octokit({ auth: process.env.GITHUB_TOKEN })
+            : new Octokit();
+
+        let response;
+        try {
+            response = await octokit.rest.repos.get({
+                owner: parsed.data.owner,
+                repo: parsed.data.repo,
+            });
+        } catch (err: any) {
+            const status = err?.status;
+            if (status === 404) {
+                res.status(404).json({ error: 'GitHub repo not found' });
+                return;
+            }
+            if (status === 401 || status === 403) {
+                res.status(403).json({ error: 'GitHub access denied' });
+                return;
+            }
+            if (status === 429) {
+                res.status(429).json({ error: 'GitHub rate limit exceeded' });
+                return;
+            }
+            logger.error({ err }, 'GitHub API request failed');
+            res.status(502).json({ error: 'GitHub API error' });
+            return;
+        }
🤖 Prompt for AI Agents 
In `@packages/backend/src/api.ts` around lines 111 - 137, Replace the
unauthenticated, unhandled GitHub call by instantiating Octokit with
process.env.GITHUB_TOKEN when present (use the Octokit constructor) and wrap the
octokit.rest.repos.get(...) call in a try/catch; on error inspect err.status (or
err.statusCode) and return matching HTTP responses for 404 (res.status(404)),
403 (res.status(403)), and 429 (res.status(429)) with a helpful message, and for
other errors return a 502/500 as appropriate; keep the subsequent
createGitHubRepoRecord(...), prisma.repo.upsert(...) and
repoIndexManager.createJobs(...) logic but only run them after a successful repo
fetch.

}

public async dispose() {
return new Promise<void>((resolve, reject) => {
this.server.close((err) => {
Expand Down
119 changes: 73 additions & 46 deletions packages/backend/src/repoCompileUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { GithubConnectionConfig } from '@sourcebot/schemas/v3/github.type';
import { getGitHubReposFromConfig } from "./github.js";
import { getGitHubReposFromConfig, OctokitRepository } from "./github.js";
import { getGitLabReposFromConfig } from "./gitlab.js";
import { getGiteaReposFromConfig } from "./gitea.js";
import { getGerritReposFromConfig } from "./gerrit.js";
Expand Down Expand Up @@ -62,60 +62,23 @@ export const compileGithubConfig = async (
const warnings = gitHubReposResult.warnings;

const hostUrl = config.url ?? 'https://github.com';
const repoNameRoot = new URL(hostUrl)
.toString()
.replace(/^https?:\/\//, '');

const repos = gitHubRepos.map((repo) => {
const repoDisplayName = repo.full_name;
const repoName = path.join(repoNameRoot, repoDisplayName);
const cloneUrl = new URL(repo.clone_url!);
const isPublic = repo.private === false;

logger.debug(`Found github repo ${repoDisplayName} with webUrl: ${repo.html_url}`);
const record = createGitHubRepoRecord({
repo,
hostUrl,
branches: config.revisions?.branches ?? undefined,
tags: config.revisions?.tags ?? undefined,
})

const record: RepoData = {
external_id: repo.id.toString(),
external_codeHostType: 'github',
external_codeHostUrl: hostUrl,
cloneUrl: cloneUrl.toString(),
webUrl: repo.html_url,
name: repoName,
displayName: repoDisplayName,
imageUrl: repo.owner.avatar_url,
isFork: repo.fork,
isArchived: !!repo.archived,
isPublic: isPublic,
org: {
connect: {
id: SINGLE_TENANT_ORG_ID,
},
},
return {
...record,
connections: {
create: {
connectionId: connectionId,
}
},
metadata: {
gitConfig: {
'zoekt.web-url-type': 'github',
'zoekt.web-url': repo.html_url,
'zoekt.name': repoName,
'zoekt.github-stars': (repo.stargazers_count ?? 0).toString(),
'zoekt.github-watchers': (repo.watchers_count ?? 0).toString(),
'zoekt.github-subscribers': (repo.subscribers_count ?? 0).toString(),
'zoekt.github-forks': (repo.forks_count ?? 0).toString(),
'zoekt.archived': marshalBool(repo.archived),
'zoekt.fork': marshalBool(repo.fork),
'zoekt.public': marshalBool(isPublic),
'zoekt.display-name': repoDisplayName,
},
branches: config.revisions?.branches ?? undefined,
tags: config.revisions?.tags ?? undefined,
} satisfies RepoMetadata,
};

return record;
})

return {
Expand All @@ -124,6 +87,70 @@ export const compileGithubConfig = async (
};
}

export const createGitHubRepoRecord = ({
repo,
hostUrl,
branches,
tags,
isAutoCleanupDisabled,
}: {
repo: OctokitRepository,
hostUrl: string,
branches?: string[],
tags?: string[],
isAutoCleanupDisabled?: boolean,
}) => {
const repoNameRoot = new URL(hostUrl)
.toString()
.replace(/^https?:\/\//, '');

const repoDisplayName = repo.full_name;
const repoName = path.join(repoNameRoot, repoDisplayName);
const cloneUrl = new URL(repo.clone_url!);
const isPublic = repo.private === false;

logger.debug(`Found github repo ${repoDisplayName} with webUrl: ${repo.html_url}`);

const record: Prisma.RepoCreateInput = {
external_id: repo.id.toString(),
external_codeHostType: 'github',
external_codeHostUrl: hostUrl,
cloneUrl: cloneUrl.toString(),
webUrl: repo.html_url,
name: repoName,
displayName: repoDisplayName,
imageUrl: repo.owner.avatar_url,
isFork: repo.fork,
isArchived: !!repo.archived,
isPublic: isPublic,
isAutoCleanupDisabled,
org: {
connect: {
id: SINGLE_TENANT_ORG_ID,
},
},
metadata: {
gitConfig: {
'zoekt.web-url-type': 'github',
'zoekt.web-url': repo.html_url,
'zoekt.name': repoName,
'zoekt.github-stars': (repo.stargazers_count ?? 0).toString(),
'zoekt.github-watchers': (repo.watchers_count ?? 0).toString(),
'zoekt.github-subscribers': (repo.subscribers_count ?? 0).toString(),
'zoekt.github-forks': (repo.forks_count ?? 0).toString(),
'zoekt.archived': marshalBool(repo.archived),
'zoekt.fork': marshalBool(repo.fork),
'zoekt.public': marshalBool(isPublic),
'zoekt.display-name': repoDisplayName,
},
branches,
tags,
} satisfies RepoMetadata,
};

return record;
}

export const compileGitlabConfig = async (
config: GitlabConnectionConfig,
connectionId: number): Promise<CompileResult> => {
Expand Down
1 change: 1 addition & 0 deletions packages/backend/src/repoIndexManager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,7 @@ export class RepoIndexManager {
connections: {
none: {}
},
isAutoCleanupDisabled: false,
OR: [
{ indexedAt: null },
{ indexedAt: { lt: gcGracePeriodMs } },
Expand Down
2 changes: 2 additions & 0 deletions ...a/migrations/20260121012745_add_is_auto_cleanup_disabled_flag_to_repo_table/migration.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
-- AlterTable
ALTER TABLE "Repo" ADD COLUMN "isAutoCleanupDisabled" BOOLEAN NOT NULL DEFAULT false;
Comment thread
brendan-kellam marked this conversation as resolved.
27 changes: 14 additions & 13 deletions packages/db/prisma/schema.prisma
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,19 +45,20 @@ enum CodeHostType {
}

model Repo {
id Int @id @default(autoincrement())
name String /// Full repo name, including the vcs hostname (ex. github.com/sourcebot-dev/sourcebot)
displayName String? /// Display name of the repo for UI (ex. sourcebot-dev/sourcebot)
createdAt DateTime @default(now())
updatedAt DateTime @updatedAt
isFork Boolean
isArchived Boolean
isPublic Boolean @default(false)
metadata Json /// For schema see repoMetadataSchema in packages/shared/src/types.ts
cloneUrl String
webUrl String?
connections RepoToConnection[]
imageUrl String?
id Int @id @default(autoincrement())
name String /// Full repo name, including the vcs hostname (ex. github.com/sourcebot-dev/sourcebot)
displayName String? /// Display name of the repo for UI (ex. sourcebot-dev/sourcebot)
createdAt DateTime @default(now())
updatedAt DateTime @updatedAt
isFork Boolean
isArchived Boolean
isPublic Boolean @default(false)
isAutoCleanupDisabled Boolean @default(false) /// If true, automatic cleanup of this repo when it becomes orphaned will be disabled.
metadata Json /// For schema see repoMetadataSchema in packages/shared/src/types.ts
cloneUrl String
webUrl String?
connections RepoToConnection[]
imageUrl String?

permittedAccounts AccountToRepoPermission[]
permissionSyncJobs RepoPermissionSyncJob[]
Expand Down
34 changes: 34 additions & 0 deletions packages/web/src/app/[domain]/askgh/[owner]/[repo]/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
import 'server-only';

import { sew } from '@/actions';
import { notFound, ServiceError } from '@/lib/serviceError';
import { withOptionalAuthV2 } from '@/withAuthV2';
import { RepoInfo } from './types';

export const getRepoInfo = async (repoId: number): Promise<RepoInfo | ServiceError> => sew(() =>
withOptionalAuthV2(async ({ prisma }) => {
const repo = await prisma.repo.findUnique({
where: { id: repoId },
include: {
jobs: {
orderBy: {
createdAt: 'desc',
},
take: 1,
},
},
});

if (!repo) {
return notFound();
}

return {
id: repo.id,
name: repo.name,
displayName: repo.displayName,
imageUrl: repo.imageUrl,
isIndexed: repo.indexedAt !== null,
};
})
)
107 changes: 107 additions & 0 deletions packages/web/src/app/[domain]/askgh/[owner]/[repo]/components/landingPage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
'use client';

import Image from 'next/image';
import { SearchModeSelector } from "@/app/[domain]/components/searchModeSelector";
import { Separator } from "@/components/ui/separator";
import { ChatBox } from "@/features/chat/components/chatBox";
import { ChatBoxToolbar } from "@/features/chat/components/chatBox/chatBoxToolbar";
import { NotConfiguredErrorBanner } from "@/features/chat/components/notConfiguredErrorBanner";
import { LanguageModelInfo, RepoSearchScope } from "@/features/chat/types";
import { useCreateNewChatThread } from "@/features/chat/useCreateNewChatThread";
import { getRepoImageSrc } from '@/lib/utils';
import { useMemo, useState } from "react";

interface LandingPageProps {
languageModels: LanguageModelInfo[];
repoName: string;
repoDisplayName?: string;
imageUrl?: string | null;
repoId: number;
}

export const LandingPage = ({
languageModels,
repoName,
repoDisplayName,
imageUrl,
repoId,
}: LandingPageProps) => {
const { createNewChatThread, isLoading } = useCreateNewChatThread();
const [isContextSelectorOpen, setIsContextSelectorOpen] = useState(false);
const isChatBoxDisabled = languageModels.length === 0;

const selectedSearchScopes = useMemo(() => [
{
type: 'repo',
name: repoDisplayName ?? repoName,
value: repoName,
codeHostType: 'github' as const,
} satisfies RepoSearchScope,
], [repoDisplayName, repoName]);

const imageSrc = imageUrl ? getRepoImageSrc(imageUrl, repoId) : undefined;
const displayName = repoDisplayName ?? repoName;

return (
<div className="min-h-screen flex flex-col justify-between p-4">
{/* Center Section - Repository Info */}
<div className="flex-1 flex items-center justify-center">
<div className="flex items-center gap-4">
{imageSrc && (
<Image
src={imageSrc}
alt={`${displayName} avatar`}
width={32}
height={32}
className="rounded-lg"
unoptimized={imageSrc.startsWith('/api/')}
/>
)}
<h1 className="text-2xl font-bold">{displayName}</h1>
</div>
</div>

{/* Bottom Section - ChatBox */}
<div className="flex justify-center pb-8">
<div className="w-full max-w-[800px]">
<div className="border rounded-md w-full shadow-sm">
<ChatBox
onSubmit={(children) => {
createNewChatThread(children, selectedSearchScopes);
}}
className="min-h-[50px]"
isRedirecting={isLoading}
languageModels={languageModels}
selectedSearchScopes={selectedSearchScopes}
searchContexts={[]}
onContextSelectorOpenChanged={setIsContextSelectorOpen}
isDisabled={isChatBoxDisabled}
/>
<Separator />
<div className="relative">
<div className="w-full flex flex-row items-center bg-accent rounded-b-md px-2">
<ChatBoxToolbar
languageModels={languageModels}
repos={[]}
searchContexts={[]}
selectedSearchScopes={selectedSearchScopes}
onSelectedSearchScopesChange={() => {}}
isContextSelectorOpen={isContextSelectorOpen}
onContextSelectorOpenChanged={setIsContextSelectorOpen}
/>
<SearchModeSelector
searchMode="agentic"
className="ml-auto"
/>
</div>
</div>
</div>

{isChatBoxDisabled && (
<NotConfiguredErrorBanner className="mt-4" />
)}
</div>
</div>
</div>
)
}
Loading