@iceinvein/agent-skills 0.23.9 → 0.23.13

package/skills/magpie/scripts/__tests__/impact-render.test.ts

@@ -0,0 +1,365 @@
+import { describe, expect, test } from 'bun:test'
+import type { ImpactMap } from '../impact.ts'
+import {
+  IMPACT_BRIEF_CAP_BYTES,
+  IMPACT_BRIEF_MAX_CHILDREN,
+  renderImpactMarkdown,
+} from '../impact-render.ts'
+
+// Entries are deliberately out of render order so the tests pin the sort.
+function sampleMap(): ImpactMap {
+  return {
+    version: 1,
+    symbols: [
+      {
+        name: 'formatTotal',
+        kind: 'added',
+        definedAt: [{ file: 'src/total.ts', line: 3 }],
+        shard: 1,
+        hits: 1,
+        references: [{ file: 'src/cart.ts', line: 7, text: 'formatTotal(cart)' }],
+      },
+      {
+        name: 'render',
+        kind: 'changed',
+        definedAt: [{ file: 'src/view.ts', line: 1 }],
+        shard: 1,
+        hits: 230,
+        references: [],
+      },
+      {
+        name: 'loadUser',
+        kind: 'changed',
+        definedAt: [{ file: 'src/user.ts', line: 5 }],
+        shard: 0,
+        hits: 30,
+        references: [
+          { file: 'src/api.ts', line: 2, text: 'loadUser(id)' },
+          { file: 'src/page.ts', line: 8, text: 'await loadUser(params.id)' },
+        ],
+      },
+      {
+        name: 'parseRow',
+        kind: 'removed',
+        definedAt: [{ file: 'src/a.ts', line: 2 }],
+        shard: 1,
+        hits: 1,
+        references: [{ file: 'src/b.ts', line: 9, text: 'parseRow(r)' }],
+      },
+    ],
+    uses: [
+      {
+        name: 'getConfig',
+        usedIn: { file: 'src/user.ts', line: 12 },
+        shard: 0,
+        definedAt: [{ file: 'lib/config.ts', line: 1, text: 'export function getConfig() {' }],
+      },
+    ],
+    stores: [
+      {
+        name: 'orders',
+        kind: 'table',
+        usedIn: [{ file: 'src/db.ts', line: 10 }],
+        shard: 0,
+        writers: [{ file: 'jobs/sync.ts', line: 4, text: 'INSERT INTO orders (id) VALUES (1)' }],
+      },
+    ],
+    routes: [
+      {
+        path: '/api/users/:id',
+        usedIn: { file: 'src/routes.ts', line: 20 },
+        shard: 1,
+        siblings: [{ file: 'src/admin.ts', line: 3, text: "router.get('/api/users', list)" }],
+      },
+    ],
+    docs: [
+      {
+        file: 'docs/user.md',
+        line: 4,
+        text: 'Call loadUser before render.',
+        mentions: ['loadUser', 'render'],
+        shards: [1],
+      },
+    ],
+  }
+}
+
+function emptyMap(): ImpactMap {
+  return { version: 1, symbols: [], uses: [], stores: [], routes: [], docs: [] }
+}
+
+const FULL = `### Other writers of the same data
+- \`orders\` (diff: src/db.ts:10)
+  - jobs/sync.ts:4 \`INSERT INTO orders (id) VALUES (1)\`
+
+### References to changed symbols
+- \`parseRow\` (diff: src/a.ts:2)
+  - src/b.ts:9 \`parseRow(r)\`
+- \`loadUser\` (diff: src/user.ts:5)
+  - src/api.ts:2 \`loadUser(id)\`
+  - src/page.ts:8 \`await loadUser(params.id)\`
+  - 2 of 30 shown
+- \`render\`: 230 hits, too common to list
+
+### References to added symbols
+- \`formatTotal\` (diff: src/total.ts:3)
+  - src/cart.ts:7 \`formatTotal(cart)\`
+
+### Definitions this change relies on
+- \`getConfig\` (diff: src/user.ts:12)
+  - lib/config.ts:1 \`export function getConfig() {\`
+
+### Sibling routes
+- \`/api/users/:id\` (diff: src/routes.ts:20)
+  - src/admin.ts:3 \`router.get('/api/users', list)\`
+
+### Docs naming what changed
+- docs/user.md:4 \`Call loadUser before render.\` (names: loadUser, render)`
+
+const SHARD_0 = `### Other writers of the same data
+- \`orders\` (diff: src/db.ts:10)
+  - jobs/sync.ts:4 \`INSERT INTO orders (id) VALUES (1)\`
+
+### References to changed symbols
+- \`loadUser\` (diff: src/user.ts:5)
+  - src/api.ts:2 \`loadUser(id)\`
+  - src/page.ts:8 \`await loadUser(params.id)\`
+  - 2 of 30 shown
+
+### Definitions this change relies on
+- \`getConfig\` (diff: src/user.ts:12)
+  - lib/config.ts:1 \`export function getConfig() {\``
+
+const SHARD_0_CUT_AFTER_TWO = `### Other writers of the same data
+- \`orders\` (diff: src/db.ts:10)
+  - jobs/sync.ts:4 \`INSERT INTO orders (id) VALUES (1)\`
+
+### References to changed symbols
+- \`loadUser\` (diff: src/user.ts:5)
+  - src/api.ts:2 \`loadUser(id)\`
+  - src/page.ts:8 \`await loadUser(params.id)\`
+  - 2 of 30 shown
+
+1 more entries in impact.json`
+
+const bytes = (s: string): number => Buffer.byteLength(s, 'utf8')
+
+describe('renderImpactMarkdown', () => {
+  test('renders every entry in section order with shard null', () => {
+    expect(renderImpactMarkdown(sampleMap(), { shard: null, capBytes: 100_000 })).toBe(FULL)
+  })
+
+  test('renders only the entries of the requested shard', () => {
+    expect(renderImpactMarkdown(sampleMap(), { shard: 0, capBytes: 100_000 })).toBe(SHARD_0)
+  })
+
+  test('returns an empty string when no entry matches the shard', () => {
+    expect(renderImpactMarkdown(sampleMap(), { shard: 5, capBytes: 100_000 })).toBe('')
+  })
+
+  test('returns an empty string for an empty map', () => {
+    expect(renderImpactMarkdown(emptyMap(), { shard: null, capBytes: 100_000 })).toBe('')
+  })
+
+  test('keeps whole entries that fit the cap and counts the rest', () => {
+    const capBytes = bytes(SHARD_0_CUT_AFTER_TWO)
+    expect(renderImpactMarkdown(sampleMap(), { shard: 0, capBytes })).toBe(SHARD_0_CUT_AFTER_TWO)
+  })
+
+  test('skips an entry too big for the cap and keeps a later one that fits', () => {
+    const map = emptyMap()
+    for (const [name, text] of [
+      ['aaaa', 'write(aaaa)'],
+      ['bbbb', 'y'.repeat(300)],
+      ['cccc', 'write(cccc)'],
+    ] as const) {
+      map.stores.push({
+        name,
+        kind: 'file',
+        usedIn: [{ file: `${name}.ts`, line: 1 }],
+        shard: null,
+        writers: [{ file: 'w.ts', line: 1, text }],
+      })
+    }
+    expect(renderImpactMarkdown(map, { shard: null, capBytes: 200 })).toBe(
+      `### Other writers of the same data
+- \`aaaa\` (diff: aaaa.ts:1)
+  - w.ts:1 \`write(aaaa)\`
+- \`cccc\` (diff: cccc.ts:1)
+  - w.ts:1 \`write(cccc)\`
+
+1 more entries in impact.json`,
+    )
+  })
+
+  test('limits each entry to maxChildren and says how many were shown', () => {
+    const refText = (i: number): string => `${'z'.repeat(116)}(${String(i).padStart(2, '0')})`
+    const twelveRefs = (file: string) =>
+      Array.from({ length: 12 }, (_, i) => ({ file, line: i + 1, text: refText(i + 1) }))
+    const map = emptyMap()
+    map.symbols.push(
+      {
+        name: 'alpha',
+        kind: 'changed',
+        definedAt: [{ file: 'src/a.ts', line: 1 }],
+        shard: null,
+        hits: 12,
+        references: twelveRefs('src/ra.ts'),
+      },
+      {
+        name: 'beta',
+        kind: 'changed',
+        definedAt: [{ file: 'src/b.ts', line: 1 }],
+        shard: null,
+        hits: 12,
+        references: twelveRefs('src/rb.ts'),
+      },
+      {
+        name: 'gamma',
+        kind: 'changed',
+        definedAt: [{ file: 'src/c.ts', line: 1 }],
+        shard: null,
+        hits: 1,
+        references: [{ file: 'src/g.ts', line: 5, text: 'gamma()' }],
+      },
+    )
+    const z = 'z'.repeat(116)
+    expect(
+      renderImpactMarkdown(map, {
+        shard: null,
+        capBytes: IMPACT_BRIEF_CAP_BYTES,
+        maxChildren: IMPACT_BRIEF_MAX_CHILDREN,
+      }),
+    ).toBe(`### References to changed symbols
+- \`alpha\` (diff: src/a.ts:1)
+  - src/ra.ts:1 \`${z}(01)\`
+  - src/ra.ts:2 \`${z}(02)\`
+  - src/ra.ts:3 \`${z}(03)\`
+  - 3 of 12 shown
+- \`beta\` (diff: src/b.ts:1)
+  - src/rb.ts:1 \`${z}(01)\`
+  - src/rb.ts:2 \`${z}(02)\`
+  - src/rb.ts:3 \`${z}(03)\`
+  - 3 of 12 shown
+- \`gamma\` (diff: src/c.ts:1)
+  - src/g.ts:5 \`gamma()\``)
+  })
+
+  test('counts children of a non-symbol entry against their own number', () => {
+    const map = emptyMap()
+    map.routes.push({
+      path: '/api/x',
+      usedIn: { file: 'r.ts', line: 1 },
+      shard: null,
+      siblings: [
+        { file: 's.ts', line: 1, text: 'a' },
+        { file: 's.ts', line: 2, text: 'b' },
+      ],
+    })
+    expect(renderImpactMarkdown(map, { shard: null, capBytes: 1000, maxChildren: 1 })).toBe(
+      `### Sibling routes
+- \`/api/x\` (diff: r.ts:1)
+  - s.ts:1 \`a\`
+  - 1 of 2 shown`,
+    )
+  })
+
+  test('throws naming the cap when the cap cannot hold the count line', () => {
+    expect(() => renderImpactMarkdown(sampleMap(), { shard: null, capBytes: 10 })).toThrow('10')
+  })
+
+  test('wraps text containing a backtick in a double-backtick span', () => {
+    const map = emptyMap()
+    map.routes.push({
+      path: '/api/:id',
+      usedIn: { file: 'r.ts', line: 1 },
+      shard: null,
+      siblings: [{ file: 's.ts', line: 4, text: `const u = \`/api/\${id}\`` }],
+    })
+    expect(renderImpactMarkdown(map, { shard: null, capBytes: 1000 })).toBe(
+      `### Sibling routes
+- \`/api/:id\` (diff: r.ts:1)
+  - s.ts:4 \`\` const u = \`/api/\${id}\` \`\``,
+    )
+  })
+
+  test('leaves out entries with no facts outside the diff, without counting them', () => {
+    const map = emptyMap()
+    map.stores.push({
+      name: 'orders',
+      kind: 'table',
+      usedIn: [{ file: 'a.ts', line: 1 }],
+      shard: null,
+      writers: [],
+    })
+    map.routes.push({ path: '/x', usedIn: { file: 'a.ts', line: 2 }, shard: null, siblings: [] })
+    map.uses.push({
+      name: 'getUser',
+      usedIn: { file: 'a.ts', line: 3 },
+      shard: null,
+      definedAt: [],
+    })
+    map.symbols.push(
+      {
+        name: 'lonely',
+        kind: 'added',
+        definedAt: [{ file: 'a.ts', line: 4 }],
+        shard: null,
+        hits: 0,
+        references: [],
+      },
+      {
+        name: 'render',
+        kind: 'changed',
+        definedAt: [{ file: 'a.ts', line: 5 }],
+        shard: null,
+        hits: 300,
+        references: [],
+      },
+    )
+    map.docs.push({
+      file: 'README.md',
+      line: 1,
+      text: 'see render',
+      mentions: ['render'],
+      shards: [],
+    })
+    expect(renderImpactMarkdown(map, { shard: null, capBytes: 1000 })).toBe(
+      `### References to changed symbols
+- \`render\`: 300 hits, too common to list
+
+### Docs naming what changed
+- README.md:1 \`see render\` (names: render)`,
+    )
+  })
+
+  test('renders a doc in each shard it names', () => {
+    const map = emptyMap()
+    map.docs.push({ file: 'd.md', line: 2, text: 'see jobs', mentions: ['jobs'], shards: [2, 4] })
+    expect(renderImpactMarkdown(map, { shard: 4, capBytes: 1000 })).toBe(
+      '### Docs naming what changed\n- d.md:2 `see jobs` (names: jobs)',
+    )
+  })
+
+  test('leaves a doc out of a shard it does not name', () => {
+    const map = emptyMap()
+    map.docs.push({ file: 'd.md', line: 2, text: 'see jobs', mentions: ['jobs'], shards: [2, 4] })
+    expect(renderImpactMarkdown(map, { shard: 3, capBytes: 1000 })).toBe('')
+  })
+
+  test('counts the cap in UTF-8 bytes, not characters', () => {
+    const map = emptyMap()
+    map.stores.push({
+      name: 'cafés',
+      kind: 'file',
+      usedIn: [{ file: 'a.ts', line: 1 }],
+      shard: null,
+      writers: [{ file: 'b.ts', line: 2, text: "write('cafés')" }],
+    })
+    const whole =
+      "### Other writers of the same data\n- `cafés` (diff: a.ts:1)\n  - b.ts:2 `write('cafés')`"
+    expect(renderImpactMarkdown(map, { shard: null, capBytes: whole.length })).toBe(
+      '1 more entries in impact.json',
+    )
+  })
+})