DEV: Do not attempt to overwrite UserOption enums during autoloading #22150
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
CvX
approved these changes
Jun 16, 2023
Unfortunately, Discourse's `UserOption` model is not currently autoloaded. That means that modifying it via a `reloadable_patch` will try to apply the changes repeatedly. Normally this doesn't matter since the changes are idempotent. However, introducing ActiveRecord enums is not idempotent - they raise an error if the same enum already exists on the model. This commit adds a check to avoid hitting this 'duplicate definition' error. Reproduced ``` rails runner 'Rails.application.reloader.reload!' ```
davidtaylorhq
force-pushed
the
chat-autoloading-fix
branch
from
ca31451 to
7609892
Compare
davidtaylorhq
changed the title
davidtaylorhq
commented
Jun 16, 2023
Comment on lines
+25
to
+26
| if !base.method_defined?(:never?) # Avoid attempting to override when autoloading | ||
| base.enum :chat_header_indicator_preference, base.chat_header_indicator_preferences |
There was a problem hiding this comment.
@jjaffeux not strictly related to this PR, I think we should probably add a prefix to this enum. Right now it's auto-defining three methods:
UserOption#never?UserOption#all_new?UserOption#dm_and_mentions?
IMO would be much better to prefix so the methods are something like #chat_header_indicator_never?
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.
Unfortunately, Discourse's
UserOptionmodel is not currently autoloaded. That means that modifying it via areloadable_patchwill try to apply the changes repeatedly. Normally this doesn't matter since the changes are idempotent. However, introducing ActiveRecord enums is not idempotent - they raise an error if the same enum already exists on the model. This commit adds a check to avoid hitting this 'duplicate definition' error.Reproduced via