Add interfaces and partial implement for public core.workspaces #4

SuZhou-Joe · 2023-06-08T08:37:42Z

Description

Issues Resolved

Screenshot

Testing the changes

Check List

ruanyl · 2023-06-09T08:02:51Z

src/core/public/core_system.ts

@@ -199,6 +202,7 @@ export class CoreSystem {
      const uiSettings = await this.uiSettings.start();
      const docLinks = this.docLinks.start({ injectedMetadata });
      const http = await this.http.start();
+      const workspaces = await this.workspaces.start({ http });


@SuZhou-Joe Should it pass savedObjects instead? like await this.workspaces.start({ savedObjects });
I thought workspace service will use savedObjects to interact with data store.

We will use the savedObjects client in server/workspaces. public/workspaces.service will only send specific http request to the routes server/workspaces registered.

Let me draw a diagram to better illustrate the dependency later.

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

raintygao · 2023-06-12T09:12:12Z

src/core/public/workspace/workspaces_client.ts

+    };
+  }
+
+  public async getCurrentWorkspaceId(): Promise<IResponse<WorkspaceAttribute['id']>> {


@SuZhou-Joe Can response of this function not be a promise?

It will be more extensible that we claim the response as promise and it may require some API calls when we need to fetch the id.

In my opinion, the service should have a state to store current workspace info and have a synchronous method to return so that other component can handle this logic easily. We can discuss this in scrum meeting.

raintygao · 2023-06-12T09:30:49Z

src/core/public/workspace/workspaces_client.ts

+    options?: WorkspaceFindOptions
+  ): Promise<
+    IResponse<
+      WorkspaceAttribute & {


@SuZhou-Joe There should respond a array of WorkspaceAttribute instead of single?

You are right, let me modify this.

https://github.com/ruanyl/OpenSearch-Dashboards/pull/7/files#diff-78985f31a7d8676a8244eb638e8090f4597042e979465020e880e8e91e03dd07

raintygao · 2023-06-13T08:13:24Z

src/core/public/workspace/index.ts

+ */
+export { WorkspacesClientContract, WorkspacesClient } from './workspaces_client';
+export { WorkspacesStart, WorkspacesService } from './workspaces_service';
+export { WorkspaceAttribute, WorkspaceFindOptions } from '../../server/types';


@SuZhou-Joe these variables should be exported in public level, otherwise there will be an error when imported.

…objects client wrapper (#230) * feat: add basic workspace saved objects client wrapper Signed-off-by: Lin Wang <[email protected]> * feat: add unit test (#2) Signed-off-by: SuZhou-Joe <[email protected]> * feat: update client wrapper Signed-off-by: tygao <[email protected]> * feat: init permission control in workspace plugin Signed-off-by: Lin Wang <[email protected]> * Support disable permission check on workspace (#228) * support disable permission check for workspace Signed-off-by: Hailong Cui <[email protected]> * fix typos Signed-off-by: Hailong Cui <[email protected]> --------- Signed-off-by: Hailong Cui <[email protected]> * feat: add ACLSearchParams consumer in repository (#3) Signed-off-by: SuZhou-Joe <[email protected]> * fix: ACLSearchParams missing in search dsl Signed-off-by: Lin Wang <[email protected]> * test: add integration test for workspace saved objects client wrapper Signed-off-by: Lin Wang <[email protected]> * style: add empty line under license Signed-off-by: Lin Wang <[email protected]> * test: enable workspace permission control for integration tests Signed-off-by: Lin Wang <[email protected]> * feat: add workspace into includeHiddenTypes (#249) * feat: add workspace into includeHiddenTypes of client wrapper and permission control client Signed-off-by: SuZhou-Joe <[email protected]> * fix: hiddenType side effect Signed-off-by: SuZhou-Joe <[email protected]> --------- Signed-off-by: SuZhou-Joe <[email protected]> * fix workspace client wrapper integration tests Signed-off-by: Lin Wang <[email protected]> * add permissions fields to workspace CRUD APIs Signed-off-by: Lin Wang <[email protected]> * Move WorkspacePermissionMode inside workspace plugin Signed-off-by: Lin Wang <[email protected]> * Address pr comments Signed-off-by: Lin Wang <[email protected]> * Remove ACLSearchParams in public SavedObjectsFindOptions Signed-off-by: Lin Wang <[email protected]> * Remove lodash and Add default permissionModes Signed-off-by: Lin Wang <[email protected]> * feat: address concerns on ensureRawRequest (#4) * feat: address concerns on ensureRawRequest Signed-off-by: SuZhou-Joe <[email protected]> * feat: add check for empty array Signed-off-by: SuZhou-Joe <[email protected]> * feat: make find api backward compatible Signed-off-by: SuZhou-Joe <[email protected]> * feat: remove useless code Signed-off-by: SuZhou-Joe <[email protected]> --------- Signed-off-by: SuZhou-Joe <[email protected]> * Update annotations and error Signed-off-by: Lin Wang <[email protected]> * Add unit tests for worksapce saved objects client wrapper Signed-off-by: Lin Wang <[email protected]> * Remove getPrincipalsOfObjects in permission Signed-off-by: Lin Wang <[email protected]> * Fix permissionEnabled flag missed in workspace plugin setup test Signed-off-by: Lin Wang <[email protected]> * Change back to Not Authorized error Signed-off-by: Lin Wang <[email protected]> * Fix unit tests for query_params and plugin setup Signed-off-by: Lin Wang <[email protected]> * Fix unittests in workspace server utils Signed-off-by: Lin Wang <[email protected]> * feat: add workspacesSearchOperators to decouple ACLSearchParams Signed-off-by: SuZhou-Joe <[email protected]> * feat: update test cases Signed-off-by: SuZhou-Joe <[email protected]> * feat: optimize test cases Signed-off-by: SuZhou-Joe <[email protected]> * feat: optimize comment Signed-off-by: SuZhou-Joe <[email protected]> * feat: omit defaultSearchOperator in public savedobjetcs client Signed-off-by: SuZhou-Joe <[email protected]> * feat: omit workspacesSearchOperator field Signed-off-by: SuZhou-Joe <[email protected]> --------- Signed-off-by: Lin Wang <[email protected]> Signed-off-by: SuZhou-Joe <[email protected]> Signed-off-by: tygao <[email protected]> Signed-off-by: Hailong Cui <[email protected]> Co-authored-by: Lin Wang <[email protected]> Co-authored-by: SuZhou-Joe <[email protected]> Co-authored-by: Hailong Cui <[email protected]>

ruanyl reviewed Jun 9, 2023

View reviewed changes

SuZhou-Joe added 4 commits June 12, 2023 10:39

feature: add public/workspaces service

d661cf3

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

feat: add interfaces for workspaces client

580343a

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

feat: add interfaces for workspaces client

a276998

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

feat: add interfaces for workspaces client

02f73fa

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

SuZhou-Joe force-pushed the feature/workspace-service branch from 0860a9c to 02f73fa Compare June 12, 2023 02:39

SuZhou-Joe merged commit 3c5df9d into ruanyl:workspace Jun 12, 2023

raintygao reviewed Jun 12, 2023

View reviewed changes

raintygao reviewed Jun 13, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add interfaces and partial implement for public core.workspaces #4

Add interfaces and partial implement for public core.workspaces #4

SuZhou-Joe commented Jun 8, 2023 •

edited

Loading

ruanyl Jun 9, 2023

SuZhou-Joe Jun 9, 2023 •

edited

Loading

raintygao Jun 12, 2023

SuZhou-Joe Jun 13, 2023

raintygao Jun 13, 2023

raintygao Jun 12, 2023

SuZhou-Joe Jun 13, 2023

SuZhou-Joe Jun 13, 2023

raintygao Jun 13, 2023 •

edited

Loading

Add interfaces and partial implement for public core.workspaces #4

Add interfaces and partial implement for public core.workspaces #4

Conversation

SuZhou-Joe commented Jun 8, 2023 • edited Loading

Description

Issues Resolved

Screenshot

Testing the changes

Check List

ruanyl Jun 9, 2023

Choose a reason for hiding this comment

SuZhou-Joe Jun 9, 2023 • edited Loading

Choose a reason for hiding this comment

raintygao Jun 12, 2023

Choose a reason for hiding this comment

SuZhou-Joe Jun 13, 2023

Choose a reason for hiding this comment

raintygao Jun 13, 2023

Choose a reason for hiding this comment

raintygao Jun 12, 2023

Choose a reason for hiding this comment

SuZhou-Joe Jun 13, 2023

Choose a reason for hiding this comment

SuZhou-Joe Jun 13, 2023

Choose a reason for hiding this comment

raintygao Jun 13, 2023 • edited Loading

Choose a reason for hiding this comment

SuZhou-Joe commented Jun 8, 2023 •

edited

Loading

SuZhou-Joe Jun 9, 2023 •

edited

Loading

raintygao Jun 13, 2023 •

edited

Loading