[Status UI] Use the new output format of API `GET /api/status` #107937

afharo · 2021-08-09T17:25:50Z

Summary

Resolves #77624

This PR uses the request GET /api/status?v8format=true to prepare the Status page for the breaking changes in the output of such API coming up for 8.0.0.

No major UI changes are made. The only visible one is that the version detailed as plugin:[email protected] is removed from each plugin name in the list.

I removed it because, IMO, it doesn't add any value, and it wouldn't be accurate for 3rd-party plugins, since we are using Kibana's global version. The current logic has the same issue because GET /api/status injects the version from Kibana as well.

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
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

elasticmachine · 2021-08-10T07:18:23Z

Pinging @elastic/kibana-core (Team:Core)

afharo · 2021-08-10T09:28:59Z

@elasticmachine run elasticsearch-ci/docs

joshdover · 2021-08-10T15:55:56Z

src/core/types/status.ts

+    core: Record<string, ServerStatus>;
+    plugins: Record<string, ServerStatus>;


This StatusResponse type isn't currently being shared across server and public, though we may not really be able to share it properly until we've removed the legacy type.

core/public is using this type, while core/server is using this unexported type:

kibana/src/core/server/status/routes/status.ts

Line 44 in 328c36d

interface StatusHttpBody {

If it's not possible to align these two to use the same type, can we leave a TODO to do this as part of #94419 or in code?

joshdover · 2021-08-10T16:35:42Z

src/core/public/core_app/status/lib/load_status.ts

-    serverState: formatStatus(response.status.overall).state,
+    statuses: [
+      ...Object.entries(response.status.core).map(([serviceName, status]) =>
+        formatStatus(`core:${serviceName}@${response.version.number}`, status)


IMO we should remove the version number from the core services as well. I think it's confusing and unnecessary.

joshdover · 2021-08-10T16:36:23Z

src/core/public/core_app/status/lib/load_status.ts

@@ -7,8 +7,9 @@
 */

 import { i18n } from '@kbn/i18n';
+import { deepFreeze } from '@kbn/std';


IMO, if this is increasing the core bundle size, it's likely not worth it.

joshdover

Meant to approve, no reason to block this merge.

- Use common types on the server and public - Remove `deepFreeze` - Remove version from core services

afharo · 2021-08-11T09:30:56Z

src/core/types/status.ts

+  build_number: number;
+  build_snapshot: boolean;


The moment we linked the types, this screamed as wrong 👌

afharo · 2021-08-11T09:34:02Z

src/core/types/status.ts

+ * We need this type to convert the object `ServiceStatusLevel` to a union of the possible strings.
+ * This is because of the "stringification" that occurs when serving HTTP requests.
+ */
+export type ServiceStatusLevel = ReturnType<ServiceStatusLevelFromServer['toString']>;


This is the biggest change when linking both types: the HTTP response calls the method toString(). So the types are not exactly the same.

kibanamachine · 2021-08-11T11:49:55Z

💚 Build Succeeded

Metrics [docs]

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`core`	423.4KB	424.2KB	+827.0B

History

💚 Build #143860 succeeded 6c0cc4da4ac1ef59a9d878a416cc4cee9a4c4254
💔 Build #143804 failed d2ab67e4d9f235ed0d8a5da6088adc36c6857c5b

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

kibanamachine · 2021-08-11T15:59:12Z

💔 Backport failed

Status	Branch	Result
❌	7.x	Commit could not be cherrypicked due to conflicts

To backport manually run:
node scripts/backport --pr 107937

afharo · 2021-08-11T16:10:46Z

7.x backport PR: #108227

…) (#108227) # Conflicts: # packages/kbn-optimizer/limits.yml

afharo added Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc v8.0.0 release_note:skip Skip the PR/issue when compiling release notes v7.15.0 labels Aug 9, 2021

afharo marked this pull request as ready for review August 10, 2021 07:18

afharo requested review from a team as code owners August 10, 2021 07:18

joshdover reviewed Aug 10, 2021

View reviewed changes

joshdover approved these changes Aug 10, 2021

View reviewed changes

afharo added 2 commits August 11, 2021 10:20

[Status UI] Use the new output format of API GET /api/status

1680713

Bump core limit

c72cdc1

afharo force-pushed the status-page/use-new-api-format branch from 6c0cc4d to 3bf1714 Compare August 11, 2021 09:25

Feedback changes:

245943c

- Use common types on the server and public - Remove `deepFreeze` - Remove version from core services

afharo force-pushed the status-page/use-new-api-format branch from 3bf1714 to 245943c Compare August 11, 2021 09:29

afharo commented Aug 11, 2021

View reviewed changes

joshdover approved these changes Aug 11, 2021

View reviewed changes

jbudz approved these changes Aug 11, 2021

View reviewed changes

afharo added the auto-backport Deprecated - use backport:version if exact versions are needed label Aug 11, 2021

afharo merged commit def97bd into elastic:master Aug 11, 2021

afharo deleted the status-page/use-new-api-format branch August 11, 2021 15:56

afharo mentioned this pull request Aug 11, 2021

[7.x] [Status UI] Use the new output format of API GET /api/status (#107937) #108227

Merged

afharo added a commit that referenced this pull request Aug 11, 2021

[Status UI] Use the new output format of API GET /api/status (#107937…

eb3e7d9

…) (#108227) # Conflicts: # packages/kbn-optimizer/limits.yml

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Status UI] Use the new output format of API `GET /api/status` #107937

[Status UI] Use the new output format of API `GET /api/status` #107937

afharo commented Aug 9, 2021 •

edited

Loading

elasticmachine commented Aug 10, 2021

afharo commented Aug 10, 2021

joshdover Aug 10, 2021

joshdover Aug 10, 2021

joshdover Aug 10, 2021

joshdover left a comment

afharo Aug 11, 2021

afharo Aug 11, 2021

kibanamachine commented Aug 11, 2021

kibanamachine commented Aug 11, 2021

afharo commented Aug 11, 2021

		core: Record<string, ServerStatus>;
		plugins: Record<string, ServerStatus>;

[Status UI] Use the new output format of API GET /api/status #107937

[Status UI] Use the new output format of API GET /api/status #107937

Conversation

afharo commented Aug 9, 2021 • edited Loading

Summary

Checklist

For maintainers

elasticmachine commented Aug 10, 2021

afharo commented Aug 10, 2021

joshdover Aug 10, 2021

Choose a reason for hiding this comment

joshdover Aug 10, 2021

Choose a reason for hiding this comment

joshdover Aug 10, 2021

Choose a reason for hiding this comment

joshdover left a comment

Choose a reason for hiding this comment

afharo Aug 11, 2021

Choose a reason for hiding this comment

afharo Aug 11, 2021

Choose a reason for hiding this comment

kibanamachine commented Aug 11, 2021

💚 Build Succeeded

Metrics [docs]

Page load bundle

History

kibanamachine commented Aug 11, 2021

💔 Backport failed

afharo commented Aug 11, 2021

[Status UI] Use the new output format of API `GET /api/status` #107937

[Status UI] Use the new output format of API `GET /api/status` #107937

afharo commented Aug 9, 2021 •

edited

Loading