[Synthetics] Isolate Add/Edit API routes HTTP interface from SavedObject type

[awahab07]

Resolves #153495

Summary

For monitor crud Add and Edit routes, the PR refactors the API response to isolate the returned data type from SavedObject interface and returns a monitor object instead. The notion of accessing monitor fields via attributes is eliminated from the frontend code and there's no reference to SavedObject anymore under synthetics/public directory.

Testing

Monitor Add/Edit server routes previously were responding the success payload in the form

  {
    "id": "d42afe4e-0f3e-4c3f-b37b-9ecb6a1ab46e",     // (generated) saved object id
    "attributes": {
      "type": "browser",
      ...
      "config_id": "d42afe4e-0f3e-4c3f-b37b-9ecb6a1ab46e",       // (generated) saved object id
      "id": "<custom-heartbeat-id>" // or same as config_id for a UI monitor
      "custom_heartbeat_id": "<custom-heartbeat-id>" // or undefined for a UI monitor
    },
    "created_at": "2023-07-24T16:24:15.697Z",
    "updated_at": "2023-07-24T16:24:15.697Z"
  }

will now response with the following payload format

{
  "type": "browser",
  ...
  "config_id": "d42afe4e-0f3e-4c3f-b37b-9ecb6a1ab46e", // (generated) saved object id
  "id": "<custom-heartbeat-id>" // or same as config_id for a UI monitor
  "custom_heartbeat_id": "<custom-heartbeat-id>" // or undefined for a UI monitor
  "created_at": "2023-07-24T16:24:15.697Z",
  "updated_at": "2023-07-24T16:24:15.697Z"
}

so code paths which might have been relying on the outer id(which they shouldn't regardless and should only rely on monitor[ConfigKey.MONITOR_QUERY_ID] and monitor[ConfigKey.CONFIG_ID]) in the old format including monitor add/update/push, alerts enable/disable, monitor enable/disable, run once and UI routes e.g. monitor details, test run details and step details etc should be smoke tested while also keeping an eye on runtime bugs in kibana and browser console.

[apmmachine]

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

• /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
• run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

[elasticmachine]

Pinging @elastic/uptime (Team:uptime)

[kibana-ci]

💚 Build Succeeded

• Buildkite Build
• Commit: 14996d6

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	912.7KB	912.8KB	+47.0B

Unknown metric groups

References to deprecated APIs

id	before	after	diff
synthetics	31	27	-4

History

• 💔 Build #145555 failed f0ee307
• 💚 Build #145161 succeeded aa70edf
• 💔 Build #145071 failed 31b0c0e
• 💔 Build #145018 failed 9e08a39eba4da9a1aec1840a80363b97813be331
• 💔 Build #144972 failed 1393d6bb21e5d703c807cc00d9f319f7a055f287

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