Skip to content

fix(useStorage): Defaults are updated if the storage gets updated when defaults are object like #4784

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

michaelcozzolino
Copy link
Contributor

@michaelcozzolino michaelcozzolino commented May 29, 2025

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Read the Pull Request Guidelines.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.
⚠️ Slowing down new functions

Warning: Slowing down new functions

As the VueUse audience continues to grow, we have been inundated with an overwhelming number of feature requests and pull requests. As a result, maintaining the project has become increasingly challenging and has stretched our capacity to its limits. As such, in the near future, we may need to slow down our acceptance of new features and prioritize the stability and quality of existing functions. Please note that new features for VueUse may not be accepted at this time. If you have any new ideas, we suggest that you first incorporate them into your own codebase, iterate on them to suit your needs, and assess their generalizability. If you strongly believe that your ideas are beneficial to the community, you may submit a pull request along with your use cases, and we would be happy to review and discuss them. Thank you for your understanding.


Description

Objects are references and when they are passed as defaults, the defaults are directly passed into a ref, and when the ref changes the defaults also change.
E.G:

const global = {a: 1};
const components = {b: 1}

    export const initialConfig = { global, components }

    export const config = useLocalStorage(
        'my-config',
        initialConfig,
        { mergeDefaults: true },
    );

    export const resetConfig = (): void => {
        config.value = initialConfig;
    };

somewhere else in the codebase:

  config.value.global.a = 88
 resetConfig();
 console.log(initialConfig, config.value) // both are {global: { a: 88} components: { b: 1}}

a workaround is to have a clone of the object (even a getter returning a non cloned object will make the object to be mutated internally):

const initialConfig = () => {
        return structuredClone({ global, components });
    };

I tried to implement the structured clone in the composable itself.

const data = (shallow ? shallowRef : deepRef)(
    structuredClone(toRaw(unref(typeof defaults === 'function' ? defaults() : defaults))),
  ) as RemovableRef<T>
  • unRef removes the ref from defaults if any
  • toRaw unproxies the proxy because proxies cannot be cloned

a watch is added to check for defaults changes, even tough I don't see a real use case for this feature because i suppose that even if defaults is reactive i am expecting the defaults to be used only when the storage value does not exist, but it seems, that, according to the original implementation, if the defaults change, the storage must be updated for the changed value.

just one small thing had to be changed in a test because now the composable will not return the defaults object when it is a ref but just a clone of it, I don't think this is a breaking change as the final value does not change.

Additional context

Screencast.from.2025-05-29.10-15-52.mp4

@dosubot dosubot bot added the size:M This PR changes 30-99 lines, ignoring generated files. label May 29, 2025
@michaelcozzolino
Copy link
Contributor Author

just realized, that this behavior is documented here #4548 (comment)
well hope my solution can fit it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size:M This PR changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant