effect-app 4.0.0-beta.99 → 4.0.1

package/src/rpc.ts

@@ -1,4 +1,4 @@
-export * as RpcX from "./rpc.js"
-export * as MiddlewareMaker from "./rpc/MiddlewareMaker.js"
-export * as RpcContextMap from "./rpc/RpcContextMap.js"
-export * as RpcMiddleware from "./rpc/RpcMiddleware.js"
+export * as Invalidation from "./rpc/Invalidation.ts"
+export * as MiddlewareMaker from "./rpc/MiddlewareMaker.ts"
+export * as RpcContextMap from "./rpc/RpcContextMap.ts"
+export * as RpcMiddleware from "./rpc/RpcMiddleware.ts"

package/src/runtime.ts

@@ -0,0 +1,57 @@
+import * as Exit from "effect/Exit"
+import { flow } from "effect/Function"
+import * as Logger from "effect/Logger"
+import * as ManagedRuntime from "effect/ManagedRuntime"
+import { CauseException } from "./client/errors.ts"
+import { type Context } from "./Context.ts"
+import * as Effect from "./Effect.ts"
+import * as Layer from "./Layer.ts"
+
+export const makeAppRuntime = Effect.fnUntraced(function*<A, E>(layer: Layer.Layer<A, E>) {
+  const l = layer.pipe(
+    Layer.provide(Logger.layer([Logger.consolePretty()])),
+    Layer.orDie
+  )
+  const mrt = ManagedRuntime.make(l)
+  yield* mrt.contextEffect
+  return Object.assign(mrt, {
+    [Symbol.dispose]() {
+      return Effect.runSync(mrt.disposeEffect)
+    },
+
+    [Symbol.asyncDispose]() {
+      return mrt.dispose()
+    }
+  }) // as we initialise here, there is no more error left.
+})
+
+export function initializeSync<A, E>(layer: Layer.Layer<A, E>) {
+  const runtime = Effect.runSync(makeAppRuntime(layer))
+  return runtime
+}
+
+export function initializeAsync<A, E>(layer: Layer.Layer<A, E>) {
+  return Effect
+    .runPromise(makeAppRuntime(layer))
+}
+
+// we wrap into CauseException because we want to keep the full cause of the failure.
+export const makeRunPromise = <T>(services: Context<T>) =>
+  flow(Effect.runPromiseExitWith(services), (_) =>
+    _.then(
+      Exit.match({
+        onFailure: (cause) => Promise.reject(new CauseException(cause, "runPromise")),
+        onSuccess: (value) => Promise.resolve(value)
+      })
+    ))
+
+export const makeRunSync = <T>(services: Context<T>) =>
+  flow(
+    Effect.runSyncExitWith(services),
+    Exit.match({
+      onFailure: (cause) => {
+        throw new CauseException(cause, "runSync")
+      },
+      onSuccess: (value) => value
+    })
+  )

package/src/setupRequest.ts

@@ -0,0 +1,138 @@
+import { SqlClient } from "effect/sql"
+import * as Tracer from "effect/Tracer"
+import { DataDependencyRecorder } from "./DataDependencies.ts"
+import * as Effect from "./Effect.ts"
+import * as Layer from "./Layer.ts"
+import * as Option from "./Option.ts"
+import { LocaleRef, RequestContext, spanAttributes } from "./RequestContext.ts"
+import * as RequestScopedDependencies from "./RequestScopedDependencies.ts"
+import { NonEmptyString255 } from "./Schema.ts"
+import { ContextMapContainer, storeId } from "./Store.ts"
+
+const withSqlTransaction = <R, E, A>(self: Effect.Effect<A, E, R>): Effect.Effect<A, E, R> =>
+  Effect.serviceOption(SqlClient.SqlClient).pipe(
+    Effect.flatMap(Option.match({
+      onNone: () => self,
+      onSome: (sql) => sql.withTransaction(self).pipe(Effect.orDie)
+    }))
+  )
+
+export const getRequestContext = Effect
+  .all({
+    span: Effect.currentSpan.pipe(Effect.orDie),
+    locale: LocaleRef,
+    namespace: storeId
+  })
+  .pipe(
+    Effect.map(({ locale, namespace, span }) =>
+      RequestContext.make({
+        span: Tracer.externalSpan(span),
+        locale,
+        namespace,
+        name: NonEmptyString255(span.name)
+      })
+    )
+  )
+
+export const getRC = Effect.all({
+  locale: LocaleRef,
+  namespace: storeId
+})
+
+const withRequestSpan = (name = "request", options?: Tracer.SpanOptions) => <R, E, A>(f: Effect.Effect<A, E, R>) =>
+  Effect.andThen(
+    getRC,
+    (ctx) =>
+      f.pipe(
+        Effect.withSpan(name, {
+          ...options,
+          attributes: { ...spanAttributes({ ...ctx, name: NonEmptyString255(name) }), ...options?.attributes }
+        }, {
+          captureStackTrace: options?.captureStackTrace ?? false
+        }),
+        // TODO: false
+        // request context info is picked up directly in the logger for annotations.
+        Effect.withLogSpan(name)
+      )
+  )
+
+export interface SetupRequestOptions {
+  readonly withTransaction?: boolean
+}
+
+export const requestStateLayer = RequestScopedDependencies.layer(ContextMapContainer, DataDependencyRecorder)
+
+// Build `layer` against the ambient (request) scope rather than a sub-scope of the
+// returned Effect. Required when the returned value is a streaming HttpServerResponse:
+// the response body keeps producing chunks (and using layer-provided state) after the
+// Effect returns, so a sub-scope would close too early and run finalizers mid-stream.
+export const provideOnRequestScope =
+  <ROut, E2, RIn>(layer: Layer.Layer<ROut, E2, RIn>) => <A, E, R>(self: Effect.Effect<A, E, R>) =>
+    Effect.gen(function*() {
+      const requestScope = yield* Effect.scope
+      // Fresh MemoMap per request: `Layer.buildWithScope` would otherwise reuse
+      // the ambient MemoMap living on the HTTP server fiber, sharing the built
+      // value (e.g. ContextMap) across every request handled by that server.
+      const memoMap = yield* Layer.makeMemoMap
+      const ctx = yield* Layer.buildWithMemoMap(layer, memoMap, requestScope)
+      return yield* Effect.provide(self, ctx)
+    })
+
+export const setupRequestContextFromCurrent =
+  (name = "request", options?: Tracer.SpanOptions & SetupRequestOptions) => <R, E, A>(self: Effect.Effect<A, E, R>) =>
+    self
+      .pipe(
+        options?.withTransaction === true ? withSqlTransaction : (_) => _,
+        withRequestSpan(name, options),
+        Effect.provide(requestStateLayer, { local: true })
+      )
+
+// Streaming variant: binds ContextMapContainer to the ambient (request) scope so its
+// finalizer (clear()) runs only after the response body is fully drained, not when the
+// outer Effect returns its HttpServerResponse value. Use for handlers that return a
+// streaming HttpServerResponse (e.g. SSE) — see RequestContextMiddleware for context.
+export const setupStreamingRequestContextFromCurrent =
+  (name = "request", options?: Tracer.SpanOptions & SetupRequestOptions) => <R, E, A>(self: Effect.Effect<A, E, R>) =>
+    self.pipe(
+      options?.withTransaction === true ? withSqlTransaction : (_) => _,
+      withRequestSpan(name, options),
+      provideOnRequestScope(requestStateLayer)
+    )
+
+// TODO: consider integrating Effect.withParentSpan
+export function setupRequestContext<R, E, A>(
+  self: Effect.Effect<A, E, R>,
+  requestContext: RequestContext,
+  options?: SetupRequestOptions
+) {
+  const layer = Layer.mergeAll(
+    requestStateLayer,
+    Layer.succeed(LocaleRef, requestContext.locale),
+    Layer.succeed(storeId, requestContext.namespace)
+  )
+  return self
+    .pipe(
+      options?.withTransaction === true ? withSqlTransaction : (_) => _,
+      withRequestSpan(requestContext.name),
+      Effect.provide(layer, { local: true })
+    )
+}
+
+export function setupRequestContextWithCustomSpan<R, E, A>(
+  self: Effect.Effect<A, E, R>,
+  requestContext: RequestContext,
+  name: string,
+  options?: Tracer.SpanOptions & SetupRequestOptions
+) {
+  const layer = Layer.mergeAll(
+    requestStateLayer,
+    Layer.succeed(LocaleRef, requestContext.locale),
+    Layer.succeed(storeId, requestContext.namespace)
+  )
+  return self
+    .pipe(
+      options?.withTransaction === true ? withSqlTransaction : (_) => _,
+      withRequestSpan(name, options),
+      Effect.provide(layer, { local: true })
+    )
+}

package/src/toast.ts

@@ -0,0 +1,54 @@
+import * as Context from "./Context.ts"
+import { accessEffectFn } from "./Context.ts"
+import * as Effect from "./Effect.ts"
+import * as Option from "./Option.ts"
+
+export type ToastId = string | number
+export type ToastOpts = { id?: ToastId; timeout?: number; groupId?: string; requestId?: string }
+export type ToastOptsInternal = { id?: ToastId | null; timeout?: number; groupId?: string; requestId?: string }
+
+export type UseToast = () => {
+  error: (this: void, message: string, options?: ToastOpts) => ToastId
+  warning: (this: void, message: string, options?: ToastOpts) => ToastId
+  success: (this: void, message: string, options?: ToastOpts) => ToastId
+  info: (this: void, message: string, options?: ToastOpts) => ToastId
+  dismiss: (this: void, id: ToastId) => void
+}
+
+export class CurrentToastId extends Context.Opaque<CurrentToastId, { toastId: ToastId }>()("CurrentToastId") {}
+
+/** fallback to CurrentToastId when available unless id is explicitly set to a value or null */
+export const wrap = (toast: ReturnType<UseToast>) => {
+  const wrap = (toastHandler: (message: string, options?: ToastOpts) => ToastId) => {
+    return (message: string, options?: ToastOptsInternal) =>
+      Effect.serviceOption(CurrentToastId).pipe(
+        Effect.flatMap((currentToast) =>
+          Effect.sync(() => {
+            const { id: _id, ...rest } = options ?? {}
+            const id = _id !== undefined
+              ? _id ?? undefined
+              : Option.getOrUndefined(Option.map(currentToast, (_) => _.toastId))
+            // when id is undefined, we may end up with no toast at all..
+            return toastHandler(message, id !== undefined ? { ...rest, id } : rest)
+          })
+        )
+      )
+  }
+  return {
+    error: wrap(toast.error),
+    info: wrap(toast.info),
+    success: wrap(toast.success),
+    warning: wrap(toast.warning),
+    dismiss: (toastId: ToastId) => Effect.sync(() => toast.dismiss(toastId))
+  }
+}
+
+type ToastShape = ReturnType<typeof wrap>
+
+export class Toast extends Context.Opaque<Toast, ToastShape>()("Toast") {
+  static readonly error = accessEffectFn(this, "error")
+  static readonly info = accessEffectFn(this, "info")
+  static readonly success = accessEffectFn(this, "success")
+  static readonly warning = accessEffectFn(this, "warning")
+  static readonly dismiss = accessEffectFn(this, "dismiss")
+}

package/src/transform.ts

@@ -1,8 +1,8 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
-import { Option } from "effect"
 import type { NonEmptyReadonlyArray } from "effect/Array"
+import * as Option from "effect/Option"
 import type { Misc, Union } from "ts-toolbelt"
-import type * as SET from "./Set.js"
+import type * as SET from "./Set.ts"
 
 // type SomeObject = {
 //   0: Option.Option<string>
@@ -51,8 +51,8 @@ const encodeOptsAsNullable_ = (value: any, cacheMap: Map<any, any>): any => {
 
   if (
     value instanceof Date
-    || value instanceof Function
-    || value instanceof Promise
+    || typeof value === "function"
+    || (typeof value === "object" && value !== null && "then" in value && typeof value.then === "function")
   ) {
     return value
   }

package/src/utils/effectify.ts

@@ -1,7 +1,7 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
 
-import { Effect } from "effect"
+import * as Effect from "effect/Effect"
 
 interface Callback<E, A> {
   (err: E, a?: A): void

package/src/utils/extend.ts

@@ -1,9 +1,28 @@
+/**
+ * Own-property define that shadows getter-only prototype fields such as
+ * Effect 4 `Schema.make`. `Object.assign` uses [[Set]] and cannot.
+ */
+export const defineOwn = (target: object, key: PropertyKey, value: unknown) => {
+  Object.defineProperty(target, key, {
+    value,
+    writable: true,
+    enumerable: true,
+    configurable: true
+  })
+}
+
+const assignOwn = <T extends object>(target: T, source: object): T => {
+  for (const key of Reflect.ownKeys(source)) {
+    const desc = Object.getOwnPropertyDescriptor(source, key)
+    if (!desc?.enumerable) continue
+    defineOwn(target, key, (source as Record<PropertyKey, unknown>)[key])
+  }
+  return target
+}
+
 export const extend = <T extends {}, X extends {}>(a: T, ext: X) => {
-  Object.assign(a, ext)
+  assignOwn(a, ext)
   return a as T & X
 }
 
-export const extendM = <T extends {}, X extends {}>(a: T, ext: (a: T) => X) => {
-  Object.assign(a, ext(a))
-  return a as typeof a & X
-}
+export const extendM = <T extends {}, X extends {}>(a: T, ext: (a: T) => X) => extend(a, ext(a))

package/src/utils/gen.ts

@@ -1,24 +1,24 @@
-import { type Effect, type Yieldable } from "effect/Effect"
+import { type Effect } from "effect/Effect"
 
 export namespace EffectGenUtils {
   export type Success<EG> = EG extends Effect<infer A, infer _E, infer _R> ? A
     // there could be a case where the generator function does not yield anything, so we need to handle that
     : EG extends (..._: infer _3) => Generator<never, infer A, infer _2> ? A
-    // v4: generators can yield Yieldable (Effect, Service, etc.), all have asEffect()
-    : EG extends (..._: infer _3) => Generator<Yieldable<any, infer _, infer _E, infer _R>, infer A, infer _2> ? A
+    // generators yield Effect values
+    : EG extends (..._: infer _3) => Generator<Effect<any, infer _E, infer _R>, infer A, infer _2> ? A
     : never
 
   export type Error<EG> = EG extends Effect<infer _A, infer E, infer _R> ? E
     // there could be a case where the generator function does not yield anything, so we need to handle that
     : EG extends (..._: infer _3) => Generator<never, infer _A, infer _2> ? never
-    // v4: generators can yield Yieldable (Effect, Service, etc.), all have asEffect()
-    : EG extends (..._: infer _3) => Generator<Yieldable<any, infer _, infer E, infer _R>, infer _A, infer _2> ? E
+    // generators yield Effect values
+    : EG extends (..._: infer _3) => Generator<Effect<any, infer E, infer _R>, infer _A, infer _2> ? E
     : never
 
   export type Context<EG> = EG extends Effect<infer _A, infer _E, infer R> ? R
     // there could be a case where the generator function does not yield anything, so we need to handle that
     : EG extends (..._: infer _3) => Generator<never, infer _A, infer _2> ? never
-    // v4: generators can yield Yieldable (Effect, Service, etc.), all have asEffect()
-    : EG extends (..._: infer _3) => Generator<Yieldable<any, infer _, infer _E, infer R>, infer _A, infer _2> ? R
+    // generators yield Effect values
+    : EG extends (..._: infer _3) => Generator<Effect<any, infer _E, infer R>, infer _A, infer _2> ? R
     : never
 }

package/src/utils/logLevel.ts

@@ -1,4 +1,4 @@
-import { type LogLevel } from "effect"
+import type * as LogLevel from "effect/LogLevel"
 
 export const LogLevelToSentry = (level: LogLevel.LogLevel) => {
   switch (level) {

package/src/utils/logger.ts

@@ -1,8 +1,9 @@
 /* eslint-disable @typescript-eslint/no-unsafe-argument */
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
-import { Effect, type LogLevel } from "effect"
-import * as Context from "../Context.js"
+import * as Effect from "effect/Effect"
+import type * as LogLevel from "effect/LogLevel"
+import * as Context from "../Context.ts"
 
 type Levels = "info" | "debug" | "warn" | "error"