weavatrix 0.2.13 → 0.2.14

package/src/analysis/architecture/contract-schema.js

@@ -0,0 +1,110 @@
+import {createHash} from 'node:crypto'
+
+export const ARCHITECTURE_CONTRACT_V = 1
+
+const RELATION_KIND = new Set(['runtime', 'type-only', 'compile-only', 'any'])
+const ACTION = new Set(['allow', 'forbid'])
+const ENFORCEMENT = new Set(['ratchet', 'strict', 'advisory'])
+
+export const safeArchitectureId = (value, fallback = '') => {
+    const text = String(value ?? '').trim()
+    return /^[a-z0-9][a-z0-9._:-]{0,127}$/i.test(text) ? text : fallback
+}
+
+export const architecturePathPrefix = (value) => {
+    const text = String(value ?? '').replace(/\\/g, '/').replace(/^\.\//, '').replace(/^\/+|\/+$/g, '')
+    return text && !text.split('/').some((part) => !part || part === '.' || part === '..') ? text : null
+}
+
+export const finiteArchitectureBudget = (value, fallback = null) => {
+    const number = Number(value)
+    return Number.isFinite(number) && number >= 0 ? number : fallback
+}
+
+const stringList = (value, sanitize, cap = 100) => [...new Set((Array.isArray(value) ? value : [])
+    .slice(0, cap).map(sanitize).filter(Boolean))]
+
+const stable = (value) => Array.isArray(value)
+    ? `[${value.map(stable).join(',')}]`
+    : value && typeof value === 'object'
+        ? `{${Object.keys(value).sort().map((key) => `${JSON.stringify(key)}:${stable(value[key])}`).join(',')}}`
+        : JSON.stringify(value)
+
+export const architectureHash = (value) => createHash('sha256').update(stable(value)).digest('hex')
+
+function sanitizeComponent(value, index) {
+    const id = safeArchitectureId(value?.id, `component-${index + 1}`)
+    const paths = stringList(value?.paths ?? [value?.path], architecturePathPrefix, 64)
+    if (!paths.length) return null
+    return {id, name: String(value?.name || id).slice(0, 128), paths}
+}
+
+function sanitizeRule(value, index) {
+    const from = stringList(value?.from, (item) => item === '*' ? '*' : safeArchitectureId(item), 64)
+    const to = stringList(value?.to, (item) => item === '*' ? '*' : safeArchitectureId(item), 64)
+    if (!from.length || !to.length) return null
+    return {
+        id: safeArchitectureId(value?.id, `dependency-${index + 1}`),
+        action: ACTION.has(value?.action) ? value.action : 'forbid',
+        kinds: stringList(value?.kinds ?? ['runtime'], (kind) => RELATION_KIND.has(kind) ? kind : '', 4),
+        from,
+        to,
+        ...(value?.reason ? {reason: String(value.reason).slice(0, 300)} : {}),
+    }
+}
+
+function sanitizeException(value) {
+    const fingerprint = /^[a-f0-9]{16,64}$/i.test(String(value?.fingerprint || '')) ? String(value.fingerprint) : null
+    if (!fingerprint) return null
+    const expires = /^\d{4}-\d{2}-\d{2}$/.test(String(value?.expires || '')) ? String(value.expires) : null
+    return {fingerprint, reason: String(value?.reason || '').slice(0, 300), ...(expires ? {expires} : {})}
+}
+
+function normalizeBudgets(raw = {}) {
+    const budgets = {
+        runtimeCycles: finiteArchitectureBudget(raw.runtimeCycles),
+        maxFunctionLoc: finiteArchitectureBudget(raw.maxFunctionLoc),
+        maxFileLoc: finiteArchitectureBudget(raw.maxFileLoc),
+        maxCyclomatic: finiteArchitectureBudget(raw.maxCyclomatic),
+        maxParams: finiteArchitectureBudget(raw.maxParams),
+        maxRuntimeDependenciesPerComponent: finiteArchitectureBudget(raw.maxRuntimeDependenciesPerComponent),
+        maxModuleFiles: finiteArchitectureBudget(raw.maxModuleFiles),
+        minModuleCohesion: finiteArchitectureBudget(raw.minModuleCohesion),
+        maxModuleBoundaryRatio: finiteArchitectureBudget(raw.maxModuleBoundaryRatio),
+    }
+    for (const key of Object.keys(budgets)) if (budgets[key] == null) delete budgets[key]
+    return budgets
+}
+
+export function normalizeArchitectureContract(input) {
+    if (!input || typeof input !== 'object' || Array.isArray(input)) throw new Error('architecture contract must be an object')
+    const components = (Array.isArray(input.components) ? input.components : [])
+        .slice(0, 200).map(sanitizeComponent).filter(Boolean)
+    const componentIds = new Set(components.map((item) => item.id))
+    const dependencyRules = (Array.isArray(input.dependencyRules) ? input.dependencyRules : [])
+        .slice(0, 500).map(sanitizeRule).filter(Boolean)
+        .filter((rule) => [...rule.from, ...rule.to].every((id) => id === '*' || componentIds.has(id)))
+    const baseline = input.ratchet?.baseline && typeof input.ratchet.baseline === 'object'
+        ? {
+            fingerprints: stringList(input.ratchet.baseline.fingerprints, (item) => /^[a-f0-9]{16,64}$/i.test(String(item)) ? String(item) : '', 5_000),
+            metrics: Object.fromEntries(Object.entries(input.ratchet.baseline.metrics || {}).slice(0, 500)
+                .map(([key, value]) => [safeArchitectureId(key), finiteArchitectureBudget(value)]).filter(([key, value]) => key && value != null)),
+        }
+        : {fingerprints: [], metrics: {}}
+    const contract = {
+        architectureContractV: ARCHITECTURE_CONTRACT_V,
+        name: String(input.name || 'Target architecture').slice(0, 128),
+        style: safeArchitectureId(input.style, 'custom'),
+        enforcement: ENFORCEMENT.has(input.enforcement) ? input.enforcement : 'ratchet',
+        components,
+        dependencyRules,
+        budgets: normalizeBudgets(input.budgets),
+        technologies: {
+            required: stringList(input.technologies?.required, (item) => safeArchitectureId(item), 100),
+            forbidden: stringList(input.technologies?.forbidden, (item) => safeArchitectureId(item), 100),
+        },
+        exceptions: (Array.isArray(input.exceptions) ? input.exceptions : []).slice(0, 500).map(sanitizeException).filter(Boolean),
+        ratchet: {baseline},
+    }
+    return {...contract, contractHash: architectureHash(contract)}
+}

package/src/analysis/architecture/contract-storage.js

@@ -0,0 +1,35 @@
+import {existsSync, readFileSync, writeFileSync, mkdirSync} from 'node:fs'
+import {dirname, join} from 'node:path'
+import {createRepoBoundary} from '../../repo-path.js'
+import {normalizeArchitectureContract} from './contract-schema.js'
+
+export const CONTRACT_PATHS = ['.weavatrix/architecture.json', '.weavatrix-architecture.json']
+
+const readContract = (path, source) => {
+    try {
+        return {contract: normalizeArchitectureContract(JSON.parse(readFileSync(path, 'utf8'))), source}
+    } catch (error) {
+        return {contract: null, source, error: error.message}
+    }
+}
+
+export function loadArchitectureContract(repoRoot, graphPath) {
+    const boundary = createRepoBoundary(repoRoot)
+    for (const relative of CONTRACT_PATHS) {
+        const resolved = boundary.resolve(relative)
+        if (resolved.ok && existsSync(resolved.path)) return readContract(resolved.path, relative)
+    }
+    const cached = graphPath ? join(dirname(graphPath), 'architecture.contract.json') : null
+    return cached && existsSync(cached)
+        ? readContract(cached, 'hosted-cache')
+        : {contract: null, source: null, error: null}
+}
+
+export function writeCachedArchitectureContract(graphPath, input) {
+    if (!graphPath) throw new Error('graph path is required for hosted contract cache')
+    const contract = normalizeArchitectureContract(input)
+    const path = join(dirname(graphPath), 'architecture.contract.json')
+    mkdirSync(dirname(path), {recursive: true})
+    writeFileSync(path, JSON.stringify(contract, null, 2), 'utf8')
+    return {path, contract}
+}

package/src/analysis/architecture/contract-verification.js

@@ -0,0 +1,168 @@
+import {
+    architectureHash,
+    architecturePathPrefix,
+    finiteArchitectureBudget,
+    normalizeArchitectureContract,
+} from './contract-schema.js'
+import {
+    architectureViolation as violation,
+    collectComponentEdges,
+    collectComponentFitness,
+    componentForFile,
+    fileOfNode,
+    isSymbolNode,
+    matchComponentSelector as matches,
+    runtimeFileGraph,
+    stronglyConnected,
+} from './contract-graph.js'
+
+function dependencyViolations(componentEdges, contract) {
+    const violations = []
+    for (const edge of componentEdges.values()) {
+        const applicable = contract.dependencyRules.filter((rule) =>
+            rule.kinds.some((kind) => kind === 'any' || kind === edge.kind) && matches(rule.from, edge.from))
+        for (const rule of applicable) if (rule.action === 'forbid' && matches(rule.to, edge.to)) {
+            violations.push(violation(rule.id, 'dependency', `${edge.from} -> ${edge.to} (${edge.kind})`, edge.count, 0))
+        }
+        const allowRules = applicable.filter((rule) => rule.action === 'allow')
+        if (allowRules.length && !allowRules.some((rule) => matches(rule.to, edge.to))) {
+            const ruleId = allowRules.map((rule) => rule.id).sort().join('+')
+            violations.push(violation(ruleId, 'dependency', `${edge.from} -> ${edge.to} (${edge.kind}; outside allow-list)`, edge.count, 0))
+        }
+    }
+    return violations
+}
+
+function componentBudgetViolations(componentEdges, stats, contract) {
+    const violations = []
+    const targetsByComponent = new Map()
+    for (const edge of componentEdges.values()) if (edge.kind === 'runtime') {
+        const targets = targetsByComponent.get(edge.from) || new Set()
+        targets.add(edge.to)
+        targetsByComponent.set(edge.from, targets)
+    }
+    if (contract.budgets.maxRuntimeDependenciesPerComponent != null) for (const [component, targets] of targetsByComponent) {
+        if (targets.size > contract.budgets.maxRuntimeDependenciesPerComponent) violations.push(violation(
+            'budget.maxRuntimeDependenciesPerComponent', 'budget', `${component} runtime dependencies`, targets.size,
+            contract.budgets.maxRuntimeDependenciesPerComponent,
+        ))
+    }
+    for (const [component, item] of stats) {
+        const internal = item.internalPairs.size, boundary = item.boundaryPairs.size
+        const cohesion = internal + boundary ? internal / (internal + boundary) : 1
+        const boundaryRatio = internal + boundary ? boundary / (internal + boundary) : 0
+        if (contract.budgets.maxModuleFiles != null && item.files.size > contract.budgets.maxModuleFiles) {
+            violations.push(violation('budget.maxModuleFiles', 'budget', `${component} files`, item.files.size, contract.budgets.maxModuleFiles))
+        }
+        if (contract.budgets.minModuleCohesion != null && cohesion < contract.budgets.minModuleCohesion) {
+            violations.push(violation('budget.minModuleCohesion', 'budget', `${component} cohesion`, Number(cohesion.toFixed(4)), contract.budgets.minModuleCohesion))
+        }
+        if (contract.budgets.maxModuleBoundaryRatio != null && boundaryRatio > contract.budgets.maxModuleBoundaryRatio) {
+            violations.push(violation('budget.maxModuleBoundaryRatio', 'budget', `${component} boundary ratio`, Number(boundaryRatio.toFixed(4)), contract.budgets.maxModuleBoundaryRatio))
+        }
+    }
+    return violations
+}
+
+function codeBudgetViolations(nodes, byId, contract) {
+    const violations = []
+    for (const node of nodes) {
+        const loc = finiteArchitectureBudget(node?.complexity?.loc)
+        const cyclomatic = finiteArchitectureBudget(node?.complexity?.cyclomatic)
+        const params = finiteArchitectureBudget(node?.complexity?.params)
+        const evidence = `${node.source_file || fileOfNode(node.id, byId)}#${node.label || node.id}`
+        if (contract.budgets.maxFunctionLoc != null && loc != null && loc > contract.budgets.maxFunctionLoc) {
+            violations.push(violation('budget.maxFunctionLoc', 'budget', evidence, loc, contract.budgets.maxFunctionLoc))
+        }
+        if (contract.budgets.maxCyclomatic != null && cyclomatic != null && cyclomatic > contract.budgets.maxCyclomatic) {
+            violations.push(violation('budget.maxCyclomatic', 'budget', evidence, cyclomatic, contract.budgets.maxCyclomatic))
+        }
+        if (contract.budgets.maxParams != null && params != null && params > contract.budgets.maxParams) {
+            violations.push(violation('budget.maxParams', 'budget', evidence, params, contract.budgets.maxParams))
+        }
+    }
+    if (contract.budgets.maxFileLoc != null) for (const node of nodes.filter((item) => !isSymbolNode(item.id))) {
+        const file = String(node.source_file || node.id)
+        const physicalLoc = finiteArchitectureBudget(node.physical_loc)
+        if (physicalLoc != null && physicalLoc > contract.budgets.maxFileLoc) {
+            violations.push(violation('budget.maxFileLoc', 'budget', file, physicalLoc, contract.budgets.maxFileLoc))
+        }
+    }
+    return violations
+}
+
+function technologyViolations(contract, technologies) {
+    const techSet = new Set(technologies.map((item) => String(item ?? '').trim()).filter(Boolean))
+    const violations = []
+    for (const required of contract.technologies.required) if (!techSet.has(required)) {
+        violations.push(violation('technology.required', 'technology', `missing ${required}`))
+    }
+    for (const forbidden of contract.technologies.forbidden) if (techSet.has(forbidden)) {
+        violations.push(violation('technology.forbidden', 'technology', `forbidden ${forbidden}`))
+    }
+    return violations
+}
+
+const componentFitnessMetrics = (stats) => Object.fromEntries([...stats].map(([component, item]) => {
+    const internal = item.internalPairs.size, boundary = item.boundaryPairs.size
+    return [component, {
+        files: item.files.size,
+        cohesion: internal + boundary ? Number((internal / (internal + boundary)).toFixed(4)) : 1,
+        boundaryRatio: internal + boundary ? Number((boundary / (internal + boundary)).toFixed(4)) : 0,
+    }]
+}))
+
+export function verifyArchitecture({graph, contract: rawContract, technologies = []}) {
+    const contract = rawContract?.contractHash ? rawContract : normalizeArchitectureContract(rawContract)
+    const {nodes, links, byId, componentEdges} = collectComponentEdges(graph, contract)
+    const stats = collectComponentFitness(nodes, links, byId, contract)
+    const runtimeCycles = stronglyConnected(runtimeFileGraph(graph))
+    const violations = [
+        ...dependencyViolations(componentEdges, contract),
+        ...componentBudgetViolations(componentEdges, stats, contract),
+        ...codeBudgetViolations(nodes, byId, contract),
+        ...technologyViolations(contract, technologies),
+    ]
+    if (contract.budgets.runtimeCycles != null && runtimeCycles.length > contract.budgets.runtimeCycles) {
+        violations.push(violation('budget.runtimeCycles', 'budget', `runtime cycles: ${runtimeCycles.length}`, runtimeCycles.length, contract.budgets.runtimeCycles))
+    }
+    const exceptions = new Set(contract.exceptions
+        .filter((item) => !item.expires || item.expires >= new Date().toISOString().slice(0, 10))
+        .map((item) => item.fingerprint))
+    const active = violations.filter((item) => !exceptions.has(item.fingerprint))
+    const baseline = new Set(contract.ratchet.baseline.fingerprints)
+    const current = new Set(active.map((item) => item.fingerprint))
+    const fresh = active.filter((item) => !baseline.has(item.fingerprint))
+    const existing = active.filter((item) => baseline.has(item.fingerprint))
+    const fixed = [...baseline].filter((fingerprint) => !current.has(fingerprint))
+    const status = contract.enforcement === 'advisory'
+        ? 'ADVISORY'
+        : contract.enforcement === 'strict' ? (active.length ? 'FAIL' : 'PASS') : (fresh.length ? 'FAIL' : 'PASS')
+    const result = {
+        architectureVerificationV: 1,
+        contractHash: contract.contractHash,
+        status,
+        enforcement: contract.enforcement,
+        metrics: {
+            runtimeCycles: runtimeCycles.length,
+            violations: active.length,
+            componentDependencies: componentEdges.size,
+            mappedComponents: contract.components.length,
+            componentFitness: componentFitnessMetrics(stats),
+        },
+        new: fresh,
+        existing,
+        fixed,
+        excepted: violations.filter((item) => exceptions.has(item.fingerprint)),
+        componentEdges: [...componentEdges.values()].sort((a, b) => a.from.localeCompare(b.from) || a.to.localeCompare(b.to) || a.kind.localeCompare(b.kind)),
+        runtimeCycles: runtimeCycles.slice(0, 100),
+    }
+    return {...result, verificationHash: architectureHash(result)}
+}
+
+export function contractForChange(contract, files = []) {
+    const normalized = (Array.isArray(files) ? files.slice(0, 200) : []).map(architecturePathPrefix).filter(Boolean)
+    const components = [...new Set(normalized.map((file) => componentForFile(file, contract.components)))]
+    const rules = contract.dependencyRules.filter((rule) => components.some((component) => matches(rule.from, component) || matches(rule.to, component)))
+    return {files: normalized, components, rules, budgets: contract.budgets, technologies: contract.technologies}
+}