ti.sil/sourcebot
1
0
Fork 0
mirror of https://github.com/sourcebot-dev/sourcebot.git synced 2025-12-11 20:05:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

fix(worker): Remove setting remote.origin.url for remote git repositories (#483)

Browse source
This commit is contained in:
Brendan Kellam 2025-08-31 13:52:51 -04:00 committed by GitHub
parent ca9069e0fa
commit 2b423ba7e9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 122 additions and 60 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
CHANGELOG.md
View file

@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]
### Fixed
- Remove setting `remote.origin.url` for remote git repositories. [#483](https://github.com/sourcebot-dev/sourcebot/pull/483)
### Changed
- Updated NextJS to version 15. [#477](https://github.com/sourcebot-dev/sourcebot/pull/477)
- Add `sessionToken` as optional Bedrock configuration parameter. [#478](https://github.com/sourcebot-dev/sourcebot/pull/478)

1
packages/backend/src/env.ts
View file

@ -43,6 +43,7 @@ export const env = createEnv({
LOGTAIL_TOKEN: z.string().optional(),
LOGTAIL_HOST: z.string().url().optional(),
SOURCEBOT_LOG_LEVEL: z.enum(["info", "debug", "warn", "error"]).default("info"),
DATABASE_URL: z.string().url().default("postgresql://postgres:postgres@localhost:5432/postgres"),
CONFIG_PATH: z.string().optional(),

101
packages/backend/src/git.ts
View file

@ -1,53 +1,72 @@
import { CheckRepoActions, GitConfigScope, simpleGit, SimpleGitProgressEvent } from 'simple-git';
import { mkdir } from 'node:fs/promises';
import { env } from './env.js';
type onProgressFn = (event: SimpleGitProgressEvent) => void;
export const cloneRepository = async (cloneURL: string, path: string, onProgress?: onProgressFn) => {
export const cloneRepository = async (
remoteUrl: URL,
path: string,
onProgress?: onProgressFn
) => {
try {
await mkdir(path, { recursive: true });
const git = simpleGit({
progress: onProgress,
});
try {
await git.clone(
cloneURL,
}).cwd({
path,
[
"--bare",
]
);
})
await git.cwd({
path,
}).addConfig("remote.origin.fetch", "+refs/heads/*:refs/heads/*");
await git.init(/*bare = */ true);
await git.fetch([
remoteUrl.toString(),
// See https://git-scm.com/book/en/v2/Git-Internals-The-Refspec
"+refs/heads/*:refs/heads/*",
"--progress",
]);
} catch (error: unknown) {
if (error instanceof Error) {
throw new Error(`Failed to clone repository: ${error.message}`);
const baseLog = `Failed to clone repository: ${path}`;
if (env.SOURCEBOT_LOG_LEVEL !== "debug") {
// Avoid printing the remote URL (that may contain credentials) to logs by default.
throw new Error(`${baseLog}. Set environment variable SOURCEBOT_LOG_LEVEL=debug to see the full error message.`);
} else if (error instanceof Error) {
throw new Error(`${baseLog}. Reason: ${error.message}`);
} else {
throw new Error(`Failed to clone repository: ${error}`);
throw new Error(`${baseLog}. Error: ${error}`);
}
}
}
};
export const fetchRepository = async (path: string, onProgress?: onProgressFn) => {
export const fetchRepository = async (
remoteUrl: URL,
path: string,
onProgress?: onProgressFn
) => {
try {
const git = simpleGit({
progress: onProgress,
});
try {
await git.cwd({
}).cwd({
path: path,
}).fetch(
"origin",
[
})
await git.fetch([
remoteUrl.toString(),
"+refs/heads/*:refs/heads/*",
"--prune",
"--progress"
]
);
]);
} catch (error: unknown) {
if (error instanceof Error) {
throw new Error(`Failed to fetch repository ${path}: ${error.message}`);
const baseLog = `Failed to fetch repository: ${path}`;
if (env.SOURCEBOT_LOG_LEVEL !== "debug") {
// Avoid printing the remote URL (that may contain credentials) to logs by default.
throw new Error(`${baseLog}. Set environment variable SOURCEBOT_LOG_LEVEL=debug to see the full error message.`);
} else if (error instanceof Error) {
throw new Error(`${baseLog}. Reason: ${error.message}`);
} else {
throw new Error(`Failed to fetch repository ${path}: ${error}`);
throw new Error(`${baseLog}. Error: ${error}`);
}
}
}
@ -76,6 +95,28 @@ export const upsertGitConfig = async (path: string, gitConfig: Record<string, st
}
}
/**
* Unsets the specified keys in the git config for the repo at the given path.
* If a key is not set, this is a no-op.
*/
export const unsetGitConfig = async (path: string, keys: string[], onProgress?: onProgressFn) => {
const git = simpleGit({
progress: onProgress,
}).cwd(path);
try {
for (const key of keys) {
await git.raw(['config', '--unset', key]);
}
} catch (error: unknown) {
if (error instanceof Error) {
throw new Error(`Failed to unset git config ${path}: ${error.message}`);
} else {
throw new Error(`Failed to unset git config ${path}: ${error}`);
}
}
}
/**
* Returns true if `path` is the _root_ of a git repository.
*/

61
packages/backend/src/repoManager.ts
View file

@ -5,7 +5,7 @@ import { Connection, PrismaClient, Repo, RepoToConnection, RepoIndexingStatus, S
import { GithubConnectionConfig, GitlabConnectionConfig, GiteaConnectionConfig, BitbucketConnectionConfig } from '@sourcebot/schemas/v3/connection.type';
import { AppContext, Settings, repoMetadataSchema } from "./types.js";
import { getRepoPath, getTokenFromConfig, measure, getShardPrefix } from "./utils.js";
import { cloneRepository, fetchRepository, upsertGitConfig } from "./git.js";
import { cloneRepository, fetchRepository, unsetGitConfig, upsertGitConfig } from "./git.js";
import { existsSync, readdirSync, promises } from 'fs';
import { indexGitRepository } from "./zoekt.js";
import { PromClient } from './promClient.js';
@ -237,12 +237,39 @@ export class RepoManager implements IRepoManager {
await promises.rm(repoPath, { recursive: true, force: true });
}
if (existsSync(repoPath) && !isReadOnly) {
logger.info(`Fetching ${repo.displayName}...`);
const credentials = await this.getCloneCredentialsForRepo(repo, this.db);
const remoteUrl = new URL(repo.cloneUrl);
if (credentials) {
// @note: URL has a weird behavior where if you set the password but
// _not_ the username, the ":" delimiter will still be present in the
// URL (e.g., https://:password@example.com). To get around this, if
// we only have a password, we set the username to the password.
// @see: https://www.typescriptlang.org/play/?#code/MYewdgzgLgBArgJwDYwLwzAUwO4wKoBKAMgBQBEAFlFAA4QBcA9I5gB4CGAtjUpgHShOZADQBKANwAoREj412ECNhAIAJmhhl5i5WrJTQkELz5IQAcxIy+UEAGUoCAJZhLo0UA
if (!credentials.username) {
remoteUrl.username = credentials.password;
} else {
remoteUrl.username = credentials.username;
remoteUrl.password = credentials.password;
}
}
const { durationMs } = await measure(() => fetchRepository(repoPath, ({ method, stage, progress }) => {
if (existsSync(repoPath) && !isReadOnly) {
// @NOTE: in #483, we changed the cloning method s.t., we _no longer_
// write the clone URL (which could contain a auth token) to the
// `remote.origin.url` entry. For the upgrade scenario, we want
// to unset this key since it is no longer needed, hence this line.
// This will no-op if the key is already unset.
// @see: https://github.com/sourcebot-dev/sourcebot/pull/483
await unsetGitConfig(repoPath, ["remote.origin.url"]);
logger.info(`Fetching ${repo.displayName}...`);
const { durationMs } = await measure(() => fetchRepository(
remoteUrl,
repoPath,
({ method, stage, progress }) => {
logger.debug(`git.${method} ${stage} stage ${progress}% complete for ${repo.displayName}`)
}));
}
));
const fetchDuration_s = durationMs / 1000;
process.stdout.write('\n');
@ -251,25 +278,13 @@ export class RepoManager implements IRepoManager {
} else if (!isReadOnly) {
logger.info(`Cloning ${repo.displayName}...`);
const auth = await this.getCloneCredentialsForRepo(repo, this.db);
const cloneUrl = new URL(repo.cloneUrl);
if (auth) {
// @note: URL has a weird behavior where if you set the password but
// _not_ the username, the ":" delimiter will still be present in the
// URL (e.g., https://:password@example.com). To get around this, if
// we only have a password, we set the username to the password.
// @see: https://www.typescriptlang.org/play/?#code/MYewdgzgLgBArgJwDYwLwzAUwO4wKoBKAMgBQBEAFlFAA4QBcA9I5gB4CGAtjUpgHShOZADQBKANwAoREj412ECNhAIAJmhhl5i5WrJTQkELz5IQAcxIy+UEAGUoCAJZhLo0UA
if (!auth.username) {
cloneUrl.username = auth.password;
} else {
cloneUrl.username = auth.username;
cloneUrl.password = auth.password;
}
}
const { durationMs } = await measure(() => cloneRepository(cloneUrl.toString(), repoPath, ({ method, stage, progress }) => {
const { durationMs } = await measure(() => cloneRepository(
remoteUrl,
repoPath,
({ method, stage, progress }) => {
logger.debug(`git.${method} ${stage} stage ${progress}% complete for ${repo.displayName}`)
}));
}
));
const cloneDuration_s = durationMs / 1000;
process.stdout.write('\n');

1
packages/web/src/app/[domain]/browse/[...path]/components/codePreviewPanel.tsx
View file

@ -45,6 +45,7 @@ export const CodePreviewPanel = async ({ path, repoName, revisionName, domain }:
displayName: repoInfoResponse.displayName,
webUrl: repoInfoResponse.webUrl,
}}
branchDisplayName={revisionName}
/>
{(fileSourceResponse.webUrl && codeHostInfo) && (
<a

1
packages/web/src/app/[domain]/browse/[...path]/components/treePreviewPanel.tsx
View file

@ -40,6 +40,7 @@ export const TreePreviewPanel = async ({ path, repoName, revisionName, domain }:
}}
pathType="tree"
isFileIconVisible={false}
branchDisplayName={revisionName}
/>
</div>
<Separator />