Skip to content

fix(validation): support nested Git workspace roots #298

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

Draft
saasom wants to merge 1 commit into
base: dev
Choose a base branch
from
+68 −14
Draft

fix(validation): support nested Git workspace roots #298

Show file tree
Hide file tree
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 packages/validation/src/workspace.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,18 @@ export interface CreateNodeValidationWorkspaceOptions {

export function createNodeValidationWorkspace(options: CreateNodeValidationWorkspaceOptions): ValidationWorkspace {
const repoRoot = resolve(options.repoRoot);
const gitPrefix = resolveGitPrefix(repoRoot);
const skippedPathSegments = new Set(options.skippedPathSegments ?? []);
return {
readFile: (path, context) => readWorkspaceFile(repoRoot, path, context),
readFile: (path, context) => readWorkspaceFile(repoRoot, gitPrefix, path, context),
listFiles: (context) => filterFileSet(listWorkspaceFiles(repoRoot, context, skippedPathSegments), skippedPathSegments),
listChangedFiles: (baseRef) => filterFileSet(listChangedFiles(repoRoot, baseRef), skippedPathSegments),
listTreeFiles: (treeRef, changedFrom) => filterFileSet(listTreeFiles(repoRoot, treeRef, changedFrom), skippedPathSegments),
listStagedFiles: () =>
filterFileSet(listDiffFiles(repoRoot, ["diff", "--cached", "--name-status", "-z", "--find-renames", "--"]), skippedPathSegments),
filterFileSet(
listDiffFiles(repoRoot, ["diff", "--relative", "--cached", "--name-status", "-z", "--find-renames", "--", "."]),
skippedPathSegments
),
listRepoFiles: () => filterFileSet(listRepoFiles(repoRoot), skippedPathSegments),
listPackageFiles: async (_packageName, packageRoot) => {
const files = filterFileSet(await listRepoFiles(repoRoot), skippedPathSegments);
Expand All @@ -47,15 +51,16 @@ export function createNodeValidationWorkspace(options: CreateNodeValidationWorks

async function readWorkspaceFile(
repoRoot: string,
gitPrefix: string,
path: string,
context?: ValidationWorkspaceReadContext
): Promise<ValidationWorkspaceReadFileResult> {
const beforeRef = beforeStateTreeRef(repoRoot, context);
if (beforeRef !== undefined) return readTreeFile(repoRoot, beforeRef, path);
if (beforeRef !== undefined) return readTreeFile(repoRoot, gitPrefix, beforeRef, path);
if (context?.scope.kind === "tree" && context.scope.treeRef !== undefined) {
return readTreeFile(repoRoot, context.scope.treeRef, path);
return readTreeFile(repoRoot, gitPrefix, context.scope.treeRef, path);
}
if (context?.scope.kind === "staged") return readStagedFile(repoRoot, path);
if (context?.scope.kind === "staged") return readStagedFile(repoRoot, gitPrefix, path);
return readDiskFile(repoRoot, path);
}

Expand Down Expand Up @@ -98,9 +103,9 @@ function hasSkippedSegment(path: string, skippedPathSegments: ReadonlySet<string
return path.split(/[\\/]+/).some((segment) => skippedPathSegments.has(segment));
}

function readStagedFile(repoRoot: string, path: string): ValidationWorkspaceReadFileResult {
function readStagedFile(repoRoot: string, gitPrefix: string, path: string): ValidationWorkspaceReadFileResult {
const normalized = validateRepoRelativePath(path);
const result = git(repoRoot, ["show", `:${normalized}`]);
const result = git(repoRoot, ["show", `:${gitRepoPath(gitPrefix, normalized)}`]);
if (result.ok) return { status: "found", content: result.stdout };
if (/exists on disk, but not in|Path .* exists, but not|does not exist/.test(result.cause)) {
return { status: "missing" };
Expand All @@ -111,9 +116,9 @@ function readStagedFile(repoRoot: string, path: string): ValidationWorkspaceRead
function listChangedFiles(repoRoot: string, baseRef: string): ValidationWorkspaceFileSet {
const base = resolveChangedBase(repoRoot, baseRef);
if (!base.ok) return unavailable(base);
const diff = listDiffFiles(repoRoot, ["diff", "--name-status", "-z", "--find-renames", base.diffBase, "--"]);
const diff = listDiffFiles(repoRoot, ["diff", "--relative", "--name-status", "-z", "--find-renames", base.diffBase, "--", "."]);
if (diff.unavailable) return diff;
const untracked = git(repoRoot, ["ls-files", "--others", "--exclude-standard", "-z"]);
const untracked = git(repoRoot, ["ls-files", "--others", "--exclude-standard", "-z", "--", "."]);
if (!untracked.ok) return unavailable(untracked);
return {
files: [
Expand All @@ -131,7 +136,7 @@ function listTreeFiles(repoRoot: string, treeRef: string, changedFrom: string):
if (!tree.ok) return unavailable(tree);
const base = resolveTreeish(repoRoot, changedFrom);
if (!base.ok) return unavailable(base);
return listDiffFiles(repoRoot, ["diff", "--name-status", "-z", "--find-renames", base.treeSha, tree.treeSha, "--"]);
return listDiffFiles(repoRoot, ["diff", "--relative", "--name-status", "-z", "--find-renames", base.treeSha, tree.treeSha, "--", "."]);
}

function listWorkspaceFiles(
Expand Down Expand Up @@ -185,28 +190,28 @@ function listDiskFiles(repoRoot: string, skippedPathSegments: ReadonlySet<string
function listTreeSnapshotFiles(repoRoot: string, treeRef: string): ValidationWorkspaceFileSet {
const tree = resolveTreeish(repoRoot, treeRef);
if (!tree.ok) return unavailable(tree);
const result = git(repoRoot, ["ls-tree", "-r", "-z", "--name-only", tree.treeSha, "--"]);
const result = git(repoRoot, ["ls-tree", "-r", "-z", "--name-only", tree.treeSha, "--", "."]);
if (!result.ok) return unavailable(result);
return {
files: parseNulRecords(result.stdout).map(normalizeGitPath)
};
}

function listRepoFiles(repoRoot: string): ValidationWorkspaceFileSet {
const result = git(repoRoot, ["ls-files", "-co", "--exclude-standard", "-z"]);
const result = git(repoRoot, ["ls-files", "-co", "--exclude-standard", "-z", "--", "."]);
if (!result.ok) return unavailable(result);
return {
files: parseNulRecords(result.stdout).map(normalizeGitPath)
};
}

function readTreeFile(repoRoot: string, treeRef: string, path: string): ValidationWorkspaceReadFileResult {
function readTreeFile(repoRoot: string, gitPrefix: string, treeRef: string, path: string): ValidationWorkspaceReadFileResult {
const normalized = validateRepoRelativePath(path);
const tree = resolveTreeish(repoRoot, treeRef);
if (!tree.ok) {
throw new Error(`${tree.message}: ${tree.cause}`);
}
const result = git(repoRoot, ["show", `${tree.treeSha}:${normalized}`]);
const result = git(repoRoot, ["show", `${tree.treeSha}:${gitRepoPath(gitPrefix, normalized)}`]);
if (result.ok) return { status: "found", content: result.stdout };
if (/exists on disk, but not in|Path .* exists, but not|does not exist in/.test(result.cause)) {
return { status: "missing" };
Expand Down Expand Up @@ -328,6 +333,18 @@ function normalizeGitPath(path: string): string {
return validateRepoRelativePath(path.replaceAll("\\", "/"));
}

function resolveGitPrefix(repoRoot: string): string {
const result = git(repoRoot, ["rev-parse", "--show-prefix"]);
if (!result.ok) return "";
const prefix = result.stdout.replace(/[\r\n]+$/, "").replace(/\/$/, "");
return prefix.length === 0 ? "" : normalizeGitPath(prefix);
}

function gitRepoPath(gitPrefix: string, path: string): string {
const normalized = validateRepoRelativePath(path);
return gitPrefix.length === 0 ? normalized : `${gitPrefix}/${normalized}`;
}

function git(repoRoot: string, args: readonly string[]): { ok: true; stdout: string } | { ok: false; message: string; cause: string } {
const result = spawnSync("git", ["-C", repoRoot, ...args], {
encoding: "utf8",
Expand Down
37 changes: 37 additions & 0 deletions tests/validation-command-adapter.test.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -582,6 +582,43 @@ describe("validation command adapters", () => {
}
});

it("scopes changed files and base-tree reads to a nested Git workspace", async () => {
const temp = mkdtempSync(join(tmpdir(), "lattice-validation-nested-workspace-"));
try {
const appRoot = join(temp, "packages/app");
mkdirSync(join(appRoot, "src"), { recursive: true });
mkdirSync(join(temp, "packages/other/src"), { recursive: true });
writeFileSync(join(appRoot, "src/index.ts"), "export const value = 'app-base';\n");
writeFileSync(join(temp, "packages/other/src/index.ts"), "export const value = 'other-base';\n");
const baseCommit = initializeGitSnapshot(temp, ["packages/app/src/index.ts", "packages/other/src/index.ts"]);
writeFileSync(join(appRoot, "src/index.ts"), "export const value = 'app-changed';\n");
writeFileSync(join(appRoot, "src/new.ts"), "export const added = true;\n");
writeFileSync(join(temp, "packages/other/src/index.ts"), "export const value = 'other-changed';\n");

const workspace = createNodeValidationWorkspace({ repoRoot: appRoot });
const before = await workspace.readFile("src/index.ts", {
scope: { kind: "changed", baseRef: baseCommit, files: ["src/index.ts"] },
state: "before"
});
const changed = workspace.listChangedFiles(baseCommit);
const beforeFiles = workspace.listFiles({
scope: { kind: "changed", baseRef: baseCommit, files: ["src/index.ts"] },
state: "before"
});

assert.deepEqual(before, { status: "found", content: "export const value = 'app-base';\n" });
assert.deepEqual(changed, {
files: [
{ path: "src/index.ts", status: "modified" },
{ path: "src/new.ts", status: "added" }
]
});
assert.deepEqual(beforeFiles, { files: ["src/index.ts", "src/new.ts"] });
} finally {
rmSync(temp, { recursive: true, force: true });
}
});

it("defaults changed-scope validation to introduced report mode", async () => {
const temp = mkdtempSync(join(tmpdir(), "lattice-validation-changed-default-introduced-"));
try {
Expand Down