[Uptime] Show experimental locations only when a particular flag is enabled #132063

lucasfcosta · 2022-05-11T19:10:43Z

As a note for people doing post-FF testing in the future: please ensure you test this on different cloud regions so that we ensure staging and QA do show experimental locations but production doesn't.
For that, you can simply serve a manifest.json locally and point the cloud Kibana to it by editing Kibana settings (you'll have to expose it with something like ngrok).

Summary

This PR closes #131585. It allows the UI to hide experimental locations unless the xpack.uptime.service.showExperimentalLocations flag is set to true.

⚠️ Please notice that in order for us to show all locations by default on staging we should set this configuration flag to true on clusters provisioned there.

⚠️ The cloud team will have to update the manifest to set existing locations to GA once this gets merged.

How to test this PR

You must test this PR using a Kibana distributable and running from source so that you can test the NODE_ENV as a developer and as if you were in production, respectively.

Testing in dev mode

Create a manifest.json file with the following contents and place it under a manifests folder:

{
  "throttling": {
    "download": 20,
    "upload": 10
  },
  "locations": {
    "Local Synth Node (GA) [MANIFEST]": {
      "url": "https://localhost:10001",
      "geo": {
        "name": "US East [GA]",
        "location": {"lat": 41.25, "lon": -95.86}
      },
      "status": "ga"
    },
    "Local Synth Node (Experimental) [MANIFEST]": {
      "url": "https://localhost:10001",
      "geo": {
        "name": "US West [EXP]",
        "location": {"lat": 41.25, "lon": -95.86}
      },
      "status": "experimental"
    }
  }
}

Use the http-server package to serve your manifest file.
```
$ npx http-server service_manifest --port 8081
```

Update your Kibana configs so that it fetches the manifest from your local server.

# Make sure to comment the `devUrl` key
# xpack.uptime.service.devUrl: https://localhost:10001
xpack.uptime.service.manifestUrl: http://localhost:8081/manifest.json
xpack.uptime.service.showExperimentalLocations: false

Try to create a new monitor and you should see that all locations appear regardless of showExperimentalLocations being false.

Testing as if it was in `production`

⚠️ This is the most important test to do. It requires you to build a Kibana distributable so that you set process.env.NODE_ENV to production, and thus can properly test Kibana.
For that, you will have to:

Build dist bundles

Run the non-dev version of kibana NODE_ENV=production node --nolazy --inspect scripts/kibana.

Create a manifest.json file with the following contents and place it under a manifests folder:

{
  "throttling": {
    "download": 20,
    "upload": 10
  },
  "locations": {
    "Local Synth Node (GA) [MANIFEST]": {
      "url": "https://localhost:10001",
      "geo": {
        "name": "US East [GA]",
        "location": {"lat": 41.25, "lon": -95.86}
      },
      "status": "ga"
    },
    "Local Synth Node (Experimental) [MANIFEST]": {
      "url": "https://localhost:10001",
      "geo": {
        "name": "US West [EXP]",
        "location": {"lat": 41.25, "lon": -95.86}
      },
      "status": "experimental"
    }
  }
}

Use the http-server package to serve your manifest file.
```
$ npx http-server service_manifest --port 8081
```

Update your Kibana configs so that it fetches the manifest from your local server.

# Make sure to comment the `devUrl` key
# xpack.uptime.service.devUrl: https://localhost:10001
xpack.uptime.service.manifestUrl: http://localhost:8081/manifest.json
xpack.uptime.service.showExperimentalLocations: false

Try to create a new monitor and you should see that only the US East [GA] location appears.
Update the xpack.uptime.service.showExperimentalLocations key to true and ensure that both locations appear and that the experimental location has a Tech Preview badge.

⚠️ The same should happen when editing a monitor.

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)
Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)
If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list

⚠️ I don't believe this is necessary, but I'd appreciate it if reviewers could confirm.
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

For maintainers

This was checked for breaking API changes and was labeled appropriately

Release note

Kibana will only show experimental Synthetic node locations when the xpack.uptime.service.showExperimentalLocations flag is set to true.

elasticmachine · 2022-05-17T09:11:01Z

Pinging @elastic/uptime (Team:uptime)

lucasfcosta · 2022-05-17T09:11:40Z

Considering this PR defaults to not showing experimental locations I think it should be fine to merge this one while we wait for cloud to set the defaults on Staging and QA to true 😄

shahzad31 · 2022-05-19T10:23:09Z

x-pack/plugins/synthetics/server/synthetics_service/get_service_locations.ts

@@ -41,13 +43,22 @@ export async function getServiceLocations(server: UptimeServerSetup) {
      locations: Record<string, ManifestLocation>;
    }>(server.config.service!.manifestUrl!);

-    Object.entries(data.locations).forEach(([locationId, location]) => {
+    const isProd = process.env.NODE_ENV === 'production';


i will recommend using flag that is coming from plugin context to determine if the evn is dev or prod

https://github.com/elastic/kibana/blob/main/x-pack/plugins/synthetics/public/plugin.ts#L213

kibana-ci · 2022-05-23T16:04:21Z

💚 Build Succeeded

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`	792.7KB	793.1KB	+390.0B

History

💚 Build #46794 succeeded 3168d15
💚 Build #46033 succeeded b2d4e05
💔 Build #46021 failed d19720b
💚 Build #44809 succeeded c68a978
💔 Build #44199 failed 264e2dd

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

lucasfcosta · 2022-05-23T16:16:23Z

@shahzad31 this is ready for a re-review. I've also enabled auto-merge given I've already tested it myself and addressed your changes, so it can go in as soon as you approve, thanks a lot 🙌

dominiqueclarke

LGTM

mistic · 2022-05-24T03:01:32Z

@lucasfcosta this PR has made our CI to fail on main. I've opened a PR at #132764 which I think it will make the CI green again

lucasfcosta · 2022-05-24T08:11:35Z

@mistic ah, that's interesting, thanks for that. I wonder whether we should look into the PR checks in that case? I'd have expected the checks to catch that missing type 🤔

mistic · 2022-05-24T12:35:52Z

@lucasfcosta they should catch it, thats correct. In that case I think the problem was that the PR was not completely in sync with the upstream before the merge 😃

lucasfcosta added release_note:enhancement Team:Uptime - DEPRECATED Synthetics & RUM sub-team of Application Observability v8.3.0 labels May 11, 2022

lucasfcosta force-pushed the show-ga-locations-only branch from 264e2dd to c68a978 Compare May 16, 2022 09:31

lucasfcosta marked this pull request as ready for review May 17, 2022 09:10

lucasfcosta requested a review from a team as a code owner May 17, 2022 09:10

lucasfcosta force-pushed the show-ga-locations-only branch 2 times, most recently from d19720b to b2d4e05 Compare May 19, 2022 09:19

shahzad31 reviewed May 19, 2022

View reviewed changes

lucasfcosta force-pushed the show-ga-locations-only branch from b2d4e05 to 3168d15 Compare May 23, 2022 09:22

lucasfcosta added 2 commits May 23, 2022 16:00

[Uptime] Show GA locations only

44b353c

show all locations out of production by default

3b617cf

lucasfcosta force-pushed the show-ga-locations-only branch from 3168d15 to 3b617cf Compare May 23, 2022 15:03

lucasfcosta enabled auto-merge (squash) May 23, 2022 16:15

dominiqueclarke self-requested a review May 23, 2022 19:07

dominiqueclarke approved these changes May 24, 2022

View reviewed changes

lucasfcosta merged commit 83a05ff into elastic:main May 24, 2022

kibanamachine added the backport:skip This commit does not require backporting label May 24, 2022

mistic mentioned this pull request May 24, 2022

fix(NA): include status on syncthetics_store.mock.ts #132764

Merged

lucasfcosta deleted the show-ga-locations-only branch May 24, 2022 15:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Uptime] Show experimental locations only when a particular flag is enabled #132063

[Uptime] Show experimental locations only when a particular flag is enabled #132063

lucasfcosta commented May 11, 2022 •

edited

Loading

elasticmachine commented May 17, 2022

lucasfcosta commented May 17, 2022

shahzad31 May 19, 2022

shahzad31 May 19, 2022

kibana-ci commented May 23, 2022

lucasfcosta commented May 23, 2022

dominiqueclarke left a comment

mistic commented May 24, 2022

lucasfcosta commented May 24, 2022

mistic commented May 24, 2022

[Uptime] Show experimental locations only when a particular flag is enabled #132063

[Uptime] Show experimental locations only when a particular flag is enabled #132063

Conversation

lucasfcosta commented May 11, 2022 • edited Loading

Summary

How to test this PR

Testing in dev mode

Testing as if it was in production

Checklist

For maintainers

Release note

elasticmachine commented May 17, 2022

lucasfcosta commented May 17, 2022

shahzad31 May 19, 2022

Choose a reason for hiding this comment

shahzad31 May 19, 2022

Choose a reason for hiding this comment

kibana-ci commented May 23, 2022

💚 Build Succeeded

Metrics [docs]

Async chunks

History

lucasfcosta commented May 23, 2022

dominiqueclarke left a comment

Choose a reason for hiding this comment

mistic commented May 24, 2022

lucasfcosta commented May 24, 2022

mistic commented May 24, 2022

lucasfcosta commented May 11, 2022 •

edited

Loading

Testing as if it was in `production`