Skip to content

Fix Human readable IDs in autorouter diagnostics #2091

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mohan-bee wants to merge 19 commits into
base: main
Choose a base branch
from
Open

Fix Human readable IDs in autorouter diagnostics #2091

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
0d47456
Fix Human readable IDs in autorouter diagnostics
mohan-bee Apr 1, 2026
ce4f6cd
chore: updated to use await
mohan-bee Apr 1, 2026
2f466dd
chore
mohan-bee Apr 1, 2026
65c6d5c
fix timeout
mohan-bee Apr 1, 2026
2fe030d
chore
mohan-bee Apr 1, 2026
74d1360
chore
mohan-bee Apr 1, 2026
888d5c9
format
mohan-bee Apr 1, 2026
ac7a74f
increase timeout
mohan-bee Apr 1, 2026
9781531
format
mohan-bee Apr 1, 2026
933d21a
format
mohan-bee Apr 2, 2026
8c5a6f7
subcircuit filtering
mohan-bee Apr 2, 2026
23d19f8
format
mohan-bee Apr 2, 2026
da18624
Revert "format"
mohan-bee Apr 2, 2026
382864b
Revert "subcircuit filtering"
mohan-bee Apr 2, 2026
06bb90c
fix
mohan-bee Apr 2, 2026
c6609d7
format
mohan-bee Apr 2, 2026
a6ae111
update
mohan-bee Apr 2, 2026
1173cf2
up
mohan-bee Apr 2, 2026
6ecacfc
upg
mohan-bee Apr 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 67 additions & 51 deletions lib/utils/autorouting/getSimpleRouteJsonFromCircuitJson.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,24 @@ import type { SimpleRouteConnection } from "./SimpleRouteJson"
import type { SimpleRouteJson } from "./SimpleRouteJson"
import { getDescendantSubcircuitIds } from "./getAncestorSubcircuitIds"

/**
* Get a readable name for a Port
*/
export const getReadableName = (
db: CircuitJsonUtilObjects,
portId?: string,
): string | undefined => {
if (!portId) return undefined
const pcbPort = db.pcb_port?.get(portId)
if (!pcbPort?.source_port_id) return portId
const sourcePort = db.source_port?.get(pcbPort.source_port_id!)
if (!sourcePort) return portId
const sourceComponent = db.source_component?.get(
sourcePort.source_component_id!,
)
return `${sourceComponent?.name ?? "unknown"}.${sourcePort.name}`
}
Copy link
Copy Markdown
Contributor

@seveibar seveibar Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

import this method from @tscircuit/circuit-json-util instead


/**
* This function can only be called in the PcbTraceRender phase or later
*/
Expand All @@ -34,7 +52,7 @@ export const getSimpleRouteJsonFromCircuitJson = ({
throw new Error("db or circuitJson is required")
}

const traceHints = db.pcb_trace_hint.list()
const traceHints = db.pcb_trace_hint?.list() ?? []

const relevantSubcircuitIds: Set<string> | null = subcircuit_id
? new Set([subcircuit_id])
Expand All @@ -58,16 +76,17 @@ export const getSimpleRouteJsonFromCircuitJson = ({
let board: PcbBoard | undefined | null = null
if (subcircuit_id) {
const source_group_id = subcircuit_id.replace(/^subcircuit_/, "")
const source_board = db.source_board.getWhere({ source_group_id })
const source_board = db.source_board?.getWhere({ source_group_id })
if (source_board) {
board = db.pcb_board.getWhere({
source_board_id: source_board.source_board_id,
})
board =
db.pcb_board?.getWhere({
source_board_id: source_board.source_board_id,
}) ?? null
}
}

if (!board) {
board = db.pcb_board.list()[0]
board = db.pcb_board?.list()?.[0]
}

db = su(subcircuitElements)
Expand All @@ -76,12 +95,12 @@ export const getSimpleRouteJsonFromCircuitJson = ({

const obstacles = getObstaclesFromCircuitJson(
[
...db.pcb_component.list(),
...db.pcb_smtpad.list(),
...db.pcb_plated_hole.list(),
...db.pcb_hole.list(),
...db.pcb_via.list(),
...db.pcb_cutout.list(),
...(db.pcb_component?.list() ?? []),
...(db.pcb_smtpad?.list() ?? []),
...(db.pcb_plated_hole?.list() ?? []),
...(db.pcb_hole?.list() ?? []),
...(db.pcb_via?.list() ?? []),
...(db.pcb_cutout?.list() ?? []),
// getObstaclesFromSoup is old and doesn't support diagonal traces
// ...db.pcb_trace.list(),
].filter(
Expand All @@ -99,7 +118,8 @@ export const getSimpleRouteJsonFromCircuitJson = ({
}

// Build mapping from source_port_id to internal connection ID for interconnects
const internalConnections = db.source_component_internal_connection.list()
const internalConnections =
db.source_component_internal_connection?.list() ?? []
const sourcePortIdToInternalConnectionId = new Map<string, string>()
for (const ic of internalConnections) {
for (const sourcePortId of ic.source_port_ids) {
Expand All @@ -112,10 +132,10 @@ export const getSimpleRouteJsonFromCircuitJson = ({

// Build mapping from pcb_smtpad_id/pcb_plated_hole_id to source_port_id via pcb_port
const pcbElementIdToSourcePortId = new Map<string, string>()
for (const pcbPort of db.pcb_port.list()) {
for (const pcbPort of db.pcb_port?.list() ?? []) {
if (pcbPort.source_port_id) {
// Find the smtpad or plated hole associated with this port
const smtpad = db.pcb_smtpad.getWhere({
const smtpad = db.pcb_smtpad?.getWhere({
pcb_port_id: pcbPort.pcb_port_id,
})
if (smtpad) {
Expand All @@ -124,7 +144,7 @@ export const getSimpleRouteJsonFromCircuitJson = ({
pcbPort.source_port_id,
)
}
const platedHole = db.pcb_plated_hole.getWhere({
const platedHole = db.pcb_plated_hole?.getWhere({
pcb_port_id: pcbPort.pcb_port_id,
})
if (platedHole) {
Expand Down Expand Up @@ -185,7 +205,7 @@ export const getSimpleRouteJsonFromCircuitJson = ({
}

if (subcircuit_id) {
const group = db.pcb_group.getWhere({ subcircuit_id })
const group = db.pcb_group?.getWhere({ subcircuit_id })
if (group?.width && group.height) {
const groupBounds = {
minX: group.center.x - group.width / 2,
Expand All @@ -202,20 +222,18 @@ export const getSimpleRouteJsonFromCircuitJson = ({
}
}
const routedTraceIds = new Set(
db.pcb_trace
.list()
(db.pcb_trace?.list() ?? [])
.map((t) => t.source_trace_id)
.filter((id): id is string => Boolean(id)),
)

// Create connections from traces
const directTraceConnections = db.source_trace
.list()
const directTraceConnections = (db.source_trace?.list() ?? [])
.filter((trace) => !routedTraceIds.has(trace.source_trace_id))
.map((trace) => {
const connectedPorts = trace.connected_source_port_ids.map((id) => {
const source_port = db.source_port.get(id)
const pcb_port = db.pcb_port.getWhere({ source_port_id: id })
const source_port = db.source_port?.get(id)
const pcb_port = db.pcb_port?.getWhere({ source_port_id: id })
return {
...source_port,
...pcb_port,
Expand All @@ -228,14 +246,20 @@ export const getSimpleRouteJsonFromCircuitJson = ({
const [portA, portB] = connectedPorts

if (portA.x === undefined || portA.y === undefined) {
const readablePortA = getReadableName(db, portA.pcb_port_id)
console.error(
`(source_port_id: ${portA.source_port_id}) for trace ${trace.source_trace_id} does not have x/y coordinates. Skipping this trace.`,
`(pcb_port_id: ${readablePortA ?? portA.pcb_port_id}) for trace ${
Copy link
Copy Markdown
Contributor

@seveibar seveibar Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the text is literally wrong, it's not a pcb port id. Also you can commit to the readable name, remove the ??

trace.source_trace_id
} does not have x/y coordinates. Skipping this trace.`,
)
return null
}
if (portB.x === undefined || portB.y === undefined) {
const readablePortB = getReadableName(db, portB.pcb_port_id)
console.error(
`(source_port_id: ${portB.source_port_id}) for trace ${trace.source_trace_id} does not have x/y coordinates. Skipping this trace.`,
`(pcb_port_id: ${readablePortB ?? portB.pcb_port_id}) for trace ${
trace.source_trace_id
} does not have x/y coordinates. Skipping this trace.`,
)
return null
}
Expand All @@ -253,7 +277,7 @@ export const getSimpleRouteJsonFromCircuitJson = ({
const hintPoints: { x: number; y: number; layer: string }[] = []

for (const hint of matchingHints) {
const port = db.pcb_port.get(hint.pcb_port_id)
const port = db.pcb_port?.get(hint.pcb_port_id)
const layer = port?.layers?.[0] ?? "top"
for (const pt of hint.route) {
hintPoints.push({
Expand All @@ -267,7 +291,7 @@ export const getSimpleRouteJsonFromCircuitJson = ({
return {
name:
trace.source_trace_id ??
connMap.getNetConnectedToId(trace.source_trace_id) ??
connMap.getNetConnectedToId(trace.source_trace_id!) ??
"",
source_trace_id: trace.source_trace_id,
nominalTraceWidth: trace.min_trace_thickness,
Expand Down Expand Up @@ -296,26 +320,22 @@ export const getSimpleRouteJsonFromCircuitJson = ({
directTraceConnections.map((c) => [c.source_trace_id, c]),
)

const source_nets = db.source_net
.list()
.filter(
(e) => !subcircuit_id || relevantSubcircuitIds?.has(e.subcircuit_id!),
)
const source_nets = (db.source_net?.list() ?? []).filter(
(e) => !subcircuit_id || relevantSubcircuitIds?.has(e.subcircuit_id!),
)

const connectionsFromNets: SimpleRouteConnection[] = []
for (const net of source_nets) {
const connectedSourceTraces = db.source_trace
.list()
.filter((st) => st.connected_source_net_ids?.includes(net.source_net_id))
const connectedSourceTraces = (db.source_trace?.list() ?? []).filter((st) =>
st.connected_source_net_ids?.includes(net.source_net_id),
)

connectionsFromNets.push({
name: net.source_net_id ?? connMap.getNetConnectedToId(net.source_net_id),
pointsToConnect: connectedSourceTraces.flatMap((st) => {
const pcb_ports = db.pcb_port
.list()
.filter((p) =>
st.connected_source_port_ids.includes(p.source_port_id),
)
const pcb_ports = (db.pcb_port?.list() ?? []).filter((p) =>
st.connected_source_port_ids.includes(p.source_port_id),
)

return pcb_ports.map((p) => ({
x: p.x!,
Expand All @@ -328,11 +348,9 @@ export const getSimpleRouteJsonFromCircuitJson = ({
})
}

const breakoutPoints = db.pcb_breakout_point
.list()
.filter(
(bp) => !subcircuit_id || relevantSubcircuitIds?.has(bp.subcircuit_id!),
)
const breakoutPoints = (db.pcb_breakout_point?.list() ?? []).filter(
(bp) => !subcircuit_id || relevantSubcircuitIds?.has(bp.subcircuit_id!),
)

const connectionsFromBreakoutPoints: SimpleRouteConnection[] = []
const breakoutTraceConnectionsById = new Map<string, SimpleRouteConnection>()
Expand Down Expand Up @@ -365,7 +383,7 @@ export const getSimpleRouteJsonFromCircuitJson = ({
})
}
} else if ((bp as any).source_port_id) {
const pcb_port = db.pcb_port.getWhere({
const pcb_port = db.pcb_port?.getWhere({
source_port_id: (bp as any).source_port_id,
})
if (pcb_port) {
Expand Down Expand Up @@ -405,11 +423,9 @@ export const getSimpleRouteJsonFromCircuitJson = ({
}

// ----- 3. Walk existing pcb_traces to find already-connected port groups
const existingTraces = db.pcb_trace
.list()
.filter(
(t) => !subcircuit_id || relevantSubcircuitIds?.has(t.subcircuit_id!),
)
const existingTraces = (db.pcb_trace?.list() ?? []).filter(
(t) => !subcircuit_id || relevantSubcircuitIds?.has(t.subcircuit_id!),
)

for (const tr of existingTraces) {
const tracePortIds = new Set<string>()
Expand Down
29 changes: 29 additions & 0 deletions tests/utils/autorouting/simple-route-json-readable-names.test.tsx
View file
Open in desktop
Copy link
Copy Markdown
Contributor

@MustafaMulla29 MustafaMulla29 Apr 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't console.log in tests, you can inline snapshot it

Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
import { expect, test } from "bun:test"
import { RootCircuit } from "lib/RootCircuit"
import "lib/register-catalogue"
import { getReadableName } from "lib/utils/autorouting/getSimpleRouteJsonFromCircuitJson"

test("verify ID mapping fix", async () => {
const circuit = new RootCircuit()

circuit.add(
<board width={10} height={10}>
<resistor name="R1" pcbX={-2} pcbY={0} resistance="1k" footprint="0402" />
<resistor name="R2" pcbX={2} pcbY={0} resistance="1k" footprint="0402" />
<net name="MY_NET" />
<trace from=".R1 > .pin1" to="net.MY_NET" />
<trace from=".R2 > .pin1" to="net.MY_NET" />
</board>,
)

await circuit.renderUntilSettled()

// Verify that getReadableName resolves correctly
const pcb_port = circuit.db.pcb_port.list()[0]

const readableName = getReadableName(circuit.db, pcb_port?.pcb_port_id)
console.log("Resolved Readable Name:", readableName)

expect(typeof readableName).toBe("string")
expect(readableName).toContain(".")
})
Loading