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/[email protected]

.github/workflows/build_and_test_workflow.yml

@@ -25,21 +25,19 @@ env:
   TEST_OPENSEARCH_TRANSPORT_PORT: 9403
   TEST_OPENSEARCH_PORT: 9400
   OSD_SNAPSHOT_SKIP_VERIFY_CHECKSUM: true
-  NODE_OPTIONS: "--max-old-space-size=6144 --dns-result-order=ipv4first"
+  NODE_OPTIONS: '--max-old-space-size=6144 --dns-result-order=ipv4first'
 
 jobs:
   build-lint-test:
     name: Build and Verify on ${{ matrix.name }} (ciGroup${{ matrix.group }})
     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)
@@ -53,7 +51,7 @@ jobs:
         with:
           minimum-size: 16GB
           maximum-size: 64GB
-          disk-root: "C:"
+          disk-root: 'C:'
 
       - name: Checkout code
         uses: actions/checkout@v3
@@ -100,13 +98,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
 
@@ -138,13 +136,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 }}
@@ -160,7 +156,7 @@ jobs:
         with:
           minimum-size: 16GB
           maximum-size: 64GB
-          disk-root: "C:"
+          disk-root: 'C:'
 
       - name: Checkout code
         uses: actions/checkout@v3
@@ -254,7 +250,7 @@ jobs:
         with:
           minimum-size: 16GB
           maximum-size: 64GB
-          disk-root: "C:"
+          disk-root: 'C:'
 
       - name: Checkout code
         uses: actions/checkout@v3
@@ -322,31 +318,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: macos-latest
-            name: macOS x64
-            ext: tar.gz
-            suffix: darwin-x64
-            script: build-platform --darwin --skip-os-packages
-          - os: macos-latest
-            name: macOS ARM64
-            ext: tar.gz
-            suffix: darwin-arm64
-            script: build-platform --darwin-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:
@@ -364,7 +345,7 @@ jobs:
         with:
           minimum-size: 16GB
           maximum-size: 64GB
-          disk-root: "C:"
+          disk-root: 'C:'
 
       - name: Checkout code
         uses: actions/checkout@v3
@@ -430,8 +411,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
@@ -441,7 +423,19 @@ jobs:
         working-directory: ./artifacts
     strategy:
       matrix:
-        version: [osd-2.0.0, osd-2.1.0, osd-2.2.0, osd-2.3.0, osd-2.4.0, osd-2.5.0, osd-2.6.0, osd-2.7.0, osd-2.8.0, osd-2.9.0]
+        version:
+          [
+            osd-2.0.0,
+            osd-2.1.0,
+            osd-2.2.0,
+            osd-2.3.0,
+            osd-2.4.0,
+            osd-2.5.0,
+            osd-2.6.0,
+            osd-2.7.0,
+            osd-2.8.0,
+            osd-2.9.0,
+          ]
     steps:
       - name: Checkout code
         uses: actions/checkout@v3

.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

@@ -3,7 +3,7 @@ name: Run cypress tests
 # trigger on every PR for all branches
 on:
   pull_request:
-    branches: [ '**' ]
+    branches: ['**']
     paths-ignore:
       - '**/*.md'
   workflow_dispatch:
@@ -15,6 +15,8 @@ on:
         type: string
       test_branch:
         description: 'Cypress test branch (default: source branch)'
+        # remove this default value
+        default: 'workspace'
         required: false
         type: string
       specs:
@@ -43,11 +45,11 @@ env:
 
 jobs:
   cypress-tests:
-    runs-on: ubuntu-latest
+    runs-on: arc-runner-set
     strategy:
       fail-fast: false
       matrix:
-          group: [1, 2, 3, 4, 5, 6, 7, 8, 9]
+        group: [1, 2, 3, 4, 5, 6, 7, 8, 9]
     container:
       image: docker://opensearchstaging/ci-runner:ci-runner-rockylinux8-opensearch-dashboards-integtest-v2
       options: --user 1001
@@ -156,7 +158,7 @@ jobs:
           name: ftr-cypress-screenshots
           path: ${{ env.FTR_PATH }}/cypress/screenshots
           retention-days: 1
-      
+
       - uses: actions/upload-artifact@v3
         if: always()
         with:
@@ -184,7 +186,7 @@ jobs:
         with:
           issue-number: ${{ inputs.pr_number }}
           comment-author: 'github-actions[bot]'
-          body-includes: "${{ env.COMMENT_TAG }}"
+          body-includes: '${{ env.COMMENT_TAG }}'
 
       - name: Add comment on the PR
         uses: peter-evans/create-or-update-comment@v3
@@ -205,6 +207,6 @@ jobs:
             '${{ env.SPEC }}'
             ```
 
-            #### Link to results: 
+            #### Link to results:
             ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
           edit-mode: replace

.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

config/opensearch_dashboards.yml

@@ -274,4 +274,10 @@
 # opensearchDashboards.survey.url: "https://survey.opensearch.org"
 
 # Set the value of this setting to true to enable plugin augmentation on Dashboard
-# vis_augmenter.pluginAugmentationEnabled: true
+# 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/types.ts

@@ -245,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';
+    };
+  };
 }
 
 /**

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

@@ -43,7 +43,9 @@ const createStartContractMock = () => {
   const startContract: DeeplyMockedKeys<InternalChromeStart> = {
     getHeaderComponent: jest.fn(),
     navLinks: {
+      setNavLinks: jest.fn(),
       getNavLinks$: jest.fn(),
+      getAllNavLinks$: jest.fn(),
       has: jest.fn(),
       get: jest.fn(),
       getAll: jest.fn(),

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: string;
@@ -70,6 +71,7 @@ function defaultStartDeps(availableApps?: App[]) {
     injectedMetadata: injectedMetadataServiceMock.createStartContract(),
     notifications: notificationServiceMock.createStartContract(),
     uiSettings: uiSettingsServiceMock.createStartContract(),
+    workspaces: workspacesServiceMock.createStartContract(),
   };
 
   if (availableApps) {