UNPKG

veffect

Version:

powerful TypeScript validation library built on the robust foundation of Effect combining exceptional type safety, high performance, and developer experience. Taking inspiration from Effect's functional principles, VEffect delivers a balanced approach tha

870 lines 28 kB
import * as Chunk from "../Chunk.js"; import * as Either from "../Either.js"; import * as Equal from "../Equal.js"; import { constFalse, constTrue, dual, identity, pipe } from "../Function.js"; import * as Hash from "../Hash.js"; import * as HashSet from "../HashSet.js"; import { NodeInspectSymbol, toJSON } from "../Inspectable.js"; import * as Option from "../Option.js"; import { pipeArguments } from "../Pipeable.js"; import { hasProperty, isFunction } from "../Predicate.js"; import * as ReadonlyArray from "../ReadonlyArray.js"; import { getBugErrorMessage } from "./errors.js"; import * as OpCodes from "./opCodes/cause.js"; // ----------------------------------------------------------------------------- // Models // ----------------------------------------------------------------------------- /** @internal */ const CauseSymbolKey = "effect/Cause"; /** @internal */ export const CauseTypeId = /*#__PURE__*/Symbol.for(CauseSymbolKey); const variance = { /* c8 ignore next */ _E: _ => _ }; /** @internal */ const proto = { [CauseTypeId]: variance, [Hash.symbol]() { return pipe(Hash.hash(CauseSymbolKey), Hash.combine(Hash.hash(flattenCause(this))), Hash.cached(this)); }, [Equal.symbol](that) { return isCause(that) && causeEquals(this, that); }, pipe() { return pipeArguments(this, arguments); }, toJSON() { switch (this._tag) { case "Empty": return { _id: "Cause", _tag: this._tag }; case "Die": return { _id: "Cause", _tag: this._tag, defect: toJSON(this.defect) }; case "Interrupt": return { _id: "Cause", _tag: this._tag, fiberId: this.fiberId.toJSON() }; case "Fail": return { _id: "Cause", _tag: this._tag, failure: toJSON(this.error) }; case "Sequential": case "Parallel": return { _id: "Cause", _tag: this._tag, left: toJSON(this.left), right: toJSON(this.right) }; } }, toString() { return pretty(this); }, [NodeInspectSymbol]() { return this.toJSON(); } }; // ----------------------------------------------------------------------------- // Constructors // ----------------------------------------------------------------------------- /** @internal */ export const empty = /*#__PURE__*/(() => { const o = /*#__PURE__*/Object.create(proto); o._tag = OpCodes.OP_EMPTY; return o; })(); /** @internal */ export const fail = error => { const o = Object.create(proto); o._tag = OpCodes.OP_FAIL; o.error = error; return o; }; /** @internal */ export const die = defect => { const o = Object.create(proto); o._tag = OpCodes.OP_DIE; o.defect = defect; return o; }; /** @internal */ export const interrupt = fiberId => { const o = Object.create(proto); o._tag = OpCodes.OP_INTERRUPT; o.fiberId = fiberId; return o; }; /** @internal */ export const parallel = (left, right) => { const o = Object.create(proto); o._tag = OpCodes.OP_PARALLEL; o.left = left; o.right = right; return o; }; /** @internal */ export const sequential = (left, right) => { const o = Object.create(proto); o._tag = OpCodes.OP_SEQUENTIAL; o.left = left; o.right = right; return o; }; // ----------------------------------------------------------------------------- // Refinements // ----------------------------------------------------------------------------- /** @internal */ export const isCause = u => hasProperty(u, CauseTypeId); /** @internal */ export const isEmptyType = self => self._tag === OpCodes.OP_EMPTY; /** @internal */ export const isFailType = self => self._tag === OpCodes.OP_FAIL; /** @internal */ export const isDieType = self => self._tag === OpCodes.OP_DIE; /** @internal */ export const isInterruptType = self => self._tag === OpCodes.OP_INTERRUPT; /** @internal */ export const isSequentialType = self => self._tag === OpCodes.OP_SEQUENTIAL; /** @internal */ export const isParallelType = self => self._tag === OpCodes.OP_PARALLEL; // ----------------------------------------------------------------------------- // Getters // ----------------------------------------------------------------------------- /** @internal */ export const size = self => reduceWithContext(self, void 0, SizeCauseReducer); /** @internal */ export const isEmpty = self => { if (self._tag === OpCodes.OP_EMPTY) { return true; } return reduce(self, true, (acc, cause) => { switch (cause._tag) { case OpCodes.OP_EMPTY: { return Option.some(acc); } case OpCodes.OP_DIE: case OpCodes.OP_FAIL: case OpCodes.OP_INTERRUPT: { return Option.some(false); } default: { return Option.none(); } } }); }; /** @internal */ export const isFailure = self => Option.isSome(failureOption(self)); /** @internal */ export const isDie = self => Option.isSome(dieOption(self)); /** @internal */ export const isInterrupted = self => Option.isSome(interruptOption(self)); /** @internal */ export const isInterruptedOnly = self => reduceWithContext(undefined, IsInterruptedOnlyCauseReducer)(self); /** @internal */ export const failures = self => Chunk.reverse(reduce(self, Chunk.empty(), (list, cause) => cause._tag === OpCodes.OP_FAIL ? Option.some(pipe(list, Chunk.prepend(cause.error))) : Option.none())); /** @internal */ export const defects = self => Chunk.reverse(reduce(self, Chunk.empty(), (list, cause) => cause._tag === OpCodes.OP_DIE ? Option.some(pipe(list, Chunk.prepend(cause.defect))) : Option.none())); /** @internal */ export const interruptors = self => reduce(self, HashSet.empty(), (set, cause) => cause._tag === OpCodes.OP_INTERRUPT ? Option.some(pipe(set, HashSet.add(cause.fiberId))) : Option.none()); /** @internal */ export const failureOption = self => find(self, cause => cause._tag === OpCodes.OP_FAIL ? Option.some(cause.error) : Option.none()); /** @internal */ export const failureOrCause = self => { const option = failureOption(self); switch (option._tag) { case "None": { // no `E` inside this `Cause`, so it can be safely cast to `never` return Either.right(self); } case "Some": { return Either.left(option.value); } } }; /** @internal */ export const dieOption = self => find(self, cause => cause._tag === OpCodes.OP_DIE ? Option.some(cause.defect) : Option.none()); /** @internal */ export const flipCauseOption = self => match(self, { onEmpty: Option.some(empty), onFail: failureOption => pipe(failureOption, Option.map(fail)), onDie: defect => Option.some(die(defect)), onInterrupt: fiberId => Option.some(interrupt(fiberId)), onSequential: (left, right) => { if (Option.isSome(left) && Option.isSome(right)) { return Option.some(sequential(left.value, right.value)); } if (Option.isNone(left) && Option.isSome(right)) { return Option.some(right.value); } if (Option.isSome(left) && Option.isNone(right)) { return Option.some(left.value); } return Option.none(); }, onParallel: (left, right) => { if (Option.isSome(left) && Option.isSome(right)) { return Option.some(parallel(left.value, right.value)); } if (Option.isNone(left) && Option.isSome(right)) { return Option.some(right.value); } if (Option.isSome(left) && Option.isNone(right)) { return Option.some(left.value); } return Option.none(); } }); /** @internal */ export const interruptOption = self => find(self, cause => cause._tag === OpCodes.OP_INTERRUPT ? Option.some(cause.fiberId) : Option.none()); /** @internal */ export const keepDefects = self => match(self, { onEmpty: Option.none(), onFail: () => Option.none(), onDie: defect => Option.some(die(defect)), onInterrupt: () => Option.none(), onSequential: (left, right) => { if (Option.isSome(left) && Option.isSome(right)) { return Option.some(sequential(left.value, right.value)); } if (Option.isSome(left) && Option.isNone(right)) { return Option.some(left.value); } if (Option.isNone(left) && Option.isSome(right)) { return Option.some(right.value); } return Option.none(); }, onParallel: (left, right) => { if (Option.isSome(left) && Option.isSome(right)) { return Option.some(parallel(left.value, right.value)); } if (Option.isSome(left) && Option.isNone(right)) { return Option.some(left.value); } if (Option.isNone(left) && Option.isSome(right)) { return Option.some(right.value); } return Option.none(); } }); /** @internal */ export const keepDefectsAndElectFailures = self => match(self, { onEmpty: Option.none(), onFail: failure => Option.some(die(failure)), onDie: defect => Option.some(die(defect)), onInterrupt: () => Option.none(), onSequential: (left, right) => { if (Option.isSome(left) && Option.isSome(right)) { return Option.some(sequential(left.value, right.value)); } if (Option.isSome(left) && Option.isNone(right)) { return Option.some(left.value); } if (Option.isNone(left) && Option.isSome(right)) { return Option.some(right.value); } return Option.none(); }, onParallel: (left, right) => { if (Option.isSome(left) && Option.isSome(right)) { return Option.some(parallel(left.value, right.value)); } if (Option.isSome(left) && Option.isNone(right)) { return Option.some(left.value); } if (Option.isNone(left) && Option.isSome(right)) { return Option.some(right.value); } return Option.none(); } }); /** @internal */ export const linearize = self => match(self, { onEmpty: HashSet.empty(), onFail: error => HashSet.make(fail(error)), onDie: defect => HashSet.make(die(defect)), onInterrupt: fiberId => HashSet.make(interrupt(fiberId)), onSequential: (leftSet, rightSet) => pipe(leftSet, HashSet.flatMap(leftCause => pipe(rightSet, HashSet.map(rightCause => sequential(leftCause, rightCause))))), onParallel: (leftSet, rightSet) => pipe(leftSet, HashSet.flatMap(leftCause => pipe(rightSet, HashSet.map(rightCause => parallel(leftCause, rightCause))))) }); /** @internal */ export const stripFailures = self => match(self, { onEmpty: empty, onFail: () => empty, onDie: defect => die(defect), onInterrupt: fiberId => interrupt(fiberId), onSequential: sequential, onParallel: parallel }); /** @internal */ export const electFailures = self => match(self, { onEmpty: empty, onFail: failure => die(failure), onDie: defect => die(defect), onInterrupt: fiberId => interrupt(fiberId), onSequential: (left, right) => sequential(left, right), onParallel: (left, right) => parallel(left, right) }); /** @internal */ export const stripSomeDefects = /*#__PURE__*/dual(2, (self, pf) => match(self, { onEmpty: Option.some(empty), onFail: error => Option.some(fail(error)), onDie: defect => { const option = pf(defect); return Option.isSome(option) ? Option.none() : Option.some(die(defect)); }, onInterrupt: fiberId => Option.some(interrupt(fiberId)), onSequential: (left, right) => { if (Option.isSome(left) && Option.isSome(right)) { return Option.some(sequential(left.value, right.value)); } if (Option.isSome(left) && Option.isNone(right)) { return Option.some(left.value); } if (Option.isNone(left) && Option.isSome(right)) { return Option.some(right.value); } return Option.none(); }, onParallel: (left, right) => { if (Option.isSome(left) && Option.isSome(right)) { return Option.some(parallel(left.value, right.value)); } if (Option.isSome(left) && Option.isNone(right)) { return Option.some(left.value); } if (Option.isNone(left) && Option.isSome(right)) { return Option.some(right.value); } return Option.none(); } })); // ----------------------------------------------------------------------------- // Mapping // ----------------------------------------------------------------------------- /** @internal */ export const as = /*#__PURE__*/dual(2, (self, error) => map(self, () => error)); /** @internal */ export const map = /*#__PURE__*/dual(2, (self, f) => flatMap(self, e => fail(f(e)))); // ----------------------------------------------------------------------------- // Sequencing // ----------------------------------------------------------------------------- /** @internal */ export const flatMap = /*#__PURE__*/dual(2, (self, f) => match(self, { onEmpty: empty, onFail: error => f(error), onDie: defect => die(defect), onInterrupt: fiberId => interrupt(fiberId), onSequential: (left, right) => sequential(left, right), onParallel: (left, right) => parallel(left, right) })); /** @internal */ export const flatten = self => flatMap(self, identity); /** @internal */ export const andThen = /*#__PURE__*/dual(2, (self, f) => isFunction(f) ? flatMap(self, f) : flatMap(self, () => f)); // ----------------------------------------------------------------------------- // Equality // ----------------------------------------------------------------------------- /** @internal */ export const contains = /*#__PURE__*/dual(2, (self, that) => { if (that._tag === OpCodes.OP_EMPTY || self === that) { return true; } return reduce(self, false, (accumulator, cause) => { return Option.some(accumulator || causeEquals(cause, that)); }); }); /** @internal */ const causeEquals = (left, right) => { let leftStack = Chunk.of(left); let rightStack = Chunk.of(right); while (Chunk.isNonEmpty(leftStack) && Chunk.isNonEmpty(rightStack)) { const [leftParallel, leftSequential] = pipe(Chunk.headNonEmpty(leftStack), reduce([HashSet.empty(), Chunk.empty()], ([parallel, sequential], cause) => { const [par, seq] = evaluateCause(cause); return Option.some([pipe(parallel, HashSet.union(par)), pipe(sequential, Chunk.appendAll(seq))]); })); const [rightParallel, rightSequential] = pipe(Chunk.headNonEmpty(rightStack), reduce([HashSet.empty(), Chunk.empty()], ([parallel, sequential], cause) => { const [par, seq] = evaluateCause(cause); return Option.some([pipe(parallel, HashSet.union(par)), pipe(sequential, Chunk.appendAll(seq))]); })); if (!Equal.equals(leftParallel, rightParallel)) { return false; } leftStack = leftSequential; rightStack = rightSequential; } return true; }; // ----------------------------------------------------------------------------- // Flattening // ----------------------------------------------------------------------------- /** * Flattens a cause to a sequence of sets of causes, where each set represents * causes that fail in parallel and sequential sets represent causes that fail * after each other. * * @internal */ const flattenCause = cause => { return flattenCauseLoop(Chunk.of(cause), Chunk.empty()); }; /** @internal */ const flattenCauseLoop = (causes, flattened) => { // eslint-disable-next-line no-constant-condition while (1) { const [parallel, sequential] = pipe(causes, ReadonlyArray.reduce([HashSet.empty(), Chunk.empty()], ([parallel, sequential], cause) => { const [par, seq] = evaluateCause(cause); return [pipe(parallel, HashSet.union(par)), pipe(sequential, Chunk.appendAll(seq))]; })); const updated = HashSet.size(parallel) > 0 ? pipe(flattened, Chunk.prepend(parallel)) : flattened; if (Chunk.isEmpty(sequential)) { return Chunk.reverse(updated); } causes = sequential; flattened = updated; } throw new Error(getBugErrorMessage("Cause.flattenCauseLoop")); }; // ----------------------------------------------------------------------------- // Finding // ----------------------------------------------------------------------------- /** @internal */ export const find = /*#__PURE__*/dual(2, (self, pf) => { const stack = [self]; while (stack.length > 0) { const item = stack.pop(); const option = pf(item); switch (option._tag) { case "None": { switch (item._tag) { case OpCodes.OP_SEQUENTIAL: case OpCodes.OP_PARALLEL: { stack.push(item.right); stack.push(item.left); break; } } break; } case "Some": { return option; } } } return Option.none(); }); // ----------------------------------------------------------------------------- // Filtering // ----------------------------------------------------------------------------- /** @internal */ export const filter = /*#__PURE__*/dual(2, (self, predicate) => reduceWithContext(self, void 0, FilterCauseReducer(predicate))); // ----------------------------------------------------------------------------- // Evaluation // ----------------------------------------------------------------------------- /** * Takes one step in evaluating a cause, returning a set of causes that fail * in parallel and a list of causes that fail sequentially after those causes. * * @internal */ const evaluateCause = self => { let cause = self; const stack = []; let _parallel = HashSet.empty(); let _sequential = Chunk.empty(); while (cause !== undefined) { switch (cause._tag) { case OpCodes.OP_EMPTY: { if (stack.length === 0) { return [_parallel, _sequential]; } cause = stack.pop(); break; } case OpCodes.OP_FAIL: { _parallel = HashSet.add(_parallel, cause.error); if (stack.length === 0) { return [_parallel, _sequential]; } cause = stack.pop(); break; } case OpCodes.OP_DIE: { _parallel = HashSet.add(_parallel, cause.defect); if (stack.length === 0) { return [_parallel, _sequential]; } cause = stack.pop(); break; } case OpCodes.OP_INTERRUPT: { _parallel = HashSet.add(_parallel, cause.fiberId); if (stack.length === 0) { return [_parallel, _sequential]; } cause = stack.pop(); break; } case OpCodes.OP_SEQUENTIAL: { switch (cause.left._tag) { case OpCodes.OP_EMPTY: { cause = cause.right; break; } case OpCodes.OP_SEQUENTIAL: { cause = sequential(cause.left.left, sequential(cause.left.right, cause.right)); break; } case OpCodes.OP_PARALLEL: { cause = parallel(sequential(cause.left.left, cause.right), sequential(cause.left.right, cause.right)); break; } default: { _sequential = Chunk.prepend(_sequential, cause.right); cause = cause.left; break; } } break; } case OpCodes.OP_PARALLEL: { stack.push(cause.right); cause = cause.left; break; } } } throw new Error(getBugErrorMessage("Cause.evaluateCauseLoop")); }; // ----------------------------------------------------------------------------- // Reducing // ----------------------------------------------------------------------------- /** @internal */ const SizeCauseReducer = { emptyCase: () => 0, failCase: () => 1, dieCase: () => 1, interruptCase: () => 1, sequentialCase: (_, left, right) => left + right, parallelCase: (_, left, right) => left + right }; /** @internal */ const IsInterruptedOnlyCauseReducer = { emptyCase: constTrue, failCase: constFalse, dieCase: constFalse, interruptCase: constTrue, sequentialCase: (_, left, right) => left && right, parallelCase: (_, left, right) => left && right }; /** @internal */ const FilterCauseReducer = predicate => ({ emptyCase: () => empty, failCase: (_, error) => fail(error), dieCase: (_, defect) => die(defect), interruptCase: (_, fiberId) => interrupt(fiberId), sequentialCase: (_, left, right) => { if (predicate(left)) { if (predicate(right)) { return sequential(left, right); } return left; } if (predicate(right)) { return right; } return empty; }, parallelCase: (_, left, right) => { if (predicate(left)) { if (predicate(right)) { return parallel(left, right); } return left; } if (predicate(right)) { return right; } return empty; } }); const OP_SEQUENTIAL_CASE = "SequentialCase"; const OP_PARALLEL_CASE = "ParallelCase"; /** @internal */ export const match = /*#__PURE__*/dual(2, (self, { onDie, onEmpty, onFail, onInterrupt, onParallel, onSequential }) => { return reduceWithContext(self, void 0, { emptyCase: () => onEmpty, failCase: (_, error) => onFail(error), dieCase: (_, defect) => onDie(defect), interruptCase: (_, fiberId) => onInterrupt(fiberId), sequentialCase: (_, left, right) => onSequential(left, right), parallelCase: (_, left, right) => onParallel(left, right) }); }); /** @internal */ export const reduce = /*#__PURE__*/dual(3, (self, zero, pf) => { let accumulator = zero; let cause = self; const causes = []; while (cause !== undefined) { const option = pf(accumulator, cause); accumulator = Option.isSome(option) ? option.value : accumulator; switch (cause._tag) { case OpCodes.OP_SEQUENTIAL: { causes.push(cause.right); cause = cause.left; break; } case OpCodes.OP_PARALLEL: { causes.push(cause.right); cause = cause.left; break; } default: { cause = undefined; break; } } if (cause === undefined && causes.length > 0) { cause = causes.pop(); } } return accumulator; }); /** @internal */ export const reduceWithContext = /*#__PURE__*/dual(3, (self, context, reducer) => { const input = [self]; const output = []; while (input.length > 0) { const cause = input.pop(); switch (cause._tag) { case OpCodes.OP_EMPTY: { output.push(Either.right(reducer.emptyCase(context))); break; } case OpCodes.OP_FAIL: { output.push(Either.right(reducer.failCase(context, cause.error))); break; } case OpCodes.OP_DIE: { output.push(Either.right(reducer.dieCase(context, cause.defect))); break; } case OpCodes.OP_INTERRUPT: { output.push(Either.right(reducer.interruptCase(context, cause.fiberId))); break; } case OpCodes.OP_SEQUENTIAL: { input.push(cause.right); input.push(cause.left); output.push(Either.left({ _tag: OP_SEQUENTIAL_CASE })); break; } case OpCodes.OP_PARALLEL: { input.push(cause.right); input.push(cause.left); output.push(Either.left({ _tag: OP_PARALLEL_CASE })); break; } } } const accumulator = []; while (output.length > 0) { const either = output.pop(); switch (either._tag) { case "Left": { switch (either.left._tag) { case OP_SEQUENTIAL_CASE: { const left = accumulator.pop(); const right = accumulator.pop(); const value = reducer.sequentialCase(context, left, right); accumulator.push(value); break; } case OP_PARALLEL_CASE: { const left = accumulator.pop(); const right = accumulator.pop(); const value = reducer.parallelCase(context, left, right); accumulator.push(value); break; } } break; } case "Right": { accumulator.push(either.right); break; } } } if (accumulator.length === 0) { throw new Error("BUG: Cause.reduceWithContext - please report an issue at https://github.com/Effect-TS/effect/issues"); } return accumulator.pop(); }); // ----------------------------------------------------------------------------- // Pretty Printing // ----------------------------------------------------------------------------- const filterStack = stack => { const lines = stack.split("\n"); const out = []; for (let i = 0; i < lines.length; i++) { out.push(lines[i].replace(/at .*effect_instruction_i.*\((.*)\)/, "at $1")); if (lines[i].includes("effect_instruction_i")) { return out.join("\n"); } } return out.join("\n"); }; /** @internal */ export const pretty = cause => { if (isInterruptedOnly(cause)) { return "All fibers interrupted without errors."; } const final = prettyErrors(cause).map(e => { let message = e.message; if (e.stack) { message += `\r\n${filterStack(e.stack)}`; } if (e.span) { let current = e.span; let i = 0; while (current && current._tag === "Span" && i < 10) { message += `\r\n at ${current.name}`; current = Option.getOrUndefined(current.parent); i++; } } return message; }).join("\r\n"); return final; }; class PrettyError { message; stack; span; constructor(message, stack, span) { this.message = message; this.stack = stack; this.span = span; } toJSON() { const out = { message: this.message }; if (this.stack) { out.stack = this.stack; } if (this.span) { out.span = this.span; } return out; } } /** * A utility function for generating human-readable error messages from a generic error of type `unknown`. * * Rules: * * 1) If the input `u` is already a string, it's considered a message, and "Error" is added as a prefix. * 2) If `u` has a user-defined `toString()` method, it uses that method and adds "Error" as a prefix. * 3) If `u` is an object and its only (optional) properties are "name", "message", or "_tag", it constructs * an error message based on those properties. * 4) Otherwise, it uses `JSON.stringify` to produce a string representation and uses it as the error message, * with "Error" added as a prefix. * * @internal */ export const prettyErrorMessage = u => { // 1) if (typeof u === "string") { return `Error: ${u}`; } // 2) try { if (hasProperty(u, "toString") && isFunction(u["toString"]) && u["toString"] !== Object.prototype.toString && u["toString"] !== Array.prototype.toString) { return u["toString"](); } } catch { // something's off, rollback to json } // 3) return `Error: ${JSON.stringify(u)}`; }; const spanSymbol = /*#__PURE__*/Symbol.for("effect/SpanAnnotation"); const defaultRenderError = error => { const span = hasProperty(error, spanSymbol) && error[spanSymbol]; if (error instanceof Error) { return new PrettyError(prettyErrorMessage(error), error.stack?.split("\n").filter(_ => _.match(/at (.*)/)).join("\n"), span); } return new PrettyError(prettyErrorMessage(error), void 0, span); }; /** @internal */ export const prettyErrors = cause => reduceWithContext(cause, void 0, { emptyCase: () => [], dieCase: (_, unknownError) => { return [defaultRenderError(unknownError)]; }, failCase: (_, error) => { return [defaultRenderError(error)]; }, interruptCase: () => [], parallelCase: (_, l, r) => [...l, ...r], sequentialCase: (_, l, r) => [...l, ...r] }); //# sourceMappingURL=cause.js.map