Use ClusterConfig everywhere instead of overloading with clusterID

Summary: This tidies things up a bit and makes it a bit more explicit.

Test Plan: yarn typecheck works, yarn test works, yarn dev + load scripts, works.

Reviewers: michelle, nlanam

Reviewed By: nlanam

Signed-off-by: Vihang Mehta <vihang@pixielabs.ai>

Differential Revision: https://phab.corp.pixielabs.ai/D11738

GitOrigin-RevId: ddcf9d9

Author: vihangm

src/ui/src/api/api-test.ts

@@ -80,7 +80,7 @@ describe('Pixie TypeScript API Client', () => {
       jest.spyOn(client.getCloudClient(), 'getClusterConnection')
         .mockReturnValue({} as unknown as Promise<GQLClusterConnectionInfo>);
 
-      const out = await client.health('foo').toPromise();
+      const out = await client.health({ id: 'foo', passthroughClusterAddress: '' }).toPromise();
       expect(spy).toHaveBeenCalled();
       expect(out).toBe('bar');
     });
@@ -93,7 +93,11 @@ describe('Pixie TypeScript API Client', () => {
       jest.spyOn(client.getCloudClient(), 'getClusterConnection')
         .mockReturnValue({} as unknown as Promise<GQLClusterConnectionInfo>);
 
-      const out = await client.executeScript('foo', 'import px', { enableE2EEncryption: false }).toPromise();
+      const out = await client.executeScript(
+        { id: 'foo', passthroughClusterAddress: '' },
+        'import px',
+        { enableE2EEncryption: false },
+      ).toPromise();
       expect(spy).toHaveBeenCalled();
       expect(out).toBe('bar');
     });

src/ui/src/api/api.ts

@@ -57,10 +57,10 @@ export abstract class PixieAPIClientAbstract {
 
   readonly options: Required<PixieAPIClientOptions>;
 
-  abstract health(cluster: string | ClusterConfig): Observable<Status>;
+  abstract health(cluster: ClusterConfig): Observable<Status>;
 
   abstract executeScript(
-    cluster: string | ClusterConfig,
+    cluster: ClusterConfig,
     script: string,
     opts: ExecuteScriptOptions,
     funcs?: VizierQueryFunc[],
@@ -134,20 +134,12 @@ export class PixieAPIClient extends PixieAPIClientAbstract {
     return client;
   }
 
-  private async getClusterClient(cluster: string | ClusterConfig) {
-    let id: string;
-    let passthroughClusterAddress: string;
-    let attachCredentials = false;
-
-    if (typeof cluster === 'string') {
-      id = cluster;
-    } else {
-      ({ id, passthroughClusterAddress, attachCredentials } = cluster);
-    }
+  private async getClusterClient(cluster: ClusterConfig) {
+    const { id } = cluster;
 
     return this.clusterConnections.has(id)
       ? Promise.resolve(this.clusterConnections.get(id))
-      : this.createVizierClient({ id, passthroughClusterAddress, attachCredentials });
+      : this.createVizierClient(cluster);
   }
 
   // TODO(nick): Once the authentication model settles down, make this easier to use outside of the browser.
@@ -174,7 +166,7 @@ export class PixieAPIClient extends PixieAPIClientAbstract {
    * @param cluster Which cluster to use. Either just its ID, or a full config. If that cluster has previously been
    *        connected in this session, that connection will be reused without changing its configuration.
    */
-  health(cluster: string | ClusterConfig): Observable<Status> {
+  health(cluster: ClusterConfig): Observable<Status> {
     return from(this.getClusterClient(cluster))
       .pipe(switchMap((client) => client.health()));
   }
@@ -196,7 +188,7 @@ export class PixieAPIClient extends PixieAPIClientAbstract {
    * @param funcs Descriptions of which functions in the script to run, and what to do with their output.
    */
   executeScript(
-    cluster: string | ClusterConfig,
+    cluster: ClusterConfig,
     script: string,
     opts: ExecuteScriptOptions,
     funcs: VizierQueryFunc[] = [],

src/ui/src/testing/mocks/api-mock.ts

@@ -37,13 +37,13 @@ export class MockPixieAPIClient implements PixieAPIClientAbstract {
 
   // eslint-disable-next-line class-methods-use-this
   executeScript(
-    cluster: string | ClusterConfig, script: string, opts: ExecuteScriptOptions, funcs?: VizierQueryFunc[],
+    cluster: ClusterConfig, script: string, opts: ExecuteScriptOptions, funcs?: VizierQueryFunc[],
   ): Observable<ExecutionStateUpdate> {
     return observableOf({} as ExecutionStateUpdate);
   }
 
   // eslint-disable-next-line class-methods-use-this
-  health(cluster: string | ClusterConfig): Observable<Status> {
+  health(cluster: ClusterConfig): Observable<Status> {
     return observableOf(new Status().setCode(0));
   }