feat: sorting search params before navigating #56
Conversation
🦋 Changeset detectedLatest commit: e907ec2 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
WalkthroughThe recent updates introduce sorting of query parameters to enhance cache hit rates for HTTP requests. By default, parameters are alphabetically sorted, and developers can customize this behavior or opt out entirely. Changes across several files ensure consistent handling of query parameters, including their declaration, storage, and testing. Changes
Assessment against linked issues
Poem
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 X ? TipsChat with CodeRabbit Bot (
|
✅ Deploy Preview for sveltekit-search-params ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 5
Configuration used: CodeRabbit UI
Files ignored due to filter (1)
- package.json
Files selected for processing (6)
- .gitignore (1 hunks)
- README.md (13 hunks)
- playground/src/routes/+page.svelte (2 hunks)
- playground/src/routes/queryparameters/+page.svelte (2 hunks)
- src/lib/sveltekit-search-params.ts (5 hunks)
- tests/index.test.ts (2 hunks)
Files skipped from review due to trivial changes (1)
- .gitignore
Additional comments: 22
README.md (9)
49-51: The import statement for
queryParamhas been updated to use single quotes, which is a minor stylistic change and aligns with the summary provided.100-103: The
queryParamfunction now includes anencodeanddecodeoption, which is consistent with the PR's objective to allow for custom sorting or disabling the sorting feature.120-124: The
defaultValueoption has been added to thequeryParamfunction call, which is a new feature mentioned in the summary. This allows for a default value to be set for a query parameter.145-145: The use of helper functions for parameter types (
ssp.number()) is demonstrated, which improves readability and usability as mentioned in the summary.160-160: Here, a default value is passed to the helper function, which is a new feature that aligns with the PR's objective to provide more control over query parameters.
175-175: The
queryParametersfunction is used without arguments, which suggests that it will manage all query parameters without sorting, as per the new feature.226-228: The
queryParametersfunction is now accepting an object that specifies which parameters should be managed, which is consistent with the PR's objective and the summary provided.310-310: The use of the
ssp.boolean(true)helper function is consistent with the PR's objective to provide helper functions for common parameter types.404-419: The configuration options for
queryParamandqueryParametersare demonstrated, which includes the newsortoption. This aligns with the PR's objective to allow for better cache-ability by sorting query parameters.playground/src/routes/+page.svelte (2)
9-11: The implementation of the
arr_unorderedquery parameter with thesortoption set tofalsealigns with the PR's objective to introduce unsorted query parameters for better cache-ability.47-68: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [6-67]
Given the PR's objective and the changes made, it's important to ensure that the new feature is well-documented and that there are comprehensive tests covering the new sorting behavior. The author's concern about the change being potentially breaking should be addressed by thoroughly reviewing the impact on the public API and considering a major version release if necessary.
playground/src/routes/queryparameters/+page.svelte (3)
13-20: The implementation of
unordered_storewith thesortproperty set tofalsecorrectly aligns with the PR's objective to allow unsorted query parameters. This should enable thearr-unorderedparameter to be managed without affecting cache consistency.58-74: The addition of the button to add items to the
arr-unorderedarray and the UI elements to display it are consistent with the existing pattern of the application. The use of the spread operator to trigger reactivity in Svelte is correct, ensuring the UI updates when the array changes.9-11: The existing store initialization does not show any changes related to the new sorting feature. It's important to ensure that documentation and examples are updated to guide users on how to use the new
sortproperty with existing stores if this is a breaking change.src/lib/sveltekit-search-params.ts (6)
30-34: The addition of the
sortproperty to theStoreOptionsinterface is consistent with the PR's objective to introduce sorting of search parameters. This is a significant change that could impact existing consumers of these functions.158-161: The
queryParametersfunction has been updated to include thesortproperty with a default value oftrue. This ensures that sorting is enabled by default, maintaining backward compatibility for existing consumers who do not specify thesortoption.246-249: The
queryParamfunction has been updated to include thesortproperty with a default value oftrue. This change maintains backward compatibility for existing consumers who do not specify thesortoption.196-208: The conditional sorting logic using the
sortproperty before updating the URL and pushing history is implemented correctly and aligns with the PR's objective to improve cache-ability by ensuring consistent order of query parameters.274-286: The conditional sorting logic in the
queryParamfunction is consistent with thequeryParametersfunction, correctly using thesortproperty to ensure the order of query parameters before updating the URL and pushing history.193-211: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [30-286]
Given the changes to the function signatures and the introduction of a new feature that alters URL generation behavior, this PR introduces breaking changes. It would be prudent to release these changes as a major version update to adhere to semantic versioning principles.
tests/index.test.ts (2)
119-130: The test case 'parameters are kept in alphabetical order by default' correctly checks the URL search string to ensure parameters are sorted alphabetically. This aligns with the PR's objective to improve cache-ability by sorting query parameters.
272-282: The test case 'parameters are kept in alphabetical order by default' in the
queryParametersdescribe block is similar to the one in thequeryParamblock. It checks the URL search string to ensure parameters are sorted alphabetically. This is consistent with the feature being tested and the PR's objective.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files selected for processing (2)
- .changeset/curvy-icons-protect.md (1 hunks)
- README.md (13 hunks)
Additional comments: 15
README.md (15)
49-51: The import statement and the usage of
queryParamare updated to use single quotes, which is a minor stylistic change. This aligns with the PR's objective to standardize the usage examples in the documentation.67-67: The example correctly demonstrates the usage of
queryParamfor a single parameter. It's important to note that the PR's objective mentions sorting, but this simple case does not demonstrate the sorting feature.87-87: The example shows how to update the query parameter by assigning a new value to the store. This is consistent with the library's usage pattern.
101-103: The
encodeanddecodefunctions are provided to handle the conversion of a number to a string and vice versa. This is a clear example of how to use these functions withqueryParam.121-123: The
defaultValueis introduced in the example, which is consistent with the PR's objective to allow setting default values for query parameters.145-145: This example uses a helper function
ssp.number()to simplify the encoding and decoding process. This is a good demonstration of the library's helper functions.160-160: The example demonstrates how to use a helper function with a default value, which is a new feature mentioned in the PR's objective.
175-175: The
queryParametersfunction is used without any options, which does not showcase the new sorting feature. It would be beneficial to include an example that demonstrates the sorting functionality.211-211: This example illustrates updating multiple query parameters at once by modifying the store object, which is consistent with the library's intended functionality.
227-227: The example shows how to specify expected query parameters, which is useful for initializing the store with predefined keys.
267-270: The
encodeanddecodefunctions are used to handle boolean values, with adefaultValueprovided. This is a good example of more complex parameter handling.310-310: Here, the helper function
ssp.boolean(true)is used to simplify the encoding and decoding of a boolean value with a default value, which aligns with the PR's objectives.396-396: The new
sortoption is introduced in the documentation, explaining its purpose and default behavior. This is a key part of the PR's objective and should be highlighted to inform users of the breaking change.406-410: The
debounceHistoryoption is documented, which is not directly related to the sorting feature but is important for users to understand how to control the history behavior.417-417: The
pushHistoryoption is mentioned, which allows users to control whether changes to the store result in new history entries. This is useful information that should be included in the documentation.
| --- | ||
| "sveltekit-search-params": minor | ||
| --- | ||
|
|
||
| feat: sorting search params before navigating |
There was a problem hiding this comment.
Given the potential impact of the new sorting feature on existing users' workflows, it might be more appropriate to release this change as a major version update, not a minor one, to clearly communicate the breaking nature of the changes. Please consider the implications of this new feature on existing users and the semantic versioning guidelines.
Closes #51
This adds sorting before navigating to allow for better cache-ability. This is technically a breaking change (?) but i'm a bit unsure about the consequences that it might have so i might keep it as a minor
Summary by CodeRabbit
Documentation
queryParamandqueryParametersfunctions with improved examples.New Features
arr_unorderedthat maintains an unordered list.unordered_storeto manage the state of unordered arrays in the UI.Refactor
queryParametersandqueryParamfunctions with asortoption to control the sorting of query parameters.Tests