Skip to content

refactor(git/instrument): correct types + always return #39664

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

Open
jamietanna wants to merge 1 commit into
base: main
Choose a base branch
from
Open

refactor(git/instrument): correct types + always return #39664

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
45 changes: 31 additions & 14 deletions lib/util/git/instrument.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import type {
DiffResult,
LogOptions,
LogResult,
MergeResult,
Options,
RemoteWithRefs,
RemoteWithoutRefs,
Expand Down Expand Up @@ -122,7 +123,7 @@ export class InstrumentedSimpleGit {
async checkoutBranch(branch: string, startPoint: string): Promise<void> {
const { spanName, options } = prepareInstrumentation('checkout');

await instrument(
return await instrument(
spanName,
() => this.git.checkoutBranch(branch, startPoint),
options,
Expand All @@ -143,25 +144,33 @@ export class InstrumentedSimpleGit {

return await instrument(spanName, () => this.git.add(files), options);
}
async addConfig(key: string, value: string): Promise<void> {
async addConfig(key: string, value: string): Promise<string> {
const { spanName, options } = prepareInstrumentation('config');

await instrument(spanName, () => this.git.addConfig(key, value), options);
return await instrument(
spanName,
() => this.git.addConfig(key, value),
options,
);
}
async rm(files: string | string[]): Promise<void> {
const { spanName, options } = prepareInstrumentation('rm');

await instrument(spanName, () => this.git.rm(files), options);
return await instrument(spanName, () => this.git.rm(files), options);
}
async reset(modeOrOptions: any): Promise<void> {
async reset(modeOrOptions: any): Promise<string> {
const { spanName, options } = prepareInstrumentation('reset');

await instrument(spanName, () => this.git.reset(modeOrOptions), options);
return await instrument(
spanName,
() => this.git.reset(modeOrOptions),
options,
);
}
async merge(args: string[]): Promise<void> {
async merge(args: string[]): Promise<MergeResult> {
const { spanName, options } = prepareInstrumentation('merge');

await instrument(spanName, () => this.git.merge(args), options);
return await instrument(spanName, () => this.git.merge(args), options);
}
async push(...args: any[]): Promise<any> {
const { spanName, options } = prepareInstrumentation('push');
Expand All @@ -178,10 +187,10 @@ export class InstrumentedSimpleGit {

return await instrument(spanName, () => this.git.fetch(args), options);
}
async clone(repo: string, dir: string, options: string[]): Promise<void> {
async clone(repo: string, dir: string, options: string[]): Promise<string> {
const { spanName, options: spanOptions } = prepareInstrumentation('clone');

await instrument(
return await instrument(
spanName,
() => this.git.clone(repo, dir, options),
spanOptions,
Expand Down Expand Up @@ -264,10 +273,14 @@ export class InstrumentedSimpleGit {
options,
);
}
async addRemote(name: string, repo: string): Promise<void> {
async addRemote(name: string, repo: string): Promise<string> {
const { spanName, options } = prepareInstrumentation('remote');

await instrument(spanName, () => this.git.addRemote(name, repo), options);
return await instrument(
spanName,
() => this.git.addRemote(name, repo),
options,
);
}
env(env: Record<string, string>): this {
this.git = this.git.env(env);
Expand All @@ -283,9 +296,13 @@ export class InstrumentedSimpleGit {

return await instrument(spanName, () => this.git.listRemote(args), options);
}
async submoduleUpdate(args: string[]): Promise<void> {
async submoduleUpdate(args: string[]): Promise<string> {
const { spanName, options } = prepareInstrumentation('submodule');

await instrument(spanName, () => this.git.submoduleUpdate(args), options);
return await instrument(
spanName,
() => this.git.submoduleUpdate(args),
options,
);
}
}