feat: add metadata about service and method to requesthandler

Adding metadata about the service and method which is invoked to the call of the requestHandler. This allows a request-handler to resolve proper service and method configurations for http requests if need be. An example usage is to use the default service configuration in order to resolve retry- or hedging-policy for a call. This change should be backwards compatible, since the request handler signature specifies the meta as an optional argument.
einride · Oct 11, 2022 · c97738f · c97738f
1 parent 32deeab
commit c97738f
Show file tree

Hide file tree

Showing 3 changed files with 69 additions and 3 deletions.
diff --git a/examples/proto/gen/typescript/einride/example/freight/v1/index.ts b/examples/proto/gen/typescript/einride/example/freight/v1/index.ts
@@ -426,7 +426,7 @@ type RequestType = {
   body: string | null;
 };
 
-type RequestHandler = (request: RequestType) => Promise<unknown>;
+type RequestHandler = (request: RequestType, meta: { service: string, method: string }) => Promise<unknown>;
 
 export function createFreightServiceClient(
   handler: RequestHandler
@@ -447,6 +447,9 @@ export function createFreightServiceClient(
         path: uri,
         method: "GET",
         body,
+      }, {
+        service: "FreightService",
+        method: "GetShipper",
       }) as Promise<Shipper>;
     },
     ListShippers(request) { // eslint-disable-line @typescript-eslint/no-unused-vars
@@ -467,6 +470,9 @@ export function createFreightServiceClient(
         path: uri,
         method: "GET",
         body,
+      }, {
+        service: "FreightService",
+        method: "ListShippers",
       }) as Promise<ListShippersResponse>;
     },
     CreateShipper(request) { // eslint-disable-line @typescript-eslint/no-unused-vars
@@ -481,6 +487,9 @@ export function createFreightServiceClient(
         path: uri,
         method: "POST",
         body,
+      }, {
+        service: "FreightService",
+        method: "CreateShipper",
       }) as Promise<Shipper>;
     },
     UpdateShipper(request) { // eslint-disable-line @typescript-eslint/no-unused-vars
@@ -501,6 +510,9 @@ export function createFreightServiceClient(
         path: uri,
         method: "PATCH",
         body,
+      }, {
+        service: "FreightService",
+        method: "UpdateShipper",
       }) as Promise<Shipper>;
     },
     DeleteShipper(request) { // eslint-disable-line @typescript-eslint/no-unused-vars
@@ -518,6 +530,9 @@ export function createFreightServiceClient(
         path: uri,
         method: "DELETE",
         body,
+      }, {
+        service: "FreightService",
+        method: "DeleteShipper",
       }) as Promise<Shipper>;
     },
     GetSite(request) { // eslint-disable-line @typescript-eslint/no-unused-vars
@@ -535,6 +550,9 @@ export function createFreightServiceClient(
         path: uri,
         method: "GET",
         body,
+      }, {
+        service: "FreightService",
+        method: "GetSite",
       }) as Promise<Site>;
     },
     ListSites(request) { // eslint-disable-line @typescript-eslint/no-unused-vars
@@ -558,6 +576,9 @@ export function createFreightServiceClient(
         path: uri,
         method: "GET",
         body,
+      }, {
+        service: "FreightService",
+        method: "ListSites",
       }) as Promise<ListSitesResponse>;
     },
     CreateSite(request) { // eslint-disable-line @typescript-eslint/no-unused-vars
@@ -575,6 +596,9 @@ export function createFreightServiceClient(
         path: uri,
         method: "POST",
         body,
+      }, {
+        service: "FreightService",
+        method: "CreateSite",
       }) as Promise<Site>;
     },
     UpdateSite(request) { // eslint-disable-line @typescript-eslint/no-unused-vars
@@ -595,6 +619,9 @@ export function createFreightServiceClient(
         path: uri,
         method: "PATCH",
         body,
+      }, {
+        service: "FreightService",
+        method: "UpdateSite",
       }) as Promise<Site>;
     },
     DeleteSite(request) { // eslint-disable-line @typescript-eslint/no-unused-vars
@@ -612,6 +639,9 @@ export function createFreightServiceClient(
         path: uri,
         method: "DELETE",
         body,
+      }, {
+        service: "FreightService",
+        method: "DeleteSite",
       }) as Promise<Site>;
     },
     GetShipment(request) { // eslint-disable-line @typescript-eslint/no-unused-vars
@@ -629,6 +659,9 @@ export function createFreightServiceClient(
         path: uri,
         method: "GET",
         body,
+      }, {
+        service: "FreightService",
+        method: "GetShipment",
       }) as Promise<Shipment>;
     },
     ListShipments(request) { // eslint-disable-line @typescript-eslint/no-unused-vars
@@ -652,6 +685,9 @@ export function createFreightServiceClient(
         path: uri,
         method: "GET",
         body,
+      }, {
+        service: "FreightService",
+        method: "ListShipments",
       }) as Promise<ListShipmentsResponse>;
     },
     CreateShipment(request) { // eslint-disable-line @typescript-eslint/no-unused-vars
@@ -669,6 +705,9 @@ export function createFreightServiceClient(
         path: uri,
         method: "POST",
         body,
+      }, {
+        service: "FreightService",
+        method: "CreateShipment",
       }) as Promise<Shipment>;
     },
     UpdateShipment(request) { // eslint-disable-line @typescript-eslint/no-unused-vars
@@ -689,6 +728,9 @@ export function createFreightServiceClient(
         path: uri,
         method: "PATCH",
         body,
+      }, {
+        service: "FreightService",
+        method: "UpdateShipment",
       }) as Promise<Shipment>;
     },
     DeleteShipment(request) { // eslint-disable-line @typescript-eslint/no-unused-vars
@@ -706,6 +748,9 @@ export function createFreightServiceClient(
         path: uri,
         method: "DELETE",
         body,
+      }, {
+        service: "FreightService",
+        method: "DeleteShipment",
       }) as Promise<Shipment>;
     },
   };

diff --git a/examples/proto/gen/typescript/einride/example/syntax/v1/index.ts b/examples/proto/gen/typescript/einride/example/syntax/v1/index.ts
@@ -304,7 +304,7 @@ type RequestType = {
   body: string | null;
 };
 
-type RequestHandler = (request: RequestType) => Promise<unknown>;
+type RequestHandler = (request: RequestType, meta: { service: string, method: string }) => Promise<unknown>;
 
 export function createSyntaxServiceClient(
   handler: RequestHandler
@@ -333,6 +333,9 @@ export function createSyntaxServiceClient(
         path: uri,
         method: "GET",
         body,
+      }, {
+        service: "SyntaxService",
+        method: "QueryOnly",
       }) as Promise<Message>;
     },
     EmptyVerb(request) { // eslint-disable-line @typescript-eslint/no-unused-vars
@@ -347,6 +350,9 @@ export function createSyntaxServiceClient(
         path: uri,
         method: "GET",
         body,
+      }, {
+        service: "SyntaxService",
+        method: "EmptyVerb",
       }) as Promise<wellKnownEmpty>;
     },
     StarBody(request) { // eslint-disable-line @typescript-eslint/no-unused-vars
@@ -361,6 +367,9 @@ export function createSyntaxServiceClient(
         path: uri,
         method: "POST",
         body,
+      }, {
+        service: "SyntaxService",
+        method: "StarBody",
       }) as Promise<Message>;
     },
     Body(request) { // eslint-disable-line @typescript-eslint/no-unused-vars
@@ -383,6 +392,9 @@ export function createSyntaxServiceClient(
         path: uri,
         method: "POST",
         body,
+      }, {
+        service: "SyntaxService",
+        method: "Body",
       }) as Promise<Message>;
     },
     Path(request) { // eslint-disable-line @typescript-eslint/no-unused-vars
@@ -408,6 +420,9 @@ export function createSyntaxServiceClient(
         path: uri,
         method: "POST",
         body,
+      }, {
+        service: "SyntaxService",
+        method: "Path",
       }) as Promise<Message>;
     },
     PathBody(request) { // eslint-disable-line @typescript-eslint/no-unused-vars
@@ -430,6 +445,9 @@ export function createSyntaxServiceClient(
         path: uri,
         method: "POST",
         body,
+      }, {
+        service: "SyntaxService",
+        method: "PathBody",
       }) as Promise<Message>;
     },
   };

diff --git a/internal/plugin/servicegen.go b/internal/plugin/servicegen.go
@@ -50,7 +50,7 @@ func (s serviceGenerator) generateHandler(f *codegen.File) {
 	f.P(t(1), "body: string | null;")
 	f.P("};")
 	f.P()
-	f.P("type RequestHandler = (request: RequestType) => Promise<unknown>;")
+	f.P("type RequestHandler = (request: RequestType, meta: { service: string, method: string }) => Promise<unknown>;")
 	f.P()
 }
 
@@ -105,6 +105,9 @@ func (s serviceGenerator) generateMethod(f *codegen.File, method protoreflect.Me
 	f.P(t(4), "path: uri,")
 	f.P(t(4), "method: ", strconv.Quote(rule.Method), ",")
 	f.P(t(4), "body,")
+	f.P(t(3), "}, {")
+	f.P(t(4), "service: \"", method.Parent().Name(), "\",")
+	f.P(t(4), "method: \"", method.Name(), "\",")
 	f.P(t(3), "}) as Promise<", outputType.Reference(), ">;")
 	f.P(t(2), "},")
 	return nil