Add back revision support#215

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 3 commits into from
Feb 27, 2025
Merged

Add back revision support #215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4986006
Store config branches/tags information in repo field. Get branch inf…
brendan-kellam Feb 27, 2025
8f6b05c
remove slow client side hack
brendan-kellam Feb 27, 2025
f2aa63f
feedback
brendan-kellam Feb 27, 2025
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
17 changes: 17 additions & 0 deletions packages/backend/src/git.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,3 +39,20 @@ export const fetchRepository = async (path: string, onProgress?: (event: SimpleG
]
);
}

export const getBranches = async (path: string) => {
const git = simpleGit();
const branches = await git.cwd({
path,
}).branch();

return branches.all;
}

export const getTags = async (path: string) => {
const git = simpleGit();
const tags = await git.cwd({
path,
}).tags();
return tags.all;
}
77 changes: 1 addition & 76 deletions packages/backend/src/gitea.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { Api, giteaApi, HttpResponse, Repository as GiteaRepository } from 'gitea-js';
import { GiteaConnectionConfig } from '@sourcebot/schemas/v3/gitea.type';
import { getTokenFromConfig, measure, fetchWithRetry } from './utils.js';
import { getTokenFromConfig, measure } from './utils.js';
import fetch from 'cross-fetch';
import { createLogger } from './logger.js';
import micromatch from 'micromatch';
Expand DownExpand Up@@ -56,49 +56,6 @@ export const getGiteaReposFromConfig = async (config: GiteaConnectionConfig, org
return true;
});


if (config.revisions) {
if (config.revisions.branches) {
const branchGlobs = config.revisions.branches;
allRepos = await Promise.all(
allRepos.map(async (repo) => {
const [owner, name] = repo.full_name!.split('/');
let branches = (await fetchWithRetry(
() => getBranchesForRepo(owner, name, api),
`branches for ${owner}/${name}`,
logger
)).map(branch => branch.name!);
branches = micromatch.match(branches, branchGlobs);

return {
...repo,
branches,
};
})
)
}

if (config.revisions.tags) {
const tagGlobs = config.revisions.tags;
allRepos = await Promise.all(
allRepos.map(async (allRepos) => {
const [owner, name] = allRepos.full_name!.split('/');
let tags = (await fetchWithRetry(
() => getTagsForRepo(owner, name, api),
`tags for ${owner}/${name}`,
logger
)).map(tag => tag.name!);
tags = micromatch.match(tags, tagGlobs);

return {
...allRepos,
tags,
};
})
)
}
}

let repos = allRepos
.filter((repo) => {
const isExcluded = shouldExcludeRepo({
Expand DownExpand Up@@ -158,38 +115,6 @@ const shouldExcludeRepo = ({
return shouldExclude;
}

const getTagsForRepo = async <T>(owner: string, repo: string, api: Api<T>) => {
try {
logger.debug(`Fetching tags for repo ${owner}/${repo}...`);
const { durationMs, data: tags } = await measure(() =>
paginate((page) => api.repos.repoListTags(owner, repo, {
page
}))
);
logger.debug(`Found ${tags.length} tags in repo ${owner}/${repo} in ${durationMs}ms.`);
return tags;
} catch (e) {
logger.error(`Failed to fetch tags for repo ${owner}/${repo}.`, e);
throw e;
}
}

const getBranchesForRepo = async <T>(owner: string, repo: string, api: Api<T>) => {
try {
logger.debug(`Fetching branches for repo ${owner}/${repo}...`);
const { durationMs, data: branches } = await measure(() =>
paginate((page) => api.repos.repoListBranches(owner, repo, {
page
}))
);
logger.debug(`Found ${branches.length} branches in repo ${owner}/${repo} in ${durationMs}ms.`);
return branches;
} catch (e) {
logger.error(`Failed to fetch branches for repo ${owner}/${repo}.`, e);
throw e;
}
}

const getReposOwnedByUsers = async <T>(users: string[], api: Api<T>) => {
const results = await Promise.allSettled(users.map(async (user) => {
try {
Expand Down
1 change: 1 addition & 0 deletions packages/backend/src/posthogEvents.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ export type PosthogEventMap = {
connectionId: number,
repoCount: number,
},
revisions_truncated: {},
//////////////////////////////////////////////////////////////////
}

Expand Down
2 changes: 1 addition & 1 deletion packages/backend/src/promClient.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import express, { Request, Response } from 'express';
import client, { Registry, Counter, Gauge, Histogram } from 'prom-client';
import client, { Registry, Counter, Gauge } from 'prom-client';

export class PromClient {
private registry: Registry;
Expand Down
83 changes: 49 additions & 34 deletions packages/backend/src/repoCompileUtils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { Prisma, PrismaClient } from '@sourcebot/db';
import { WithRequired } from "./types.js"
import { marshalBool } from "./utils.js";
import { GerritConnectionConfig, GiteaConnectionConfig, GitlabConnectionConfig } from '@sourcebot/schemas/v3/connection.type';
import { RepoMetadata } from './types.js';

export type RepoData = WithRequired<Prisma.RepoCreateInput, 'connections'>;

Expand DownExpand Up@@ -54,17 +55,21 @@ export const compileGithubConfig = async (
}
},
metadata: {
'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(repo.private === false)
},
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(repo.private === false),
},
branches: config.revisions?.branches ?? undefined,
tags: config.revisions?.tags ?? undefined,
} satisfies RepoMetadata,
};

return record;
Expand DownExpand Up@@ -113,15 +118,19 @@ export const compileGitlabConfig = async (
}
},
metadata: {
'zoekt.web-url-type': 'gitlab',
'zoekt.web-url': projectUrl,
'zoekt.name': project.path_with_namespace,
'zoekt.gitlab-stars': (project.stargazers_count ?? 0).toString(),
'zoekt.gitlab-forks': (project.forks_count ?? 0).toString(),
'zoekt.archived': marshalBool(project.archived),
'zoekt.fork': marshalBool(isFork),
'zoekt.public': marshalBool(project.private === false)
},
gitConfig: {
'zoekt.web-url-type': 'gitlab',
'zoekt.web-url': projectUrl,
'zoekt.name': project.path_with_namespace,
'zoekt.gitlab-stars': (project.stargazers_count ?? 0).toString(),
'zoekt.gitlab-forks': (project.forks_count ?? 0).toString(),
'zoekt.archived': marshalBool(project.archived),
'zoekt.fork': marshalBool(isFork),
'zoekt.public': marshalBool(project.private === false)
},
branches: config.revisions?.branches ?? undefined,
tags: config.revisions?.tags ?? undefined,
} satisfies RepoMetadata,
};

return record;
Expand DownExpand Up@@ -168,13 +177,17 @@ export const compileGiteaConfig = async (
}
},
metadata: {
'zoekt.web-url-type': 'gitea',
'zoekt.web-url': repo.html_url!,
'zoekt.name': repo.full_name!,
'zoekt.archived': marshalBool(repo.archived),
'zoekt.fork': marshalBool(repo.fork!),
'zoekt.public': marshalBool(repo.internal === false && repo.private === false),
},
gitConfig: {
'zoekt.web-url-type': 'gitea',
'zoekt.web-url': repo.html_url!,
'zoekt.name': repo.full_name!,
'zoekt.archived': marshalBool(repo.archived),
'zoekt.fork': marshalBool(repo.fork!),
'zoekt.public': marshalBool(repo.internal === false && repo.private === false),
},
branches: config.revisions?.branches ?? undefined,
tags: config.revisions?.tags ?? undefined,
} satisfies RepoMetadata,
};

return record;
Expand DownExpand Up@@ -227,13 +240,15 @@ export const compileGerritConfig = async (
}
},
metadata: {
'zoekt.web-url-type': 'gitiles',
'zoekt.web-url': webUrl,
'zoekt.name': repoId,
'zoekt.archived': marshalBool(false),
'zoekt.fork': marshalBool(false),
'zoekt.public': marshalBool(true),
},
gitConfig: {
'zoekt.web-url-type': 'gitiles',
'zoekt.web-url': webUrl,
'zoekt.name': repoId,
'zoekt.archived': marshalBool(false),
'zoekt.fork': marshalBool(false),
'zoekt.public': marshalBool(true),
},
} satisfies RepoMetadata,
};

return record;
Expand Down
6 changes: 3 additions & 3 deletions packages/backend/src/repoManager.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 } from "./types.js";
import { AppContext, Settings, RepoMetadata } from "./types.js";
import { getRepoPath, getTokenFromConfig, measure, getShardPrefix } from "./utils.js";
import { cloneRepository, fetchRepository } from "./git.js";
import { existsSync, rmSync, readdirSync, rm } from 'fs';
Expand DownExpand Up@@ -187,7 +187,7 @@ export class RepoManager implements IRepoManager {
let cloneDuration_s: number | undefined = undefined;

const repoPath = getRepoPath(repo, this.ctx);
const metadata = repo.metadata as Record<string, string>;
const metadata = repo.metadata as RepoMetadata;

// 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
Expand DownExpand Up@@ -223,7 +223,7 @@ export class RepoManager implements IRepoManager {
cloneUrl = url.toString();
}

const { durationMs } = await measure(() => cloneRepository(cloneUrl, repoPath, metadata, ({ method, stage, progress }) => {
const { durationMs } = await measure(() => cloneRepository(cloneUrl, repoPath, metadata.gitConfig, ({ method, stage, progress }) => {
//this.logger.info(`git.${method} ${stage} stage ${progress}% complete for ${repo.id}`)
}));
cloneDuration_s = durationMs / 1000;
Expand Down
23 changes: 23 additions & 0 deletions packages/backend/src/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,6 +49,29 @@ export type Settings = {
gcGracePeriodMs: number;
}

/**
* Structure of the `metadata` field in the `Repo` table.
*/
export type RepoMetadata = {
/**
* 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>;

/**
* A list of branches to index. Glob patterns are supported.
*/
branches?: string[];

/**
* A list of tags to index. Glob patterns are supported.
*/
tags?: string[];
}


// @see : https://stackoverflow.com/a/61132308
export type DeepPartial<T> = T extends object ? {
[P in keyof T]?: DeepPartial<T[P]>;
Expand Down
54 changes: 50 additions & 4 deletions packages/backend/src/zoekt.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,63 @@
import { exec } from "child_process";
import { AppContext } from "./types.js";
import { AppContext, RepoMetadata } from "./types.js";
import { Repo } from "@sourcebot/db";
import { getRepoPath } from "./utils.js";
import { DEFAULT_SETTINGS } from "./constants.js";
import { getShardPrefix } from "./utils.js";
import { getBranches, getTags } from "./git.js";
import micromatch from "micromatch";
import { createLogger } from "./logger.js";
import { captureEvent } from "./posthog.js";

const logger = createLogger('zoekt');

export const indexGitRepository = async (repo: Repo, ctx: AppContext) => {
const revisions = [
let revisions = [
'HEAD'
];

const shardPrefix = getShardPrefix(repo.orgId, repo.id);

const repoPath = getRepoPath(repo, ctx);
const shardPrefix = getShardPrefix(repo.orgId, repo.id);
const metadata = repo.metadata as RepoMetadata;

if (metadata.branches) {
const branchGlobs = metadata.branches
const allBranches = await getBranches(repoPath);
const matchingBranches =
allBranches
.filter((branch) => micromatch.isMatch(branch, branchGlobs))
.map((branch) => `refs/heads/${branch}`);

revisions = [
...revisions,
...matchingBranches
];
}

if (metadata.tags) {
const tagGlobs = metadata.tags;
const allTags = await getTags(repoPath);
const matchingTags =
allTags
.filter((tag) => micromatch.isMatch(tag, tagGlobs))
.map((tag) => `refs/tags/${tag}`);

revisions = [
...revisions,
...matchingTags
];
}

// zoekt has a limit of 64 branches/tags to index.
if (revisions.length > 64) {
logger.warn(`Too many revisions (${revisions.length}) for repo ${repo.id}, truncating to 64`);
Comment thread
brendan-kellam marked this conversation as resolved.
captureEvent('backend_revisions_truncated', {
repoId: repo.id,
revisionCount: revisions.length,
});
revisions = revisions.slice(0, 64);
}

const command = `zoekt-git-index -allow_missing_branches -index ${ctx.indexPath} -file_limit ${DEFAULT_SETTINGS.maxFileSize} -branches ${revisions.join(',')} -tenant_id ${repo.orgId} -shard_prefix ${shardPrefix} ${repoPath}`;

return new Promise<{ stdout: string, stderr: string }>((resolve, reject) => {
Expand Down
6 changes: 3 additions & 3 deletions packages/schemas/src/v3/connection.schema.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -154,11 +154,11 @@ const schema = {
},
"revisions": {
"type": "object",
"description": "The revisions (branches, tags) that should be included when indexing. The default branch (HEAD) is always indexed.",
"description": "The revisions (branches, tags) that should be included when indexing. The default branch (HEAD) is always indexed. A maximum of 64 revisions can be indexed, with any additional revisions being ignored.",
"properties": {
"branches": {
"type": "array",
"description": "List of branches to include when indexing. For a given repo, only the branches that exist on the repo's remote *and* match at least one of the provided `branches` will be indexed. The default branch (HEAD) is always indexed. Glob patterns are supported.",
"description": "List of branches to include when indexing. For a given repo, only the branches that exist on the repo's remote *and* match at least one of the provided `branches` will be indexed. The default branch (HEAD) is always indexed. Glob patterns are supported. A maximum of 64 branches can be indexed, with any additional branches being ignored.",
"items": {
"type": "string"
},
Expand All@@ -175,7 +175,7 @@ const schema = {
},
"tags": {
"type": "array",
"description": "List of tags to include when indexing. For a given repo, only the tags that exist on the repo's remote *and* match at least one of the provided `tags` will be indexed. Glob patterns are supported.",
"description": "List of tags to include when indexing. For a given repo, only the tags that exist on the repo's remote *and* match at least one of the provided `tags` will be indexed. Glob patterns are supported. A maximum of 64 tags can be indexed, with any additional tags being ignored.",
"items": {
"type": "string"
},
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Add back revision support#215

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 3 commits into

from

Feb 27, 2025
 Merged


Add back revision support
#215
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4986006

Store config branches/tags information in repo field. Get branch inf…


brendan-kellam Feb 27, 2025
8f6b05c

remove slow client side hack


brendan-kellam Feb 27, 2025
f2aa63f

feedback


brendan-kellam Feb 27, 2025

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


17 changes: 17 additions & 0 deletions
packages/backend/src/git.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,3 +39,20 @@ export const fetchRepository = async (path: string, onProgress?: (event: SimpleG
 ]
 );
}

export const getBranches = async (path: string) => {
 const git = simpleGit();
 const branches = await git.cwd({
 path,
 }).branch();

 return branches.all;
}

export const getTags = async (path: string) => {
 const git = simpleGit();
 const tags = await git.cwd({
 path,
 }).tags();
 return tags.all;
}

77 changes: 1 addition & 76 deletions
packages/backend/src/gitea.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { Api, giteaApi, HttpResponse, Repository as GiteaRepository } from 'gitea-js';
import { GiteaConnectionConfig } from '@sourcebot/schemas/v3/gitea.type';
import { getTokenFromConfig, measure, fetchWithRetry } from './utils.js';
import { getTokenFromConfig, measure } from './utils.js';
import fetch from 'cross-fetch';
import { createLogger } from './logger.js';
import micromatch from 'micromatch';
Expand DownExpand Up@@ -56,49 +56,6 @@ export const getGiteaReposFromConfig = async (config: GiteaConnectionConfig, org
 return true;
 });


 if (config.revisions) {
 if (config.revisions.branches) {
 const branchGlobs = config.revisions.branches;
 allRepos = await Promise.all(
 allRepos.map(async (repo) => {
 const [owner, name] = repo.full_name!.split('/');
 let branches = (await fetchWithRetry(
 () => getBranchesForRepo(owner, name, api),
 `branches for ${owner}/${name}`,
 logger
 )).map(branch => branch.name!);
 branches = micromatch.match(branches, branchGlobs);

 return {
 ...repo,
 branches,
 };
 })
 )
 }

 if (config.revisions.tags) {
 const tagGlobs = config.revisions.tags;
 allRepos = await Promise.all(
 allRepos.map(async (allRepos) => {
 const [owner, name] = allRepos.full_name!.split('/');
 let tags = (await fetchWithRetry(
 () => getTagsForRepo(owner, name, api),
 `tags for ${owner}/${name}`,
 logger
 )).map(tag => tag.name!);
 tags = micromatch.match(tags, tagGlobs);

 return {
 ...allRepos,
 tags,
 };
 })
 )
 }
 }

 let repos = allRepos
 .filter((repo) => {
 const isExcluded = shouldExcludeRepo({
Expand DownExpand Up@@ -158,38 +115,6 @@ const shouldExcludeRepo = ({
 return shouldExclude;
}

const getTagsForRepo = async <T>(owner: string, repo: string, api: Api<T>) => {
 try {
 logger.debug(`Fetching tags for repo ${owner}/${repo}...`);
 const { durationMs, data: tags } = await measure(() =>
 paginate((page) => api.repos.repoListTags(owner, repo, {
 page
 }))
 );
 logger.debug(`Found ${tags.length} tags in repo ${owner}/${repo} in ${durationMs}ms.`);
 return tags;
 } catch (e) {
 logger.error(`Failed to fetch tags for repo ${owner}/${repo}.`, e);
 throw e;
 }
}

const getBranchesForRepo = async <T>(owner: string, repo: string, api: Api<T>) => {
 try {
 logger.debug(`Fetching branches for repo ${owner}/${repo}...`);
 const { durationMs, data: branches } = await measure(() => 
 paginate((page) => api.repos.repoListBranches(owner, repo, {
 page
 }))
 );
 logger.debug(`Found ${branches.length} branches in repo ${owner}/${repo} in ${durationMs}ms.`);
 return branches;
 } catch (e) {
 logger.error(`Failed to fetch branches for repo ${owner}/${repo}.`, e);
 throw e;
 }
}

const getReposOwnedByUsers = async <T>(users: string[], api: Api<T>) => {
 const results = await Promise.allSettled(users.map(async (user) => {
 try {
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/posthogEvents.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ export type PosthogEventMap = {
 connectionId: number,
 repoCount: number,
 },
 revisions_truncated: {},
 //////////////////////////////////////////////////////////////////
}

Expand Down

2 changes: 1 addition & 1 deletion
packages/backend/src/promClient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import express, { Request, Response } from 'express';
import client, { Registry, Counter, Gauge, Histogram } from 'prom-client';
import client, { Registry, Counter, Gauge } from 'prom-client';

export class PromClient {
 private registry: Registry;
Expand Down

83 changes: 49 additions & 34 deletions
packages/backend/src/repoCompileUtils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { Prisma, PrismaClient } from '@sourcebot/db';
import { WithRequired } from "./types.js"
import { marshalBool } from "./utils.js";
import { GerritConnectionConfig, GiteaConnectionConfig, GitlabConnectionConfig } from '@sourcebot/schemas/v3/connection.type';
import { RepoMetadata } from './types.js';

export type RepoData = WithRequired<Prisma.RepoCreateInput, 'connections'>;

Expand DownExpand Up@@ -54,17 +55,21 @@ export const compileGithubConfig = async (
 }
 },
 metadata: {
 '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(repo.private === false)
 },
 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(repo.private === false),
 },
 branches: config.revisions?.branches ?? undefined,
 tags: config.revisions?.tags ?? undefined,
 } satisfies RepoMetadata,
 };

 return record;
Expand DownExpand Up@@ -113,15 +118,19 @@ export const compileGitlabConfig = async (
 }
 },
 metadata: {
 'zoekt.web-url-type': 'gitlab',
 'zoekt.web-url': projectUrl,
 'zoekt.name': project.path_with_namespace,
 'zoekt.gitlab-stars': (project.stargazers_count ?? 0).toString(),
 'zoekt.gitlab-forks': (project.forks_count ?? 0).toString(),
 'zoekt.archived': marshalBool(project.archived),
 'zoekt.fork': marshalBool(isFork),
 'zoekt.public': marshalBool(project.private === false)
 },
 gitConfig: {
 'zoekt.web-url-type': 'gitlab',
 'zoekt.web-url': projectUrl,
 'zoekt.name': project.path_with_namespace,
 'zoekt.gitlab-stars': (project.stargazers_count ?? 0).toString(),
 'zoekt.gitlab-forks': (project.forks_count ?? 0).toString(),
 'zoekt.archived': marshalBool(project.archived),
 'zoekt.fork': marshalBool(isFork),
 'zoekt.public': marshalBool(project.private === false)
 },
 branches: config.revisions?.branches ?? undefined,
 tags: config.revisions?.tags ?? undefined,
 } satisfies RepoMetadata,
 };

 return record;
Expand DownExpand Up@@ -168,13 +177,17 @@ export const compileGiteaConfig = async (
 }
 },
 metadata: {
 'zoekt.web-url-type': 'gitea',
 'zoekt.web-url': repo.html_url!,
 'zoekt.name': repo.full_name!,
 'zoekt.archived': marshalBool(repo.archived),
 'zoekt.fork': marshalBool(repo.fork!),
 'zoekt.public': marshalBool(repo.internal === false && repo.private === false),
 },
 gitConfig: {
 'zoekt.web-url-type': 'gitea',
 'zoekt.web-url': repo.html_url!,
 'zoekt.name': repo.full_name!,
 'zoekt.archived': marshalBool(repo.archived),
 'zoekt.fork': marshalBool(repo.fork!),
 'zoekt.public': marshalBool(repo.internal === false && repo.private === false),
 },
 branches: config.revisions?.branches ?? undefined,
 tags: config.revisions?.tags ?? undefined,
 } satisfies RepoMetadata,
 };

 return record;
Expand DownExpand Up@@ -227,13 +240,15 @@ export const compileGerritConfig = async (
 }
 },
 metadata: {
 'zoekt.web-url-type': 'gitiles',
 'zoekt.web-url': webUrl,
 'zoekt.name': repoId,
 'zoekt.archived': marshalBool(false),
 'zoekt.fork': marshalBool(false),
 'zoekt.public': marshalBool(true),
 },
 gitConfig: {
 'zoekt.web-url-type': 'gitiles',
 'zoekt.web-url': webUrl,
 'zoekt.name': repoId,
 'zoekt.archived': marshalBool(false),
 'zoekt.fork': marshalBool(false),
 'zoekt.public': marshalBool(true),
 },
 } satisfies RepoMetadata,
 };

 return record;
Expand Down

6 changes: 3 additions & 3 deletions
packages/backend/src/repoManager.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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 } from "./types.js";
import { AppContext, Settings, RepoMetadata } from "./types.js";
import { getRepoPath, getTokenFromConfig, measure, getShardPrefix } from "./utils.js";
import { cloneRepository, fetchRepository } from "./git.js";
import { existsSync, rmSync, readdirSync, rm } from 'fs';
Expand DownExpand Up@@ -187,7 +187,7 @@ export class RepoManager implements IRepoManager {
 let cloneDuration_s: number | undefined = undefined;

 const repoPath = getRepoPath(repo, this.ctx);
 const metadata = repo.metadata as Record<string, string>;
 const metadata = repo.metadata as RepoMetadata;

 // 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 
Expand DownExpand Up@@ -223,7 +223,7 @@ export class RepoManager implements IRepoManager {
 cloneUrl = url.toString();
 }

 const { durationMs } = await measure(() => cloneRepository(cloneUrl, repoPath, metadata, ({ method, stage, progress }) => {
 const { durationMs } = await measure(() => cloneRepository(cloneUrl, repoPath, metadata.gitConfig, ({ method, stage, progress }) => {
 //this.logger.info(`git.${method} ${stage} stage ${progress}% complete for ${repo.id}`)
 }));
 cloneDuration_s = durationMs / 1000;
Expand Down

23 changes: 23 additions & 0 deletions
packages/backend/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,6 +49,29 @@ export type Settings = {
 gcGracePeriodMs: number;
}

/**
 * Structure of the `metadata` field in the `Repo` table.
 */
export type RepoMetadata = {
 /**
 * 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>;

 /**
 * A list of branches to index. Glob patterns are supported.
 */
 branches?: string[];

 /**
 * A list of tags to index. Glob patterns are supported.
 */
 tags?: string[];
}


// @see : https://stackoverflow.com/a/61132308
export type DeepPartial<T> = T extends object ? {
 [P in keyof T]?: DeepPartial<T[P]>;
Expand Down

54 changes: 50 additions & 4 deletions
packages/backend/src/zoekt.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,63 @@
import { exec } from "child_process";
import { AppContext } from "./types.js";
import { AppContext, RepoMetadata } from "./types.js";
import { Repo } from "@sourcebot/db";
import { getRepoPath } from "./utils.js";
import { DEFAULT_SETTINGS } from "./constants.js";
import { getShardPrefix } from "./utils.js";
import { getBranches, getTags } from "./git.js";
import micromatch from "micromatch";
import { createLogger } from "./logger.js";
import { captureEvent } from "./posthog.js";

const logger = createLogger('zoekt');

export const indexGitRepository = async (repo: Repo, ctx: AppContext) => {
const revisions = [
let revisions = [
 'HEAD'
 ];

 const shardPrefix = getShardPrefix(repo.orgId, repo.id);

 const repoPath = getRepoPath(repo, ctx);
 const shardPrefix = getShardPrefix(repo.orgId, repo.id);
 const metadata = repo.metadata as RepoMetadata;

 if (metadata.branches) {
 const branchGlobs = metadata.branches
 const allBranches = await getBranches(repoPath);
 const matchingBranches = 
 allBranches
 .filter((branch) => micromatch.isMatch(branch, branchGlobs))
 .map((branch) => `refs/heads/${branch}`);

 revisions = [
 ...revisions,
 ...matchingBranches
 ];
 }

 if (metadata.tags) {
 const tagGlobs = metadata.tags;
 const allTags = await getTags(repoPath);
 const matchingTags = 
 allTags
 .filter((tag) => micromatch.isMatch(tag, tagGlobs))
 .map((tag) => `refs/tags/${tag}`);

 revisions = [
 ...revisions,
 ...matchingTags
 ];
 }

 // zoekt has a limit of 64 branches/tags to index.
 if (revisions.length > 64) {
 logger.warn(`Too many revisions (${revisions.length}) for repo ${repo.id}, truncating to 64`);
Comment thread
brendan-kellam marked this conversation as resolved.

 captureEvent('backend_revisions_truncated', {
 repoId: repo.id,
 revisionCount: revisions.length,
 });
 revisions = revisions.slice(0, 64);
 }

 const command = `zoekt-git-index -allow_missing_branches -index ${ctx.indexPath} -file_limit ${DEFAULT_SETTINGS.maxFileSize} -branches ${revisions.join(',')} -tenant_id ${repo.orgId} -shard_prefix ${shardPrefix} ${repoPath}`;

 return new Promise<{ stdout: string, stderr: string }>((resolve, reject) => {
Expand Down

6 changes: 3 additions & 3 deletions
packages/schemas/src/v3/connection.schema.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,11 +154,11 @@ const schema = {
 },
 "revisions": {
 "type": "object",
 "description": "The revisions (branches, tags) that should be included when indexing. The default branch (HEAD) is always indexed.",
 "description": "The revisions (branches, tags) that should be included when indexing. The default branch (HEAD) is always indexed. A maximum of 64 revisions can be indexed, with any additional revisions being ignored.",
 "properties": {
 "branches": {
 "type": "array",
 "description": "List of branches to include when indexing. For a given repo, only the branches that exist on the repo's remote *and* match at least one of the provided `branches` will be indexed. The default branch (HEAD) is always indexed. Glob patterns are supported.",
 "description": "List of branches to include when indexing. For a given repo, only the branches that exist on the repo's remote *and* match at least one of the provided `branches` will be indexed. The default branch (HEAD) is always indexed. Glob patterns are supported. A maximum of 64 branches can be indexed, with any additional branches being ignored.",
 "items": {
 "type": "string"
 },
Expand All@@ -175,7 +175,7 @@ const schema = {
 },
 "tags": {
 "type": "array",
 "description": "List of tags to include when indexing. For a given repo, only the tags that exist on the repo's remote *and* match at least one of the provided `tags` will be indexed. Glob patterns are supported.",
 "description": "List of tags to include when indexing. For a given repo, only the tags that exist on the repo's remote *and* match at least one of the provided `tags` will be indexed. Glob patterns are supported. A maximum of 64 tags can be indexed, with any additional tags being ignored.",
 "items": {
 "type": "string"
 },
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add back revision support#215

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 3 commits into

from

Feb 27, 2025
 Merged


Add back revision support
#215
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4986006

Store config branches/tags information in repo field. Get branch inf…


brendan-kellam Feb 27, 2025
8f6b05c

remove slow client side hack


brendan-kellam Feb 27, 2025
f2aa63f

feedback


brendan-kellam Feb 27, 2025

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


17 changes: 17 additions & 0 deletions
packages/backend/src/git.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,3 +39,20 @@ export const fetchRepository = async (path: string, onProgress?: (event: SimpleG
 ]
 );
}

export const getBranches = async (path: string) => {
 const git = simpleGit();
 const branches = await git.cwd({
 path,
 }).branch();

 return branches.all;
}

export const getTags = async (path: string) => {
 const git = simpleGit();
 const tags = await git.cwd({
 path,
 }).tags();
 return tags.all;
}

77 changes: 1 addition & 76 deletions
packages/backend/src/gitea.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { Api, giteaApi, HttpResponse, Repository as GiteaRepository } from 'gitea-js';
import { GiteaConnectionConfig } from '@sourcebot/schemas/v3/gitea.type';
import { getTokenFromConfig, measure, fetchWithRetry } from './utils.js';
import { getTokenFromConfig, measure } from './utils.js';
import fetch from 'cross-fetch';
import { createLogger } from './logger.js';
import micromatch from 'micromatch';
Expand DownExpand Up@@ -56,49 +56,6 @@ export const getGiteaReposFromConfig = async (config: GiteaConnectionConfig, org
 return true;
 });


 if (config.revisions) {
 if (config.revisions.branches) {
 const branchGlobs = config.revisions.branches;
 allRepos = await Promise.all(
 allRepos.map(async (repo) => {
 const [owner, name] = repo.full_name!.split('/');
 let branches = (await fetchWithRetry(
 () => getBranchesForRepo(owner, name, api),
 `branches for ${owner}/${name}`,
 logger
 )).map(branch => branch.name!);
 branches = micromatch.match(branches, branchGlobs);

 return {
 ...repo,
 branches,
 };
 })
 )
 }

 if (config.revisions.tags) {
 const tagGlobs = config.revisions.tags;
 allRepos = await Promise.all(
 allRepos.map(async (allRepos) => {
 const [owner, name] = allRepos.full_name!.split('/');
 let tags = (await fetchWithRetry(
 () => getTagsForRepo(owner, name, api),
 `tags for ${owner}/${name}`,
 logger
 )).map(tag => tag.name!);
 tags = micromatch.match(tags, tagGlobs);

 return {
 ...allRepos,
 tags,
 };
 })
 )
 }
 }

 let repos = allRepos
 .filter((repo) => {
 const isExcluded = shouldExcludeRepo({
Expand DownExpand Up@@ -158,38 +115,6 @@ const shouldExcludeRepo = ({
 return shouldExclude;
}

const getTagsForRepo = async <T>(owner: string, repo: string, api: Api<T>) => {
 try {
 logger.debug(`Fetching tags for repo ${owner}/${repo}...`);
 const { durationMs, data: tags } = await measure(() =>
 paginate((page) => api.repos.repoListTags(owner, repo, {
 page
 }))
 );
 logger.debug(`Found ${tags.length} tags in repo ${owner}/${repo} in ${durationMs}ms.`);
 return tags;
 } catch (e) {
 logger.error(`Failed to fetch tags for repo ${owner}/${repo}.`, e);
 throw e;
 }
}

const getBranchesForRepo = async <T>(owner: string, repo: string, api: Api<T>) => {
 try {
 logger.debug(`Fetching branches for repo ${owner}/${repo}...`);
 const { durationMs, data: branches } = await measure(() => 
 paginate((page) => api.repos.repoListBranches(owner, repo, {
 page
 }))
 );
 logger.debug(`Found ${branches.length} branches in repo ${owner}/${repo} in ${durationMs}ms.`);
 return branches;
 } catch (e) {
 logger.error(`Failed to fetch branches for repo ${owner}/${repo}.`, e);
 throw e;
 }
}

const getReposOwnedByUsers = async <T>(users: string[], api: Api<T>) => {
 const results = await Promise.allSettled(users.map(async (user) => {
 try {
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/posthogEvents.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ export type PosthogEventMap = {
 connectionId: number,
 repoCount: number,
 },
 revisions_truncated: {},
 //////////////////////////////////////////////////////////////////
}

Expand Down

2 changes: 1 addition & 1 deletion
packages/backend/src/promClient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import express, { Request, Response } from 'express';
import client, { Registry, Counter, Gauge, Histogram } from 'prom-client';
import client, { Registry, Counter, Gauge } from 'prom-client';

export class PromClient {
 private registry: Registry;
Expand Down

83 changes: 49 additions & 34 deletions
packages/backend/src/repoCompileUtils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { Prisma, PrismaClient } from '@sourcebot/db';
import { WithRequired } from "./types.js"
import { marshalBool } from "./utils.js";
import { GerritConnectionConfig, GiteaConnectionConfig, GitlabConnectionConfig } from '@sourcebot/schemas/v3/connection.type';
import { RepoMetadata } from './types.js';

export type RepoData = WithRequired<Prisma.RepoCreateInput, 'connections'>;

Expand DownExpand Up@@ -54,17 +55,21 @@ export const compileGithubConfig = async (
 }
 },
 metadata: {
 '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(repo.private === false)
 },
 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(repo.private === false),
 },
 branches: config.revisions?.branches ?? undefined,
 tags: config.revisions?.tags ?? undefined,
 } satisfies RepoMetadata,
 };

 return record;
Expand DownExpand Up@@ -113,15 +118,19 @@ export const compileGitlabConfig = async (
 }
 },
 metadata: {
 'zoekt.web-url-type': 'gitlab',
 'zoekt.web-url': projectUrl,
 'zoekt.name': project.path_with_namespace,
 'zoekt.gitlab-stars': (project.stargazers_count ?? 0).toString(),
 'zoekt.gitlab-forks': (project.forks_count ?? 0).toString(),
 'zoekt.archived': marshalBool(project.archived),
 'zoekt.fork': marshalBool(isFork),
 'zoekt.public': marshalBool(project.private === false)
 },
 gitConfig: {
 'zoekt.web-url-type': 'gitlab',
 'zoekt.web-url': projectUrl,
 'zoekt.name': project.path_with_namespace,
 'zoekt.gitlab-stars': (project.stargazers_count ?? 0).toString(),
 'zoekt.gitlab-forks': (project.forks_count ?? 0).toString(),
 'zoekt.archived': marshalBool(project.archived),
 'zoekt.fork': marshalBool(isFork),
 'zoekt.public': marshalBool(project.private === false)
 },
 branches: config.revisions?.branches ?? undefined,
 tags: config.revisions?.tags ?? undefined,
 } satisfies RepoMetadata,
 };

 return record;
Expand DownExpand Up@@ -168,13 +177,17 @@ export const compileGiteaConfig = async (
 }
 },
 metadata: {
 'zoekt.web-url-type': 'gitea',
 'zoekt.web-url': repo.html_url!,
 'zoekt.name': repo.full_name!,
 'zoekt.archived': marshalBool(repo.archived),
 'zoekt.fork': marshalBool(repo.fork!),
 'zoekt.public': marshalBool(repo.internal === false && repo.private === false),
 },
 gitConfig: {
 'zoekt.web-url-type': 'gitea',
 'zoekt.web-url': repo.html_url!,
 'zoekt.name': repo.full_name!,
 'zoekt.archived': marshalBool(repo.archived),
 'zoekt.fork': marshalBool(repo.fork!),
 'zoekt.public': marshalBool(repo.internal === false && repo.private === false),
 },
 branches: config.revisions?.branches ?? undefined,
 tags: config.revisions?.tags ?? undefined,
 } satisfies RepoMetadata,
 };

 return record;
Expand DownExpand Up@@ -227,13 +240,15 @@ export const compileGerritConfig = async (
 }
 },
 metadata: {
 'zoekt.web-url-type': 'gitiles',
 'zoekt.web-url': webUrl,
 'zoekt.name': repoId,
 'zoekt.archived': marshalBool(false),
 'zoekt.fork': marshalBool(false),
 'zoekt.public': marshalBool(true),
 },
 gitConfig: {
 'zoekt.web-url-type': 'gitiles',
 'zoekt.web-url': webUrl,
 'zoekt.name': repoId,
 'zoekt.archived': marshalBool(false),
 'zoekt.fork': marshalBool(false),
 'zoekt.public': marshalBool(true),
 },
 } satisfies RepoMetadata,
 };

 return record;
Expand Down

6 changes: 3 additions & 3 deletions
packages/backend/src/repoManager.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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 } from "./types.js";
import { AppContext, Settings, RepoMetadata } from "./types.js";
import { getRepoPath, getTokenFromConfig, measure, getShardPrefix } from "./utils.js";
import { cloneRepository, fetchRepository } from "./git.js";
import { existsSync, rmSync, readdirSync, rm } from 'fs';
Expand DownExpand Up@@ -187,7 +187,7 @@ export class RepoManager implements IRepoManager {
 let cloneDuration_s: number | undefined = undefined;

 const repoPath = getRepoPath(repo, this.ctx);
 const metadata = repo.metadata as Record<string, string>;
 const metadata = repo.metadata as RepoMetadata;

 // 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 
Expand DownExpand Up@@ -223,7 +223,7 @@ export class RepoManager implements IRepoManager {
 cloneUrl = url.toString();
 }

 const { durationMs } = await measure(() => cloneRepository(cloneUrl, repoPath, metadata, ({ method, stage, progress }) => {
 const { durationMs } = await measure(() => cloneRepository(cloneUrl, repoPath, metadata.gitConfig, ({ method, stage, progress }) => {
 //this.logger.info(`git.${method} ${stage} stage ${progress}% complete for ${repo.id}`)
 }));
 cloneDuration_s = durationMs / 1000;
Expand Down

23 changes: 23 additions & 0 deletions
packages/backend/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,6 +49,29 @@ export type Settings = {
 gcGracePeriodMs: number;
}

/**
 * Structure of the `metadata` field in the `Repo` table.
 */
export type RepoMetadata = {
 /**
 * 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>;

 /**
 * A list of branches to index. Glob patterns are supported.
 */
 branches?: string[];

 /**
 * A list of tags to index. Glob patterns are supported.
 */
 tags?: string[];
}


// @see : https://stackoverflow.com/a/61132308
export type DeepPartial<T> = T extends object ? {
 [P in keyof T]?: DeepPartial<T[P]>;
Expand Down

54 changes: 50 additions & 4 deletions
packages/backend/src/zoekt.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,63 @@
import { exec } from "child_process";
import { AppContext } from "./types.js";
import { AppContext, RepoMetadata } from "./types.js";
import { Repo } from "@sourcebot/db";
import { getRepoPath } from "./utils.js";
import { DEFAULT_SETTINGS } from "./constants.js";
import { getShardPrefix } from "./utils.js";
import { getBranches, getTags } from "./git.js";
import micromatch from "micromatch";
import { createLogger } from "./logger.js";
import { captureEvent } from "./posthog.js";

const logger = createLogger('zoekt');

export const indexGitRepository = async (repo: Repo, ctx: AppContext) => {
const revisions = [
let revisions = [
 'HEAD'
 ];

 const shardPrefix = getShardPrefix(repo.orgId, repo.id);

 const repoPath = getRepoPath(repo, ctx);
 const shardPrefix = getShardPrefix(repo.orgId, repo.id);
 const metadata = repo.metadata as RepoMetadata;

 if (metadata.branches) {
 const branchGlobs = metadata.branches
 const allBranches = await getBranches(repoPath);
 const matchingBranches = 
 allBranches
 .filter((branch) => micromatch.isMatch(branch, branchGlobs))
 .map((branch) => `refs/heads/${branch}`);

 revisions = [
 ...revisions,
 ...matchingBranches
 ];
 }

 if (metadata.tags) {
 const tagGlobs = metadata.tags;
 const allTags = await getTags(repoPath);
 const matchingTags = 
 allTags
 .filter((tag) => micromatch.isMatch(tag, tagGlobs))
 .map((tag) => `refs/tags/${tag}`);

 revisions = [
 ...revisions,
 ...matchingTags
 ];
 }

 // zoekt has a limit of 64 branches/tags to index.
 if (revisions.length > 64) {
 logger.warn(`Too many revisions (${revisions.length}) for repo ${repo.id}, truncating to 64`);
Comment thread
brendan-kellam marked this conversation as resolved.

 captureEvent('backend_revisions_truncated', {
 repoId: repo.id,
 revisionCount: revisions.length,
 });
 revisions = revisions.slice(0, 64);
 }

 const command = `zoekt-git-index -allow_missing_branches -index ${ctx.indexPath} -file_limit ${DEFAULT_SETTINGS.maxFileSize} -branches ${revisions.join(',')} -tenant_id ${repo.orgId} -shard_prefix ${shardPrefix} ${repoPath}`;

 return new Promise<{ stdout: string, stderr: string }>((resolve, reject) => {
Expand Down

6 changes: 3 additions & 3 deletions
packages/schemas/src/v3/connection.schema.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,11 +154,11 @@ const schema = {
 },
 "revisions": {
 "type": "object",
 "description": "The revisions (branches, tags) that should be included when indexing. The default branch (HEAD) is always indexed.",
 "description": "The revisions (branches, tags) that should be included when indexing. The default branch (HEAD) is always indexed. A maximum of 64 revisions can be indexed, with any additional revisions being ignored.",
 "properties": {
 "branches": {
 "type": "array",
 "description": "List of branches to include when indexing. For a given repo, only the branches that exist on the repo's remote *and* match at least one of the provided `branches` will be indexed. The default branch (HEAD) is always indexed. Glob patterns are supported.",
 "description": "List of branches to include when indexing. For a given repo, only the branches that exist on the repo's remote *and* match at least one of the provided `branches` will be indexed. The default branch (HEAD) is always indexed. Glob patterns are supported. A maximum of 64 branches can be indexed, with any additional branches being ignored.",
 "items": {
 "type": "string"
 },
Expand All@@ -175,7 +175,7 @@ const schema = {
 },
 "tags": {
 "type": "array",
 "description": "List of tags to include when indexing. For a given repo, only the tags that exist on the repo's remote *and* match at least one of the provided `tags` will be indexed. Glob patterns are supported.",
 "description": "List of tags to include when indexing. For a given repo, only the tags that exist on the repo's remote *and* match at least one of the provided `tags` will be indexed. Glob patterns are supported. A maximum of 64 tags can be indexed, with any additional tags being ignored.",
 "items": {
 "type": "string"
 },
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add back revision support#215

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 3 commits into

from

Feb 27, 2025
 Merged


Add back revision support
#215
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4986006

Store config branches/tags information in repo field. Get branch inf…


brendan-kellam Feb 27, 2025
8f6b05c

remove slow client side hack


brendan-kellam Feb 27, 2025
f2aa63f

feedback


brendan-kellam Feb 27, 2025

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


17 changes: 17 additions & 0 deletions
packages/backend/src/git.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,3 +39,20 @@ export const fetchRepository = async (path: string, onProgress?: (event: SimpleG
 ]
 );
}

export const getBranches = async (path: string) => {
 const git = simpleGit();
 const branches = await git.cwd({
 path,
 }).branch();

 return branches.all;
}

export const getTags = async (path: string) => {
 const git = simpleGit();
 const tags = await git.cwd({
 path,
 }).tags();
 return tags.all;
}

77 changes: 1 addition & 76 deletions
packages/backend/src/gitea.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { Api, giteaApi, HttpResponse, Repository as GiteaRepository } from 'gitea-js';
import { GiteaConnectionConfig } from '@sourcebot/schemas/v3/gitea.type';
import { getTokenFromConfig, measure, fetchWithRetry } from './utils.js';
import { getTokenFromConfig, measure } from './utils.js';
import fetch from 'cross-fetch';
import { createLogger } from './logger.js';
import micromatch from 'micromatch';
Expand DownExpand Up@@ -56,49 +56,6 @@ export const getGiteaReposFromConfig = async (config: GiteaConnectionConfig, org
 return true;
 });


 if (config.revisions) {
 if (config.revisions.branches) {
 const branchGlobs = config.revisions.branches;
 allRepos = await Promise.all(
 allRepos.map(async (repo) => {
 const [owner, name] = repo.full_name!.split('/');
 let branches = (await fetchWithRetry(
 () => getBranchesForRepo(owner, name, api),
 `branches for ${owner}/${name}`,
 logger
 )).map(branch => branch.name!);
 branches = micromatch.match(branches, branchGlobs);

 return {
 ...repo,
 branches,
 };
 })
 )
 }

 if (config.revisions.tags) {
 const tagGlobs = config.revisions.tags;
 allRepos = await Promise.all(
 allRepos.map(async (allRepos) => {
 const [owner, name] = allRepos.full_name!.split('/');
 let tags = (await fetchWithRetry(
 () => getTagsForRepo(owner, name, api),
 `tags for ${owner}/${name}`,
 logger
 )).map(tag => tag.name!);
 tags = micromatch.match(tags, tagGlobs);

 return {
 ...allRepos,
 tags,
 };
 })
 )
 }
 }

 let repos = allRepos
 .filter((repo) => {
 const isExcluded = shouldExcludeRepo({
Expand DownExpand Up@@ -158,38 +115,6 @@ const shouldExcludeRepo = ({
 return shouldExclude;
}

const getTagsForRepo = async <T>(owner: string, repo: string, api: Api<T>) => {
 try {
 logger.debug(`Fetching tags for repo ${owner}/${repo}...`);
 const { durationMs, data: tags } = await measure(() =>
 paginate((page) => api.repos.repoListTags(owner, repo, {
 page
 }))
 );
 logger.debug(`Found ${tags.length} tags in repo ${owner}/${repo} in ${durationMs}ms.`);
 return tags;
 } catch (e) {
 logger.error(`Failed to fetch tags for repo ${owner}/${repo}.`, e);
 throw e;
 }
}

const getBranchesForRepo = async <T>(owner: string, repo: string, api: Api<T>) => {
 try {
 logger.debug(`Fetching branches for repo ${owner}/${repo}...`);
 const { durationMs, data: branches } = await measure(() => 
 paginate((page) => api.repos.repoListBranches(owner, repo, {
 page
 }))
 );
 logger.debug(`Found ${branches.length} branches in repo ${owner}/${repo} in ${durationMs}ms.`);
 return branches;
 } catch (e) {
 logger.error(`Failed to fetch branches for repo ${owner}/${repo}.`, e);
 throw e;
 }
}

const getReposOwnedByUsers = async <T>(users: string[], api: Api<T>) => {
 const results = await Promise.allSettled(users.map(async (user) => {
 try {
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/posthogEvents.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ export type PosthogEventMap = {
 connectionId: number,
 repoCount: number,
 },
 revisions_truncated: {},
 //////////////////////////////////////////////////////////////////
}

Expand Down

2 changes: 1 addition & 1 deletion
packages/backend/src/promClient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import express, { Request, Response } from 'express';
import client, { Registry, Counter, Gauge, Histogram } from 'prom-client';
import client, { Registry, Counter, Gauge } from 'prom-client';

export class PromClient {
 private registry: Registry;
Expand Down

83 changes: 49 additions & 34 deletions
packages/backend/src/repoCompileUtils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { Prisma, PrismaClient } from '@sourcebot/db';
import { WithRequired } from "./types.js"
import { marshalBool } from "./utils.js";
import { GerritConnectionConfig, GiteaConnectionConfig, GitlabConnectionConfig } from '@sourcebot/schemas/v3/connection.type';
import { RepoMetadata } from './types.js';

export type RepoData = WithRequired<Prisma.RepoCreateInput, 'connections'>;

Expand DownExpand Up@@ -54,17 +55,21 @@ export const compileGithubConfig = async (
 }
 },
 metadata: {
 '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(repo.private === false)
 },
 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(repo.private === false),
 },
 branches: config.revisions?.branches ?? undefined,
 tags: config.revisions?.tags ?? undefined,
 } satisfies RepoMetadata,
 };

 return record;
Expand DownExpand Up@@ -113,15 +118,19 @@ export const compileGitlabConfig = async (
 }
 },
 metadata: {
 'zoekt.web-url-type': 'gitlab',
 'zoekt.web-url': projectUrl,
 'zoekt.name': project.path_with_namespace,
 'zoekt.gitlab-stars': (project.stargazers_count ?? 0).toString(),
 'zoekt.gitlab-forks': (project.forks_count ?? 0).toString(),
 'zoekt.archived': marshalBool(project.archived),
 'zoekt.fork': marshalBool(isFork),
 'zoekt.public': marshalBool(project.private === false)
 },
 gitConfig: {
 'zoekt.web-url-type': 'gitlab',
 'zoekt.web-url': projectUrl,
 'zoekt.name': project.path_with_namespace,
 'zoekt.gitlab-stars': (project.stargazers_count ?? 0).toString(),
 'zoekt.gitlab-forks': (project.forks_count ?? 0).toString(),
 'zoekt.archived': marshalBool(project.archived),
 'zoekt.fork': marshalBool(isFork),
 'zoekt.public': marshalBool(project.private === false)
 },
 branches: config.revisions?.branches ?? undefined,
 tags: config.revisions?.tags ?? undefined,
 } satisfies RepoMetadata,
 };

 return record;
Expand DownExpand Up@@ -168,13 +177,17 @@ export const compileGiteaConfig = async (
 }
 },
 metadata: {
 'zoekt.web-url-type': 'gitea',
 'zoekt.web-url': repo.html_url!,
 'zoekt.name': repo.full_name!,
 'zoekt.archived': marshalBool(repo.archived),
 'zoekt.fork': marshalBool(repo.fork!),
 'zoekt.public': marshalBool(repo.internal === false && repo.private === false),
 },
 gitConfig: {
 'zoekt.web-url-type': 'gitea',
 'zoekt.web-url': repo.html_url!,
 'zoekt.name': repo.full_name!,
 'zoekt.archived': marshalBool(repo.archived),
 'zoekt.fork': marshalBool(repo.fork!),
 'zoekt.public': marshalBool(repo.internal === false && repo.private === false),
 },
 branches: config.revisions?.branches ?? undefined,
 tags: config.revisions?.tags ?? undefined,
 } satisfies RepoMetadata,
 };

 return record;
Expand DownExpand Up@@ -227,13 +240,15 @@ export const compileGerritConfig = async (
 }
 },
 metadata: {
 'zoekt.web-url-type': 'gitiles',
 'zoekt.web-url': webUrl,
 'zoekt.name': repoId,
 'zoekt.archived': marshalBool(false),
 'zoekt.fork': marshalBool(false),
 'zoekt.public': marshalBool(true),
 },
 gitConfig: {
 'zoekt.web-url-type': 'gitiles',
 'zoekt.web-url': webUrl,
 'zoekt.name': repoId,
 'zoekt.archived': marshalBool(false),
 'zoekt.fork': marshalBool(false),
 'zoekt.public': marshalBool(true),
 },
 } satisfies RepoMetadata,
 };

 return record;
Expand Down

6 changes: 3 additions & 3 deletions
packages/backend/src/repoManager.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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 } from "./types.js";
import { AppContext, Settings, RepoMetadata } from "./types.js";
import { getRepoPath, getTokenFromConfig, measure, getShardPrefix } from "./utils.js";
import { cloneRepository, fetchRepository } from "./git.js";
import { existsSync, rmSync, readdirSync, rm } from 'fs';
Expand DownExpand Up@@ -187,7 +187,7 @@ export class RepoManager implements IRepoManager {
 let cloneDuration_s: number | undefined = undefined;

 const repoPath = getRepoPath(repo, this.ctx);
 const metadata = repo.metadata as Record<string, string>;
 const metadata = repo.metadata as RepoMetadata;

 // 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 
Expand DownExpand Up@@ -223,7 +223,7 @@ export class RepoManager implements IRepoManager {
 cloneUrl = url.toString();
 }

 const { durationMs } = await measure(() => cloneRepository(cloneUrl, repoPath, metadata, ({ method, stage, progress }) => {
 const { durationMs } = await measure(() => cloneRepository(cloneUrl, repoPath, metadata.gitConfig, ({ method, stage, progress }) => {
 //this.logger.info(`git.${method} ${stage} stage ${progress}% complete for ${repo.id}`)
 }));
 cloneDuration_s = durationMs / 1000;
Expand Down

23 changes: 23 additions & 0 deletions
packages/backend/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,6 +49,29 @@ export type Settings = {
 gcGracePeriodMs: number;
}

/**
 * Structure of the `metadata` field in the `Repo` table.
 */
export type RepoMetadata = {
 /**
 * 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>;

 /**
 * A list of branches to index. Glob patterns are supported.
 */
 branches?: string[];

 /**
 * A list of tags to index. Glob patterns are supported.
 */
 tags?: string[];
}


// @see : https://stackoverflow.com/a/61132308
export type DeepPartial<T> = T extends object ? {
 [P in keyof T]?: DeepPartial<T[P]>;
Expand Down

54 changes: 50 additions & 4 deletions
packages/backend/src/zoekt.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,63 @@
import { exec } from "child_process";
import { AppContext } from "./types.js";
import { AppContext, RepoMetadata } from "./types.js";
import { Repo } from "@sourcebot/db";
import { getRepoPath } from "./utils.js";
import { DEFAULT_SETTINGS } from "./constants.js";
import { getShardPrefix } from "./utils.js";
import { getBranches, getTags } from "./git.js";
import micromatch from "micromatch";
import { createLogger } from "./logger.js";
import { captureEvent } from "./posthog.js";

const logger = createLogger('zoekt');

export const indexGitRepository = async (repo: Repo, ctx: AppContext) => {
const revisions = [
let revisions = [
 'HEAD'
 ];

 const shardPrefix = getShardPrefix(repo.orgId, repo.id);

 const repoPath = getRepoPath(repo, ctx);
 const shardPrefix = getShardPrefix(repo.orgId, repo.id);
 const metadata = repo.metadata as RepoMetadata;

 if (metadata.branches) {
 const branchGlobs = metadata.branches
 const allBranches = await getBranches(repoPath);
 const matchingBranches = 
 allBranches
 .filter((branch) => micromatch.isMatch(branch, branchGlobs))
 .map((branch) => `refs/heads/${branch}`);

 revisions = [
 ...revisions,
 ...matchingBranches
 ];
 }

 if (metadata.tags) {
 const tagGlobs = metadata.tags;
 const allTags = await getTags(repoPath);
 const matchingTags = 
 allTags
 .filter((tag) => micromatch.isMatch(tag, tagGlobs))
 .map((tag) => `refs/tags/${tag}`);

 revisions = [
 ...revisions,
 ...matchingTags
 ];
 }

 // zoekt has a limit of 64 branches/tags to index.
 if (revisions.length > 64) {
 logger.warn(`Too many revisions (${revisions.length}) for repo ${repo.id}, truncating to 64`);
Comment thread
brendan-kellam marked this conversation as resolved.

 captureEvent('backend_revisions_truncated', {
 repoId: repo.id,
 revisionCount: revisions.length,
 });
 revisions = revisions.slice(0, 64);
 }

 const command = `zoekt-git-index -allow_missing_branches -index ${ctx.indexPath} -file_limit ${DEFAULT_SETTINGS.maxFileSize} -branches ${revisions.join(',')} -tenant_id ${repo.orgId} -shard_prefix ${shardPrefix} ${repoPath}`;

 return new Promise<{ stdout: string, stderr: string }>((resolve, reject) => {
Expand Down

6 changes: 3 additions & 3 deletions
packages/schemas/src/v3/connection.schema.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,11 +154,11 @@ const schema = {
 },
 "revisions": {
 "type": "object",
 "description": "The revisions (branches, tags) that should be included when indexing. The default branch (HEAD) is always indexed.",
 "description": "The revisions (branches, tags) that should be included when indexing. The default branch (HEAD) is always indexed. A maximum of 64 revisions can be indexed, with any additional revisions being ignored.",
 "properties": {
 "branches": {
 "type": "array",
 "description": "List of branches to include when indexing. For a given repo, only the branches that exist on the repo's remote *and* match at least one of the provided `branches` will be indexed. The default branch (HEAD) is always indexed. Glob patterns are supported.",
 "description": "List of branches to include when indexing. For a given repo, only the branches that exist on the repo's remote *and* match at least one of the provided `branches` will be indexed. The default branch (HEAD) is always indexed. Glob patterns are supported. A maximum of 64 branches can be indexed, with any additional branches being ignored.",
 "items": {
 "type": "string"
 },
Expand All@@ -175,7 +175,7 @@ const schema = {
 },
 "tags": {
 "type": "array",
 "description": "List of tags to include when indexing. For a given repo, only the tags that exist on the repo's remote *and* match at least one of the provided `tags` will be indexed. Glob patterns are supported.",
 "description": "List of tags to include when indexing. For a given repo, only the tags that exist on the repo's remote *and* match at least one of the provided `tags` will be indexed. Glob patterns are supported. A maximum of 64 tags can be indexed, with any additional tags being ignored.",
 "items": {
 "type": "string"
 },
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Add back revision support#215

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 3 commits into

from

Feb 27, 2025
 Merged


Add back revision support
#215
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4986006

Store config branches/tags information in repo field. Get branch inf…


brendan-kellam Feb 27, 2025
8f6b05c

remove slow client side hack


brendan-kellam Feb 27, 2025
f2aa63f

feedback


brendan-kellam Feb 27, 2025

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


17 changes: 17 additions & 0 deletions
packages/backend/src/git.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,3 +39,20 @@ export const fetchRepository = async (path: string, onProgress?: (event: SimpleG
 ]
 );
}

export const getBranches = async (path: string) => {
 const git = simpleGit();
 const branches = await git.cwd({
 path,
 }).branch();

 return branches.all;
}

export const getTags = async (path: string) => {
 const git = simpleGit();
 const tags = await git.cwd({
 path,
 }).tags();
 return tags.all;
}

77 changes: 1 addition & 76 deletions
packages/backend/src/gitea.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { Api, giteaApi, HttpResponse, Repository as GiteaRepository } from 'gitea-js';
import { GiteaConnectionConfig } from '@sourcebot/schemas/v3/gitea.type';
import { getTokenFromConfig, measure, fetchWithRetry } from './utils.js';
import { getTokenFromConfig, measure } from './utils.js';
import fetch from 'cross-fetch';
import { createLogger } from './logger.js';
import micromatch from 'micromatch';
Expand DownExpand Up@@ -56,49 +56,6 @@ export const getGiteaReposFromConfig = async (config: GiteaConnectionConfig, org
 return true;
 });


 if (config.revisions) {
 if (config.revisions.branches) {
 const branchGlobs = config.revisions.branches;
 allRepos = await Promise.all(
 allRepos.map(async (repo) => {
 const [owner, name] = repo.full_name!.split('/');
 let branches = (await fetchWithRetry(
 () => getBranchesForRepo(owner, name, api),
 `branches for ${owner}/${name}`,
 logger
 )).map(branch => branch.name!);
 branches = micromatch.match(branches, branchGlobs);

 return {
 ...repo,
 branches,
 };
 })
 )
 }

 if (config.revisions.tags) {
 const tagGlobs = config.revisions.tags;
 allRepos = await Promise.all(
 allRepos.map(async (allRepos) => {
 const [owner, name] = allRepos.full_name!.split('/');
 let tags = (await fetchWithRetry(
 () => getTagsForRepo(owner, name, api),
 `tags for ${owner}/${name}`,
 logger
 )).map(tag => tag.name!);
 tags = micromatch.match(tags, tagGlobs);

 return {
 ...allRepos,
 tags,
 };
 })
 )
 }
 }

 let repos = allRepos
 .filter((repo) => {
 const isExcluded = shouldExcludeRepo({
Expand DownExpand Up@@ -158,38 +115,6 @@ const shouldExcludeRepo = ({
 return shouldExclude;
}

const getTagsForRepo = async <T>(owner: string, repo: string, api: Api<T>) => {
 try {
 logger.debug(`Fetching tags for repo ${owner}/${repo}...`);
 const { durationMs, data: tags } = await measure(() =>
 paginate((page) => api.repos.repoListTags(owner, repo, {
 page
 }))
 );
 logger.debug(`Found ${tags.length} tags in repo ${owner}/${repo} in ${durationMs}ms.`);
 return tags;
 } catch (e) {
 logger.error(`Failed to fetch tags for repo ${owner}/${repo}.`, e);
 throw e;
 }
}

const getBranchesForRepo = async <T>(owner: string, repo: string, api: Api<T>) => {
 try {
 logger.debug(`Fetching branches for repo ${owner}/${repo}...`);
 const { durationMs, data: branches } = await measure(() => 
 paginate((page) => api.repos.repoListBranches(owner, repo, {
 page
 }))
 );
 logger.debug(`Found ${branches.length} branches in repo ${owner}/${repo} in ${durationMs}ms.`);
 return branches;
 } catch (e) {
 logger.error(`Failed to fetch branches for repo ${owner}/${repo}.`, e);
 throw e;
 }
}

const getReposOwnedByUsers = async <T>(users: string[], api: Api<T>) => {
 const results = await Promise.allSettled(users.map(async (user) => {
 try {
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/posthogEvents.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ export type PosthogEventMap = {
 connectionId: number,
 repoCount: number,
 },
 revisions_truncated: {},
 //////////////////////////////////////////////////////////////////
}

Expand Down

2 changes: 1 addition & 1 deletion
packages/backend/src/promClient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import express, { Request, Response } from 'express';
import client, { Registry, Counter, Gauge, Histogram } from 'prom-client';
import client, { Registry, Counter, Gauge } from 'prom-client';

export class PromClient {
 private registry: Registry;
Expand Down

83 changes: 49 additions & 34 deletions
packages/backend/src/repoCompileUtils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { Prisma, PrismaClient } from '@sourcebot/db';
import { WithRequired } from "./types.js"
import { marshalBool } from "./utils.js";
import { GerritConnectionConfig, GiteaConnectionConfig, GitlabConnectionConfig } from '@sourcebot/schemas/v3/connection.type';
import { RepoMetadata } from './types.js';

export type RepoData = WithRequired<Prisma.RepoCreateInput, 'connections'>;

Expand DownExpand Up@@ -54,17 +55,21 @@ export const compileGithubConfig = async (
 }
 },
 metadata: {
 '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(repo.private === false)
 },
 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(repo.private === false),
 },
 branches: config.revisions?.branches ?? undefined,
 tags: config.revisions?.tags ?? undefined,
 } satisfies RepoMetadata,
 };

 return record;
Expand DownExpand Up@@ -113,15 +118,19 @@ export const compileGitlabConfig = async (
 }
 },
 metadata: {
 'zoekt.web-url-type': 'gitlab',
 'zoekt.web-url': projectUrl,
 'zoekt.name': project.path_with_namespace,
 'zoekt.gitlab-stars': (project.stargazers_count ?? 0).toString(),
 'zoekt.gitlab-forks': (project.forks_count ?? 0).toString(),
 'zoekt.archived': marshalBool(project.archived),
 'zoekt.fork': marshalBool(isFork),
 'zoekt.public': marshalBool(project.private === false)
 },
 gitConfig: {
 'zoekt.web-url-type': 'gitlab',
 'zoekt.web-url': projectUrl,
 'zoekt.name': project.path_with_namespace,
 'zoekt.gitlab-stars': (project.stargazers_count ?? 0).toString(),
 'zoekt.gitlab-forks': (project.forks_count ?? 0).toString(),
 'zoekt.archived': marshalBool(project.archived),
 'zoekt.fork': marshalBool(isFork),
 'zoekt.public': marshalBool(project.private === false)
 },
 branches: config.revisions?.branches ?? undefined,
 tags: config.revisions?.tags ?? undefined,
 } satisfies RepoMetadata,
 };

 return record;
Expand DownExpand Up@@ -168,13 +177,17 @@ export const compileGiteaConfig = async (
 }
 },
 metadata: {
 'zoekt.web-url-type': 'gitea',
 'zoekt.web-url': repo.html_url!,
 'zoekt.name': repo.full_name!,
 'zoekt.archived': marshalBool(repo.archived),
 'zoekt.fork': marshalBool(repo.fork!),
 'zoekt.public': marshalBool(repo.internal === false && repo.private === false),
 },
 gitConfig: {
 'zoekt.web-url-type': 'gitea',
 'zoekt.web-url': repo.html_url!,
 'zoekt.name': repo.full_name!,
 'zoekt.archived': marshalBool(repo.archived),
 'zoekt.fork': marshalBool(repo.fork!),
 'zoekt.public': marshalBool(repo.internal === false && repo.private === false),
 },
 branches: config.revisions?.branches ?? undefined,
 tags: config.revisions?.tags ?? undefined,
 } satisfies RepoMetadata,
 };

 return record;
Expand DownExpand Up@@ -227,13 +240,15 @@ export const compileGerritConfig = async (
 }
 },
 metadata: {
 'zoekt.web-url-type': 'gitiles',
 'zoekt.web-url': webUrl,
 'zoekt.name': repoId,
 'zoekt.archived': marshalBool(false),
 'zoekt.fork': marshalBool(false),
 'zoekt.public': marshalBool(true),
 },
 gitConfig: {
 'zoekt.web-url-type': 'gitiles',
 'zoekt.web-url': webUrl,
 'zoekt.name': repoId,
 'zoekt.archived': marshalBool(false),
 'zoekt.fork': marshalBool(false),
 'zoekt.public': marshalBool(true),
 },
 } satisfies RepoMetadata,
 };

 return record;
Expand Down

6 changes: 3 additions & 3 deletions
packages/backend/src/repoManager.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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 } from "./types.js";
import { AppContext, Settings, RepoMetadata } from "./types.js";
import { getRepoPath, getTokenFromConfig, measure, getShardPrefix } from "./utils.js";
import { cloneRepository, fetchRepository } from "./git.js";
import { existsSync, rmSync, readdirSync, rm } from 'fs';
Expand DownExpand Up@@ -187,7 +187,7 @@ export class RepoManager implements IRepoManager {
 let cloneDuration_s: number | undefined = undefined;

 const repoPath = getRepoPath(repo, this.ctx);
 const metadata = repo.metadata as Record<string, string>;
 const metadata = repo.metadata as RepoMetadata;

 // 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 
Expand DownExpand Up@@ -223,7 +223,7 @@ export class RepoManager implements IRepoManager {
 cloneUrl = url.toString();
 }

 const { durationMs } = await measure(() => cloneRepository(cloneUrl, repoPath, metadata, ({ method, stage, progress }) => {
 const { durationMs } = await measure(() => cloneRepository(cloneUrl, repoPath, metadata.gitConfig, ({ method, stage, progress }) => {
 //this.logger.info(`git.${method} ${stage} stage ${progress}% complete for ${repo.id}`)
 }));
 cloneDuration_s = durationMs / 1000;
Expand Down

23 changes: 23 additions & 0 deletions
packages/backend/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,6 +49,29 @@ export type Settings = {
 gcGracePeriodMs: number;
}

/**
 * Structure of the `metadata` field in the `Repo` table.
 */
export type RepoMetadata = {
 /**
 * 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>;

 /**
 * A list of branches to index. Glob patterns are supported.
 */
 branches?: string[];

 /**
 * A list of tags to index. Glob patterns are supported.
 */
 tags?: string[];
}


// @see : https://stackoverflow.com/a/61132308
export type DeepPartial<T> = T extends object ? {
 [P in keyof T]?: DeepPartial<T[P]>;
Expand Down

54 changes: 50 additions & 4 deletions
packages/backend/src/zoekt.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,63 @@
import { exec } from "child_process";
import { AppContext } from "./types.js";
import { AppContext, RepoMetadata } from "./types.js";
import { Repo } from "@sourcebot/db";
import { getRepoPath } from "./utils.js";
import { DEFAULT_SETTINGS } from "./constants.js";
import { getShardPrefix } from "./utils.js";
import { getBranches, getTags } from "./git.js";
import micromatch from "micromatch";
import { createLogger } from "./logger.js";
import { captureEvent } from "./posthog.js";

const logger = createLogger('zoekt');

export const indexGitRepository = async (repo: Repo, ctx: AppContext) => {
const revisions = [
let revisions = [
 'HEAD'
 ];

 const shardPrefix = getShardPrefix(repo.orgId, repo.id);

 const repoPath = getRepoPath(repo, ctx);
 const shardPrefix = getShardPrefix(repo.orgId, repo.id);
 const metadata = repo.metadata as RepoMetadata;

 if (metadata.branches) {
 const branchGlobs = metadata.branches
 const allBranches = await getBranches(repoPath);
 const matchingBranches = 
 allBranches
 .filter((branch) => micromatch.isMatch(branch, branchGlobs))
 .map((branch) => `refs/heads/${branch}`);

 revisions = [
 ...revisions,
 ...matchingBranches
 ];
 }

 if (metadata.tags) {
 const tagGlobs = metadata.tags;
 const allTags = await getTags(repoPath);
 const matchingTags = 
 allTags
 .filter((tag) => micromatch.isMatch(tag, tagGlobs))
 .map((tag) => `refs/tags/${tag}`);

 revisions = [
 ...revisions,
 ...matchingTags
 ];
 }

 // zoekt has a limit of 64 branches/tags to index.
 if (revisions.length > 64) {
 logger.warn(`Too many revisions (${revisions.length}) for repo ${repo.id}, truncating to 64`);
Comment thread
brendan-kellam marked this conversation as resolved.

 captureEvent('backend_revisions_truncated', {
 repoId: repo.id,
 revisionCount: revisions.length,
 });
 revisions = revisions.slice(0, 64);
 }

 const command = `zoekt-git-index -allow_missing_branches -index ${ctx.indexPath} -file_limit ${DEFAULT_SETTINGS.maxFileSize} -branches ${revisions.join(',')} -tenant_id ${repo.orgId} -shard_prefix ${shardPrefix} ${repoPath}`;

 return new Promise<{ stdout: string, stderr: string }>((resolve, reject) => {
Expand Down

6 changes: 3 additions & 3 deletions
packages/schemas/src/v3/connection.schema.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,11 +154,11 @@ const schema = {
 },
 "revisions": {
 "type": "object",
 "description": "The revisions (branches, tags) that should be included when indexing. The default branch (HEAD) is always indexed.",
 "description": "The revisions (branches, tags) that should be included when indexing. The default branch (HEAD) is always indexed. A maximum of 64 revisions can be indexed, with any additional revisions being ignored.",
 "properties": {
 "branches": {
 "type": "array",
 "description": "List of branches to include when indexing. For a given repo, only the branches that exist on the repo's remote *and* match at least one of the provided `branches` will be indexed. The default branch (HEAD) is always indexed. Glob patterns are supported.",
 "description": "List of branches to include when indexing. For a given repo, only the branches that exist on the repo's remote *and* match at least one of the provided `branches` will be indexed. The default branch (HEAD) is always indexed. Glob patterns are supported. A maximum of 64 branches can be indexed, with any additional branches being ignored.",
 "items": {
 "type": "string"
 },
Expand All@@ -175,7 +175,7 @@ const schema = {
 },
 "tags": {
 "type": "array",
 "description": "List of tags to include when indexing. For a given repo, only the tags that exist on the repo's remote *and* match at least one of the provided `tags` will be indexed. Glob patterns are supported.",
 "description": "List of tags to include when indexing. For a given repo, only the tags that exist on the repo's remote *and* match at least one of the provided `tags` will be indexed. Glob patterns are supported. A maximum of 64 tags can be indexed, with any additional tags being ignored.",
 "items": {
 "type": "string"
 },
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add back revision support#215

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 3 commits into

from

Feb 27, 2025
 Merged


Add back revision support
#215
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4986006

Store config branches/tags information in repo field. Get branch inf…


brendan-kellam Feb 27, 2025
8f6b05c

remove slow client side hack


brendan-kellam Feb 27, 2025
f2aa63f

feedback


brendan-kellam Feb 27, 2025

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


17 changes: 17 additions & 0 deletions
packages/backend/src/git.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,3 +39,20 @@ export const fetchRepository = async (path: string, onProgress?: (event: SimpleG
 ]
 );
}

export const getBranches = async (path: string) => {
 const git = simpleGit();
 const branches = await git.cwd({
 path,
 }).branch();

 return branches.all;
}

export const getTags = async (path: string) => {
 const git = simpleGit();
 const tags = await git.cwd({
 path,
 }).tags();
 return tags.all;
}

77 changes: 1 addition & 76 deletions
packages/backend/src/gitea.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { Api, giteaApi, HttpResponse, Repository as GiteaRepository } from 'gitea-js';
import { GiteaConnectionConfig } from '@sourcebot/schemas/v3/gitea.type';
import { getTokenFromConfig, measure, fetchWithRetry } from './utils.js';
import { getTokenFromConfig, measure } from './utils.js';
import fetch from 'cross-fetch';
import { createLogger } from './logger.js';
import micromatch from 'micromatch';
Expand DownExpand Up@@ -56,49 +56,6 @@ export const getGiteaReposFromConfig = async (config: GiteaConnectionConfig, org
 return true;
 });


 if (config.revisions) {
 if (config.revisions.branches) {
 const branchGlobs = config.revisions.branches;
 allRepos = await Promise.all(
 allRepos.map(async (repo) => {
 const [owner, name] = repo.full_name!.split('/');
 let branches = (await fetchWithRetry(
 () => getBranchesForRepo(owner, name, api),
 `branches for ${owner}/${name}`,
 logger
 )).map(branch => branch.name!);
 branches = micromatch.match(branches, branchGlobs);

 return {
 ...repo,
 branches,
 };
 })
 )
 }

 if (config.revisions.tags) {
 const tagGlobs = config.revisions.tags;
 allRepos = await Promise.all(
 allRepos.map(async (allRepos) => {
 const [owner, name] = allRepos.full_name!.split('/');
 let tags = (await fetchWithRetry(
 () => getTagsForRepo(owner, name, api),
 `tags for ${owner}/${name}`,
 logger
 )).map(tag => tag.name!);
 tags = micromatch.match(tags, tagGlobs);

 return {
 ...allRepos,
 tags,
 };
 })
 )
 }
 }

 let repos = allRepos
 .filter((repo) => {
 const isExcluded = shouldExcludeRepo({
Expand DownExpand Up@@ -158,38 +115,6 @@ const shouldExcludeRepo = ({
 return shouldExclude;
}

const getTagsForRepo = async <T>(owner: string, repo: string, api: Api<T>) => {
 try {
 logger.debug(`Fetching tags for repo ${owner}/${repo}...`);
 const { durationMs, data: tags } = await measure(() =>
 paginate((page) => api.repos.repoListTags(owner, repo, {
 page
 }))
 );
 logger.debug(`Found ${tags.length} tags in repo ${owner}/${repo} in ${durationMs}ms.`);
 return tags;
 } catch (e) {
 logger.error(`Failed to fetch tags for repo ${owner}/${repo}.`, e);
 throw e;
 }
}

const getBranchesForRepo = async <T>(owner: string, repo: string, api: Api<T>) => {
 try {
 logger.debug(`Fetching branches for repo ${owner}/${repo}...`);
 const { durationMs, data: branches } = await measure(() => 
 paginate((page) => api.repos.repoListBranches(owner, repo, {
 page
 }))
 );
 logger.debug(`Found ${branches.length} branches in repo ${owner}/${repo} in ${durationMs}ms.`);
 return branches;
 } catch (e) {
 logger.error(`Failed to fetch branches for repo ${owner}/${repo}.`, e);
 throw e;
 }
}

const getReposOwnedByUsers = async <T>(users: string[], api: Api<T>) => {
 const results = await Promise.allSettled(users.map(async (user) => {
 try {
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/posthogEvents.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ export type PosthogEventMap = {
 connectionId: number,
 repoCount: number,
 },
 revisions_truncated: {},
 //////////////////////////////////////////////////////////////////
}

Expand Down

2 changes: 1 addition & 1 deletion
packages/backend/src/promClient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import express, { Request, Response } from 'express';
import client, { Registry, Counter, Gauge, Histogram } from 'prom-client';
import client, { Registry, Counter, Gauge } from 'prom-client';

export class PromClient {
 private registry: Registry;
Expand Down

83 changes: 49 additions & 34 deletions
packages/backend/src/repoCompileUtils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { Prisma, PrismaClient } from '@sourcebot/db';
import { WithRequired } from "./types.js"
import { marshalBool } from "./utils.js";
import { GerritConnectionConfig, GiteaConnectionConfig, GitlabConnectionConfig } from '@sourcebot/schemas/v3/connection.type';
import { RepoMetadata } from './types.js';

export type RepoData = WithRequired<Prisma.RepoCreateInput, 'connections'>;

Expand DownExpand Up@@ -54,17 +55,21 @@ export const compileGithubConfig = async (
 }
 },
 metadata: {
 '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(repo.private === false)
 },
 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(repo.private === false),
 },
 branches: config.revisions?.branches ?? undefined,
 tags: config.revisions?.tags ?? undefined,
 } satisfies RepoMetadata,
 };

 return record;
Expand DownExpand Up@@ -113,15 +118,19 @@ export const compileGitlabConfig = async (
 }
 },
 metadata: {
 'zoekt.web-url-type': 'gitlab',
 'zoekt.web-url': projectUrl,
 'zoekt.name': project.path_with_namespace,
 'zoekt.gitlab-stars': (project.stargazers_count ?? 0).toString(),
 'zoekt.gitlab-forks': (project.forks_count ?? 0).toString(),
 'zoekt.archived': marshalBool(project.archived),
 'zoekt.fork': marshalBool(isFork),
 'zoekt.public': marshalBool(project.private === false)
 },
 gitConfig: {
 'zoekt.web-url-type': 'gitlab',
 'zoekt.web-url': projectUrl,
 'zoekt.name': project.path_with_namespace,
 'zoekt.gitlab-stars': (project.stargazers_count ?? 0).toString(),
 'zoekt.gitlab-forks': (project.forks_count ?? 0).toString(),
 'zoekt.archived': marshalBool(project.archived),
 'zoekt.fork': marshalBool(isFork),
 'zoekt.public': marshalBool(project.private === false)
 },
 branches: config.revisions?.branches ?? undefined,
 tags: config.revisions?.tags ?? undefined,
 } satisfies RepoMetadata,
 };

 return record;
Expand DownExpand Up@@ -168,13 +177,17 @@ export const compileGiteaConfig = async (
 }
 },
 metadata: {
 'zoekt.web-url-type': 'gitea',
 'zoekt.web-url': repo.html_url!,
 'zoekt.name': repo.full_name!,
 'zoekt.archived': marshalBool(repo.archived),
 'zoekt.fork': marshalBool(repo.fork!),
 'zoekt.public': marshalBool(repo.internal === false && repo.private === false),
 },
 gitConfig: {
 'zoekt.web-url-type': 'gitea',
 'zoekt.web-url': repo.html_url!,
 'zoekt.name': repo.full_name!,
 'zoekt.archived': marshalBool(repo.archived),
 'zoekt.fork': marshalBool(repo.fork!),
 'zoekt.public': marshalBool(repo.internal === false && repo.private === false),
 },
 branches: config.revisions?.branches ?? undefined,
 tags: config.revisions?.tags ?? undefined,
 } satisfies RepoMetadata,
 };

 return record;
Expand DownExpand Up@@ -227,13 +240,15 @@ export const compileGerritConfig = async (
 }
 },
 metadata: {
 'zoekt.web-url-type': 'gitiles',
 'zoekt.web-url': webUrl,
 'zoekt.name': repoId,
 'zoekt.archived': marshalBool(false),
 'zoekt.fork': marshalBool(false),
 'zoekt.public': marshalBool(true),
 },
 gitConfig: {
 'zoekt.web-url-type': 'gitiles',
 'zoekt.web-url': webUrl,
 'zoekt.name': repoId,
 'zoekt.archived': marshalBool(false),
 'zoekt.fork': marshalBool(false),
 'zoekt.public': marshalBool(true),
 },
 } satisfies RepoMetadata,
 };

 return record;
Expand Down

6 changes: 3 additions & 3 deletions
packages/backend/src/repoManager.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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 } from "./types.js";
import { AppContext, Settings, RepoMetadata } from "./types.js";
import { getRepoPath, getTokenFromConfig, measure, getShardPrefix } from "./utils.js";
import { cloneRepository, fetchRepository } from "./git.js";
import { existsSync, rmSync, readdirSync, rm } from 'fs';
Expand DownExpand Up@@ -187,7 +187,7 @@ export class RepoManager implements IRepoManager {
 let cloneDuration_s: number | undefined = undefined;

 const repoPath = getRepoPath(repo, this.ctx);
 const metadata = repo.metadata as Record<string, string>;
 const metadata = repo.metadata as RepoMetadata;

 // 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 
Expand DownExpand Up@@ -223,7 +223,7 @@ export class RepoManager implements IRepoManager {
 cloneUrl = url.toString();
 }

 const { durationMs } = await measure(() => cloneRepository(cloneUrl, repoPath, metadata, ({ method, stage, progress }) => {
 const { durationMs } = await measure(() => cloneRepository(cloneUrl, repoPath, metadata.gitConfig, ({ method, stage, progress }) => {
 //this.logger.info(`git.${method} ${stage} stage ${progress}% complete for ${repo.id}`)
 }));
 cloneDuration_s = durationMs / 1000;
Expand Down

23 changes: 23 additions & 0 deletions
packages/backend/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,6 +49,29 @@ export type Settings = {
 gcGracePeriodMs: number;
}

/**
 * Structure of the `metadata` field in the `Repo` table.
 */
export type RepoMetadata = {
 /**
 * 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>;

 /**
 * A list of branches to index. Glob patterns are supported.
 */
 branches?: string[];

 /**
 * A list of tags to index. Glob patterns are supported.
 */
 tags?: string[];
}


// @see : https://stackoverflow.com/a/61132308
export type DeepPartial<T> = T extends object ? {
 [P in keyof T]?: DeepPartial<T[P]>;
Expand Down

54 changes: 50 additions & 4 deletions
packages/backend/src/zoekt.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,63 @@
import { exec } from "child_process";
import { AppContext } from "./types.js";
import { AppContext, RepoMetadata } from "./types.js";
import { Repo } from "@sourcebot/db";
import { getRepoPath } from "./utils.js";
import { DEFAULT_SETTINGS } from "./constants.js";
import { getShardPrefix } from "./utils.js";
import { getBranches, getTags } from "./git.js";
import micromatch from "micromatch";
import { createLogger } from "./logger.js";
import { captureEvent } from "./posthog.js";

const logger = createLogger('zoekt');

export const indexGitRepository = async (repo: Repo, ctx: AppContext) => {
const revisions = [
let revisions = [
 'HEAD'
 ];

 const shardPrefix = getShardPrefix(repo.orgId, repo.id);

 const repoPath = getRepoPath(repo, ctx);
 const shardPrefix = getShardPrefix(repo.orgId, repo.id);
 const metadata = repo.metadata as RepoMetadata;

 if (metadata.branches) {
 const branchGlobs = metadata.branches
 const allBranches = await getBranches(repoPath);
 const matchingBranches = 
 allBranches
 .filter((branch) => micromatch.isMatch(branch, branchGlobs))
 .map((branch) => `refs/heads/${branch}`);

 revisions = [
 ...revisions,
 ...matchingBranches
 ];
 }

 if (metadata.tags) {
 const tagGlobs = metadata.tags;
 const allTags = await getTags(repoPath);
 const matchingTags = 
 allTags
 .filter((tag) => micromatch.isMatch(tag, tagGlobs))
 .map((tag) => `refs/tags/${tag}`);

 revisions = [
 ...revisions,
 ...matchingTags
 ];
 }

 // zoekt has a limit of 64 branches/tags to index.
 if (revisions.length > 64) {
 logger.warn(`Too many revisions (${revisions.length}) for repo ${repo.id}, truncating to 64`);
Comment thread
brendan-kellam marked this conversation as resolved.

 captureEvent('backend_revisions_truncated', {
 repoId: repo.id,
 revisionCount: revisions.length,
 });
 revisions = revisions.slice(0, 64);
 }

 const command = `zoekt-git-index -allow_missing_branches -index ${ctx.indexPath} -file_limit ${DEFAULT_SETTINGS.maxFileSize} -branches ${revisions.join(',')} -tenant_id ${repo.orgId} -shard_prefix ${shardPrefix} ${repoPath}`;

 return new Promise<{ stdout: string, stderr: string }>((resolve, reject) => {
Expand Down

6 changes: 3 additions & 3 deletions
packages/schemas/src/v3/connection.schema.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,11 +154,11 @@ const schema = {
 },
 "revisions": {
 "type": "object",
 "description": "The revisions (branches, tags) that should be included when indexing. The default branch (HEAD) is always indexed.",
 "description": "The revisions (branches, tags) that should be included when indexing. The default branch (HEAD) is always indexed. A maximum of 64 revisions can be indexed, with any additional revisions being ignored.",
 "properties": {
 "branches": {
 "type": "array",
 "description": "List of branches to include when indexing. For a given repo, only the branches that exist on the repo's remote *and* match at least one of the provided `branches` will be indexed. The default branch (HEAD) is always indexed. Glob patterns are supported.",
 "description": "List of branches to include when indexing. For a given repo, only the branches that exist on the repo's remote *and* match at least one of the provided `branches` will be indexed. The default branch (HEAD) is always indexed. Glob patterns are supported. A maximum of 64 branches can be indexed, with any additional branches being ignored.",
 "items": {
 "type": "string"
 },
Expand All@@ -175,7 +175,7 @@ const schema = {
 },
 "tags": {
 "type": "array",
 "description": "List of tags to include when indexing. For a given repo, only the tags that exist on the repo's remote *and* match at least one of the provided `tags` will be indexed. Glob patterns are supported.",
 "description": "List of tags to include when indexing. For a given repo, only the tags that exist on the repo's remote *and* match at least one of the provided `tags` will be indexed. Glob patterns are supported. A maximum of 64 tags can be indexed, with any additional tags being ignored.",
 "items": {
 "type": "string"
 },
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add back revision support#215

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 3 commits into

from

Feb 27, 2025
 Merged


Add back revision support
#215
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4986006

Store config branches/tags information in repo field. Get branch inf…


brendan-kellam Feb 27, 2025
8f6b05c

remove slow client side hack


brendan-kellam Feb 27, 2025
f2aa63f

feedback


brendan-kellam Feb 27, 2025

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


17 changes: 17 additions & 0 deletions
packages/backend/src/git.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,3 +39,20 @@ export const fetchRepository = async (path: string, onProgress?: (event: SimpleG
 ]
 );
}

export const getBranches = async (path: string) => {
 const git = simpleGit();
 const branches = await git.cwd({
 path,
 }).branch();

 return branches.all;
}

export const getTags = async (path: string) => {
 const git = simpleGit();
 const tags = await git.cwd({
 path,
 }).tags();
 return tags.all;
}

77 changes: 1 addition & 76 deletions
packages/backend/src/gitea.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { Api, giteaApi, HttpResponse, Repository as GiteaRepository } from 'gitea-js';
import { GiteaConnectionConfig } from '@sourcebot/schemas/v3/gitea.type';
import { getTokenFromConfig, measure, fetchWithRetry } from './utils.js';
import { getTokenFromConfig, measure } from './utils.js';
import fetch from 'cross-fetch';
import { createLogger } from './logger.js';
import micromatch from 'micromatch';
Expand DownExpand Up@@ -56,49 +56,6 @@ export const getGiteaReposFromConfig = async (config: GiteaConnectionConfig, org
 return true;
 });


 if (config.revisions) {
 if (config.revisions.branches) {
 const branchGlobs = config.revisions.branches;
 allRepos = await Promise.all(
 allRepos.map(async (repo) => {
 const [owner, name] = repo.full_name!.split('/');
 let branches = (await fetchWithRetry(
 () => getBranchesForRepo(owner, name, api),
 `branches for ${owner}/${name}`,
 logger
 )).map(branch => branch.name!);
 branches = micromatch.match(branches, branchGlobs);

 return {
 ...repo,
 branches,
 };
 })
 )
 }

 if (config.revisions.tags) {
 const tagGlobs = config.revisions.tags;
 allRepos = await Promise.all(
 allRepos.map(async (allRepos) => {
 const [owner, name] = allRepos.full_name!.split('/');
 let tags = (await fetchWithRetry(
 () => getTagsForRepo(owner, name, api),
 `tags for ${owner}/${name}`,
 logger
 )).map(tag => tag.name!);
 tags = micromatch.match(tags, tagGlobs);

 return {
 ...allRepos,
 tags,
 };
 })
 )
 }
 }

 let repos = allRepos
 .filter((repo) => {
 const isExcluded = shouldExcludeRepo({
Expand DownExpand Up@@ -158,38 +115,6 @@ const shouldExcludeRepo = ({
 return shouldExclude;
}

const getTagsForRepo = async <T>(owner: string, repo: string, api: Api<T>) => {
 try {
 logger.debug(`Fetching tags for repo ${owner}/${repo}...`);
 const { durationMs, data: tags } = await measure(() =>
 paginate((page) => api.repos.repoListTags(owner, repo, {
 page
 }))
 );
 logger.debug(`Found ${tags.length} tags in repo ${owner}/${repo} in ${durationMs}ms.`);
 return tags;
 } catch (e) {
 logger.error(`Failed to fetch tags for repo ${owner}/${repo}.`, e);
 throw e;
 }
}

const getBranchesForRepo = async <T>(owner: string, repo: string, api: Api<T>) => {
 try {
 logger.debug(`Fetching branches for repo ${owner}/${repo}...`);
 const { durationMs, data: branches } = await measure(() => 
 paginate((page) => api.repos.repoListBranches(owner, repo, {
 page
 }))
 );
 logger.debug(`Found ${branches.length} branches in repo ${owner}/${repo} in ${durationMs}ms.`);
 return branches;
 } catch (e) {
 logger.error(`Failed to fetch branches for repo ${owner}/${repo}.`, e);
 throw e;
 }
}

const getReposOwnedByUsers = async <T>(users: string[], api: Api<T>) => {
 const results = await Promise.allSettled(users.map(async (user) => {
 try {
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/posthogEvents.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ export type PosthogEventMap = {
 connectionId: number,
 repoCount: number,
 },
 revisions_truncated: {},
 //////////////////////////////////////////////////////////////////
}

Expand Down

2 changes: 1 addition & 1 deletion
packages/backend/src/promClient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import express, { Request, Response } from 'express';
import client, { Registry, Counter, Gauge, Histogram } from 'prom-client';
import client, { Registry, Counter, Gauge } from 'prom-client';

export class PromClient {
 private registry: Registry;
Expand Down

83 changes: 49 additions & 34 deletions
packages/backend/src/repoCompileUtils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { Prisma, PrismaClient } from '@sourcebot/db';
import { WithRequired } from "./types.js"
import { marshalBool } from "./utils.js";
import { GerritConnectionConfig, GiteaConnectionConfig, GitlabConnectionConfig } from '@sourcebot/schemas/v3/connection.type';
import { RepoMetadata } from './types.js';

export type RepoData = WithRequired<Prisma.RepoCreateInput, 'connections'>;

Expand DownExpand Up@@ -54,17 +55,21 @@ export const compileGithubConfig = async (
 }
 },
 metadata: {
 '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(repo.private === false)
 },
 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(repo.private === false),
 },
 branches: config.revisions?.branches ?? undefined,
 tags: config.revisions?.tags ?? undefined,
 } satisfies RepoMetadata,
 };

 return record;
Expand DownExpand Up@@ -113,15 +118,19 @@ export const compileGitlabConfig = async (
 }
 },
 metadata: {
 'zoekt.web-url-type': 'gitlab',
 'zoekt.web-url': projectUrl,
 'zoekt.name': project.path_with_namespace,
 'zoekt.gitlab-stars': (project.stargazers_count ?? 0).toString(),
 'zoekt.gitlab-forks': (project.forks_count ?? 0).toString(),
 'zoekt.archived': marshalBool(project.archived),
 'zoekt.fork': marshalBool(isFork),
 'zoekt.public': marshalBool(project.private === false)
 },
 gitConfig: {
 'zoekt.web-url-type': 'gitlab',
 'zoekt.web-url': projectUrl,
 'zoekt.name': project.path_with_namespace,
 'zoekt.gitlab-stars': (project.stargazers_count ?? 0).toString(),
 'zoekt.gitlab-forks': (project.forks_count ?? 0).toString(),
 'zoekt.archived': marshalBool(project.archived),
 'zoekt.fork': marshalBool(isFork),
 'zoekt.public': marshalBool(project.private === false)
 },
 branches: config.revisions?.branches ?? undefined,
 tags: config.revisions?.tags ?? undefined,
 } satisfies RepoMetadata,
 };

 return record;
Expand DownExpand Up@@ -168,13 +177,17 @@ export const compileGiteaConfig = async (
 }
 },
 metadata: {
 'zoekt.web-url-type': 'gitea',
 'zoekt.web-url': repo.html_url!,
 'zoekt.name': repo.full_name!,
 'zoekt.archived': marshalBool(repo.archived),
 'zoekt.fork': marshalBool(repo.fork!),
 'zoekt.public': marshalBool(repo.internal === false && repo.private === false),
 },
 gitConfig: {
 'zoekt.web-url-type': 'gitea',
 'zoekt.web-url': repo.html_url!,
 'zoekt.name': repo.full_name!,
 'zoekt.archived': marshalBool(repo.archived),
 'zoekt.fork': marshalBool(repo.fork!),
 'zoekt.public': marshalBool(repo.internal === false && repo.private === false),
 },
 branches: config.revisions?.branches ?? undefined,
 tags: config.revisions?.tags ?? undefined,
 } satisfies RepoMetadata,
 };

 return record;
Expand DownExpand Up@@ -227,13 +240,15 @@ export const compileGerritConfig = async (
 }
 },
 metadata: {
 'zoekt.web-url-type': 'gitiles',
 'zoekt.web-url': webUrl,
 'zoekt.name': repoId,
 'zoekt.archived': marshalBool(false),
 'zoekt.fork': marshalBool(false),
 'zoekt.public': marshalBool(true),
 },
 gitConfig: {
 'zoekt.web-url-type': 'gitiles',
 'zoekt.web-url': webUrl,
 'zoekt.name': repoId,
 'zoekt.archived': marshalBool(false),
 'zoekt.fork': marshalBool(false),
 'zoekt.public': marshalBool(true),
 },
 } satisfies RepoMetadata,
 };

 return record;
Expand Down

6 changes: 3 additions & 3 deletions
packages/backend/src/repoManager.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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 } from "./types.js";
import { AppContext, Settings, RepoMetadata } from "./types.js";
import { getRepoPath, getTokenFromConfig, measure, getShardPrefix } from "./utils.js";
import { cloneRepository, fetchRepository } from "./git.js";
import { existsSync, rmSync, readdirSync, rm } from 'fs';
Expand DownExpand Up@@ -187,7 +187,7 @@ export class RepoManager implements IRepoManager {
 let cloneDuration_s: number | undefined = undefined;

 const repoPath = getRepoPath(repo, this.ctx);
 const metadata = repo.metadata as Record<string, string>;
 const metadata = repo.metadata as RepoMetadata;

 // 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 
Expand DownExpand Up@@ -223,7 +223,7 @@ export class RepoManager implements IRepoManager {
 cloneUrl = url.toString();
 }

 const { durationMs } = await measure(() => cloneRepository(cloneUrl, repoPath, metadata, ({ method, stage, progress }) => {
 const { durationMs } = await measure(() => cloneRepository(cloneUrl, repoPath, metadata.gitConfig, ({ method, stage, progress }) => {
 //this.logger.info(`git.${method} ${stage} stage ${progress}% complete for ${repo.id}`)
 }));
 cloneDuration_s = durationMs / 1000;
Expand Down

23 changes: 23 additions & 0 deletions
packages/backend/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,6 +49,29 @@ export type Settings = {
 gcGracePeriodMs: number;
}

/**
 * Structure of the `metadata` field in the `Repo` table.
 */
export type RepoMetadata = {
 /**
 * 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>;

 /**
 * A list of branches to index. Glob patterns are supported.
 */
 branches?: string[];

 /**
 * A list of tags to index. Glob patterns are supported.
 */
 tags?: string[];
}


// @see : https://stackoverflow.com/a/61132308
export type DeepPartial<T> = T extends object ? {
 [P in keyof T]?: DeepPartial<T[P]>;
Expand Down

54 changes: 50 additions & 4 deletions
packages/backend/src/zoekt.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,63 @@
import { exec } from "child_process";
import { AppContext } from "./types.js";
import { AppContext, RepoMetadata } from "./types.js";
import { Repo } from "@sourcebot/db";
import { getRepoPath } from "./utils.js";
import { DEFAULT_SETTINGS } from "./constants.js";
import { getShardPrefix } from "./utils.js";
import { getBranches, getTags } from "./git.js";
import micromatch from "micromatch";
import { createLogger } from "./logger.js";
import { captureEvent } from "./posthog.js";

const logger = createLogger('zoekt');

export const indexGitRepository = async (repo: Repo, ctx: AppContext) => {
const revisions = [
let revisions = [
 'HEAD'
 ];

 const shardPrefix = getShardPrefix(repo.orgId, repo.id);

 const repoPath = getRepoPath(repo, ctx);
 const shardPrefix = getShardPrefix(repo.orgId, repo.id);
 const metadata = repo.metadata as RepoMetadata;

 if (metadata.branches) {
 const branchGlobs = metadata.branches
 const allBranches = await getBranches(repoPath);
 const matchingBranches = 
 allBranches
 .filter((branch) => micromatch.isMatch(branch, branchGlobs))
 .map((branch) => `refs/heads/${branch}`);

 revisions = [
 ...revisions,
 ...matchingBranches
 ];
 }

 if (metadata.tags) {
 const tagGlobs = metadata.tags;
 const allTags = await getTags(repoPath);
 const matchingTags = 
 allTags
 .filter((tag) => micromatch.isMatch(tag, tagGlobs))
 .map((tag) => `refs/tags/${tag}`);

 revisions = [
 ...revisions,
 ...matchingTags
 ];
 }

 // zoekt has a limit of 64 branches/tags to index.
 if (revisions.length > 64) {
 logger.warn(`Too many revisions (${revisions.length}) for repo ${repo.id}, truncating to 64`);
Comment thread
brendan-kellam marked this conversation as resolved.

 captureEvent('backend_revisions_truncated', {
 repoId: repo.id,
 revisionCount: revisions.length,
 });
 revisions = revisions.slice(0, 64);
 }

 const command = `zoekt-git-index -allow_missing_branches -index ${ctx.indexPath} -file_limit ${DEFAULT_SETTINGS.maxFileSize} -branches ${revisions.join(',')} -tenant_id ${repo.orgId} -shard_prefix ${shardPrefix} ${repoPath}`;

 return new Promise<{ stdout: string, stderr: string }>((resolve, reject) => {
Expand Down

6 changes: 3 additions & 3 deletions
packages/schemas/src/v3/connection.schema.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,11 +154,11 @@ const schema = {
 },
 "revisions": {
 "type": "object",
 "description": "The revisions (branches, tags) that should be included when indexing. The default branch (HEAD) is always indexed.",
 "description": "The revisions (branches, tags) that should be included when indexing. The default branch (HEAD) is always indexed. A maximum of 64 revisions can be indexed, with any additional revisions being ignored.",
 "properties": {
 "branches": {
 "type": "array",
 "description": "List of branches to include when indexing. For a given repo, only the branches that exist on the repo's remote *and* match at least one of the provided `branches` will be indexed. The default branch (HEAD) is always indexed. Glob patterns are supported.",
 "description": "List of branches to include when indexing. For a given repo, only the branches that exist on the repo's remote *and* match at least one of the provided `branches` will be indexed. The default branch (HEAD) is always indexed. Glob patterns are supported. A maximum of 64 branches can be indexed, with any additional branches being ignored.",
 "items": {
 "type": "string"
 },
Expand All@@ -175,7 +175,7 @@ const schema = {
 },
 "tags": {
 "type": "array",
 "description": "List of tags to include when indexing. For a given repo, only the tags that exist on the repo's remote *and* match at least one of the provided `tags` will be indexed. Glob patterns are supported.",
 "description": "List of tags to include when indexing. For a given repo, only the tags that exist on the repo's remote *and* match at least one of the provided `tags` will be indexed. Glob patterns are supported. A maximum of 64 tags can be indexed, with any additional tags being ignored.",
 "items": {
 "type": "string"
 },
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Add back revision support#215

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 3 commits into

from

Feb 27, 2025
 Merged


Add back revision support
#215
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4986006

Store config branches/tags information in repo field. Get branch inf…


brendan-kellam Feb 27, 2025
8f6b05c

remove slow client side hack


brendan-kellam Feb 27, 2025
f2aa63f

feedback


brendan-kellam Feb 27, 2025

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


17 changes: 17 additions & 0 deletions
packages/backend/src/git.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,3 +39,20 @@ export const fetchRepository = async (path: string, onProgress?: (event: SimpleG
 ]
 );
}

export const getBranches = async (path: string) => {
 const git = simpleGit();
 const branches = await git.cwd({
 path,
 }).branch();

 return branches.all;
}

export const getTags = async (path: string) => {
 const git = simpleGit();
 const tags = await git.cwd({
 path,
 }).tags();
 return tags.all;
}

77 changes: 1 addition & 76 deletions
packages/backend/src/gitea.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { Api, giteaApi, HttpResponse, Repository as GiteaRepository } from 'gitea-js';
import { GiteaConnectionConfig } from '@sourcebot/schemas/v3/gitea.type';
import { getTokenFromConfig, measure, fetchWithRetry } from './utils.js';
import { getTokenFromConfig, measure } from './utils.js';
import fetch from 'cross-fetch';
import { createLogger } from './logger.js';
import micromatch from 'micromatch';
Expand DownExpand Up@@ -56,49 +56,6 @@ export const getGiteaReposFromConfig = async (config: GiteaConnectionConfig, org
 return true;
 });


 if (config.revisions) {
 if (config.revisions.branches) {
 const branchGlobs = config.revisions.branches;
 allRepos = await Promise.all(
 allRepos.map(async (repo) => {
 const [owner, name] = repo.full_name!.split('/');
 let branches = (await fetchWithRetry(
 () => getBranchesForRepo(owner, name, api),
 `branches for ${owner}/${name}`,
 logger
 )).map(branch => branch.name!);
 branches = micromatch.match(branches, branchGlobs);

 return {
 ...repo,
 branches,
 };
 })
 )
 }

 if (config.revisions.tags) {
 const tagGlobs = config.revisions.tags;
 allRepos = await Promise.all(
 allRepos.map(async (allRepos) => {
 const [owner, name] = allRepos.full_name!.split('/');
 let tags = (await fetchWithRetry(
 () => getTagsForRepo(owner, name, api),
 `tags for ${owner}/${name}`,
 logger
 )).map(tag => tag.name!);
 tags = micromatch.match(tags, tagGlobs);

 return {
 ...allRepos,
 tags,
 };
 })
 )
 }
 }

 let repos = allRepos
 .filter((repo) => {
 const isExcluded = shouldExcludeRepo({
Expand DownExpand Up@@ -158,38 +115,6 @@ const shouldExcludeRepo = ({
 return shouldExclude;
}

const getTagsForRepo = async <T>(owner: string, repo: string, api: Api<T>) => {
 try {
 logger.debug(`Fetching tags for repo ${owner}/${repo}...`);
 const { durationMs, data: tags } = await measure(() =>
 paginate((page) => api.repos.repoListTags(owner, repo, {
 page
 }))
 );
 logger.debug(`Found ${tags.length} tags in repo ${owner}/${repo} in ${durationMs}ms.`);
 return tags;
 } catch (e) {
 logger.error(`Failed to fetch tags for repo ${owner}/${repo}.`, e);
 throw e;
 }
}

const getBranchesForRepo = async <T>(owner: string, repo: string, api: Api<T>) => {
 try {
 logger.debug(`Fetching branches for repo ${owner}/${repo}...`);
 const { durationMs, data: branches } = await measure(() => 
 paginate((page) => api.repos.repoListBranches(owner, repo, {
 page
 }))
 );
 logger.debug(`Found ${branches.length} branches in repo ${owner}/${repo} in ${durationMs}ms.`);
 return branches;
 } catch (e) {
 logger.error(`Failed to fetch branches for repo ${owner}/${repo}.`, e);
 throw e;
 }
}

const getReposOwnedByUsers = async <T>(users: string[], api: Api<T>) => {
 const results = await Promise.allSettled(users.map(async (user) => {
 try {
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/posthogEvents.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ export type PosthogEventMap = {
 connectionId: number,
 repoCount: number,
 },
 revisions_truncated: {},
 //////////////////////////////////////////////////////////////////
}

Expand Down

2 changes: 1 addition & 1 deletion
packages/backend/src/promClient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import express, { Request, Response } from 'express';
import client, { Registry, Counter, Gauge, Histogram } from 'prom-client';
import client, { Registry, Counter, Gauge } from 'prom-client';

export class PromClient {
 private registry: Registry;
Expand Down

83 changes: 49 additions & 34 deletions
packages/backend/src/repoCompileUtils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import { Prisma, PrismaClient } from '@sourcebot/db';
import { WithRequired } from "./types.js"
import { marshalBool } from "./utils.js";
import { GerritConnectionConfig, GiteaConnectionConfig, GitlabConnectionConfig } from '@sourcebot/schemas/v3/connection.type';
import { RepoMetadata } from './types.js';

export type RepoData = WithRequired<Prisma.RepoCreateInput, 'connections'>;

Expand DownExpand Up@@ -54,17 +55,21 @@ export const compileGithubConfig = async (
 }
 },
 metadata: {
 '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(repo.private === false)
 },
 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(repo.private === false),
 },
 branches: config.revisions?.branches ?? undefined,
 tags: config.revisions?.tags ?? undefined,
 } satisfies RepoMetadata,
 };

 return record;
Expand DownExpand Up@@ -113,15 +118,19 @@ export const compileGitlabConfig = async (
 }
 },
 metadata: {
 'zoekt.web-url-type': 'gitlab',
 'zoekt.web-url': projectUrl,
 'zoekt.name': project.path_with_namespace,
 'zoekt.gitlab-stars': (project.stargazers_count ?? 0).toString(),
 'zoekt.gitlab-forks': (project.forks_count ?? 0).toString(),
 'zoekt.archived': marshalBool(project.archived),
 'zoekt.fork': marshalBool(isFork),
 'zoekt.public': marshalBool(project.private === false)
 },
 gitConfig: {
 'zoekt.web-url-type': 'gitlab',
 'zoekt.web-url': projectUrl,
 'zoekt.name': project.path_with_namespace,
 'zoekt.gitlab-stars': (project.stargazers_count ?? 0).toString(),
 'zoekt.gitlab-forks': (project.forks_count ?? 0).toString(),
 'zoekt.archived': marshalBool(project.archived),
 'zoekt.fork': marshalBool(isFork),
 'zoekt.public': marshalBool(project.private === false)
 },
 branches: config.revisions?.branches ?? undefined,
 tags: config.revisions?.tags ?? undefined,
 } satisfies RepoMetadata,
 };

 return record;
Expand DownExpand Up@@ -168,13 +177,17 @@ export const compileGiteaConfig = async (
 }
 },
 metadata: {
 'zoekt.web-url-type': 'gitea',
 'zoekt.web-url': repo.html_url!,
 'zoekt.name': repo.full_name!,
 'zoekt.archived': marshalBool(repo.archived),
 'zoekt.fork': marshalBool(repo.fork!),
 'zoekt.public': marshalBool(repo.internal === false && repo.private === false),
 },
 gitConfig: {
 'zoekt.web-url-type': 'gitea',
 'zoekt.web-url': repo.html_url!,
 'zoekt.name': repo.full_name!,
 'zoekt.archived': marshalBool(repo.archived),
 'zoekt.fork': marshalBool(repo.fork!),
 'zoekt.public': marshalBool(repo.internal === false && repo.private === false),
 },
 branches: config.revisions?.branches ?? undefined,
 tags: config.revisions?.tags ?? undefined,
 } satisfies RepoMetadata,
 };

 return record;
Expand DownExpand Up@@ -227,13 +240,15 @@ export const compileGerritConfig = async (
 }
 },
 metadata: {
 'zoekt.web-url-type': 'gitiles',
 'zoekt.web-url': webUrl,
 'zoekt.name': repoId,
 'zoekt.archived': marshalBool(false),
 'zoekt.fork': marshalBool(false),
 'zoekt.public': marshalBool(true),
 },
 gitConfig: {
 'zoekt.web-url-type': 'gitiles',
 'zoekt.web-url': webUrl,
 'zoekt.name': repoId,
 'zoekt.archived': marshalBool(false),
 'zoekt.fork': marshalBool(false),
 'zoekt.public': marshalBool(true),
 },
 } satisfies RepoMetadata,
 };

 return record;
Expand Down

6 changes: 3 additions & 3 deletions
packages/backend/src/repoManager.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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 } from "./types.js";
import { AppContext, Settings, RepoMetadata } from "./types.js";
import { getRepoPath, getTokenFromConfig, measure, getShardPrefix } from "./utils.js";
import { cloneRepository, fetchRepository } from "./git.js";
import { existsSync, rmSync, readdirSync, rm } from 'fs';
Expand DownExpand Up@@ -187,7 +187,7 @@ export class RepoManager implements IRepoManager {
 let cloneDuration_s: number | undefined = undefined;

 const repoPath = getRepoPath(repo, this.ctx);
 const metadata = repo.metadata as Record<string, string>;
 const metadata = repo.metadata as RepoMetadata;

 // 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 
Expand DownExpand Up@@ -223,7 +223,7 @@ export class RepoManager implements IRepoManager {
 cloneUrl = url.toString();
 }

 const { durationMs } = await measure(() => cloneRepository(cloneUrl, repoPath, metadata, ({ method, stage, progress }) => {
 const { durationMs } = await measure(() => cloneRepository(cloneUrl, repoPath, metadata.gitConfig, ({ method, stage, progress }) => {
 //this.logger.info(`git.${method} ${stage} stage ${progress}% complete for ${repo.id}`)
 }));
 cloneDuration_s = durationMs / 1000;
Expand Down

23 changes: 23 additions & 0 deletions
packages/backend/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,6 +49,29 @@ export type Settings = {
 gcGracePeriodMs: number;
}

/**
 * Structure of the `metadata` field in the `Repo` table.
 */
export type RepoMetadata = {
 /**
 * 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>;

 /**
 * A list of branches to index. Glob patterns are supported.
 */
 branches?: string[];

 /**
 * A list of tags to index. Glob patterns are supported.
 */
 tags?: string[];
}


// @see : https://stackoverflow.com/a/61132308
export type DeepPartial<T> = T extends object ? {
 [P in keyof T]?: DeepPartial<T[P]>;
Expand Down

54 changes: 50 additions & 4 deletions
packages/backend/src/zoekt.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,63 @@
import { exec } from "child_process";
import { AppContext } from "./types.js";
import { AppContext, RepoMetadata } from "./types.js";
import { Repo } from "@sourcebot/db";
import { getRepoPath } from "./utils.js";
import { DEFAULT_SETTINGS } from "./constants.js";
import { getShardPrefix } from "./utils.js";
import { getBranches, getTags } from "./git.js";
import micromatch from "micromatch";
import { createLogger } from "./logger.js";
import { captureEvent } from "./posthog.js";

const logger = createLogger('zoekt');

export const indexGitRepository = async (repo: Repo, ctx: AppContext) => {
const revisions = [
let revisions = [
 'HEAD'
 ];

 const shardPrefix = getShardPrefix(repo.orgId, repo.id);

 const repoPath = getRepoPath(repo, ctx);
 const shardPrefix = getShardPrefix(repo.orgId, repo.id);
 const metadata = repo.metadata as RepoMetadata;

 if (metadata.branches) {
 const branchGlobs = metadata.branches
 const allBranches = await getBranches(repoPath);
 const matchingBranches = 
 allBranches
 .filter((branch) => micromatch.isMatch(branch, branchGlobs))
 .map((branch) => `refs/heads/${branch}`);

 revisions = [
 ...revisions,
 ...matchingBranches
 ];
 }

 if (metadata.tags) {
 const tagGlobs = metadata.tags;
 const allTags = await getTags(repoPath);
 const matchingTags = 
 allTags
 .filter((tag) => micromatch.isMatch(tag, tagGlobs))
 .map((tag) => `refs/tags/${tag}`);

 revisions = [
 ...revisions,
 ...matchingTags
 ];
 }

 // zoekt has a limit of 64 branches/tags to index.
 if (revisions.length > 64) {
 logger.warn(`Too many revisions (${revisions.length}) for repo ${repo.id}, truncating to 64`);
Comment thread
brendan-kellam marked this conversation as resolved.

 captureEvent('backend_revisions_truncated', {
 repoId: repo.id,
 revisionCount: revisions.length,
 });
 revisions = revisions.slice(0, 64);
 }

 const command = `zoekt-git-index -allow_missing_branches -index ${ctx.indexPath} -file_limit ${DEFAULT_SETTINGS.maxFileSize} -branches ${revisions.join(',')} -tenant_id ${repo.orgId} -shard_prefix ${shardPrefix} ${repoPath}`;

 return new Promise<{ stdout: string, stderr: string }>((resolve, reject) => {
Expand Down

6 changes: 3 additions & 3 deletions
packages/schemas/src/v3/connection.schema.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,11 +154,11 @@ const schema = {
 },
 "revisions": {
 "type": "object",
 "description": "The revisions (branches, tags) that should be included when indexing. The default branch (HEAD) is always indexed.",
 "description": "The revisions (branches, tags) that should be included when indexing. The default branch (HEAD) is always indexed. A maximum of 64 revisions can be indexed, with any additional revisions being ignored.",
 "properties": {
 "branches": {
 "type": "array",
 "description": "List of branches to include when indexing. For a given repo, only the branches that exist on the repo's remote *and* match at least one of the provided `branches` will be indexed. The default branch (HEAD) is always indexed. Glob patterns are supported.",
 "description": "List of branches to include when indexing. For a given repo, only the branches that exist on the repo's remote *and* match at least one of the provided `branches` will be indexed. The default branch (HEAD) is always indexed. Glob patterns are supported. A maximum of 64 branches can be indexed, with any additional branches being ignored.",
 "items": {
 "type": "string"
 },
Expand All@@ -175,7 +175,7 @@ const schema = {
 },
 "tags": {
 "type": "array",
 "description": "List of tags to include when indexing. For a given repo, only the tags that exist on the repo's remote *and* match at least one of the provided `tags` will be indexed. Glob patterns are supported.",
 "description": "List of tags to include when indexing. For a given repo, only the tags that exist on the repo's remote *and* match at least one of the provided `tags` will be indexed. Glob patterns are supported. A maximum of 64 tags can be indexed, with any additional tags being ignored.",
 "items": {
 "type": "string"
 },
Expand Down
Loading