From 54be2507a9c712b34fb7f46115c3bb4cc7aca3b9 Mon Sep 17 00:00:00 2001 From: Theo Bennett Date: Tue, 20 Oct 2026 09:44:49 +0600 Subject: [PATCH] fix(artifacts): make diagram IDs from the file path, not the folder --- src/artifacts/load.test.ts | 4 +++- src/artifacts/load.ts | 6 ++++-- src/artifacts/write.test.ts | 40 +++++++++++++++++++++++++------------ src/artifacts/write.ts | 7 +++---- src/server.test.ts | 7 ++++++- 5 files changed, 43 insertions(+), 21 deletions(-) diff --git a/src/artifacts/load.test.ts b/src/artifacts/load.test.ts index c46c21a..a156084 100644 --- a/src/artifacts/load.test.ts +++ b/src/artifacts/load.test.ts @@ -27,7 +27,9 @@ describe('loadArtifacts', () => { ['GET', '/orders', 'listOrders'], ['POST', '/orders', 'createOrder'], ]) - expect(db.diagrams[0].entity.id).toBe('checkout') + expect(db.diagrams[0].entity.id).toBe( + 'uigraph-diagrams-checkout-checkout-mmd' + ) expect(db.diagrams[0].flow.nodes.length).toBeGreaterThan(0) expect(db.databases[0].serviceDb.tables).toEqual([ expect.objectContaining({ diff --git a/src/artifacts/load.ts b/src/artifacts/load.ts index 8f1e729..8479bf7 100644 --- a/src/artifacts/load.ts +++ b/src/artifacts/load.ts @@ -678,9 +678,11 @@ export async function loadArtifacts(root: string, configFile = ROOT_CONFIG) { : serviceIdByName.get(config.service.name) for (const [index, entry] of config.architectureDiagrams.entries()) { const where = `${file}: architectureDiagrams[${entry.name}]` - const id = slugify(path.posix.basename(path.posix.dirname(entry.path))) + const id = slugify(entry.path) if (diagramIds.has(id)) { - errors.push(`${where}: another diagram already uses the folder "${id}"`) + errors.push( + `${where}: another diagram already uses the path "${entry.path}"` + ) continue } let mermaid: string diff --git a/src/artifacts/write.test.ts b/src/artifacts/write.test.ts index 95664c9..199b7c8 100644 --- a/src/artifacts/write.test.ts +++ b/src/artifacts/write.test.ts @@ -71,7 +71,7 @@ describe('diagrams', () => { }) expect( await createDiagram(root, '.uigraph.yaml', '.uigraph.yaml', 'Payments') - ).toBe('payments-2') + ).toBe('uigraph-diagrams-payments-2-payments-2-mmd') expect(await readRepoFile(root, '.uigraph.yaml')) .toContain(` - name: Checkout flow # main flow path: .uigraph/diagrams/checkout/checkout.mmd @@ -82,8 +82,8 @@ describe('diagrams', () => { const { db, errors } = await loadArtifacts(root) expect(errors).toEqual([]) expect(db.diagrams.map((d) => d.entity.id)).toEqual([ - 'checkout', - 'payments-2', + 'uigraph-diagrams-checkout-checkout-mmd', + 'uigraph-diagrams-payments-2-payments-2-mmd', ]) }) @@ -99,9 +99,14 @@ describe('diagrams', () => { it('renames a diagram without touching the rest of the file', async () => { const root = await createRepo(ORDERS_FILES) const before = await readRepoFile(root, '.uigraph.yaml') - const saved = await saveDiagram(root, '.uigraph.yaml', 'checkout', { - name: ' Checkout v2 ', - }) + const saved = await saveDiagram( + root, + '.uigraph.yaml', + 'uigraph-diagrams-checkout-checkout-mmd', + { + name: ' Checkout v2 ', + } + ) expect(saved.name).toBe('Checkout v2') expect(await readRepoFile(root, '.uigraph.yaml')).toBe( before.replace('name: Checkout flow # main', 'name: Checkout v2 # main') @@ -112,12 +117,17 @@ describe('diagrams', () => { const root = await createRepo(ORDERS_FILES) const { db } = await loadArtifacts(root) const flow = db.diagrams[0].flow - await saveDiagram(root, '.uigraph.yaml', 'checkout', { - content: JSON.stringify({ - nodes: flow.nodes.filter((node) => node.id !== 'Db'), - edges: flow.edges.filter((edge) => edge.target !== 'Db'), - }), - }) + await saveDiagram( + root, + '.uigraph.yaml', + 'uigraph-diagrams-checkout-checkout-mmd', + { + content: JSON.stringify({ + nodes: flow.nodes.filter((node) => node.id !== 'Db'), + edges: flow.edges.filter((edge) => edge.target !== 'Db'), + }), + } + ) const mermaid = await readRepoFile( root, '.uigraph/diagrams/checkout/checkout.mmd' @@ -137,7 +147,11 @@ describe('diagrams', () => { ...ORDERS_FILES, '.uigraph/diagrams/checkout/images/shot.png': 'png', }) - await deleteDiagram(root, '.uigraph.yaml', 'checkout') + await deleteDiagram( + root, + '.uigraph.yaml', + 'uigraph-diagrams-checkout-checkout-mmd' + ) expect(await readRepoFile(root, '.uigraph.yaml')).toContain( 'architectureDiagrams: []\n' ) diff --git a/src/artifacts/write.ts b/src/artifacts/write.ts index f1689d3..df4c080 100644 --- a/src/artifacts/write.ts +++ b/src/artifacts/write.ts @@ -260,8 +260,7 @@ export async function createDiagram( let folder = base for ( let suffix = 2; - db.diagrams.some((d) => d.entity.id === folder) || - (await fs.lstat(path.join(root, '.uigraph/diagrams', folder)).then( + await fs.lstat(path.join(root, '.uigraph/diagrams', folder)).then( () => true, (error: NodeJS.ErrnoException) => { if (error.code === 'ENOENT') { @@ -269,7 +268,7 @@ export async function createDiagram( } throw error } - )); + ); suffix++ ) { folder = `${base}-${suffix}` @@ -296,7 +295,7 @@ export async function createDiagram( appendItem(source, document, ['architectureDiagrams'], entry), ]) ) - return folder + return slugify(entry.path) } export async function deleteDiagram( diff --git a/src/server.test.ts b/src/server.test.ts index 21fbcf6..98871ca 100644 --- a/src/server.test.ts +++ b/src/server.test.ts @@ -161,7 +161,12 @@ describe('GraphQL', () => { }, diagrams: { items: [ - { id: expect.stringMatching(/--checkout$/), name: 'Checkout flow' }, + { + id: expect.stringMatching( + /--uigraph-diagrams-checkout-checkout-mmd$/ + ), + name: 'Checkout flow', + }, ], }, apiEndpoints: [