@effect-app/infra 2.73.4 → 2.75.0

package/src/api/routing/middleware/middleware.ts

@@ -0,0 +1,120 @@
+import { Cause, Context, Effect, ParseResult } from "effect-app"
+import { HttpHeaders, type HttpRouter, HttpServerRequest } from "effect-app/http"
+import { pretty } from "effect-app/utils"
+import { logError, reportError } from "../../../errorReporter.js"
+import { InfraLogger } from "../../../logger.js"
+
+const logRequestError = logError("Request")
+const reportRequestError = reportError("Request")
+
+export class DevMode extends Context.Reference<DevMode>()("DevMode", { defaultValue: () => false }) {}
+
+export class ConfigureInterruptibility extends Effect.Service<ConfigureInterruptibility>()(
+  "ConfigureInterruptibility",
+  {
+    effect: Effect.gen(function*() {
+      return <A, E>(
+        handle: (input: any, headers: HttpHeaders.Headers) => Effect.Effect<A, E, HttpRouter.HttpRouter.Provided>,
+        _moduleName: string
+      ) =>
+        Effect.fnUntraced(function*(input: any, headers: HttpHeaders.Headers) {
+          return yield* handle(input, headers).pipe(
+            // TODO: make this depend on query/command, and consider if middleware also should be affected. right now it's not.
+            Effect.uninterruptible
+          )
+        })
+    })
+  }
+) {}
+
+export class CaptureHttpHeadersAsRpcHeaders
+  extends Effect.Service<CaptureHttpHeadersAsRpcHeaders>()("CaptureHttpHeadersAsRpcHeaders", {
+    effect: Effect.gen(function*() {
+      return <A, E>(
+        handle: (input: any, headers: HttpHeaders.Headers) => Effect.Effect<A, E, HttpRouter.HttpRouter.Provided>,
+        _moduleName: string
+      ) =>
+        Effect.fnUntraced(function*(input: any, rpcHeaders: HttpHeaders.Headers) {
+          // merge in the request headers
+          // we should consider if we should merge them into rpc headers on the Protocol layer instead.
+          const httpReq = yield* HttpServerRequest.HttpServerRequest
+          const headers = HttpHeaders.merge(httpReq.headers, rpcHeaders)
+          return yield* handle(input, headers)
+        })
+    })
+  })
+{}
+
+export class MiddlewareLogger extends Effect.Service<MiddlewareLogger>()("MiddlewareLogger", {
+  effect: Effect.gen(function*() {
+    return <A, E>(
+      handle: (input: any, headers: HttpHeaders.Headers) => Effect.Effect<A, E, HttpRouter.HttpRouter.Provided>,
+      moduleName: string
+    ) =>
+      Effect.fnUntraced(function*(input: any, rpcHeaders: HttpHeaders.Headers) {
+        const devMode = yield* DevMode
+        // merge in the request headers
+        // we should consider if we should merge them into rpc headers on the Protocol layer instead.
+        const httpReq = yield* HttpServerRequest.HttpServerRequest
+        const headers = HttpHeaders.merge(httpReq.headers, rpcHeaders)
+
+        return yield* Effect
+          .annotateCurrentSpan(
+            "requestInput",
+            Object.entries(input).reduce((prev, [key, value]: [string, unknown]) => {
+              prev[key] = key === "password"
+                ? "<redacted>"
+                : typeof value === "string" || typeof value === "number" || typeof value === "boolean"
+                ? typeof value === "string" && value.length > 256
+                  ? (value.substring(0, 253) + "...")
+                  : value
+                : Array.isArray(value)
+                ? `Array[${value.length}]`
+                : value === null || value === undefined
+                ? `${value}`
+                : typeof value === "object" && value
+                ? `Object[${Object.keys(value).length}]`
+                : typeof value
+              return prev
+            }, {} as Record<string, string | number | boolean>)
+          )
+          .pipe(
+            // can't use andThen due to some being a function and effect
+            Effect.zipRight(handle(input, headers)),
+            // TODO: support ParseResult if the error channel of the request allows it.. but who would want that?
+            Effect.catchAll((_) => ParseResult.isParseError(_) ? Effect.die(_) : Effect.fail(_)),
+            Effect.tapErrorCause((cause) => Cause.isFailure(cause) ? logRequestError(cause) : Effect.void),
+            Effect.tapDefect((cause) =>
+              Effect
+                .all([
+                  reportRequestError(cause, {
+                    action: `${moduleName}.${input._tag}`
+                  }),
+                  InfraLogger
+                    .logError("Finished request", cause)
+                    .pipe(Effect.annotateLogs({
+                      action: `${moduleName}.${input._tag}`,
+                      req: pretty(input),
+                      headers: pretty(headers)
+                      // resHeaders: pretty(
+                      //   Object
+                      //     .entries(headers)
+                      //     .reduce((prev, [key, value]) => {
+                      //       prev[key] = value && typeof value === "string" ? snipString(value) : value
+                      //       return prev
+                      //     }, {} as Record<string, any>)
+                      // )
+                    }))
+                ])
+            ),
+            devMode ? (_) => _ : Effect.catchAllDefect(() => Effect.die("Internal Server Error"))
+          )
+      })
+  })
+}) {}
+
+export const DefaultGenericMiddlewares = [
+  ConfigureInterruptibility,
+  CaptureHttpHeadersAsRpcHeaders,
+  MiddlewareLogger
+] as const

package/src/api/routing/middleware.ts

@@ -0,0 +1,7 @@
+// codegen:start {preset: barrel, include: ./middleware/*.ts, nodir: false }
+export * from "./middleware/ContextProvider.js"
+export * from "./middleware/dynamic-middleware.js"
+export * from "./middleware/DynamicMiddleware.js"
+export * from "./middleware/generic-middleware.js"
+export * from "./middleware/middleware.js"
+// codegen:end

package/src/api/routing/tsort.ts

@@ -0,0 +1,56 @@
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-nocheck
+export function tsort(edges) {
+  const nodes = new Map(), sorted = [], visited = new Map()
+
+  const Node = function(id) {
+    this.id = id
+    this.afters = []
+  }
+
+  edges.forEach((v) => {
+    const from = v[0], to = v[1]
+    if (!nodes.get(from)) nodes.set(from, new Node(from))
+    if (!nodes.get(to)) nodes.set(to, new Node(to))
+    nodes.get(from).afters.push(to)
+  })
+  ;[...nodes.keys()].forEach(function visit(idstr, ancestors) {
+    const node = nodes.get(idstr), id = node.id
+
+    if (visited.get(idstr)) return
+    if (!Array.isArray(ancestors)) ancestors = []
+
+    ancestors.push(id)
+    visited.set(idstr, true)
+    node.afters.forEach(function(afterID) {
+      if (ancestors.indexOf(afterID) >= 0) {
+        throw new Error("closed chain : " + afterID + " is in " + id)
+      }
+      visit(
+        afterID,
+        ancestors.map(function(v) {
+          return v
+        })
+      )
+    })
+    sorted.unshift(id)
+  })
+
+  return sorted
+}
+
+export const createEdges = <T extends { dependsOn?: any[] }>(dep: readonly T[]) => {
+  const result = []
+  dep.forEach((key) => {
+    key.dependsOn?.forEach((n) => {
+      result.push([n, key])
+    })
+  })
+  return result
+}
+
+export const sort = <T>(dep: readonly (T & { dependsOn?: any[] })[]): readonly T[] => {
+  const edges = createEdges(dep)
+  const result = tsort(edges)
+  return result.concat(dep.filter((v) => !result.includes(v)))
+}

package/src/api/routing.ts

@@ -3,41 +3,17 @@
 /* eslint-disable @typescript-eslint/no-empty-object-type */
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import { determineMethod, isCommand } from "@effect-app/infra/api/routing/utils"
-import { logError, reportError } from "@effect-app/infra/errorReporter"
-import { InfraLogger } from "@effect-app/infra/logger"
 import { Rpc, RpcGroup, RpcServer } from "@effect/rpc"
-import { Array, Cause, Duration, Effect, Layer, type NonEmptyArray, type NonEmptyReadonlyArray, ParseResult, Predicate, Request, S, Schedule, Schema } from "effect-app"
+import { type Array, Duration, Effect, Layer, type NonEmptyArray, Predicate, Request, S, Schedule, Schema } from "effect-app"
 import type { GetEffectContext, GetEffectError, RPCContextMap } from "effect-app/client/req"
 import { type HttpHeaders, HttpRouter } from "effect-app/http"
-import { pretty, typedKeysOf, typedValuesOf } from "effect-app/utils"
+import { typedKeysOf, typedValuesOf } from "effect-app/utils"
 import type { Contravariant } from "effect/Types"
 import { type YieldWrap } from "effect/Utils"
-import { type Middleware } from "./routing/DynamicMiddleware.js"
+import { type LayerUtils } from "./layerUtils.js"
+import { DevMode, type Middleware } from "./routing/middleware.js"
 
-export * from "./routing/DynamicMiddleware.js"
-
-export namespace LayersUtils {
-  export type GetLayersSuccess<Layers extends ReadonlyArray<Layer.Layer.Any>> = Layers extends
-    NonEmptyReadonlyArray<Layer.Layer.Any> ? {
-      [k in keyof Layers]: Layer.Layer.Success<Layers[k]>
-    }[number]
-    : never
-
-  export type GetLayersContext<Layers extends ReadonlyArray<Layer.Layer.Any>> = Layers extends
-    NonEmptyReadonlyArray<Layer.Layer.Any> ? {
-      [k in keyof Layers]: Layer.Layer.Context<Layers[k]>
-    }[number]
-    : never
-
-  export type GetLayersError<Layers extends ReadonlyArray<Layer.Layer.Any>> = Layers extends
-    NonEmptyReadonlyArray<Layer.Layer.Any> ? {
-      [k in keyof Layers]: Layer.Layer.Error<Layers[k]>
-    }[number]
-    : never
-}
-
-const logRequestError = logError("Request")
-const reportRequestError = reportError("Request")
+export * from "./routing/middleware.js"
 
 // retry just once on optimistic concurrency exceptions
 const optimisticConcurrencySchedule = Schedule.once.pipe(
@@ -423,64 +399,17 @@ export const makeRouter = <
                   }
                 } as any
                 : resource,
-              rpc.effect(resource, (input: any, headers: HttpHeaders.Headers) =>
-                // TODO: render more data... similar to console?
-                Effect
-                  .annotateCurrentSpan(
-                    "requestInput",
-                    Object.entries(input).reduce((prev, [key, value]: [string, unknown]) => {
-                      prev[key] = key === "password"
-                        ? "<redacted>"
-                        : typeof value === "string" || typeof value === "number" || typeof value === "boolean"
-                        ? typeof value === "string" && value.length > 256
-                          ? (value.substring(0, 253) + "...")
-                          : value
-                        : Array.isArray(value)
-                        ? `Array[${value.length}]`
-                        : value === null || value === undefined
-                        ? `${value}`
-                        : typeof value === "object" && value
-                        ? `Object[${Object.keys(value).length}]`
-                        : typeof value
-                      return prev
-                    }, {} as Record<string, string | number | boolean>)
-                  )
-                  .pipe(
-                    // can't use andThen due to some being a function and effect
-                    Effect.zipRight(handle(input, headers)),
-                    // TODO: support ParseResult if the error channel of the request allows it.. but who would want that?
-                    Effect.catchAll((_) => ParseResult.isParseError(_) ? Effect.die(_) : Effect.fail(_)),
-                    Effect.tapErrorCause((cause) => Cause.isFailure(cause) ? logRequestError(cause) : Effect.void),
-                    Effect.tapDefect((cause) =>
-                      Effect
-                        .all([
-                          reportRequestError(cause, {
-                            action: `${meta.moduleName}.${resource._tag}`
-                          }),
-                          InfraLogger
-                            .logError("Finished request", cause)
-                            .pipe(Effect.annotateLogs({
-                              action: `${meta.moduleName}.${resource._tag}`,
-                              req: pretty(resource),
-                              headers: pretty(headers)
-                              // resHeaders: pretty(
-                              //   Object
-                              //     .entries(headers)
-                              //     .reduce((prev, [key, value]) => {
-                              //       prev[key] = value && typeof value === "string" ? snipString(value) : value
-                              //       return prev
-                              //     }, {} as Record<string, any>)
-                              // )
-                            }))
-                        ])
-                    ),
-                    // NOTE: this does not catch errors from the middlewares..
-                    // we should re-evalute this in any case..
-                    devMode ? (_) => _ : Effect.catchAllDefect(() => Effect.die("Internal Server Error")),
+              rpc.effect(
+                resource,
+                (req, headers) =>
+                  handle(req, headers).pipe(
                     Effect.withSpan("Request." + meta.moduleName + "." + resource._tag, {
                       captureStackTrace: () => handler.stack
-                    })
-                  ), meta.moduleName),
+                    }),
+                    Effect.provideService(DevMode, devMode)
+                  ),
+                meta.moduleName
+              ),
               meta.moduleName
             ] as const
             return acc
@@ -515,10 +444,10 @@ export const makeRouter = <
           })) as unknown as Layer<
             { [K in keyof RequestModules]: Rpc.Handler<K> },
             | Layer.Error<typeof middleware.Default>
-            | LayersUtils.GetLayersError<MakeDependencies>,
+            | LayerUtils.GetLayersError<MakeDependencies>,
             | RPCRouteR<typeof mapped[keyof typeof mapped]>
             | Layer.Context<typeof middleware.Default>
-            | LayersUtils.GetLayersContext<MakeDependencies>
+            | LayerUtils.GetLayersContext<MakeDependencies>
           >
 
           return RpcServer
@@ -544,12 +473,12 @@ export const makeRouter = <
         )
       ) as (Layer.Layer<
         Router,
-        | LayersUtils.GetLayersError<MakeDependencies>
+        | LayerUtils.GetLayersError<MakeDependencies>
         | MakeE
         | Layer.Error<typeof middleware.Default>,
-        | LayersUtils.GetLayersContext<MakeDependencies>
+        | LayerUtils.GetLayersContext<MakeDependencies>
         | Layer.Context<typeof middleware.Default>
-        | Exclude<MakeR, LayersUtils.GetLayersSuccess<MakeDependencies>>
+        | Exclude<MakeR, LayerUtils.GetLayersSuccess<MakeDependencies>>
       >)
 
       // Effect.Effect<HttpRouter.HttpRouter<unknown, HttpRouter.HttpRouter.DefaultServices>, never, UserRouter>
@@ -567,7 +496,7 @@ export const makeRouter = <
           dependencies: Array<Layer.Layer.Any>
           effect: (match: typeof router3) => Generator<
             YieldWrap<
-              Effect<any, any, Make["strict"] extends false ? any : LayersUtils.GetLayersSuccess<Make["dependencies"]>>
+              Effect<any, any, Make["strict"] extends false ? any : LayerUtils.GetLayersSuccess<Make["dependencies"]>>
             >,
             { [K in keyof FilterRequestModules<Resource>]: AnyHandler<Resource[K]> },
             any
@@ -585,13 +514,13 @@ export const makeRouter = <
         routes: Layer.Layer<
           RouterShape<Resource>,
           | MakeErrors<Make>
-          | LayersUtils.GetLayersError<Make["dependencies"]>
+          | LayerUtils.GetLayersError<Make["dependencies"]>
           | Layer.Error<typeof middleware.Default>,
-          | LayersUtils.GetLayersContext<Make["dependencies"]>
+          | LayerUtils.GetLayersContext<Make["dependencies"]>
           | Layer.Context<typeof middleware.Default>
           | Exclude<
             MakeContext<Make>,
-            LayersUtils.GetLayersSuccess<Make["dependencies"]>
+            LayerUtils.GetLayersSuccess<Make["dependencies"]>
           >
         >
 
@@ -604,7 +533,7 @@ export const makeRouter = <
           effect: Effect<
             { [K in keyof FilterRequestModules<Resource>]: AnyHandler<Resource[K]> },
             any,
-            Make["strict"] extends false ? any : LayersUtils.GetLayersSuccess<Make["dependencies"]>
+            Make["strict"] extends false ? any : LayerUtils.GetLayersSuccess<Make["dependencies"]>
           >
           strict?: boolean
           /** @deprecated */
@@ -618,13 +547,13 @@ export const makeRouter = <
         routes: Layer.Layer<
           RouterShape<Resource>,
           | MakeErrors<Make>
-          | LayersUtils.GetLayersError<Make["dependencies"]>
+          | LayerUtils.GetLayersError<Make["dependencies"]>
           | Layer.Error<typeof middleware.Default>,
-          | LayersUtils.GetLayersContext<Make["dependencies"]>
+          | LayerUtils.GetLayersContext<Make["dependencies"]>
           | Layer.Context<typeof middleware.Default>
           | Exclude<
             MakeContext<Make>,
-            LayersUtils.GetLayersSuccess<Make["dependencies"]>
+            LayerUtils.GetLayersSuccess<Make["dependencies"]>
           >
         >
 
@@ -637,7 +566,7 @@ export const makeRouter = <
           effect: Effect<
             { [K in keyof FilterRequestModules<Resource>]: AnyHandler<Resource[K]> },
             any,
-            Make["strict"] extends false ? any : LayersUtils.GetLayersSuccess<Make["dependencies"]>
+            Make["strict"] extends false ? any : LayerUtils.GetLayersSuccess<Make["dependencies"]>
           >
           strict?: boolean
           /** @deprecated */
@@ -651,13 +580,13 @@ export const makeRouter = <
         routes: Layer.Layer<
           RouterShape<Resource>,
           | MakeErrors<Make>
-          | LayersUtils.GetLayersError<Make["dependencies"]>
+          | LayerUtils.GetLayersError<Make["dependencies"]>
           | Layer.Error<typeof middleware.Default>,
-          | LayersUtils.GetLayersContext<Make["dependencies"]>
+          | LayerUtils.GetLayersContext<Make["dependencies"]>
           | Layer.Context<typeof middleware.Default>
           | Exclude<
             MakeContext<Make>,
-            LayersUtils.GetLayersSuccess<Make["dependencies"]>
+            LayerUtils.GetLayersSuccess<Make["dependencies"]>
           >
         >
 
@@ -670,7 +599,7 @@ export const makeRouter = <
           effect: Effect<
             { [K in keyof FilterRequestModules<Resource>]: AnyHandler<Resource[K]> },
             any,
-            Make["strict"] extends false ? any : LayersUtils.GetLayersSuccess<Make["dependencies"]>
+            Make["strict"] extends false ? any : LayerUtils.GetLayersSuccess<Make["dependencies"]>
           >
           strict?: boolean
           /** @deprecated */
@@ -684,13 +613,13 @@ export const makeRouter = <
         routes: Layer.Layer<
           RouterShape<Resource>,
           | MakeErrors<Make>
-          | LayersUtils.GetLayersError<Make["dependencies"]>
+          | LayerUtils.GetLayersError<Make["dependencies"]>
           | Layer.Error<typeof middleware.Default>,
-          | LayersUtils.GetLayersContext<Make["dependencies"]>
+          | LayerUtils.GetLayersContext<Make["dependencies"]>
           | Layer.Context<typeof middleware.Default>
           | Exclude<
             MakeContext<Make>,
-            LayersUtils.GetLayersSuccess<Make["dependencies"]>
+            LayerUtils.GetLayersSuccess<Make["dependencies"]>
           >
         >
 
@@ -703,7 +632,7 @@ export const makeRouter = <
           effect: Effect<
             { [K in keyof FilterRequestModules<Resource>]: AnyHandler<Resource[K]> },
             any,
-            LayersUtils.GetLayersSuccess<Make["dependencies"]>
+            LayerUtils.GetLayersSuccess<Make["dependencies"]>
           >
           strict?: boolean
           /** @deprecated */
@@ -717,13 +646,13 @@ export const makeRouter = <
         routes: Layer.Layer<
           RouterShape<Resource>,
           | MakeErrors<Make>
-          | LayersUtils.GetLayersError<Make["dependencies"]>
+          | LayerUtils.GetLayersError<Make["dependencies"]>
           | Layer.Error<typeof middleware.Default>,
-          | LayersUtils.GetLayersContext<Make["dependencies"]>
+          | LayerUtils.GetLayersContext<Make["dependencies"]>
           | Layer.Context<typeof middleware.Default>
           | Exclude<
             MakeContext<Make>,
-            LayersUtils.GetLayersSuccess<Make["dependencies"]>
+            LayerUtils.GetLayersSuccess<Make["dependencies"]>
           >
         >
 
@@ -736,7 +665,7 @@ export const makeRouter = <
           effect: Effect<
             { [K in keyof FilterRequestModules<Resource>]: AnyHandler<Resource[K]> },
             any,
-            LayersUtils.GetLayersSuccess<Make["dependencies"]>
+            LayerUtils.GetLayersSuccess<Make["dependencies"]>
           >
           strict?: boolean
         }
@@ -748,13 +677,13 @@ export const makeRouter = <
         routes: Layer.Layer<
           RouterShape<Resource>,
           | MakeErrors<Make>
-          | LayersUtils.GetLayersError<Make["dependencies"]>
+          | LayerUtils.GetLayersError<Make["dependencies"]>
           | Layer.Error<typeof middleware.Default>,
-          | LayersUtils.GetLayersContext<Make["dependencies"]>
+          | LayerUtils.GetLayersContext<Make["dependencies"]>
           | Layer.Context<typeof middleware.Default>
           | Exclude<
             MakeContext<Make>,
-            LayersUtils.GetLayersSuccess<Make["dependencies"]>
+            LayerUtils.GetLayersSuccess<Make["dependencies"]>
           >
         >
 
@@ -766,7 +695,7 @@ export const makeRouter = <
           dependencies: Array<Layer.Layer.Any>
           effect: (match: typeof router3) => Generator<
             YieldWrap<
-              Effect<any, any, Make["strict"] extends false ? any : LayersUtils.GetLayersSuccess<Make["dependencies"]>>
+              Effect<any, any, Make["strict"] extends false ? any : LayerUtils.GetLayersSuccess<Make["dependencies"]>>
             >,
             { [K in keyof FilterRequestModules<Resource>]: AnyHandler<Resource[K]> },
             any
@@ -782,13 +711,13 @@ export const makeRouter = <
         routes: Layer.Layer<
           RouterShape<Resource>,
           | MakeErrors<Make>
-          | LayersUtils.GetLayersError<Make["dependencies"]>
+          | LayerUtils.GetLayersError<Make["dependencies"]>
           | Layer.Error<typeof middleware.Default>,
-          | LayersUtils.GetLayersContext<Make["dependencies"]>
+          | LayerUtils.GetLayersContext<Make["dependencies"]>
           | Layer.Context<typeof middleware.Default>
           | Exclude<
             MakeContext<Make>,
-            LayersUtils.GetLayersSuccess<Make["dependencies"]>
+            LayerUtils.GetLayersSuccess<Make["dependencies"]>
           >
         >