effect 2.0.0-next.9 → 2.0.0

package/src/TestServices.ts

@@ -0,0 +1,392 @@
+/**
+ * @since 2.0.0
+ */
+import * as Context from "./Context.js"
+import type * as DefaultServices from "./DefaultServices.js"
+import * as Effect from "./Effect.js"
+import type * as Fiber from "./Fiber.js"
+import type * as FiberRef from "./FiberRef.js"
+import { dual, pipe } from "./Function.js"
+import * as core from "./internal/core.js"
+import * as defaultServices from "./internal/defaultServices.js"
+import * as fiberRuntime from "./internal/fiberRuntime.js"
+import * as layer from "./internal/layer.js"
+import * as ref from "./internal/ref.js"
+import type * as Layer from "./Layer.js"
+import type * as Scope from "./Scope.js"
+import type * as SortedSet from "./SortedSet.js"
+import type * as TestAnnotation from "./TestAnnotation.js"
+import * as TestAnnotationMap from "./TestAnnotationMap.js"
+import * as Annotations from "./TestAnnotations.js"
+import * as TestConfig from "./TestConfig.js"
+import * as Live from "./TestLive.js"
+import * as Sized from "./TestSized.js"
+
+/**
+ * @since 2.0.0
+ */
+export type TestServices =
+  | Annotations.TestAnnotations
+  | Live.TestLive
+  | Sized.TestSized
+  | TestConfig.TestConfig
+
+/**
+ * The default Effect test services.
+ *
+ * @since 2.0.0
+ */
+export const liveServices: Context.Context<TestServices> = pipe(
+  Context.make(Annotations.TestAnnotations, Annotations.make(ref.unsafeMake(TestAnnotationMap.empty()))),
+  Context.add(Live.TestLive, Live.make(defaultServices.liveServices)),
+  Context.add(Sized.TestSized, Sized.make(100)),
+  Context.add(TestConfig.TestConfig, TestConfig.make({ repeats: 100, retries: 100, samples: 200, shrinks: 1000 }))
+)
+
+/**
+ * @since 2.0.0
+ */
+export const currentServices: FiberRef.FiberRef<Context.Context<TestServices>> = core.fiberRefUnsafeMakeContext(
+  liveServices
+)
+
+/**
+ * Retrieves the `Annotations` service for this test.
+ *
+ * @since 2.0.0
+ */
+export const annotations = (): Effect.Effect<never, never, Annotations.TestAnnotations> => annotationsWith(core.succeed)
+
+/**
+ * Retrieves the `Annotations` service for this test and uses it to run the
+ * specified workflow.
+ *
+ * @since 2.0.0
+ */
+export const annotationsWith = <R, E, A>(
+  f: (annotations: Annotations.TestAnnotations) => Effect.Effect<R, E, A>
+): Effect.Effect<R, E, A> =>
+  core.fiberRefGetWith(
+    currentServices,
+    (services) => f(Context.get(services, Annotations.TestAnnotations))
+  )
+
+/**
+ * Executes the specified workflow with the specified implementation of the
+ * annotations service.
+ *
+ * @since 2.0.0
+ */
+export const withAnnotations = dual<
+  (annotations: Annotations.TestAnnotations) => <R, E, A>(effect: Effect.Effect<R, E, A>) => Effect.Effect<R, E, A>,
+  <R, E, A>(effect: Effect.Effect<R, E, A>, annotations: Annotations.TestAnnotations) => Effect.Effect<R, E, A>
+>(2, (effect, annotations) =>
+  core.fiberRefLocallyWith(
+    currentServices,
+    Context.add(Annotations.TestAnnotations, annotations)
+  )(effect))
+
+/**
+ * Sets the implementation of the annotations service to the specified value
+ * and restores it to its original value when the scope is closed.
+ *
+ * @since 2.0.0
+ */
+export const withAnnotationsScoped = (
+  annotations: Annotations.TestAnnotations
+): Effect.Effect<Scope.Scope, never, void> =>
+  fiberRuntime.fiberRefLocallyScopedWith(
+    currentServices,
+    Context.add(Annotations.TestAnnotations, annotations)
+  )
+
+/**
+ * Constructs a new `Annotations` service wrapped in a layer.
+ *
+ * @since 2.0.0
+ */
+export const annotationsLayer = (): Layer.Layer<never, never, Annotations.TestAnnotations> =>
+  layer.scoped(
+    Annotations.TestAnnotations,
+    pipe(
+      core.sync(() => ref.unsafeMake(TestAnnotationMap.empty())),
+      core.map(Annotations.make),
+      core.tap(withAnnotationsScoped)
+    )
+  )
+
+/**
+ * Accesses an `Annotations` instance in the context and retrieves the
+ * annotation of the specified type, or its default value if there is none.
+ *
+ * @since 2.0.0
+ */
+export const get = <A>(key: TestAnnotation.TestAnnotation<A>): Effect.Effect<never, never, A> =>
+  annotationsWith((annotations) => annotations.get(key))
+
+/**
+ * Accesses an `Annotations` instance in the context and appends the
+ * specified annotation to the annotation map.
+ *
+ * @since 2.0.0
+ */
+export const annotate = <A>(key: TestAnnotation.TestAnnotation<A>, value: A): Effect.Effect<never, never, void> =>
+  annotationsWith((annotations) => annotations.annotate(key, value))
+
+/**
+ * Returns the set of all fibers in this test.
+ *
+ * @since 2.0.0
+ */
+export const supervisedFibers = (): Effect.Effect<
+  never,
+  never,
+  SortedSet.SortedSet<Fiber.RuntimeFiber<unknown, unknown>>
+> => annotationsWith((annotations) => annotations.supervisedFibers)
+
+/**
+ * Retrieves the `Live` service for this test and uses it to run the specified
+ * workflow.
+ *
+ * @since 2.0.0
+ */
+export const liveWith = <R, E, A>(f: (live: Live.TestLive) => Effect.Effect<R, E, A>): Effect.Effect<R, E, A> =>
+  core.fiberRefGetWith(currentServices, (services) => f(Context.get(services, Live.TestLive)))
+
+/**
+ * Retrieves the `Live` service for this test.
+ *
+ * @since 2.0.0
+ */
+export const live: Effect.Effect<never, never, Live.TestLive> = liveWith(core.succeed)
+
+/**
+ * Executes the specified workflow with the specified implementation of the
+ * live service.
+ *
+ * @since 2.0.0
+ */
+export const withLive = dual<
+  (live: Live.TestLive) => <R, E, A>(effect: Effect.Effect<R, E, A>) => Effect.Effect<R, E, A>,
+  <R, E, A>(effect: Effect.Effect<R, E, A>, live: Live.TestLive) => Effect.Effect<R, E, A>
+>(2, (effect, live) =>
+  core.fiberRefLocallyWith(
+    currentServices,
+    Context.add(Live.TestLive, live)
+  )(effect))
+
+/**
+ * Sets the implementation of the live service to the specified value and
+ * restores it to its original value when the scope is closed.
+ *
+ * @since 2.0.0
+ */
+export const withLiveScoped = (live: Live.TestLive): Effect.Effect<Scope.Scope, never, void> =>
+  fiberRuntime.fiberRefLocallyScopedWith(currentServices, Context.add(Live.TestLive, live))
+
+/**
+ * Constructs a new `Live` service wrapped in a layer.
+ *
+ * @since 2.0.0
+ */
+export const liveLayer = (): Layer.Layer<DefaultServices.DefaultServices, never, Live.TestLive> =>
+  layer.scoped(
+    Live.TestLive,
+    pipe(
+      core.context<DefaultServices.DefaultServices>(),
+      core.map(Live.make),
+      core.tap(withLiveScoped)
+    )
+  )
+
+/**
+ * Provides a workflow with the "live" default Effect services.
+ *
+ * @since 2.0.0
+ */
+export const provideLive = <R, E, A>(effect: Effect.Effect<R, E, A>): Effect.Effect<R, E, A> =>
+  liveWith((live) => live.provide(effect))
+
+/**
+ * Runs a transformation function with the live default Effect services while
+ * ensuring that the workflow itself is run with the test services.
+ *
+ * @since 2.0.0
+ */
+export const provideWithLive = dual<
+  <R, E, A, R2, E2, A2>(
+    f: (effect: Effect.Effect<R, E, A>) => Effect.Effect<R2, E2, A2>
+  ) => (self: Effect.Effect<R, E, A>) => Effect.Effect<R | R2, E | E2, A2>,
+  <R, E, A, R2, E2, A2>(
+    self: Effect.Effect<R, E, A>,
+    f: (effect: Effect.Effect<R, E, A>) => Effect.Effect<R2, E2, A2>
+  ) => Effect.Effect<R | R2, E | E2, A2>
+>(2, (self, f) =>
+  core.fiberRefGetWith(
+    defaultServices.currentServices,
+    (services) => provideLive(f(core.fiberRefLocally(defaultServices.currentServices, services)(self)))
+  ))
+
+/**
+ * Retrieves the `Sized` service for this test and uses it to run the
+ * specified workflow.
+ *
+ * @since 2.0.0
+ */
+export const sizedWith = <R, E, A>(f: (sized: Sized.TestSized) => Effect.Effect<R, E, A>): Effect.Effect<R, E, A> =>
+  core.fiberRefGetWith(
+    currentServices,
+    (services) => f(Context.get(services, Sized.TestSized))
+  )
+
+/**
+ * Retrieves the `Sized` service for this test.
+ *
+ * @since 2.0.0
+ */
+export const sized: Effect.Effect<never, never, Sized.TestSized> = sizedWith(core.succeed)
+
+/**
+ * Executes the specified workflow with the specified implementation of the
+ * sized service.
+ *
+ * @since 2.0.0
+ */
+export const withSized = dual<
+  (sized: Sized.TestSized) => <R, E, A>(effect: Effect.Effect<R, E, A>) => Effect.Effect<R, E, A>,
+  <R, E, A>(effect: Effect.Effect<R, E, A>, sized: Sized.TestSized) => Effect.Effect<R, E, A>
+>(2, (effect, sized) =>
+  core.fiberRefLocallyWith(
+    currentServices,
+    Context.add(Sized.TestSized, sized)
+  )(effect))
+
+/**
+ * Sets the implementation of the sized service to the specified value and
+ * restores it to its original value when the scope is closed.
+ *
+ * @since 2.0.0
+ */
+export const withSizedScoped = (sized: Sized.TestSized): Effect.Effect<Scope.Scope, never, void> =>
+  fiberRuntime.fiberRefLocallyScopedWith(currentServices, Context.add(Sized.TestSized, sized))
+
+/**
+ * @since 2.0.0
+ */
+export const sizedLayer = (size: number): Layer.Layer<never, never, Sized.TestSized> =>
+  layer.scoped(
+    Sized.TestSized,
+    pipe(
+      fiberRuntime.fiberRefMake(size),
+      core.map(Sized.fromFiberRef),
+      core.tap(withSizedScoped)
+    )
+  )
+
+/**
+ * @since 2.0.0
+ */
+export const size: Effect.Effect<never, never, number> = sizedWith((sized) => sized.size)
+
+/**
+ * @since 2.0.0
+ */
+export const withSize = dual<
+  (size: number) => <R, E, A>(effect: Effect.Effect<R, E, A>) => Effect.Effect<R, E, A>,
+  <R, E, A>(effect: Effect.Effect<R, E, A>, size: number) => Effect.Effect<R, E, A>
+>(2, (effect, size) => sizedWith((sized) => sized.withSize(size)(effect)))
+
+/**
+ * Retrieves the `TestConfig` service for this test and uses it to run the
+ * specified workflow.
+ *
+ * @since 2.0.0
+ */
+export const testConfigWith = <R, E, A>(
+  f: (config: TestConfig.TestConfig) => Effect.Effect<R, E, A>
+): Effect.Effect<R, E, A> =>
+  core.fiberRefGetWith(
+    currentServices,
+    (services) => f(Context.get(services, TestConfig.TestConfig))
+  )
+
+/**
+ * Retrieves the `TestConfig` service for this test.
+ *
+ * @since 2.0.0
+ */
+export const testConfig: Effect.Effect<never, never, TestConfig.TestConfig> = testConfigWith(core.succeed)
+
+/**
+ * Executes the specified workflow with the specified implementation of the
+ * config service.
+ *
+ * @since 2.0.0
+ */
+export const withTestConfig = dual<
+  (config: TestConfig.TestConfig) => <R, E, A>(effect: Effect.Effect<R, E, A>) => Effect.Effect<R, E, A>,
+  <R, E, A>(effect: Effect.Effect<R, E, A>, config: TestConfig.TestConfig) => Effect.Effect<R, E, A>
+>(2, (effect, config) =>
+  core.fiberRefLocallyWith(
+    currentServices,
+    Context.add(TestConfig.TestConfig, config)
+  )(effect))
+
+/**
+ * Sets the implementation of the config service to the specified value and
+ * restores it to its original value when the scope is closed.
+ *
+ * @since 2.0.0
+ */
+export const withTestConfigScoped = (config: TestConfig.TestConfig): Effect.Effect<Scope.Scope, never, void> =>
+  fiberRuntime.fiberRefLocallyScopedWith(currentServices, Context.add(TestConfig.TestConfig, config))
+
+/**
+ * Constructs a new `TestConfig` service with the specified settings.
+ *
+ * @since 2.0.0
+ */
+export const testConfigLayer = (params: {
+  readonly repeats: number
+  readonly retries: number
+  readonly samples: number
+  readonly shrinks: number
+}): Layer.Layer<never, never, TestConfig.TestConfig> =>
+  layer.scoped(
+    TestConfig.TestConfig,
+    Effect.suspend(() => {
+      const testConfig = TestConfig.make(params)
+      return pipe(
+        withTestConfigScoped(testConfig),
+        core.as(testConfig)
+      )
+    })
+  )
+
+/**
+ * The number of times to repeat tests to ensure they are stable.
+ *
+ * @since 2.0.0
+ */
+export const repeats: Effect.Effect<never, never, number> = testConfigWith((config) => core.succeed(config.repeats))
+
+/**
+ * The number of times to retry flaky tests.
+ *
+ * @since 2.0.0
+ */
+export const retries: Effect.Effect<never, never, number> = testConfigWith((config) => core.succeed(config.retries))
+
+/**
+ * The number of sufficient samples to check for a random variable.
+ *
+ * @since 2.0.0
+ */
+export const samples: Effect.Effect<never, never, number> = testConfigWith((config) => core.succeed(config.samples))
+
+/**
+ * The maximum number of shrinkings to minimize large failures.
+ *
+ * @since 2.0.0
+ */
+export const shrinks: Effect.Effect<never, never, number> = testConfigWith((config) => core.succeed(config.shrinks))

package/src/TestSized.ts

@@ -0,0 +1,55 @@
+/**
+ * @since 2.0.0
+ */
+import * as Context from "./Context.js"
+import type * as Effect from "./Effect.js"
+import type * as FiberRef from "./FiberRef.js"
+import * as core from "./internal/core.js"
+
+/**
+ * @since 2.0.0
+ */
+export const TestSizedTypeId = Symbol.for("effect/TestSized")
+
+/**
+ * @since 2.0.0
+ */
+export type TestSizedTypeId = typeof TestSizedTypeId
+
+/**
+ * @since 2.0.0
+ */
+export interface TestSized {
+  readonly [TestSizedTypeId]: TestSizedTypeId
+  readonly fiberRef: FiberRef.FiberRef<number>
+  readonly size: Effect.Effect<never, never, number>
+  withSize(size: number): <R, E, A>(effect: Effect.Effect<R, E, A>) => Effect.Effect<R, E, A>
+}
+
+/**
+ * @since 2.0.0
+ */
+export const TestSized: Context.Tag<TestSized, TestSized> = Context.Tag(TestSizedTypeId)
+
+/** @internal */
+class SizedImpl implements TestSized {
+  readonly [TestSizedTypeId]: TestSizedTypeId = TestSizedTypeId
+  constructor(readonly fiberRef: FiberRef.FiberRef<number>) {}
+  get size(): Effect.Effect<never, never, number> {
+    return core.fiberRefGet(this.fiberRef)
+  }
+  withSize(size: number) {
+    return <R, E, A>(effect: Effect.Effect<R, E, A>): Effect.Effect<R, E, A> =>
+      core.fiberRefLocally(this.fiberRef, size)(effect)
+  }
+}
+
+/**
+ * @since 2.0.0
+ */
+export const make = (size: number): TestSized => new SizedImpl(core.fiberRefUnsafeMake(size))
+
+/**
+ * @since 2.0.0
+ */
+export const fromFiberRef = (fiberRef: FiberRef.FiberRef<number>): TestSized => new SizedImpl(fiberRef)

package/src/Tracer.ts

@@ -0,0 +1,135 @@
+/**
+ * @since 2.0.0
+ */
+import type * as Context from "./Context.js"
+import type * as Effect from "./Effect.js"
+import type * as Exit from "./Exit.js"
+import type * as Fiber from "./Fiber.js"
+import * as defaultServices from "./internal/defaultServices.js"
+import * as internal from "./internal/tracer.js"
+import type * as Option from "./Option.js"
+
+/**
+ * @since 2.0.0
+ */
+export const TracerTypeId: unique symbol = internal.TracerTypeId
+
+/**
+ * @since 2.0.0
+ */
+export type TracerTypeId = typeof TracerTypeId
+
+/**
+ * @since 2.0.0
+ */
+export interface Tracer {
+  readonly [TracerTypeId]: TracerTypeId
+  span(
+    name: string,
+    parent: Option.Option<ParentSpan>,
+    context: Context.Context<never>,
+    links: ReadonlyArray<SpanLink>,
+    startTime: bigint
+  ): Span
+  context<X>(f: () => X, fiber: Fiber.RuntimeFiber<any, any>): X
+}
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export type SpanStatus = {
+  _tag: "Started"
+  startTime: bigint
+} | {
+  _tag: "Ended"
+  startTime: bigint
+  endTime: bigint
+  exit: Exit.Exit<unknown, unknown>
+}
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export type ParentSpan = Span | ExternalSpan
+
+/**
+ * @since 2.0.0
+ * @category tags
+ */
+export const ParentSpan: Context.Tag<ParentSpan, ParentSpan> = internal.spanTag
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export interface ExternalSpan {
+  readonly _tag: "ExternalSpan"
+  readonly spanId: string
+  readonly traceId: string
+  readonly sampled: boolean
+  readonly context: Context.Context<never>
+}
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export interface Span {
+  readonly _tag: "Span"
+  readonly name: string
+  readonly spanId: string
+  readonly traceId: string
+  readonly parent: Option.Option<ParentSpan>
+  readonly context: Context.Context<never>
+  readonly status: SpanStatus
+  readonly attributes: ReadonlyMap<string, unknown>
+  readonly links: ReadonlyArray<SpanLink>
+  readonly sampled: boolean
+  end(endTime: bigint, exit: Exit.Exit<unknown, unknown>): void
+  attribute(key: string, value: unknown): void
+  event(name: string, startTime: bigint, attributes?: Record<string, unknown>): void
+}
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export interface SpanLink {
+  readonly _tag: "SpanLink"
+  readonly span: ParentSpan
+  readonly attributes: Readonly<Record<string, unknown>>
+}
+
+/**
+ * @since 2.0.0
+ * @category tags
+ */
+export const Tracer: Context.Tag<Tracer, Tracer> = internal.tracerTag
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const make: (options: Omit<Tracer, typeof TracerTypeId>) => Tracer = internal.make
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const externalSpan: (
+  options: {
+    readonly spanId: string
+    readonly traceId: string
+    readonly sampled?: boolean | undefined
+    readonly context?: Context.Context<never> | undefined
+  }
+) => ExternalSpan = internal.externalSpan
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const tracerWith: <R, E, A>(f: (tracer: Tracer) => Effect.Effect<R, E, A>) => Effect.Effect<R, E, A> =
+  defaultServices.tracerWith