@likec4/core 1.18.0 → 1.19.1

package/src/compute-view/element-view/__test__/TestHelper.ts

@@ -0,0 +1,258 @@
+import { indexBy, isArray, isString, map, mapValues, pipe, prop } from 'remeda'
+import type { Writable } from 'type-fest'
+import type { ExpectStatic } from 'vitest'
+import { expect as vitestExpect } from 'vitest'
+import {
+  type AnyTypes,
+  type Builder,
+  type ElementViewRulesBuilder,
+  type Types,
+  type ViewPredicate,
+} from '../../../builder'
+import * as viewhelpers from '../../../builder/Builder.view-common'
+import { mkViewBuilder } from '../../../builder/Builder.views'
+import { differenceConnections } from '../../../model/connection'
+import type { ComputedElementView, ElementView, ViewId, ViewRule } from '../../../types'
+import { compareNatural } from '../../../utils'
+import { imap, toArray } from '../../../utils/iterable'
+import { difference as differenceSet } from '../../../utils/set'
+import type { CtxConnection, CtxElement } from '../../memory'
+import { withReadableEdges } from '../../utils/with-readable-edges'
+import { processPredicates as processPredicatesImpl } from '../compute'
+import { type Ctx, Memory } from '../memory'
+
+type ConnectionExpression<T extends AnyTypes> = `${T['Fqn']} -> ${T['Fqn']}`
+
+// type ConnectionsDeepMatcher<T extends AnyTypes> = {
+//   [K in `${T['Fqn']} -> ${T['Fqn']}`]?: {
+//     relations?: Array<`${T['Fqn']} -> ${T['Fqn']}`>
+//   }
+// }
+
+type ConnectionsDeepMatcher<Expr extends string> = {
+  [K in Expr]?: Array<Expr>
+}
+
+type ConnectionEqual<T extends AnyTypes> = [ConnectionsDeepMatcher<ConnectionExpression<T>>] | [
+  ConnectionExpression<T>,
+  ...ConnectionExpression<T>[],
+]
+
+type Elem = CtxElement<Ctx>
+type Connection = CtxConnection<Ctx>
+
+export class TestHelper<T extends AnyTypes> {
+  model: Types.ToLikeC4Model<T>
+
+  static $include = viewhelpers.$include
+  static $exclude = viewhelpers.$exclude
+  static $rules = viewhelpers.$rules
+  static $style = viewhelpers.$style
+
+  $include = viewhelpers.$include
+  $exclude = viewhelpers.$exclude
+  $style = viewhelpers.$style
+
+  static from<const T extends AnyTypes>(builder: Builder<T>, expect = vitestExpect): TestHelper<T> {
+    return new TestHelper(builder, expect)
+  }
+
+  constructor(
+    private builder: Builder<T>,
+    private _expect: ExpectStatic,
+  ) {
+    this.model = builder.toLikeC4Model() as Types.ToLikeC4Model<T>
+  }
+
+  computeView = (...rules: ElementViewRulesBuilder<T>[]) => {
+    return withReadableEdges(
+      this.builder
+        .clone()
+        .views(_ => _.view('dev').with(...rules))
+        .toLikeC4Model()
+        .view('dev')
+        .$view as ComputedElementView<'dev'>,
+      ' -> ',
+    )
+  }
+
+  processPredicates(...rules: ElementViewRulesBuilder<T>[]) {
+    return ProcessPredicates.execute(this, ...rules)
+  }
+  processPredicatesWithScope(scope: T['Fqn'], ...rules: ElementViewRulesBuilder<T>[]) {
+    return ProcessPredicates.executeWithScope(this, scope, ...rules)
+  }
+
+  expectView(view: ComputedElementView) {
+    return {
+      toHave: (nodesAndEdges: { nodes: Array<T['Fqn']>; edges: Array<ConnectionExpression<T>> }) => {
+        const actual = {
+          nodes: view.nodes.map(prop('id')),
+          edges: view.edges.map(prop('id')),
+        }
+        this._expect(actual).toEqual(nodesAndEdges)
+      },
+      toHaveNodes: <Id extends T['Fqn']>(...nodes: Id[]) => {
+        this._expect(view.nodes.map(prop('id'))).toEqual(nodes)
+      },
+      toHaveEdges: <Id extends ConnectionExpression<T>>(...edges: Id[]) => {
+        this._expect(view.edges.map(prop('id'))).toEqual(edges)
+      },
+    }
+  }
+
+  expectComputedView(...rules: ElementViewRulesBuilder<T>[]) {
+    return this.expectView(this.computeView(...rules))
+  }
+
+  expectMemory = (memory: Memory) => ({
+    toHaveAllElements: <Id extends T['Fqn']>(...ids: Id[]) => {
+      this._expect(map([...memory.elements], prop('id'))).toEqual(ids)
+    },
+    /**
+     * Final elements (visible in the view)
+     */
+    toHaveElements: <Id extends T['Fqn']>(...ids: Id[]) => {
+      this._expect(map([...memory.final], prop('id'))).toEqual(ids)
+    },
+    toHaveConnections: (...matchers: ConnectionEqual<T>) => {
+      this.expectConnections(memory.connections).toEqual(...matchers)
+    },
+  })
+
+  expectElements = (elements: ReadonlySet<Elem>) => ({
+    toEqual: <const Id extends ViewPredicate.DeploymentConnectionExpression<T>>(...ids: Id[]) => {
+      this._expect(toArray(imap(elements, prop('id')))).toEqual(ids)
+    },
+  })
+
+  expectConnections = (connections: ReadonlyArray<Connection>) => ({
+    toBeEmpty: () => {
+      this._expect(connections.map(c => c.expression)).to.be.empty
+    },
+    toEqual: (...matchers: ConnectionEqual<T>) => {
+      const [matcher, ...rest] = matchers
+      if (isString(matcher)) {
+        this._expect(connections.map(c => c.expression)).toEqual([matcher, ...rest])
+        return
+      }
+      const obj = pipe(
+        connections,
+        indexBy(prop('expression')),
+        mapValues(c => [...c.relations].map(prop('expression')).sort(compareNatural)),
+      )
+      const expected = mapValues(matcher, (v: any) => [...v].sort(compareNatural))
+      this._expect(obj).toEqual(expected)
+    },
+  })
+
+  expectStep = (step: ProcessPredicates<T>) => ({
+    ...this.expectMemory(step.memory),
+  })
+
+  expect(value: ComputedElementView): ReturnType<typeof this['expectView']>
+  expect(value: Set<Elem>): ReturnType<typeof this['expectElements']>
+  expect(value: ReadonlyArray<Connection>): ReturnType<typeof this['expectConnections']>
+  expect(value: Memory | ProcessPredicates<T>): ReturnType<typeof this['expectMemory']>
+  expect(value: Memory | ProcessPredicates<T> | Set<Elem> | ComputedElementView | ReadonlyArray<Connection>) {
+    if (value instanceof Memory) {
+      return this.expectMemory(value)
+    }
+    if (value instanceof ProcessPredicates) {
+      return this.expectStep(value)
+    }
+    if (value instanceof Set) {
+      return this.expectElements(value)
+    }
+    if (isArray(value)) {
+      return this.expectConnections(value)
+    }
+    return this.expectView(value)
+  }
+}
+
+class ProcessPredicates<T extends AnyTypes> {
+  static execute<A extends AnyTypes>(
+    test: TestHelper<A>,
+    ...rules: ElementViewRulesBuilder<A>[]
+  ): ProcessPredicates<A> {
+    const processor = new ProcessPredicates(test)
+    processor.next(...rules)
+    return processor
+  }
+
+  static executeWithScope<A extends AnyTypes>(
+    test: TestHelper<A>,
+    scope: A['Fqn'],
+    ...rules: ElementViewRulesBuilder<A>[]
+  ): ProcessPredicates<A> {
+    const processor = new ProcessPredicates(test, scope)
+    processor.next(...rules)
+    return processor
+  }
+
+  public viewrules: ReadonlyArray<ViewRule> = []
+
+  public previousMemory: Memory = Memory.empty(null)
+  public memory: Memory = Memory.empty(null)
+  public predicates: ElementViewRulesBuilder<T>[] = []
+
+  constructor(
+    public readonly t: TestHelper<T>,
+    public scope: T['Fqn'] | null = null,
+    protected age = 0,
+  ) {}
+
+  get elements() {
+    return toArray(imap(this.memory.elements, prop('id')))
+  }
+
+  get connections() {
+    return this.memory.connections.map(c => c.expression)
+  }
+
+  diff() {
+    const prevState = this.previousMemory
+    const state = this.memory
+    return {
+      added: this.memory.update({
+        elements: differenceSet(state.elements, prevState.elements),
+        explicits: differenceSet(state.explicits, prevState.explicits),
+        final: differenceSet(state.final, prevState.final),
+        connections: differenceConnections(state.connections, prevState.connections),
+      }),
+      removed: this.memory.update({
+        elements: differenceSet(prevState.elements, state.elements),
+        explicits: differenceSet(prevState.explicits, state.explicits),
+        final: differenceSet(prevState.final, state.final),
+        connections: differenceConnections(prevState.connections, state.connections),
+      }),
+    }
+  }
+
+  next(...predicates: ElementViewRulesBuilder<T>[]): this {
+    const view = {
+      id: 'test' as ViewId,
+      __: 'element',
+      rules: [],
+    } as any as Writable<ElementView>
+    let vb = mkViewBuilder(view) as any
+    this.predicates = [
+      ...this.predicates,
+      ...predicates,
+    ]
+    for (const rule of this.predicates) {
+      rule(vb)
+    }
+    this.previousMemory = this.memory
+    this.viewrules = view.rules
+    const scope = this.scope ? this.t.model.element(this.scope) : null
+    this.memory = processPredicatesImpl(
+      this.t.model,
+      Memory.empty(scope),
+      view.rules,
+    )
+    this.age++
+    return this
+  }
+}

package/src/compute-view/element-view/__test__/__snapshots__/legacy.spec.ts.snap

@@ -24,57 +24,59 @@ exports[`compute-element-view > view of cloud 1`] = `
       "label": "manages",
       "parent": null,
       "relations": [
-        "support:cloud.frontend.adminPanel",
+        "support:cloud.frontend.supportPanel",
       ],
       "source": "support",
       "target": "cloud.frontend",
     },
     {
       "id": "cloud.frontend:cloud.backend",
+      "kind": "graphlql",
       "label": "requests",
       "parent": "cloud",
       "relations": [
         "cloud.frontend:cloud.backend",
         "cloud.frontend.dashboard:cloud.backend.graphql",
-        "cloud.frontend.adminPanel:cloud.backend.graphql",
+        "cloud.frontend.supportPanel:cloud.backend.graphql",
       ],
       "source": "cloud.frontend",
       "tags": [
         "next",
         "old",
       ],
+      "tail": "odiamond",
       "target": "cloud.backend",
     },
     {
-      "id": "cloud.backend:amazon",
-      "label": "uploads",
+      "id": "cloud.backend:email",
+      "label": "schedule",
       "parent": null,
       "relations": [
-        "cloud.backend.storage:amazon.s3",
+        "cloud.backend:email",
       ],
       "source": "cloud.backend",
       "tags": [
-        "aws",
-        "legacy",
-        "storage",
+        "communication",
       ],
-      "target": "amazon",
+      "target": "email",
     },
     {
-      "id": "cloud.backend:email",
-      "label": "schedule",
+      "id": "cloud.backend:amazon",
+      "label": "uploads",
       "parent": null,
       "relations": [
-        "cloud.backend:email",
+        "cloud.backend.storage:amazon.s3",
       ],
       "source": "cloud.backend",
       "tags": [
-        "communication",
+        "aws",
+        "storage",
+        "legacy",
       ],
-      "target": "email",
+      "target": "amazon",
     },
   ],
-  "hash": "3e66b5ad85ed469ae32e87604c15a6e7e186dcba",
+  "hash": "6df052156ae59d91622677537c2d657e4946d803",
   "id": "index",
   "links": null,
   "nodes": [
@@ -128,16 +130,16 @@ exports[`compute-element-view > view of cloud 1`] = `
       "description": null,
       "id": "cloud",
       "inEdges": [
-        "support:cloud.frontend",
         "customer:cloud.frontend",
+        "support:cloud.frontend",
       ],
       "kind": "system",
       "level": 0,
       "links": null,
       "modelRef": 1,
       "outEdges": [
-        "cloud.backend:amazon",
         "cloud.backend:email",
+        "cloud.backend:amazon",
       ],
       "parent": null,
       "shape": "rectangle",
@@ -155,8 +157,8 @@ exports[`compute-element-view > view of cloud 1`] = `
       "description": null,
       "id": "cloud.frontend",
       "inEdges": [
-        "support:cloud.frontend",
         "customer:cloud.frontend",
+        "support:cloud.frontend",
       ],
       "kind": "container",
       "level": 1,
@@ -185,8 +187,8 @@ exports[`compute-element-view > view of cloud 1`] = `
       "links": null,
       "modelRef": 1,
       "outEdges": [
-        "cloud.backend:amazon",
         "cloud.backend:email",
+        "cloud.backend:amazon",
       ],
       "parent": "cloud",
       "shape": "rectangle",
@@ -254,16 +256,6 @@ exports[`compute-element-view > view of cloud.frontend 1`] = `
   "customColorDefinitions": {},
   "description": null,
   "edges": [
-    {
-      "id": "support:cloud.frontend.adminPanel",
-      "label": "manages",
-      "parent": null,
-      "relations": [
-        "support:cloud.frontend.adminPanel",
-      ],
-      "source": "support",
-      "target": "cloud.frontend.adminPanel",
-    },
     {
       "id": "customer:cloud.frontend.dashboard",
       "label": "opens in browser",
@@ -275,20 +267,14 @@ exports[`compute-element-view > view of cloud.frontend 1`] = `
       "target": "cloud.frontend.dashboard",
     },
     {
-      "id": "cloud.frontend.adminPanel:cloud.backend",
-      "kind": "graphlql",
-      "label": "fetches",
-      "line": "dashed",
+      "id": "support:cloud.frontend.supportPanel",
+      "label": "manages",
       "parent": null,
       "relations": [
-        "cloud.frontend.adminPanel:cloud.backend.graphql",
+        "support:cloud.frontend.supportPanel",
       ],
-      "source": "cloud.frontend.adminPanel",
-      "tags": [
-        "old",
-      ],
-      "tail": "odiamond",
-      "target": "cloud.backend",
+      "source": "support",
+      "target": "cloud.frontend.supportPanel",
     },
     {
       "id": "cloud.frontend.dashboard:cloud.backend",
@@ -305,8 +291,24 @@ exports[`compute-element-view > view of cloud.frontend 1`] = `
       ],
       "target": "cloud.backend",
     },
+    {
+      "id": "cloud.frontend.supportPanel:cloud.backend",
+      "kind": "graphlql",
+      "label": "fetches",
+      "line": "dashed",
+      "parent": null,
+      "relations": [
+        "cloud.frontend.supportPanel:cloud.backend.graphql",
+      ],
+      "source": "cloud.frontend.supportPanel",
+      "tags": [
+        "old",
+      ],
+      "tail": "odiamond",
+      "target": "cloud.backend",
+    },
   ],
-  "hash": "c187cb8d56ed752122754d1937d8598e8c1544f7",
+  "hash": "388ed63a4179b91d2953e5c4908c651e3e826eb0",
   "id": "index",
   "links": null,
   "nodes": [
@@ -314,46 +316,46 @@ exports[`compute-element-view > view of cloud.frontend 1`] = `
       "children": [],
       "color": "primary",
       "description": null,
-      "id": "support",
+      "id": "customer",
       "inEdges": [],
       "kind": "actor",
       "level": 0,
       "links": null,
       "modelRef": 1,
       "outEdges": [
-        "support:cloud.frontend.adminPanel",
+        "customer:cloud.frontend.dashboard",
       ],
       "parent": null,
       "shape": "person",
       "style": {},
       "tags": null,
       "technology": null,
-      "title": "support",
+      "title": "customer",
     },
     {
       "children": [],
       "color": "primary",
       "description": null,
-      "id": "customer",
+      "id": "support",
       "inEdges": [],
       "kind": "actor",
       "level": 0,
       "links": null,
       "modelRef": 1,
       "outEdges": [
-        "customer:cloud.frontend.dashboard",
+        "support:cloud.frontend.supportPanel",
       ],
       "parent": null,
       "shape": "person",
       "style": {},
       "tags": null,
       "technology": null,
-      "title": "customer",
+      "title": "support",
     },
     {
       "children": [
-        "cloud.frontend.adminPanel",
         "cloud.frontend.dashboard",
+        "cloud.frontend.supportPanel",
       ],
       "color": "primary",
       "depth": 1,
@@ -361,7 +363,7 @@ exports[`compute-element-view > view of cloud.frontend 1`] = `
       "id": "cloud.frontend",
       "inEdges": [
         "customer:cloud.frontend.dashboard",
-        "support:cloud.frontend.adminPanel",
+        "support:cloud.frontend.supportPanel",
       ],
       "kind": "container",
       "level": 0,
@@ -369,7 +371,7 @@ exports[`compute-element-view > view of cloud.frontend 1`] = `
       "modelRef": 1,
       "outEdges": [
         "cloud.frontend.dashboard:cloud.backend",
-        "cloud.frontend.adminPanel:cloud.backend",
+        "cloud.frontend.supportPanel:cloud.backend",
       ],
       "parent": null,
       "shape": "browser",
@@ -382,50 +384,50 @@ exports[`compute-element-view > view of cloud.frontend 1`] = `
       "children": [],
       "color": "primary",
       "description": null,
-      "id": "cloud.frontend.adminPanel",
+      "icon": "tech:react",
+      "id": "cloud.frontend.dashboard",
       "inEdges": [
-        "support:cloud.frontend.adminPanel",
+        "customer:cloud.frontend.dashboard",
       ],
       "kind": "component",
       "level": 1,
       "links": null,
       "modelRef": 1,
       "outEdges": [
-        "cloud.frontend.adminPanel:cloud.backend",
+        "cloud.frontend.dashboard:cloud.backend",
       ],
       "parent": "cloud.frontend",
       "shape": "rectangle",
       "style": {},
       "tags": [
-        "old",
+        "next",
       ],
       "technology": null,
-      "title": "adminPanel",
+      "title": "dashboard",
     },
     {
       "children": [],
       "color": "primary",
       "description": null,
-      "icon": "tech:react",
-      "id": "cloud.frontend.dashboard",
+      "id": "cloud.frontend.supportPanel",
       "inEdges": [
-        "customer:cloud.frontend.dashboard",
+        "support:cloud.frontend.supportPanel",
       ],
       "kind": "component",
       "level": 1,
       "links": null,
       "modelRef": 1,
       "outEdges": [
-        "cloud.frontend.dashboard:cloud.backend",
+        "cloud.frontend.supportPanel:cloud.backend",
       ],
       "parent": "cloud.frontend",
       "shape": "rectangle",
       "style": {},
       "tags": [
-        "next",
+        "old",
       ],
       "technology": null,
-      "title": "dashboard",
+      "title": "adminPanel",
     },
     {
       "children": [],
@@ -434,7 +436,7 @@ exports[`compute-element-view > view of cloud.frontend 1`] = `
       "id": "cloud.backend",
       "inEdges": [
         "cloud.frontend.dashboard:cloud.backend",
-        "cloud.frontend.adminPanel:cloud.backend",
+        "cloud.frontend.supportPanel:cloud.backend",
       ],
       "kind": "container",
       "level": 0,