refactor get_all_environments to minimize exports and be more consistent and clean

ogupte · ogupte · commit c798812f5d65 · 2020-08-26T15:41:03.000-07:00
diff --git a/x-pack/plugins/apm/common/environment_filter_values.ts b/x-pack/plugins/apm/common/environment_filter_values.ts
@@ -6,32 +6,30 @@
 
 import { i18n } from '@kbn/i18n';
 
-export const ENVIRONMENT_ALL = 'ENVIRONMENT_ALL';
-export const ENVIRONMENT_NOT_DEFINED = 'ENVIRONMENT_NOT_DEFINED';
+const ENVIRONMENT_ALL_VALUE = 'ENVIRONMENT_ALL';
+const ENVIRONMENT_NOT_DEFINED_VALUE = 'ENVIRONMENT_NOT_DEFINED';
 
-const ENVIRONMENT_ALL_LABEL = i18n.translate('xpack.apm.environment.allLabel', {
-  defaultMessage: 'All',
-});
-const ENVIRONMENT_NOT_DEFINED_LABEL = i18n.translate(
-  'xpack.apm.filter.environment.notDefinedLabel',
-  { defaultMessage: 'Not defined' }
-);
+const environmentLabels: Record<string, string> = {
+  [ENVIRONMENT_ALL_VALUE]: i18n.translate(
+    'xpack.apm.filter.environment.allLabel',
+    { defaultMessage: 'All' }
+  ),
+  [ENVIRONMENT_NOT_DEFINED_VALUE]: i18n.translate(
+    'xpack.apm.filter.environment.notDefinedLabel',
+    { defaultMessage: 'Not defined' }
+  ),
+};
 
-export const ALL_OPTION = {
-  value: ENVIRONMENT_ALL,
-  text: ENVIRONMENT_ALL_LABEL,
+export const ENVIRONMENT_ALL = {
+  value: ENVIRONMENT_ALL_VALUE,
+  text: environmentLabels[ENVIRONMENT_ALL_VALUE],
 };
-export const NOT_DEFINED_OPTION = {
-  value: ENVIRONMENT_NOT_DEFINED,
-  text: ENVIRONMENT_NOT_DEFINED_LABEL,
+
+export const ENVIRONMENT_NOT_DEFINED = {
+  value: ENVIRONMENT_NOT_DEFINED_VALUE,
+  text: environmentLabels[ENVIRONMENT_NOT_DEFINED_VALUE],
 };
 
 export function getEnvironmentLabel(environment: string) {
-  if (environment === ENVIRONMENT_ALL) {
-    return ENVIRONMENT_ALL_LABEL;
-  }
-  if (environment === ENVIRONMENT_NOT_DEFINED) {
-    return ENVIRONMENT_NOT_DEFINED_LABEL;
-  }
-  return environment;
+  return environmentLabels[environment] || environment;
 }
diff --git a/x-pack/plugins/apm/public/components/shared/EnvironmentFilter/index.tsx b/x-pack/plugins/apm/public/components/shared/EnvironmentFilter/index.tsx
@@ -12,8 +12,6 @@ import { useUrlParams } from '../../../hooks/useUrlParams';
 import { history } from '../../../utils/history';
 import { fromQuery, toQuery } from '../Links/url_helpers';
 import {
-  ALL_OPTION,
-  NOT_DEFINED_OPTION,
   ENVIRONMENT_ALL,
   ENVIRONMENT_NOT_DEFINED,
 } from '../../../../common/environment_filter_values';
@@ -24,7 +22,7 @@ function updateEnvironmentUrl(
   environment?: string
 ) {
   const nextEnvironmentQueryParam =
-    environment !== ENVIRONMENT_ALL ? environment : undefined;
+    environment !== ENVIRONMENT_ALL.value ? environment : undefined;
   history.push({
     ...location,
     search: fromQuery({
@@ -44,16 +42,16 @@ const SEPARATOR_OPTION = {
 
 function getOptions(environments: string[]) {
   const environmentOptions = environments
-    .filter((env) => env !== ENVIRONMENT_NOT_DEFINED)
+    .filter((env) => env !== ENVIRONMENT_NOT_DEFINED.value)
     .map((environment) => ({
       value: environment,
       text: environment,
     }));
 
   return [
-    ALL_OPTION,
-    ...(environments.includes(ENVIRONMENT_NOT_DEFINED)
-      ? [NOT_DEFINED_OPTION]
+    ENVIRONMENT_ALL,
+    ...(environments.includes(ENVIRONMENT_NOT_DEFINED.value)
+      ? [ENVIRONMENT_NOT_DEFINED]
       : []),
     ...(environmentOptions.length > 0 ? [SEPARATOR_OPTION] : []),
     ...environmentOptions,
@@ -78,7 +76,7 @@ export function EnvironmentFilter() {
         defaultMessage: 'environment',
       })}
       options={getOptions(environments)}
-      value={environment || ENVIRONMENT_ALL}
+      value={environment || ENVIRONMENT_ALL.value}
       onChange={(event) => {
         updateEnvironmentUrl(location, event.target.value);
       }}
diff --git a/x-pack/plugins/apm/public/components/shared/ErrorRateAlertTrigger/index.tsx b/x-pack/plugins/apm/public/components/shared/ErrorRateAlertTrigger/index.tsx
@@ -43,7 +43,7 @@ export function ErrorRateAlertTrigger(props: Props) {
     threshold: 25,
     windowSize: 1,
     windowUnit: 'm',
-    environment: ENVIRONMENT_ALL,
+    environment: ENVIRONMENT_ALL.value,
   };
 
   const params = {
diff --git a/x-pack/plugins/apm/public/components/shared/TransactionDurationAlertTrigger/index.tsx b/x-pack/plugins/apm/public/components/shared/TransactionDurationAlertTrigger/index.tsx
@@ -58,7 +58,7 @@ export function TransactionDurationAlertTrigger(props: Props) {
     windowSize: 5,
     windowUnit: 'm',
     transactionType: transactionTypes[0],
-    environment: ENVIRONMENT_ALL,
+    environment: ENVIRONMENT_ALL.value,
   };
 
   const params = {
diff --git a/x-pack/plugins/apm/public/components/shared/TransactionDurationAnomalyAlertTrigger/index.tsx b/x-pack/plugins/apm/public/components/shared/TransactionDurationAnomalyAlertTrigger/index.tsx
@@ -52,7 +52,7 @@ export function TransactionDurationAnomalyAlertTrigger(props: Props) {
     windowUnit: 'm',
     transactionType: transactionTypes[0],
     serviceName,
-    environment: urlParams.environment || ENVIRONMENT_ALL,
+    environment: urlParams.environment || ENVIRONMENT_ALL.value,
     anomalyScore: 75,
   };
 
diff --git a/x-pack/plugins/apm/public/hooks/useEnvironments.tsx b/x-pack/plugins/apm/public/hooks/useEnvironments.tsx
@@ -7,20 +7,20 @@
 import { useMemo } from 'react';
 import { useFetcher } from './useFetcher';
 import {
-  ALL_OPTION,
+  ENVIRONMENT_ALL,
   ENVIRONMENT_NOT_DEFINED,
 } from '../../common/environment_filter_values';
 import { callApmApi } from '../services/rest/createCallApmApi';
 
 function getEnvironmentOptions(environments: string[]) {
   const environmentOptions = environments
-    .filter((env) => env !== ENVIRONMENT_NOT_DEFINED)
+    .filter((env) => env !== ENVIRONMENT_NOT_DEFINED.value)
     .map((environment) => ({
       value: environment,
       text: environment,
     }));
 
-  return [ALL_OPTION, ...environmentOptions];
+  return [ENVIRONMENT_ALL, ...environmentOptions];
 }
 
 export function useEnvironments({
diff --git a/x-pack/plugins/apm/server/lib/alerts/register_error_rate_alert_type.ts b/x-pack/plugins/apm/server/lib/alerts/register_error_rate_alert_type.ts
@@ -75,7 +75,7 @@ export function registerErrorRateAlertType({
       });
 
       const environmentTerm =
-        alertParams.environment === ENVIRONMENT_ALL
+        alertParams.environment === ENVIRONMENT_ALL.value
           ? []
           : [{ term: { [SERVICE_ENVIRONMENT]: alertParams.environment } }];
 
diff --git a/x-pack/plugins/apm/server/lib/alerts/register_transaction_duration_alert_type.ts b/x-pack/plugins/apm/server/lib/alerts/register_transaction_duration_alert_type.ts
@@ -89,7 +89,7 @@ export function registerTransactionDurationAlertType({
       });
 
       const environmentTerm =
-        alertParams.environment === ENVIRONMENT_ALL
+        alertParams.environment === ENVIRONMENT_ALL.value
           ? []
           : [{ term: { [SERVICE_ENVIRONMENT]: alertParams.environment } }];
 
diff --git a/x-pack/plugins/apm/server/lib/environments/get_all_environments.ts b/x-pack/plugins/apm/server/lib/environments/get_all_environments.ts
@@ -48,7 +48,7 @@ export async function getAllEnvironments({
           terms: {
             field: SERVICE_ENVIRONMENT,
             size: 100,
-            missing: includeMissing ? ENVIRONMENT_NOT_DEFINED : undefined,
+            missing: includeMissing ? ENVIRONMENT_NOT_DEFINED.value : undefined,
           },
         },
       },
diff --git a/x-pack/plugins/apm/server/lib/helpers/convert_ui_filters/__test__/get_environment_ui_filter_es.test.ts b/x-pack/plugins/apm/server/lib/helpers/convert_ui_filters/__test__/get_environment_ui_filter_es.test.ts
@@ -21,7 +21,7 @@ describe('getEnvironmentUiFilterES', () => {
   });
 
   it('should create a filter for missing service environments', () => {
-    const uiFilterES = getEnvironmentUiFilterES(ENVIRONMENT_NOT_DEFINED);
+    const uiFilterES = getEnvironmentUiFilterES(ENVIRONMENT_NOT_DEFINED.value);
     expect(uiFilterES).toHaveLength(1);
     expect(uiFilterES[0]).toHaveProperty(
       ['bool', 'must_not', 'exists', 'field'],
diff --git a/x-pack/plugins/apm/server/lib/helpers/convert_ui_filters/get_environment_ui_filter_es.ts b/x-pack/plugins/apm/server/lib/helpers/convert_ui_filters/get_environment_ui_filter_es.ts
@@ -12,7 +12,7 @@ export function getEnvironmentUiFilterES(environment?: string): ESFilter[] {
   if (!environment) {
     return [];
   }
-  if (environment === ENVIRONMENT_NOT_DEFINED) {
+  if (environment === ENVIRONMENT_NOT_DEFINED.value) {
     return [{ bool: { must_not: { exists: { field: SERVICE_ENVIRONMENT } } } }];
   }
   return [{ term: { [SERVICE_ENVIRONMENT]: environment } }];
diff --git a/x-pack/plugins/apm/server/lib/service_map/get_service_anomalies.ts b/x-pack/plugins/apm/server/lib/service_map/get_service_anomalies.ts
@@ -148,7 +148,7 @@ export async function getMLJobIds(
   const mlJobs = response.jobs.filter(
     (job) => (job.custom_settings?.job_tags?.apm_ml_version ?? 0) >= 2
   );
-  if (environment && environment !== ENVIRONMENT_ALL) {
+  if (environment && environment !== ENVIRONMENT_ALL.value) {
     const matchingMLJob = mlJobs.find(
       (job) => job.custom_settings?.job_tags?.environment === environment
     );
diff --git a/x-pack/plugins/apm/server/lib/ui_filters/get_environments.ts b/x-pack/plugins/apm/server/lib/ui_filters/get_environments.ts
@@ -47,7 +47,7 @@ export async function getEnvironments(
         environments: {
           terms: {
             field: SERVICE_ENVIRONMENT,
-            missing: ENVIRONMENT_NOT_DEFINED,
+            missing: ENVIRONMENT_NOT_DEFINED.value,
           },
         },
       },
diff --git a/x-pack/plugins/translations/translations/ja-JP.json b/x-pack/plugins/translations/translations/ja-JP.json
@@ -4774,7 +4774,6 @@
     "xpack.apm.customLink.empty": "カスタムリンクが見つかりません。独自のカスタムリンク、たとえば特定のダッシュボードまたは外部リンクへのリンクをセットアップします。",
     "xpack.apm.emptyMessage.noDataFoundDescription": "別の時間範囲を試すか検索フィルターをリセットしてください。",
     "xpack.apm.emptyMessage.noDataFoundLabel": "データが見つかりません。",
-    "xpack.apm.environment.allLabel": "すべて",
     "xpack.apm.error.prompt.body": "詳細はブラウザの開発者コンソールをご確認ください。",
     "xpack.apm.error.prompt.title": "申し訳ございませんが、エラーが発生しました :(",
     "xpack.apm.errorGroupDetails.avgLabel": "平均",
@@ -4812,6 +4811,7 @@
     "xpack.apm.fetcher.error.title": "リソースの取得中にエラーが発生しました",
     "xpack.apm.fetcher.error.url": "URL",
     "xpack.apm.filter.environment.label": "環境",
+    "xpack.apm.filter.environment.allLabel": "すべて",
     "xpack.apm.filter.environment.notDefinedLabel": "未定義",
     "xpack.apm.filter.environment.selectEnvironmentLabel": "環境を選択",
     "xpack.apm.formatters.hoursTimeUnitLabel": "h",
diff --git a/x-pack/plugins/translations/translations/zh-CN.json b/x-pack/plugins/translations/translations/zh-CN.json
@@ -4775,7 +4775,6 @@
     "xpack.apm.customLink.empty": "未找到定制链接。设置自己的定制链接，如特定仪表板的链接或外部链接。",
     "xpack.apm.emptyMessage.noDataFoundDescription": "尝试其他时间范围或重置搜索筛选。",
     "xpack.apm.emptyMessage.noDataFoundLabel": "未找到任何数据",
-    "xpack.apm.environment.allLabel": "全部",
     "xpack.apm.error.prompt.body": "有关详情，请查看您的浏览器开发者控制台。",
     "xpack.apm.error.prompt.title": "抱歉，发生错误 :(",
     "xpack.apm.errorGroupDetails.avgLabel": "平均",
@@ -4813,6 +4812,7 @@
     "xpack.apm.fetcher.error.title": "提取资源时出错",
     "xpack.apm.fetcher.error.url": "URL",
     "xpack.apm.filter.environment.label": "环境",
+    "xpack.apm.filter.environment.allLabel": "全部",
     "xpack.apm.filter.environment.notDefinedLabel": "未定义",
     "xpack.apm.filter.environment.selectEnvironmentLabel": "选择环境",
     "xpack.apm.formatters.hoursTimeUnitLabel": "h",
