Skip to content

Handle standard errors in association generation #1621

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
LTe wants to merge 1 commit into from
Closed

Handle standard errors in association generation #1621

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions lib/tapioca/dsl/compilers/active_record_associations.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,10 @@ def populate_associations(mod)
add_error(<<~MSG.strip)
Cannot generate association `#{declaration(reflection)}` on `#{constant}` since the constant `#{error.class_name}` does not exist.
MSG
rescue StandardError => error

@KaanOzkan KaanOzkan Aug 28, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We think this rescue is a bit of an overkill for one method missing. Rescuing every error and generating potentially incorrect RBIs with no one noticing it would be a real possibility with this change.

Looking at the monkey patching in the test it seems to break Rails internals that we rely on. Can this be fixed in that monkey patch instead?

@KaanOzkan KaanOzkan Sep 1, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@LTe An alternative is doing an early return if reflection isn't defined similar to https://github.com/Shopify/tapioca/pull/1632/files#diff-56a92ed84ac2571734401e6c2cfd52020ff8b497899c93e07d1effedd7a3bc97R57

@LTe LTe Sep 15, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you are right and it should be fixed in the monkey-patch for rails.

add_error(<<~MSG.strip)
Cannot generate association `#{association_name}` on `#{constant}` because of `#{error}`.".
MSG
end
end

Expand Down
42 changes: 42 additions & 0 deletions spec/tapioca/dsl/compilers/active_record_associations_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1337,6 +1337,48 @@ def reload_post; end
expect_dsl_compiler_errors!
end

it "generates RBI file for monkey patches reflections" do
add_ruby_file("schema.rb", <<~RUBY)
ActiveRecord::Migration.suppress_messages do
ActiveRecord::Schema.define do
create_table :posts do |t|
end
end
end
RUBY

add_ruby_file("custom_reflection.rb", <<~RUBY)
class CustomReflection
def parent_reflection
end
end
RUBY

add_ruby_file("post.rb", <<~RUBY)
class Post < ActiveRecord::Base
::ActiveRecord::Reflection.add_reflection(self, :monkey, CustomReflection.new)
end
RUBY

expected = <<~RBI
# typed: strong

class Post
include GeneratedAssociationMethods

module GeneratedAssociationMethods; end
end
RBI

assert_equal(expected, rbi_for(:Post))

assert_equal(1, generated_errors.size)

assert_match(Regexp.new(<<~MSG.strip), generated_errors.first)
Cannot generate association `monkey` on `Post` because of `undefined method `collection?.*
MSG
end

it "generates RBI file for broken associations" do
add_ruby_file("schema.rb", <<~RUBY)
ActiveRecord::Migration.suppress_messages do
Expand Down