Add version-aware settings support (#407) (#427)

* Added version-aware changes



* adding local datasource logic



* adding local datasource logic



* adding local datasource logic



* adding local datasource logic



* adding local datasource logic



* Removed _cat/plugins



* hide live queries in 3.3 below



* updated tests



* updated tests



* updated tests



* Updated tests



* Fixed comments



* Lint fix



---------



(cherry picked from commit 8192a9b)

Signed-off-by: Kishore Kumaar Natarajan <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Kishore Kumaar Natarajan <[email protected]>
Co-authored-by: Chenyang Ji <[email protected]>

Author: 4 people

common/constants.ts

@@ -68,6 +68,7 @@ export const DEFAULT_EXPORTER_TYPE = EXPORTER_TYPE.localIndex;
 export const DEFAULT_DELETE_AFTER_DAYS = '7';
 export const DEFAULT_REFRESH_INTERVAL = 30000; // default 30s
 export const TOP_N_DISPLAY_LIMIT = 9;
+export const DEFAULT_SHOW_LIVE_QUERIES_ON_ERROR = false;
 export const WLM_GROUP_ID_PARAM = 'wlmGroupId';
 export const ALL_WORKLOAD_GROUPS_TEXT = 'All workload groups';
 export const CHART_COLORS = [

cypress/e2e/5_live_queries.cy.js

@@ -358,75 +358,90 @@ describe('Inflight Queries Dashboard - WLM Enabled', () => {
       }).as('getLiveQueries');
     });
 
-    cy.fixture('stub_wlm_stats.json').then((wlmStatsResponse) => {
+    // WLM stats
+    cy.fixture('stub_wlm_stats.json').then((wlmStats) => {
       cy.intercept('GET', '**/api/_wlm/stats', {
         statusCode: 200,
-        body: wlmStatsResponse,
+        body: wlmStats.body,
       }).as('getWlmStats');
     });
 
-    cy.intercept('GET', '**/api/cat_plugins', {
-      statusCode: 200,
-      body: { hasWlm: true },
-    }).as('getPluginsEnabled');
-
     cy.intercept('GET', '**/api/_wlm/workload_group', {
       statusCode: 200,
       body: {
         workload_groups: [
           { _id: 'ANALYTICS_WORKLOAD_GROUP', name: 'ANALYTICS_WORKLOAD_GROUP' },
-          { _id: 'DEFAULT_QUERY_GROUP', name: 'DEFAULT_QUERY_GROUP' },
+          { _id: 'DEFAULT_WORKLOAD_GROUP', name: 'DEFAULT_WORKLOAD_GROUP' },
         ],
       },
     }).as('getWorkloadGroups');
-    cy.intercept('GET', '**/api/cat_plugins', {
+
+    cy.intercept('GET', '**/api/cluster/version', {
       statusCode: 200,
-      body: { hasWlm: true },
-    }).as('getPluginsEnabled');
+      body: { version: '3.3.0' },
+    }).as('getClusterVersion');
 
+    // Navigate AFTER all intercepts are ready, then wait initial snapshot
     cy.navigateToLiveQueries();
-    cy.wait('@getLiveQueries');
   });
 
   it('displays WLM group links when WLM is enabled', () => {
     cy.wait('@getWorkloadGroups');
-    cy.wait('@getPluginsEnabled');
 
     cy.get('tbody tr')
       .first()
       .within(() => {
-        cy.get('td').contains('ANALYTICS_WORKLOAD_GROUP').click({ force: true });
+        cy.contains('td', 'ANALYTICS_WORKLOAD_GROUP').click({ force: true });
       });
   });
 
   it('calls different API when WLM group selection changes', () => {
-    // Intercept all live_queries calls
-    cy.intercept('GET', '**/api/live_queries*').as('liveQueries');
+    // Robust spies that tolerate extra query params & any order
+    cy.intercept('GET', /\/api\/live_queries\?(?=.*\bwlmGroupId=ANALYTICS_WORKLOAD_GROUP\b).*/).as(
+      'liveQueriesAnalytics'
+    );
+
+    cy.intercept('GET', /\/api\/live_queries\?(?=.*\bwlmGroupId=DEFAULT_WORKLOAD_GROUP\b).*/).as(
+      'liveQueriesDefault'
+    );
 
-    // 1) Select ANALYTICS first
-    cy.get('#wlm-group-select').should('exist').select('ANALYTICS_WORKLOAD_GROUP');
+    cy.get('#wlm-group-select').should('exist');
 
-    cy.wait('@liveQueries')
+    // 1) Select ANALYTICS
+    cy.get('#wlm-group-select').select('ANALYTICS_WORKLOAD_GROUP');
+    cy.wait('@liveQueriesAnalytics')
       .its('request.url')
-      .should('include', 'wlmGroupId=ANALYTICS_WORKLOAD_GROUP');
+      .should((urlStr) => {
+        const url = new URL(urlStr);
+        expect(url.searchParams.get('wlmGroupId')).to.eq('ANALYTICS_WORKLOAD_GROUP');
+      });
 
-    // Component re-fetches workload groups after selection — wait for that
+    // Component re-fetches groups after selection
     cy.wait('@getWorkloadGroups');
 
-    // 2) Select DEFAULT_WORKLOAD_GROUP explicitly
+    // 2) Select DEFAULT
     cy.get('#wlm-group-select').select('DEFAULT_WORKLOAD_GROUP');
 
-    cy.wait('@liveQueries')
+    cy.wait('@liveQueriesDefault')
       .its('request.url')
-      .should('include', 'wlmGroupId=DEFAULT_WORKLOAD_GROUP');
+      .should((urlStr) => {
+        const url = new URL(urlStr);
+        expect(url.searchParams.get('wlmGroupId')).to.eq('DEFAULT_WORKLOAD_GROUP');
+      });
   });
 
   it('displays total completion, cancellation, and rejection metrics correctly', () => {
-    // Trigger a refresh to ensure WLM stats are loaded
-    cy.get('[data-test-subj="live-queries-refresh-button"]').click();
+    // Wait for version check to complete
+    cy.wait('@getClusterVersion');
+
+    // Wait for WLM groups to be fetched
+    cy.wait('@getWorkloadGroups');
+
+    // Wait for WLM stats to be fetched
     cy.wait('@getWlmStats');
 
-    cy.contains('Total completions')
+    // Wait for the panels to be rendered with data
+    cy.contains('Total completions', { timeout: 10000 })
       .closest('.euiPanel')
       .within(() => {
         cy.get('h2').should('contain.text', '300');

opensearch_dashboards.json

@@ -5,7 +5,8 @@
   "server": true,
   "ui": true,
   "requiredPlugins": [
-    "navigation"
+    "navigation",
+    "opensearchDashboardsUtils"
   ],
   "optionalPlugins": [
     "dataSource",

public/application.tsx

@@ -10,13 +10,45 @@ import { AppMountParameters, CoreStart } from '../../../src/core/public';
 import { QueryInsightsDashboardsApp } from './components/app';
 import { QueryInsightsDashboardsPluginStartDependencies } from './types';
 import { DataSourceManagementPluginSetup } from '../../../src/plugins/data_source_management/public';
+import {
+  setCore,
+  setSavedObjectsClient,
+  setRouteService,
+  setDataSourceManagementPlugin,
+  setDataSourceEnabled,
+  setNotifications,
+  setUISettings,
+  setApplication,
+  setNavigationUI,
+  setHeaderActionMenu,
+} from './service';
+import { RouteService } from './route_service';
 
 export const renderApp = (
   core: CoreStart,
   depsStart: QueryInsightsDashboardsPluginStartDependencies,
   params: AppMountParameters,
   dataSourceManagement?: DataSourceManagementPluginSetup
 ) => {
+  // Initialize services
+  setCore(core);
+  setSavedObjectsClient(core.savedObjects.client);
+  setRouteService(new RouteService(core.http));
+  setNotifications(core.notifications);
+  setUISettings(core.uiSettings);
+  setApplication(core.application);
+  setHeaderActionMenu(params.setHeaderActionMenu);
+
+  if (dataSourceManagement) {
+    setDataSourceManagementPlugin(dataSourceManagement);
+  }
+
+  if (depsStart.navigation) {
+    setNavigationUI(depsStart.navigation.ui);
+  }
+
+  setDataSourceEnabled({ enabled: !!dataSourceManagement });
+
   ReactDOM.render(
     <Router>
       <QueryInsightsDashboardsApp