[Workspace] Capabilities service add dashboard admin flag (opensearch…

…-project#7103) * Capabilities service add dashboard admin flag Signed-off-by: yubonluo <yubonluo@amazon.com> * Capabilities service add dashboard admin flag Signed-off-by: yubonluo <yubonluo@amazon.com> * Changeset file for PR opensearch-project#7103 created/updated * optimize the code Signed-off-by: yubonluo <yubonluo@amazon.com> * optimize the code Signed-off-by: yubonluo <yubonluo@amazon.com> * if groups/users are not configured or [], login defaults to OSD Admin Signed-off-by: yubonluo <yubonluo@amazon.com> * optimize the code Signed-off-by: yubonluo <yubonluo@amazon.com> --------- Signed-off-by: yubonluo <yubonluo@amazon.com> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>
ashwin-pc · Jul 2, 2024 · bb9eeef · bb9eeef
1 parent 9ac3184
commit bb9eeef
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 4 deletions.
diff --git a/changelogs/fragments/7103.yml b/changelogs/fragments/7103.yml
@@ -0,0 +1,2 @@
+feat:
+- [Workspace] Capabilities service add dashboard admin flag ([#7103](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/7103))
diff --git a/src/plugins/workspace/server/plugin.test.ts b/src/plugins/workspace/server/plugin.test.ts
@@ -6,28 +6,55 @@
 import { OnPostAuthHandler, OnPreRoutingHandler } from 'src/core/server';
 import { coreMock, httpServerMock } from '../../../core/server/mocks';
 import { WorkspacePlugin } from './plugin';
-import { getWorkspaceState } from '../../../core/server/utils';
+import { getWorkspaceState, updateWorkspaceState } from '../../../core/server/utils';
 import * as utilsExports from './utils';
 
 describe('Workspace server plugin', () => {
   it('#setup', async () => {
     let value;
+    const capabilities = {} as any;
     const setupMock = coreMock.createSetup();
     const initializerContextConfigMock = coreMock.createPluginInitializerContext({
       enabled: true,
     });
+    const request = httpServerMock.createOpenSearchDashboardsRequest();
+
     setupMock.capabilities.registerProvider.mockImplementationOnce((fn) => (value = fn()));
+    setupMock.capabilities.registerSwitcher.mockImplementationOnce((fn) => {
+      return fn(request, capabilities);
+    });
+
     const workspacePlugin = new WorkspacePlugin(initializerContextConfigMock);
     await workspacePlugin.setup(setupMock);
     expect(value).toMatchInlineSnapshot(`
       Object {
+        "dashboards": Object {
+          "isDashboardAdmin": false,
+        },
         "workspaces": Object {
           "enabled": true,
           "permissionEnabled": true,
         },
       }
     `);
     expect(setupMock.savedObjects.addClientWrapper).toBeCalledTimes(4);
+
+    let registerSwitcher;
+    let result;
+    updateWorkspaceState(request, { isDashboardAdmin: false });
+    registerSwitcher = setupMock.capabilities.registerSwitcher.mock.calls[0][0];
+    result = registerSwitcher(request, capabilities);
+    expect(result).toEqual({ dashboards: { isDashboardAdmin: false } });
+
+    updateWorkspaceState(request, { isDashboardAdmin: true });
+    registerSwitcher = setupMock.capabilities.registerSwitcher.mock.calls[0][0];
+    result = registerSwitcher(request, capabilities);
+    expect(result).toEqual({ dashboards: { isDashboardAdmin: true } });
+
+    updateWorkspaceState(request, { isDashboardAdmin: undefined });
+    registerSwitcher = setupMock.capabilities.registerSwitcher.mock.calls[0][0];
+    result = registerSwitcher(request, capabilities);
+    expect(result).toEqual({ dashboards: { isDashboardAdmin: true } });
   });
 
   it('#proxyWorkspaceTrafficToRealHandler', async () => {

diff --git a/src/plugins/workspace/server/plugin.ts b/src/plugins/workspace/server/plugin.ts
@@ -30,6 +30,7 @@ import { WorkspaceSavedObjectsClientWrapper } from './saved_objects';
 import {
   cleanWorkspaceId,
   getWorkspaceIdFromUrl,
+  getWorkspaceState,
   updateWorkspaceState,
 } from '../../../core/server/utils';
 import { WorkspaceConflictSavedObjectsClientWrapper } from './saved_objects/saved_objects_wrapper_for_check_workspace_conflict';
@@ -157,7 +158,14 @@ export class WorkspacePlugin implements Plugin<WorkspacePluginSetup, WorkspacePl
         enabled: true,
         permissionEnabled: isPermissionControlEnabled,
       },
+      dashboards: { isDashboardAdmin: false },
     }));
+    // Dynamically update capabilities based on the auth information from request.
+    core.capabilities.registerSwitcher((request) => {
+      // If the value is undefined/true, the user is dashboard admin.
+      const isDashboardAdmin = getWorkspaceState(request).isDashboardAdmin !== false;
+      return { dashboards: { isDashboardAdmin } };
+    });
 
     return {
       client: this.client,

diff --git a/src/plugins/workspace/server/utils.test.ts b/src/plugins/workspace/server/utils.test.ts
@@ -128,7 +128,7 @@ describe('workspace utils', () => {
     const configGroups: string[] = [];
     const configUsers: string[] = [];
     updateDashboardAdminStateForRequest(mockRequest, groups, users, configGroups, configUsers);
-    expect(getWorkspaceState(mockRequest)?.isDashboardAdmin).toBe(false);
+    expect(getWorkspaceState(mockRequest)?.isDashboardAdmin).toBe(true);
   });
 
   it('should get correct admin config when admin config is enabled ', async () => {

diff --git a/src/plugins/workspace/server/utils.ts b/src/plugins/workspace/server/utils.ts
@@ -67,9 +67,9 @@ export const updateDashboardAdminStateForRequest = (
     updateWorkspaceState(request, { isDashboardAdmin: true });
     return;
   }
-
+  // If groups/users are not configured or [], login defaults to OSD Admin
   if (!configGroups.length && !configUsers.length) {
-    updateWorkspaceState(request, { isDashboardAdmin: false });
+    updateWorkspaceState(request, { isDashboardAdmin: true });
     return;
   }
   const groupMatchAny = groups.some((group) => configGroups.includes(group));