[Workspace] Add APIs to support plugin state in request (opensearch-p…

…roject#6303)

* feat: add APIs to support plugin state in request (#312)

* feat: add APIs to support plugin state in request

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

* feat: add APIs to support plugin state in request

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

---------

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

* feat: update CHANGELOG

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

* feat: update

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

* feat: use request app to store request workspace id

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

* feat: remove useless if

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

---------

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

CHANGELOG.md

@@ -77,6 +77,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - [Multiple Datasource] Fetch data source title for DataSourceView when only id is provided ([#6315](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6315)
 - [Workspace] Add permission control logic ([#6052](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6052))
 - [Multiple Datasource] Pass selected data sources to plugin consumers when the multi-select component initially loads ([#6333](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6333))
+- [Workspace] Add APIs to support plugin state in request ([#6303](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6303))
 
 ### 🐛 Bug Fixes
 

src/core/server/utils/index.ts

@@ -33,3 +33,4 @@ export * from './from_root';
 export * from './package_json';
 export * from './streams';
 export { getWorkspaceIdFromUrl, cleanWorkspaceId } from '../../utils';
+export { updateWorkspaceState, getWorkspaceState } from './workspace';

src/core/server/utils/workspace.test.ts

@@ -0,0 +1,19 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { httpServerMock } from '../mocks';
+import { getWorkspaceState, updateWorkspaceState } from './workspace';
+
+describe('updateWorkspaceState', () => {
+  it('update with payload', () => {
+    const requestMock = httpServerMock.createOpenSearchDashboardsRequest();
+    updateWorkspaceState(requestMock, {
+      requestWorkspaceId: 'foo',
+    });
+    expect(getWorkspaceState(requestMock)).toEqual({
+      requestWorkspaceId: 'foo',
+    });
+  });
+});

src/core/server/utils/workspace.ts

@@ -0,0 +1,36 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { OpenSearchDashboardsRequest, ensureRawRequest } from '../http/router';
+
+export interface WorkspaceState {
+  requestWorkspaceId?: string;
+}
+
+/**
+ * This function will be used as a proxy
+ * because `ensureRequest` is only importable from core module.
+ *
+ * @param workspaceId string
+ * @returns void
+ */
+export const updateWorkspaceState = (
+  request: OpenSearchDashboardsRequest,
+  payload: Partial<WorkspaceState>
+) => {
+  const rawRequest = ensureRawRequest(request);
+
+  rawRequest.app = {
+    ...rawRequest.app,
+    ...payload,
+  };
+};
+
+export const getWorkspaceState = (request: OpenSearchDashboardsRequest): WorkspaceState => {
+  const { requestWorkspaceId } = ensureRawRequest(request).app as WorkspaceState;
+  return {
+    requestWorkspaceId,
+  };
+};