feat: add plugin store watcher #585
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,164 @@ | ||
| /* eslint-disable tsdoc/syntax */ | ||
| /** | ||
| * @module \@polar/polar/core/composables/usePluginStoreWatcher | ||
| */ | ||
| /* eslint-enable tsdoc/syntax */ | ||
|
|
||
| import { computed, watch, type ComputedRef, type WatchHandle } from 'vue' | ||
|
|
||
| import type { StoreReference } from '@/core/types' | ||
|
|
||
| import { useCoreStore } from '@/core/stores' | ||
|
|
||
| /** | ||
| * Configuration for a single store reference watcher. | ||
| * @internal | ||
| */ | ||
| interface WatcherConfig { | ||
| callback: (value: unknown) => void | Promise<void> | ||
| handle: WatchHandle | null | ||
| source: StoreReference | ||
| } | ||
|
|
||
| /** | ||
| * Generic composable for watching multiple plugin store references. | ||
| * | ||
| * It watches the list of installed plugins to detect when target plugins | ||
| * are added or removed, and manages the corresponding watchers accordingly. | ||
| * | ||
| * @param sources - Array of plugin store references to watch, or a computed reference to them, or a function returning them | ||
| * @param callback - Function called when any watched plugin store value changes | ||
| * | ||
| * @example | ||
| * ```typescript | ||
| * const { setupPlugin, teardownPlugin } = usePluginStoreWatcher( | ||
| * () => configuration.value.coordinateSources || [], | ||
| * (coordinate) => { | ||
| * if (coordinate) { | ||
| * await reverseGeocode(coordinate) | ||
| * } | ||
| * } | ||
| * ) | ||
| * ``` | ||
| * | ||
| * @internal | ||
| */ | ||
| export function usePluginStoreWatcher( | ||
| sources: | ||
| | StoreReference[] | ||
| | ComputedRef<StoreReference[]> | ||
| | (() => StoreReference[]), | ||
| callback: (value: unknown) => void | Promise<void> | ||
| ) { | ||
| const coreStore = useCoreStore() | ||
| const sourcesArray = computed(() => { | ||
| if (typeof sources === 'function') { | ||
| return sources() | ||
| } | ||
| if ('value' in sources) { | ||
| return sources.value | ||
| } | ||
| return sources | ||
| }) | ||
|
|
||
| const watchers: WatcherConfig[] = [] | ||
| let pluginListWatcher: WatchHandle | null = null | ||
| let sourcesWatcher: WatchHandle | null = null | ||
|
|
||
| function setupWatcherForSource(watcherConfig: WatcherConfig) { | ||
| if (watcherConfig.handle !== null) { | ||
| return | ||
| } | ||
|
|
||
| if (!watcherConfig.source.plugin) { | ||
| return | ||
| } | ||
|
|
||
| const store = coreStore.getPluginStore(watcherConfig.source.plugin) | ||
|
|
||
| if (!store) { | ||
| console.warn( | ||
| `usePluginStoreWatcher: "${watcherConfig.source.plugin}" not found. Cannot watch "${watcherConfig.source.key}".` | ||
| ) | ||
| return | ||
| } | ||
|
|
||
| watcherConfig.handle = watch( | ||
| () => store[watcherConfig.source.key], | ||
| watcherConfig.callback | ||
| ) | ||
| } | ||
|
|
||
| function removeWatcherForSource(watcherConfig: WatcherConfig) { | ||
| if (watcherConfig.handle) { | ||
| watcherConfig.handle() | ||
| watcherConfig.handle = null | ||
| } | ||
| } | ||
|
|
||
| function updateWatchersBasedOnInstalledPlugins() { | ||
| const currentSources = sourcesArray.value | ||
|
|
||
| watchers.forEach((watcherConfig, index) => { | ||
| if (!currentSources.some((s) => s === watcherConfig.source)) { | ||
| removeWatcherForSource(watcherConfig) | ||
| watchers.splice(index, 1) | ||
| } | ||
| }) | ||
|
|
||
| currentSources.forEach((source) => { | ||
| let watcherConfig = watchers.find((w) => w.source === source) | ||
|
|
||
| if (!watcherConfig) { | ||
| watcherConfig = { source, callback, handle: null } | ||
| watchers.push(watcherConfig) | ||
| } | ||
|
|
||
| const pluginIsInstalled = | ||
| source.plugin && coreStore.getPluginStore(source.plugin) | ||
|
|
||
| if (pluginIsInstalled && !watcherConfig.handle) { | ||
| setupWatcherForSource(watcherConfig) | ||
| } else if (!pluginIsInstalled && watcherConfig.handle) { | ||
| removeWatcherForSource(watcherConfig) | ||
| } | ||
| }) | ||
| } | ||
|
|
||
| function setupPlugin() { | ||
| updateWatchersBasedOnInstalledPlugins() | ||
|
|
||
| sourcesWatcher = watch(sourcesArray, () => { | ||
| updateWatchersBasedOnInstalledPlugins() | ||
| }) | ||
|
|
||
| pluginListWatcher = watch( | ||
| () => coreStore.usedPlugins, | ||
| () => { | ||
| updateWatchersBasedOnInstalledPlugins() | ||
| } | ||
| ) | ||
| } | ||
|
|
||
| function teardownPlugin() { | ||
| watchers.forEach((watcher) => { | ||
| removeWatcherForSource(watcher) | ||
| }) | ||
| watchers.length = 0 | ||
|
|
||
| if (sourcesWatcher) { | ||
| sourcesWatcher() | ||
| sourcesWatcher = null | ||
| } | ||
|
|
||
| if (pluginListWatcher) { | ||
| pluginListWatcher() | ||
| pluginListWatcher = null | ||
| } | ||
| } | ||
|
|
||
| return { | ||
| setupPlugin, | ||
| teardownPlugin, | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There should be some console warnings if something is not working when setting up the watchers.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
4a7d352