[maps] fix Maps embeddables in a dashboard not capturing map id in execution context by nreese · Pull Request #153616 · elastic/kibana

nreese · 2023-03-24T00:22:38Z

Existing execution context implementation spread results from executionContextServiceStart().get() to add map id. This implementation did not work when map was embedded in another application. When embedded, executionContextServiceStart().get() returned the id of the parent application and not the id for the map.

This PR resolves the issue by building executionContext directly in MapEmbeddable and MapApp. MapApp uses savedObjectId for executionContext.id. MapEmbeddable uses embeddableId for executionContext.id.

The PR also updates the MVT routes to include executionContextId for the execution context with _mvt calls.

Testing

To view execution context in kibana logs, add below to kibana.dev.yml. For more information https://www.elastic.co/guide/en/kibana/8.7/kibana-troubleshooting-trace-query.html

logging:
  loggers:
    - name: execution_context
      level: debug
      appenders: [console]

Execution context for lens and maps panels in dashboard

There is not a lot of consistency for what type and name should be across Kibana. I found this comment for when lens added execution context for lens embeddable that stated type:feature and name:sub_feature. Therefore, I followed the lens example and made type:maps and name:maps since maps does not have sub_features.

[2023-03-23T18:29:12.750-06:00][DEBUG][execution_context] {"type":"application","name":"dashboards","url":"/mth/app/dashboards","page":"app","id":"d98e6530-c9a8-11ed-9340-d743c2c88db8","child":{"type":"maps","name":"maps","id":"91f17723-367d-460e-ad90-dbac1fc072cb","url":"/map/de71f4f0-1902-11e9-919b-ffe5949a18d2","description":"es_geo_grid_source:cluster"}}
[2023-03-23T18:29:12.750-06:00][DEBUG][execution_context] {"type":"application","name":"dashboards","url":"/mth/app/dashboards","page":"app","id":"d98e6530-c9a8-11ed-9340-d743c2c88db8","child":{"type":"maps","name":"maps","id":"91f17723-367d-460e-ad90-dbac1fc072cb","url":"/map/de71f4f0-1902-11e9-919b-ffe5949a18d2","description":"es_term_source:terms"}}
[2023-03-23T18:29:13.241-06:00][DEBUG][execution_context] {"type":"dashboard","name":"dashboards","url":"/mth/app/dashboards","page":"app","id":"d98e6530-c9a8-11ed-9340-d743c2c88db8","description":"single map","child":{"type":"lens","name":"lnsXY","id":"b9e44118-9e67-4c1c-9159-597d8a9f80d1","description":"lens","url":"/mth/app/lens#/edit/32e87880-c9ab-11ed-9340-d743c2c88db8"}}

Execution context for maps

There is not a lot of consistency across kibana for type and name in applications. ExecutionContextService.getDefaultContext returns the below so I stuck with application for type in client and server for type in server. Here is one more link that provides some context value of name property.

return {
      type: 'application',
      name: this.appId,
      url: window.location.pathname,
    };

[2023-03-23T18:30:39.886-06:00][DEBUG][execution_context] {"type":"application","name":"maps","url":"/mth/app/maps/map/de71f4f0-1902-11e9-919b-ffe5949a18d2","id":"de71f4f0-1902-11e9-919b-ffe5949a18d2","page":"editor","description":"es_geo_grid_source:cluster"}
[2023-03-23T18:30:39.886-06:00][DEBUG][execution_context] {"type":"application","name":"maps","url":"/mth/app/maps/map/de71f4f0-1902-11e9-919b-ffe5949a18d2","id":"de71f4f0-1902-11e9-919b-ffe5949a18d2","page":"editor","description":"es_term_source:terms"}

…ecution context

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

…-fix'

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

nreese · 2023-03-27T14:04:55Z

@elasticmachine merge upstream

kibana-ci · 2023-03-27T15:09:09Z

💚 Build Succeeded

Buildkite Build
Commit: 05f4555

Metrics [docs]

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
`maps`	266	268	+2

Async chunks

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

id	before	after	diff
`maps`	2.7MB	2.7MB	+816.0B

Unknown metric groups

API count

id	before	after	diff
`maps`	267	269	+2

ESLint disabled line counts

id	before	after	diff
`securitySolution`	433	436	+3

Total ESLint disabled count

id	before	after	diff
`securitySolution`	513	516	+3

History

💚 Build #115506 succeeded abf8155
💔 Build #115503 failed da89cf0
💔 Build #115501 failed ad94814
💔 Build #115214 failed fc0ea16
💔 Build #115212 failed 5459c1c

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

elasticmachine · 2023-03-27T21:12:09Z

Pinging @elastic/kibana-presentation (Team:Presentation)

nickpeihl

lgtm! this is great and will make it much easier for users and support to audit and troubleshoot es queries from kibana!

code review and tested logging execution contexts and x-opaque-id headers

nickpeihl · 2023-03-28T17:46:55Z

x-pack/plugins/maps/public/classes/sources/ems_file_source/ems_file_source.tsx

  }

-  async getTooltipProperties(properties: unknown): Promise<ITooltipProperty[]> {
+  async getTooltipProperties(properties: GeoJsonProperties): Promise<ITooltipProperty[]> {


nickpeihl · 2023-03-28T17:53:11Z

x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx

+      params.set('executionContextId', executionContextId);
+    }
+
+    return `${mvtUrlServicePath}?${params.toString()}`;


Nice use of URLSearchParams!

nreese added 5 commits March 23, 2023 14:46

[maps] fix Maps embeddables in a dashboard not capturing map id in ex…

27f84f3

…ecution context

grid source

ac8ff6d

pew pew source

063180e

remove makePublicExecutionContext

f5939e3

use executionContextId in mvt routes

3a1dfe6

nreese mentioned this pull request Mar 24, 2023

[maps] fix Maps embeddables in a dashboard not capturing map id in execution context #153346

Closed

kibanamachine and others added 8 commits March 24, 2023 00:28

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

5459c1c

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

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

fc0ea16

…-fix'

tslint fixes

70d38c2

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

ad94814

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

more tslint fixes

ea7dfb1

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

da89cf0

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

fix jest test

e8b6c05

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

abf8155

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

Merge branch 'main' into issue_153218_2

05f4555

nreese marked this pull request as ready for review March 27, 2023 21:11

nreese requested a review from a team as a code owner March 27, 2023 21:11

nreese added Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas t// release_note:skip Skip the PR/issue when compiling release notes v8.8.0 labels Mar 27, 2023

nreese added the Feature:Maps label Mar 27, 2023

nickpeihl approved these changes Mar 28, 2023

View reviewed changes

nreese merged commit 6907882 into elastic:main Mar 28, 2023

kibanamachine added the backport:skip This PR does not require backporting label Mar 28, 2023

nreese mentioned this pull request Mar 28, 2023

Maps embeddables in a dashboard not capturing map id in execution context #153218

Closed

nreese mentioned this pull request May 9, 2023

[maps] double encoding MVT request body #157219

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[maps] fix Maps embeddables in a dashboard not capturing map id in execution context#153616

[maps] fix Maps embeddables in a dashboard not capturing map id in execution context#153616
nreese merged 14 commits intoelastic:mainfrom
nreese:issue_153218_2

nreese commented Mar 24, 2023 •

edited

Loading

Uh oh!

nreese commented Mar 27, 2023

Uh oh!

kibana-ci commented Mar 27, 2023

API count

ESLint disabled line counts

Total ESLint disabled count

Uh oh!

elasticmachine commented Mar 27, 2023

Uh oh!

nickpeihl left a comment

Uh oh!

nickpeihl Mar 28, 2023

Uh oh!

nickpeihl Mar 28, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

nreese commented Mar 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Testing

Execution context for lens and maps panels in dashboard

Execution context for maps

Uh oh!

nreese commented Mar 27, 2023

Uh oh!

kibana-ci commented Mar 27, 2023

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Async chunks

API count

ESLint disabled line counts

Total ESLint disabled count

History

Uh oh!

elasticmachine commented Mar 27, 2023

Uh oh!

nickpeihl left a comment

Choose a reason for hiding this comment

Uh oh!

nickpeihl Mar 28, 2023

Choose a reason for hiding this comment

Uh oh!

nickpeihl Mar 28, 2023

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

nreese commented Mar 24, 2023 •

edited

Loading