effect 3.12.4 → 3.12.5

package/src/Arbitrary.ts

@@ -4,6 +4,7 @@
 
 import * as Arr from "./Array.js"
 import * as FastCheck from "./FastCheck.js"
+import { globalValue } from "./GlobalValue.js"
 import * as errors_ from "./internal/schema/errors.js"
 import * as schemaId_ from "./internal/schema/schemaId.js"
 import * as util_ from "./internal/schema/util.js"
@@ -276,6 +277,11 @@ const makeArrayConfig = (options: {
 
 type Config = StringConstraints | NumberConstraints | BigIntConstraints | DateConstraints | ArrayConfig
 
+const arbitraryMemoMap = globalValue(
+  Symbol.for("effect/Arbitrary/arbitraryMemoMap"),
+  () => new WeakMap<AST.AST, LazyArbitrary<any>>()
+)
+
 const go = (
   ast: AST.AST,
   ctx: ArbitraryGenerationContext,
@@ -311,6 +317,7 @@ const go = (
 const constStringConstraints = makeStringConstraints({})
 const constNumberConstraints = makeNumberConstraints({})
 const constBigIntConstraints = makeBigIntConstraints({})
+const defaultSuspendedArrayConstraints: FastCheck.ArrayConstraints = { maxLength: 2 }
 
 /** @internal */
 export const toOp = (
@@ -439,8 +446,22 @@ export const toOp = (
           const value = indexSignatures[i][1](fc)
           output = output.chain((o) => {
             const item = fc.tuple(key, value)
+            /*
+
+              `getSuspendedArray` is used to generate less key/value pairs in
+              the context of a recursive schema. Without it, the following schema
+              would generate an big amount of values possibly leading to a stack
+              overflow:
+
+              ```ts
+              type A = { [_: string]: A }
+
+              const schema = S.Record({ key: S.String, value: S.suspend((): S.Schema<A> => schema) })
+              ```
+
+            */
             const arr = ctx.depthIdentifier !== undefined ?
-              getSuspendedArray(fc, ctx.depthIdentifier, ctx.maxDepth, item) :
+              getSuspendedArray(fc, ctx.depthIdentifier, ctx.maxDepth, item, defaultSuspendedArrayConstraints) :
               fc.array(item)
             return arr.map((tuples) => ({ ...Object.fromEntries(tuples), ...o }))
           })
@@ -454,16 +475,39 @@ export const toOp = (
       return new Succeed((fc) => fc.oneof(...types.map((arb) => arb(fc))))
     }
     case "Suspend": {
+      const memo = arbitraryMemoMap.get(ast)
+      if (memo) {
+        return new Succeed(memo)
+      }
       const get = util_.memoizeThunk(() => {
         return go(ast.f(), getSuspendedContext(ctx, ast), path)
       })
-      return new Succeed((fc) => fc.constant(null).chain(() => get()(fc)))
+      const out: LazyArbitrary<any> = (fc) => fc.constant(null).chain(() => get()(fc))
+      arbitraryMemoMap.set(ast, out)
+      return new Succeed(out)
     }
     case "Transformation":
       return toOp(ast.to, ctx, path)
   }
 }
 
+function subtractElementsLength(
+  constraints: FastCheck.ArrayConstraints,
+  elementsLength: number
+): FastCheck.ArrayConstraints {
+  if (elementsLength === 0 || (constraints.minLength === undefined && constraints.maxLength === undefined)) {
+    return constraints
+  }
+  const out = { ...constraints }
+  if (out.minLength !== undefined) {
+    out.minLength = Math.max(out.minLength - elementsLength, 0)
+  }
+  if (out.maxLength !== undefined) {
+    out.maxLength = Math.max(out.maxLength - elementsLength, 0)
+  }
+  return out
+}
+
 const goTupleType = (
   ast: AST.TupleType,
   ctx: ArbitraryGenerationContext,
@@ -508,9 +552,36 @@ const goTupleType = (
       const [head, ...tail] = rest
       const item = head(fc)
       output = output.chain((as) => {
-        return (ctx.depthIdentifier !== undefined
-          ? getSuspendedArray(fc, ctx.depthIdentifier, ctx.maxDepth, item, constraints)
-          : fc.array(item, constraints)).map((rest) => [...as, ...rest])
+        const len = as.length
+        // We must adjust the constraints for the rest element
+        // because the elements might have generated some values
+        const restArrayConstraints = subtractElementsLength(constraints, len)
+        if (restArrayConstraints.maxLength === 0) {
+          return fc.constant(as)
+        }
+        /*
+
+          `getSuspendedArray` is used to generate less values in
+          the context of a recursive schema. Without it, the following schema
+          would generate an big amount of values possibly leading to a stack
+          overflow:
+
+          ```ts
+          type A = ReadonlyArray<A | null>
+
+          const schema = S.Array(
+            S.NullOr(S.suspend((): S.Schema<A> => schema))
+          )
+          ```
+
+        */
+        const arr = ctx.depthIdentifier !== undefined
+          ? getSuspendedArray(fc, ctx.depthIdentifier, ctx.maxDepth, item, restArrayConstraints)
+          : fc.array(item, restArrayConstraints)
+        if (len === 0) {
+          return arr
+        }
+        return arr.map((rest) => [...as, ...rest])
       })
       // ---------------------------------------------
       // handle post rest elements
@@ -660,20 +731,19 @@ const getSuspendedArray = (
   depthIdentifier: string,
   maxDepth: number,
   item: FastCheck.Arbitrary<any>,
-  constraints?: FastCheck.ArrayConstraints
+  constraints: FastCheck.ArrayConstraints
 ) => {
-  let minLength = 1
-  let maxLength = 2
-  if (constraints && constraints.minLength !== undefined && constraints.minLength > minLength) {
-    minLength = constraints.minLength
-    if (minLength > maxLength) {
-      maxLength = minLength
-    }
+  // In the context of a recursive schema, we don't want a `maxLength` greater than 2.
+  // The only exception is when `minLength` is also set, in which case we set
+  // `maxLength` to the minimum value, which is `minLength`.
+  const maxLengthLimit = Math.max(2, constraints.minLength ?? 0)
+  if (constraints.maxLength !== undefined && constraints.maxLength > maxLengthLimit) {
+    constraints = { ...constraints, maxLength: maxLengthLimit }
   }
   return fc.oneof(
     { maxDepth, depthIdentifier },
     fc.constant([]),
-    fc.array(item, { minLength, maxLength })
+    fc.array(item, constraints)
   )
 }
 

package/src/Inspectable.ts

@@ -1,7 +1,6 @@
 /**
  * @since 2.0.0
  */
-
 import type * as FiberRefs from "./FiberRefs.js"
 import { globalValue } from "./GlobalValue.js"
 import { hasProperty, isFunction } from "./Predicate.js"

package/src/ParseResult.ts

@@ -809,11 +809,11 @@ interface Parser {
 }
 
 const decodeMemoMap = globalValue(
-  Symbol.for("effect/Schema/Parser/decodeMemoMap"),
+  Symbol.for("effect/ParseResult/decodeMemoMap"),
   () => new WeakMap<AST.AST, Parser>()
 )
 const encodeMemoMap = globalValue(
-  Symbol.for("effect/Schema/Parser/encodeMemoMap"),
+  Symbol.for("effect/ParseResult/encodeMemoMap"),
   () => new WeakMap<AST.AST, Parser>()
 )
 
@@ -1983,12 +1983,25 @@ const formatTree = (
 }
 
 /**
+ * Represents an issue returned by the {@link ArrayFormatter} formatter.
+ *
  * @category model
  * @since 3.10.0
  */
 export interface ArrayFormatterIssue {
+  /**
+   * The tag identifying the type of parse issue.
+   */
   readonly _tag: ParseIssue["_tag"]
+
+  /**
+   * The path to the property where the issue occurred.
+   */
   readonly path: ReadonlyArray<PropertyKey>
+
+  /**
+   * A descriptive message explaining the issue.
+   */
   readonly message: string
 }