@effect/platform 0.69.1 → 0.69.3

package/src/OpenApi.ts

@@ -2,6 +2,7 @@
  * @since 1.0.0
  */
 import * as Context from "effect/Context"
+import { globalValue } from "effect/GlobalValue"
 import * as HashSet from "effect/HashSet"
 import * as Option from "effect/Option"
 import type { ReadonlyRecord } from "effect/Record"
@@ -58,70 +59,76 @@ export class ExternalDocs
  * @category annotations
  */
 export class Servers
-  extends Context.Tag("@effect/platform/OpenApi/Servers")<ExternalDocs, ReadonlyArray<OpenAPISpecServer>>()
+  extends Context.Tag("@effect/platform/OpenApi/Servers")<Servers, ReadonlyArray<OpenAPISpecServer>>()
 {}
 
 /**
  * @since 1.0.0
  * @category annotations
  */
-export class Override extends Context.Tag("@effect/platform/OpenApi/Override")<Override, Record<string, unknown>>() {}
+export class Format extends Context.Tag("@effect/platform/OpenApi/Format")<Format, string>() {}
 
 /**
  * @since 1.0.0
  * @category annotations
  */
-export const annotations = (annotations: {
-  readonly identifier?: string | undefined
-  readonly title?: string | undefined
-  readonly description?: string | undefined
-  readonly version?: string | undefined
-  readonly license?: OpenAPISpecLicense | undefined
-  readonly externalDocs?: OpenAPISpecExternalDocs | undefined
-  readonly servers?: ReadonlyArray<OpenAPISpecServer> | undefined
-  readonly override?: Record<string, unknown> | undefined
-}): Context.Context<never> => {
-  let context = Context.empty()
-  if (annotations.identifier !== undefined) {
-    context = Context.add(context, Identifier, annotations.identifier)
-  }
-  if (annotations.title !== undefined) {
-    context = Context.add(context, Title, annotations.title)
-  }
-  if (annotations.description !== undefined) {
-    context = Context.add(context, Description, annotations.description)
-  }
-  if (annotations.version !== undefined) {
-    context = Context.add(context, Version, annotations.version)
-  }
-  if (annotations.license !== undefined) {
-    context = Context.add(context, License, annotations.license)
-  }
-  if (annotations.externalDocs !== undefined) {
-    context = Context.add(context, ExternalDocs, annotations.externalDocs)
-  }
-  if (annotations.servers !== undefined) {
-    context = Context.add(context, Servers, annotations.servers)
+export class Override extends Context.Tag("@effect/platform/OpenApi/Override")<Override, Record<string, unknown>>() {}
+
+const contextPartial = <Tags extends Record<string, Context.Tag<any, any>>>(tags: Tags): (
+  options: {
+    readonly [K in keyof Tags]?: Context.Tag.Service<Tags[K]> | undefined
   }
-  if (annotations.override !== undefined) {
-    context = Context.add(context, Override, annotations.override)
+) => Context.Context<never> => {
+  const entries = Object.entries(tags)
+  return (options) => {
+    let context = Context.empty()
+    for (const [key, tag] of entries) {
+      if (options[key] !== undefined) {
+        context = Context.add(context, tag, options[key]!)
+      }
+    }
+    return context
   }
-  return context
 }
 
 /**
  * @since 1.0.0
  * @category annotations
  */
-export interface Annotatable {
-  readonly annotations: Context.Context<never>
-}
+export const annotations: (
+  options: {
+    readonly identifier?: string | undefined
+    readonly title?: string | undefined
+    readonly version?: string | undefined
+    readonly description?: string | undefined
+    readonly license?: OpenAPISpecLicense | undefined
+    readonly externalDocs?: OpenAPISpecExternalDocs | undefined
+    readonly servers?: ReadonlyArray<OpenAPISpecServer> | undefined
+    readonly format?: string | undefined
+    readonly override?: Record<string, unknown> | undefined
+  }
+) => Context.Context<never> = contextPartial({
+  identifier: Identifier,
+  title: Title,
+  version: Version,
+  description: Description,
+  license: License,
+  externalDocs: ExternalDocs,
+  servers: Servers,
+  format: Format,
+  override: Override
+})
+
+const apiCache = globalValue("@effect/platform/OpenApi/apiCache", () => new WeakMap<HttpApi.HttpApi.Any, OpenAPISpec>())
 
 /**
  * @category constructors
  * @since 1.0.0
  */
 export const fromApi = <A extends HttpApi.HttpApi.Any>(self: A): OpenAPISpec => {
+  if (apiCache.has(self)) {
+    return apiCache.get(self)!
+  }
   const api = self as unknown as HttpApi.HttpApi.AnyWithProps
   const jsonSchemaDefs: Record<string, JsonSchema.JsonSchema> = {}
   const spec: DeepMutable<OpenAPISpec> = {
@@ -145,17 +152,14 @@ export const fromApi = <A extends HttpApi.HttpApi.Any>(self: A): OpenAPISpec =>
     })
   }
   function registerSecurity(
-    tag: HttpApiMiddleware.TagClassSecurityAny,
     name: string,
     security: HttpApiSecurity
-  ): string {
-    const id = `${tag.key}/${name}`
-    if (spec.components!.securitySchemes![id]) {
-      return id
+  ) {
+    if (spec.components!.securitySchemes![name]) {
+      return
     }
     const scheme = makeSecurityScheme(security)
-    spec.components!.securitySchemes![id] = scheme
-    return id
+    spec.components!.securitySchemes![name] = scheme
   }
   Option.map(Context.getOption(api.annotations, Description), (description) => {
     spec.info.description = description
@@ -174,10 +178,8 @@ export const fromApi = <A extends HttpApi.HttpApi.Any>(self: A): OpenAPISpec =>
       return
     }
     for (const [name, security] of Object.entries(middleware.security)) {
-      const id = registerSecurity(middleware, name, security)
-      spec.security!.push({
-        [id]: []
-      })
+      registerSecurity(name, security)
+      spec.security!.push({ [name]: [] })
     }
   })
   HttpApi.reflect(api as any, {
@@ -221,10 +223,8 @@ export const fromApi = <A extends HttpApi.HttpApi.Any>(self: A): OpenAPISpec =>
           return
         }
         for (const [name, security] of Object.entries(middleware.security)) {
-          const id = registerSecurity(middleware, name, security)
-          op.security!.push({
-            [id]: []
-          })
+          registerSecurity(name, security)
+          op.security!.push({ [name]: [] })
         }
       })
       endpoint.payloadSchema.pipe(
@@ -334,6 +334,8 @@ export const fromApi = <A extends HttpApi.HttpApi.Any>(self: A): OpenAPISpec =>
     }
   })
 
+  apiCache.set(self, spec)
+
   return spec
 }
 
@@ -351,10 +353,15 @@ const makeSecurityScheme = (security: HttpApiSecurity): OpenAPISecurityScheme =>
       }
     }
     case "Bearer": {
+      const format = Context.getOption(security.annotations, Format).pipe(
+        Option.map((format) => ({ bearerFormat: format })),
+        Option.getOrUndefined
+      )
       return {
         ...meta,
         type: "http",
-        scheme: "bearer"
+        scheme: "bearer",
+        ...format
       }
     }
     case "ApiKey": {

package/src/internal/httpMiddleware.ts

@@ -76,8 +76,7 @@ export const withTracerDisabledForUrls = dual<
 export const logger = make((httpApp) => {
   let counter = 0
   return Effect.withFiberRuntime((fiber) => {
-    const context = fiber.getFiberRef(FiberRef.currentContext)
-    const request = Context.unsafeGet(context, ServerRequest.HttpServerRequest)
+    const request = Context.unsafeGet(fiber.currentContext, ServerRequest.HttpServerRequest)
     return Effect.withLogSpan(
       Effect.flatMap(Effect.exit(httpApp), (exit) => {
         if (fiber.getFiberRef(loggerDisabled)) {
@@ -110,8 +109,7 @@ export const logger = make((httpApp) => {
 /** @internal */
 export const tracer = make((httpApp) =>
   Effect.withFiberRuntime((fiber) => {
-    const context = fiber.getFiberRef(FiberRef.currentContext)
-    const request = Context.unsafeGet(context, ServerRequest.HttpServerRequest)
+    const request = Context.unsafeGet(fiber.currentContext, ServerRequest.HttpServerRequest)
     const disabled = fiber.getFiberRef(currentTracerDisabledWhen)(request)
     if (disabled) {
       return httpApp
@@ -303,8 +301,7 @@ export const cors = (options?: {
 
   return <E, R>(httpApp: App.Default<E, R>): App.Default<E, R> =>
     Effect.withFiberRuntime((fiber) => {
-      const context = fiber.getFiberRef(FiberRef.currentContext)
-      const request = Context.unsafeGet(context, ServerRequest.HttpServerRequest)
+      const request = Context.unsafeGet(fiber.currentContext, ServerRequest.HttpServerRequest)
       if (request.method === "OPTIONS") {
         return Effect.succeed(ServerResponse.empty({
           status: 204,