feat: add plugin store watcher by jedi-of-the-sea · Pull Request #585 · Dataport/polar

jedi-of-the-sea · 2026-03-06T13:48:39Z

Summary

This PR should solve the problem of the dependency of plugin orders by adding a reusable plugin store watcher. It can be used within plugins to manahge watchers for stores from other plugins.

Within this PR, plugin store watchers where added to geoLocation plugin and pins plugin.

⚠️ Please note: to test the new plugin watchers, the order of the plugins geolocation, addressSearch, attributions, layerChooser and pins within the snowbox client was changed.

Instructions for local reproduction and review

Start the snowbox client

click in the map (stay in the vicinity of Hamburg)
check if the address of the place that was clicked on the map is displayed in the search result input field.

search for address
check if map zooms to search result and a pin is put on the map

open the attributions
change layer visibiliity in layer chooser
check if the attributions change accordingly

Pull Request Checklist (for Assignee)

Changelogs are maintained
Functionality has been tested in Firefox, Chrome, Safari
Functionality has been tested on a smartphone
Functionality has been tested with 200% screen zoom
Screenreader functionality has been manually tested with NVDA

UI has been tested in the following tools regarding accessibility (only regarding functionality affected in this PR)

Chrome Lighthouse
Firefox Accessibility

Relevant tickets, issues, et cetera

closes #484

github-actions · 2026-03-06T13:51:53Z

PR Preview Action v1.8.0
🚀 View preview at https://Dataport.github.io/polar/pr-preview/pr-585/
Built to branch `gh-pages` at 2026-04-08 10:15 UTC. Preview will be ready when the GitHub Pages deployment is complete.

…-watcher

dopenguin

Attributions also need this new composable.

🏓 @jedi-of-the-sea

Co-authored-by: Pascal Röhling <73653210+dopenguin@users.noreply.github.com>

…in array

…ed store

…narrowing/safety error

…toreWatcher

…hanges

jedi-of-the-sea · 2026-03-12T13:32:19Z

Attributions also need this new composable.

fecfba8

🏓 @dopenguin

(i also updated the description / instructions)

…agement

jedi-of-the-sea · 2026-03-26T11:57:51Z

I noticed an inconsistency within the attributions plugin when a layer is selected but not visible in the current zoom level (can be tested in client "snowbox"). While selecting / deselecting layers, the layer "Ausgleichsflächen" is sometimes listed in the attributions and sometimes not. This seems to be already a problem within the next branch, so I suggest I ignore it in this branch and it gets a separate issue. Would you aggree?

dopenguin · 2026-04-07T10:23:26Z

I noticed an inconsistency within the attributions plugin when a layer is selected but not visible in the current zoom level (can be tested in client "snowbox"). While selecting / deselecting layers, the layer "Ausgleichsflächen" is sometimes listed in the attributions and sometimes not. This seems to be already a problem within the next branch, so I suggest I ignore it in this branch and it gets a separate issue. Would you aggree?

This either seems to have already been fixed on next or I can not reproduce this bug at least for iceberg.
Please update the branch so we may see if this is the case for this PR as well.

However, this does not seem to work at all for iceberg whereas it works for snowbox without any problems.

dopenguin

🏓 @jedi-of-the-sea

Please also rebase the branch / merge the changes from next onto this branch

jedi-of-the-sea · 2026-04-08T07:17:44Z

I noticed an inconsistency within the attributions plugin when a layer is selected but not visible in the current zoom level (can be tested in client "snowbox"). While selecting / deselecting layers, the layer "Ausgleichsflächen" is sometimes listed in the attributions and sometimes not. This seems to be already a problem within the next branch, so I suggest I ignore it in this branch and it gets a separate issue. Would you aggree?

This either seems to have already been fixed on next or I can not reproduce this bug at least for iceberg. Please update the branch so we may see if this is the case for this PR as well.

However, this does not seem to work at all for iceberg whereas it works for snowbox without any problems.

I can still reproduce the bug in the updated next branch for the snowbox client. But in iceberg, the listener for the attributions does not seem to work at all? The videos are from my tests with the next branch

snowbox:
https://github.com/user-attachments/assets/d3254647-924f-42d7-9d88-035fec4f5272

iceberg:
https://github.com/user-attachments/assets/0631aace-2021-4c01-9923-a8b03953da8b

EDIT: i just checked the config and iceberg has no listenToChanges config parameter, so this is why it won't work there. So iceberg is not suited to test the plugin watcher in the attributions plugin.

dopenguin · 2026-04-08T09:54:58Z

I noticed an inconsistency within the attributions plugin when a layer is selected but not visible in the current zoom level (can be tested in client "snowbox"). While selecting / deselecting layers, the layer "Ausgleichsflächen" is sometimes listed in the attributions and sometimes not. This seems to be already a problem within the next branch, so I suggest I ignore it in this branch and it gets a separate issue. Would you aggree?

This either seems to have already been fixed on next or I can not reproduce this bug at least for iceberg. Please update the branch so we may see if this is the case for this PR as well.
However, this does not seem to work at all for iceberg whereas it works for snowbox without any problems.

I can still reproduce the bug in the updated next branch for the snowbox client. But in iceberg, the listener for the attributions does not seem to work at all? The videos are from my tests with the next branch

snowbox: https://github.com/user-attachments/assets/d3254647-924f-42d7-9d88-035fec4f5272

iceberg: https://github.com/user-attachments/assets/0631aace-2021-4c01-9923-a8b03953da8b

EDIT: i just checked the config and iceberg has no listenToChanges config parameter, so this is why it won't work there. So iceberg is not suited to test the plugin watcher in the attributions plugin.

The config has been updated in 6cfe0dc.

I'll take a closer look regarding the inconsistencies of the attributions

…taport/polar into vue3/add-plugin-store-watcher

jedi-of-the-sea · 2026-04-08T10:15:13Z

The config has been updated in [6cfe0dc]

Ah ok. I found the same bug here now, too.

I'll take a closer look regarding the inconsistencies of the attributions

it seems to be a bug in getVisibleLayers - sometimes, layer.getVisible() returns true when the layer is selected but invisible due to to zoom level (e.g. when starting the client), sometimes it returns false (e.g. after zooming out again after the layer was visible in a zoom level and is not anymore in the next). Don't know why

🏓 @dopenguin

dopenguin

🚀 @jedi-of-the-sea

jedi-of-the-sea added 3 commits March 6, 2026 09:47

feat(core): add plugin store watcher

b37fde1

refactor(pins): use pluginStoreWatcher for watching coordinateSource

4f33de0

refactor(pins): use pluginStoreWatcher for watching coordinateSource

11b075c

jedi-of-the-sea and others added 5 commits March 6, 2026 14:57

Merge remote-tracking branch 'origin/next' into vue3/add-plugin-store…

7e7aeef

…-watcher

Merge remote-tracking branch 'origin/next' into vue3/add-plugin-store…

1fc2774

…-watcher

Merge branch 'next' into vue3/add-plugin-store-watcher

18036b0

test: accept use of usePluginStoreWatcher in plugins

f528a15

fix(core): watch coreStore in usePluginWatcher

be3377b

jedi-of-the-sea force-pushed the vue3/add-plugin-store-watcher branch from a0a2c76 to be3377b Compare March 9, 2026 08:37

jedi-of-the-sea self-assigned this Mar 9, 2026

test: switch order of plugins for testing plugin store watcher

c5ed058

jedi-of-the-sea added the enhancement New feature or request label Mar 9, 2026

jedi-of-the-sea marked this pull request as ready for review March 9, 2026 09:15

jedi-of-the-sea requested review from dopenguin, oeninghe-dataport and warm-coolguy as code owners March 9, 2026 09:15

jedi-of-the-sea changed the title ~~Vue3/add plugin store watcher~~ feat: add plugin store watcher Mar 9, 2026

dopenguin linked an issue Mar 9, 2026 that may be closed by this pull request

Plugin watchers don't work if another plugin is added later on #484

Closed

jedi-of-the-sea added 3 commits March 10, 2026 08:36

Merge branch 'next' into vue3/add-plugin-store-watcher

51a48af

Merge branch 'next' into vue3/add-plugin-store-watcher

60ab99b

Merge branch 'next' into vue3/add-plugin-store-watcher

1bf97fe

dopenguin requested changes Mar 10, 2026

View reviewed changes

jedi-of-the-sea and others added 7 commits March 11, 2026 13:55

Update src/core/composables/usePluginStoreWatcher.ts

43dc809

Co-authored-by: Pascal Röhling <73653210+dopenguin@users.noreply.github.com>

test: restore original test

7c0f3cc

refactor: extract pluginStoreWatcher from core

a977903

fix: delete unnnecessary comments

074ec91

refactor: access plugin store through coreStore

bea374c

refactor: use getPluginStore instead of manually looking through plug…

9456b59

…in array

refactor(core): add getter usedPlugins

e8a36a9

jedi-of-the-sea added 8 commits March 11, 2026 15:46

refactor: change pluginIsInstalled to require both plugin ID and load…

52e24fd

…ed store

refactor: delete unreachable code, leave guard check to prevent type …

2aac0a4

…narrowing/safety error

feat: add warnings when plugin store cannot be found

4a7d352

fix(pins): correct callback parameter types for usePluginStoreWatcher

ed83242

fix(reverseGeocoder): correct callback parameter types for usePluginS…

f89d83e

…toreWatcher

test(reverseGeocoder): adjust tests to watcher changes

9f6d623

refactor(attributions): use pluginStoreWatcher for watching listenToC…

fecfba8

…hanges

test: change order of plugins for more testing

d5941bb

Merge branch 'next' into vue3/add-plugin-store-watcher

42571a3

oeninghe-dataport reviewed Mar 24, 2026

View reviewed changes

Comment thread src/composables/usePluginStoreWatcher.ts Outdated

jedi-of-the-sea added 3 commits March 25, 2026 17:25

refactor: simplify usePluginStoreWatcher with automatic lifecycle man…

e62c609

…agement

Merge branch 'next' into vue3/add-plugin-store-watcher

bac28af

fix: prevent linting errors

747dce9

dopenguin requested changes Apr 7, 2026

View reviewed changes

Comment thread src/plugins/reverseGeocoder/store.ts

Comment thread src/plugins/attributions/store.ts Outdated

Comment thread src/plugins/attributions/store.ts

Merge branch 'next' into vue3/add-plugin-store-watcher

608248e

feat(composables): support watch options in usePluginStoreWatcher

e1300dc

jedi-of-the-sea and others added 3 commits April 8, 2026 12:00

Merge branch 'next' into vue3/add-plugin-store-watcher

6d69b98

refactor(attributions): reuse listenToChanges computed

da607e5

Merge branch 'vue3/add-plugin-store-watcher' of https://github.com/Da…

840c3b5

…taport/polar into vue3/add-plugin-store-watcher

dopenguin approved these changes Apr 9, 2026

View reviewed changes

jedi-of-the-sea merged commit be0dda4 into next Apr 9, 2026
4 checks passed

jedi-of-the-sea deleted the vue3/add-plugin-store-watcher branch April 9, 2026 13:31

Conversation

jedi-of-the-sea commented Mar 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Instructions for local reproduction and review

Pull Request Checklist (for Assignee)

Relevant tickets, issues, et cetera

Uh oh!

github-actions bot commented Mar 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Built to branch gh-pages at 2026-04-08 10:15 UTC. Preview will be ready when the GitHub Pages deployment is complete.

Uh oh!

dopenguin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jedi-of-the-sea commented Mar 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

jedi-of-the-sea commented Mar 26, 2026

Uh oh!

dopenguin commented Apr 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dopenguin left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jedi-of-the-sea commented Apr 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dopenguin commented Apr 8, 2026

Uh oh!

jedi-of-the-sea commented Apr 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dopenguin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jedi-of-the-sea commented Mar 6, 2026 •

edited

Loading

github-actions bot commented Mar 6, 2026 •

edited

Loading

Built to branch `gh-pages` at 2026-04-08 10:15 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

jedi-of-the-sea commented Mar 12, 2026 •

edited

Loading

dopenguin commented Apr 7, 2026 •

edited

Loading

dopenguin left a comment •

edited

Loading

jedi-of-the-sea commented Apr 8, 2026 •

edited

Loading

jedi-of-the-sea commented Apr 8, 2026 •

edited

Loading