@jwilger/pi-development-system 0.72.0 → 0.74.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jwilger/pi-development-system",
-  "version": "0.72.0",
+  "version": "0.74.0",
   "description": "A pi extension package representing a seasoned approach to software development using a full AI SDLC.",
   "keywords": [
     "pi-package"

package/src/tracker/repo-files.ts

@@ -1,5 +1,5 @@
-import { mkdir, readdir, readFile, writeFile } from "node:fs/promises";
-import { join } from "node:path";
+import { lstat, mkdir, readdir, readFile, writeFile } from "node:fs/promises";
+import { join, relative, sep } from "node:path";
 import { ok } from "../core/result.ts";
 import { parseItem, renderBacklog, renderItem, unwritable } from "./item-format.ts";
 import {
@@ -36,8 +36,35 @@ const byCodeUnit = (a: string, b: string): number => Number(a > b) - Number(a <
 const describe = (cause: unknown): string =>
   cause instanceof Error ? cause.message : String(cause);
 
+/**
+ * The first symlink on the way from the repo root to `target`, if any. A committed symlink
+ * under `work/` could otherwise make a tracker write land outside the repository.
+ */
+const symlinkOnPath = async (root: string, target: string): Promise<string | undefined> => {
+  let current = root;
+  for (const part of relative(root, target).split(sep)) {
+    current = join(current, part);
+    try {
+      if ((await lstat(current)).isSymbolicLink()) return current;
+    } catch (cause) {
+      if (isMissing(cause)) return undefined;
+      throw cause;
+    }
+  }
+  return undefined;
+};
+
+const refuseSymlink = async (root: string, target: string): Promise<string | undefined> => {
+  const link = await symlinkOnPath(root, target);
+  return link === undefined
+    ? undefined
+    : `${relative(root, link)} is a symbolic link; the repo-files tracker will not follow it`;
+};
+
 const readItem = async (root: string, id: string): Promise<TrackerResult<WorkItem>> => {
   if (!ID.test(id)) return trackerError(`work item "${id}": not a valid id`);
+  const link = await refuseSymlink(root, fileOf(root, id));
+  if (link !== undefined) return trackerError(link);
   try {
     return parseItem(id, await readFile(fileOf(root, id), "utf8"));
   } catch (cause) {
@@ -59,6 +86,8 @@ const itemIds = async (root: string): Promise<string[]> => {
 };
 
 const readAll = async (root: string): Promise<TrackerResult<WorkItem[]>> => {
+  const link = await refuseSymlink(root, itemsDir(root));
+  if (link !== undefined) return trackerError(link);
   const items: WorkItem[] = [];
   for (const id of (await itemIds(root)).toSorted(byCodeUnit)) {
     const item = await readItem(root, id);
@@ -71,6 +100,11 @@ const readAll = async (root: string): Promise<TrackerResult<WorkItem[]>> => {
 const save = async (root: string, item: WorkItem): Promise<TrackerResult<WorkItem>> => {
   const problem = unwritable(item);
   if (problem !== undefined) return trackerError(problem);
+  const backlog = join(root, "work", "backlog.md");
+  for (const target of [itemsDir(root), fileOf(root, item.id), backlog]) {
+    const link = await refuseSymlink(root, target);
+    if (link !== undefined) return trackerError(link);
+  }
   const others = await readAll(root);
   if (!others.ok) return others;
   await mkdir(itemsDir(root), { recursive: true });
@@ -78,7 +112,7 @@ const save = async (root: string, item: WorkItem): Promise<TrackerResult<WorkIte
   const items = [...others.value.filter((i) => i.id !== item.id), item].toSorted((a, b) =>
     byCodeUnit(a.id, b.id),
   );
-  await writeFile(join(root, "work", "backlog.md"), renderBacklog(items));
+  await writeFile(backlog, renderBacklog(items));
   return ok(item);
 };