feat: add getEmbedAccessToken functionality (#6)

Author: TristanSpeakEasy

README.md

@@ -336,4 +336,50 @@ app.use((req: Request, res: Response, next: NextFunction) => {
 		ctrl.setMaskingOpts(Masking.withRequestHeaderMask("authorization"))
     next();
 });
+```
+
+## Embedded Request Viewer Access Tokens
+
+The Speakeasy SDK can generate access tokens for the [Embedded Request Viewer](https://docs.speakeasyapi.dev/speakeasy-user-guide/request-viewer/embedded-request-viewer) that can be used to view requests captured by the SDK.
+
+For documentation on how to configure filters, find that [HERE](https://docs.speakeasyapi.dev/speakeasy-user-guide/request-viewer/embedded-request-viewer).
+
+Below are some examples on how to generate access tokens:
+
+```typescript
+import { EmbedAccessTokenRequest } from "@speakeasy-api/speakeasy-schemas/registry/embedaccesstoken/embedaccesstoken_pb";
+
+// If the SDK is configured as a global instance, an access token can be generated using the `generateAccessToken` function on the speakeasy package.
+const req = new EmbedAccessTokenRequest();
+const filter = new EmbedAccessTokenRequest.Filter();
+filter.setKey("customer_id");
+filter.setOperator("=");
+filter.setValue("a-customer-id");
+
+req.setFiltersList([filter]);
+const accessToken = await speakeasy.getEmbedAccessToken(req);
+
+// If you have followed the `Advanced Configuration` section above you can also generate an access token using the `GenerateAccessToken` function on the sdk instance.
+const req = new EmbedAccessTokenRequest();
+const filter = new EmbedAccessTokenRequest.Filter();
+filter.setKey("customer_id");
+filter.setOperator("=");
+filter.setValue("a-customer-id");
+
+req.setFiltersList([filter]);
+const accessToken = await storeSDK.getEmbedAccessToken(req);
+
+// Or finally if you have a handler that you would like to generate an access token from, you can get the SDK instance for that handler from the middleware controller and use the `GetEmbedAccessToken` function it.
+app.all("/", (req, res) => {
+  const req = new EmbedAccessTokenRequest();
+  const filter = new EmbedAccessTokenRequest.Filter();
+  filter.setKey("customer_id");
+  filter.setOperator("=");
+  filter.setValue("a-customer-id");
+
+  req.setFiltersList([filter]);
+  const accessToken = await req.controller.getSDKInstance().getEmbedAccessToken(req);
+	
+	// the rest of your handlers code
+});
 ```

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@speakeasy-api/speakeasy-typescript-sdk",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/speakeasy-api/speakeasy-typescript-sdk"
@@ -45,7 +45,7 @@
   },
   "dependencies": {
     "@grpc/grpc-js": "^1.6.9",
-    "@speakeasy-api/speakeasy-schemas": "^1.1.2",
+    "@speakeasy-api/speakeasy-schemas": "^1.3.0",
     "content-type": "^1.0.4",
     "cookie": "^0.5.0",
     "raw-body": "^2.5.1",

package.json

@@ -1,10 +1,17 @@
+import { SpeakeasySDK } from "./speakeasy";
+
 type MaskingOption = (m: Masking) => void;
 
 export class MiddlewareController {
+  private sdkInstance: SpeakeasySDK = null;
   private pathHint: string = "";
   private customerID: string = "";
   private masking: Masking = new Masking();
 
+  public constructor(sdkInstance: SpeakeasySDK | null) {
+    this.sdkInstance = sdkInstance;
+  }
+
   public getPathHint(): string {
     return this.pathHint;
   }
@@ -28,6 +35,10 @@ export class MiddlewareController {
   public getMasking(): Masking {
     return this.masking;
   }
+
+  public getSDKInstance(): SpeakeasySDK {
+    return this.sdkInstance;
+  }
 }
 
 export const DefaultStringMask: string = "__masked__";

src/controller.ts

@@ -24,7 +24,7 @@ export function expressCompatibleMiddleware(
 
     const reqResWriter = new RequestResponseWriter(req, res);
 
-    const controller = new MiddlewareController();
+    const controller = new MiddlewareController(speakeasy);
 
     res.on("finish", () => {
       reqResWriter.end();

src/middleware/common/middleware.ts

@@ -1,3 +1,4 @@
+import { EmbedAccessTokenRequest } from "@speakeasy-api/speakeasy-schemas/registry/embedaccesstoken/embedaccesstoken_pb";
 import { GRPCClient } from "./transport";
 import type { RequestHandler } from "express";
 import { expressMiddleware as eMiddleware } from "./middleware/express/middleware";
@@ -58,6 +59,10 @@ export class SpeakeasySDK {
   public send(har: string, pathHint: string, customerID: string) {
     this.grpcClient.send(har, pathHint, customerID);
   }
+
+  public getEmbedAccessToken(req: EmbedAccessTokenRequest): Promise<string> {
+    return this.grpcClient.getEmbedAccessToken(req);
+  }
 }
 
 export function configure(config: Config): void {
@@ -80,6 +85,16 @@ export function nestJSMiddleware(): RequestHandler {
   return speakeasyInstance.nestJSMiddleware();
 }
 
+export function getEmbedAccessToken(
+  req: EmbedAccessTokenRequest
+): Promise<string> {
+  if (!speakeasyInstance) {
+    throw new Error("speakeasy is not configured");
+  }
+
+  return speakeasyInstance.getEmbedAccessToken(req);
+}
+
 const maxIDSize = 128;
 const validCharsRegexStr = "[^a-zA-Z0-9.\\-_~]";
 

src/speakeasy.ts

@@ -1,10 +1,22 @@
 import * as grpc from "@grpc/grpc-js";
 
+import {
+  CallOptions,
+  Client,
+  ClientUnaryCall,
+  Metadata,
+  ServiceError,
+} from "@grpc/grpc-js";
+
+import { EmbedAccessTokenRequest } from "@speakeasy-api/speakeasy-schemas/registry/embedaccesstoken/embedaccesstoken_pb";
+import { EmbedAccessTokenServiceClient } from "@speakeasy-api/speakeasy-schemas/registry/embedaccesstoken/embedaccesstoken_grpc_pb";
 import { IngestRequest } from "@speakeasy-api/speakeasy-schemas/registry/ingest/ingest_pb";
 import { IngestServiceClient } from "@speakeasy-api/speakeasy-schemas/registry/ingest/ingest_grpc_pb";
+import { Message } from "google-protobuf";
 
 export class GRPCClient {
-  private client: IngestServiceClient;
+  private ingestClient: Promisified<IngestServiceClient>;
+  private embedClient: Promisified<EmbedAccessTokenServiceClient>;
   private apiKey: string;
   private apiID: string;
   private versionID: string;
@@ -21,7 +33,12 @@ export class GRPCClient {
       credentials = grpc.credentials.createInsecure();
     }
 
-    this.client = new IngestServiceClient(address, credentials);
+    this.ingestClient = promisify(
+      new IngestServiceClient(address, credentials)
+    );
+    this.embedClient = promisify(
+      new EmbedAccessTokenServiceClient(address, credentials)
+    );
 
     this.apiKey = apiKey;
     this.apiID = apiID;
@@ -39,10 +56,79 @@ export class GRPCClient {
     request.setPathHint(pathHint);
     request.setCustomerId(customerID);
 
-    this.client.ingest(request, metadata, (err, response) => {
+    this.ingestClient.ingest(request, metadata).catch((err) => {
       if (err) {
-        console.error(err); // TODO log error?
+        console.error(err); // TODO log error with a provided logger?
       }
     });
   }
+
+  public async getEmbedAccessToken(
+    req: EmbedAccessTokenRequest
+  ): Promise<string> {
+    const metadata = new grpc.Metadata();
+    metadata.set("x-api-key", this.apiKey);
+
+    const res = await this.embedClient.get(req, metadata);
+    return res.getAccesstoken();
+  }
+}
+
+type OriginalCall<T, U> = (
+  request: T,
+  metadata: Metadata,
+  options: Partial<CallOptions>,
+  callback: (error: ServiceError, res: U) => void
+) => ClientUnaryCall;
+
+type PromisifiedCall<T, U> = (
+  request: T,
+  metadata?: Metadata,
+  options?: Partial<CallOptions>
+) => Promise<U>;
+
+export type Promisified<C> = { $: C } & {
+  [prop in Exclude<keyof C, keyof Client>]: C[prop] extends OriginalCall<
+    infer T,
+    infer U
+  >
+    ? PromisifiedCall<T, U>
+    : never;
+};
+
+export function promisify<C extends Client>(client: C): Promisified<C> {
+  return new Proxy(client, {
+    get: (target, descriptor) => {
+      let stack = "";
+
+      // this step is required to get the correct stack trace
+      // of course, this has some performance impact, but it's not that big in comparison with grpc calls
+      try {
+        throw new Error();
+      } catch (e) {
+        stack = e.stack;
+      }
+
+      if (descriptor === "$") {
+        return target;
+      }
+
+      return (...args: any[]) =>
+        new Promise((resolve, reject) =>
+          target[descriptor](
+            ...[
+              ...args,
+              (err: ServiceError, res: Message) => {
+                if (err) {
+                  err.stack += stack;
+                  reject(err);
+                } else {
+                  resolve(res);
+                }
+              },
+            ]
+          )
+        );
+    },
+  }) as unknown as Promisified<C>;
 }

src/transport.ts

@@ -88,7 +88,7 @@ describe("Masking Configuration", () => {
     ];
 
     test.each(tests)("$name", ({ name, args, wantQueryStringMasks }) => {
-      const controller = new MiddlewareController();
+      const controller = new MiddlewareController(null);
       controller.setMaskingOpts(
         Masking.withQueryStringMask(args.keys, ...args.masks)
       );
@@ -181,7 +181,7 @@ describe("Masking Configuration", () => {
     ];
 
     test.each(tests)("$name", ({ name, args, wantRequestCookieMasks }) => {
-      const controller = new MiddlewareController();
+      const controller = new MiddlewareController(null);
       controller.setMaskingOpts(
         Masking.withRequestCookieMask(args.keys, ...args.masks)
       );

test/masking/masking.test.ts

@@ -648,10 +648,10 @@
   dependencies:
     "@sinonjs/commons" "^1.7.0"
 
-"@speakeasy-api/speakeasy-schemas@^1.1.2":
-  version "1.1.2"
-  resolved "https://registry.yarnpkg.com/@speakeasy-api/speakeasy-schemas/-/speakeasy-schemas-1.1.2.tgz#fd3485bc0bfbbafe892ce240b61c0bb3147cbd81"
-  integrity sha512-WpkQqafGg4d1X0Ylo9oVuQJ0EP//iKiro8cQHulTkEPudIOnP3U17XKsD76htdeUSrpLbrioi0WYWtiI68JhrA==
+"@speakeasy-api/speakeasy-schemas@^1.3.0":
+  version "1.3.0"
+  resolved "https://registry.yarnpkg.com/@speakeasy-api/speakeasy-schemas/-/speakeasy-schemas-1.3.0.tgz#75f24c153a3fec97c84ed6680bbb0fa0cf7dca4d"
+  integrity sha512-EwbXWmJfJoaPWSqBrUurg2hgXJfpRVNvhgmaggzmILuMLNx4cme8z1KNLl75hCTSQdIV5154g/ZcfA0Iz4ed8g==
   dependencies:
     "@types/google-protobuf" "^3.15.6"
     google-protobuf "^3.21.0"