paoloricciuti / sveltekit-search-params

The easiest way to read and WRITE from query parameters in sveltekit.
https://sveltekit-search-params.netlify.app
MIT License
478 stars 13 forks source link

Fix the override setting to allow for false values #74

Closed TravelingTice closed 5 months ago

TravelingTice commented 5 months ago

Hi @paoloricciuti 👋

I found a small bug when using the package with a store value that was a boolean, and by default false. I had this mount on a form submit after which a checkbox component would be mounted, mapped to a queryParam store that was of type boolean and by default false. It caused this weird infinite redirect loop, here is a little video of it:

https://github.com/paoloricciuti/sveltekit-search-params/assets/34274090/042fc7a7-e133-4633-9798-4e817b78dad0

Was able to trace it down to an evaluation of $override which wouldn't work for false values. Changed it to do a comparison of null which should be a bit safer, as the type of this is T | null, so I assume that we want this path to run only when non-null.

Summary by CodeRabbit

changeset-bot[bot] commented 5 months ago

🦋 Changeset detected

Latest commit: a87044a859bebf1b4abc81db8f52e0e66183c61a

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package | Name | Type | | ----------------------- | ----- | | sveltekit-search-params | Patch |

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

coderabbitai[bot] commented 5 months ago

Walkthrough

The change involves a refinement in the logic for handling query parameters within a specific function. This adjustment shifts the focus from evaluating truthiness to explicitly checking for non-null values, thereby refining the control flow based on more precise value checks. This subtle yet significant change ensures a more accurate handling of query parameters and introduces a new functionality related to allowing false values in sveltekit-search-params.

Changes

File Path Change Summary
src/lib/sveltekit-search-params Modified condition to check for non-null instead of truthy values in query parameter handling. Introduces fix for allowing false values in sveltekit-search-params.

🐰✨
In the realm of code, where logic intertwines,
A rabbit hopped through, refining the lines.
From truthy to non-null, the checks did evolve,
Ensuring query params, mysteries could solve.
🌟📜

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips ### Chat There are 3 ways to chat with CodeRabbit: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests for this file.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit tests for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.
netlify[bot] commented 5 months ago

Deploy Preview for sveltekit-search-params failed.

Name Link
Latest commit a87044a859bebf1b4abc81db8f52e0e66183c61a
Latest deploy log https://app.netlify.com/sites/sveltekit-search-params/deploys/65e5ef30ce2df700098122aa
TravelingTice commented 5 months ago

Hey @paoloricciuti 👋 Just following up here, I processed your suggestion a couple days ago, so should be all good now 🚀

paoloricciuti commented 5 months ago

Hey @paoloricciuti 👋 Just following up here, I processed your suggestion a couple days ago, so should be all good now 🚀

Ugh sorry...thanks for pinging me