migrate kanta to nebulex v3 - #140
Open
cwllwch wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Bump Nebulex to v3
Description
We wanted to use a new adapter that Nebulex 3.0 introduces due to the needs of our app, so this was necessary. Making this PR here in case you also find it relevant to bump the version.
This follows instructions from Nebulex's guide: https://nebulex.hexdocs.pm/v3-0.html
Type of Change
Related Issues
None. Would you like me to open one first?
Changes Made
Testing
automated and basic manual tests
Test Environment
Test Cases
Test Commands Run
mix test mix compile --warnings-as-errors MIX_ENV=test mix credo mix dialyzerDocumentation
Code Quality
Backward Compatibility
Breaking Changes
Host applications that also depend on nebulex ~> 2.x will get a dependency conflict and must upgrade to Nebulex 3.x. Nebulex v3 split its adapters into separate packages, so nebulex_local and nebulex_distributed are new direct dependencies. Kanta's own behavior is unchanged — call sites use the ! variants, which keep v2 semantics. Migration for most users is just updating deps.
Performance Impact
Performance Notes
Performance shouldn't be affected as the app's behavior is mantained.
Translation Management Impact
Translation Impact Notes
While this touches on the cache layer, it should not affect how the program behaves.
Security Considerations
Additional Notes
Screenshots/Examples
In all call sites, all you need to do is add a ! after the normal call. So instead of
you'd do a
There is also a slight difference in how you do opts, also done according to the migration guide.
Checklist
Reviewer Notes
Thanks for your time! 😄