[RSDK-8305] Send SDK/API version

.github/workflows/update_protos.yml

@@ -20,6 +20,7 @@ jobs:
 
       - name: Update api
         run: |
+          echo ${{ github.event.client_payload.tag }} > api_version.lock
           sudo chown -R testbot .
           sudo -u testbot bash -lc 'make update-buf'
 

.gitignore

@@ -111,3 +111,6 @@ bin/
 
 # typedoc documentation
 docs/dist
+
+# build-time outputs
+src/api-version.ts

Makefile

@@ -55,7 +55,7 @@ update-buf: $(node_modules)
 .PHONY: build-buf
 build-buf: $(node_modules) clean-buf
 	$(buf) generate $$(./scripts/get-buf-lock-version.js buf.build/googleapis/googleapis)
-	$(buf) generate $$(./scripts/get-buf-lock-version.js buf.build/viamrobotics/api) --path common,component,robot,service,app,provisioning,tagger,stream
+	$(buf) generate buf.build/viamrobotics/api:$$(cat api_version.lock) --path common,component,robot,service,app,provisioning,tagger,stream
 	$(buf) generate $$(./scripts/get-buf-lock-version.js buf.build/viamrobotics/goutils)
 
 # js targets

api_version.lock

@@ -0,0 +1 @@
+v0.1.330

buf.lock

@@ -4,13 +4,13 @@ deps:
   - remote: buf.build
     owner: googleapis
     repository: googleapis
-    commit: 2bbd25900cb34c79bae97d85c948d3cf
-    digest: shake256:a6446e23f4408160217c22738a0c8c370ff3ff966f601d678960b803829cf53b5cf5998d20fcb3f9c9be944b24337843e7beb6e681ddbf9d036fb6491c0e47e7
+    commit: 8bc2c51e08c447cd8886cdea48a73e14
+    digest: shake256:a969155953a5cedc5b2df5b42c368f2bc66ff8ce1804bc96e0f14ff2ee8a893687963058909df844d1643cdbc98ff099d2daa6bc9f9f5b8886c49afdc60e19af
   - remote: buf.build
     owner: viamrobotics
     repository: api
-    commit: 50ed3af8a5ba4ae1b2cff6c9536163f7
-    digest: shake256:c7a5a1a961713ab6316f08c4c0ea8308cf5b068516229d4c74ea78b7e2233ba51011616021e431a49a71ea8f7944f55bc70deb7a8dd2800ecdbb1107f026244f
+    commit: 611b5d52df6843bdb8f407dd7aa3e2fa
+    digest: shake256:c53316f527a616e8c4d9d96df342040d41a51f575b8410c091940eb774cfe5b9474ed888226d25a0464f48053e032746c60022df2a7bd90f29e85607c2545949
   - remote: buf.build
     owner: viamrobotics
     repository: goutils

package.json

@@ -16,6 +16,7 @@
     }
   },
   "scripts": {
+    "prebuild": "ts-node ./scripts/write-versions.ts",
     "build": "npm run build:bundle && npm run build:types && npm run build:copy-dts",
     "build:bundle": "vite build",
     "build:types": "tsc --project tsconfig.build.json",
@@ -72,6 +73,7 @@
     "prettier": "^3.1.1",
     "prettier-plugin-jsdoc": "^1.1.1",
     "protoc-gen-js": "^3.21.2",
+    "ts-node": "^10.9.2",
     "ts-protoc-gen": "^0.15.0",
     "typedoc": "^0.25.4",
     "typescript": "^5.3.3",

scripts/write-versions.ts

@@ -0,0 +1,7 @@
+const fs = require('node:fs');
+
+const apiVersion = fs.readFileSync('./api_version.lock').toString().trim();
+fs.writeFileSync(
+  './src/api-version.ts',
+  `export const apiVersion = "${apiVersion}";`
+);

src/app/viam-transport.ts

@@ -3,6 +3,7 @@ import { dialDirect } from '@viamrobotics/rpc';
 
 import { AuthenticateRequest, Credentials } from '../gen/proto/rpc/v1/auth_pb';
 import { AuthServiceClient } from '../gen/proto/rpc/v1/auth_pb_service';
+import { MetadataTransport } from '../utils';
 
 /** A credential that can be exchanged to obtain an access token */
 export interface Credential {
@@ -94,33 +95,13 @@ const createWithCredential = async (
     new ViamTransport(transportFactory, opts, accessToken);
 };
 
-export class ViamTransport implements grpc.Transport {
-  private accessToken: string;
-  protected readonly transport: grpc.Transport;
-
+export class ViamTransport extends MetadataTransport {
   constructor(
     transportFactory: grpc.TransportFactory,
     opts: grpc.TransportOptions,
     accessToken: string
   ) {
-    this.transport = transportFactory(opts);
-    this.accessToken = accessToken;
-  }
-
-  public start(metadata: grpc.Metadata): void {
-    metadata.set('authorization', `Bearer ${this.accessToken}`);
-    this.transport.start(metadata);
-  }
-
-  public sendMessage(msgBytes: Uint8Array): void {
-    this.transport.sendMessage(msgBytes);
-  }
-
-  public finishSend(): void {
-    this.transport.finishSend();
-  }
-
-  public cancel(): void {
-    this.transport.cancel();
+    const md = new grpc.Metadata({ authorization: `Bearer ${accessToken}` });
+    super(transportFactory, opts, md);
   }
 }

src/robot/client.ts

@@ -36,7 +36,7 @@ import { SensorsServiceClient } from '../gen/service/sensors/v1/sensors_pb_servi
 import { SLAMServiceClient } from '../gen/service/slam/v1/slam_pb_service';
 import { VisionServiceClient } from '../gen/service/vision/v1/vision_pb_service';
 import { ViamResponseStream } from '../responses';
-import { encodeResourceName, promisify } from '../utils';
+import { encodeResourceName, promisify, MetadataTransport } from '../utils';
 import GRPCConnectionManager from './grpc-connection-manager';
 import type { Robot, RobotStatusStream } from './robot';
 import SessionManager from './session-manager';
@@ -525,9 +525,16 @@ export class RobotClient extends EventDispatcher implements Robot {
         await this.gRPCConnectionManager.start();
       }
 
-      const clientTransportFactory = this.sessionOptions?.disabled
-        ? this.transportFactory
-        : this.sessionManager.transportFactory;
+      const ctf: grpc.TransportFactory = (
+        options: grpc.TransportOptions
+      ): grpc.Transport => {
+        const tf = this.sessionOptions?.disabled
+          ? this.transportFactory
+          : this.sessionManager.transportFactory;
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        return new MetadataTransport(tf!, options);
+      };
+      const clientTransportFactory = ctf;
       const grpcOptions = { transport: clientTransportFactory };
 
       this.robotServiceClient = new RobotServiceClient(