@bevel-software/platform-core-backend 0.29.0 → 0.31.0

package/src/shared/__tests__/no-link-below.test.ts

@@ -0,0 +1,45 @@
+import { describe, it, expect, beforeEach, afterEach } from 'vitest';
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import os from 'node:os';
+import { linkedAncestor } from '../no-link-below.js';
+
+/**
+ * `linkedAncestor`: the one judge of "is this path reached through a link
+ * below the base". A link on the way is named; a sibling of the base that
+ * merely shares its spelling is not below it and is never looked at.
+ */
+describe('linkedAncestor', () => {
+  let tmp: string;
+  beforeEach(async () => {
+    tmp = await fs.mkdtemp(path.join(os.tmpdir(), 'no-link-below-'));
+  });
+  afterEach(async () => {
+    await fs.rm(tmp, { recursive: true, force: true });
+  });
+
+  it('answers null for a plain path below the base, and the base itself', async () => {
+    const base = path.join(tmp, 'repo');
+    await fs.mkdir(path.join(base, 'a', 'b'), { recursive: true });
+    expect(await linkedAncestor(base, path.join(base, 'a', 'b', 'c.md'))).toBeNull();
+    expect(await linkedAncestor(base, base)).toBeNull();
+  });
+
+  // Symbolic links need a privilege on Windows that a test runner does not have.
+  it.skipIf(process.platform === 'win32')('names the first link on the way below the base', async () => {
+    const base = path.join(tmp, 'repo');
+    await fs.mkdir(path.join(base, 'real'), { recursive: true });
+    await fs.symlink(path.join(base, 'real'), path.join(base, 'via'));
+    expect(await linkedAncestor(base, path.join(base, 'via', 'x.md'))).toBe(path.join(base, 'via'));
+  });
+
+  it.skipIf(process.platform === 'win32')('treats a sibling that shares the base\'s spelling as outside: not below it, never walked', async () => {
+    const base = path.join(tmp, 'repo');
+    await fs.mkdir(base, { recursive: true });
+    await fs.mkdir(path.join(tmp, 'elsewhere'));
+    // `<tmp>/repository` is a LINK, and a sibling of `<tmp>/repo`: a prefix
+    // match without a separator would walk it and name it as an ancestor.
+    await fs.symlink(path.join(tmp, 'elsewhere'), path.join(tmp, 'repository'));
+    expect(await linkedAncestor(base, path.join(tmp, 'repository', 'x.md'))).toBeNull();
+  });
+});

package/src/shared/git.contract.ts

@@ -248,6 +248,16 @@ export function isGitTimeout(err: unknown): boolean {
   return err instanceof GitRunError && err.timedOut;
 }
 
+/**
+ * A full object id (SHA-1 or SHA-256, lowercase hex): what every at-ref
+ * access gate resolves its ref to before reading, and the one spelling the
+ * history tools accept for a commit — anything shorter or mixed-case is a
+ * name, which a fetch can move.
+ */
+export function isCommitSha(ref: string): boolean {
+  return /^(?:[0-9a-f]{40}|[0-9a-f]{64})$/.test(ref);
+}
+
 /**
  * Runs one git command to completion and returns what it wrote.
  *

package/src/shared/no-link-below.ts

@@ -0,0 +1,29 @@
+import path from 'node:path';
+import { lstatOrNull } from './rename-no-replace.js';
+
+/**
+ * The first folder between `base` (exclusive) and `absolute` (inclusive)
+ * that is a symbolic link, or null when none is — judged by `lstat` on each
+ * ancestor, so a path that would be followed out of `base` is named before
+ * anything reads or writes through it. ONE rule for every sink that resolves
+ * a repository path on disk: the locking filesystem's moves and the merge's
+ * conflict reads and writes.
+ */
+export async function linkedAncestor(base: string, absolute: string): Promise<string | null> {
+  const root = path.resolve(base);
+  // Below `root` means past a separator after it: `/tmp/repository` is a
+  // sibling of `/tmp/repo`, not inside it, and is never walked or stat'ed. A
+  // filesystem root already ends with its separator.
+  const inside = root.endsWith(path.sep) ? root : root + path.sep;
+  let current = path.resolve(absolute);
+  const ancestors: string[] = [];
+  while (current.startsWith(inside)) {
+    ancestors.push(current);
+    current = path.dirname(current);
+  }
+  for (const ancestor of ancestors) {
+    const stat = await lstatOrNull(ancestor);
+    if (stat?.isSymbolicLink()) return ancestor;
+  }
+  return null;
+}

package/src/test-setup.ts

@@ -1,4 +1,6 @@
 import { branchModelFromEnv, configureBranchModel } from '@bevel-software/platform-shared';
+import { afterAll } from 'vitest';
+import { removeTestRepositoryRoots } from './__tests__/test-repositories.js';
 
 /**
  * Apply the branch model before any suite imports something that reads it.
@@ -16,3 +18,6 @@ import { branchModelFromEnv, configureBranchModel } from '@bevel-software/platfo
  * place the historical two-branch pair is written.
  */
 configureBranchModel(branchModelFromEnv());
+
+// The repositories `testKbRepository` placed beside each suite's fixture root.
+afterAll(removeTestRepositoryRoots);