[Maps] Ensure draw tools updates by index name, not index pattern title #108394

kindsun · 2021-08-12T16:00:12Z

Draw tools currently validates index patterns that match a single index. This works fine when both the index and pattern have the same name, but since we were passing the index pattern name rather than the index name for writes, we run into errors when the index pattern has a different name than the index. Like test* for the pattern vs. testdraw for the index. This ensures all 1:1 matches between index patterns and associated indexes are correctly validated and the index name is used for udpates.

Also fixed:

Inconsistent route shape. For consistency with our other endpoints and appearance, it makes more sense to make a call to /api/maps/getMatchingIndexes?indexPattern=test* vs. /api/maps/getMatchingIndexes/test*
Fixed route return type on ES 404. An ES 404 resp means there were no matching indexes for the pattern supplied. This should result in a valid response from this endpoint and should return an empty array
Misc. type updates

…dex-pattern-index-mismatch

… index call for separate call

elasticmachine · 2021-08-17T22:28:36Z

Pinging @elastic/kibana-gis (Team:Geo)

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

nreese · 2021-08-18T13:54:14Z

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

+    const {
+      payload: { matchingIndexes },
+    } = await getMatchingIndexes(this.indexPattern.title);
+    return matchingIndexes;


You need to handle the case where matchingIndexes is undefined and return empty array in that case. This can be handled here or in getMatchingIndexes. Maybe it would be better if handled in getMatchingIndexes and getMatchingIndexes could just return an string[] and better encapsulate the API response.

To be consistent with how we're handling other endpoints, I've made it conditional on whether the call was successful or not. Successful calls to the endpoint always return an array. Unsuccessful calls don't which we now handle here by detecting and returning an empty array from the function.

…nctions

…dex-pattern-index-mismatch

x-pack/plugins/maps/server/data_indexing/get_indexes_matching_pattern.ts

kindsun · 2021-08-20T17:25:11Z

@elasticmachine merge upstream

…dex-pattern-index-mismatch

nreese

@gchaps Would you mind reviewing the copy?

x-pack/plugins/maps/public/actions/map_actions.ts

…dex-pattern-index-mismatch

nreese · 2021-08-30T16:44:38Z

x-pack/plugins/maps/server/data_indexing/get_indexes_matching_pattern.ts

+    if (errorStatusCode === 404) {
+      return response.ok({ body: { success: true, matchingIndexes: [] } });
+    } else {
+      logger.error(error);


Do we want to surface this Error in the Kibana logs? I think since the errors are handled by the UI and messages are displayed to the user, we should not surface these errors in the kibana logs. Thoughts?

It's consistent with the handling for our other feature editing endpoints (see here and here for example). I think there's some future work in here around possibly creating a wrapper function for endpoints where we decide if there's some standard or conditional handling we want to apply to all endpoints (error catching, logging, etc.). Since this is a bug fix, I'm mostly just trying to match existing patterns and not rock the boat too much.

nreese

LGTM
code review

x-pack/plugins/maps/public/actions/map_actions.ts

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

gchaps

Text LGTM

kibanamachine · 2021-08-31T01:24:57Z

💚 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
`maps`	3.1MB	3.1MB	+1.0KB

History

💚 Build #149519 succeeded 87372c4
💚 Build #148312 succeeded 7dbc9b8
💚 Build #147441 succeeded 1a60707
💔 Build #147419 failed 8cdd845
💔 Build #147406 failed 5da7a47

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

…le (elastic#108394)

…le (elastic#108394) # Conflicts: # x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx

…le (#108394) (#110649) # Conflicts: # x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx

…le (#108394) (#110644)

…le (#108394) (#110643) Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

Match index and index pattern to validate for drawing

9809ae8

kindsun added [Deprecated-Use Team:Presentation]Team:Geo Former Team Label for Geo Team. Now use Team:Presentation v7.15.0 v7.14.1 labels Aug 12, 2021

Aaron Caldwell added 4 commits August 17, 2021 09:43

Merge remote-tracking branch 'upstream/master' into fix-draw-tools-in…

05a1c76

…dex-pattern-index-mismatch

Merge remote-tracking branch 'upstream/master' into fix-draw-tools-in…

b1100e2

…dex-pattern-index-mismatch

Clean up server route. Return empty array if no es results. Split out…

449552d

… index call for separate call

Get associated index for delete ops

20a6ee3

kindsun marked this pull request as ready for review August 17, 2021 22:28

kindsun requested a review from a team as a code owner August 17, 2021 22:28

kindsun requested review from thomasneirynck and nreese August 17, 2021 22:28

kindsun added v8.0.0 release_note:fix labels Aug 17, 2021

kindsun changed the title ~~[Maps] Fix issue where draw tools tries to write to index pattern name that doesn't match index name~~ [Maps] Ensure draw tools updates by index name, not index pattern title Aug 17, 2021

nreese reviewed Aug 18, 2021

View reviewed changes

Aaron Caldwell added 4 commits August 18, 2021 09:58

Handle unsuccessful call. Remove extra response wrap

bd13e49

Review feedback. Remove unneeded type declarations and placeholder fu…

b086b14

…nctions

Fix api integration test

eec4ef9

Merge remote-tracking branch 'upstream/master' into fix-draw-tools-in…

5fd3897

…dex-pattern-index-mismatch

kindsun requested a review from nreese August 18, 2021 16:57

mistic added v7.16.0 and removed v7.15.0 labels Aug 18, 2021

nreese added the v7.15.0 label Aug 18, 2021

nreese reviewed Aug 18, 2021

View reviewed changes

x-pack/plugins/maps/server/data_indexing/get_indexes_matching_pattern.ts Outdated Show resolved Hide resolved

Aaron Caldwell added 2 commits August 18, 2021 14:38

Surround request w/ try catch to cover 500 errors and fix test

68a27f8

Review feedback. Add handling for unauthorized and forbidden access

eb8e19b

kindsun requested a review from nreese August 18, 2021 20:44

nreese reviewed Aug 18, 2021

View reviewed changes

x-pack/plugins/maps/server/data_indexing/get_indexes_matching_pattern.ts Outdated Show resolved Hide resolved

i18n fix

8cdd845

Aaron Caldwell added 2 commits August 24, 2021 08:52

Merge remote-tracking branch 'upstream/master' into fix-draw-tools-in…

dcec3e8

…dex-pattern-index-mismatch

Move toasts to map actions

7dbc9b8

kindsun force-pushed the fix-draw-tools-index-pattern-index-mismatch branch from 1a60707 to 7dbc9b8 Compare August 24, 2021 19:23

kindsun requested a review from nreese August 26, 2021 16:04

nreese reviewed Aug 26, 2021

View reviewed changes

x-pack/plugins/maps/public/actions/map_actions.ts Outdated Show resolved Hide resolved

x-pack/plugins/maps/public/actions/map_actions.ts Outdated Show resolved Hide resolved

Aaron Caldwell added 2 commits August 30, 2021 09:13

Merge remote-tracking branch 'upstream/master' into fix-draw-tools-in…

83e3a4b

…dex-pattern-index-mismatch

Review feedback. Make error messages less specific

87372c4

kindsun requested a review from nreese August 30, 2021 16:34

nreese reviewed Aug 30, 2021

View reviewed changes

nreese approved these changes Aug 30, 2021

View reviewed changes

thomasneirynck added v7.14.2 and removed v7.14.1 labels Aug 30, 2021

gchaps reviewed Aug 30, 2021

View reviewed changes

Review feedback. Update error wording

569cb1e

kindsun requested a review from gchaps August 30, 2021 23:10

gchaps approved these changes Aug 30, 2021

View reviewed changes

kindsun merged commit 10185fe into elastic:master Aug 31, 2021

kindsun deleted the fix-draw-tools-index-pattern-index-mismatch branch August 31, 2021 14:49

kindsun mentioned this pull request Aug 31, 2021

[7.x] [Maps] Ensure draw tools updates by index name, not index pattern title (#108394) #110643

Merged

kindsun pushed a commit to kindsun/kibana that referenced this pull request Aug 31, 2021

[Maps] Ensure draw tools updates by index name, not index pattern tit…

db8ba95

…le (elastic#108394)

kindsun mentioned this pull request Aug 31, 2021

[7.15] [Maps] Ensure draw tools updates by index name, not index pattern title (#108394) #110644

Merged

kindsun pushed a commit to kindsun/kibana that referenced this pull request Aug 31, 2021

[Maps] Ensure draw tools updates by index name, not index pattern tit…

57b9ffa

…le (elastic#108394)

kindsun mentioned this pull request Aug 31, 2021

[7.14] [Maps] Ensure draw tools updates by index name, not index pattern title (#108394) #110649

Merged

kindsun pushed a commit to kindsun/kibana that referenced this pull request Aug 31, 2021

[Maps] Ensure draw tools updates by index name, not index pattern tit…

e03ae7a

…le (elastic#108394) # Conflicts: # x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx

kindsun pushed a commit that referenced this pull request Aug 31, 2021

[Maps] Ensure draw tools updates by index name, not index pattern tit…

8351a81

…le (#108394) (#110649) # Conflicts: # x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx

kindsun pushed a commit that referenced this pull request Aug 31, 2021

[Maps] Ensure draw tools updates by index name, not index pattern tit…

b45110a

…le (#108394) (#110644)

kindsun pushed a commit that referenced this pull request Aug 31, 2021

[Maps] Ensure draw tools updates by index name, not index pattern tit…

2c5613b

…le (#108394) (#110643) Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Maps] Ensure draw tools updates by index name, not index pattern title #108394

[Maps] Ensure draw tools updates by index name, not index pattern title #108394

kindsun commented Aug 12, 2021 •

edited

elasticmachine commented Aug 17, 2021

nreese Aug 18, 2021

kindsun Aug 18, 2021

kindsun commented Aug 20, 2021

nreese left a comment

nreese Aug 30, 2021

kindsun Aug 30, 2021 •

edited

nreese left a comment

gchaps left a comment

kibanamachine commented Aug 31, 2021

[Maps] Ensure draw tools updates by index name, not index pattern title #108394

[Maps] Ensure draw tools updates by index name, not index pattern title #108394

Conversation

kindsun commented Aug 12, 2021 • edited

elasticmachine commented Aug 17, 2021

nreese Aug 18, 2021

Choose a reason for hiding this comment

kindsun Aug 18, 2021

Choose a reason for hiding this comment

kindsun commented Aug 20, 2021

nreese left a comment

Choose a reason for hiding this comment

nreese Aug 30, 2021

Choose a reason for hiding this comment

kindsun Aug 30, 2021 • edited

Choose a reason for hiding this comment

nreese left a comment

Choose a reason for hiding this comment

gchaps left a comment

Choose a reason for hiding this comment

kibanamachine commented Aug 31, 2021

💚 Build Succeeded

Metrics [docs]

Async chunks

History

kindsun commented Aug 12, 2021 •

edited

kindsun Aug 30, 2021 •

edited