fix: service layer typing and docs

kitlangton · kitlangton · commit 5f07f8e55f98 · 2025-11-22T10:25:58.000-05:00
diff --git a/.changeset/service-deps-layer-typing.md b/.changeset/service-deps-layer-typing.md
@@ -0,0 +1,5 @@
+---
+"effect": patch
+---
+
+Fix Service helper typing so dependency layers eliminate make requirements, add docgen @since for Service exports, and cover dependency elimination with dtslint checks.
diff --git a/packages/effect/dtslint/Service.tst.ts b/packages/effect/dtslint/Service.tst.ts
@@ -0,0 +1,35 @@
+import type { Layer } from "effect"
+import { Effect, Service } from "effect"
+import { describe, expect, it } from "tstyche"
+
+describe("Service public typing", () => {
+  it("layer removes requirements satisfied by dependencies", () => {
+    class Config extends Service<Config>()("Config", {
+      make: (prefix: string) => Effect.succeed({ prefix })
+    }) {}
+
+    class Logger extends Service<Logger>()("Logger", {
+      make: Effect.gen(function*() {
+        const cfg = yield* Config
+        return { log: (msg: string) => Effect.succeed(`${cfg.prefix}:${msg}`) }
+      }),
+      dependencies: [Config.layer("cfg")]
+    }) {}
+
+    expect(Logger.layer).type.toBe<Layer.Layer<Logger>>()
+    expect(Logger.layerWithoutDependencies).type.toBe<Layer.Layer<Logger, never, Config>>()
+  })
+
+  it("factory make keeps constructor parameters on layer", () => {
+    class Http extends Service<Http>()("Http", {
+      make: (base: string, timeout: number) =>
+        Effect.succeed({
+          base,
+          timeout,
+          get: (path: string) => Effect.succeed(`${base}${path}`)
+        })
+    }) {}
+
+    expect(Http.layer).type.toBe<(base: string, timeout: number) => Layer.Layer<Http, never, never>>()
+  })
+})
diff --git a/packages/effect/src/Service.ts b/packages/effect/src/Service.ts
@@ -0,0 +1,236 @@
+/**
+ * Layer-aware service constructor. Use this when providing `make` to get
+ * automatic `layer`, `layerWithoutDependencies`, and `use` helpers.
+ *
+ * @since 4.0.0
+ * @category Constructors
+ */
+import type * as EffectTypes from "./Effect.ts"
+import * as Effect from "./Effect.ts"
+import { isEffect } from "./internal/core.ts"
+import * as Layer from "./Layer.ts"
+import type { Scope } from "./Scope.ts"
+import * as ServiceMap from "./ServiceMap.ts"
+import type * as Types from "./types/Types.ts"
+
+// Internal helper types for layer generation
+type MakeEffect<Make> = Make extends (...args: Array<any>) => EffectTypes.Effect<any, any, any> ? ReturnType<Make>
+  : Make
+type MakeArgs<Make> = Make extends (...args: infer Args) => EffectTypes.Effect<any, any, any> ? Args : never
+
+type DepsContext<Deps extends ReadonlyArray<Layer.Layer<any, any, any>> | undefined> = Deps extends
+  ReadonlyArray<Layer.Layer<any, any, any>> ? Layer.Services<Deps[number]>
+  : never
+
+type LiftToEffect<X> = X extends EffectTypes.Effect<infer A, infer E, infer R> ? EffectTypes.Effect<A, E, R>
+  : X extends Promise<infer A> ? EffectTypes.Effect<A, unknown>
+  : EffectTypes.Effect<X, never>
+
+// Without dependencies: layer requires what make requires
+type LayerShapeNoDeps<Self, Eff> = Layer.Layer<
+  Self,
+  EffectTypes.Error<Eff>,
+  Exclude<EffectTypes.Services<Eff>, Scope>
+>
+
+// With dependencies: layer requires ONLY what dependencies require (make's reqs are satisfied)
+type LayerShapeWithDeps<Self, Eff, DepsReq> = Layer.Layer<Self, EffectTypes.Error<Eff>, DepsReq>
+
+type NonEmptyDeps<Deps extends ReadonlyArray<Layer.Layer<any, any, any>> | undefined> = Deps extends
+  ReadonlyArray<infer L> ? readonly [L, ...Array<L>] : never
+
+type LayerFromMake<Self, Make, Deps extends ReadonlyArray<Layer.Layer<any, any, any>> | undefined> = Deps extends
+  undefined ? ([MakeArgs<Make>] extends [never] ? LayerShapeNoDeps<Self, MakeEffect<Make>>
+      : (...args: MakeArgs<Make>) => LayerShapeNoDeps<Self, MakeEffect<Make>>)
+  : ([MakeArgs<Make>] extends [never] ? LayerShapeWithDeps<Self, MakeEffect<Make>, DepsContext<Deps>>
+    : (...args: MakeArgs<Make>) => LayerShapeWithDeps<Self, MakeEffect<Make>, DepsContext<Deps>>)
+
+type LayerWithoutDepsFromMake<Self, Make> = [MakeArgs<Make>] extends [never] ? LayerShapeNoDeps<Self, MakeEffect<Make>>
+  : (...args: MakeArgs<Make>) => LayerShapeNoDeps<Self, MakeEffect<Make>>
+
+// Type simplification helper to improve IDE display
+// Forces TypeScript to expand intermediate type aliases like LayerShapeNoDeps to Layer.Layer<...>
+const isPromise = (u: unknown): u is Promise<unknown> =>
+  typeof u === "object" && u !== null && "then" in u && typeof (u as any).then === "function"
+
+const buildUse = (service: any) => {
+  return <X>(f: (svc: any) => X): EffectTypes.Effect<any, any, any> =>
+    Effect.gen(function*() {
+      const svc = yield* service
+      const result = f(svc)
+      if (isEffect(result)) {
+        return yield* result
+      }
+      if (isPromise(result)) {
+        return yield* Effect.promise(() => result)
+      }
+      return result
+    })
+}
+
+const buildLayer = (
+  service: any,
+  make: EffectTypes.Effect<any, any, any> | ((...args: Array<any>) => EffectTypes.Effect<any, any, any>),
+  dependencies?: ReadonlyArray<Layer.Layer<any, any, any>>
+) => {
+  const isFactory = typeof make === "function"
+  const depsLayer = dependencies && dependencies.length > 0
+    ? Layer.mergeAll(...(dependencies as NonEmptyDeps<typeof dependencies>))
+    : undefined
+
+  const base = (...args: Array<any>) => {
+    const eff = isFactory ? (make as any)(...args) : make
+    return Layer.effect(service, eff)
+  }
+
+  return depsLayer
+    ? isFactory
+      ? (...args: Array<any>) => Layer.provide(base(...args), depsLayer)
+      : Layer.provide(base(), depsLayer)
+    : isFactory
+    ? (...args: Array<any>) => base(...args)
+    : base()
+}
+
+/**
+ * Extended ServiceClass with layer helpers for services with `make`.
+ *
+ * @since 4.0.0
+ * @category Models
+ */
+export type ServiceWithMake<
+  Self,
+  Id extends string,
+  Shape,
+  Make extends EffectTypes.Effect<any, any, any> | ((...args: any) => EffectTypes.Effect<any, any, any>),
+  Deps extends ReadonlyArray<Layer.Layer<any, any, any>> | undefined
+> = ServiceMap.ServiceClass<Self, Id, Shape> & {
+  readonly make: Make
+  readonly use: <X>(f: (svc: Shape) => X) => LiftToEffect<X>
+  readonly layer: [MakeArgs<Make>] extends [never]
+    ? Deps extends undefined
+      ? Layer.Layer<Self, EffectTypes.Error<MakeEffect<Make>>, Exclude<EffectTypes.Services<MakeEffect<Make>>, Scope>>
+    : Layer.Layer<Self, EffectTypes.Error<MakeEffect<Make>>, DepsContext<Deps>>
+    : Deps extends undefined ? (
+        ...args: MakeArgs<Make>
+      ) => Layer.Layer<
+        Self,
+        EffectTypes.Error<MakeEffect<Make>>,
+        Exclude<EffectTypes.Services<MakeEffect<Make>>, Scope>
+      >
+    : (...args: MakeArgs<Make>) => Layer.Layer<Self, EffectTypes.Error<MakeEffect<Make>>, DepsContext<Deps>>
+  readonly layerWithoutDependencies: Deps extends undefined ? never
+    : [MakeArgs<Make>] extends [never]
+      ? Layer.Layer<Self, EffectTypes.Error<MakeEffect<Make>>, Exclude<EffectTypes.Services<MakeEffect<Make>>, Scope>>
+    : (
+      ...args: MakeArgs<Make>
+    ) => Layer.Layer<Self, EffectTypes.Error<MakeEffect<Make>>, Exclude<EffectTypes.Services<MakeEffect<Make>>, Scope>>
+}
+
+/**
+ * Creates a service with layer helpers when `make` is provided.
+ *
+ * @example
+ * ```ts
+ * import { Service, Effect } from "effect"
+ *
+ * class Logger extends Service<Logger>()("Logger", {
+ *   make: Effect.sync(() => ({ log: (msg: string) => console.log(msg) }))
+ * }) {}
+ *
+ * // Use Logger.layer, Logger.use, etc.
+ * ```
+ *
+ * @since 4.0.0
+ * @category Constructors
+ */
+type ServiceFactory = {
+  // Plain tag (no make)
+  <Identifier, Shape = Identifier>(key: string): ServiceMap.Service<Identifier, Shape>
+  // Curried with explicit Shape; make optional
+  <Self, Shape>(): <
+    const Identifier extends string,
+    E,
+    R = Types.unassigned,
+    Args extends ReadonlyArray<any> = never,
+    Deps extends ReadonlyArray<Layer.Layer<any, any, any>> | undefined = undefined
+  >(
+    id: Identifier,
+    options?: {
+      readonly make?: ((...args: Args) => EffectTypes.Effect<Shape, E, R>) | EffectTypes.Effect<Shape, E, R> | undefined
+      readonly dependencies?: Deps
+    } | undefined
+  ) => [Types.unassigned] extends [R] ? ServiceMap.ServiceClass<Self, Identifier, Shape>
+    : ServiceWithMake<
+      Self,
+      Identifier,
+      Shape,
+      [Args] extends [never] ? EffectTypes.Effect<Shape, E, R> : (...args: Args) => EffectTypes.Effect<Shape, E, R>,
+      Deps
+    >
+  // Curried with inferred Shape; make required
+  <Self>(): <
+    const Identifier extends string,
+    Make extends EffectTypes.Effect<any, any, any> | ((...args: any) => EffectTypes.Effect<any, any, any>),
+    Deps extends ReadonlyArray<Layer.Layer<any, any, any>> | undefined = undefined
+  >(
+    id: Identifier,
+    options: {
+      readonly make: Make
+      readonly dependencies?: Deps
+    }
+  ) => ServiceWithMake<
+    Self,
+    Identifier,
+    Make extends
+      | EffectTypes.Effect<infer _A, infer _E, infer _R>
+      | ((...args: infer _Args) => EffectTypes.Effect<infer _A, infer _E, infer _R>) ? _A
+      : never,
+    Make,
+    Deps
+  >
+}
+
+const ServiceImpl = (...args: Array<any>) => {
+  if (args.length === 0) {
+    const baseService = ServiceMap.Service()
+
+    return function(key: string, options?: {
+      readonly make?: any
+      readonly dependencies?: ReadonlyArray<Layer.Layer<any, any, any>>
+    }) {
+      const service = options?.make
+        ? baseService(key, { make: options.make })
+        : baseService(key)
+
+      if (options?.make) {
+        const deps = options.dependencies
+        type Self = typeof service
+        type Make = typeof options.make
+        type Deps = typeof deps
+
+        const svc = service as Types.Mutable<
+          & ServiceMap.ServiceClass<Self, typeof service.key, typeof service.Service>
+          & Partial<ServiceWithMake<Self, typeof service.key, typeof service.Service, Make, Deps>>
+        >
+
+        svc.layer = buildLayer(svc, options.make, deps) as LayerFromMake<Self, Make, Deps>
+        if (deps && deps.length > 0) {
+          svc.layerWithoutDependencies = buildLayer(svc, options.make) as LayerWithoutDepsFromMake<Self, Make>
+        }
+        svc.use = buildUse(svc) as ServiceWithMake<Self, typeof service.key, typeof service.Service, Make, Deps>["use"]
+      }
+
+      return service
+    }
+  }
+
+  return (ServiceMap.Service as (...fnArgs: Array<any>) => any)(...args)
+}
+
+/**
+ * Layer-aware service constructor with generated `layer`, `layerWithoutDependencies`, and `use` helpers.
+ *
+ * @since 4.0.0
+ */
+export const Service = ServiceImpl as ServiceFactory
diff --git a/packages/effect/src/index.ts b/packages/effect/src/index.ts
@@ -1298,6 +1298,17 @@ export * as ScopedRef from "./ScopedRef.ts"
  *
  * @since 4.0.0
  */
+export {
+  /**
+   * Layer-aware service constructor with automatic helpers.
+   *
+   * @since 4.0.0
+   */
+  Service
+} from "./Service.ts"
+/**
+ * @since 4.0.0
+ */
 export * as ServiceMap from "./ServiceMap.ts"
 
 /**
diff --git a/packages/effect/test/Service.layer.test.ts b/packages/effect/test/Service.layer.test.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"effect": patch
 +---
++
 +Fix Service helper typing so dependency layers eliminate make requirements, add docgen @since for Service exports, and cover dependency elimination with dtslint checks.