[protocol] Add x-restate-server header (#319)

Author: igalshilman

package-lock.json

@@ -20,17 +20,17 @@
     "dist"
   ],
   "scripts": {
+    "gen:version": "node ./scripts/version.js",
     "proto": "npx buf mod update && npx buf generate",
+    "prebuild": "npm run gen:version",
     "build": "tsc -b",
+    "pretest": "npm run gen:version",
     "test": "jest --silent --maxWorkers=1",
     "lint": "eslint --ignore-path .eslintignore --max-warnings=0 --ext .ts .",
     "format": "prettier --ignore-path .eslintignore --write \"**/*.+(js|ts|json)\"",
     "format-check": "prettier --ignore-path .eslintignore --check \"**/*.+(js|ts|json)\"",
     "verify": "npm run format-check && npm run lint && npm run test && npm run build",
-    "release": "release-it",
-    "example": "RESTATE_DEBUG_LOGGING=OFF ts-node-dev --transpile-only ./examples/example.ts",
-    "workflowexample": "RESTATE_DEBUG_LOGGING=OFF ts-node-dev --transpile-only ./examples/workflow_example.ts",
-    "ingress": "RESTATE_DEBUG_LOGGING=OFF ts-node-dev --transpile-only ./examples/ingress.ts"
+    "release": "release-it"
   },
   "dependencies": {
     "@bufbuild/protobuf": "^1.8.0"

packages/restate-sdk/package.json

@@ -0,0 +1,38 @@
+/*
+ * Copyright (c) 2023-2024 - Restate Software, Inc., Restate GmbH
+ *
+ * This file is part of the Restate SDK for Node.js/TypeScript,
+ * which is released under the MIT license.
+ *
+ * You can find a copy of the license in file LICENSE in the root
+ * directory of this repository or package, or at
+ * https://github.com/restatedev/sdk-typescript/blob/main/LICENSE
+ */
+
+// The following script injects the current version
+// taken from package.json into a src/generated/version.ts
+// file.
+
+const fs = require("node:fs");
+const path = require("node:path");
+
+//
+// figure out where we are
+//
+const cwd = path.dirname(__filename);
+
+//
+// compute the relative paths to this script
+//
+const packageJsonPath = `${cwd}/../package.json`;
+const targetDir = `${cwd}/../src/generated`;
+const targetFile = `${targetDir}/version.ts`;
+
+//
+// generate version.ts
+//
+const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf8"));
+const version = packageJson.version;
+const versionFileContent = `export const SDK_VERSION = '${version}';\n`;
+fs.mkdirSync(targetDir, { recursive: true });
+fs.writeFileSync(targetFile, versionFileContent);

packages/restate-sdk/scripts/version.js

@@ -166,11 +166,11 @@ export class EndpointImpl implements RestateEndpoint {
     });
   }
 
-  computeDiscovery(): discovery.Deployment {
+  computeDiscovery(protocolMode: discovery.ProtocolMode): discovery.Deployment {
     const components = [...this.components.values()].map((c) => c.discovery());
 
     const deployment: discovery.Deployment = {
-      protocolMode: discovery.ProtocolMode.BIDI_STREAM,
+      protocolMode,
       minProtocolVersion: 1,
       maxProtocolVersion: 2,
       components,

packages/restate-sdk/src/endpoint/endpoint_impl.ts

@@ -28,6 +28,7 @@ import {
 import { Deployment, ProtocolMode } from "../types/discovery";
 import { validateRequestSignature } from "./request_signing/validate";
 import { ServerHttp2Stream } from "node:http2";
+import { X_RESTATE_SERVER } from "../user_agent";
 
 export class Http2Handler {
   constructor(private readonly endpoint: EndpointImpl) {}
@@ -82,6 +83,7 @@ export class Http2Handler {
       );
       stream.respond({
         "content-type": "application/restate",
+        "x-restate-server": X_RESTATE_SERVER,
         ":status": 401,
       });
       stream.end();
@@ -101,7 +103,10 @@ export class Http2Handler {
       return respondNotFound(stream);
     }
     if (route === "discovery") {
-      return respondDiscovery(this.endpoint.computeDiscovery(), stream);
+      const discovery = this.endpoint.computeDiscovery(
+        ProtocolMode.BIDI_STREAM
+      );
+      return respondDiscovery(discovery, stream);
     }
     const urlComponents = route as UrlPathComponents;
     const component = this.endpoint.componentByName(
@@ -117,6 +122,7 @@ export class Http2Handler {
     // valid connection, let's dispatch the invocation
     stream.respond({
       "content-type": "application/restate",
+      "x-restate-server": X_RESTATE_SERVER,
       ":status": 200,
     });
     const restateStream = RestateHttp2Connection.from(stream);
@@ -133,6 +139,7 @@ function respondDiscovery(
   http2Stream.respond({
     ":status": 200,
     "content-type": "application/json",
+    "x-restate-server": X_RESTATE_SERVER,
   });
 
   return pipeline(stream.Readable.from(responseData), http2Stream, {
@@ -143,6 +150,7 @@ function respondDiscovery(
 function respondNotFound(stream: http2.ServerHttp2Stream) {
   stream.respond({
     "content-type": "application/json",
+    "x-restate-server": X_RESTATE_SERVER,
     ":status": 404,
   });
   stream.end();

packages/restate-sdk/src/endpoint/http2_handler.ts

@@ -33,6 +33,7 @@ import {
   parseUrlComponents,
 } from "../types/components";
 import { validateRequestSignature } from "./request_signing/validate";
+import { X_RESTATE_SERVER } from "../user_agent";
 
 export class LambdaHandler {
   constructor(private readonly endpoint: EndpointImpl) {}
@@ -149,6 +150,7 @@ export class LambdaHandler {
       return {
         headers: {
           "content-type": "application/restate",
+          "x-restate-server": X_RESTATE_SERVER,
         },
         statusCode: 200,
         isBase64Encoded: true,
@@ -163,13 +165,16 @@ export class LambdaHandler {
   }
 
   private handleDiscovery(): APIGatewayProxyResult | APIGatewayProxyResultV2 {
-    const disocvery = this.endpoint.computeDiscovery();
+    const disocvery = this.endpoint.computeDiscovery(
+      ProtocolMode.REQUEST_RESPONSE
+    );
     const discoveryJson = JSON.stringify(disocvery);
     const body = Buffer.from(discoveryJson).toString("base64");
 
     return {
       headers: {
         "content-type": "application/json",
+        "x-restate-server": X_RESTATE_SERVER,
       },
       statusCode: 200,
       isBase64Encoded: true,
@@ -181,6 +186,7 @@ export class LambdaHandler {
     return {
       headers: {
         "content-type": "application/restate",
+        "x-restate-server": X_RESTATE_SERVER,
       },
       statusCode: code,
       isBase64Encoded: true,

packages/restate-sdk/src/endpoint/lambda_handler.ts

@@ -1,3 +1,14 @@
+/*
+ * Copyright (c) 2023-2024 - Restate Software, Inc., Restate GmbH
+ *
+ * This file is part of the Restate SDK for Node.js/TypeScript,
+ * which is released under the MIT license.
+ *
+ * You can find a copy of the license in file LICENSE in the root
+ * directory of this repository or package, or at
+ * https://github.com/restatedev/sdk-typescript/blob/main/LICENSE
+ */
+
 import { Buffer } from "node:buffer";
 import { webcrypto } from "node:crypto";
 import * as crypto from "node:crypto";

packages/restate-sdk/src/endpoint/request_signing/ed25519.ts

@@ -1,3 +1,14 @@
+/*
+ * Copyright (c) 2023-2024 - Restate Software, Inc., Restate GmbH
+ *
+ * This file is part of the Restate SDK for Node.js/TypeScript,
+ * which is released under the MIT license.
+ *
+ * You can find a copy of the license in file LICENSE in the root
+ * directory of this repository or package, or at
+ * https://github.com/restatedev/sdk-typescript/blob/main/LICENSE
+ */
+
 import { Buffer } from "node:buffer";
 import { headerValue, ValidateResponse, ValidateSuccess } from "./validate";
 import { importKey, Key, verify } from "./ed25519";

packages/restate-sdk/src/endpoint/request_signing/v1.ts

@@ -1,3 +1,14 @@
+/*
+ * Copyright (c) 2023-2024 - Restate Software, Inc., Restate GmbH
+ *
+ * This file is part of the Restate SDK for Node.js/TypeScript,
+ * which is released under the MIT license.
+ *
+ * You can find a copy of the license in file LICENSE in the root
+ * directory of this repository or package, or at
+ * https://github.com/restatedev/sdk-typescript/blob/main/LICENSE
+ */
+
 import { KeySetV1, SCHEME_V1, validateV1 } from "./v1";
 
 const SIGNATURE_SCHEME_HEADER = "x-restate-signature-scheme";

packages/restate-sdk/src/endpoint/request_signing/validate.ts

@@ -0,0 +1,14 @@
+/*
+ * Copyright (c) 2023-2024 - Restate Software, Inc., Restate GmbH
+ *
+ * This file is part of the Restate SDK for Node.js/TypeScript,
+ * which is released under the MIT license.
+ *
+ * You can find a copy of the license in file LICENSE in the root
+ * directory of this repository or package, or at
+ * https://github.com/restatedev/sdk-typescript/blob/main/LICENSE
+ */
+
+import { SDK_VERSION } from "./generated/version";
+
+export const X_RESTATE_SERVER = `restate-sdk-typescript/${SDK_VERSION}`;

packages/restate-sdk/src/user_agent.ts

@@ -27,6 +27,7 @@ import {
 import { decodeLambdaBody } from "../src/io/decoder";
 import { TestGreeter, TestResponse } from "./testdriver";
 import { ComponentType, Deployment } from "../src/types/discovery";
+import { X_RESTATE_SERVER } from "../src/user_agent";
 
 class LambdaGreeter implements TestGreeter {
   async greet(
@@ -128,6 +129,7 @@ describe("LambdaGreeter", () => {
     expect(result.statusCode).toStrictEqual(200);
     expect(result.headers).toStrictEqual({
       "content-type": "application/restate",
+      "x-restate-server": X_RESTATE_SERVER,
     });
     expect(result.isBase64Encoded).toStrictEqual(true);
     expect(deserializeMessages(result.body)).toStrictEqual([
@@ -152,6 +154,7 @@ describe("LambdaGreeter", () => {
     expect(result.statusCode).toStrictEqual(404);
     expect(result.headers).toStrictEqual({
       "content-type": "application/restate",
+      "x-restate-server": X_RESTATE_SERVER,
     });
     expect(result.isBase64Encoded).toStrictEqual(true);
   });
@@ -172,6 +175,7 @@ describe("LambdaGreeter", () => {
     expect(result.statusCode).toStrictEqual(404);
     expect(result.headers).toStrictEqual({
       "content-type": "application/restate",
+      "x-restate-server": X_RESTATE_SERVER,
     });
   });
 
@@ -191,6 +195,7 @@ describe("LambdaGreeter", () => {
     expect(result.statusCode).toStrictEqual(404);
     expect(result.headers).toStrictEqual({
       "content-type": "application/restate",
+      "x-restate-server": X_RESTATE_SERVER,
     });
   });
 
@@ -208,6 +213,7 @@ describe("LambdaGreeter", () => {
     expect(result.statusCode).toStrictEqual(200);
     expect(result.headers).toStrictEqual({
       "content-type": "application/json",
+      "x-restate-server": X_RESTATE_SERVER,
     });
     expect(result.isBase64Encoded).toStrictEqual(true);