socket protocol utilities for http apis

[harrysolovay]

What is the problem this feature would solve?

Streamline including socket protocols in the client, and parsing socket protocols in http APIs.

What is the feature you are proposing to solve the problem?

Some minimal socket protocol utils.

export const SocketProtocolsKey = "Sec-WebSocket-Protocol" as const

const SocketProtocols = S.String.pipe(
  S.decodeTo(S.Array(S.Trim), {
    decode: SchemaGetter.split({ separator: "," }),
    encode: SchemaGetter.transform((arr) => arr.join(",")),
  }),
)

Ideally there'd also be a requirement that we could optionally provide to any SocketConstructor.

mySocketClient.pipe(
  Layer.provide(Socket.layerWebSocketConstructorGlobal.pipe(Layer.provide(SocketProtocols.layer(["a", "b", "c"]))))
)

And a piece of http middleware for parsing the protocols from an HttpServerRequest.

const handler = Effect.gen(function*() {
  const protocols = yield* SocketProtocols
})

What alternatives have you considered?

No response

[ArjunCodess]

hi, i'd like to work on this.

i'd add a socketprotocols schema that splits sec-websocket-protocol, plus a layer for the constructor and http middleware that yields the parsed list.

should the middleware fail closed if the header is missing, or yield an empty array?

[harrysolovay]

I actually just submitted this yesterday. Would you be willing to provide a review?: #8302

[ArjunCodess]

yeah, left a review on #8302.

schema + the request layer look right. missing header as undefined is actually the nicer fail-open. empty header still becomes [].

the client SocketConstructor layer is still missing, and a,,b will leave a hole in the array. details are on the pr.

i'll drop the claim. this is yours.