Rewrite useLocalStorageEarthstarSettings + LocalStorageSettingsWriter - Githubissues

earthstar-project / react-earthstar

A UI toolkit for making collaborative, offline-first applets for small groups.

GNU Affero General Public License v3.0

60 stars 5 forks source link

Rewrite useLocalStorageEarthstarSettings + LocalStorageSettingsWriter #54

Closed sgwilym closed 3 years ago

sgwilym commented 3 years ago

There's been a lot of weirdness with localstorage, stemming from two issues:

Stuff we don't want being written to localstorage (private methods, recursively duplicated properties)
The useLocalStorageEarthstarSettings updating itself whenever localstorage was written to, which was often as it happens on every document write. This had the effect of rerendering any component it was used in, which is often the entire app.

This PR makes the following changes:

Rewrites useLocalStorageEarthstarSettings to use the native localStorage API.
- This has the effect of making it so that this hook does not detect when values in localstorage update.
Rewrite LocalStorageSettingsWriter so that it serialises storages properly, and writes to localstorage when it is expected to.
Adds tests for useLocalStorageEarthstarSettings.

This should close #50 and #51.

sgwilym commented 3 years ago

What this PR doesn't deal with yet is local storage updates coming from another tab. But I plan to add support for that later.