@nmnmcc/ability 2.0.6 → 2.1.1

package/src/internal/nodes.ts

@@ -23,6 +23,7 @@ import type * as Effect from "effect/Effect"
 import { hasProperty } from "effect/Predicate"
 import * as Schema from "effect/Schema"
 import * as Limits from "./limits.ts"
+import * as Trampoline from "./trampoline.ts"
 
 /** A value that a condition can compare. */
 export type Scalar = string | number | boolean | null
@@ -83,14 +84,17 @@ const checkPath = (path: unknown): string => {
 	if (typeof path !== "string") {
 		throw new Error("A field path must be a string")
 	}
-	const parts = path.split(".", Limits.fieldPathParts + 1).length
-	if (parts > Limits.fieldPathParts) {
+	// A node does not know its domain, so it checks the ceiling. The binding
+	// to a domain checks the limit of the domain.
+	const most = Limits.ceilings.fieldPathParts
+	const parts = path.split(".", most + 1).length
+	if (parts > most) {
 		throw Limits.exceeded(
 			"A field path",
 			"fieldPathParts",
 			"parts",
 			parts,
-			Limits.fieldPathParts,
+			most,
 		)
 	}
 	return path
@@ -124,37 +128,46 @@ const checkOperands = (values: unknown): ReadonlyArray<Operand> => {
 
 interface Facts {
 	readonly size: number
+	readonly weight: number
 	readonly depth: number
 	readonly opaque: boolean
 }
 
-const leaf: Facts = { size: 1, depth: 1, opaque: false }
+const leaf: Facts = { size: 1, weight: 1, depth: 1, opaque: false }
 
-/** The facts of a node with children. It stops a node past the limits. */
-const factsOf = (children: ReadonlyArray<Node>): Facts => {
-	const size = Arr.reduce(children, 1, (total, child) => total + child.size)
-	if (size > Limits.conditionNodes) {
+/**
+ * The facts of a test with values, as `In` and `Under`. Each value counts in
+ * the weight, since a walk that reads the test reads its values too. It stops
+ * a test past the limits.
+ */
+const valuesFacts = (values: ReadonlyArray<Operand>): Facts =>
+	checkWeight({ ...leaf, weight: 1 + values.length })
+
+const checkWeight = (facts: Facts): Facts => {
+	// A node does not know its domain, so it checks the ceiling. The binding
+	// to a domain, and a decoder, check their limits.
+	if (facts.weight > Limits.ceilings.conditionNodes) {
 		throw Limits.exceeded(
 			"A condition",
 			"conditionNodes",
-			"nodes",
-			size,
-			Limits.conditionNodes,
+			"nodes and values",
+			facts.weight,
+			Limits.ceilings.conditionNodes,
 		)
 	}
+	return facts
+}
+
+/** The facts of a node with children. It stops a node past the limits. */
+const factsOf = (children: ReadonlyArray<Node>): Facts => {
+	const size = Arr.reduce(children, 1, (total, child) => total + child.size)
+	const weight = Arr.reduce(children, 1, (total, child) => total + child.weight)
+	checkWeight({ ...leaf, weight })
 	const depth =
 		1 + Arr.reduce(children, 0, (top, child) => Math.max(top, child.depth))
-	if (depth > Limits.conditionDepth) {
-		throw Limits.exceeded(
-			"A condition",
-			"conditionDepth",
-			"levels",
-			depth,
-			Limits.conditionDepth,
-		)
-	}
 	return {
 		size,
+		weight,
 		depth,
 		opaque: Arr.some(children, (child) => child.opaque),
 	}
@@ -183,6 +196,15 @@ abstract class Base extends Data.Class {
 		return this.#facts.size
 	}
 
+	/**
+	 * The number of nodes and of the values of their `In` and `Under` tests,
+	 * with a shared child counted for each place. A walk that reads the tests
+	 * does this much work, so the limits of the nodes count it.
+	 */
+	get weight(): number {
+		return this.#facts.weight
+	}
+
 	/** The number of levels. */
 	get depth(): number {
 		return this.#facts.depth
@@ -244,10 +266,8 @@ export class In extends Base {
 		readonly field: string
 		readonly values: ReadonlyArray<Operand>
 	}) {
-		super(
-			{ field: checkPath(props.field), values: checkOperands(props.values) },
-			leaf,
-		)
+		const values = checkOperands(props.values)
+		super({ field: checkPath(props.field), values }, valuesFacts(values))
 	}
 }
 
@@ -265,7 +285,8 @@ export class Under extends Base {
 	readonly _tag = "Under"
 	declare readonly prefix: ReadonlyArray<Operand>
 	constructor(props: { readonly prefix: ReadonlyArray<Operand> }) {
-		super({ prefix: checkOperands(props.prefix) }, leaf)
+		const prefix = checkOperands(props.prefix)
+		super({ prefix }, valuesFacts(prefix))
 	}
 }
 
@@ -333,7 +354,7 @@ export class Predicate extends Base {
 		}
 		super(
 			{ name: props.name, run: props.run },
-			{ size: 1, depth: 1, opaque: true },
+			{ size: 1, weight: 1, depth: 1, opaque: true },
 		)
 	}
 }
@@ -358,40 +379,61 @@ const operandJson = (operand: Operand): unknown =>
 			}
 		: { _tag: "Principal", path: operand.path }
 
-/** Gives the JSON form of a condition with no predicate. */
-export const toJson = (node: Node): unknown => {
-	switch (node._tag) {
-		case "True":
-		case "False":
-			return { _tag: node._tag }
-		case "Compare":
-			return {
-				_tag: "Compare",
-				op: node.op,
-				field: node.field,
-				value: operandJson(node.value),
-			}
-		case "In":
-			return {
-				_tag: "In",
-				field: node.field,
-				values: Arr.map(node.values, operandJson),
+/**
+ * Gives the JSON form of a condition with no predicate. The walk takes the
+ * steps of a trampoline, so a deep condition does not fill the stack.
+ */
+export const toJson = (root: Node): unknown =>
+	Trampoline.run(root.depth, (R) => {
+		const go = (node: Node): Trampoline.Step<unknown> => {
+			switch (node._tag) {
+				case "True":
+				case "False":
+					return R.succeed({ _tag: node._tag })
+				case "Compare":
+					return R.succeed({
+						_tag: "Compare",
+						op: node.op,
+						field: node.field,
+						value: operandJson(node.value),
+					})
+				case "In":
+					return R.succeed({
+						_tag: "In",
+						field: node.field,
+						values: Arr.map(node.values, operandJson),
+					})
+				case "Exists":
+					return R.succeed({ _tag: "Exists", field: node.field })
+				case "Under":
+					return R.succeed({
+						_tag: "Under",
+						prefix: Arr.map(node.prefix, operandJson),
+					})
+				case "And":
+				case "Or": {
+					const tag = node._tag
+					return R.map(
+						R.forEach(node.conditions, (child) => R.suspend(() => go(child))),
+						(conditions) => ({ _tag: tag, conditions }),
+					)
+				}
+				case "Not":
+					return R.map(
+						R.suspend(() => go(node.condition)),
+						(condition) => ({
+							_tag: "Not",
+							condition,
+						}),
+					)
+				case "Predicate":
+					throw new Error(
+						`The predicate "${node.name}" can not become JSON. A condition with a predicate has no JSON form.`,
+					)
 			}
-		case "Exists":
-			return { _tag: "Exists", field: node.field }
-		case "Under":
-			return { _tag: "Under", prefix: Arr.map(node.prefix, operandJson) }
-		case "And":
-		case "Or":
-			return { _tag: node._tag, conditions: Arr.map(node.conditions, toJson) }
-		case "Not":
-			return { _tag: "Not", condition: toJson(node.condition) }
-		case "Predicate":
-			throw new Error(
-				`The predicate "${node.name}" can not become JSON. A condition with a predicate has no JSON form.`,
-			)
-	}
-}
+		}
+		return go(root)
+	})
 
 /** Tests if a value is a node. Only a constructor of a node makes one. */
 export const isNode = (u: unknown): u is Node => u instanceof Base

package/src/internal/patterns.ts

@@ -14,6 +14,7 @@
  * number of names times the number of parts.
  */
 import * as Arr from "effect/Array"
+import * as Option from "effect/Option"
 import * as Result from "effect/Result"
 import * as Catalog from "./catalog.ts"
 import * as Limits from "./limits.ts"
@@ -39,13 +40,17 @@ const partOf = (text: string): Part =>
 
 /**
  * Reads a pattern. It fails with the problem when the pattern has `**`
- * inside a part, or has more parts than `patternParts`.
+ * inside a part, or has more parts than `parts`, the `patternParts` of a
+ * domain.
  */
-export const parse = (text: string): Result.Result<Pattern, string> => {
-	const texts = text.split(".", Limits.patternParts + 1)
-	if (texts.length > Limits.patternParts) {
+export const parse = (
+	text: string,
+	parts: number = Limits.patternParts,
+): Result.Result<Pattern, string> => {
+	const texts = text.split(".", parts + 1)
+	if (texts.length > parts) {
 		return Result.fail(
-			`The field pattern "${text}" has more than ${String(Limits.patternParts)} parts. The most is ${String(Limits.patternParts)}.`,
+			`The field pattern "${text}" has more than ${String(parts)} parts. The most is ${String(parts)}.`,
 		)
 	}
 	if (Arr.some(texts, (part) => part !== "**" && part.includes("**"))) {
@@ -63,11 +68,15 @@ export const parse = (text: string): Result.Result<Pattern, string> => {
 }
 
 /**
- * Reads a pattern of a bound rule. The binding of the rule took the pattern,
- * so a problem here is a defect.
+ * Reads a pattern of a bound rule. The binding of the rule took the pattern
+ * with the limits of its domain, so this reads it up to the ceiling, and a
+ * problem here is a defect.
  */
 export const parseBound = (text: string): Pattern =>
-	Result.getOrThrowWith(parse(text), (problem) => new Error(problem))
+	Result.getOrThrowWith(
+		parse(text, Limits.ceilings.patternParts),
+		(problem) => new Error(problem),
+	)
 
 /** Tests if a name matches the pieces of a part with stars. */
 const globMatches = (pieces: ReadonlyArray<string>, name: string): boolean => {
@@ -189,27 +198,64 @@ export const matchesBelow = (
 		(state) => state < pattern.length,
 	)
 
-/** Tests if a pattern matches some field of a catalog. */
+/**
+ * Tests if a pattern matches some field of a catalog, with at most `parts`
+ * parts. A recursive Schema has no end of fields, so the search goes over the
+ * pairs of a place of the catalog and the places of the match: each pair
+ * comes one time, a level after a level, so the search is short, and it
+ * keeps a queue, so a deep Schema does not fill the stack. The set of the
+ * pairs is native, with keys that are numbers, and the set and the queue
+ * belong to this call.
+ */
 export const fitsCatalog = (
 	pattern: Pattern,
 	catalog: Catalog.Catalog,
+	parts: number = Limits.fieldPathParts,
 ): boolean => {
-	const below = (branch: Catalog.Branch, states: States): boolean =>
-		states.length > 0 &&
-		(Arr.some(branch.children, ([name, child]) => visit(child, name, states)) ||
-			(branch.key !== undefined &&
-				branch.keyBranch !== undefined &&
-				visit(branch.keyBranch, branch.key, states)))
-	const visit = (
-		branch: Catalog.Branch,
-		segment: Catalog.Segment,
-		before: States,
-	): boolean => {
-		const states = step(pattern, before, segment)
-		return (
-			(branch.field !== undefined && isDone(pattern, states)) ||
-			below(branch, states)
-		)
+	interface Visit {
+		readonly branch: Catalog.Branch
+		readonly states: States
+		readonly depth: number
+	}
+	const seen = new Set<string>()
+	const next = (visit: Visit): ReadonlyArray<Visit> => {
+		if (visit.states.length === 0 || visit.depth === parts) {
+			return []
+		}
+		const steps: ReadonlyArray<readonly [Catalog.Segment, number]> = [
+			...visit.branch.children,
+			...(visit.branch.key === undefined || visit.branch.keyBranch === undefined
+				? []
+				: [[visit.branch.key, visit.branch.keyBranch] as const]),
+		]
+		return Arr.flatMap(steps, ([segment, id]) => {
+			const states = step(pattern, visit.states, segment)
+			const key = `${String(id)}|${states.join(",")}`
+			if (states.length === 0 || seen.has(key)) {
+				return []
+			}
+			seen.add(key)
+			return [{ branch: catalog.branches[id]!, states, depth: visit.depth + 1 }]
+		})
 	}
-	return below(catalog.root, start(pattern))
+	const queue: Array<Visit> = [
+		{ branch: catalog.root, states: start(pattern), depth: 0 },
+	]
+	// The walk stops at the first field that the pattern matches.
+	const found = (visit: Visit) =>
+		visit.depth > 0 && isDone(pattern, visit.states)
+	return Arr.some(
+		Arr.unfold(0, (index) => {
+			const visit = queue[index]
+			if (visit === undefined) {
+				return Option.none()
+			}
+			if (found(visit)) {
+				return Option.some([true, queue.length] as const)
+			}
+			queue.push(...next(visit))
+			return Option.some([false, index + 1] as const)
+		}),
+		(match) => match,
+	)
 }