Do not cache the service account token in the devWorkspace client (#1283)

vinokurig · web-flow · commit e3d2d8deff31 · 2025-01-02T12:32:23.000+02:00
diff --git a/packages/dashboard-backend/src/__tests__/app.spec.ts b/packages/dashboard-backend/src/__tests__/app.spec.ts
@@ -20,6 +20,7 @@ const mockProcessExit = jest.fn();
 });
 
 jest.mock('../routes/api/helpers/getDevWorkspaceClient.ts');
+jest.mock('../routes/api/helpers/getServiceAccountToken.ts');
 describe('App', () => {
   afterEach(() => {
     jest.clearAllMocks();
diff --git a/packages/dashboard-backend/src/app.ts b/packages/dashboard-backend/src/app.ts
@@ -34,7 +34,8 @@ import { registerEditorsRoutes } from '@/routes/api/editors';
 import { registerEventsRoutes } from '@/routes/api/events';
 import { registerGettingStartedSamplesRoutes } from '@/routes/api/gettingStartedSample';
 import { registerGitConfigRoutes } from '@/routes/api/gitConfig';
-import { getDevWorkspaceSingletonClient } from '@/routes/api/helpers/getDevWorkspaceClient';
+import { getDevWorkspaceClient } from '@/routes/api/helpers/getDevWorkspaceClient';
+import { getServiceAccountToken } from '@/routes/api/helpers/getServiceAccountToken';
 import { registerKubeConfigRoute } from '@/routes/api/kubeConfig';
 import { registerPersonalAccessTokenRoutes } from '@/routes/api/personalAccessToken';
 import { registerPodmanLoginRoute } from '@/routes/api/podmanLogin';
@@ -71,8 +72,8 @@ export default async function buildApp(server: FastifyInstance): Promise<unknown
     },
   );
 
-  const { devWorkspaceClusterServiceApi } = getDevWorkspaceSingletonClient();
-  await devWorkspaceClusterServiceApi.watchInAllNamespaces();
+  const devWorkspaceClient = getDevWorkspaceClient(getServiceAccountToken());
+  await devWorkspaceClient.devWorkspaceClusterApi.watchInAllNamespaces();
 
   server.register(import('@fastify/rate-limit'));
 
diff --git a/packages/dashboard-backend/src/devworkspaceClient/__tests__/index.spec.ts b/packages/dashboard-backend/src/devworkspaceClient/__tests__/index.spec.ts
@@ -13,6 +13,7 @@
 import * as mockClientNode from '@kubernetes/client-node';
 import { KubeConfig } from '@kubernetes/client-node';
 
+import { DevWorkspaceClient } from '@/devworkspaceClient';
 import { DevWorkspaceApiService } from '@/devworkspaceClient/services/devWorkspaceApi';
 import { DevWorkspaceClusterApiService } from '@/devworkspaceClient/services/devWorkspaceClusterApiService';
 import { DevWorkspaceTemplateApiService } from '@/devworkspaceClient/services/devWorkspaceTemplateApi';
@@ -27,9 +28,7 @@ import { ServerConfigApiService } from '@/devworkspaceClient/services/serverConf
 import { SshKeysService } from '@/devworkspaceClient/services/sshKeysApi';
 import { UserProfileApiService } from '@/devworkspaceClient/services/userProfileApi';
 
-import { DevWorkspaceClient, DevWorkspaceSingletonClient } from '..';
-
-jest.mock('../services/devWorkspaceApi.ts');
+jest.mock('@/devworkspaceClient/services/devWorkspaceApi.ts');
 
 describe('DevWorkspace client', () => {
   let config: KubeConfig;
@@ -50,6 +49,7 @@ describe('DevWorkspace client', () => {
     expect(client.devworkspaceApi).toBeInstanceOf(DevWorkspaceApiService);
     expect(client.dockerConfigApi).toBeInstanceOf(DockerConfigApiService);
     expect(client.eventApi).toBeInstanceOf(EventApiService);
+    expect(client.devWorkspaceClusterApi).toBeInstanceOf(DevWorkspaceClusterApiService);
     expect(client.kubeConfigApi).toBeInstanceOf(KubeConfigApiService);
     expect(client.logsApi).toBeInstanceOf(LogsApiService);
     expect(client.podApi).toBeInstanceOf(PodApiService);
@@ -60,28 +60,3 @@ describe('DevWorkspace client', () => {
     expect(client.sshKeysApi).toBeInstanceOf(SshKeysService);
   });
 });
-
-describe('DevWorkspace singleton client', () => {
-  let config: KubeConfig;
-  beforeEach(() => {
-    const { KubeConfig } = mockClientNode;
-    config = new KubeConfig();
-    config.makeApiClient = jest.fn().mockImplementation(() => ({}));
-  });
-
-  afterEach(() => {
-    jest.clearAllMocks();
-  });
-
-  test('client', () => {
-    const client = DevWorkspaceSingletonClient.getInstance(config);
-
-    expect(client.devWorkspaceClusterServiceApi).toBeInstanceOf(DevWorkspaceClusterApiService);
-  });
-
-  test('return same instance', () => {
-    const client = DevWorkspaceSingletonClient.getInstance(config);
-
-    expect(client.devWorkspaceClusterServiceApi).toEqual(client.devWorkspaceClusterServiceApi);
-  });
-});
diff --git a/packages/dashboard-backend/src/devworkspaceClient/index.ts b/packages/dashboard-backend/src/devworkspaceClient/index.ts
@@ -35,7 +35,6 @@ import {
   IDevWorkspaceApi,
   IDevWorkspaceClient,
   IDevWorkspaceClusterApi,
-  IDevWorkspaceSingletonClient,
   IDevWorkspaceTemplateApi,
   IDockerConfigApi,
   IEditorsApi,
@@ -110,6 +109,10 @@ export class DevWorkspaceClient implements IDevWorkspaceClient {
     return new GitConfigApiService(this.kubeConfig);
   }
 
+  get devWorkspaceClusterApi(): IDevWorkspaceClusterApi {
+    return new DevWorkspaceClusterApiService(this.kubeConfig);
+  }
+
   get gettingStartedSampleApi(): IGettingStartedSampleApi {
     return new GettingStartedSamplesApiService(this.kubeConfig);
   }
@@ -130,22 +133,3 @@ export class DevWorkspaceClient implements IDevWorkspaceClient {
     return new WorkspacePreferencesApiService(this.kubeConfig);
   }
 }
-
-let devWorkspaceSingletonClient: DevWorkspaceSingletonClient;
-
-/**
- * Singleton client for devworkspace services.
- */
-export class DevWorkspaceSingletonClient implements IDevWorkspaceSingletonClient {
-  static getInstance(kc: k8s.KubeConfig): DevWorkspaceSingletonClient {
-    if (!devWorkspaceSingletonClient) {
-      devWorkspaceSingletonClient = new DevWorkspaceSingletonClient(kc);
-    }
-    return devWorkspaceSingletonClient;
-  }
-
-  public readonly devWorkspaceClusterServiceApi: IDevWorkspaceClusterApi;
-  private constructor(kc: k8s.KubeConfig) {
-    this.devWorkspaceClusterServiceApi = new DevWorkspaceClusterApiService(kc);
-  }
-}
diff --git a/packages/dashboard-backend/src/routes/__tests__/factoryAcceptanceRedirect.spec.ts b/packages/dashboard-backend/src/routes/__tests__/factoryAcceptanceRedirect.spec.ts
@@ -15,6 +15,7 @@ import { FastifyInstance } from 'fastify';
 import { setup, teardown } from '@/utils/appBuilder';
 
 jest.mock('../api/helpers/getDevWorkspaceClient.ts');
+jest.mock('../api/helpers/getServiceAccountToken.ts');
 describe('Factory Acceptance Redirect', () => {
   let app: FastifyInstance;
 
diff --git a/packages/dashboard-backend/src/routes/api/__tests__/clusterInfo.spec.ts b/packages/dashboard-backend/src/routes/api/__tests__/clusterInfo.spec.ts
@@ -17,6 +17,7 @@ import { baseApiPath } from '@/constants/config';
 import { setup, teardown } from '@/utils/appBuilder';
 
 jest.mock('../helpers/getDevWorkspaceClient.ts');
+jest.mock('../helpers/getServiceAccountToken.ts');
 describe('Cluster Info Route', () => {
   let app: FastifyInstance;
   const clusterConsoleUrl = 'cluster-console-url';
diff --git a/packages/dashboard-backend/src/routes/api/__tests__/dataResolver.spec.ts b/packages/dashboard-backend/src/routes/api/__tests__/dataResolver.spec.ts
@@ -19,6 +19,7 @@ import { setup, teardown } from '@/utils/appBuilder';
 
 jest.mock('@/routes/api/helpers/getCertificateAuthority');
 jest.mock('../helpers/getDevWorkspaceClient.ts');
+jest.mock('../helpers/getServiceAccountToken.ts');
 const axiosInstanceMock = jest.fn();
 (axiosInstance.get as jest.Mock).mockImplementation(axiosInstanceMock);
 const defaultAxiosInstanceMock = jest.fn();
diff --git a/packages/dashboard-backend/src/routes/api/__tests__/devworkspaceTemplates.spec.ts b/packages/dashboard-backend/src/routes/api/__tests__/devworkspaceTemplates.spec.ts
@@ -21,6 +21,7 @@ import {
 import { setup, teardown } from '@/utils/appBuilder';
 
 jest.mock('../helpers/getDevWorkspaceClient.ts');
+jest.mock('../helpers/getServiceAccountToken.ts');
 jest.mock('../helpers/getToken.ts');
 
 describe('DevWorkspaceTemplates Routes', () => {
diff --git a/packages/dashboard-backend/src/routes/api/__tests__/devworkspaces.spec.ts b/packages/dashboard-backend/src/routes/api/__tests__/devworkspaces.spec.ts
@@ -22,6 +22,7 @@ import { setup, teardown } from '@/utils/appBuilder';
 
 jest.mock('../helpers/getDevWorkspaceClient.ts');
 jest.mock('../helpers/getToken.ts');
+jest.mock('../helpers/getServiceAccountToken.ts');
 
 describe('DevWorkspaces Routes', () => {
   let app: FastifyInstance;
diff --git a/packages/dashboard-backend/src/routes/api/__tests__/dockerConfig.spec.ts b/packages/dashboard-backend/src/routes/api/__tests__/dockerConfig.spec.ts
@@ -18,6 +18,7 @@ import { setup, teardown } from '@/utils/appBuilder';
 
 jest.mock('../helpers/getDevWorkspaceClient.ts');
 jest.mock('../helpers/getToken.ts');
+jest.mock('../helpers/getServiceAccountToken.ts');
 
 describe('Docker Config Routes', () => {
   let app: FastifyInstance;
diff --git a/packages/dashboard-backend/src/routes/api/__tests__/events.spec.ts b/packages/dashboard-backend/src/routes/api/__tests__/events.spec.ts
@@ -18,6 +18,7 @@ import { setup, teardown } from '@/utils/appBuilder';
 
 jest.mock('../helpers/getToken.ts');
 jest.mock('../helpers/getDevWorkspaceClient.ts');
+jest.mock('../helpers/getServiceAccountToken.ts');
 
 describe('Events Route', () => {
   let app: FastifyInstance;
diff --git a/packages/dashboard-backend/src/routes/api/__tests__/gitConfig.spec.ts b/packages/dashboard-backend/src/routes/api/__tests__/gitConfig.spec.ts
@@ -25,13 +25,12 @@ jest.mock('../helpers/getDevWorkspaceClient.ts', () => ({
       read: mockRead,
       patch: mockPatch,
     },
-  }),
-  getDevWorkspaceSingletonClient: () => ({
-    devWorkspaceClusterServiceApi: {
+    devWorkspaceClusterApi: {
       watchInAllNamespaces: jest.fn().mockResolvedValueOnce(true),
     },
   }),
 }));
+jest.mock('../helpers/getServiceAccountToken.ts');
 jest.mock('../helpers/getToken.ts');
 
 describe('Gitconfig Routes', () => {
diff --git a/packages/dashboard-backend/src/routes/api/__tests__/kubeConfig.spec.ts b/packages/dashboard-backend/src/routes/api/__tests__/kubeConfig.spec.ts
@@ -17,6 +17,7 @@ import { setup, teardown } from '@/utils/appBuilder';
 
 jest.mock('../helpers/getDevWorkspaceClient.ts');
 jest.mock('../helpers/getToken.ts');
+jest.mock('../helpers/getServiceAccountToken.ts');
 
 describe('Kube Config Route', () => {
   let app: FastifyInstance;
diff --git a/packages/dashboard-backend/src/routes/api/__tests__/personalAccessToken.spec.ts b/packages/dashboard-backend/src/routes/api/__tests__/personalAccessToken.spec.ts
@@ -19,6 +19,7 @@ import { setup, teardown } from '@/utils/appBuilder';
 
 jest.mock('../helpers/getToken.ts');
 jest.mock('../helpers/getDevWorkspaceClient.ts');
+jest.mock('../helpers/getServiceAccountToken.ts');
 
 describe('Personal Access Token Route', () => {
   let app: FastifyInstance;
diff --git a/packages/dashboard-backend/src/routes/api/__tests__/pods.spec.ts b/packages/dashboard-backend/src/routes/api/__tests__/pods.spec.ts
@@ -18,6 +18,7 @@ import { setup, teardown } from '@/utils/appBuilder';
 
 jest.mock('../helpers/getToken.ts');
 jest.mock('../helpers/getDevWorkspaceClient.ts');
+jest.mock('../helpers/getServiceAccountToken.ts');
 
 describe('Pods Route', () => {
   let app: FastifyInstance;
diff --git a/packages/dashboard-backend/src/routes/api/__tests__/sshKeys.spec.ts b/packages/dashboard-backend/src/routes/api/__tests__/sshKeys.spec.ts
@@ -19,6 +19,7 @@ import { setup, teardown } from '@/utils/appBuilder';
 
 jest.mock('../helpers/getToken.ts');
 jest.mock('../helpers/getDevWorkspaceClient.ts');
+jest.mock('../helpers/getServiceAccountToken.ts');
 
 describe('SSH Keys Route', () => {
   let app: FastifyInstance;
diff --git a/packages/dashboard-backend/src/routes/api/__tests__/workspacePreferences.spec.ts b/packages/dashboard-backend/src/routes/api/__tests__/workspacePreferences.spec.ts
@@ -18,6 +18,7 @@ import { setup, teardown } from '@/utils/appBuilder';
 
 jest.mock('../helpers/getToken.ts');
 jest.mock('../helpers/getDevWorkspaceClient.ts');
+jest.mock('../helpers/getServiceAccountToken.ts');
 
 describe('Workspace Preferences', () => {
   let app: FastifyInstance;
diff --git a/packages/dashboard-backend/src/routes/api/devworkspaceCluster.ts b/packages/dashboard-backend/src/routes/api/devworkspaceCluster.ts
@@ -13,7 +13,8 @@
 import { FastifyInstance } from 'fastify';
 
 import { baseApiPath } from '@/constants/config';
-import { getDevWorkspaceSingletonClient } from '@/routes/api/helpers/getDevWorkspaceClient';
+import { getDevWorkspaceClient } from '@/routes/api/helpers/getDevWorkspaceClient';
+import { getServiceAccountToken } from '@/routes/api/helpers/getServiceAccountToken';
 import { getSchema } from '@/services/helpers';
 
 const tags = ['Devworkspace Cluster'];
@@ -24,8 +25,8 @@ export function registerDevWorkspaceClusterRoutes(instance: FastifyInstance) {
       `${baseApiPath}/devworkspace/running-workspaces-cluster-limit-exceeded`,
       getSchema({ tags }),
       async function () {
-        const { devWorkspaceClusterServiceApi } = getDevWorkspaceSingletonClient();
-        return await devWorkspaceClusterServiceApi.isRunningWorkspacesClusterLimitExceeded();
+        const devWorkspaceClient = getDevWorkspaceClient(getServiceAccountToken());
+        return await devWorkspaceClient.devWorkspaceClusterApi.isRunningWorkspacesClusterLimitExceeded();
       },
     );
   });
diff --git a/packages/dashboard-backend/src/routes/api/helpers/__mocks__/getDevWorkspaceClient.ts b/packages/dashboard-backend/src/routes/api/helpers/__mocks__/getDevWorkspaceClient.ts
@@ -23,7 +23,6 @@ import { IncomingHttpHeaders } from 'http';
 
 import {
   DevWorkspaceClient,
-  DevWorkspaceSingletonClient,
   IDevWorkspaceApi,
   IDevWorkspaceClusterApi,
   IDevWorkspaceTemplateApi,
@@ -244,6 +243,13 @@ export const getDevWorkspaceClient = jest.fn(
         read: _namespace => Promise.resolve({} as api.IGitConfig),
         patch: (_namespace, _gitconfig) => Promise.resolve({} as api.IGitConfig),
       } as IGitConfigApi,
+      devWorkspaceClusterApi: {
+        isRunningWorkspacesClusterLimitExceeded: () =>
+          Promise.resolve(stubIsRunningWorkspaceClusterLimitExceeded),
+        watchInAllNamespaces(): Promise<void> {
+          return Promise.resolve();
+        },
+      } as IDevWorkspaceClusterApi,
       sshKeysApi: {
         add: (_namespace, _sshKey) => Promise.resolve({} as api.SshKey),
         delete: (_namespace, _name) => Promise.resolve(),
@@ -258,17 +264,3 @@ export const getDevWorkspaceClient = jest.fn(
     } as DevWorkspaceClient;
   },
 );
-
-export const getDevWorkspaceSingletonClient = jest.fn(
-  (..._args: Parameters<typeof helper>): DevWorkspaceSingletonClient => {
-    return {
-      devWorkspaceClusterServiceApi: {
-        isRunningWorkspacesClusterLimitExceeded: () =>
-          Promise.resolve(stubIsRunningWorkspaceClusterLimitExceeded),
-        watchInAllNamespaces(): Promise<void> {
-          return Promise.resolve();
-        },
-      } as IDevWorkspaceClusterApi,
-    };
-  },
-);
diff --git a/packages/dashboard-backend/src/routes/api/helpers/getDevWorkspaceClient.ts b/packages/dashboard-backend/src/routes/api/helpers/getDevWorkspaceClient.ts
@@ -10,9 +10,8 @@
  *   Red Hat, Inc. - initial API and implementation
  */
 
-import { DevWorkspaceClient, DevWorkspaceSingletonClient } from '@/devworkspaceClient';
+import { DevWorkspaceClient } from '@/devworkspaceClient';
 import { DwClientProvider } from '@/services/kubeclient/dwClientProvider';
-import { DwSingletonClientProvider } from '@/services/kubeclient/dwSingletonClientProvider';
 
 /**
  * Creates DevWorkspace Client depending on the context for the specified request.
@@ -21,8 +20,3 @@ export function getDevWorkspaceClient(token: string): DevWorkspaceClient {
   const dwClientProvider = new DwClientProvider();
   return dwClientProvider.getDWClient(token);
 }
-
-export function getDevWorkspaceSingletonClient(): DevWorkspaceSingletonClient {
-  const dwSingletonClientProvider = DwSingletonClientProvider.getInstance();
-  return dwSingletonClientProvider.getDWSingletonClient();
-}
diff --git a/packages/dashboard-backend/src/services/kubeclient/__tests__/dwSingletonClientProvider.spec.ts b/packages/dashboard-backend/src/services/kubeclient/__tests__/dwSingletonClientProvider.spec.ts
diff --git a/packages/dashboard-backend/src/services/kubeclient/dwSingletonClientProvider.ts b/packages/dashboard-backend/src/services/kubeclient/dwSingletonClientProvider.ts
