feat: rename the workspaceBasePath to clientBasePath

Signed-off-by: SuZhou-Joe <[email protected]>

src/core/public/http/base_path.test.ts

@@ -111,7 +111,7 @@ describe('BasePath', () => {
     });
   });
 
-  describe('workspaceBasePath', () => {
+  describe('clientBasePath', () => {
     it('get path with workspace', () => {
       expect(new BasePath('/foo/bar', '/foo/bar', '/workspace').get()).toEqual(
         '/foo/bar/workspace'

src/core/public/http/base_path.ts

@@ -35,11 +35,11 @@ export class BasePath {
   constructor(
     private readonly basePath: string = '',
     public readonly serverBasePath: string = basePath,
-    private readonly workspaceBasePath: string = ''
+    private readonly clientBasePath: string = ''
   ) {}
 
   public get = () => {
-    return `${this.basePath}${this.workspaceBasePath}`;
+    return `${this.basePath}${this.clientBasePath}`;
   };
 
   public getBasePath = () => {

src/core/public/http/http_service.mock.ts

@@ -39,7 +39,7 @@ export type HttpSetupMock = jest.Mocked<HttpSetup> & {
   anonymousPaths: jest.Mocked<HttpSetup['anonymousPaths']>;
 };
 
-const createServiceMock = ({ basePath = '', workspaceBasePath = '' } = {}): HttpSetupMock => ({
+const createServiceMock = ({ basePath = '', clientBasePath = '' } = {}): HttpSetupMock => ({
   fetch: jest.fn(),
   get: jest.fn(),
   head: jest.fn(),
@@ -48,7 +48,7 @@ const createServiceMock = ({ basePath = '', workspaceBasePath = '' } = {}): Http
   patch: jest.fn(),
   delete: jest.fn(),
   options: jest.fn(),
-  basePath: new BasePath(basePath, undefined, workspaceBasePath),
+  basePath: new BasePath(basePath, undefined, clientBasePath),
   anonymousPaths: {
     register: jest.fn(),
     isAnonymous: jest.fn(),
@@ -58,14 +58,14 @@ const createServiceMock = ({ basePath = '', workspaceBasePath = '' } = {}): Http
   intercept: jest.fn(),
 });
 
-const createMock = ({ basePath = '', workspaceBasePath = '' } = {}) => {
+const createMock = ({ basePath = '', clientBasePath = '' } = {}) => {
   const mocked: jest.Mocked<PublicMethodsOf<HttpService>> = {
     setup: jest.fn(),
     start: jest.fn(),
     stop: jest.fn(),
   };
-  mocked.setup.mockReturnValue(createServiceMock({ basePath, workspaceBasePath }));
-  mocked.start.mockReturnValue(createServiceMock({ basePath, workspaceBasePath }));
+  mocked.setup.mockReturnValue(createServiceMock({ basePath, clientBasePath }));
+  mocked.start.mockReturnValue(createServiceMock({ basePath, clientBasePath }));
   return mocked;
 };
 

src/core/public/http/http_service.ts

@@ -52,7 +52,7 @@ export class HttpService implements CoreService<HttpSetup, HttpStart> {
 
   public setup({ injectedMetadata, fatalErrors }: HttpDeps): HttpSetup {
     const opensearchDashboardsVersion = injectedMetadata.getOpenSearchDashboardsVersion();
-    let workspaceBasePath = '';
+    let clientBasePath = '';
     const plugins = injectedMetadata.getPlugins();
     const findWorkspaceConfig = plugins.find((plugin) => plugin.id === 'workspace');
     // Only try to get workspace id from url when workspace feature is enabled
@@ -62,13 +62,13 @@ export class HttpService implements CoreService<HttpSetup, HttpStart> {
         injectedMetadata.getBasePath()
       );
       if (workspaceId) {
-        workspaceBasePath = `${WORKSPACE_PATH_PREFIX}/${workspaceId}`;
+        clientBasePath = `${WORKSPACE_PATH_PREFIX}/${workspaceId}`;
       }
     }
     const basePath = new BasePath(
       injectedMetadata.getBasePath(),
       injectedMetadata.getServerBasePath(),
-      workspaceBasePath
+      clientBasePath
     );
     const fetchService = new Fetch({ basePath, opensearchDashboardsVersion });
     const loadingCount = this.loadingCount.setup({ fatalErrors });

src/core/utils/workspace.test.ts

@@ -25,16 +25,16 @@ describe('#getWorkspaceIdFromUrl', () => {
 });
 
 describe('#formatUrlWithWorkspaceId', () => {
-  const basePathWithoutWorkspaceBasePath = httpServiceMock.createSetupContract().basePath;
+  const basePathWithoutClientBasePath = httpServiceMock.createSetupContract().basePath;
   it('return url with workspace prefix when format with a id provided', () => {
     expect(
-      formatUrlWithWorkspaceId('/app/dashboard', 'foo', basePathWithoutWorkspaceBasePath)
+      formatUrlWithWorkspaceId('/app/dashboard', 'foo', basePathWithoutClientBasePath)
     ).toEqual('http://localhost/w/foo/app/dashboard');
   });
 
   it('return url without workspace prefix when format without a id', () => {
     expect(
-      formatUrlWithWorkspaceId('/w/foo/app/dashboard', '', basePathWithoutWorkspaceBasePath)
+      formatUrlWithWorkspaceId('/w/foo/app/dashboard', '', basePathWithoutClientBasePath)
     ).toEqual('http://localhost/app/dashboard');
   });
 });