Feature/workspace

.github/workflows/add-untriaged.yml

@@ -6,7 +6,7 @@ on:
 
 jobs:
   apply-label:
-    runs-on: ubuntu-latest
+    runs-on: arc-runner-set
     steps:
       - uses: actions/github-script@v6
         with:

.github/workflows/backport.yml

@@ -7,7 +7,7 @@ on:
 
 jobs:
   backport:
-    runs-on: ubuntu-latest
+    runs-on: arc-runner-set
     permissions:
       contents: write
       pull-requests: write
@@ -31,7 +31,7 @@ jobs:
           app_id: ${{ secrets.APP_ID }}
           private_key: ${{ secrets.APP_PRIVATE_KEY }}
           # opensearch-trigger-bot installation ID
-          installation_id: 22958780
+          installation_id: 41494816
 
       - name: Backport
         uses: VachaShah/backport@v2.2.0

.github/workflows/build_and_test_workflow.yml

@@ -33,13 +33,11 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, windows-latest]
+        os: [arc-runner-set]
         group: [1, 2, 3, 4]
         include:
-          - os: ubuntu-latest
+          - os: arc-runner-set
             name: Linux
-          - os: windows-latest
-            name: Windows
     runs-on: ${{ matrix.os }}
     steps:
       - name: Configure git's autocrlf (Windows only)
@@ -92,13 +90,13 @@ jobs:
 
       - name: Run linter
         # ciGroup 1 of unit-tests is shorter and Linux is faster
-        if: matrix.group == 1 && matrix.os == 'ubuntu-latest'
+        if: matrix.group == 1 && matrix.os == 'arc-runner-set'
         id: linter
         run: yarn lint
 
       - name: Validate NOTICE file
         # ciGroup 1 of unit-tests is shorter and Linux is faster
-        if: matrix.group == 1 && matrix.os == 'ubuntu-latest'
+        if: matrix.group == 1 && matrix.os == 'arc-runner-set'
         id: notice-validate
         run: yarn notice:validate
 
@@ -130,13 +128,11 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, windows-latest]
+        os: [arc-runner-set]
         group: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]
         include:
-          - os: ubuntu-latest
+          - os: arc-runner-set
             name: Linux
-          - os: windows-latest
-            name: Windows
     runs-on: ${{ matrix.os }}
     steps:
       - run: echo Running functional tests for ciGroup${{ matrix.group }}
@@ -217,21 +213,16 @@ jobs:
     strategy:
       matrix:
         include:
-          - os: ubuntu-latest
+          - os: arc-runner-set
             name: Linux x64
             ext: tar.gz
             suffix: linux-x64
             script: build-platform --linux --skip-os-packages
-          - os: ubuntu-latest
+          - os: arc-runner-set
             name: Linux ARM64
             ext: tar.gz
             suffix: linux-arm64
             script: build-platform --linux-arm --skip-os-packages
-          - os: windows-latest
-            name: Windows x64
-            ext: zip
-            suffix: windows-x64
-            script: build-platform --windows --skip-os-packages
     runs-on: ${{ matrix.os }}
     defaults:
       run:
@@ -307,8 +298,9 @@ jobs:
           retention-days: 1
 
   bwc-tests:
+    if: false
     needs: [build-min-artifact-tests]
-    runs-on: ubuntu-latest
+    runs-on: arc-runner-set
     container:
       image: docker://opensearchstaging/ci-runner:ci-runner-rockylinux8-opensearch-dashboards-integtest-v2
       options: --user 1001

.github/workflows/changelog_verifier.yml

@@ -7,7 +7,7 @@ on:
 jobs:
   # Enforces the update of a changelog file on every pull request
   verify-changelog:
-    runs-on: ubuntu-latest
+    runs-on: arc-runner-set
     steps:
       - uses: actions/checkout@v3
         with:

.github/workflows/create_doc_issue.yml

@@ -9,7 +9,7 @@ env:
 jobs:
   create-issue:
     if: ${{ github.event.label.name == 'needs-documentation' }}
-    runs-on: ubuntu-latest
+    runs-on: arc-runner-set
     name: Create Documentation Issue
     steps:
       - name: GitHub App token

.github/workflows/cypress_workflow.yml

@@ -19,7 +19,7 @@ env:
 
 jobs:
   cypress-tests:
-    runs-on: ubuntu-latest
+    runs-on: arc-runner-set
     container:
       image: docker://opensearchstaging/ci-runner:ci-runner-rockylinux8-opensearch-dashboards-integtest-v2
       options: --user 1001
@@ -55,7 +55,8 @@ jobs:
         with:
           path: ${{ env.FTR_PATH }}
           repository: opensearch-project/opensearch-dashboards-functional-test
-          ref: '${{ github.base_ref }}'
+          # revert this to '${{ github.base_ref }}'
+          ref: 'workspace'
 
       - name: Get Cypress version
         id: cypress_version
@@ -88,7 +89,7 @@ jobs:
           name: ftr-cypress-screenshots
           path: ${{ env.FTR_PATH }}/cypress/screenshots
           retention-days: 1
-      
+
       - uses: actions/upload-artifact@v3
         if: always()
         with:
@@ -101,4 +102,4 @@ jobs:
         with:
           name: ftr-cypress-results
           path: ${{ env.FTR_PATH }}/cypress/results
-          retention-days: 1
+          retention-days: 1

.github/workflows/delete_backport_branch.yml

@@ -6,7 +6,7 @@ on:
 
 jobs:
   delete-branch:
-    runs-on: ubuntu-latest
+    runs-on: arc-runner-set
     if: startsWith(github.event.pull_request.head.ref,'backport/')
     steps:
       - name: Delete merged branch

.github/workflows/github-workflow-badger.yml

@@ -7,7 +7,7 @@ on:
 
 jobs:
   call-action:
-    runs-on: ubuntu-latest
+    runs-on: arc-runner-set
     permissions:
       pull-requests: write
     steps:

.github/workflows/links_checker.yml

@@ -12,7 +12,7 @@ on:
 jobs:
   linkchecker:
 
-    runs-on: ubuntu-latest
+    runs-on: arc-runner-set
 
     steps:
     - uses: actions/checkout@v2

CHANGELOG.md

@@ -38,6 +38,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Adds Data explorer framework and implements Discover using it ([#4806](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/4806))
 - [Theme] Use themes' definitions to render the initial view ([#4936](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/4936/))
 - [Theme] Make `next` theme the default ([#4854](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/4854/))
+- [Workspace] Setup workspace skeleton and implement basic CRUD API ([#5075](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5075/))
 
 ### 🐛 Bug Fixes
 

config/opensearch_dashboards.yml

@@ -273,3 +273,9 @@
 
 # Set the value of this setting to true to enable plugin augmentation on Dashboard
 # vis_augmenter.pluginAugmentationEnabled: true
+
+# Set the value to true enable workspace feature
+# workspace.enabled: false
+# Set the value to false to disable permission check on workspace
+# Permission check depends on OpenSearch Dashboards has authentication enabled, set it to false if no authentication is configured
+# workspace.permission.enabled: true

cypress/integration/with-security/check_advanced_settings.js

@@ -13,7 +13,7 @@ const loginPage = new LoginPage(cy);
 
 describe('verify the advanced settings are saved', () => {
   beforeEach(() => {
-    miscUtils.visitPage('app/management/opensearch-dashboards/settings');
+    miscUtils.visitPage('app/settings');
     loginPage.enterUserName('admin');
     loginPage.enterPassword('admin');
     loginPage.submit();

cypress/integration/with-security/helpers/generate_data.js

@@ -13,7 +13,7 @@ const loginPage = new LoginPage(cy);
 
 describe('Generating BWC test data with security', () => {
   beforeEach(() => {
-    miscUtils.visitPage('app/management/opensearch-dashboards/settings');
+    miscUtils.visitPage('app/settings');
     loginPage.enterUserName('admin');
     loginPage.enterPassword('admin');
     loginPage.submit();
@@ -29,7 +29,7 @@ describe('Generating BWC test data with security', () => {
   });
 
   it('adds advanced settings', () => {
-    miscUtils.visitPage('app/management/opensearch-dashboards/settings');
+    miscUtils.visitPage('app/settings');
     cy.get('[data-test-subj="advancedSetting-editField-theme:darkMode"]').click();
     cy.get('[data-test-subj="advancedSetting-editField-timeline:max_buckets"]').type(
       '{selectAll}4'

cypress/integration/without-security/check_advanced_settings.js

@@ -9,7 +9,7 @@ const miscUtils = new MiscUtils(cy);
 
 describe('verify the advanced settings are saved', () => {
   beforeEach(() => {
-    miscUtils.visitPage('app/management/opensearch-dashboards/settings');
+    miscUtils.visitPage('app/settings');
   });
 
   it('the dark mode is on', () => {

cypress/integration/without-security/helpers/generate_data.js

@@ -12,7 +12,7 @@ describe('Generating BWC test data without security', () => {
     miscUtils.visitPage('app');
   });
   it('adds advanced settings', () => {
-    miscUtils.visitPage('app/management/opensearch-dashboards/settings');
+    miscUtils.visitPage('app/settings');
     cy.get('[data-test-subj="advancedSetting-editField-theme:darkMode"]').click();
     cy.get('[data-test-subj="advancedSetting-editField-timeline:max_buckets"]').type(
       '{selectAll}4'

src/core/public/application/capabilities/capabilities_service.mock.ts

@@ -37,6 +37,7 @@ const createStartContractMock = (): jest.Mocked<CapabilitiesStart> => ({
     catalogue: {},
     management: {},
     navLinks: {},
+    workspaces: {},
   }),
 });
 

src/core/public/application/types.ts

@@ -47,6 +47,7 @@ import { IUiSettingsClient } from '../ui_settings';
 import { SavedObjectsStart } from '../saved_objects';
 import { AppCategory } from '../../types';
 import { ScopedHistory } from './scoped_history';
+import { WorkspacesStart } from '../workspace';
 
 /**
  * Accessibility status of an application.
@@ -244,6 +245,16 @@ export interface App<HistoryLocationState = unknown> {
    * ```
    */
   exactRoute?: boolean;
+
+  /**
+   * The dependencies of one application, required feature will be automatic select and can't
+   * be unselect in the workspace configuration.
+   */
+  dependencies?: {
+    [key: string]: {
+      type: 'required' | 'optional';
+    };
+  };
 }
 
 /**
@@ -334,6 +345,8 @@ export interface AppMountContext {
     injectedMetadata: {
       getInjectedVar: (name: string, defaultValue?: any) => unknown;
     };
+    /** {@link WorkspacesService} */
+    workspaces: WorkspacesStart;
   };
 }
 

src/core/public/chrome/chrome_service.mock.ts

@@ -33,11 +33,19 @@ import type { PublicMethodsOf } from '@osd/utility-types';
 import { ChromeBadge, ChromeBreadcrumb, ChromeService, InternalChromeStart } from './';
 import { getLogosMock } from '../../common/mocks';
 
+const createSetupContractMock = () => {
+  return {
+    registerCollapsibleNavHeader: jest.fn(),
+  };
+};
+
 const createStartContractMock = () => {
   const startContract: DeeplyMockedKeys<InternalChromeStart> = {
     getHeaderComponent: jest.fn(),
     navLinks: {
       getNavLinks$: jest.fn(),
+      getFilteredNavLinks$: jest.fn(),
+      setFilteredNavLinks: jest.fn(),
       has: jest.fn(),
       get: jest.fn(),
       getAll: jest.fn(),
@@ -95,6 +103,7 @@ const createStartContractMock = () => {
 type ChromeServiceContract = PublicMethodsOf<ChromeService>;
 const createMock = () => {
   const mocked: jest.Mocked<ChromeServiceContract> = {
+    setup: jest.fn(),
     start: jest.fn(),
     stop: jest.fn(),
   };
@@ -105,4 +114,5 @@ const createMock = () => {
 export const chromeServiceMock = {
   create: createMock,
   createStartContract: createStartContractMock,
+  createSetupContract: createSetupContractMock,
 };

src/core/public/chrome/chrome_service.test.ts

@@ -41,6 +41,7 @@ import { notificationServiceMock } from '../notifications/notifications_service.
 import { uiSettingsServiceMock } from '../ui_settings/ui_settings_service.mock';
 import { ChromeService } from './chrome_service';
 import { getAppInfo } from '../application/utils';
+import { workspacesServiceMock } from '../workspace/workspaces_service.mock';
 
 class FakeApp implements App {
   public title = `${this.id} App`;
@@ -67,6 +68,7 @@ function defaultStartDeps(availableApps?: App[]) {
     injectedMetadata: injectedMetadataServiceMock.createStartContract(),
     notifications: notificationServiceMock.createStartContract(),
     uiSettings: uiSettingsServiceMock.createStartContract(),
+    workspaces: workspacesServiceMock.createStartContract(),
   };
 
   if (availableApps) {