H-3617: harpc: Implement TypeScript wire-protocol codec (#5686)

hashintel · Nov 22, 2024 · 74098e6 · 74098e6
1 parent 8bd2f22
commit 74098e6
Show file tree

Hide file tree

Showing 29 changed files with 334 additions and 6 deletions.
diff --git a/libs/@local/harpc/client/typescript/src/types/ErrorCode.ts b/libs/@local/harpc/client/typescript/src/types/ErrorCode.ts
@@ -95,6 +95,8 @@ export const make = (
   }
 };
 
+export type EncodeError = Effect.Effect.Error<ReturnType<typeof encode>>;
+
 export const encode = encodeDual(
   (buffer: Buffer.WriteBuffer, errorCode: ErrorCode) =>
     Buffer.putU16(buffer, errorCode.value),

diff --git a/libs/@local/harpc/client/typescript/src/types/ProcedureDescriptor.ts b/libs/@local/harpc/client/typescript/src/types/ProcedureDescriptor.ts
@@ -69,11 +69,15 @@ const ProcedureDescriptorProto: Omit<ProcedureDescriptor, "id"> = {
 export const make = (id: ProcedureId.ProcedureId): ProcedureDescriptor =>
   createProto(ProcedureDescriptorProto, { id });
 
+export type EncodeError = Effect.Effect.Error<ReturnType<typeof encode>>;
+
 export const encode = encodeDual(
   (buffer: Buffer.WriteBuffer, descriptor: ProcedureDescriptor) =>
     ProcedureId.encode(buffer, descriptor.id),
 );
 
+export type DecodeError = Effect.Effect.Error<ReturnType<typeof decode>>;
+
 export const decode = (buffer: Buffer.ReadBuffer) =>
   ProcedureId.decode(buffer).pipe(Effect.map(make));
 

diff --git a/libs/@local/harpc/client/typescript/src/types/ProcedureId.ts b/libs/@local/harpc/client/typescript/src/types/ProcedureId.ts
@@ -100,11 +100,15 @@ export const make = (
   return Effect.succeed(makeUnchecked(id));
 };
 
+export type EncodeError = Effect.Effect.Error<ReturnType<typeof encode>>;
+
 export const encode = encodeDual(
   (buffer: Buffer.WriteBuffer, procedureId: ProcedureId) =>
     Buffer.putU16(buffer, procedureId.value),
 );
 
+export type DecodeError = Effect.Effect.Error<ReturnType<typeof decode>>;
+
 export const decode = (buffer: Buffer.ReadBuffer) =>
   Buffer.getU16(buffer).pipe(Effect.map(makeUnchecked));
 

diff --git a/libs/@local/harpc/client/typescript/src/types/ResponseKind.ts b/libs/@local/harpc/client/typescript/src/types/ResponseKind.ts
@@ -121,6 +121,8 @@ export const err = (code: ErrorCode.ErrorCode): Err =>
 
 export type ResponseKind = Ok | Err;
 
+export type EncodeError = Effect.Effect.Error<ReturnType<typeof encode>>;
+
 export const encode = encodeDual(
   (buffer: Buffer.WriteBuffer, kind: ResponseKind) =>
     Effect.gen(function* () {
@@ -133,6 +135,8 @@ export const encode = encodeDual(
     }),
 );
 
+export type DecodeError = Effect.Effect.Error<ReturnType<typeof decode>>;
+
 export const decode = (buffer: Buffer.ReadBuffer) =>
   Effect.gen(function* () {
     const value = yield* Buffer.getU16(buffer);

diff --git a/libs/@local/harpc/client/typescript/src/types/SubsystemDescriptor.ts b/libs/@local/harpc/client/typescript/src/types/SubsystemDescriptor.ts
@@ -79,6 +79,8 @@ export const make = (
 ): SubsystemDescriptor =>
   createProto(SubsystemDescriptorProto, { id, version });
 
+export type EncodeError = Effect.Effect.Error<ReturnType<typeof encode>>;
+
 export const encode = encodeDual(
   (buffer: Buffer.WriteBuffer, descriptor: SubsystemDescriptor) =>
     pipe(
@@ -88,6 +90,8 @@ export const encode = encodeDual(
     ),
 );
 
+export type DecodeError = Effect.Effect.Error<ReturnType<typeof decode>>;
+
 export const decode = (buffer: Buffer.ReadBuffer) =>
   Effect.gen(function* () {
     const id = yield* SubsystemId.decode(buffer);

diff --git a/libs/@local/harpc/client/typescript/src/types/SubsystemId.ts b/libs/@local/harpc/client/typescript/src/types/SubsystemId.ts
@@ -101,11 +101,15 @@ export const make = (
   return Effect.succeed(makeUnchecked(id));
 };
 
+export type EncodeError = Effect.Effect.Error<ReturnType<typeof encode>>;
+
 export const encode = encodeDual(
   (buffer: Buffer.WriteBuffer, subsystemId: SubsystemId) =>
     Buffer.putU16(buffer, subsystemId.value),
 );
 
+export type DecodeError = Effect.Effect.Error<ReturnType<typeof decode>>;
+
 export const decode = (buffer: Buffer.ReadBuffer) =>
   Buffer.getU16(buffer).pipe(Effect.map(makeUnchecked));
 

diff --git a/libs/@local/harpc/client/typescript/src/types/Version.ts b/libs/@local/harpc/client/typescript/src/types/Version.ts
@@ -75,6 +75,8 @@ const VersionProto: Omit<Version, "major" | "minor"> = {
 export const make = (major: number, minor: number): Version =>
   createProto(VersionProto, { major, minor });
 
+export type EncodeError = Effect.Effect.Error<ReturnType<typeof encode>>;
+
 export const encode: {
   (version: Version): (buffer: Buffer.WriteBuffer) => Buffer.WriteResult;
   (buffer: Buffer.WriteBuffer, version: Version): Buffer.WriteResult;
@@ -87,6 +89,8 @@ export const encode: {
   }),
 );
 
+export type DecodeError = Effect.Effect.Error<ReturnType<typeof decode>>;
+
 export const decode = (buffer: Buffer.ReadBuffer) =>
   Effect.gen(function* () {
     const major = yield* Buffer.getU8(buffer);

diff --git a/libs/@local/harpc/client/typescript/src/wire-protocol/Buffer.ts b/libs/@local/harpc/client/typescript/src/wire-protocol/Buffer.ts
@@ -273,5 +273,5 @@ export const take = (buffer: Buffer<Write>) =>
     const impl = buffer as unknown as BufferImpl<Write>;
 
     const inner = impl.value.buffer.slice(0, currentLength);
-    return new Uint8Array(inner);
+    return inner;
   });
diff --git a/libs/@local/harpc/client/typescript/src/wire-protocol/models/Payload.ts b/libs/@local/harpc/client/typescript/src/wire-protocol/models/Payload.ts
@@ -128,6 +128,8 @@ export const make = (
   return Effect.succeed(makeUnchecked(buffer));
 };
 
+export type EncodeError = Effect.Effect.Error<ReturnType<typeof encode>>;
+
 export const encode = encodeDual(
   (buffer: Buffer.WriteBuffer, payload: Payload) =>
     Effect.gen(function* () {
@@ -138,6 +140,8 @@ export const encode = encodeDual(
     }),
 );
 
+export type DecodeError = Effect.Effect.Error<ReturnType<typeof decode>>;
+
 export const decode = (buffer: Buffer.ReadBuffer) =>
   Effect.gen(function* () {
     const length = yield* Buffer.getU16(buffer);

diff --git a/libs/@local/harpc/client/typescript/src/wire-protocol/models/Protocol.ts b/libs/@local/harpc/client/typescript/src/wire-protocol/models/Protocol.ts
@@ -80,6 +80,8 @@ const MAGIC = new Uint8Array([
   0x68 /* h */, 0x61 /* a */, 0x72 /* r */, 0x70 /* p */, 0x63 /* c */,
 ]);
 
+export type EncodeError = Effect.Effect.Error<ReturnType<typeof encode>>;
+
 export const encode = encodeDual(
   (buffer: Buffer.WriteBuffer, protocol: Protocol): Buffer.WriteResult => {
     return pipe(
@@ -90,6 +92,8 @@ export const encode = encodeDual(
   },
 );
 
+export type DecodeError = Effect.Effect.Error<ReturnType<typeof decode>>;
+
 export const decode = (buffer: Buffer.ReadBuffer) =>
   Effect.gen(function* () {
     const magic = yield* Buffer.getSlice(buffer, 5);

diff --git a/libs/@local/harpc/client/typescript/src/wire-protocol/models/ProtocolVersion.ts b/libs/@local/harpc/client/typescript/src/wire-protocol/models/ProtocolVersion.ts
@@ -85,6 +85,8 @@ export const encode = encodeDual(
   },
 );
 
+export type DecodeError = Effect.Effect.Error<ReturnType<typeof decode>>;
+
 export const decode = (buffer: Buffer.ReadBuffer) =>
   Effect.gen(function* () {
     const version = yield* Buffer.getU8(buffer);

diff --git a/libs/@local/harpc/client/typescript/src/wire-protocol/models/index.ts b/libs/@local/harpc/client/typescript/src/wire-protocol/models/index.ts
@@ -1,4 +1,7 @@
 /* eslint-disable canonical/filename-no-index */
 
+export * as Payload from "./Payload.js";
+export * as Protocol from "./Protocol.js";
+export * as ProtocolVersion from "./ProtocolVersion.js";
 export * as request from "./request/index.js";
 export * as response from "./response/index.js";
diff --git a/libs/@local/harpc/client/typescript/src/wire-protocol/models/request/Request.ts b/libs/@local/harpc/client/typescript/src/wire-protocol/models/request/Request.ts
@@ -92,6 +92,8 @@ export const prepare = (self: Request) => {
   return make(header, self.body);
 };
 
+export type EncodeError = Effect.Effect.Error<ReturnType<typeof encode>>;
+
 export const encode = encodeDual(
   (buffer: Buffer.WriteBuffer, request: Request) =>
     Effect.gen(function* () {
@@ -105,6 +107,8 @@ export const encode = encodeDual(
     }),
 );
 
+export type DecodeError = Effect.Effect.Error<ReturnType<typeof decode>>;
+
 export const decode = (buffer: Buffer.ReadBuffer) =>
   Effect.gen(function* () {
     const header = yield* RequestHeader.decode(buffer);

diff --git a/libs/@local/harpc/client/typescript/src/wire-protocol/models/request/RequestBegin.ts b/libs/@local/harpc/client/typescript/src/wire-protocol/models/request/RequestBegin.ts
@@ -89,6 +89,8 @@ export const make = (
 ): RequestBegin =>
   createProto(RequestBeginProto, { subsystem, procedure, payload });
 
+export type EncodeError = Effect.Effect.Error<ReturnType<typeof encode>>;
+
 export const encode = encodeDual(
   (buffer: Buffer.WriteBuffer, begin: RequestBegin) =>
     pipe(
@@ -100,6 +102,8 @@ export const encode = encodeDual(
     ),
 );
 
+export type DecodeError = Effect.Effect.Error<ReturnType<typeof decode>>;
+
 export const decode = (buffer: Buffer.ReadBuffer) =>
   Effect.gen(function* () {
     const subsystem = yield* SubsystemDescriptor.decode(buffer);

diff --git a/libs/@local/harpc/client/typescript/src/wire-protocol/models/request/RequestBody.ts b/libs/@local/harpc/client/typescript/src/wire-protocol/models/request/RequestBody.ts
@@ -105,6 +105,8 @@ export const match: {
     }),
 );
 
+export type EncodeError = Effect.Effect.Error<ReturnType<typeof encode>>;
+
 export const encode = encodeDual(
   (buffer: Buffer.WriteBuffer, body: RequestBody) =>
     match(body, {
@@ -113,6 +115,8 @@ export const encode = encodeDual(
     }),
 );
 
+export type DecodeError = Effect.Effect.Error<ReturnType<typeof decode>>;
+
 export const decode = (
   buffer: Buffer.ReadBuffer,
   variant: RequestBodyVariant,

diff --git a/libs/@local/harpc/client/typescript/src/wire-protocol/models/request/RequestFlags.ts b/libs/@local/harpc/client/typescript/src/wire-protocol/models/request/RequestFlags.ts
@@ -102,6 +102,8 @@ export const repr = (flags: RequestFlags) => {
   return value;
 };
 
+export type EncodeError = Effect.Effect.Error<ReturnType<typeof encode>>;
+
 export const encode = encodeDual(
   (buffer: Buffer.WriteBuffer, flags: RequestFlags) =>
     Effect.gen(function* () {
@@ -111,6 +113,8 @@ export const encode = encodeDual(
     }),
 );
 
+export type DecodeError = Effect.Effect.Error<ReturnType<typeof decode>>;
+
 export const decode = (buffer: Buffer.ReadBuffer) =>
   Effect.gen(function* () {
     const value = yield* Buffer.getU8(buffer);

diff --git a/libs/@local/harpc/client/typescript/src/wire-protocol/models/request/RequestFrame.ts b/libs/@local/harpc/client/typescript/src/wire-protocol/models/request/RequestFrame.ts
@@ -69,6 +69,8 @@ const RequestFrameProto: Omit<RequestFrame, "payload"> = {
 export const make = (payload: Payload.Payload): RequestFrame =>
   createProto(RequestFrameProto, { payload });
 
+export type EncodeError = Effect.Effect.Error<ReturnType<typeof encode>>;
+
 export const encode = encodeDual(
   (buffer: Buffer.WriteBuffer, frame: RequestFrame) =>
     pipe(
@@ -78,6 +80,8 @@ export const encode = encodeDual(
     ),
 );
 
+export type DecodeError = Effect.Effect.Error<ReturnType<typeof decode>>;
+
 export const decode = (buffer: Buffer.ReadBuffer) =>
   Effect.gen(function* () {
     yield* Buffer.advance(buffer, 19);

diff --git a/libs/@local/harpc/client/typescript/src/wire-protocol/models/request/RequestHeader.ts b/libs/@local/harpc/client/typescript/src/wire-protocol/models/request/RequestHeader.ts
@@ -100,6 +100,8 @@ export const applyBodyVariant = (
     RequestFlags.applyBodyVariant(header.flags, variant),
   );
 
+export type EncodeError = Effect.Effect.Error<ReturnType<typeof encode>>;
+
 export const encode = encodeDual(
   (buffer: Buffer.WriteBuffer, header: RequestHeader) => {
     return pipe(
@@ -111,6 +113,8 @@ export const encode = encodeDual(
   },
 );
 
+export type DecodeError = Effect.Effect.Error<ReturnType<typeof decode>>;
+
 export const decode = (buffer: Buffer.ReadBuffer) =>
   Effect.gen(function* () {
     const protocol = yield* Protocol.decode(buffer);

diff --git a/libs/@local/harpc/client/typescript/src/wire-protocol/models/request/RequestId.ts b/libs/@local/harpc/client/typescript/src/wire-protocol/models/request/RequestId.ts
@@ -70,11 +70,15 @@ const RequestIdProto: Omit<RequestId, "value"> = {
 export const makeUnchecked = (value: number): RequestId =>
   createProto(RequestIdProto, { value });
 
+export type EncodeError = Effect.Effect.Error<ReturnType<typeof encode>>;
+
 export const encode = encodeDual(
   (buffer: Buffer.WriteBuffer, requestId: RequestId) =>
     Buffer.putU32(buffer, requestId.value),
 );
 
+export type DecodeError = Effect.Effect.Error<ReturnType<typeof decode>>;
+
 export const decode = (buffer: Buffer.ReadBuffer) =>
   pipe(
     Buffer.getU32(buffer), //

diff --git a/libs/@local/harpc/client/typescript/src/wire-protocol/models/response/Response.ts b/libs/@local/harpc/client/typescript/src/wire-protocol/models/response/Response.ts
@@ -92,6 +92,8 @@ export const prepare = (self: Response) => {
   return make(header, self.body);
 };
 
+export type EncodeError = Effect.Effect.Error<ReturnType<typeof encode>>;
+
 export const encode = encodeDual(
   (buffer: Buffer.WriteBuffer, request: Response) =>
     Effect.gen(function* () {
@@ -105,6 +107,8 @@ export const encode = encodeDual(
     }),
 );
 
+export type DecodeError = Effect.Effect.Error<ReturnType<typeof decode>>;
+
 export const decode = (buffer: Buffer.ReadBuffer) =>
   Effect.gen(function* () {
     const header = yield* ResponseHeader.decode(buffer);

diff --git a/libs/@local/harpc/client/typescript/src/wire-protocol/models/response/ResponseBegin.ts b/libs/@local/harpc/client/typescript/src/wire-protocol/models/response/ResponseBegin.ts
@@ -79,6 +79,8 @@ export const make = (
   payload: Payload.Payload,
 ): ResponseBegin => createProto(ResponseBeginProto, { kind, payload });
 
+export type EncodeError = Effect.Effect.Error<ReturnType<typeof encode>>;
+
 export const encode = encodeDual(
   (buffer: Buffer.WriteBuffer, begin: ResponseBegin) =>
     pipe(
@@ -89,6 +91,8 @@ export const encode = encodeDual(
     ),
 );
 
+export type DecodeError = Effect.Effect.Error<ReturnType<typeof decode>>;
+
 export const decode = (buffer: Buffer.ReadBuffer) =>
   Effect.gen(function* () {
     yield* Buffer.advance(buffer, 17);

diff --git a/libs/@local/harpc/client/typescript/src/wire-protocol/models/response/ResponseBody.ts b/libs/@local/harpc/client/typescript/src/wire-protocol/models/response/ResponseBody.ts
@@ -105,6 +105,8 @@ export const match: {
     }),
 );
 
+export type EncodeError = Effect.Effect.Error<ReturnType<typeof encode>>;
+
 export const encode = encodeDual(
   (buffer: Buffer.WriteBuffer, body: ResponseBody) =>
     match(body, {
@@ -113,6 +115,8 @@ export const encode = encodeDual(
     }),
 );
 
+export type DecodeError = Effect.Effect.Error<ReturnType<typeof decode>>;
+
 export const decode = (
   buffer: Buffer.ReadBuffer,
   variant: ResponseBodyVariant,

diff --git a/libs/@local/harpc/client/typescript/src/wire-protocol/models/response/ResponseFlags.ts b/libs/@local/harpc/client/typescript/src/wire-protocol/models/response/ResponseFlags.ts
@@ -101,6 +101,8 @@ export const repr = (flags: ResponseFlags) => {
   return value;
 };
 
+export type EncodeError = Effect.Effect.Error<ReturnType<typeof encode>>;
+
 export const encode = encodeDual(
   (buffer: Buffer.WriteBuffer, flags: ResponseFlags) =>
     Effect.gen(function* () {
@@ -110,6 +112,8 @@ export const encode = encodeDual(
     }),
 );
 
+export type DecodeError = Effect.Effect.Error<ReturnType<typeof decode>>;
+
 export const decode = (buffer: Buffer.ReadBuffer) =>
   Effect.gen(function* () {
     const value = yield* Buffer.getU8(buffer);

diff --git a/libs/@local/harpc/client/typescript/src/wire-protocol/models/response/ResponseFrame.ts b/libs/@local/harpc/client/typescript/src/wire-protocol/models/response/ResponseFrame.ts
@@ -69,6 +69,8 @@ const ResponseFrameProto: Omit<ResponseFrame, "payload"> = {
 export const make = (payload: Payload.Payload): ResponseFrame =>
   createProto(ResponseFrameProto, { payload });
 
+export type EncodeError = Effect.Effect.Error<ReturnType<typeof encode>>;
+
 export const encode = encodeDual(
   (buffer: Buffer.WriteBuffer, frame: ResponseFrame) =>
     pipe(
@@ -78,6 +80,8 @@ export const encode = encodeDual(
     ),
 );
 
+export type DecodeError = Effect.Effect.Error<ReturnType<typeof decode>>;
+
 export const decode = (buffer: Buffer.ReadBuffer) =>
   Effect.gen(function* () {
     yield* Buffer.advance(buffer, 19);