synthetics - adjust is_tls_enabled field for project monitors

elastic · Jan 23, 2023 · 1ebdd24 · 1ebdd24
1 parent 727c554
commit 1ebdd24
Show file tree

Hide file tree

Showing 8 changed files with 422 additions and 12 deletions.
diff --git a/...plugins/synthetics/server/synthetics_service/project_monitor/normalizers/common_fields.ts b/...plugins/synthetics/server/synthetics_service/project_monitor/normalizers/common_fields.ts
@@ -52,7 +52,6 @@ export const getNormalizeCommonFields = ({
   namespace,
 }: NormalizedProjectProps): Partial<CommonFields> => {
   const defaultFields = DEFAULT_COMMON_FIELDS;
-
   const normalizedFields = {
     [ConfigKey.JOURNEY_ID]: monitor.id || defaultFields[ConfigKey.JOURNEY_ID],
     [ConfigKey.MONITOR_SOURCE_TYPE]: SourceType.PROJECT,
@@ -252,3 +251,7 @@ export const normalizeYamlConfig = (monitor: NormalizedProjectProps['monitor'])
     unsupportedKeys,
   };
 };
+
+// returns true when any ssl fields are defined
+export const getHasTLSFields = (monitor: ProjectMonitor) =>
+  Object.keys(monitor).some((key) => key.includes('ssl'));
diff --git a/...ins/synthetics/server/synthetics_service/project_monitor/normalizers/http_monitor.test.ts b/...ins/synthetics/server/synthetics_service/project_monitor/normalizers/http_monitor.test.ts
@@ -4,7 +4,7 @@
  * 2.0; you may not use this file except in compliance with the Elastic License
  * 2.0.
  */
-
+import { omit } from 'lodash';
 import {
   DataStream,
   Locations,
@@ -144,7 +144,7 @@ describe('http normalizers', () => {
           normalizedFields: {
             ...DEFAULT_FIELDS[DataStream.HTTP],
             __ui: {
-              is_tls_enabled: false,
+              is_tls_enabled: true,
             },
             'check.request.body': {
               type: 'json',
@@ -201,7 +201,7 @@ describe('http normalizers', () => {
           normalizedFields: {
             ...DEFAULT_FIELDS[DataStream.HTTP],
             __ui: {
-              is_tls_enabled: false,
+              is_tls_enabled: true,
             },
             'check.request.body': {
               type: 'text',
@@ -255,5 +255,145 @@ describe('http normalizers', () => {
         },
       ]);
     });
+
+    it('sets is_tls_enabled appropriately', () => {
+      const actual = normalizeProjectMonitors({
+        locations,
+        privateLocations,
+        monitors: [monitors[0], { ...omit(monitors[1], ['ssl.supported_protocols']) }],
+        projectId,
+        namespace: 'test-space',
+        version: '8.5.0',
+      });
+      expect(actual).toEqual([
+        {
+          errors: [
+            {
+              details:
+                '`http` project monitors must have exactly one value for field `urls` in version `8.5.0`. Your monitor was not created or updated.',
+              id: 'my-monitor-2',
+              reason: 'Invalid Heartbeat configuration',
+            },
+            {
+              details:
+                'The following Heartbeat options are not supported for http project monitors in 8.5.0: check.response.body|unsupportedKey.nestedUnsupportedKey. You monitor was not created or updated.',
+              id: 'my-monitor-2',
+              reason: 'Unsupported Heartbeat option',
+            },
+          ],
+          normalizedFields: {
+            ...DEFAULT_FIELDS[DataStream.HTTP],
+            __ui: {
+              is_tls_enabled: true,
+            },
+            'check.request.body': {
+              type: 'json',
+              value: '{"json":"body"}',
+            },
+            'check.request.headers': {
+              'a-header': 'a-header-value',
+            },
+            'check.request.method': 'POST',
+            'check.response.body.negative': [],
+            'check.response.body.positive': [],
+            'check.response.headers': {},
+            'check.response.status': ['200'],
+            config_id: '',
+            custom_heartbeat_id: 'my-monitor-2-test-project-id-test-space',
+            enabled: false,
+            form_monitor_type: 'http',
+            journey_id: 'my-monitor-2',
+            locations: [],
+            max_redirects: '0',
+            name: 'My Monitor 2',
+            namespace: 'test_space',
+            origin: 'project',
+            original_space: 'test-space',
+            password: '',
+            project_id: 'test-project-id',
+            proxy_url: '',
+            'response.include_body': 'always',
+            'response.include_headers': false,
+            schedule: {
+              number: '60',
+              unit: 'm',
+            },
+            'service.name': 'test service',
+            'ssl.certificate': '',
+            'ssl.certificate_authorities': '',
+            'ssl.key': '',
+            'ssl.key_passphrase': '',
+            'ssl.supported_protocols': ['TLSv1.2', 'TLSv1.3'],
+            'ssl.verification_mode': 'full',
+            tags: [],
+            timeout: '80',
+            type: 'http',
+            urls: 'http://localhost:9200',
+            'url.port': null,
+            username: '',
+            id: '',
+            hash: testHash,
+          },
+          unsupportedKeys: ['check.response.body', 'unsupportedKey.nestedUnsupportedKey'],
+        },
+        {
+          errors: [],
+          normalizedFields: {
+            ...DEFAULT_FIELDS[DataStream.HTTP],
+            __ui: {
+              is_tls_enabled: false,
+            },
+            'check.request.body': {
+              type: 'text',
+              value: 'sometextbody',
+            },
+            'check.request.headers': {
+              'a-header': 'a-header-value',
+            },
+            'check.request.method': 'POST',
+            'check.response.body.negative': [],
+            'check.response.body.positive': ['Saved', 'saved'],
+            'check.response.headers': {},
+            'check.response.status': ['200'],
+            config_id: '',
+            custom_heartbeat_id: 'my-monitor-3-test-project-id-test-space',
+            enabled: false,
+            form_monitor_type: 'http',
+            journey_id: 'my-monitor-3',
+            locations: [],
+            max_redirects: '0',
+            name: 'My Monitor 3',
+            namespace: 'test_space',
+            origin: 'project',
+            original_space: 'test-space',
+            password: '',
+            project_id: 'test-project-id',
+            proxy_url: '',
+            'response.include_body': 'always',
+            'response.include_headers': false,
+            schedule: {
+              number: '60',
+              unit: 'm',
+            },
+            'service.name': 'test service',
+            'ssl.certificate': '',
+            'ssl.certificate_authorities': '',
+            'ssl.key': '',
+            'ssl.key_passphrase': '',
+            'ssl.supported_protocols': ['TLSv1.1', 'TLSv1.2', 'TLSv1.3'],
+            'ssl.verification_mode': 'full',
+            tags: ['tag2', 'tag2'],
+            timeout: '80',
+            type: 'http',
+            urls: 'http://localhost:9200',
+            'url.port': null,
+            username: '',
+            id: '',
+            hash: testHash,
+          },
+          unsupportedKeys: [],
+        },
+      ]);
+    });
   });
 });
diff --git a/.../plugins/synthetics/server/synthetics_service/project_monitor/normalizers/http_monitor.ts b/.../plugins/synthetics/server/synthetics_service/project_monitor/normalizers/http_monitor.ts
@@ -23,6 +23,7 @@ import {
   getOptionalArrayField,
   getUnsupportedKeysError,
   getInvalidUrlsOrHostsError,
+  getHasTLSFields,
 } from './common_fields';
 
 export const getNormalizeHTTPFields = ({
@@ -69,7 +70,12 @@ export const getNormalizeHTTPFields = ({
     [ConfigKey.TLS_VERSION]: get(monitor, ConfigKey.TLS_VERSION)
       ? (getOptionalListField(get(monitor, ConfigKey.TLS_VERSION)) as TLSVersion[])
       : defaultFields[ConfigKey.TLS_VERSION],
+    [ConfigKey.METADATA]: {
+      ...DEFAULT_FIELDS[DataStream.HTTP][ConfigKey.METADATA],
+      is_tls_enabled: getHasTLSFields(monitor),
+    },
   };
+
   return {
     normalizedFields: {
       ...defaultFields,