Add caveat about normalizes / Marshal interaction [ci-skip]
#49876
Conversation
This file contains 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
When `ActiveRecord.marshalling_format_version` is set to `6.1`, `Marshal` will try to serialize attribute types along with the model, causing a `TypeError` if the model uses `ActiveRecord::Base.normalizes` with a normalization `Proc`. This commit adds a caveat to the `normalizes` API documentation to warn users that they should set `marshalling_format_version` to `7.1` if they are using `normalizes` and marshalling the targeted model. Fixes rails#49871.
Maybe not prevented, but definitely helped diagnose. I think this is useful. |
|
Ok, we'll go with this for now then. Thank you for the feedback, @mjankowski! 😃 Backported to |
jonathanhefner
added a commit
that referenced
this pull request
Nov 1, 2023
…s-marshalling_format_version-caveat Add caveat about `normalizes` / `Marshal` interaction [ci-skip] (cherry picked from commit 6cf3f6d)
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.
When
ActiveRecord.marshalling_format_versionis set to6.1,Marshalwill try to serialize attribute types along with the model, causing aTypeErrorif the model usesActiveRecord::Base.normalizeswith a normalizationProc.This commit adds a caveat to the
normalizesAPI documentation to warn users that they should setmarshalling_format_versionto7.1if they are usingnormalizesand marshalling the targeted model.Fixes #49871.
@mjankowski Do you feel like this would have prevented the issue you encountered?