@effect/platform 0.80.21 → 0.81.1

package/src/HttpClient.ts

@@ -809,7 +809,7 @@ export const followRedirects: {
 
 /**
  * @since 1.0.0
- * @category fiber refs
+ * @category Tracing
  */
 export const currentTracerDisabledWhen: FiberRef.FiberRef<Predicate.Predicate<ClientRequest.HttpClientRequest>> =
   internal.currentTracerDisabledWhen
@@ -818,31 +818,31 @@ export const currentTracerDisabledWhen: FiberRef.FiberRef<Predicate.Predicate<Cl
  * Disables tracing for specific requests based on a provided predicate.
  *
  * @since 1.0.0
- * @category fiber refs
+ * @category Tracing
  */
 export const withTracerDisabledWhen: {
   /**
    * Disables tracing for specific requests based on a provided predicate.
    *
    * @since 1.0.0
-   * @category fiber refs
+   * @category Tracing
    */
-  (predicate: Predicate.Predicate<ClientRequest.HttpClientRequest>): <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E, R>
+  (predicate: Predicate.Predicate<ClientRequest.HttpClientRequest>): <E, R>(self: HttpClient.With<E, R>) => HttpClient.With<E, R>
   /**
    * Disables tracing for specific requests based on a provided predicate.
    *
    * @since 1.0.0
-   * @category fiber refs
+   * @category Tracing
    */
-  <A, E, R>(
-    effect: Effect.Effect<A, E, R>,
+  <E, R>(
+    self: HttpClient.With<E, R>,
     predicate: Predicate.Predicate<ClientRequest.HttpClientRequest>
-  ): Effect.Effect<A, E, R>
+  ): HttpClient.With<E, R>
 } = internal.withTracerDisabledWhen
 
 /**
  * @since 1.0.0
- * @category fiber refs
+ * @category Tracing
  */
 export const currentTracerPropagation: FiberRef.FiberRef<boolean> = internal.currentTracerPropagation
 
@@ -850,23 +850,23 @@ export const currentTracerPropagation: FiberRef.FiberRef<boolean> = internal.cur
  * Enables or disables tracing propagation for the request.
  *
  * @since 1.0.0
- * @category fiber refs
+ * @category Tracing
  */
 export const withTracerPropagation: {
   /**
    * Enables or disables tracing propagation for the request.
    *
    * @since 1.0.0
-   * @category fiber refs
+   * @category Tracing
    */
-  (enabled: boolean): <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E, R>
+  (enabled: boolean): <E, R>(self: HttpClient.With<E, R>) => HttpClient.With<E, R>
   /**
    * Enables or disables tracing propagation for the request.
    *
    * @since 1.0.0
-   * @category fiber refs
+   * @category Tracing
    */
-  <A, E, R>(effect: Effect.Effect<A, E, R>, enabled: boolean): Effect.Effect<A, E, R>
+  <E, R>(self: HttpClient.With<E, R>, enabled: boolean): HttpClient.With<E, R>
 } = internal.withTracerPropagation
 
 /**
@@ -875,3 +875,97 @@ export const withTracerPropagation: {
 export const layerMergedContext: <E, R>(
   effect: Effect.Effect<HttpClient, E, R>
 ) => Layer<HttpClient, E, R> = internal.layerMergedContext
+
+/**
+ * @since 1.0.0
+ * @category Tracing
+ */
+export interface SpanNameGenerator {
+  readonly _: unique symbol
+}
+
+/**
+ * @since 1.0.0
+ * @category Tracing
+ */
+export const SpanNameGenerator: Context.Reference<
+  SpanNameGenerator,
+  (request: ClientRequest.HttpClientRequest) => string
+> = internal.SpanNameGenerator
+
+/**
+ * Customizes the span names for tracing.
+ *
+ * ```ts
+ * import { FetchHttpClient, HttpClient } from "@effect/platform"
+ * import { NodeRuntime } from "@effect/platform-node"
+ * import { Effect } from "effect"
+ *
+ * Effect.gen(function* () {
+ *   const client = (yield* HttpClient.HttpClient).pipe(
+ *     // Customize the span names for this HttpClient
+ *     HttpClient.withSpanNameGenerator(
+ *       (request) => `http.client ${request.method} ${request.url}`
+ *     )
+ *   )
+ *
+ *   yield* client.get("https://jsonplaceholder.typicode.com/posts/1")
+ * }).pipe(Effect.provide(FetchHttpClient.layer), NodeRuntime.runMain)
+ * ```
+ *
+ * @since 1.0.0
+ * @category Tracing
+ */
+export const withSpanNameGenerator: {
+  /**
+   * Customizes the span names for tracing.
+   *
+   * ```ts
+   * import { FetchHttpClient, HttpClient } from "@effect/platform"
+   * import { NodeRuntime } from "@effect/platform-node"
+   * import { Effect } from "effect"
+   *
+   * Effect.gen(function* () {
+   *   const client = (yield* HttpClient.HttpClient).pipe(
+   *     // Customize the span names for this HttpClient
+   *     HttpClient.withSpanNameGenerator(
+   *       (request) => `http.client ${request.method} ${request.url}`
+   *     )
+   *   )
+   *
+   *   yield* client.get("https://jsonplaceholder.typicode.com/posts/1")
+   * }).pipe(Effect.provide(FetchHttpClient.layer), NodeRuntime.runMain)
+   * ```
+   *
+   * @since 1.0.0
+   * @category Tracing
+   */
+  (f: (request: ClientRequest.HttpClientRequest) => string): <E, R>(self: HttpClient.With<E, R>) => HttpClient.With<E, R>
+  /**
+   * Customizes the span names for tracing.
+   *
+   * ```ts
+   * import { FetchHttpClient, HttpClient } from "@effect/platform"
+   * import { NodeRuntime } from "@effect/platform-node"
+   * import { Effect } from "effect"
+   *
+   * Effect.gen(function* () {
+   *   const client = (yield* HttpClient.HttpClient).pipe(
+   *     // Customize the span names for this HttpClient
+   *     HttpClient.withSpanNameGenerator(
+   *       (request) => `http.client ${request.method} ${request.url}`
+   *     )
+   *   )
+   *
+   *   yield* client.get("https://jsonplaceholder.typicode.com/posts/1")
+   * }).pipe(Effect.provide(FetchHttpClient.layer), NodeRuntime.runMain)
+   * ```
+   *
+   * @since 1.0.0
+   * @category Tracing
+   */
+  <E, R>(
+    self: HttpClient.With<E, R>,
+    f: (request: ClientRequest.HttpClientRequest) => string
+  ): HttpClient.With<E, R>
+} = internal.withSpanNameGenerator

package/src/HttpMiddleware.ts

@@ -1,6 +1,7 @@
 /**
  * @since 1.0.0
  */
+import type * as Context from "effect/Context"
 import type * as Effect from "effect/Effect"
 import type * as FiberRef from "effect/FiberRef"
 import type * as Layer from "effect/Layer"
@@ -149,3 +150,112 @@ export const cors: (
     readonly credentials?: boolean | undefined
   } | undefined
 ) => <E, R>(httpApp: App.Default<E, R>) => App.Default<E, R> = internal.cors
+
+/**
+ * @since 1.0.0
+ * @category Tracing
+ */
+export interface SpanNameGenerator {
+  readonly _: unique symbol
+}
+
+/**
+ * @since 1.0.0
+ * @category Tracing
+ */
+export const SpanNameGenerator: Context.Reference<
+  SpanNameGenerator,
+  (request: ServerRequest.HttpServerRequest) => string
+> = internal.SpanNameGenerator
+
+/**
+ * Customizes the span name for the http app.
+ *
+ * ```ts
+ * import {
+ *   HttpMiddleware,
+ *   HttpRouter,
+ *   HttpServer,
+ *   HttpServerResponse
+ * } from "@effect/platform"
+ * import { NodeHttpServer, NodeRuntime } from "@effect/platform-node"
+ * import { Layer } from "effect"
+ * import { createServer } from "http"
+ *
+ * HttpRouter.empty.pipe(
+ *   HttpRouter.get("/", HttpServerResponse.empty()),
+ *   HttpServer.serve(),
+ *   // Customize the span names for this HttpApp
+ *   HttpMiddleware.withSpanNameGenerator((request) => `GET ${request.url}`),
+ *   Layer.provide(NodeHttpServer.layer(createServer, { port: 3000 })),
+ *   Layer.launch,
+ *   NodeRuntime.runMain
+ * )
+ * ```
+ *
+ * @since 1.0.0
+ * @category Tracing
+ */
+export const withSpanNameGenerator: {
+  /**
+   * Customizes the span name for the http app.
+   *
+   * ```ts
+   * import {
+   *   HttpMiddleware,
+   *   HttpRouter,
+   *   HttpServer,
+   *   HttpServerResponse
+   * } from "@effect/platform"
+   * import { NodeHttpServer, NodeRuntime } from "@effect/platform-node"
+   * import { Layer } from "effect"
+   * import { createServer } from "http"
+   *
+   * HttpRouter.empty.pipe(
+   *   HttpRouter.get("/", HttpServerResponse.empty()),
+   *   HttpServer.serve(),
+   *   // Customize the span names for this HttpApp
+   *   HttpMiddleware.withSpanNameGenerator((request) => `GET ${request.url}`),
+   *   Layer.provide(NodeHttpServer.layer(createServer, { port: 3000 })),
+   *   Layer.launch,
+   *   NodeRuntime.runMain
+   * )
+   * ```
+   *
+   * @since 1.0.0
+   * @category Tracing
+   */
+  (f: (request: ServerRequest.HttpServerRequest) => string): <A, E, R>(layer: Layer.Layer<A, E, R>) => Layer.Layer<A, E, R>
+  /**
+   * Customizes the span name for the http app.
+   *
+   * ```ts
+   * import {
+   *   HttpMiddleware,
+   *   HttpRouter,
+   *   HttpServer,
+   *   HttpServerResponse
+   * } from "@effect/platform"
+   * import { NodeHttpServer, NodeRuntime } from "@effect/platform-node"
+   * import { Layer } from "effect"
+   * import { createServer } from "http"
+   *
+   * HttpRouter.empty.pipe(
+   *   HttpRouter.get("/", HttpServerResponse.empty()),
+   *   HttpServer.serve(),
+   *   // Customize the span names for this HttpApp
+   *   HttpMiddleware.withSpanNameGenerator((request) => `GET ${request.url}`),
+   *   Layer.provide(NodeHttpServer.layer(createServer, { port: 3000 })),
+   *   Layer.launch,
+   *   NodeRuntime.runMain
+   * )
+   * ```
+   *
+   * @since 1.0.0
+   * @category Tracing
+   */
+  <A, E, R>(
+    layer: Layer.Layer<A, E, R>,
+    f: (request: ServerRequest.HttpServerRequest) => string
+  ): Layer.Layer<A, E, R>
+} = internal.withSpanNameGenerator

package/src/internal/httpClient.ts

@@ -44,12 +44,12 @@ export const currentTracerDisabledWhen = globalValue(
 export const withTracerDisabledWhen = dual<
   (
     predicate: Predicate.Predicate<ClientRequest.HttpClientRequest>
-  ) => <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E, R>,
-  <A, E, R>(
-    effect: Effect.Effect<A, E, R>,
+  ) => <E, R>(self: Client.HttpClient.With<E, R>) => Client.HttpClient.With<E, R>,
+  <E, R>(
+    self: Client.HttpClient.With<E, R>,
     predicate: Predicate.Predicate<ClientRequest.HttpClientRequest>
-  ) => Effect.Effect<A, E, R>
->(2, (self, pred) => Effect.locally(self, currentTracerDisabledWhen, pred))
+  ) => Client.HttpClient.With<E, R>
+>(2, (self, pred) => transformResponse(self, Effect.locally(currentTracerDisabledWhen, pred)))
 
 /** @internal */
 export const currentTracerPropagation = globalValue(
@@ -61,12 +61,31 @@ export const currentTracerPropagation = globalValue(
 export const withTracerPropagation = dual<
   (
     enabled: boolean
-  ) => <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E, R>,
-  <A, E, R>(
-    effect: Effect.Effect<A, E, R>,
+  ) => <E, R>(self: Client.HttpClient.With<E, R>) => Client.HttpClient.With<E, R>,
+  <E, R>(
+    self: Client.HttpClient.With<E, R>,
     enabled: boolean
-  ) => Effect.Effect<A, E, R>
->(2, (self, enabled) => Effect.locally(self, currentTracerPropagation, enabled))
+  ) => Client.HttpClient.With<E, R>
+>(2, (self, enabled) => transformResponse(self, Effect.locally(currentTracerPropagation, enabled)))
+
+/** @internal */
+export const SpanNameGenerator = Context.Reference<Client.SpanNameGenerator>()(
+  "@effect/platform/HttpClient/SpanNameGenerator",
+  {
+    defaultValue: () => (request: ClientRequest.HttpClientRequest) => `http.client ${request.method}`
+  }
+)
+
+/** @internal */
+export const withSpanNameGenerator = dual<
+  (
+    f: (request: ClientRequest.HttpClientRequest) => string
+  ) => <E, R>(self: Client.HttpClient.With<E, R>) => Client.HttpClient.With<E, R>,
+  <E, R>(
+    self: Client.HttpClient.With<E, R>,
+    f: (request: ClientRequest.HttpClientRequest) => string
+  ) => Client.HttpClient.With<E, R>
+>(2, (self, f) => transformResponse(self, Effect.provideService(SpanNameGenerator, f)))
 
 const ClientProto = {
   [TypeId]: TypeId,
@@ -193,8 +212,9 @@ export const make = (
             })
           )
         }
+        const nameGenerator = Context.get(fiber.currentContext, SpanNameGenerator)
         return Effect.useSpan(
-          `http.client ${request.method}`,
+          nameGenerator(request),
           { kind: "client", captureStackTrace: false },
           (span) => {
             span.attribute("http.request.method", request.method)

package/src/internal/httpMiddleware.ts

@@ -72,6 +72,25 @@ export const withTracerDisabledForUrls = dual<
   ) => Layer.Layer<A, E, R>
 >(2, (self, urls) => Layer.locally(self, currentTracerDisabledWhen, (req) => urls.includes(req.url)))
 
+/** @internal */
+export const SpanNameGenerator = Context.Reference<Middleware.SpanNameGenerator>()(
+  "@effect/platform/HttpMiddleware/SpanNameGenerator",
+  {
+    defaultValue: () => (request: ServerRequest.HttpServerRequest) => `http.server ${request.method}`
+  }
+)
+
+/** @internal */
+export const withSpanNameGenerator = dual<
+  (
+    f: (request: ServerRequest.HttpServerRequest) => string
+  ) => <A, E, R>(layer: Layer.Layer<A, E, R>) => Layer.Layer<A, E, R>,
+  <A, E, R>(
+    layer: Layer.Layer<A, E, R>,
+    f: (request: ServerRequest.HttpServerRequest) => string
+  ) => Layer.Layer<A, E, R>
+>(2, (self, f) => Layer.provide(self, Layer.succeed(SpanNameGenerator, f)))
+
 /** @internal */
 export const logger = make((httpApp) => {
   let counter = 0
@@ -121,8 +140,9 @@ export const tracer = make((httpApp) =>
     }
     const redactedHeaderNames = fiber.getFiberRef(Headers.currentRedactedNames)
     const redactedHeaders = Headers.redact(request.headers, redactedHeaderNames)
+    const nameGenerator = Context.get(fiber.currentContext, SpanNameGenerator)
     return Effect.useSpan(
-      `http.server ${request.method}`,
+      nameGenerator(request),
       {
         parent: Option.getOrUndefined(TraceContext.fromHeaders(request.headers)),
         kind: "server",