feat: Pass optional envoyPrefix query param to CoreClient constructor (#1219)

Author: vbabich

packages/code-studio/src/main/AppInit.tsx

@@ -52,6 +52,7 @@ import {
   createCoreClient,
   createSessionWrapper,
   getAuthType,
+  getEnvoyPrefix,
   getLoginOptions,
   getSessionDetails,
 } from './SessionUtils';
@@ -170,7 +171,12 @@ function AppInit(props: AppInitProps) {
         navigator.userAgent
       );
 
-      const coreClient = createCoreClient();
+      const envoyPrefix = getEnvoyPrefix();
+      const options =
+        envoyPrefix != null
+          ? { headers: { 'envoy-prefix': envoyPrefix } }
+          : undefined;
+      const coreClient = createCoreClient(options);
       const authType = getAuthType();
       log.info(`Login using auth type ${authType}...`);
       const [loginOptions, sessionDetails] = await Promise.all([

packages/code-studio/src/main/SessionUtils.ts

@@ -3,6 +3,7 @@ import {
   SessionWrapper,
 } from '@deephaven/dashboard-core-plugins';
 import dh, {
+  ConnectOptions,
   CoreClient,
   IdeConnection,
   LoginOptions,
@@ -42,6 +43,11 @@ export function getAuthType(): AUTH_TYPE {
   }
 }
 
+export function getEnvoyPrefix(): string | null {
+  const searchParams = new URLSearchParams(window.location.search);
+  return searchParams.get('envoyPrefix');
+}
+
 /**
  * @returns New connection to the server
  */
@@ -89,12 +95,12 @@ export async function createSessionWrapper(
   };
 }
 
-export function createCoreClient(): CoreClient {
+export function createCoreClient(options?: ConnectOptions): CoreClient {
   const websocketUrl = getWebsocketUrl();
 
   log.info('createCoreClient', websocketUrl);
 
-  return new dh.CoreClient(websocketUrl);
+  return new dh.CoreClient(websocketUrl, options);
 }
 
 async function requestParentLoginOptions(): Promise<LoginOptions> {

packages/jsapi-types/src/dh.types.ts

@@ -1066,14 +1066,18 @@ export interface StorageService {
   createDirectory(path: string): Promise<void>;
 }
 
+export interface ConnectOptions {
+  headers?: Record<string, string>;
+}
+
 export interface CoreClientContructor extends Evented {
   EVENT_CONNECT: string;
   EVENT_DISCONNECT: string;
   EVENT_RECONNECT: string;
   EVENT_RECONNECT_AUTH_FAILED: string;
   EVENT_REFRESH_TOKEN_UPDATED: string;
   LOGIN_TYPE_ANONYMOUS: string;
-  new (serverUrl: string): CoreClient;
+  new (serverUrl: string, options?: ConnectOptions): CoreClient;
 }
 
 export interface CoreClient extends CoreClientContructor {