Ensure constants and utils are under common (#88)

github-actions[bot] · github-actions[bot] · commit 3433c925db44 · 2025-01-30T20:31:51.000Z
Signed-off-by: Chenyang Ji <cyji@amazon.com> (cherry picked from commit e5c5d4b) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
diff --git a/.github/workflows/verify-binary-installation.yml b/.github/workflows/verify-binary-installation.yml
@@ -0,0 +1,55 @@
+name: 'Install Query Insights Dashboards with Plugin via Binary'
+
+on: [push, pull_request]
+env:
+  OPENSEARCH_VERSION: '2.19.0'
+  CI: 1
+  # avoid warnings like "tput: No value for $TERM and no -T specified"
+  TERM: xterm
+  OPENSEARCH_INITIAL_ADMIN_PASSWORD: myStrongPassword123!
+
+jobs:
+  verify-binary-installation:
+    name: Run binary installation
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        # TODO: add windows support when OSD core is stable on windows
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout Branch
+        uses: actions/checkout@v3
+
+      - name: Set env
+        run: |
+          opensearch_version=$(node -p "require('./package.json').opensearchDashboards.version")
+          plugin_version=$(node -p "require('./package.json').version")
+          echo "OPENSEARCH_VERSION=$opensearch_version" >> $GITHUB_ENV
+          echo "PLUGIN_VERSION=$plugin_version" >> $GITHUB_ENV
+        shell: bash
+
+      - name: Run OpenSearch
+        uses: derek-ho/start-opensearch@v6
+        with:
+          opensearch-version: ${{ env.OPENSEARCH_VERSION }}
+          security-enabled: false
+
+      - name: Run Dashboard
+        id: setup-dashboards
+        uses: derek-ho/setup-opensearch-dashboards@v1
+        with:
+          plugin_name: query-insights-dashboards
+          built_plugin_name: queryInsightsDashboards
+          install_zip: true
+
+      - name: Start the binary
+        run: |
+          nohup ./bin/opensearch-dashboards &
+        working-directory: ${{ steps.setup-dashboards.outputs.dashboards-binary-directory }}
+        shell: bash
+
+      - name: Health check
+        run: |
+          timeout 300 bash -c 'while [[ "$(curl -u admin:${{ env.OPENSEARCH_INITIAL_ADMIN_PASSWORD }} -k http://localhost:5601/api/status | jq -r '.status.overall.state')" != "green" ]]; do sleep 5; done'
+        shell: bash
diff --git a/common/constants.ts b/common/constants.ts
@@ -18,3 +18,54 @@ export const GROUP_BY = 'Group by';
 export const AVERAGE_LATENCY = 'Average Latency';
 export const AVERAGE_CPU_TIME = 'Average CPU Time';
 export const AVERAGE_MEMORY_USAGE = 'Average Memory Usage';
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export const MetricType = {
+  LATENCY: 'latency',
+  CPU: 'cpu',
+  MEMORY: 'memory',
+};
+export const METRIC_TYPES_TEXT = [
+  { value: MetricType.LATENCY, text: 'Latency' },
+  { value: MetricType.CPU, text: 'CPU' },
+  { value: MetricType.MEMORY, text: 'Memory' },
+];
+export const TIME_UNITS_TEXT = [
+  { value: 'MINUTES', text: 'Minute(s)' },
+  { value: 'HOURS', text: 'Hour(s)' },
+];
+export const MINUTES_OPTIONS = [
+  { value: '1', text: '1' },
+  { value: '5', text: '5' },
+  { value: '10', text: '10' },
+  { value: '30', text: '30' },
+];
+export const GROUP_BY_OPTIONS = [
+  { value: 'none', text: 'None' },
+  { value: 'similarity', text: 'Similarity' },
+];
+export const TIME_UNIT = {
+  MINUTES: 'MINUTES',
+  HOURS: 'HOURS',
+};
+export const TIME_UNIT_ABBREVIATION = {
+  MINUTES: 'm',
+  HOURS: 'h',
+};
+export const EXPORTER_TYPE = {
+  localIndex: 'local_index',
+  none: 'none',
+};
+export const EXPORTER_TYPES_LIST = [
+  { value: EXPORTER_TYPE.localIndex, text: 'Local Index' },
+  { value: EXPORTER_TYPE.none, text: 'None' },
+];
+export const DEFAULT_METRIC_ENABLED = true;
+export const DEFAULT_TOP_N_SIZE = '10';
+export const DEFAULT_WINDOW_SIZE = '5';
+export const DEFAULT_TIME_UNIT = TIME_UNIT.MINUTES;
+export const DEFAULT_GROUP_BY = 'none';
+export const DEFAULT_EXPORTER_TYPE = EXPORTER_TYPE.localIndex;
+export const DEFAULT_DELETE_AFTER_DAYS = '7';
diff --git a/common/utils/DateUtils.ts b/common/utils/DateUtils.ts
diff --git a/common/utils/MetricUtils.ts b/common/utils/MetricUtils.ts
@@ -3,8 +3,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { DEFAULT_TIME_UNIT, DEFAULT_WINDOW_SIZE, TIME_UNIT_ABBREVIATION } from './Constants';
-import { MetricSettingsResponse } from '../../../types/types';
+import { DEFAULT_TIME_UNIT, DEFAULT_WINDOW_SIZE, TIME_UNIT_ABBREVIATION } from '../constants';
+import { MetricSettingsResponse } from '../../types/types';
 
 export function calculateMetric(
   value?: number,
diff --git a/common/utils/QueryUtils.ts b/common/utils/QueryUtils.ts
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { SearchQueryRecord } from '../../../types/types';
+import { SearchQueryRecord } from '../../types/types';
 
 // Utility function to fetch query by id and time range
 export const retrieveQueryById = async (
diff --git a/package.json b/package.json
@@ -3,6 +3,10 @@
   "version": "2.19.0.0",
   "description": "OpenSearch Dashboards plugin for Query Insights",
   "main": "index.js",
+  "opensearchDashboards": {
+    "version": "2.19.0",
+    "templateVersion": "2.19.0"
+  },
   "license": "Apache-2.0",
   "homepage": "https://github.com/opensearch-project/query-insights-dashboards",
   "config": {
@@ -65,4 +69,4 @@
     "node_modules/*",
     "target/*"
   ]
-}
+}
diff --git a/public/pages/Configuration/Configuration.tsx b/public/pages/Configuration/Configuration.tsx
@@ -39,7 +39,7 @@ import {
   GROUP_BY_OPTIONS,
   EXPORTER_TYPES_LIST,
   EXPORTER_TYPE,
-} from '../Utils/Constants';
+} from '../../../common/constants';
 import { QueryInsightsDataSourceMenu } from '../../components/DataSourcePicker';
 import { QueryInsightsDashboardsPluginStartDependencies } from '../../types';
 
diff --git a/public/pages/QueryDetails/Components/QuerySummary.tsx b/public/pages/QueryDetails/Components/QuerySummary.tsx
@@ -16,7 +16,7 @@ import {
   TIMESTAMP,
   TOTAL_SHARDS,
 } from '../../../../common/constants';
-import { calculateMetric } from '../../Utils/MetricUtils';
+import { calculateMetric } from '../../../../common/utils/MetricUtils';
 
 // Panel component for displaying query detail values
 const PanelItem = ({ label, value }: { label: string; value: string | number }) => (
diff --git a/public/pages/QueryDetails/QueryDetails.test.tsx b/public/pages/QueryDetails/QueryDetails.test.tsx
@@ -12,14 +12,14 @@ import '@testing-library/jest-dom';
 import plotly from 'plotly.js-dist';
 import { MemoryRouter, Route } from 'react-router-dom';
 import hash from 'object-hash';
-import { retrieveQueryById } from '../Utils/QueryUtils';
+import { retrieveQueryById } from '../../../common/utils/QueryUtils';
 import { DataSourceContext } from '../TopNQueries/TopNQueries';
 
 jest.mock('plotly.js-dist', () => ({
   newPlot: jest.fn(),
 }));
 
-jest.mock('../Utils/QueryUtils', () => ({
+jest.mock('../../../common/utils/QueryUtils', () => ({
   retrieveQueryById: jest.fn(),
 }));
 
diff --git a/public/pages/QueryDetails/QueryDetails.tsx b/public/pages/QueryDetails/QueryDetails.tsx
@@ -26,7 +26,7 @@ import { DataSourceContext, QUERY_INSIGHTS } from '../TopNQueries/TopNQueries';
 import { SearchQueryRecord } from '../../../types/types';
 import { PageHeader } from '../../components/PageHeader';
 import { QueryInsightsDashboardsPluginStartDependencies } from '../../types';
-import { retrieveQueryById } from '../Utils/QueryUtils';
+import { retrieveQueryById } from '../../../common/utils/QueryUtils';
 import { QueryInsightsDataSourceMenu } from '../../components/DataSourcePicker';
 
 import { getDataSourceFromUrl } from '../../utils/datasource-utils';
diff --git a/public/pages/QueryGroupDetails/Components/QueryGroupAggregateSummary.tsx b/public/pages/QueryGroupDetails/Components/QueryGroupAggregateSummary.tsx
@@ -12,7 +12,7 @@ import {
   GROUP_BY,
   ID,
 } from '../../../../common/constants';
-import { calculateMetric } from '../../Utils/MetricUtils';
+import { calculateMetric } from '../../../../common/utils/MetricUtils';
 
 // Panel component for displaying query group detail values
 const PanelItem = ({ label, value }: { label: string; value: string | number }) => (
diff --git a/public/pages/QueryGroupDetails/QueryGroupDetails.test.tsx b/public/pages/QueryGroupDetails/QueryGroupDetails.test.tsx
@@ -10,7 +10,7 @@ import { CoreStart } from 'opensearch-dashboards/public';
 import React from 'react';
 import { mockQueries } from '../../../test/mocks/mockQueries';
 import '@testing-library/jest-dom/extend-expect';
-import { retrieveQueryById } from '../Utils/QueryUtils';
+import { retrieveQueryById } from '../../../common/utils/QueryUtils';
 import { DataSourceContext } from '../TopNQueries/TopNQueries';
 
 jest.mock('object-hash', () => jest.fn(() => '8c1e50c035663459d567fa11d8eb494d'));
@@ -21,7 +21,7 @@ jest.mock('plotly.js-dist', () => ({
   relayout: jest.fn(),
 }));
 
-jest.mock('../Utils/QueryUtils', () => ({
+jest.mock('../../../common/utils/QueryUtils', () => ({
   retrieveQueryById: jest.fn(),
 }));
 
diff --git a/public/pages/QueryGroupDetails/QueryGroupDetails.tsx b/public/pages/QueryGroupDetails/QueryGroupDetails.tsx
@@ -29,7 +29,7 @@ import { QueryGroupSampleQuerySummary } from './Components/QueryGroupSampleQuery
 import { QueryInsightsDashboardsPluginStartDependencies } from '../../types';
 import { PageHeader } from '../../components/PageHeader';
 import { SearchQueryRecord } from '../../../types/types';
-import { retrieveQueryById } from '../Utils/QueryUtils';
+import { retrieveQueryById } from '../../../common/utils/QueryUtils';
 import { QueryInsightsDataSourceMenu } from '../../components/DataSourcePicker';
 import { getDataSourceFromUrl } from '../../utils/datasource-utils';
 
diff --git a/public/pages/QueryInsights/QueryInsights.tsx b/public/pages/QueryInsights/QueryInsights.tsx
@@ -23,8 +23,8 @@ import {
   TOTAL_SHARDS,
   TYPE,
 } from '../../../common/constants';
-import { calculateMetric } from '../Utils/MetricUtils';
-import { parseDateString } from '../Utils/DateUtils';
+import { calculateMetric } from '../../../common/utils/MetricUtils';
+import { parseDateString } from '../../../common/utils/DateUtils';
 import { QueryInsightsDataSourceMenu } from '../../components/DataSourcePicker';
 import { QueryInsightsDashboardsPluginStartDependencies } from '../../types';
 
diff --git a/public/pages/TopNQueries/TopNQueries.tsx b/public/pages/TopNQueries/TopNQueries.tsx
@@ -24,17 +24,17 @@ import {
   DEFAULT_TIME_UNIT,
   DEFAULT_TOP_N_SIZE,
   DEFAULT_WINDOW_SIZE,
+  EXPORTER_TYPE,
   MetricType,
-} from '../Utils/Constants';
+} from '../../../common/constants';
 
-import { parseDateString } from '../Utils/DateUtils';
+import { parseDateString } from '../../../common/utils/DateUtils';
 import {
   getMergedMetricSettings,
   getMergedStringSettings,
   getTimeAndUnitFromString,
-} from '../Utils/MetricUtils';
+} from '../../../common/utils/MetricUtils';
 import { getDataSourceFromUrl } from '../../utils/datasource-utils';
-import { EXPORTER_TYPE } from '../Utils/Constants';
 
 export const QUERY_INSIGHTS = '/queryInsights';
 export const CONFIGURATION = '/configuration';
diff --git a/public/pages/Utils/Constants.ts b/public/pages/Utils/Constants.ts
diff --git a/server/routes/index.ts b/server/routes/index.ts
@@ -5,7 +5,7 @@
 
 import { schema } from '@osd/config-schema';
 import { IRouter } from '../../../../src/core/server';
-import { EXPORTER_TYPE } from '../../public/pages/Utils/Constants';
+import { EXPORTER_TYPE } from '../../common/constants';
 
 export function defineRoutes(router: IRouter, dataSourceEnabled: boolean) {
   router.get(
