ensure HttpApi preserves referential equality of error schemas (#4145)

Effect-TS · Dec 15, 2024 · 883639c · 883639c
1 parent 9e40ece
commit 883639c
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 36 deletions.
diff --git a/.changeset/little-dogs-applaud.md b/.changeset/little-dogs-applaud.md
@@ -0,0 +1,5 @@
+---
+"@effect/platform": patch
+---
+
+ensure HttpApi preserves referential equality of error schemas
diff --git a/packages/platform-node/test/HttpApi.test.ts b/packages/platform-node/test/HttpApi.test.ts
@@ -323,6 +323,7 @@ class UsersApi extends HttpApiGroup.make("users")
       }))
       .addSuccess(User)
       .addError(UserError)
+      .addError(UserError) // ensure errors are deduplicated
   )
   .add(
     HttpApiEndpoint.get("list")`/`

diff --git a/packages/platform/src/HttpApi.ts b/packages/platform/src/HttpApi.ts
@@ -186,9 +186,9 @@ const Proto = {
       groups: this.groups,
       errorSchema: HttpApiSchema.UnionUnify(
         this.errorSchema,
-        schema.annotations(HttpApiSchema.annotations({
-          status: annotations?.status ?? HttpApiSchema.getStatusError(schema)
-        }))
+        annotations?.status
+          ? schema.annotations(HttpApiSchema.annotations({ status: annotations.status }))
+          : schema
       ),
       annotations: this.annotations,
       middlewares: this.middlewares
@@ -207,12 +207,7 @@ const Proto = {
     return makeProto({
       identifier: this.identifier,
       groups: this.groups,
-      errorSchema: HttpApiSchema.UnionUnify(
-        this.errorSchema,
-        tag.failure.annotations(HttpApiSchema.annotations({
-          status: HttpApiSchema.getStatusError(tag.failure)
-        }) as any)
-      ),
+      errorSchema: HttpApiSchema.UnionUnify(this.errorSchema, tag.failure),
       annotations: this.annotations,
       middlewares: new Set([...this.middlewares, tag])
     })

diff --git a/packages/platform/src/HttpApiEndpoint.ts b/packages/platform/src/HttpApiEndpoint.ts
@@ -700,11 +700,9 @@ const Proto = {
     schema: Schema.Schema.Any,
     annotations?: { readonly status?: number }
   ) {
-    schema = schema.pipe(
-      Schema.annotations(HttpApiSchema.annotations({
-        status: annotations?.status ?? HttpApiSchema.getStatusSuccess(schema)
-      }))
-    )
+    schema = annotations?.status ?
+      schema.annotations(HttpApiSchema.annotations({ status: annotations.status })) :
+      schema
     return makeProto({
       ...this,
       successSchema: this.successSchema === HttpApiSchema.NoContent ?
@@ -717,11 +715,7 @@ const Proto = {
       ...this,
       errorSchema: HttpApiSchema.UnionUnify(
         this.errorSchema,
-        schema.pipe(
-          Schema.annotations(HttpApiSchema.annotations({
-            status: annotations?.status ?? HttpApiSchema.getStatusError(schema)
-          }))
-        )
+        annotations?.status ? schema.annotations(HttpApiSchema.annotations({ status: annotations.status })) : schema
       )
     })
   },
@@ -758,14 +752,7 @@ const Proto = {
   middleware(this: HttpApiEndpoint.AnyWithProps, middleware: HttpApiMiddleware.TagClassAny) {
     return makeProto({
       ...this,
-      errorSchema: HttpApiSchema.UnionUnify(
-        this.errorSchema,
-        middleware.failure.pipe(
-          Schema.annotations(HttpApiSchema.annotations({
-            status: HttpApiSchema.getStatusError(middleware.failure)
-          }))
-        )
-      ),
+      errorSchema: HttpApiSchema.UnionUnify(this.errorSchema, middleware.failure),
       middlewares: new Set([...this.middlewares, middleware])
     })
   },

diff --git a/packages/platform/src/HttpApiGroup.ts b/packages/platform/src/HttpApiGroup.ts
@@ -309,9 +309,7 @@ const Proto = {
       endpoints: this.endpoints,
       errorSchema: HttpApiSchema.UnionUnify(
         this.errorSchema,
-        schema.annotations(HttpApiSchema.annotations({
-          status: annotations?.status ?? HttpApiSchema.getStatusError(schema)
-        }))
+        annotations?.status ? schema.annotations(HttpApiSchema.annotations({ status: annotations.status })) : schema
       ),
       annotations: this.annotations,
       middlewares: this.middlewares
@@ -332,12 +330,7 @@ const Proto = {
       identifier: this.identifier,
       topLevel: this.topLevel,
       endpoints: this.endpoints,
-      errorSchema: HttpApiSchema.UnionUnify(
-        this.errorSchema,
-        middleware.failure.annotations(HttpApiSchema.annotations({
-          status: HttpApiSchema.getStatusError(middleware.failure)
-        }) as any)
-      ),
+      errorSchema: HttpApiSchema.UnionUnify(this.errorSchema, middleware.failure),
       annotations: this.annotations,
       middlewares: new Set([...this.middlewares, middleware])
     })