feat: add issue view with body cleaning and truncation (task 0003)

Add `issue view <n>` as the first detail command, introducing the content-cleaning and truncation machinery (src/body.ts) that later issue and PR slices reuse. - Default output: number, title, state, author, created, body (truncated at 500), plus comment_count; --comments expands every comment (bodies truncated at 800); --full suppresses all truncation. - cleanBody runs only when a body exceeds its limit: normalizes Gitea issue/PR URLs on the detected host to Issue#N/PR#N, strips image embeds and long URLs, and collapses quoted blocks. - Type guard: a PR number fails with VALIDATION_ERROR and a `pr view <n>` hint, detected via the fetched object's pull_request field. - renderDetail joins the detail entity, optional sub-blocks, and help.
2026-07-11 19:32:31 -04:00
parent ae0f4c2675
commit 5e66b4d746
8 changed files with 680 additions and 16 deletions
--- a/test/body.test.ts
+++ b/test/body.test.ts
@@ -0,0 +1,97 @@
+import { describe, expect, it } from "vitest";
+import {
+  BODY_TRUNCATE_LIMIT,
+  cleanBody,
+  truncateBody,
+} from "../src/body.js";
+
+const HOST = "gitea.example.com";
+
+describe("truncateBody", () => {
+  it("returns bodies at or under the limit untouched, without cleaning", () => {
+    const body = `See https://${HOST}/o/r/issues/9 for details`;
+    expect(truncateBody(body, BODY_TRUNCATE_LIMIT, HOST)).toBe(body);
+  });
+
+  it("returns a body exactly at the limit untouched", () => {
+    const body = "x".repeat(BODY_TRUNCATE_LIMIT);
+    expect(truncateBody(body, BODY_TRUNCATE_LIMIT, HOST)).toBe(body);
+  });
+
+  it("truncates an over-limit body with the inline hint and original length", () => {
+    const body = "y".repeat(BODY_TRUNCATE_LIMIT + 250);
+    const out = truncateBody(body, BODY_TRUNCATE_LIMIT, HOST);
+    expect(out.startsWith("y".repeat(BODY_TRUNCATE_LIMIT))).toBe(true);
+    expect(out).toContain(
+      `... (truncated, ${BODY_TRUNCATE_LIMIT + 250} chars total - use --full to see complete body)`,
+    );
+  });
+
+  it("returns the cleaned body with a note when cleaning brings it under the limit", () => {
+    const longUrl = `https://${HOST}/${"segment/".repeat(20)}deep/path/resource`;
+    const filler = "z".repeat(BODY_TRUNCATE_LIMIT - 20);
+    const body = `${filler} ${longUrl}`;
+    expect(body.length).toBeGreaterThan(BODY_TRUNCATE_LIMIT);
+    const out = truncateBody(body, BODY_TRUNCATE_LIMIT, HOST);
+    expect(out).toContain("[long URL removed]");
+    expect(out).toContain(`(cleaned, ${body.length} chars original - use --full to see original)`);
+    expect(out).not.toContain("truncated,");
+  });
+});
+
+describe("cleanBody", () => {
+  it("normalizes bare issue and PR URLs on the detected host", () => {
+    const text = `Fixed by https://${HOST}/acme/widgets/pulls/12, closes https://${HOST}/acme/widgets/issues/7`;
+    const out = cleanBody(text, HOST);
+    expect(out).toContain("PR#12");
+    expect(out).toContain("Issue#7");
+    expect(out).not.toContain(HOST);
+  });
+
+  it("normalizes issue URLs carrying a fragment", () => {
+    const out = cleanBody(`see https://${HOST}/o/r/issues/33#issuecomment-9 ok`, HOST);
+    expect(out).toContain("Issue#33");
+    expect(out).not.toContain("issuecomment");
+  });
+
+  it("normalizes issue/PR URLs inside markdown links", () => {
+    const out = cleanBody(`[the fix](https://${HOST}/o/r/pulls/5)`, HOST);
+    expect(out).toContain("PR#5");
+    expect(out).not.toContain("the fix");
+  });
+
+  it("leaves URLs on a different host alone", () => {
+    const text = `https://other.host/o/r/issues/7`;
+    expect(cleanBody(text, HOST)).toBe(text);
+  });
+
+  it("strips markdown image embeds, keeping alt text when present", () => {
+    expect(cleanBody("![a diagram](https://x/y.png)", HOST)).toContain("[image: a diagram]");
+    expect(cleanBody("![](https://x/y.png)", HOST)).toContain("[image]");
+  });
+
+  it("drops the URL from a markdown link when the URL is very long", () => {
+    const longUrl = `https://cdn.example.com/${"a".repeat(90)}`;
+    const out = cleanBody(`[report](${longUrl})`, HOST);
+    expect(out).toBe("[report]");
+  });
+
+  it("removes standalone long URLs over 100 chars", () => {
+    const longUrl = `https://cdn.example.com/${"b".repeat(110)}`;
+    expect(cleanBody(`prefix ${longUrl} suffix`, HOST)).toBe("prefix [long URL removed] suffix");
+  });
+
+  it("collapses email-style quoted blocks of three or more lines", () => {
+    const text = "reply\n> one\n> two\n> three\nend";
+    const out = cleanBody(text, HOST);
+    expect(out).toContain("[quoted text removed]");
+    expect(out).not.toContain("> two");
+  });
+
+  it("leaves a short (two-line) quoted block intact", () => {
+    const text = "> one\n> two\nafter";
+    const out = cleanBody(text, HOST);
+    expect(out).toContain("> one");
+    expect(out).not.toContain("[quoted text removed]");
+  });
+});
--- a/test/issue-view.test.ts
+++ b/test/issue-view.test.ts
@@ -0,0 +1,260 @@
+import { afterEach, describe, expect, it } from "vitest";
+import { startFixtureServer, type FixtureServer } from "./fixture-server.js";
+import { runCliTest, testModeEnv } from "./harness.js";
+
+const ISSUE_PATH = "/api/v1/repos/testowner/testrepo/issues/42";
+const COMMENTS_PATH = "/api/v1/repos/testowner/testrepo/issues/42/comments";
+
+let server: FixtureServer;
+
+afterEach(async () => {
+  await server.close();
+});
+
+function issueBody(fields: Record<string, unknown>): Record<string, unknown> {
+  return {
+    number: 42,
+    title: "Fix the thing",
+    state: "open",
+    user: { login: "alexion" },
+    created_at: "2026-07-01T00:00:00Z",
+    comments: 0,
+    body: "",
+    ...fields,
+  };
+}
+
+describe("issue view", () => {
+  it("renders the default detail fields plus comment_count", async () => {
+    server = await startFixtureServer([
+      {
+        method: "GET",
+        path: ISSUE_PATH,
+        body: issueBody({ comments: 3, body: "A short body." }),
+      },
+    ]);
+    const { stdout, exitCode } = await runCliTest(["issue", "view", "42"], {
+      env: testModeEnv(server.url),
+    });
+
+    expect(exitCode).toBe(0);
+    expect(stdout).toContain("issue:");
+    expect(stdout).toContain("number: 42");
+    expect(stdout).toContain("title: Fix the thing");
+    expect(stdout).toContain("state: open");
+    expect(stdout).toContain("author: alexion");
+    expect(stdout).toContain("body: A short body.");
+    expect(stdout).toContain("comment_count: 3 — use --comments to see full comments");
+  });
+
+  it("renders comment_count: 0 when there are no comments", async () => {
+    server = await startFixtureServer([
+      { method: "GET", path: ISSUE_PATH, body: issueBody({ comments: 0 }) },
+    ]);
+    const { stdout } = await runCliTest(["issue", "view", "42"], {
+      env: testModeEnv(server.url),
+    });
+
+    expect(stdout).toContain("comment_count: 0");
+    expect(stdout).not.toContain("use --comments");
+  });
+
+  it("passes a body at or under 500 chars through untouched", async () => {
+    const body = "b".repeat(500);
+    server = await startFixtureServer([
+      { method: "GET", path: ISSUE_PATH, body: issueBody({ body }) },
+    ]);
+    const { stdout } = await runCliTest(["issue", "view", "42"], {
+      env: testModeEnv(server.url),
+    });
+
+    expect(stdout).toContain(body);
+    expect(stdout).not.toContain("truncated");
+    expect(stdout).not.toContain("cleaned");
+  });
+
+  it("cleans then truncates a body over 500 chars, with the inline hint", async () => {
+    const body = `See http://127.0.0.1/o/r/issues/7 for context. ${"y".repeat(600)}`;
+    server = await startFixtureServer([
+      { method: "GET", path: ISSUE_PATH, body: issueBody({ body }) },
+    ]);
+    const { stdout } = await runCliTest(["issue", "view", "42"], {
+      env: testModeEnv(server.url),
+    });
+
+    // cleanBody normalized the host URL before truncation kicked in.
+    expect(stdout).toContain("Issue#7");
+    expect(stdout).toContain(
+      `... (truncated, ${body.length} chars total - use --full to see complete body)`,
+    );
+    expect(stdout).toContain("issue view 42 --full");
+  });
+
+  it("returns the cleaned body with a note when cleaning brings it under 500", async () => {
+    const longUrl = `http://127.0.0.1/${"c".repeat(110)}`;
+    const body = `${"d".repeat(480)} ${longUrl}`;
+    server = await startFixtureServer([
+      { method: "GET", path: ISSUE_PATH, body: issueBody({ body }) },
+    ]);
+    const { stdout } = await runCliTest(["issue", "view", "42"], {
+      env: testModeEnv(server.url),
+    });
+
+    expect(stdout).toContain("[long URL removed]");
+    expect(stdout).toContain(`(cleaned, ${body.length} chars original - use --full to see original)`);
+    expect(stdout).not.toContain("truncated,");
+  });
+
+  it("suppresses body truncation with --full", async () => {
+    const body = "e".repeat(900);
+    server = await startFixtureServer([
+      { method: "GET", path: ISSUE_PATH, body: issueBody({ body }) },
+    ]);
+    const { stdout } = await runCliTest(["issue", "view", "42", "--full"], {
+      env: testModeEnv(server.url),
+    });
+
+    expect(stdout).toContain(body);
+    expect(stdout).not.toContain("truncated");
+  });
+
+  it("renders every comment with --comments, truncating bodies at 800 chars", async () => {
+    const longComment = "f".repeat(1000);
+    server = await startFixtureServer([
+      { method: "GET", path: ISSUE_PATH, body: issueBody({ comments: 2 }) },
+      {
+        method: "GET",
+        path: COMMENTS_PATH,
+        body: [
+          { user: { login: "bob" }, created_at: "2026-07-02T00:00:00Z", body: "short reply" },
+          { user: { login: "sue" }, created_at: "2026-07-03T00:00:00Z", body: longComment },
+        ],
+      },
+    ]);
+    const { stdout, exitCode } = await runCliTest(["issue", "view", "42", "--comments"], {
+      env: testModeEnv(server.url),
+    });
+
+    expect(exitCode).toBe(0);
+    expect(stdout).toContain("comments[2]");
+    expect(stdout).toContain("bob");
+    expect(stdout).toContain("short reply");
+    expect(stdout).toContain(
+      `... (truncated, ${longComment.length} chars total - use --full to see complete body)`,
+    );
+    // With --comments the redundant scalar count is replaced by the block.
+    expect(stdout).not.toContain("comment_count");
+  });
+
+  it("suppresses comment truncation with --full --comments", async () => {
+    const longComment = "g".repeat(1000);
+    server = await startFixtureServer([
+      { method: "GET", path: ISSUE_PATH, body: issueBody({ comments: 1 }) },
+      {
+        method: "GET",
+        path: COMMENTS_PATH,
+        body: [{ user: { login: "sue" }, created_at: "2026-07-03T00:00:00Z", body: longComment }],
+      },
+    ]);
+    const { stdout } = await runCliTest(["issue", "view", "42", "--full", "--comments"], {
+      env: testModeEnv(server.url),
+    });
+
+    expect(stdout).toContain(longComment);
+    expect(stdout).not.toContain("truncated");
+  });
+
+  it("renders an explicit empty comments block when there are none", async () => {
+    server = await startFixtureServer([
+      { method: "GET", path: ISSUE_PATH, body: issueBody({ comments: 0 }) },
+      { method: "GET", path: COMMENTS_PATH, body: [] },
+    ]);
+    const { stdout, exitCode } = await runCliTest(["issue", "view", "42", "--comments"], {
+      env: testModeEnv(server.url),
+    });
+
+    expect(exitCode).toBe(0);
+    expect(stdout).toContain("comments[0]: (none)");
+  });
+
+  it("surfaces a failure to fetch comments", async () => {
+    server = await startFixtureServer([
+      { method: "GET", path: ISSUE_PATH, body: issueBody({ comments: 2 }) },
+      { method: "GET", path: COMMENTS_PATH, status: 403, body: { message: "forbidden" } },
+    ]);
+    const { stdout, exitCode } = await runCliTest(["issue", "view", "42", "--comments"], {
+      env: testModeEnv(server.url),
+    });
+
+    expect(exitCode).toBe(1);
+    expect(stdout).toContain("code: FORBIDDEN");
+  });
+
+  it("prints help with --help without calling the API", async () => {
+    server = await startFixtureServer([]);
+    const { stdout, exitCode } = await runCliTest(["issue", "view", "--help"], {
+      env: testModeEnv(server.url),
+    });
+
+    expect(exitCode).toBe(0);
+    expect(stdout).toContain("usage: gitea-axi issue view <number>");
+    expect(server.requests).toHaveLength(0);
+  });
+
+  it("rejects a pull request number with VALIDATION_ERROR and a pr view hint", async () => {
+    server = await startFixtureServer([
+      {
+        method: "GET",
+        path: ISSUE_PATH,
+        body: issueBody({ pull_request: { merged: false, html_url: "http://x/pulls/42" } }),
+      },
+    ]);
+    const { stdout, exitCode } = await runCliTest(["issue", "view", "42"], {
+      env: testModeEnv(server.url),
+    });
+
+    expect(exitCode).toBe(2);
+    expect(stdout).toContain("code: VALIDATION_ERROR");
+    expect(stdout).toContain("issue #42 is a pull request");
+    expect(stdout).toContain("pr view 42");
+  });
+
+  it("reports a nonexistent issue as ISSUE_NOT_FOUND with exit 1", async () => {
+    server = await startFixtureServer([
+      {
+        method: "GET",
+        path: ISSUE_PATH,
+        status: 404,
+        body: { message: "Not Found" },
+      },
+    ]);
+    const { stdout, exitCode } = await runCliTest(["issue", "view", "42"], {
+      env: testModeEnv(server.url),
+    });
+
+    expect(exitCode).toBe(1);
+    expect(stdout).toContain("code: ISSUE_NOT_FOUND");
+  });
+
+  it("rejects a missing issue number with exit 2", async () => {
+    server = await startFixtureServer([]);
+    const { stdout, exitCode } = await runCliTest(["issue", "view"], {
+      env: testModeEnv(server.url),
+    });
+
+    expect(exitCode).toBe(2);
+    expect(stdout).toContain("code: VALIDATION_ERROR");
+    expect(server.requests).toHaveLength(0);
+  });
+
+  it("rejects a non-numeric issue number with exit 2", async () => {
+    server = await startFixtureServer([]);
+    const { stdout, exitCode } = await runCliTest(["issue", "view", "abc"], {
+      env: testModeEnv(server.url),
+    });
+
+    expect(exitCode).toBe(2);
+    expect(stdout).toContain("code: VALIDATION_ERROR");
+    expect(server.requests).toHaveLength(0);
+  });
+});