-
Notifications
You must be signed in to change notification settings - Fork 264
Expand file tree
/
Copy pathgit.ts
More file actions
259 lines (227 loc) · 7.58 KB
/
git.ts
File metadata and controls
259 lines (227 loc) · 7.58 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
import { CheckRepoActions, GitConfigScope, simpleGit, SimpleGitProgressEvent } from 'simple-git';
import { mkdir } from 'node:fs/promises';
import { env } from './env.js';
type onProgressFn = (event: SimpleGitProgressEvent) => void;
// Helper function to prepare Azure DevOps authentication
const prepareAzureDevOpsAuth = (cloneUrl: string) => {
// Check if this is an Azure DevOps URL
const isAzureDevOps = cloneUrl.includes('dev.azure.com') || cloneUrl.includes('devops');
if (!isAzureDevOps) {
return { url: cloneUrl, authHeader: null };
}
let token = '';
try {
const url = new (globalThis as any).URL(cloneUrl);
token = url.password;
} catch (e) {
return { url: cloneUrl, authHeader: null };
}
if (!token) {
return { url: cloneUrl, authHeader: null };
}
// For Azure DevOps, we need to remove the token from the URL and pass it as a header
const url = new (globalThis as any).URL(cloneUrl);
url.password = '';
const cleanUrl = url.toString();
// Create the authorization header
const authHeader = `Authorization: Basic ${(globalThis as any).Buffer.from(`:${token}`).toString('base64')}`;
return { url: cleanUrl, authHeader };
};
export const cloneRepository = async (
{
cloneUrl,
path,
onProgress,
}: {
cloneUrl: string,
path: string,
onProgress?: onProgressFn
}
) => {
try {
await mkdir(path, { recursive: true });
const git = simpleGit({
progress: onProgress,
}).cwd({
path,
})
const { url: cleanUrl, authHeader } = prepareAzureDevOpsAuth(cloneUrl);
if (authHeader) {
await git.clone(
cleanUrl,
path,
[
"--bare",
"-c",
`http.extraHeader=${authHeader}`
]
);
} else {
await git.clone(
cloneUrl,
path,
[
"--bare",
]
);
}
await unsetGitConfig(path, ["remote.origin.url"]);
} catch (error: unknown) {
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(`${baseLog}. Error: ${error}`);
}
}
};
export const fetchRepository = async (
{
cloneUrl,
path,
onProgress,
}: {
cloneUrl: string,
path: string,
onProgress?: onProgressFn
}
) => {
try {
const git = simpleGit({
progress: onProgress,
}).cwd({
path: path,
})
const { url: cleanUrl, authHeader } = prepareAzureDevOpsAuth(cloneUrl);
if (authHeader) {
// Temporarily set git configuration
await git.addConfig('http.extraHeader', authHeader);
await git.fetch([
cleanUrl,
"+refs/heads/*:refs/heads/*",
"--prune",
"--progress"
]);
} else {
await git.fetch([
cloneUrl,
"+refs/heads/*:refs/heads/*",
"--prune",
"--progress"
]);
}
} catch (error: unknown) {
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(`${baseLog}. Error: ${error}`);
}
}
}
/**
* Applies the gitConfig to the repo at the given path. Note that this will
* override the values for any existing keys, and append new values for keys
* that do not exist yet. It will _not_ remove any existing keys that are not
* present in gitConfig.
*/
export const upsertGitConfig = async (path: string, gitConfig: Record<string, string>, onProgress?: onProgressFn) => {
const git = simpleGit({
progress: onProgress,
}).cwd(path);
try {
for (const [key, value] of Object.entries(gitConfig)) {
await git.addConfig(key, value);
}
} catch (error: unknown) {
if (error instanceof Error) {
throw new Error(`Failed to set git config ${path}: ${error.message}`);
} else {
throw new Error(`Failed to set git config ${path}: ${error}`);
}
}
}
/**
* 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 {
const configList = await git.listConfig();
const setKeys = Object.keys(configList.all);
for (const key of keys) {
if (setKeys.includes(key)) {
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.
*/
export const isPathAValidGitRepoRoot = async (path: string, onProgress?: onProgressFn) => {
const git = simpleGit({
progress: onProgress,
}).cwd(path);
try {
return git.checkIsRepo(CheckRepoActions.IS_REPO_ROOT);
} catch (error: unknown) {
if (error instanceof Error) {
throw new Error(`isPathAGitRepoRoot failed: ${error.message}`);
} else {
throw new Error(`isPathAGitRepoRoot failed: ${error}`);
}
}
}
export const isUrlAValidGitRepo = async (url: string) => {
const git = simpleGit();
// List the remote heads. If an exception is thrown, the URL is not a valid git repo.
try {
const result = await git.listRemote(['--heads', url]);
return result.trim().length > 0;
} catch (error: unknown) {
return false;
}
}
export const getOriginUrl = async (path: string) => {
const git = simpleGit().cwd(path);
try {
const remotes = await git.getConfig('remote.origin.url', GitConfigScope.local);
return remotes.value;
} catch (error: unknown) {
if (error instanceof Error) {
throw new Error(`Failed to get origin for ${path}: ${error.message}`);
} else {
throw new Error(`Failed to get origin for ${path}: ${error}`);
}
}
}
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;
}