refactor OodApp and BatchConnect::App #4170
Open
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
refactor OodApp and BatchConnect::App to simplify their relationship. Confusingly, these 2 objects referenced each other. An OodApp had a BatchConnect::App object and vice versa, making it very difficult to (a) reason about and (b) cache/serialize. So this simplifies the relationship by simply having OodApp the parent class which BatchConnect::App inherets and can reference through super.
johrstrom
commented
Feb 19, 2025
Comment on lines
-187
to
-189
| def batch_connect | ||
| @batch_connect ||= BatchConnect::App.new(router: router) | ||
| end |
There was a problem hiding this comment.
Here you can see OodApp (what is now the parent) having a reference to a BatchConnect::App, what is now it's child.
johrstrom
commented
Feb 19, 2025
Comment on lines
-460
to
-463
| # The OOD app object describing this app | ||
| def ood_app | ||
| @ood_app ||= OodApp.new(router) | ||
| end |
There was a problem hiding this comment.
Then confusingly, the child BatchConnect::App has a reference back to the parent OodApp and indeed uses this object for defaults for titles or categories and so on.
johrstrom
commented
Feb 19, 2025
| @@ -106,31 +104,33 @@ def description | |||
| # Default description for the batch connect app | |||
| # @return [String] default description of app | |||
| def default_description | |||
| ood_app.manifest.description | |||
| OodApp.instance_method(:manifest).bind(self).call.description | |||
There was a problem hiding this comment.
There may be a better way to do this. Calling super calls the method of the same name - i.e., default_description. Only default_description doesn't exist on the parent, so we have to do some fancy footwork here.
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.
refactor OodApp and BatchConnect::App to simplify their relationship. Confusingly, these 2 objects referenced each other. An OodApp had a BatchConnect::App object and vice versa, making it very difficult to (a) reason about and (b) cache/serialize.
So this simplifies the relationship by simply having OodApp the parent class which BatchConnect::App inherets and can reference through super.
I'll comment through these changes on specific areas that I'm trying to fix.