mirror of
https://github.com/hanzoai/azure-sdk-for-js.git
synced 2026-10-30 19:51:51 +00:00
Sync eng/common directory with azure-sdk-tools for PR https://github.com/Azure/azure-sdk-tools/pull/16330 See [eng/common workflow](https://github.com/Azure/azure-sdk-tools/blob/main/eng/common/README.md#workflow) --------- Co-authored-by: helen229 <[email protected]>
135 lines
5.2 KiB
TypeScript
135 lines
5.2 KiB
TypeScript
// Ensures a shallow + sparse cache clone of a git repo exists and is reasonably fresh.
|
|
// First run: shallow blobless cone-sparse clone. Within maxAgeHours: no-op. Past that:
|
|
// fetch + checkout. Primes the cache Vally's `environment.git` fixtures point at; FETCH_HEAD
|
|
// is landed on a local branch named <ref> so `git worktree add --detach <tmp> <ref>` resolves.
|
|
|
|
import fs from "node:fs";
|
|
import path from "node:path";
|
|
import { pathToFileURL } from "node:url";
|
|
import { execFile, isExecError } from "./lib/exec.ts";
|
|
|
|
// Throws on non-zero git exit so a failed clone stops immediately. Delegates to the shared
|
|
// execFile helper (copied from azure-rest-api-specs; see lib/exec.ts), which runs git without a
|
|
// shell (no injection) and captures output; git's stderr is surfaced only when the command fails.
|
|
async function invokeGit(args: string[]): Promise<void> {
|
|
try {
|
|
await execFile("git", args);
|
|
} catch (error) {
|
|
if (isExecError(error) && error.stderr) {
|
|
process.stderr.write(error.stderr);
|
|
}
|
|
throw new Error(`git ${args.join(" ")} failed`);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Clones or refreshes the cache and returns its path.
|
|
*
|
|
* @param {object} options
|
|
* @param {string} [options.cacheRoot] Cache root dir (default <cwd>/artifacts/specs-cache).
|
|
* @param {string} [options.repoUrl] Clone URL.
|
|
* @param {string} [options.repoName] Cache sub-folder name.
|
|
* @param {string} [options.ref] Branch/ref to check out.
|
|
* @param {string[]} [options.sparseCheckoutPaths] Cone-sparse paths (pass [] for full tree).
|
|
* @param {number} [options.maxAgeHours] Skip the refresh fetch if cached within this window.
|
|
* @returns {Promise<string>} The cache path.
|
|
*/
|
|
export async function syncRepo({
|
|
cacheRoot,
|
|
repoUrl = "https://github.com/Azure/azure-rest-api-specs.git",
|
|
repoName = "azure-rest-api-specs",
|
|
ref = "main",
|
|
sparseCheckoutPaths = ["specification/contosowidgetmanager", "specification/ai/Face"],
|
|
maxAgeHours = 24,
|
|
} = {}) {
|
|
if (!cacheRoot) {
|
|
cacheRoot = path.join(process.cwd(), "artifacts", "specs-cache");
|
|
}
|
|
const cache = path.join(cacheRoot, repoName);
|
|
const stamp = path.join(cache, ".vally-last-fetch");
|
|
|
|
if (!fs.existsSync(path.join(cache, ".git"))) {
|
|
console.log(`[sync-eval-git-repo] Cloning ${repoName} (${ref}) into cache: ${cache}`);
|
|
fs.mkdirSync(cache, { recursive: true });
|
|
// init + fetch <ref> (not clone --depth 1) so any branch/tag/SHA is pinned on a cold cache.
|
|
await invokeGit(["-C", cache, "init", "--quiet"]);
|
|
await invokeGit(["-C", cache, "remote", "add", "origin", repoUrl]);
|
|
if (sparseCheckoutPaths.length > 0) {
|
|
await invokeGit(["-C", cache, "sparse-checkout", "init", "--cone"]);
|
|
await invokeGit(["-C", cache, "sparse-checkout", "set", ...sparseCheckoutPaths]);
|
|
}
|
|
await invokeGit(["-C", cache, "fetch", "--depth", "1", "--filter=blob:none", "origin", ref]);
|
|
// Land FETCH_HEAD on a real local branch named <ref> (not detached) so Vally's worktree
|
|
// fixtures can resolve `git worktree add --detach <tmp> <ref>`.
|
|
await invokeGit(["-C", cache, "checkout", "-B", ref, "FETCH_HEAD"]);
|
|
fs.writeFileSync(stamp, new Date().toISOString());
|
|
} else {
|
|
let stale = true;
|
|
if (fs.existsSync(stamp)) {
|
|
const ageHours = (Date.now() - fs.statSync(stamp).mtimeMs) / 3_600_000;
|
|
stale = ageHours > maxAgeHours;
|
|
}
|
|
if (stale) {
|
|
console.log(`[sync-eval-git-repo] Refreshing cache (>${maxAgeHours}h old): ${cache}`);
|
|
await invokeGit(["-C", cache, "fetch", "--depth", "1", "origin", ref]);
|
|
// Re-point the local <ref> branch at FETCH_HEAD (also repairs a previously detached cache)
|
|
// so the worktree fixtures keep resolving.
|
|
await invokeGit(["-C", cache, "checkout", "-B", ref, "FETCH_HEAD"]);
|
|
fs.writeFileSync(stamp, new Date().toISOString());
|
|
} else {
|
|
console.log(`[sync-eval-git-repo] Cache is fresh (<${maxAgeHours}h): ${cache}`);
|
|
}
|
|
}
|
|
|
|
return cache;
|
|
}
|
|
|
|
// ----- CLI -----
|
|
|
|
function parseArgs(argv) {
|
|
const options = { sparseCheckoutPaths: [], maxAgeHours: 24 };
|
|
let sparseGiven = false;
|
|
for (let i = 0; i < argv.length; i++) {
|
|
const next = () => argv[++i];
|
|
switch (argv[i]) {
|
|
case "--cache-root":
|
|
options.cacheRoot = next();
|
|
break;
|
|
case "--repo-url":
|
|
options.repoUrl = next();
|
|
break;
|
|
case "--repo-name":
|
|
options.repoName = next();
|
|
break;
|
|
case "--ref":
|
|
options.ref = next();
|
|
break;
|
|
case "--sparse":
|
|
options.sparseCheckoutPaths.push(next());
|
|
sparseGiven = true;
|
|
break;
|
|
case "--max-age-hours":
|
|
options.maxAgeHours = Number(next());
|
|
break;
|
|
default:
|
|
throw new Error(`Unknown argument: ${argv[i]}`);
|
|
}
|
|
}
|
|
// Only override the default sparse paths when --sparse was actually passed.
|
|
if (!sparseGiven) {
|
|
delete options.sparseCheckoutPaths;
|
|
}
|
|
return options;
|
|
}
|
|
|
|
if (process.argv[1] && import.meta.url === pathToFileURL(process.argv[1]).href) {
|
|
syncRepo(parseArgs(process.argv.slice(2)))
|
|
.then((cache) => {
|
|
console.log(cache); // echo the cache path so a wrapper can capture it
|
|
})
|
|
.catch((error) => {
|
|
console.error(error instanceof Error ? error.message : error);
|
|
process.exit(1);
|
|
});
|
|
}
|