Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Maps] Fix issue preventing TMS from rendering correctly #71946

Merged
merged 4 commits into from
Jul 16, 2020
Merged

[Maps] Fix issue preventing TMS from rendering correctly #71946

merged 4 commits into from
Jul 16, 2020

Conversation

kindsun
Copy link
Contributor

@kindsun kindsun commented Jul 15, 2020

Resolves #68818. The map_selectors > getMapColors selector creates a new array on each call which unnecessarily triggers downstream re-renders as each new array is interpreted as a props change in consuming components. This caused the flyout_body component to repeatedly attempt to render when passed a new empty array for map_colors.

The getMapsSelector selector has been modified to update the same variable across multiple calls so that the reference is preserved and there are no downstream effects on rendering.

@kindsun kindsun added [Deprecated-Use Team:Presentation]Team:Geo Former Team Label for Geo Team. Now use Team:Presentation v8.0.0 v7.9.0 labels Jul 15, 2020
@kindsun kindsun requested a review from a team as a code owner July 15, 2020 20:08
@elasticmachine
Copy link
Contributor

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

nreese
nreese reviewed Jul 15, 2020
View reviewed changes
Copy link
Contributor

@nreese nreese left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't reselect already take care of this? createSelector will return a memoized value unless getLayerListRaw's inputs change.

Where was the re-render spinning out of control?

kindsun
kindsun commented Jul 16, 2020
View reviewed changes
x-pack/plugins/maps/public/classes/sources/kibana_tilemap_source/create_source_editor.js
if (tilemap.url) {
onSourceConfigChange();
}
// eslint-disable-next-line react-hooks/exhaustive-deps
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Passing an empty array to useEffect has the effect of only executing once on mount like componentDidMount for functional components. It's the generally accepted stand-in for componentDidMount but still triggers the linter

@kindsun kindsun added the release_note:skip Skip the PR/issue when compiling release notes label Jul 16, 2020
@kindsun
Copy link
Contributor Author

kindsun commented Jul 16, 2020

Revised following offline conversation with @nreese (thanks!). There was an upstream issue causing layerList to continually get updated resulting in downstream effects in the selector getMapColors. Latest fix targets the layerList issue directly

nreese
nreese approved these changes Jul 16, 2020
View reviewed changes
Copy link
Contributor

@nreese nreese left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - thanks for fixing this.
code review

@kindsun
Copy link
Contributor Author

kindsun commented Jul 16, 2020

@elasticmachine merge upstream

@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Build metrics

async chunks size

id value diff baseline
maps 3.8MB +85.0B 3.8MB

History

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

@kindsun kindsun merged commit 63e6666 into elastic:master Jul 16, 2020
@kindsun kindsun mentioned this pull request Jul 16, 2020
Merged
gmmorris added a commit to gmmorris/kibana that referenced this pull request Jul 17, 2020
@gmmorris
Merge branch 'master' into task-manager/batch-update-delete
edb3f1e 
* master: (214 commits)
  replacing hard coded links for ela.st (elastic#72240)
  skip flaky suite (elastic#60865)
  chore(NA): teardown dynamic dll plugin (elastic#72096)
  Register navLink actions for declared applications (elastic#72109)
  Fix value for process.hash.sha256 draggable (elastic#72142)
  Call setupIngest before fleet_install tests (elastic#72214)
  [Security Solution][Detections] Better toast errors (elastic#72205)
  skip flaky suite (elastic#64696)
  [Security Solution][Detections] Disable exceptions for Threshold and ML rules (elastic#72137)
  [Security Solution][Detections,Lists] Miscellaneous post-FF fixes (elastic#71990)
  [baseline/capture] use high-memory nodes with ramDisks (elastic#71894)
  skip flaky suite (elastic#77207)
  [Maps] Fix issue preventing TMS from rendering correctly (elastic#71946)
  using test_user with minimum privs (elastic#71988)
  Fixed Webhook connector doesn't retain added HTTP header settings (elastic#71924)
  [Ingest Manager] Do not show enrolling and unenrolling agents as online in agent counters (elastic#71921)
  [Maps] fix 'New Map' from getting added to recently accessed (elastic#72125)
  [Visualizations] Pass 'aggs' parameter to custom request handlers (elastic#71423)
  [Monitoring] Out of the box alert tweaks (elastic#71942)
  [ML] Fix datafeed start time is incorrect when the job has trailing empty buckets (elastic#71976)
  ...
gmmorris added a commit to gmmorris/kibana that referenced this pull request Jul 17, 2020
@gmmorris
Merge branch 'master' into alerting/consumer-based-rbac
cbee849 
* master: (55 commits)
  updates 'External alerts' tab text (elastic#72237)
  [Security Solution][Case] Fix connector's dropdown with conflicting requests (elastic#72037)
  replacing hard coded links for ela.st (elastic#72240)
  skip flaky suite (elastic#60865)
  chore(NA): teardown dynamic dll plugin (elastic#72096)
  Register navLink actions for declared applications (elastic#72109)
  Fix value for process.hash.sha256 draggable (elastic#72142)
  Call setupIngest before fleet_install tests (elastic#72214)
  [Security Solution][Detections] Better toast errors (elastic#72205)
  skip flaky suite (elastic#64696)
  [Security Solution][Detections] Disable exceptions for Threshold and ML rules (elastic#72137)
  [Security Solution][Detections,Lists] Miscellaneous post-FF fixes (elastic#71990)
  [baseline/capture] use high-memory nodes with ramDisks (elastic#71894)
  skip flaky suite (elastic#77207)
  [Maps] Fix issue preventing TMS from rendering correctly (elastic#71946)
  using test_user with minimum privs (elastic#71988)
  Fixed Webhook connector doesn't retain added HTTP header settings (elastic#71924)
  [Ingest Manager] Do not show enrolling and unenrolling agents as online in agent counters (elastic#71921)
  [Maps] fix 'New Map' from getting added to recently accessed (elastic#72125)
  [Visualizations] Pass 'aggs' parameter to custom request handlers (elastic#71423)
  ...
kindsun pushed a commit that referenced this pull request Jul 17, 2020
@elasticmachine
[Maps] Fix issue preventing TMS from rendering correctly (#71946) (#7…
6a6c7db 
…2203)

* Ensure getColors selector modifies and returns the same object

* Call onSourceConfigChange on CreateSourceEditor mount

* Back out selector update

Co-authored-by: Elastic Machine <[email protected]>

Co-authored-by: Elastic Machine <[email protected]>
gmmorris added a commit to gmmorris/kibana that referenced this pull request Jul 17, 2020
@gmmorris
Merge branch 'alerting/consumer-based-rbac' into alerting/management-…
fead80a 
…feature-privileges

* alerting/consumer-based-rbac: (56 commits)
  take into account which features available in the active space
  updates 'External alerts' tab text (elastic#72237)
  [Security Solution][Case] Fix connector's dropdown with conflicting requests (elastic#72037)
  replacing hard coded links for ela.st (elastic#72240)
  skip flaky suite (elastic#60865)
  chore(NA): teardown dynamic dll plugin (elastic#72096)
  Register navLink actions for declared applications (elastic#72109)
  Fix value for process.hash.sha256 draggable (elastic#72142)
  Call setupIngest before fleet_install tests (elastic#72214)
  [Security Solution][Detections] Better toast errors (elastic#72205)
  skip flaky suite (elastic#64696)
  [Security Solution][Detections] Disable exceptions for Threshold and ML rules (elastic#72137)
  [Security Solution][Detections,Lists] Miscellaneous post-FF fixes (elastic#71990)
  [baseline/capture] use high-memory nodes with ramDisks (elastic#71894)
  skip flaky suite (elastic#77207)
  [Maps] Fix issue preventing TMS from rendering correctly (elastic#71946)
  using test_user with minimum privs (elastic#71988)
  Fixed Webhook connector doesn't retain added HTTP header settings (elastic#71924)
  [Ingest Manager] Do not show enrolling and unenrolling agents as online in agent counters (elastic#71921)
  [Maps] fix 'New Map' from getting added to recently accessed (elastic#72125)
  ...
chrisronline pushed a commit to chrisronline/kibana that referenced this pull request Jul 17, 2020
@elasticmachine @chrisronline
[Maps] Fix issue preventing TMS from rendering correctly (elastic#71946)
6882e12 
* Ensure getColors selector modifies and returns the same object

* Call onSourceConfigChange on CreateSourceEditor mount

* Back out selector update

Co-authored-by: Elastic Machine <[email protected]>
@kindsun kindsun mentioned this pull request Jul 22, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nreese nreese nreese approved these changes

Assignees
No one assigned
Labels
[Deprecated-Use Team:Presentation]Team:Geo Former Team Label for Geo Team. Now use Team:Presentation release_note:skip Skip the PR/issue when compiling release notes v7.9.0 v8.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Maps] Cannot add configured tile-map layer
4 participants
@kindsun @elasticmachine @kibanamachine @nreese