Merge pull request #2 from SuZhou-Joe/feature/category-change-integr

move data source / advanced settings / saved objects management out of Dashboard management
ruanyl · Sep 28, 2023 · c4cbc84 · c4cbc84
2 parents dd7fdee + ba2de2e
commit c4cbc84
Show file tree

Hide file tree

Showing 59 changed files with 407 additions and 251 deletions.
diff --git a/cypress/integration/with-security/check_advanced_settings.js b/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();

diff --git a/cypress/integration/with-security/helpers/generate_data.js b/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'

diff --git a/cypress/integration/without-security/check_advanced_settings.js b/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', () => {

diff --git a/cypress/integration/without-security/helpers/generate_data.js b/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'

diff --git a/src/core/public/core_app/errors/url_overflow.test.ts b/src/core/public/core_app/errors/url_overflow.test.ts
@@ -102,7 +102,7 @@ describe('url overflow detection', () => {
         </code>
          option in 
         <a
-          href="/test-123/app/management/opensearch-dashboards/settings"
+          href="/test-123/app/settings"
         >
           advanced settings
         </a>

diff --git a/src/core/public/core_app/errors/url_overflow.tsx b/src/core/public/core_app/errors/url_overflow.tsx
@@ -92,7 +92,7 @@ export const setupUrlOverflowDetection = ({ basePath, history, toasts, uiSetting
             values={{
               storeInSessionStorageParam: <code>state:storeInSessionStorage</code>,
               advancedSettingsLink: (
-                <a href={basePath.prepend('/app/management/opensearch-dashboards/settings')}>
+                <a href={basePath.prepend('/app/settings')}>
                   <FormattedMessage
                     id="core.ui.errorUrlOverflow.bigUrlWarningNotificationMessage.advancedSettingsLinkText"
                     defaultMessage="advanced settings"

diff --git a/src/core/public/core_app/errors/url_overflow_ui.tsx b/src/core/public/core_app/errors/url_overflow_ui.tsx
@@ -54,7 +54,7 @@ export const UrlOverflowUi: React.FC<{ basePath: IBasePath }> = ({ basePath }) =
             values={{
               storeInSessionStorageConfig: <code>state:storeInSessionStorage</code>,
               opensearchDashboardsSettingsLink: (
-                <a href={basePath.prepend('/app/management/opensearch-dashboards/settings')}>
+                <a href={basePath.prepend('/app/settings')}>
                   <FormattedMessage
                     id="core.ui.errorUrlOverflow.optionsToFixError.enableOptionText.advancedSettingsLinkText"
                     defaultMessage="Advanced Settings"

diff --git a/src/core/server/ui_settings/saved_objects/ui_settings.ts b/src/core/server/ui_settings/saved_objects/ui_settings.ts
@@ -47,7 +47,7 @@ export const uiSettingsType: SavedObjectsType = {
     importableAndExportable: true,
     getInAppUrl() {
       return {
-        path: `/app/management/opensearch-dashboards/settings`,
+        path: `/app/settings`,
         uiCapabilitiesPath: 'advancedSettings.show',
       };
     },

diff --git a/src/plugins/advanced_settings/public/management_app/components/page_wrapper/index.ts b/src/plugins/advanced_settings/public/management_app/components/page_wrapper/index.ts
@@ -0,0 +1,6 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export { PageWrapper } from './page_wrapper';
diff --git a/src/plugins/advanced_settings/public/management_app/components/page_wrapper/page_wrapper.tsx b/src/plugins/advanced_settings/public/management_app/components/page_wrapper/page_wrapper.tsx
@@ -0,0 +1,21 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { EuiPageContent } from '@elastic/eui';
+import React from 'react';
+
+export const PageWrapper = (props: { fullWidth?: boolean; children?: React.ReactChild }) => {
+  return (
+    <EuiPageContent
+      style={props.fullWidth ? {} : { maxWidth: '75%', marginTop: '20px' }}
+      hasShadow={false}
+      hasBorder={false}
+      panelPaddingSize="none"
+      horizontalPosition="center"
+      color="transparent"
+      {...props}
+    />
+  );
+};
diff --git a/src/plugins/advanced_settings/public/management_app/mount_management_section.tsx b/src/plugins/advanced_settings/public/management_app/mount_management_section.tsx
@@ -34,11 +34,17 @@ import { Router, Switch, Route } from 'react-router-dom';
 
 import { i18n } from '@osd/i18n';
 import { I18nProvider } from '@osd/i18n/react';
-import { StartServicesAccessor } from 'src/core/public';
+import {
+  AppMountParameters,
+  ChromeBreadcrumb,
+  ScopedHistory,
+  StartServicesAccessor,
+} from 'src/core/public';
 
 import { AdvancedSettings } from './advanced_settings';
-import { ManagementAppMountParams } from '../../../management/public';
 import { ComponentRegistry } from '../types';
+import { reactRouterNavigate } from '../../../opensearch_dashboards_react/public';
+import { PageWrapper } from './components/page_wrapper';
 
 import './index.scss';
 
@@ -57,13 +63,21 @@ const readOnlyBadge = {
   iconType: 'glasses',
 };
 
-export async function mountManagementSection(
+export async function mountAdvancedSettingsManagementSection(
   getStartServices: StartServicesAccessor,
-  params: ManagementAppMountParams,
+  params: AppMountParameters,
   componentRegistry: ComponentRegistry['start']
 ) {
-  params.setBreadcrumbs(crumb);
   const [{ uiSettings, notifications, docLinks, application, chrome }] = await getStartServices();
+  const setBreadcrumbsScoped = (crumbs: ChromeBreadcrumb[] = []) => {
+    const wrapBreadcrumb = (item: ChromeBreadcrumb, scopedHistory: ScopedHistory) => ({
+      ...item,
+      ...(item.href ? reactRouterNavigate(scopedHistory, item.href) : {}),
+    });
+
+    chrome.setBreadcrumbs([...crumbs.map((item) => wrapBreadcrumb(item, params.history))]);
+  };
+  setBreadcrumbsScoped(crumb);
 
   const canSave = application.capabilities.advancedSettings.save as boolean;
 
@@ -72,21 +86,23 @@ export async function mountManagementSection(
   }
 
   ReactDOM.render(
-    <I18nProvider>
-      <Router history={params.history}>
-        <Switch>
-          <Route path={['/:query', '/']}>
-            <AdvancedSettings
-              enableSaving={canSave}
-              toasts={notifications.toasts}
-              dockLinks={docLinks.links}
-              uiSettings={uiSettings}
-              componentRegistry={componentRegistry}
-            />
-          </Route>
-        </Switch>
-      </Router>
-    </I18nProvider>,
+    <PageWrapper>
+      <I18nProvider>
+        <Router history={params.history}>
+          <Switch>
+            <Route path={['/:query', '/']}>
+              <AdvancedSettings
+                enableSaving={canSave}
+                toasts={notifications.toasts}
+                dockLinks={docLinks.links}
+                uiSettings={uiSettings}
+                componentRegistry={componentRegistry}
+              />
+            </Route>
+          </Switch>
+        </Router>
+      </I18nProvider>
+    </PageWrapper>,
     params.element
   );
   return () => {

diff --git a/src/plugins/advanced_settings/public/plugin.ts b/src/plugins/advanced_settings/public/plugin.ts
@@ -29,10 +29,11 @@
  */
 
 import { i18n } from '@osd/i18n';
-import { CoreSetup, Plugin } from 'opensearch-dashboards/public';
+import { AppMountParameters, CoreSetup, Plugin } from 'opensearch-dashboards/public';
 import { FeatureCatalogueCategory } from '../../home/public';
 import { ComponentRegistry } from './component_registry';
 import { AdvancedSettingsSetup, AdvancedSettingsStart, AdvancedSettingsPluginSetup } from './types';
+import { DEFAULT_APP_CATEGORIES } from '../../../core/public';
 
 const component = new ComponentRegistry();
 
@@ -42,18 +43,21 @@ const title = i18n.translate('advancedSettings.advancedSettingsLabel', {
 
 export class AdvancedSettingsPlugin
   implements Plugin<AdvancedSettingsSetup, AdvancedSettingsStart, AdvancedSettingsPluginSetup> {
-  public setup(core: CoreSetup, { management, home }: AdvancedSettingsPluginSetup) {
-    const opensearchDashboardsSection = management.sections.section.opensearchDashboards;
-
-    opensearchDashboardsSection.registerApp({
+  public setup(core: CoreSetup, { home }: AdvancedSettingsPluginSetup) {
+    core.application.register({
       id: 'settings',
       title,
-      order: 3,
-      async mount(params) {
-        const { mountManagementSection } = await import(
+      order: 99,
+      category: DEFAULT_APP_CATEGORIES.management,
+      async mount(params: AppMountParameters) {
+        const { mountAdvancedSettingsManagementSection } = await import(
           './management_app/mount_management_section'
         );
-        return mountManagementSection(core.getStartServices, params, component.start);
+        return mountAdvancedSettingsManagementSection(
+          core.getStartServices,
+          params,
+          component.start
+        );
       },
     });
 
@@ -66,7 +70,7 @@ export class AdvancedSettingsPlugin
             'Customize your OpenSearch Dashboards experience — change the date format, turn on dark mode, and more.',
         }),
         icon: 'gear',
-        path: '/app/management/opensearch-dashboards/settings',
+        path: '/app/settings',
         showOnHomePage: false,
         category: FeatureCatalogueCategory.ADMIN,
       });

diff --git a/src/plugins/dashboard/server/saved_objects/dashboard.ts b/src/plugins/dashboard/server/saved_objects/dashboard.ts
@@ -43,9 +43,7 @@ export const dashboardSavedObjectType: SavedObjectsType = {
       return obj.attributes.title;
     },
     getEditUrl(obj) {
-      return `/management/opensearch-dashboards/objects/savedDashboards/${encodeURIComponent(
-        obj.id
-      )}`;
+      return `/objects/savedDashboards/${encodeURIComponent(obj.id)}`;
     },
     getInAppUrl(obj) {
       return {

diff --git a/src/plugins/data_source/server/saved_objects/data_source.ts b/src/plugins/data_source/server/saved_objects/data_source.ts
@@ -17,11 +17,11 @@ export const dataSource: SavedObjectsType = {
       return obj.attributes.title;
     },
     getEditUrl(obj) {
-      return `/management/opensearch-dashboards/dataSources/${encodeURIComponent(obj.id)}`;
+      return `/dataSources/${encodeURIComponent(obj.id)}`;
     },
     getInAppUrl(obj) {
       return {
-        path: `/app/management/opensearch-dashboards/dataSources/${encodeURIComponent(obj.id)}`,
+        path: `/app/dataSources/${encodeURIComponent(obj.id)}`,
         uiCapabilitiesPath: 'management.opensearchDashboards.dataSources',
       };
     },

diff --git a/src/plugins/data_source_management/opensearch_dashboards.json b/src/plugins/data_source_management/opensearch_dashboards.json
@@ -3,7 +3,7 @@
   "version": "opensearchDashboards",
   "server": false,
   "ui": true,
-  "requiredPlugins": ["management", "dataSource", "indexPatternManagement"],
+  "requiredPlugins": ["dataSource", "indexPatternManagement"],
   "optionalPlugins": [],
   "requiredBundles": ["opensearchDashboardsReact"],
   "extraPublicDirs": ["public/components/utils"]

diff --git a/...lugins/data_source_management/public/components/data_source_column/data_source_column.tsx b/...lugins/data_source_management/public/components/data_source_column/data_source_column.tsx
@@ -56,11 +56,7 @@ export class DataSourceColumn implements IndexPatternTableColumn<DataSourceMap>
         ?.map((dataSource) => {
           return {
             ...dataSource,
-            relativeUrl: basePath.prepend(
-              `/app/management/opensearch-dashboards/dataSources/${encodeURIComponent(
-                dataSource.id
-              )}`
-            ),
+            relativeUrl: basePath.prepend(`/app/dataSources/${encodeURIComponent(dataSource.id)}`),
           };
         })
         ?.reduce(

diff --git a/src/plugins/data_source_management/public/components/page_wrapper/index.ts b/src/plugins/data_source_management/public/components/page_wrapper/index.ts
@@ -0,0 +1,6 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export { PageWrapper } from './page_wrapper';
diff --git a/src/plugins/data_source_management/public/components/page_wrapper/page_wrapper.tsx b/src/plugins/data_source_management/public/components/page_wrapper/page_wrapper.tsx
@@ -0,0 +1,21 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { EuiPageContent } from '@elastic/eui';
+import React from 'react';
+
+export const PageWrapper = (props: { fullWidth?: boolean; children?: React.ReactChild }) => {
+  return (
+    <EuiPageContent
+      style={props.fullWidth ? {} : { maxWidth: '75%', marginTop: '20px' }}
+      hasShadow={false}
+      hasBorder={false}
+      panelPaddingSize="none"
+      horizontalPosition="center"
+      color="transparent"
+      {...props}
+    />
+  );
+};
diff --git a/src/plugins/data_source_management/public/management_app/index.ts b/src/plugins/data_source_management/public/management_app/index.ts
@@ -3,4 +3,4 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-export { mountManagementSection } from './mount_management_section';
+export { mountDataSourcesManagementSection } from './mount_management_section';