[Synthetics] enable/disable - prevent incorrect keys from being added to the monitor saved object #140553

dominiqueclarke · 2022-09-12T20:01:27Z

Summary

Fixes a bug where incorrect keys were being added to montiors on the enable/disable flow in Synthetics UI.

This was due to an oversight where types were changed to accept either a Synthetics Monitor saved object or an Overview Monitor Item. In reality, Overview Monitor Items are not a type of Synthetics monitor, but is a unique object for displaying information about a monitor on the overview page in general. This only impacted 8.5.0.

The enable/disable hook was updated to adjust the types.

Additionally, extra runtime type decoding was added to ensure that unknown keys cannot be added to a monitor-saved object. The t.exact type returns a valid monitor, stripped of any additional unknown keys that are not part of the codec.

Testing

Create a monitor.
Navigate to Overview. Disable the monitor
Inspect the monitor saved object. You can do this by viewing the monitor get request when editing the monitor.
Inspect the attributes key of the monitor. Ensure that no keys from the MonitorOverviewItem are present, such as location, isEnabled or id.

… to the monitor saved object

…-ref HEAD~1..HEAD --fix'

…enable-disable-incorrect-keys

…//github.com/dominiqueclarke/kibana into fix/synthetics-enable-disable-incorrect-keys

…-ref HEAD~1..HEAD --fix'

…//github.com/dominiqueclarke/kibana into fix/synthetics-enable-disable-incorrect-keys

x-pack/test/api_integration/apis/uptime/rest/add_monitor.ts

…//github.com/dominiqueclarke/kibana into fix/synthetics-enable-disable-incorrect-keys

x-pack/plugins/synthetics/common/runtime_types/monitor_management/monitor_types.ts

…ent/monitor_types.ts

x-pack/plugins/synthetics/server/routes/monitor_cruds/add_monitor.ts

…tor.ts

dominiqueclarke · 2022-09-25T19:30:51Z

x-pack/plugins/synthetics/public/apps/synthetics/hooks/use_monitor_enable_handler.tsx

      dispatch(
        fetchUpsertMonitorAction({
          id,
-          monitor: { ...monitor, [ConfigKey.ENABLED]: enabled },
+          monitor: { [ConfigKey.ENABLED]: enabled },


Since edits are applied on top of the existing object, we can just pass the enabled key to be safe here.

elasticmachine · 2022-09-25T19:32:55Z

Pinging @elastic/uptime (Team:uptime)

…//github.com/dominiqueclarke/kibana into fix/synthetics-enable-disable-incorrect-keys

…-fix'

…//github.com/dominiqueclarke/kibana into fix/synthetics-enable-disable-incorrect-keys

dominiqueclarke · 2022-09-27T11:53:53Z

@elasticmachine merge upstream

shahzad31

LGTM, Works as expected, doesn't add extra fields now !!

kibana-ci · 2022-09-29T15:12:50Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 5c43159

Failed CI Steps

Synthetics @elastic/synthetics Tests

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`synthetics`	1023.3KB	1023.6KB	+297.0B

History

💔 Build #76849 failed 3a7d244
💚 Build #75988 succeeded f9fe54bf17bc11178f8125ccd2f70601e362aa96
💚 Build #75776 succeeded 4d4ca60
💔 Build #75689 failed 1871790
💔 Build #75662 failed 694c390

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

… to the monitor saved object (elastic#140553) * synthetics - enable/disable - prevent incorrect keys from being added to the monitor saved object * [CI] Auto-commit changed files from 'node scripts/precommit_hook.js --ref HEAD~1..HEAD --fix' * adjust types * add exact typing * [CI] Auto-commit changed files from 'node scripts/precommit_hook.js --ref HEAD~1..HEAD --fix' * adjust test * use exact types * use exact types for editing * adjust types * adjust tests * adjust types * Update x-pack/test/api_integration/apis/uptime/rest/add_monitor.ts * adjust normalizers * Update x-pack/plugins/synthetics/common/runtime_types/monitor_management/monitor_types.ts * Update x-pack/plugins/synthetics/server/routes/monitor_cruds/add_monitor.ts * adjust types * [CI] Auto-commit changed files from 'node scripts/eslint --no-cache --fix' * adjust jest tests * adjust types * adjust api_integration tests * update tests Co-authored-by: kibanamachine <[email protected]> (cherry picked from commit 27916d3)

kibanamachine · 2022-09-29T15:29:21Z

💚 All backports created successfully

Status	Branch	Result
✅	8.5

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

… to the monitor saved object (#140553) (#142238) * synthetics - enable/disable - prevent incorrect keys from being added to the monitor saved object * [CI] Auto-commit changed files from 'node scripts/precommit_hook.js --ref HEAD~1..HEAD --fix' * adjust types * add exact typing * [CI] Auto-commit changed files from 'node scripts/precommit_hook.js --ref HEAD~1..HEAD --fix' * adjust test * use exact types * use exact types for editing * adjust types * adjust tests * adjust types * Update x-pack/test/api_integration/apis/uptime/rest/add_monitor.ts * adjust normalizers * Update x-pack/plugins/synthetics/common/runtime_types/monitor_management/monitor_types.ts * Update x-pack/plugins/synthetics/server/routes/monitor_cruds/add_monitor.ts * adjust types * [CI] Auto-commit changed files from 'node scripts/eslint --no-cache --fix' * adjust jest tests * adjust types * adjust api_integration tests * update tests Co-authored-by: kibanamachine <[email protected]> (cherry picked from commit 27916d3) Co-authored-by: Dominique Clarke <[email protected]>

… to the monitor saved object (elastic#140553) * synthetics - enable/disable - prevent incorrect keys from being added to the monitor saved object * [CI] Auto-commit changed files from 'node scripts/precommit_hook.js --ref HEAD~1..HEAD --fix' * adjust types * add exact typing * [CI] Auto-commit changed files from 'node scripts/precommit_hook.js --ref HEAD~1..HEAD --fix' * adjust test * use exact types * use exact types for editing * adjust types * adjust tests * adjust types * Update x-pack/test/api_integration/apis/uptime/rest/add_monitor.ts * adjust normalizers * Update x-pack/plugins/synthetics/common/runtime_types/monitor_management/monitor_types.ts * Update x-pack/plugins/synthetics/server/routes/monitor_cruds/add_monitor.ts * adjust types * [CI] Auto-commit changed files from 'node scripts/eslint --no-cache --fix' * adjust jest tests * adjust types * adjust api_integration tests * update tests Co-authored-by: kibanamachine <[email protected]>

dominiqueclarke and others added 14 commits September 12, 2022 16:00

synthetics - enable/disable - prevent incorrect keys from being added…

72de9c3

… to the monitor saved object

[CI] Auto-commit changed files from 'node scripts/precommit_hook.js -…

3520486

…-ref HEAD~1..HEAD --fix'

Merge branch 'main' of github.com:elastic/kibana into fix/synthetics-…

64a3337

…enable-disable-incorrect-keys

adjust types

8878b8c

Merge branch 'fix/synthetics-enable-disable-incorrect-keys' of https:…

f9aa1df

…//github.com/dominiqueclarke/kibana into fix/synthetics-enable-disable-incorrect-keys

add exact typing

8ecb794

[CI] Auto-commit changed files from 'node scripts/precommit_hook.js -…

6a39211

…-ref HEAD~1..HEAD --fix'

adjust test

a614583

use exact types

aa42c58

Merge branch 'fix/synthetics-enable-disable-incorrect-keys' of https:…

9da887a

…//github.com/dominiqueclarke/kibana into fix/synthetics-enable-disable-incorrect-keys

use exact types for editing

7a9ff1b

adjust types

a840eaa

adjust tests

a3de6fc

adjust types

bebde51

dominiqueclarke commented Sep 25, 2022

View reviewed changes

x-pack/test/api_integration/apis/uptime/rest/add_monitor.ts Outdated Show resolved Hide resolved

dominiqueclarke added 3 commits September 24, 2022 23:08

Update x-pack/test/api_integration/apis/uptime/rest/add_monitor.ts

5795c5e

adjust normalizers

df617c6

Merge branch 'fix/synthetics-enable-disable-incorrect-keys' of https:…

3e84c89

…//github.com/dominiqueclarke/kibana into fix/synthetics-enable-disable-incorrect-keys

dominiqueclarke commented Sep 25, 2022

View reviewed changes

x-pack/plugins/synthetics/common/runtime_types/monitor_management/monitor_types.ts Outdated Show resolved Hide resolved

Update x-pack/plugins/synthetics/common/runtime_types/monitor_managem…

929c451

…ent/monitor_types.ts

dominiqueclarke commented Sep 25, 2022

View reviewed changes

x-pack/plugins/synthetics/server/routes/monitor_cruds/add_monitor.ts Outdated Show resolved Hide resolved

Update x-pack/plugins/synthetics/server/routes/monitor_cruds/add_moni…

ec265de

…tor.ts

dominiqueclarke commented Sep 25, 2022

View reviewed changes

dominiqueclarke added bug Fixes for quality problems that affect the customer experience Team:Uptime - DEPRECATED Synthetics & RUM sub-team of Application Observability release_note:skip Skip the PR/issue when compiling release notes v8.5.0 v8.6.0 labels Sep 25, 2022

dominiqueclarke changed the title ~~synthetics - enable/disable - prevent incorrect keys from being added to the monitor saved object~~ [Synthetics] enable/disable - prevent incorrect keys from being added to the monitor saved object Sep 25, 2022

dominiqueclarke marked this pull request as ready for review September 25, 2022 19:32

dominiqueclarke requested a review from a team as a code owner September 25, 2022 19:32

dominiqueclarke and others added 7 commits September 26, 2022 10:17

adjust types

0e68251

Merge branch 'fix/synthetics-enable-disable-incorrect-keys' of https:…

694c390

…//github.com/dominiqueclarke/kibana into fix/synthetics-enable-disable-incorrect-keys

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

1871790

…-fix'

adjust jest tests

9b3d683

Merge branch 'fix/synthetics-enable-disable-incorrect-keys' of https:…

63d613d

…//github.com/dominiqueclarke/kibana into fix/synthetics-enable-disable-incorrect-keys

adjust types

a5b2f03

adjust api_integration tests

4d4ca60

dominiqueclarke mentioned this pull request Sep 28, 2022

[Synthetics UI] [Overview] Actions #135152

Closed

2 tasks

merge main

3a7d244

dominiqueclarke force-pushed the fix/synthetics-enable-disable-incorrect-keys branch from f9fe54b to 3a7d244 Compare September 29, 2022 12:34

shahzad31 approved these changes Sep 29, 2022

View reviewed changes

update tests

5c43159

dominiqueclarke merged commit 27916d3 into elastic:main Sep 29, 2022

dominiqueclarke deleted the fix/synthetics-enable-disable-incorrect-keys branch September 29, 2022 15:23

kibanamachine mentioned this pull request Sep 29, 2022

[8.5] [Synthetics] enable/disable - prevent incorrect keys from being added to the monitor saved object (#140553) #142238

Merged

dominiqueclarke mentioned this pull request Oct 3, 2022

[Synthetics] preserve id field on monitor attributes #142478

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Synthetics] enable/disable - prevent incorrect keys from being added to the monitor saved object #140553

[Synthetics] enable/disable - prevent incorrect keys from being added to the monitor saved object #140553

dominiqueclarke commented Sep 12, 2022 •

edited by kibanamachine

Loading

dominiqueclarke Sep 25, 2022

elasticmachine commented Sep 25, 2022

dominiqueclarke commented Sep 27, 2022

shahzad31 left a comment

kibana-ci commented Sep 29, 2022

kibanamachine commented Sep 29, 2022

[Synthetics] enable/disable - prevent incorrect keys from being added to the monitor saved object #140553

[Synthetics] enable/disable - prevent incorrect keys from being added to the monitor saved object #140553

Conversation

dominiqueclarke commented Sep 12, 2022 • edited by kibanamachine Loading

Summary

Testing

dominiqueclarke Sep 25, 2022

Choose a reason for hiding this comment

elasticmachine commented Sep 25, 2022

dominiqueclarke commented Sep 27, 2022

shahzad31 left a comment

Choose a reason for hiding this comment

kibana-ci commented Sep 29, 2022

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Async chunks

History

kibanamachine commented Sep 29, 2022

💚 All backports created successfully

Questions ?

dominiqueclarke commented Sep 12, 2022 •

edited by kibanamachine

Loading