[Workspace] Add base path when parsing url in http service (#6233) (#…

…6451)

* fix: add base path when parse url in http service

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

* feat: add CHANGELOG

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

* feat: optimize unit test cases for parse clientBasePath from url when basePath enabled

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

* feat: add empty line before getWorkspaceIdFromURL method

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

* feat: optimize comment

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

* feat: optimize code

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

---------

Signed-off-by: SuZhou-Joe <[email protected]>
Co-authored-by: Xinrui Bai-amazon <[email protected]>
(cherry picked from commit 0dce00a)

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

@@ -83,21 +83,22 @@ describe('#setup()', () => {
     expect(setupResult.basePath.get()).toEqual('');
   });
 
-  it('setup basePath with workspaceId provided in window.location.href', () => {
+  it('setup basePath with workspaceId provided in window.location.href and basePath present in injectedMetadata', () => {
     const windowSpy = jest.spyOn(window, 'window', 'get');
     windowSpy.mockImplementation(
       () =>
         ({
           location: {
-            href: 'http://localhost/w/workspaceId/app',
+            href: 'http://localhost/base_path/w/workspaceId/app',
           },
         } as any)
     );
     const injectedMetadata = injectedMetadataServiceMock.createSetupContract();
+    injectedMetadata.getBasePath.mockReturnValue('/base_path');
     const fatalErrors = fatalErrorsServiceMock.createSetupContract();
     const httpService = new HttpService();
     const setupResult = httpService.setup({ fatalErrors, injectedMetadata });
-    expect(setupResult.basePath.get()).toEqual('/w/workspaceId');
+    expect(setupResult.basePath.get()).toEqual('/base_path/w/workspaceId');
     windowSpy.mockRestore();
   });
 });

src/core/public/http/http_service.ts

@@ -53,7 +53,7 @@ export class HttpService implements CoreService<HttpSetup, HttpStart> {
   public setup({ injectedMetadata, fatalErrors }: HttpDeps): HttpSetup {
     const opensearchDashboardsVersion = injectedMetadata.getOpenSearchDashboardsVersion();
     let clientBasePath = '';
-    const workspaceId = getWorkspaceIdFromUrl(window.location.href);
+    const workspaceId = getWorkspaceIdFromUrl(window.location.href, injectedMetadata.getBasePath());
     if (workspaceId) {
       clientBasePath = `${WORKSPACE_PATH_PREFIX}/${workspaceId}`;
     }

src/core/utils/workspace.test.ts

@@ -8,11 +8,11 @@ import { httpServiceMock } from '../public/mocks';
 
 describe('#getWorkspaceIdFromUrl', () => {
   it('return workspace when there is a match', () => {
-    expect(getWorkspaceIdFromUrl('http://localhost/w/foo')).toEqual('foo');
+    expect(getWorkspaceIdFromUrl('http://localhost/w/foo', '')).toEqual('foo');
   });
 
   it('return empty when there is not a match', () => {
-    expect(getWorkspaceIdFromUrl('http://localhost/w2/foo')).toEqual('');
+    expect(getWorkspaceIdFromUrl('http://localhost/w2/foo', '')).toEqual('');
   });
 
   it('return workspace when there is a match with basePath provided', () => {

src/core/utils/workspace.ts

@@ -6,7 +6,7 @@
 import { WORKSPACE_PATH_PREFIX } from './constants';
 import { IBasePath } from '../public';
 
-export const getWorkspaceIdFromUrl = (url: string, basePath?: string): string => {
+export const getWorkspaceIdFromUrl = (url: string, basePath: string): string => {
   const regexp = new RegExp(`^${basePath || ''}\/w\/([^\/]*)`);
   const urlObject = new URL(url);
   const matchedResult = urlObject.pathname.match(regexp);

src/plugins/workspace/public/plugin.ts

@@ -30,17 +30,17 @@ export class WorkspacePlugin implements Plugin<{}, {}, {}> {
       });
     }
   }
-  private getWorkspaceIdFromURL(basePath?: string): string | null {
-    return getWorkspaceIdFromUrl(window.location.href, basePath);
-  }
   public async setup(core: CoreSetup) {
     const workspaceClient = new WorkspaceClient(core.http, core.workspaces);
     await workspaceClient.init();
 
     /**
      * Retrieve workspace id from url
      */
-    const workspaceId = this.getWorkspaceIdFromURL(core.http.basePath.getBasePath());
+    const workspaceId = getWorkspaceIdFromUrl(
+      window.location.href,
+      core.http.basePath.getBasePath()
+    );
 
     if (workspaceId) {
       const result = await workspaceClient.enterWorkspace(workspaceId);

src/plugins/workspace/server/plugin.ts

@@ -27,7 +27,10 @@ export class WorkspacePlugin implements Plugin<{}, {}> {
      * Proxy all {basePath}/w/{workspaceId}{osdPath*} paths to {basePath}{osdPath*}
      */
     setupDeps.http.registerOnPreRouting(async (request, response, toolkit) => {
-      const workspaceId = getWorkspaceIdFromUrl(request.url.toString());
+      const workspaceId = getWorkspaceIdFromUrl(
+        request.url.toString(),
+        '' // No need to pass basePath here because the request.url will be rewrite by registerOnPreRouting method in `src/core/server/http/http_server.ts`
+      );
 
       if (workspaceId) {
         const requestUrl = new URL(request.url.toString());