Page MenuHomePhabricator
Create Task
Maniphest T318702

Proof-of-concept: Integrate leaflet clustering with the Nearby layer
Closed, ResolvedPublic8 Estimated Story Points
Actions

Description

This task is complete when we have proof-of-concept code to demonstrate clustered nearby markers.

Note: this task is only about implementing for the nearby markers and not user-added markers. This will be done as follow-up work once the we have pin grouping fully working for show nearby pins.

Out of scope:

  • No style specification. Use all default settings for the POC.

Implementation:

  • How is Wikivoyage legacy Nearby clustering implemented?
  • Clustering is recalculated whenever the list of articles changes.
  • TBD: What happens when clicking on a cluster? Is this out of scope?
  • Leave a screenshot on this task.

Details

SubjectRepoBranchLines +/-
[PoC] Use leaflet.markercluster for nearby featuremediawiki/extensions/Kartographermaster+2 K -5
Customize query in gerrit

Related Objects
Search...

Event Timeline

awight created this task.Sep 27 2022, 12:34 PM
ECohen_WMDE moved this task from Backlog to In sprint on the WMDE-GeoInfo-FocusArea board.Sep 27 2022, 1:06 PM
thiemowmde added a project: WMDE-TechWish-Sprint-2022-09-28.Sep 28 2022, 12:14 PM
ECohen_WMDE updated the task description. (Show Details)Sep 28 2022, 4:18 PM
ECohen_WMDE subscribed.
ECohen_WMDE set the point value for this task to 8.Sep 28 2022, 4:36 PM

Agreed in story time to timebox and review the feature's prioritization if it seems that it will take more time than that.

WMDE-Fisch claimed this task.Oct 10 2022, 2:45 PM
WMDE-Fisch moved this task from Sprint Backlog to Doing on the WMDE-TechWish-Sprint-2022-09-28 board.
gerritbot added a comment.Oct 11 2022, 9:58 AM

Change 841462 had a related patch set uploaded (by WMDE-Fisch; author: WMDE-Fisch):

[mediawiki/extensions/Kartographer@master] [PoC] Use leaflet.markercluster for nearby feature

https://gerrit.wikimedia.org/r/841462

gerritbot added a project: Patch-For-Review.Oct 11 2022, 9:58 AM
WMDE-Fisch added a comment.Oct 11 2022, 1:08 PM

How is Wikivoyage legacy Nearby clustering implemented?

The Wikivoyage implementation uses the Pruncluster library that works together with Leaflet to cluster markers. It's supposed to be lightweight and fast. The downside seems to be, that each marker object needs to be created with the included constructor for markers. So it's not automatically "just" taking existing Leaflet markers and clusters them. Also it's last release is from 2017 and it seems not very well maintained.

In the PoC patch uploaded I used the Leaflet.markercluster library that seem to be the default for clustering markers on with Leaflet and is more actively maintained.

TBD: What happens when clicking on a cluster? Is this out of scope?

Leaflet.markercluser allows either zooming in on click or expanding to a kind of spider web. I'll attach a screenshot. The former one feels quite weird with our current implementation because we add and remove markers when we zoom. So it can happen that the user clicks to "expand" two markers and then he finds himself in front a new cluster with even more points because more stuff got loaded. The PoC goes for the latter implementation. But it's a simple setting that can easily be changed.

WMDE-Fisch added a comment.EditedOct 11 2022, 5:37 PM

Leave a screenshot on this task.

T318702-v1-optimized.gif (600×900 px, 1 MB)

Note: The Popups still need to be re-wired in the final implementation. They are not working in the PoC. That's why it's not demoed here.

WMDE-Fisch moved this task from Doing to Tech Review on the WMDE-TechWish-Sprint-2022-09-28 board.Oct 11 2022, 5:48 PM

TechReview:

  • Is adding Leaflet.markercluster reasonable? Or should be try to adapt to Prunecluster?
  • Any other thoughts on the approach? What about the habit to copy the lib files during the build step?
WMDE-Fisch added a project: WMDE-TechWish-Sprint-2022-10-12.Oct 12 2022, 9:54 AM
ECohen_WMDE moved this task from Sprint Backlog to Tech Review on the WMDE-TechWish-Sprint-2022-10-12 board.Oct 12 2022, 9:54 AM
ECohen_WMDE added a comment.Oct 17 2022, 10:09 AM

@WMDE-Fisch Have you looked into the pin grouping used in the Places tab of the iOS app at all? I think the balance is working quite well there (when to group, how many to group, zooming). Can we either use that library or check their variables to re-use?

awight moved this task from Tech Review to Doing on the WMDE-TechWish-Sprint-2022-10-12 board.Oct 19 2022, 11:05 AM
WMDE-Fisch mentioned this in T321307: Create clustering MVP with Leaflet.markercluster.EditedOct 20 2022, 12:27 PM
WMDE-Fisch moved this task from Doing to Done on the WMDE-TechWish-Sprint-2022-10-12 board.

Investigation is done. Follow up ticket takes care to continue the development: T321307: Create clustering MVP with Leaflet.markercluster

WMDE-Fisch closed this task as Resolved.Oct 25 2022, 8:58 AM
gerritbot added a comment.Jan 13 2023, 3:58 PM

Change 841462 abandoned by WMDE-Fisch:

[mediawiki/extensions/Kartographer@master] [PoC] Use leaflet.markercluster for nearby feature

Reason:

PoC not needed anymore

https://gerrit.wikimedia.org/r/841462

Maintenance_bot removed a project: Patch-For-Review.Jan 13 2023, 4:31 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL