@likec4/core 1.19.1 → 1.20.0

package/src/compute-view/deployment-view/predicates/relation-in-out.ts

@@ -1,24 +1,27 @@
+import { filter, pipe } from 'remeda'
 import { invariant } from '../../../errors'
 import { findConnectionsBetween } from '../../../model/connection/deployment'
 import type { RelationshipModel } from '../../../model/RelationModel'
 import type { AnyAux } from '../../../model/types'
-import { FqnExpr, type RelationExpr } from '../../../types/expression-v2'
+import { type RelationExpr, FqnExpr } from '../../../types/expression-v2'
 import { union } from '../../../utils/set'
 import type { PredicateExecutor } from '../_types'
 import { resolveElements, resolveModelElements } from '../utils'
-import { excludeModelRelations, resolveAscendingSiblings } from './relation-direct'
+import { resolveAscendingSiblings } from './relation-direct'
 import { filterIncomingConnections } from './relation-incoming'
 import { filterOutgoingConnections } from './relation-outgoing'
+import { applyPredicate, excludeModelRelations, matchConnections } from './utils'
 
 //
 export const InOutRelationPredicate: PredicateExecutor<RelationExpr.InOut> = {
-  include: ({ expr, model, memory, stage }) => {
+  include: ({ expr, model, memory, stage, where }) => {
     const sources = [...memory.elements]
 
     if (FqnExpr.isWildcard(expr.inout)) {
       for (const source of sources) {
         const targets = [...resolveAscendingSiblings(source)]
-        stage.addConnections(findConnectionsBetween(source, targets, 'both'))
+        const toInclude = matchConnections(findConnectionsBetween(source, targets, 'both'), where)
+        stage.addConnections(toInclude)
       }
       return stage
     }
@@ -26,12 +29,13 @@ export const InOutRelationPredicate: PredicateExecutor<RelationExpr.InOut> = {
 
     const targets = resolveElements(model, expr.inout)
     for (const source of sources) {
-      stage.addConnections(findConnectionsBetween(source, targets, 'both'))
+      const toInclude = matchConnections(findConnectionsBetween(source, targets, 'both'), where)
+      stage.addConnections(toInclude)
     }
 
     return stage
   },
-  exclude: ({ expr, model, memory, stage }) => {
+  exclude: ({ expr, model, memory, stage, where }) => {
     // Exclude all connections that have model relationshps with the elements
     if (FqnExpr.isModelRef(expr.inout)) {
       const elements = resolveModelElements(model, expr.inout)
@@ -42,7 +46,7 @@ export const InOutRelationPredicate: PredicateExecutor<RelationExpr.InOut> = {
         new Set<RelationshipModel<AnyAux>>(),
         ...elements.flatMap(e => [e.allIncoming, e.allOutgoing]),
       )
-      return excludeModelRelations(excludedRelations, { stage, memory })
+      return excludeModelRelations(excludedRelations, { stage, memory }, where)
     }
 
     if (FqnExpr.isWildcard(expr.inout)) {
@@ -54,7 +58,11 @@ export const InOutRelationPredicate: PredicateExecutor<RelationExpr.InOut> = {
     const isIncoming = filterIncomingConnections(elements)
     const isOutgoing = filterOutgoingConnections(elements)
 
-    const toExclude = memory.connections.filter(c => isIncoming(c) !== isOutgoing(c))
+    const toExclude = pipe(
+      memory.connections,
+      filter(c => isIncoming(c) !== isOutgoing(c)),
+      applyPredicate(where),
+    )
     stage.excludeConnections(toExclude)
     return stage
   },

package/src/compute-view/deployment-view/predicates/relation-incoming.ts

@@ -1,18 +1,18 @@
-import { anyPass } from 'remeda'
+import { anyPass, filter, pipe } from 'remeda'
 import { invariant } from '../../../errors'
+import type { AnyAux, RelationshipModel } from '../../../model'
 import { findConnectionsBetween } from '../../../model/connection/deployment'
 import type { LikeC4DeploymentModel } from '../../../model/DeploymentModel'
-import type { RelationshipModel } from '../../../model/RelationModel'
-import type { AnyAux } from '../../../model/types'
-import { FqnExpr, type RelationExpr } from '../../../types'
-import { isAncestor } from '../../../utils/fqn'
+import { type RelationExpr, FqnExpr } from '../../../types'
+import { isAncestor } from '../../../utils'
 import type { Connection, Elem, PredicateExecutor } from '../_types'
 import { resolveElements, resolveModelElements } from '../utils'
-import { excludeModelRelations, resolveAscendingSiblings } from './relation-direct'
+import { resolveAscendingSiblings } from './relation-direct'
+import { applyPredicate, excludeModelRelations } from './utils'
 
 // from visible element incoming to this
 export const IncomingRelationPredicate: PredicateExecutor<RelationExpr.Incoming> = {
-  include: ({ expr, model, memory, stage }) => {
+  include: ({ expr, model, memory, stage, where }) => {
     const sources = [...memory.elements]
 
     if (FqnExpr.isWildcard(expr.incoming)) {
@@ -21,7 +21,8 @@ export const IncomingRelationPredicate: PredicateExecutor<RelationExpr.Incoming>
           continue
         }
         const targets = [...resolveAscendingSiblings(source)]
-        stage.addConnections(findConnectionsBetween(source, targets, 'directed'))
+        const toInclude = applyPredicate(findConnectionsBetween(source, targets, 'directed'), where)
+        stage.addConnections(toInclude)
       }
       return stage
     }
@@ -29,16 +30,17 @@ export const IncomingRelationPredicate: PredicateExecutor<RelationExpr.Incoming>
 
     const targets = resolveElements(model, expr.incoming)
     for (const source of sources) {
-      stage.addConnections(findConnectionsBetween(source, targets, 'directed'))
+      const toInclude = applyPredicate(findConnectionsBetween(source, targets, 'directed'), where)
+      stage.addConnections(toInclude)
     }
 
     return stage
   },
-  exclude: ({ expr, model, memory, stage }) => {
+  exclude: ({ expr, model, memory, stage, where }) => {
     // Exclude all connections that have model relationshps with the elements
     if (FqnExpr.isModelRef(expr.incoming)) {
       const excludedRelations = resolveAllImcomingRelations(model, expr.incoming)
-      return excludeModelRelations(excludedRelations, { stage, memory })
+      return excludeModelRelations(excludedRelations, { stage, memory }, where)
     }
     if (FqnExpr.isWildcard(expr.incoming)) {
       // non-sense
@@ -46,7 +48,11 @@ export const IncomingRelationPredicate: PredicateExecutor<RelationExpr.Incoming>
     }
 
     const isIncoming = filterIncomingConnections(resolveElements(model, expr.incoming))
-    const toExclude = memory.connections.filter(isIncoming)
+    const toExclude = pipe(
+      memory.connections,
+      filter(isIncoming),
+      applyPredicate(where),
+    )
     stage.excludeConnections(toExclude)
     return stage
   },

package/src/compute-view/deployment-view/predicates/relation-outgoing.ts

@@ -1,16 +1,17 @@
-import { anyPass } from 'remeda'
+import { anyPass, filter, pipe } from 'remeda'
 import { invariant } from '../../../errors'
 import type { LikeC4DeploymentModel } from '../../../model'
 import { findConnection, findConnectionsBetween } from '../../../model/connection/deployment'
 import type { RelationshipModel } from '../../../model/RelationModel'
-import { FqnExpr, type RelationExpr } from '../../../types'
+import { type RelationExpr, FqnExpr } from '../../../types'
 import { isAncestor } from '../../../utils'
 import type { Connection, Elem, PredicateExecutor } from '../_types'
 import { resolveElements, resolveModelElements } from '../utils'
-import { excludeModelRelations, resolveAscendingSiblings } from './relation-direct'
+import { resolveAscendingSiblings } from './relation-direct'
+import { applyPredicate, excludeModelRelations } from './utils'
 
 export const OutgoingRelationPredicate: PredicateExecutor<RelationExpr.Outgoing> = {
-  include: ({ expr, model, memory, stage }) => {
+  include: ({ expr, model, memory, stage, where }) => {
     const targets = [...memory.elements]
 
     // * -> (to visible elements)
@@ -21,7 +22,8 @@ export const OutgoingRelationPredicate: PredicateExecutor<RelationExpr.Outgoing>
           continue
         }
         for (const source of resolveAscendingSiblings(target)) {
-          stage.addConnections(findConnection(source, target, 'directed'))
+          const toInclude = applyPredicate(findConnection(source, target, 'directed'), where)
+          stage.addConnections(toInclude)
         }
       }
       return stage
@@ -30,16 +32,17 @@ export const OutgoingRelationPredicate: PredicateExecutor<RelationExpr.Outgoing>
 
     const sources = resolveElements(model, expr.outgoing)
     for (const source of sources) {
-      stage.addConnections(findConnectionsBetween(source, targets, 'directed'))
+      const toInclude = applyPredicate(findConnectionsBetween(source, targets, 'directed'), where)
+      stage.addConnections(toInclude)
     }
 
     return stage
   },
-  exclude: ({ expr, model, memory, stage }) => {
+  exclude: ({ expr, model, memory, stage, where }) => {
     // Exclude all connections that have model relationshps with the elements
     if (FqnExpr.isModelRef(expr.outgoing)) {
       const excludedRelations = resolveAllOutgoingRelations(model, expr.outgoing)
-      return excludeModelRelations(excludedRelations, { stage, memory })
+      return excludeModelRelations(excludedRelations, { stage, memory }, where)
     }
     if (FqnExpr.isWildcard(expr.outgoing)) {
       // non-sense
@@ -47,7 +50,11 @@ export const OutgoingRelationPredicate: PredicateExecutor<RelationExpr.Outgoing>
     }
 
     const isOutgoing = filterOutgoingConnections(resolveElements(model, expr.outgoing))
-    const toExclude = memory.connections.filter(isOutgoing)
+    const toExclude = pipe(
+      memory.connections,
+      filter(isOutgoing),
+      applyPredicate(where),
+    )
     stage.excludeConnections(toExclude)
     return stage
   },

package/src/compute-view/deployment-view/predicates/relation-where.ts

@@ -0,0 +1,18 @@
+import { whereOperatorAsPredicate, type RelationExpr } from '../../../types'
+import type { PredicateExecutor } from '../_types'
+import type { StageExclude, StageInclude } from '../memory'
+import { predicateToPatch } from './utils'
+
+// relation matches the condition
+export const WhereRelationPredicate: PredicateExecutor<RelationExpr.Where> = {
+  include: ({ expr, model, memory, stage }) => {
+    const where = whereOperatorAsPredicate(expr.where.condition)
+
+    return predicateToPatch('include', { expr: expr.where.expr, model, stage, memory, where }) as StageInclude
+  },
+  exclude: ({ expr, model, memory, stage }) => {    
+    const where = whereOperatorAsPredicate(expr.where.condition)
+
+    return predicateToPatch('exclude', { expr: expr.where.expr, model, stage, memory, where }) as StageExclude
+  }
+}

package/src/compute-view/deployment-view/predicates/utils.ts

@@ -0,0 +1,214 @@
+import { filter, isArray, map, pick, pipe } from 'remeda'
+import { nonexhaustive } from '../../../errors'
+import { type DeploymentConnectionModel, ElementModel, isDeployedInstance, isDeploymentNode } from '../../../model'
+import type {
+  DeploymentElementModel,
+  DeploymentRelationEndpoint,
+  DeploymentRelationModel,
+} from '../../../model/DeploymentElementModel'
+import { isElementModel } from '../../../model/ElementModel'
+import { isDeploymentElementModel, isNestedElementOfDeployedInstanceModel } from '../../../model/guards'
+import type { RelationshipModel } from '../../../model/RelationModel'
+import type { AnyAux } from '../../../model/types'
+import { type Filterable, type OperatorPredicate, FqnExpr, RelationExpr } from '../../../types'
+import { hasIntersection, intersection } from '../../../utils/set'
+import type { ExcludePredicateCtx, PredicateCtx } from '../_types'
+import type { StageExclude, StageInclude } from '../memory'
+import { DeploymentRefPredicate } from './elements'
+import { DirectRelationPredicate } from './relation-direct'
+import { InOutRelationPredicate } from './relation-in-out'
+import { IncomingRelationPredicate } from './relation-incoming'
+import { OutgoingRelationPredicate } from './relation-outgoing'
+import { WhereRelationPredicate } from './relation-where'
+import { WildcardPredicate } from './wildcard'
+
+/**
+ * Builds a patch object from an expression
+ */
+export function predicateToPatch(
+  op: 'include' | 'exclude',
+  { expr, where, ...ctx }: PredicateCtx,
+): StageExclude | StageInclude | undefined {
+  switch (true) {
+    case FqnExpr.isModelRef(expr):
+      // Ignore model refs in deployment view
+      return undefined
+    case FqnExpr.isDeploymentRef(expr):
+      return DeploymentRefPredicate[op]({ ...ctx, expr, where } as any)
+    case FqnExpr.isWildcard(expr):
+      return WildcardPredicate[op]({ ...ctx, expr, where } as any)
+    case RelationExpr.isDirect(expr):
+      return DirectRelationPredicate[op]({ ...ctx, expr, where } as any)
+    case RelationExpr.isInOut(expr):
+      return InOutRelationPredicate[op]({ ...ctx, expr, where } as any)
+    case RelationExpr.isOutgoing(expr):
+      return OutgoingRelationPredicate[op]({ ...ctx, expr, where } as any)
+    case RelationExpr.isIncoming(expr):
+      return IncomingRelationPredicate[op]({ ...ctx, expr, where } as any)
+    case RelationExpr.isWhere(expr):
+      return WhereRelationPredicate[op]({ ...ctx, expr, where } as any)
+    default:
+      nonexhaustive(expr)
+  }
+}
+
+export function excludeModelRelations(
+  relationsToExclude: ReadonlySet<RelationshipModel<AnyAux>>,
+  { stage, memory }: Pick<ExcludePredicateCtx, 'stage' | 'memory'>,
+  where: OperatorPredicate<Filterable> | null,
+  // Optional filter to scope the connections to exclude
+  filterConnections: (c: DeploymentConnectionModel) => boolean = () => true,
+): StageExclude {
+  if (relationsToExclude.size === 0) {
+    return stage
+  }
+  const toExclude = pipe(
+    memory.connections,
+    filter(c => filterConnections(c)),
+    // Find connections that have at least one relation in common with the excluded relations
+    filter(c => hasIntersection(c.relations.model, relationsToExclude)),
+    map(c =>
+      c.update({
+        deployment: null,
+        model: intersection(c.relations.model, relationsToExclude),
+      })
+    ),
+    applyPredicate(where),
+    filter(c => c.nonEmpty()),
+  )
+  if (toExclude.length === 0) {
+    return stage
+  }
+  return stage.excludeConnections(toExclude)
+}
+
+export function matchConnection<M extends AnyAux>(
+  c: DeploymentConnectionModel<M>,
+  where: OperatorPredicate<Filterable> | null,
+): boolean {
+  return applyPredicate(c, where).nonEmpty()
+}
+
+/**
+ * Filters relations of the provided connections using the provided predicate.
+ * And copy of the connection with the filtered relations will be created.
+ * Connections left without relations are removed from resulting collection.
+ *
+ * @param c The connection to apply the predicate to
+ * @param where The predicate
+ * @returns A copy of the connection with the filtered relations
+ */
+export function applyPredicate<M extends AnyAux>(
+  c: readonly DeploymentConnectionModel<M>[],
+  where: OperatorPredicate<Filterable> | null,
+): readonly DeploymentConnectionModel<M>[]
+/**
+ * Filters relations of the connection using the provided predicate.
+ *
+ * @param c The connection to apply the predicate to
+ * @param where The predicate
+ * @returns A deep copy of the original collection with the filtered relations
+ */
+export function applyPredicate<M extends AnyAux>(
+  c: DeploymentConnectionModel<M>,
+  where: OperatorPredicate<Filterable> | null,
+): DeploymentConnectionModel<M>
+/**
+ * Creates a function that filters relations of the provided connections using the provided predicate.
+ * Connections left without relations are removed from resulting collection.
+ *
+ * @param c The connection to apply the predicate to
+ * @param where The predicate
+ * @returns A function to create a filtered copy of connections
+ */
+export function applyPredicate<M extends AnyAux>(
+  where: OperatorPredicate<Filterable> | null,
+): (data: readonly DeploymentConnectionModel<M>[]) => readonly DeploymentConnectionModel<M>[]
+export function applyPredicate<M extends AnyAux>(
+  ...args:
+    | [readonly DeploymentConnectionModel<M>[], OperatorPredicate<Filterable> | null]
+    | [OperatorPredicate<Filterable> | null]
+    | [c: DeploymentConnectionModel<M>, OperatorPredicate<Filterable> | null]
+):
+  | DeploymentConnectionModel<M>
+  | readonly DeploymentConnectionModel<M>[]
+  | ((data: readonly DeploymentConnectionModel<M>[]) => readonly DeploymentConnectionModel<M>[])
+{
+  if (args.length === 1) {
+    return x => applyPredicate(x, args[0])
+  }
+
+  const [c, where] = args
+  if (where === null) {
+    return c
+  }
+
+  if (isArray(c)) {
+    return c
+      .map(x => applyPredicate(x, where))
+      .filter(x => x.nonEmpty())
+  }
+
+  return c.update({
+    model: new Set([...c.relations.model.values()].filter(r => where(toFilterableRelation(c)(r)))),
+    deployment: new Set([...c.relations.deployment.values()].filter(r => where(toFilterableRelation(c)(r)))),
+  })
+}
+
+export function matchConnections<M extends AnyAux>(
+  connections: readonly DeploymentConnectionModel<M>[],
+  where: OperatorPredicate<Filterable> | null,
+): readonly DeploymentConnectionModel[] {
+  if (!where) {
+    return connections
+  }
+
+  return pipe(
+    connections,
+    filter(c => matchConnection(c, where)),
+  )
+}
+
+/**
+ * Builds filterable presentation for relation endpoint. Enriches model properties with deployment properties when needed.
+ * @param relationEndpoint Endpoint for which to build presentation
+ * @param connectionEndpoint Endpoint of connection which was build from the relation.
+ * @returns Presentation of the endpoint for usage in predicates
+ */
+function toFilterable<M extends AnyAux>(
+  relationEndpoint: ElementModel<M> | DeploymentRelationEndpoint<M>,
+  connectionEndpoint: DeploymentRelationEndpoint<M>,
+): Filterable {
+  if (isElementModel(relationEndpoint)) { // Element itself. Extend with tags of the deployed instance (TODO)
+    const deployedInstance = isDeploymentElementModel(connectionEndpoint) && isDeployedInstance(connectionEndpoint)
+      ? connectionEndpoint
+      : null
+    return {
+      kind: relationEndpoint.kind,
+      tags: [...relationEndpoint.tags, ...(deployedInstance?.tags ?? [])],
+    }
+  }
+  if (isNestedElementOfDeployedInstanceModel(relationEndpoint)) { // Nested element. Has no own instance. No need to extend
+    return pick(relationEndpoint.element, ['tags', 'kind'])
+  }
+  if (isDeployedInstance(relationEndpoint)) { // Deployed instance. Extend with tags of the model element
+    return {
+      kind: relationEndpoint.element.kind,
+      tags: [...relationEndpoint.tags, ...relationEndpoint.element.tags],
+    }
+  }
+  if (isDeploymentNode(relationEndpoint)) { // Deployment node. Has no representation in model. No need to extend
+    return pick(relationEndpoint, ['tags', 'kind'])
+  }
+
+  nonexhaustive(relationEndpoint)
+}
+
+function toFilterableRelation<M extends AnyAux>(c: DeploymentConnectionModel<M>) {
+  return (relation: RelationshipModel<M> | DeploymentRelationModel<M>) => ({
+    tags: relation.tags,
+    kind: relation.kind,
+    source: toFilterable(relation.source, c.source),
+    target: toFilterable(relation.target, c.target),
+  })
+}

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

@@ -18,10 +18,7 @@ import {
   type IconUrl,
   type IncomingExpr as C4IncomingExpr,
   type InOutExpr as C4InOutExpr,
-  isElementRef,
-  isElementWhere,
-  isRelationExpression,
-  isRelationWhere,
+  type KindEqual,
   type ModelRelation,
   type NonEmptyArray,
   type OutgoingExpr as C4OutgoingExpr,
@@ -30,6 +27,7 @@ import {
   type RelationshipLineType,
   type RelationWhereExpr,
   type Tag,
+  type TagEqual,
   type ViewId,
   type ViewRule,
   type ViewRuleGlobalPredicateRef,
@@ -38,8 +36,13 @@ import {
   type ViewRulePredicate,
   type ViewRuleStyle,
   type WhereOperator,
+  isElementRef,
+  isElementWhere,
+  isRelationExpression,
+  isRelationWhere,
 } from '../../../types'
 import { type DirectRelationExpr as C4RelationExpr } from '../../../types/expression'
+import type { Participant } from '../../../types/operators'
 import { withReadableEdges } from '../../utils/with-readable-edges'
 import { computeElementView } from '../compute'
 
@@ -482,6 +485,16 @@ export function $where(
   }
 }
 
+export function $participant(
+  participant: Participant,
+  operator: TagEqual<TestTag> | KindEqual<TestTag>,
+): WhereOperator<TestTag, string> {
+  return {
+    participant,
+    operator,
+  }
+}
+
 export function $inout(
   expr: InOutExpr | C4ElementExpression,
 ): C4InOutExpr {

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

@@ -1,8 +1,9 @@
 import DefaultMap from 'mnemonist/default-map'
 import { filter, findLast, forEach, map, pipe } from 'remeda'
 import { invariant, nonexhaustive, nonNullable } from '../../errors'
-import { type ElementModel, LikeC4Model } from '../../model'
 import { ConnectionModel } from '../../model/connection/model/ConnectionModel'
+import { type ElementModel } from '../../model/ElementModel'
+import { LikeC4Model } from '../../model/LikeC4Model'
 import type { RelationshipModel } from '../../model/RelationModel'
 import type { AnyAux } from '../../model/types'
 import type {
@@ -15,7 +16,7 @@ import type {
 } from '../../types'
 import { isViewRuleAutoLayout, isViewRuleGroup, isViewRulePredicate, whereOperatorAsPredicate } from '../../types'
 import * as Expr from '../../types/expression'
-import { sortNaturalByFqn, sortParentsFirst } from '../../utils'
+import { sortParentsFirst } from '../../utils'
 import { applyCustomElementProperties } from '../utils/applyCustomElementProperties'
 import { applyCustomRelationProperties } from '../utils/applyCustomRelationProperties'
 import { applyViewRuleStyles } from '../utils/applyViewRuleStyles'