[Workspace] Add APIs to support plugin state in request

[SuZhou-Joe]

Description

Workspace need to store its workspace id throughout the whole request lifecycle but for now OpensearchDashboardsRequest only provides readonly interfaces. In order to add some states into the request without any impact on the response header or the connection between OSD and opensearch cluster, workspace will leverage the app interface in the raw request.

How will the functions be used in workspace:

• updateWorkspaceState: https://github.com/ruanyl/OpenSearch-Dashboards/pull/293/files#diff-5462d700cd760de03fd73de704ceaf51a9f6a519df36429a3b384a21d4f9b68bR56 . workspace will parse the workspaceId from the real request and add the workspace id into workspaceState, which under the hood add requestWorkspaceId into rawRequest.app.
• getWorkspaceState: https://github.com/ruanyl/OpenSearch-Dashboards/pull/293/files#diff-4ca4e52d5f1dbb92bcdb3694cd11e6f902fa3acadda1ab0f2e7045a0cd9e573dR25 In a wrapper of saved objects client, workspace will detect if there is requestWorkspaceId inside workspace state and try to append the workspace into the params accordingly.

Issues Resolved

partial resolve #6130

Screenshot

Testing the changes

This PR only introduces a function to mutate the request.app.requestWorkspaceId field and has already been covered by unit test. Will have a following PR to consume such function and we can test in that PR.

Check List

• All tests pass
  • yarn test:jest
  • yarn test:jest_integration
• New functionality includes testing.
• New functionality has been documented.
• Update CHANGELOG.md
• Commits are signed per the DCO using --signoff

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.51%. Comparing base (b92387a) to head (cf21980).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #6303   +/-   ##
=======================================
  Coverage   67.50%   67.51%           
=======================================
  Files        3376     3377    +1     
  Lines       65830    65836    +6     
  Branches    10648    10648           
=======================================
+ Hits        44441    44449    +8     
+ Misses      18803    18802    -1     
+ Partials     2586     2585    -1     

Flag	Coverage Δ
Linux_1	32.60% <33.33%> (+<0.01%)	⬆️
Linux_2	55.61% <100.00%> (+0.01%)	⬆️
Linux_3	44.89% <33.33%> (+0.01%)	⬆️
Linux_4	34.99% <33.33%> (-0.01%)	⬇️
Windows_1	32.62% <33.33%> (+<0.01%)	⬆️
Windows_2	55.58% <100.00%> (+0.01%)	⬆️
Windows_3	44.89% <33.33%> (-0.01%)	⬇️
Windows_4	34.99% <33.33%> (-0.01%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[ruanyl]

@SuZhou-Joe would you mind to update the PR description a bit to include how will updateWorkspaceState and getWorkspaceState be used? Just for more context for the other reviewers, I believe the workspace saved object wrapper will use it as we discussed offline.

[SuZhou-Joe]

update the PR description a bit to include how will updateWorkspaceState and getWorkspaceState be used

Sure, updated.

[BionIT]

looks like workspacestate only has one field which is optional, is it necessary to specify partial?

[SuZhou-Joe]

I think yes because actually the function just spread all the property into the request.app, which means user can pass in partial of the WorkspaceState to update the state.

[ZilongX]

LGTM, looking forward to the actual consumption of the updated API