solidjs-community/solid-primitives

[storage] The `messageSync` is not syncing between multiple browser tabs on different paths

Open

#703 opened on Sep 30, 2024

View on GitHubContributor guide
 (1 comment) (0 reactions) (1 assignee)TypeScript (153 forks)auto 404
help wanted

Repository metrics

Stars
 (1,541 stars)
PR merge metrics
 (PR metrics pending)

Description

Describe The Problem To Be Solved

Currently, the url of postMessage argument is manually set to location.href in the code: https://github.com/solidjs-community/solid-primitives/blob/dceb3800fac83c9c1d99b8054a0dd44a280c6646/packages/storage/src/persisted.ts#L214-L217

This means that synchronization is only available for tabs that are on the same path. If the tabs are on different paths, synchronization will not occur. However, synchronization will resume if the tabs navigate back to the same path and a message is posted.

Suggest A Solution

  • Allow customizing the postMessage's url argument for the messageSync.
  • Remove this argument in the code so synchronization is available for all paths by default.

Contributor guide

Research direction
Look at the file packages/storage/src/persisted.ts around line 214-217 where postMessage is called with location.href. Consider modifying the url argument to be configurable or removing it to allow cross path sync. Test with multiple tabs on different paths.
Tech stack
typescriptjavascript
Domain
frontend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJavaScriptbrowser storage
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75