can't distinguish between responses with the same (void) schema

[ryskajakub]

What version of Effect is running?

"@effect/platform": "^0.69.25",

What steps can reproduce the bug?

I add endpoint:

    HttpApiEndpoint.get('home', '/')
      .addSuccess(HttpApiSchema.Created)
      .addSuccess(HttpApiSchema.NoContent)

implement it:

.handle('home', () => Effect.succeed(null)

What is the expected behavior?

I should have an option to return something different to trigger the no content response.

What do you see instead?

The handler always returns the Created status

Additional information

I can do some workaround to make it work,

1. Either I can make the second response to be error response and then use Effect.fail
2. Or I can add a distinguishable schema to each response, so the result of handler can be dispatched to the correct status code

[tim-smart]

To allow for multiple empty responses on an endpoint you first have to create a discriminated union to distinguish between the different response types, then "cast" them to empty responses:

import {
  HttpApi,
  HttpApiBuilder,
  HttpApiEndpoint,
  HttpApiGroup,
  HttpApiScalar,
  HttpApiSchema,
  HttpServer
} from "@effect/platform"
import { NodeHttpServer, NodeRuntime } from "@effect/platform-node"
import { Effect, Layer, Schema } from "effect"
import { createServer } from "http"

class NoContent extends Schema.TaggedClass<NoContent>()("NoContent", {}) {}

class ImATeapot extends Schema.TaggedClass<ImATeapot>()("ImATeapot", {}) {}

class EmptyApi extends HttpApiGroup.make("empty").add(
  HttpApiEndpoint.get("no-content", "/no-content")
    .addSuccess(NoContent.pipe(HttpApiSchema.asEmpty({
      status: 204,
      decode: () => new NoContent()
    })))
    .addSuccess(ImATeapot.pipe(HttpApiSchema.asEmpty({
      status: 418,
      decode: () => new ImATeapot()
    })))
) {}

class TopLevelApi extends HttpApi.empty.add(EmptyApi) {}

const EmptyApiLive = HttpApiBuilder.group(
  TopLevelApi,
  "empty",
  (handlers) => handlers.handle("no-content", () => Effect.succeed(new ImATeapot()))
)

const ApiLive = HttpApiBuilder.api(TopLevelApi).pipe(
  Layer.provide(EmptyApiLive)
)

HttpApiBuilder.serve().pipe(
  HttpServer.withLogAddress,
  Layer.provide(HttpApiScalar.layer()),
  Layer.provide(ApiLive),
  Layer.provide(NodeHttpServer.layer(createServer, { port: 3000 })),
  Layer.launch,
  NodeRuntime.runMain
)

[mikearnaldi]

To allow for multiple empty responses on an endpoint you first have to create a discriminated union to distinguish between the different response types, then "cast" them to empty responses:

import {
  HttpApi,
  HttpApiBuilder,
  HttpApiEndpoint,
  HttpApiGroup,
  HttpApiScalar,
  HttpApiSchema,
  HttpServer
} from "@effect/platform"
import { NodeHttpServer, NodeRuntime } from "@effect/platform-node"
import { Effect, Layer, Schema } from "effect"
import { createServer } from "http"

class NoContent extends Schema.TaggedClass<NoContent>()("NoContent", {}) {}

class ImATeapot extends Schema.TaggedClass<ImATeapot>()("ImATeapot", {}) {}

class EmptyApi extends HttpApiGroup.make("empty").add(
  HttpApiEndpoint.get("no-content", "/no-content")
    .addSuccess(NoContent.pipe(HttpApiSchema.asEmpty({
      status: 204,
      decode: () => new NoContent()
    })))
    .addSuccess(ImATeapot.pipe(HttpApiSchema.asEmpty({
      status: 418,
      decode: () => new ImATeapot()
    })))
) {}

class TopLevelApi extends HttpApi.empty.add(EmptyApi) {}

const EmptyApiLive = HttpApiBuilder.group(
  TopLevelApi,
  "empty",
  (handlers) => handlers.handle("no-content", () => Effect.succeed(new ImATeapot()))
)

const ApiLive = HttpApiBuilder.api(TopLevelApi).pipe(
  Layer.provide(EmptyApiLive)
)

HttpApiBuilder.serve().pipe(
  HttpServer.withLogAddress,
  Layer.provide(HttpApiScalar.layer()),
  Layer.provide(ApiLive),
  Layer.provide(NodeHttpServer.layer(createServer, { port: 3000 })),
  Layer.launch,
  NodeRuntime.runMain
)

why not doing this by default?

[tim-smart]

You have to explicitly specify what the status code will rehydrate to.

With the recently added predefined error types in the HttpApiError module it is easier to accomplish now.