Moving Query Workbench to Dev Tools

common/utils/legacy_route_helper.tsx

@@ -0,0 +1,31 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export const convertLegacyWorkbenchUrl = (location: Location) => {
+  // Update pathname to new structure
+  let pathname = location.pathname.replace(
+    'app/opensearch-query-workbench',
+    'app/dev_tools#/opensearch-query-workbench'
+  );
+
+  // If the pathname ends with '/', remove it before appending the hash
+  if (pathname.endsWith('/')) {
+    pathname = pathname.slice(0, -1);
+  }
+
+  // Adjust the hash part of the URL
+  let hash = location.hash.replace('#/', '/');
+
+  // If hash contains "accelerate" or any random text, handle it properly
+  if (hash.includes('accelerate/')) {
+    hash = hash.replace('#/', '/');
+  } else if (hash.startsWith('#/')) {
+    hash = hash.replace('#/', '/');
+  }
+
+  const finalUrl = `${pathname}${hash}`;
+
+  return finalUrl;
+};

opensearch_dashboards.json

@@ -6,6 +6,6 @@
   "ui": true,
   "supportedOSDataSourceVersions": ">=1.0.0",
   "requiredOSDataSourcePlugins": ["opensearch-sql"],
-  "requiredPlugins": ["navigation", "opensearchDashboardsReact", "opensearchDashboardsUtils"],
+  "requiredPlugins": ["devTools", "navigation", "opensearchDashboardsReact", "opensearchDashboardsUtils"],
   "optionalPlugins": ["observabilityDashboards", "dataSource", "dataSourceManagement"]
 }

public/application.tsx

@@ -3,7 +3,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-
 import React from 'react';
 import ReactDOM from 'react-dom';
 import { AppMountParameters, CoreStart } from '../../../src/core/public';
@@ -14,7 +13,7 @@ import { AppPluginStartDependencies } from './types';
 export const renderApp = (
   { notifications, http, chrome, savedObjects }: CoreStart,
   { navigation, dataSource }: AppPluginStartDependencies,
-  { appBasePath, element, setHeaderActionMenu }: AppMountParameters,
+  { appBasePath, element, setHeaderActionMenu, dataSourceId }: AppMountParameters,
   dataSourceManagement: DataSourceManagementPluginSetup
 ) => {
   ReactDOM.render(
@@ -28,6 +27,7 @@ export const renderApp = (
       dataSourceEnabled={!!dataSource}
       dataSourceManagement={dataSourceManagement}
       setActionMenu={setHeaderActionMenu}
+      dataSourceMDSId={dataSourceId}
     />,
     element
   );

public/components/Main/main.tsx

@@ -42,6 +42,7 @@
 import { executeAsyncQuery } from '../../../common/utils/async_query_helpers';
 import { fetchDataSources } from '../../../common/utils/fetch_datasources';
 import * as pluginManifest from '../../../opensearch_dashboards.json';
+import { coreRefs } from '../../framework/core_refs';
 import { MESSAGE_TAB_LABEL } from '../../utils/constants';
 import {
   Tree,
@@ -61,8 +62,8 @@
 
 interface ResponseData {
   ok: boolean;
   resp: any;
   body: any;
 }
 
 export interface ResponseDetail<T> {
@@ -72,11 +73,11 @@
 }
 
 export interface TranslateResult {
   [key: string]: any;
 }
 
 export interface QueryMessage {
   text: any;
   className: string;
 }
 
@@ -96,13 +97,13 @@
   [key: string]: {
     nodes: Tree;
     expandedRow?: {};
     selectedNodes?: { [key: string]: any };
   };
 }
 
 export interface DataRow {
   rowId: number;
   data: { [key: string]: any };
 }
 
 interface MainProps {
@@ -114,6 +115,7 @@
   notifications: NotificationsStart;
   dataSourceEnabled: boolean;
   dataSourceManagement: DataSourceManagementPluginSetup;
+  dataSourceMDSId: string;
   setActionMenu: (menuMount: MountPoint | undefined) => void;
 }
 
@@ -150,7 +152,7 @@
 }
 
 const SUCCESS_MESSAGE = 'Success';
 const errorQueryResponse = (queryResultResponseDetail: any) => {
   const errorMessage =
     queryResultResponseDetail.errorMessage +
     ', this query is not runnable. \n \n' +
@@ -178,7 +180,7 @@
         const dataRows: DataRow[] = [];
 
         const schema: object[] = _.get(responseObj, 'schema');
         const datarows: any[][] = _.get(responseObj, 'datarows');
         let queryType = 'default';
 
         for (const column of schema.values()) {
@@ -203,7 +205,7 @@
             }
 
             for (const [id, field] of datarows.entries()) {
               const row: { [key: string]: any } = {};
               row.TABLE_NAME = field[index];
               const dataRow: DataRow = {
                 rowId: id,
@@ -216,7 +218,7 @@
           case 'describe':
           case 'default':
             for (const [id, field] of schema.entries()) {
               let alias: any = null;
               try {
                 alias = _.get(field, 'alias');
               } catch (e) {
@@ -290,7 +292,7 @@
       isCallOutVisible: false,
       cluster: 'Indexes',
       dataSourceOptions: [],
-      selectedMDSDataConnectionId: '',
+      selectedMDSDataConnectionId: this.props.dataSourceMDSId,
       mdsClusterName: '',
       flintDataConnections: false,
     };
@@ -301,19 +303,22 @@
   }
 
   componentDidMount() {
-    this.props.setBreadcrumbs([
-      {
-        text: 'Query Workbench',
-        href: '#',
-      },
-    ]);
+    if (!coreRefs?.chrome?.navGroup.getNavGroupEnabled()) {
+      this.props.setBreadcrumbs([
+        {
+          text: 'Query Workbench',
+          href: '#',
+        },
+      ]);
+    }
+
     this.fetchFlintDataSources();
   }
 
   fetchFlintDataSources = () => {
     fetchDataSources(
       this.httpClient,
-      this.state.selectedMDSDataConnectionId,
+      this.props.dataSourceMDSId,
       this.props.urlDataSource,
       (dataOptions) => {
         if (dataOptions.length > 0) {
@@ -435,7 +440,7 @@
       const endpoint = '/api/sql_console/' + (_.isEqual(language, 'SQL') ? 'sqlquery' : 'pplquery');
       let query = {};
       if (this.props.dataSourceEnabled) {
-        query = { dataSourceMDSId: this.state.selectedMDSDataConnectionId };
+        query = { dataSourceMDSId: this.props.dataSourceMDSId };
       }
       const responsePromise = Promise.all(
         queries.map((eachQuery: string) =>
@@ -570,7 +575,7 @@
               });
             }
           },
-          this.state.selectedMDSDataConnectionId,
+          this.props.dataSourceMDSId,
           (errorDetails: string) => {
             this.setState({
               asyncLoading: false,
@@ -599,7 +604,7 @@
     if (queries.length > 0) {
       let query = {};
       if (this.props.dataSourceEnabled) {
-        query = { dataSourceMDSId: this.state.selectedMDSDataConnectionId };
+        query = { dataSourceMDSId: this.props.dataSourceMDSId };
       }
       const endpoint =
         '/api/sql_console/' + (_.isEqual(language, 'SQL') ? 'translatesql' : 'translateppl');
@@ -651,7 +656,7 @@
     if (queries.length > 0) {
       let query = {};
       if (this.props.dataSourceEnabled) {
-        query = { dataSourceMDSId: this.state.selectedMDSDataConnectionId };
+        query = { dataSourceMDSId: this.props.dataSourceMDSId };
       }
       Promise.all(
         queries.map((eachQuery: string) =>
@@ -688,7 +693,7 @@
     if (queries.length > 0) {
       let query = {};
       if (this.props.dataSourceEnabled) {
-        query = { dataSourceMDSId: this.state.selectedMDSDataConnectionId };
+        query = { dataSourceMDSId: this.props.dataSourceMDSId };
       }
       const endpoint = '/api/sql_console/' + (_.isEqual(language, 'SQL') ? 'sqlquery' : 'pplquery');
       Promise.all(
@@ -726,7 +731,7 @@
     if (queries.length > 0) {
       let query = {};
       if (this.props.dataSourceEnabled) {
-        query = { dataSourceMDSId: this.state.selectedMDSDataConnectionId };
+        query = { dataSourceMDSId: this.props.dataSourceMDSId };
       }
       const endpoint = '/api/sql_console/' + (_.isEqual(language, 'SQL') ? 'sqlcsv' : 'pplcsv');
       Promise.all(
@@ -764,7 +769,7 @@
     if (queries.length > 0) {
       let query = {};
       if (this.props.dataSourceEnabled) {
-        query = { dataSourceMDSId: this.state.selectedMDSDataConnectionId };
+        query = { dataSourceMDSId: this.props.dataSourceMDSId };
       }
       const endpoint = '/api/sql_console/' + (_.isEqual(language, 'SQL') ? 'sqltext' : 'ppltext');
       Promise.all(
@@ -947,7 +952,7 @@
           openAccelerationFlyout={
             this.props.isAccelerationFlyoutOpen && !this.state.isAccelerationFlyoutOpened
           }
-          dataSourceMDSId={this.state.selectedMDSDataConnectionId}
+          dataSourceMDSId={this.props.dataSourceMDSId}
           setIsAccelerationFlyoutOpened={this.setIsAccelerationFlyoutOpened}
         />
       );
@@ -1086,7 +1091,7 @@
                         onSelect={this.handleDataSelect}
                         urlDataSource={this.props.urlDataSource}
                         asyncLoading={this.state.asyncLoading}
-                        dataSourceMDSId={this.state.selectedMDSDataConnectionId}
+                        dataSourceMDSId={this.props.dataSourceMDSId}
                       />
                     </EuiFlexItem>
                     <EuiFlexItem grow={false}>
@@ -1105,7 +1110,7 @@
                     updateSQLQueries={this.updateSQLQueries}
                     refreshTree={this.state.refreshTree}
                     dataSourceEnabled={this.props.dataSourceEnabled}
-                    dataSourceMDSId={this.state.selectedMDSDataConnectionId}
+                    dataSourceMDSId={this.props.dataSourceMDSId}
                     clusterTab={this.state.cluster}
                     language={this.state.language}
                     updatePPLQueries={this.updatePPLQueries}

public/components/app.tsx

@@ -13,6 +13,7 @@
 import { DataSourceManagementPluginSetup } from '../../../../src/plugins/data_source_management/public';
 import { NavigationPublicPluginStart } from '../../../../src/plugins/navigation/public';
 
+import { coreRefs } from '../framework/core_refs';
 import { Main } from './Main';
 
 interface WorkbenchAppDeps {
@@ -24,20 +25,25 @@
   savedObjects: CoreStart['savedObjects'];
   dataSourceEnabled: boolean;
   dataSourceManagement: DataSourceManagementPluginSetup;
+  dataSourceMDSId: string;
   setActionMenu: (menuMount: MountPoint | undefined) => void;
 }
 
 export const WorkbenchApp = ({
   basename,
   notifications,
   http,
   navigation,
   chrome,
   savedObjects,
   dataSourceEnabled,
   dataSourceManagement,
+  dataSourceMDSId: dataSourceId,
   setActionMenu,
 }: WorkbenchAppDeps) => {
+  const isNavGroupEnabled = coreRefs?.chrome?.navGroup.getNavGroupEnabled();
+  const basePath = isNavGroupEnabled ? 'opensearch-query-workbench' : '';
+
   return (
     <HashRouter>
       <I18nProvider>
@@ -47,7 +53,7 @@
               <Switch>
                 <Route
                   exact
-                  path="/"
+                  path={`/${basePath}`}
                   render={(props) => (
                     <Main
                       httpClient={http}
@@ -59,13 +65,14 @@
                       savedObjects={savedObjects}
                       dataSourceEnabled={dataSourceEnabled}
                       dataSourceManagement={dataSourceManagement}
+                      dataSourceMDSId={dataSourceId}
                       setActionMenu={setActionMenu}
                     />
                   )}
                 />
                 <Route
                   exact
-                  path="/:dataSource"
+                  path={`/${basePath}/:dataSource`}
                   render={(props) => (
                     <Main
                       httpClient={http}
@@ -77,13 +84,14 @@
                       savedObjects={savedObjects}
                       dataSourceEnabled={dataSourceEnabled}
                       dataSourceManagement={dataSourceManagement}
+                      dataSourceMDSId={dataSourceId}
                       setActionMenu={setActionMenu}
                     />
                   )}
                 />
                 <Route
                   exact
-                  path="/accelerate/:dataSource"
+                  path={`/${basePath}/accelerate/:dataSource`}
                   render={(props) => (
                     <Main
                       httpClient={http}
@@ -95,6 +103,7 @@
                       savedObjects={savedObjects}
                       dataSourceEnabled={dataSourceEnabled}
                       dataSourceManagement={dataSourceManagement}
+                      dataSourceMDSId={dataSourceId}
                       setActionMenu={setActionMenu}
                     />
                   )}

public/plugin.ts

@@ -4,41 +4,83 @@
  */
 
 import { AppMountParameters, CoreSetup, CoreStart, Plugin } from '../../../src/core/public';
-import { DataSourcePluginSetup, DataSourcePluginStart } from '../../../src/plugins/data_source/public';
+import {
+  DataSourcePluginSetup,
+  DataSourcePluginStart,
+} from '../../../src/plugins/data_source/public';
 import { DataSourceManagementPluginSetup } from '../../../src/plugins/data_source_management/public';
+import { DevToolsSetup } from '../../../src/plugins/dev_tools/public';
 import { PLUGIN_NAME } from '../common/constants';
+import { convertLegacyWorkbenchUrl } from '../common/utils/legacy_route_helper';
 import { registerObservabilityDependencies } from './dependencies/register_observability_dependencies';
 import { coreRefs } from './framework/core_refs';
 import { AppPluginStartDependencies, WorkbenchPluginSetup, WorkbenchPluginStart } from './types';
 export interface WorkbenchPluginSetupDependencies {
   dataSource: DataSourcePluginSetup;
-  dataSourceManagement: DataSourceManagementPluginSetup
+  dataSourceManagement: DataSourceManagementPluginSetup;
+  devTools: DevToolsSetup;
 }
 
 export interface WorkbenchPluginStartDependencies {
   dataSource: DataSourcePluginStart;
 }
 export class WorkbenchPlugin implements Plugin<WorkbenchPluginSetup, WorkbenchPluginStart> {
-  public setup(core: CoreSetup, {dataSource, dataSourceManagement} : WorkbenchPluginSetupDependencies): WorkbenchPluginSetup {
-    // Register an application into the side navigation menu
-    core.application.register({
-      id: 'opensearch-query-workbench',
-      title: PLUGIN_NAME,
-      category: {
-        id: 'opensearch',
-        label: 'OpenSearch Plugins',
-        order: 2000,
-      },
-      order: 1000,
-      async mount(params: AppMountParameters) {
-        // Load application bundle
-        const { renderApp } = await import('./application');
-        // Get start services as specified in opensearch_dashboards.json
-        const [coreStart, depsStart] = await core.getStartServices();
-        // Render the application
-        return renderApp(coreStart, depsStart as AppPluginStartDependencies, params, dataSourceManagement);
-      },
-    });
+  public setup(
+    core: CoreSetup,
+    { dataSource, dataSourceManagement, devTools }: WorkbenchPluginSetupDependencies
+  ): WorkbenchPluginSetup {
+    const isNavGroupEnabled = core.chrome.navGroup.getNavGroupEnabled();
+
+    if (isNavGroupEnabled) {
+      devTools.register({
+        id: 'opensearch-query-workbench',
+        title: PLUGIN_NAME,
+        enableRouting: true,
+        order: 2,
+        async mount(params: AppMountParameters) {
+          // Load application bundle
+          const { renderApp } = await import('./application');
+          // Get start services as specified in opensearch_dashboards.json
+          const [coreStart, depsStart] = await core.getStartServices();
+          // Render the application
+          return renderApp(
+            coreStart,
+            depsStart as AppPluginStartDependencies,
+            params,
+            dataSourceManagement
+          );
+        },
+      });
+
+      // redirect legacy workbench URL to current URL under dev-tools
+      if (window.location.pathname.includes('app/opensearch-query-workbench')) {
+        window.location.assign(convertLegacyWorkbenchUrl(window.location));
+      }
+    } else {
+      core.application.register({
+        id: 'opensearch-query-workbench',
+        title: PLUGIN_NAME,
+        category: {
+          id: 'opensearch',
+          label: 'OpenSearch Plugins',
+          order: 2000,
+        },
+        order: 1000,
+        async mount(params: AppMountParameters) {
+          // Load application bundle
+          const { renderApp } = await import('./application');
+          // Get start services as specified in opensearch_dashboards.json
+          const [coreStart, depsStart] = await core.getStartServices();
+          // Render the application
+          return renderApp(
+            coreStart,
+            depsStart as AppPluginStartDependencies,
+            params,
+            dataSourceManagement
+          );
+        },
+      });
+    }
 
     // Return methods that should be available to other plugins
     return {};