[Workspace] Validate if workspace exists when setup inside a workspace

[SuZhou-Joe]

Description

When user enters a url with workspaceId pattern inside url, workspace plugin should validate if the id exists, or should show an friendly error page to ask user to go back to home page without a pattern in url.

Issues Resolved

closes #6155

Screenshot

Testing the changes

• Using the branch to bootstrap
• Enable workspace feature flag in yml file by set workspace.enabled: true
• Start OSD by using yarn start --no-base-path to make sure no random base path will be appended
• Navigate to devTools
• Insert test workspaces by calling

PUT .kibana/_doc/workspace:foo
{
  "type": "workspace",
  "workspace": {
    "name": "foo"
  }
}

• Visit devTools under the test workspace: http://localhost:5601/w/foo/app/dev_tools, the page should render successfully.
• Visit devTools under a unexisting workspace: http://localhost:5601/w/not_existing/app/dev_tools, should see a page with error just like the screenshot above.
• Visit the error page under a existing worksapce: http://localhost:5601/w/foo/app/workspace_fatal_error, user should be redirect to http://localhost:5601/w/foo/app/workspace_overview page, though the page has not been implement yet.

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

Attention: Patch coverage is 76.92308% with 6 lines in your changes are missing coverage. Please review.

Project coverage is 67.31%. Comparing base (f103b7e) to head (fc570f3).

Files	Patch %	Lines
src/plugins/workspace/public/plugin.ts	68.42%	5 Missing and 1 partial ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #6154   +/-   ##
=======================================
  Coverage   67.31%   67.31%           
=======================================
  Files        3348     3350    +2     
  Lines       64966    64993   +27     
  Branches    10465    10468    +3     
=======================================
+ Hits        43729    43752   +23     
- Misses      18690    18694    +4     
  Partials     2547     2547           

Flag	Coverage Δ
Linux_1	31.75% <76.92%> (+0.03%)	⬆️
Linux_2	55.55% <ø> (ø)
Linux_3	44.68% <ø> (+0.01%)	⬆️
Linux_4	35.02% <ø> (ø)
Windows_1	31.77% <76.92%> (+0.03%)	⬆️
Windows_2	55.52% <ø> (ø)
Windows_3	44.68% <ø> (ø)
Windows_4	35.02% <ø> (ø)

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.

[Flyingliuhub]

do we consider to to check result.error exists before access it. like as const error = result.error || "Unknown error"; so ensures that error always have value

[SuZhou-Joe]

If the error is empty or null, we will hide the callout component to not display the detailed error message, but update to result?.error to protect the code.

[opensearch-trigger-bot]

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch-Dashboards/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch-Dashboards/backport-2.x
# Create a new branch
git switch --create backport/backport-6154-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 0cc91ab3ed89ed72552a29e503cab2dab324a073
# Push it to GitHub
git push --set-upstream origin backport/backport-6154-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch-Dashboards/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-6154-to-2.x.