Skip to content
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

fix: avoid complex values default being overriden on write #89

Merged
merged 1 commit into from
Jul 28, 2024

Conversation

paoloricciuti
Copy link
Owner

@paoloricciuti paoloricciuti commented Jul 28, 2024

Closes #86

Summary by CodeRabbit

  • New Features
    • Introduced new Svelte components for managing query parameters with enhanced type safety.
    • Added functionality to reset query parameters via navigation links.
  • Bug Fixes
    • Resolved an issue preventing complex values from being preserved during write operations in the search parameters.
  • Tests
    • Added new tests to verify that default values for complex objects remain unchanged during write operations.

Copy link

changeset-bot bot commented Jul 28, 2024

🦋 Changeset detected

Latest commit: ae3d890

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

Copy link

netlify bot commented Jul 28, 2024

Deploy Preview for sveltekit-search-params ready!

Name Link
🔨 Latest commit ae3d890
🔍 Latest deploy log https://app.netlify.com/sites/sveltekit-search-params/deploys/66a6215430e8fa0008772357
😎 Deploy Preview https://deploy-preview-89--sveltekit-search-params.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

coderabbitai bot commented Jul 28, 2024

Walkthrough

This update enhances the sveltekit-search-params functionality, ensuring complex values remain unchanged during write operations. It introduces new Svelte components for managing query parameters with TypeScript, improving both type safety and user interaction. Additionally, modifications to core functions prevent unintended mutations of complex objects, bolstering data integrity throughout the application.

Changes

Files Change Summary
.changeset/twelve-weeks-drive.md Patch for sveltekit-search-params to prevent complex values from being overridden during writes.
playground/src/routes/default/obj/+page.svelte New Svelte component for managing the obj query parameter with TypeScript, enhancing user interaction with conditional input field.
playground/src/routes/default/parameters-obj/+page.svelte New Svelte component for handling query parameters with dynamic updates based on user input.
src/lib/sveltekit-search-params.ts Modifications in queryParameters and queryParam functions to use structuredClone for safer handling of object references.
tests/index.test.ts Added tests to verify that default values for complex objects remain unchanged during writes.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SvelteComponent
    participant SearchParams

    User->>SvelteComponent: Input data
    SvelteComponent->>SearchParams: Update query parameters
    SearchParams->>SvelteComponent: Return updated parameters
    SvelteComponent->>User: Display updated parameters
Loading

Assessment against linked issues

Objective Addressed Explanation
Store is not cleared when navigating to the same route (#[86])

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
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 <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • 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 testing code 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 testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 8b85bc1 and ae3d890.

Files selected for processing (5)
  • .changeset/twelve-weeks-drive.md (1 hunks)
  • playground/src/routes/default/obj/+page.svelte (1 hunks)
  • playground/src/routes/default/parameters-obj/+page.svelte (1 hunks)
  • src/lib/sveltekit-search-params.ts (2 hunks)
  • tests/index.test.ts (1 hunks)
Additional comments not posted (11)
.changeset/twelve-weeks-drive.md (1)

1-5: LGTM!

The changeset entry correctly specifies a patch update and provides a clear description of the fix.

playground/src/routes/default/obj/+page.svelte (2)

1-5: LGTM!

The code correctly imports necessary functions and defines a query parameter with a default value.


6-11: LGTM!

The code correctly binds the input value to the query parameter and includes a link to reset the parameters.

playground/src/routes/default/parameters-obj/+page.svelte (2)

1-5: LGTM!

The code correctly imports necessary functions and defines a query parameter with a default value.


6-11: LGTM!

The code correctly binds the input value to the query parameter and includes a link to reset the parameters.

src/lib/sveltekit-search-params.ts (4)

284-284: Good use of structuredClone for valueToSet.

The use of structuredClone ensures that a deep copy of the values is passed, preventing unintended mutations and maintaining data integrity.


290-290: Good use of structuredClone for valueToSet.

The use of structuredClone ensures that a deep copy of the values is passed, preventing unintended mutations and maintaining data integrity.


392-392: Good use of structuredClone for defaultValue.

The use of structuredClone ensures that a deep copy of the values is passed, preventing unintended mutations and maintaining data integrity.


398-398: Good use of structuredClone for defaultValue.

The use of structuredClone ensures that a deep copy of the values is passed, preventing unintended mutations and maintaining data integrity.

tests/index.test.ts (2)

385-395: Test case for verifying default values for complex objects.

The test case ensures that the obj parameter retains its default value after the input field is filled and the link is clicked. This verifies the correct behavior of the fix.


397-407: Test case for verifying default values for complex objects with queryParameters.

The test case ensures that the obj parameter retains its default value after the input field is filled and the link is clicked. This verifies the correct behavior of the fix.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Store is not cleared when navigating to the same route without params
1 participant