Expose decoded cloudId components from the cloud plugin's contract #159442

pgayvallet · 2023-06-12T07:30:51Z

Summary

Fix #138813

decode the cloudId and expose the id components from the cloud plugin's browser and server-side contracts
remove the existing decodeCloudId helpers from the other plugins
adapt the usages accordingly

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

…fix'

pgayvallet

self-review

pgayvallet · 2023-06-12T08:38:31Z

x-pack/plugins/cloud/common/decode_cloud_id.ts

-      kibanaUrl: string;
-    }
-  | undefined {
+export function decodeCloudId(cid: string): DecodedCloudId | undefined {


Moved, pretty much without any modifications, to the cloud plugin. Tell me if you think anything within the method should be changed.

Can't add a comment in that line. Should we use a different logger to replace all console.debug entries?

Oh right, we have the client-side loggers now! will do.

pgayvallet · 2023-06-12T08:39:26Z

x-pack/plugins/cloud/public/types.ts

+export interface CloudStart {
+  /**
+   * A React component that provides a pre-wired `React.Context` which connects components to Cloud services.
+   */
+  CloudContextProvider: FC<{}>;


Took this opportunity to move the browser-side contracts to a dedicated file, given they started to become quite big.

pgayvallet · 2023-06-12T08:40:08Z

x-pack/plugins/cloud/public/types.ts

+  /**
+   * The full URL to the elasticsearch cluster.
+   */
+  elasticsearchUrl?: string;
+  /**
+   * The full URL to the Kibana deployment.
+   */
+  kibanaUrl?: string;
+  /**
+   * {host} from the deployment url https://<deploymentId>.<application>.<host><?:port>
+   */
+  cloudHost?: string;
+  /**
+   * {port} from the deployment url https://<deploymentId>.<application>.<host><?:port>
+   */
+  cloudDefaultPort?: string;


Naming is hard. I went with those, but I'm open to better suggestions (or better TSDoc)

pgayvallet · 2023-06-12T08:48:00Z

x-pack/plugins/cloud/public/plugin.tsx

    return {
      cloudId: id,
+      deploymentId: parseDeploymentIdFromDeploymentUrl(this.config.deployment_url),


Added the deploymentId (which was only exposed on the server-side contract) while I was at it, given some plugins recoded their helper to access it.

juliaElastic

Fleet LGTM

…loud-id

elasticmachine · 2023-06-12T12:40:25Z

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

pgayvallet · 2023-06-12T12:40:45Z

Moving into review as the current failures are unrelated to the PR's changes

shahzad31

Synthetics changes LGTM !!

elasticmachine · 2023-06-12T12:44:32Z

Pinging @elastic/fleet (Team:Fleet)

elasticmachine · 2023-06-12T12:44:32Z

Pinging @elastic/uptime (Team:uptime)

…loud-id

ogupte

Observability onboarding changes LGTM. Thank you for this, it's so much better!

lukeelmers · 2023-06-12T23:14:48Z

x-pack/plugins/cloud/public/types.ts

+   * The full URL to the Kibana deployment.
+   */
+  kibanaUrl?: string;


Just out of curiosity, is there a difference between this and server.publicBaseUrl? (Other than the fact that this will only be available in a cloud environment?)

There is. server.publicBaseUrl is an arbitrary URL eventually set by the user, that is supposed to reflect the "public" way of accessing Kibana.

The url decrypted from the cloudId is

only available on cloud (obviously)

reflecting the "internal" way of accessing the deployment.

…loud-id

…fix'

kibana-ci · 2023-06-13T08:58:32Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: a5c8579

Failed CI Steps

Test Failures

[job] [logs] Fleet Cypress Tests / View agents list Bulk actions should allow to bulk upgrade agents and cancel that upgrade

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`cloud`	9	10	+1
`enterpriseSearch`	2103	2102	-1
`fleet`	814	813	-1
`serverlessSearch`	85	84	-1
total			-2

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`fleet`	1068	1066	-2

Async chunks

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

id	before	after	diff
`enterpriseSearch`	2.4MB	2.4MB	-2.5KB
`fleet`	970.2KB	970.2KB	-2.0B
`serverlessSearch`	52.6KB	51.9KB	-784.0B
total			-3.3KB

Page load bundle

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

id	before	after	diff
`cloud`	3.6KB	4.6KB	+1.0KB
`fleet`	131.6KB	130.9KB	-728.0B
total			+317.0B

Unknown metric groups

API count

id	before	after	diff
`cloud`	41	52	+11
`fleet`	1184	1182	-2
total			+9

ESLint disabled line counts

id	before	after	diff
`enterpriseSearch`	19	18	-1
`fleet`	49	46	-3
`securitySolution`	410	414	+4
`serverlessSearch`	7	4	-3
total			-3

Total ESLint disabled count

id	before	after	diff
`enterpriseSearch`	20	19	-1
`fleet`	59	56	-3
`securitySolution`	491	495	+4
`serverlessSearch`	7	4	-3
total			-3

History

💔 Build #134623 failed df14feb
💛 Build #134337 was flaky cdb183f
💔 Build #134314 failed b38b74f
💔 Build #134282 failed fdc5d6c
💔 Build #134240 failed 2485859

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

* main: (199 commits) [Lens] Add custom formatter within the Lens editor (elastic#158468) [Uptime] Hide app if no data is available (elastic#159118) [CodeEditor] Add grok highlighting (elastic#159334) Expose decoded cloudId components from the cloud plugin's contract (elastic#159442) [Profiling] Use collector and symbolizer integrations in the add data page (elastic#159481) [Infrastructure UI] Hosts View: Unified Search bar with auto-refresh enabled (elastic#157011) [APM] Add feature flag for not available apm schema (elastic#158911) [Lens] Remove deprecated componentWillReceiveProps usage (elastic#159502) [api-docs] 2023-06-13 Daily api_docs build (elastic#159536) [data views] Use versioned router for REST routes (elastic#158608) [maps] fix geo line source not loaded unless maps application is opened (elastic#159432) [Enterprise Search][Search application]Fix Create Api key url (elastic#159519) [Security Solution] Increase timeout for indexing hosts (elastic#159518) dashboard Reset button disable (elastic#159430) [Security Solution] Unskip Endpoint API tests after package fix (elastic#159484) [Synthetics] adjust alert timing (elastic#159511) [ResponseOps][rule registry] Remove usages of `refresh: true` (elastic#159252) Revert "Remove unused package (elastic#158597)" [Serverless] Adding config to disable authentication on task manager background worker utilization API (elastic#159505) Remove unused package (elastic#158597) ...

…lastic#159442) ## Summary Fix elastic#138813 - decode the cloudId and expose the id components from the `cloud` plugin's browser and server-side contracts - remove the existing `decodeCloudId` helpers from the other plugins - adapt the usages accordingly --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

## Summary #159442 updated the decoding of the cloud id and added `elasticsearchUrl` & `kibanaUrl` to the `CloudStart` type, but it only set them on the `CloudSetup` result. This change will also add them to the `CloudStart` so they are available to code that is trying to read the values from `CloudStart` , mainly [serverless_search](https://github.com/elastic/kibana/blob/main/x-pack/plugins/serverless_search/public/application/components/overview.tsx#L49-L51) is what I'm concerned with.

pgayvallet added 3 commits June 12, 2023 08:58

add urls to cloud browser contracts

dc08921

adapt fleet usages

607fb45

adapt other usages

80934be

pgayvallet added v8.9.0 Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc release_note:skip Skip the PR/issue when compiling release notes labels Jun 12, 2023

kibanamachine and others added 7 commits June 12, 2023 07:35

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

d08de8c

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

[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…

6e23426

…fix'

adapt unit tests

65057b9

add deploymentId to public contract

f2b91d5

update the mocks

e0dc1cc

add unit tests for plugin

296beda

remove from start contract given unused for now

2485859

pgayvallet commented Jun 12, 2023

View reviewed changes

juliaElastic approved these changes Jun 12, 2023

View reviewed changes

pgayvallet added 3 commits June 12, 2023 12:45

Merge remote-tracking branch 'upstream/main' into kbn-138813-decode-c…

093ea96

…loud-id

fix snapshot

fdc5d6c

Merge remote-tracking branch 'upstream/main' into kbn-138813-decode-c…

b38b74f

…loud-id

pgayvallet marked this pull request as ready for review June 12, 2023 12:40

pgayvallet requested review from a team as code owners June 12, 2023 12:40

shahzad31 approved these changes Jun 12, 2023

View reviewed changes

botelastic bot added Team:Fleet Team label for Observability Data Collection Fleet team Team:Uptime - DEPRECATED Synthetics & RUM sub-team of Application Observability labels Jun 12, 2023

juliaElastic approved these changes Jun 12, 2023

View reviewed changes

Merge remote-tracking branch 'upstream/main' into kbn-138813-decode-c…

cdb183f

…loud-id

sphilipse approved these changes Jun 12, 2023

View reviewed changes

Bamieh approved these changes Jun 12, 2023

View reviewed changes

ogupte approved these changes Jun 12, 2023

View reviewed changes

lukeelmers reviewed Jun 12, 2023

View reviewed changes

pgayvallet added 2 commits June 13, 2023 08:50

use real logger

e8e2e1b

Merge remote-tracking branch 'upstream/main' into kbn-138813-decode-c…

772b6b8

…loud-id

pgayvallet enabled auto-merge (squash) June 13, 2023 06:50

kibanamachine and others added 2 commits June 13, 2023 06:55

[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…

df14feb

…fix'

also adapt server-side call

a5c8579

pgayvallet merged commit 2b42341 into elastic:main Jun 13, 2023
20 checks passed

kibanamachine added the backport:skip This commit does not require backporting label Jun 13, 2023

TattdCodeMonkey mentioned this pull request Jul 11, 2023

fix: return decoded urls on CloudStart as well as CloudSetup #161711

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Expose decoded cloudId components from the cloud plugin's contract #159442

Expose decoded cloudId components from the cloud plugin's contract #159442

pgayvallet commented Jun 12, 2023 •

edited

pgayvallet left a comment

pgayvallet Jun 12, 2023

afharo Jun 12, 2023

pgayvallet Jun 13, 2023

pgayvallet Jun 12, 2023

pgayvallet Jun 12, 2023

pgayvallet Jun 12, 2023

juliaElastic left a comment

elasticmachine commented Jun 12, 2023

pgayvallet commented Jun 12, 2023

shahzad31 left a comment

elasticmachine commented Jun 12, 2023

elasticmachine commented Jun 12, 2023

ogupte left a comment

lukeelmers Jun 12, 2023

pgayvallet Jun 13, 2023

kibana-ci commented Jun 13, 2023

API count

ESLint disabled line counts

Total ESLint disabled count

Expose decoded cloudId components from the cloud plugin's contract #159442

Expose decoded cloudId components from the cloud plugin's contract #159442

Conversation

pgayvallet commented Jun 12, 2023 • edited

Summary

pgayvallet left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

juliaElastic left a comment

Choose a reason for hiding this comment

elasticmachine commented Jun 12, 2023

pgayvallet commented Jun 12, 2023

shahzad31 left a comment

Choose a reason for hiding this comment

elasticmachine commented Jun 12, 2023

elasticmachine commented Jun 12, 2023

ogupte left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kibana-ci commented Jun 13, 2023

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Page load bundle

API count

ESLint disabled line counts

Total ESLint disabled count

History

pgayvallet commented Jun 12, 2023 •

edited