Skip to content
This repository was archived by the owner on Nov 30, 2024. It is now read-only.

Add missing ruby2_keywords calls in rspec-mocks #1464

Merged
merged 1 commit into from
Mar 29, 2022
Merged

Add missing ruby2_keywords calls in rspec-mocks #1464

merged 1 commit into from
Mar 29, 2022

Conversation

eregon
Copy link
Contributor

@eregon eregon commented Mar 21, 2022 •
edited
Loading

  • And standardize checks to if respond_to?(:ruby2_keywords, true).

cc @bjfish

This is progress towards rspec/rspec-metagem#68.
Before: 25 failures, After: 2 failures left (which seem unrelated):

Failures:

  1) #any_instance when stubbing aliased methods tracks aliased method calls
     Failure/Error: parent_aliased_method
     
     NameError:
       undefined local variable or method `parent_aliased_method' for #<AnyInstanceSpec::ParentClass:0x2bb88>
     # ./spec/rspec/mocks/any_instance_spec.rb:20:in `caller_of_parent_aliased_method'
     # ./spec/rspec/mocks/any_instance_spec.rb:210:in `block (4 levels) in <module:Mocks>'

  2) Marshal extensions #dump when rspec-mocks has been fully initialized applying and unapplying patch is idempotent
     Failure/Error: expect { Marshal.dump(obj) }.to raise_error(TypeError)
       expected TypeError but nothing was raised
     # ./spec/rspec/mocks/marshal_extension_spec.rb:46:in `block (4 levels) in <top (required)>'

BTW, the reason the code worked before these ruby2_keywords seems accidental and due to a bug/inconsistency in CRuby: https://bugs.ruby-lang.org/issues/18625

@eregon eregon mentioned this pull request Mar 21, 2022
Closed
@eregon eregon force-pushed the add-missing-ruby2_keywords branch from 0dbe9d7 to 9703d86 Compare March 21, 2022 16:44
This was referenced Mar 21, 2022
Merged
Merged
@eregon
Copy link
Contributor Author

eregon commented Mar 22, 2022 •
edited
Loading

This change is also needed for Ruby 3.2 if the fix for https://bugs.ruby-lang.org/issues/18625 gets in.
So what I did is build that change locally and run rspec-mocks specs without & with this patch.
Without this PR, there are 23 failures. With this PR, no failures.

Since 3.2 needs that fix, it seems we will need a rspec release, so Bundler can get this fix, and Bundler is tested in ruby/ruby's CI. Bundler's specs can't just point to a github branch due to rspec inter-gem version restrictions (and that wouldn't be a good solution longer-term either of course): https://github.com/ruby/ruby/pull/5684/checks

@pirj pirj requested a review from JonRowe March 22, 2022 12:26
@pirj
Copy link
Member

pirj commented Mar 22, 2022

Re-running jobs to see if a weird failure was temporary.

@JonRowe
Copy link
Member

JonRowe commented Mar 23, 2022

I'm fine with this if we can get a passing build, although if there is an easy way to get a spec (or specs) that would fail without these changes on one of the existing MRI builds that'd be a nice to have.

@eregon
Copy link
Contributor Author

eregon commented Mar 24, 2022

I'm really confused how this PR can cause 2.5/2.6 to fail rspec-rails specs, on Linux but not Windows, when ruby2_keywords doesn't exist in Ruby < 2.7 (and even if it's defined there it would noop).
I'll schedule a few runs on my fork to try to debug it.

@eregon
Copy link
Contributor Author

eregon commented Mar 24, 2022

Looks like I'm running into #1385 (comment)

@eregon eregon mentioned this pull request Mar 24, 2022
Merged
@eregon
Add missing ruby2_keywords in rspec-mocks
114e6ba 
* And standardize checks to `if respond_to?(:ruby2_keywords, true)`.
@eregon eregon force-pushed the add-missing-ruby2_keywords branch from 9703d86 to 114e6ba Compare March 24, 2022 11:50
@eregon
Copy link
Contributor Author

eregon commented Mar 24, 2022

CI shall be green now (here is my run), except 2.3 Windows which is already failing on main.

although if there is an easy way to get a spec (or specs) that would fail without these changes on one of the existing MRI builds that'd be a nice to have.

This is not possible, the code before this PR only works "thanks" to a CRuby bug of not resetting the ruby2_keywords flag correctly (https://bugs.ruby-lang.org/issues/18625).
So this PR has no effect on CRuby <= 3.1, but it does fix TruffleRuby (which doesn't have that bug) and CRuby 3.2 (if the bug is fixed in CRuby 3.2, let's hope so).
I verified this change is required to pass existing specs on a local build of CRuby 3.2-dev with the fix (#1464 (comment)).

@pirj
Copy link
Member

pirj commented Mar 24, 2022 •
edited
Loading

I recalled that there was a reason to switch to Module.private_method_defined? in the first place. There's some discussion here #1385 (comment) - PS my apologies, I've just realized you've dug down to this discussion, too.

Just to have some records of what the fix entailed, what is the difference between your original implementation of this PR and the final result, @eregon?
I can spot a call of ruby2_keywords on an instance of a Proc (TIL) 🤯

@eregon
Copy link
Contributor Author

eregon commented Mar 24, 2022

Just to have some records of what the fix entailed, what is the difference between your original implementation of this PR and the final result, @eregon?

You can see it with the Compare button above, it links to this diff. So it's just restoring that check and adding comment why it's done that way (I otherwise used the well-known if respond_to?(:ruby2_keywords, true) check).

@JonRowe JonRowe merged commit 820b30b into rspec:main Mar 29, 2022
@eregon
Copy link
Contributor Author

eregon commented Mar 31, 2022

Could I ask for a release of rspec-mocks including this fix?
I tried various things, but I can't get the Bundler tests in ruby/ruby CI to use rspec-mocks master (ruby/ruby#5684)

JonRowe added a commit that referenced this pull request Mar 31, 2022
@JonRowe
Changelog for #1464
904e933
JonRowe added a commit that referenced this pull request Mar 31, 2022
@JonRowe
Merge pull request #1464 from eregon/add-missing-ruby2_keywords
d847fa6 
Add missing ruby2_keywords calls in rspec-mocks
JonRowe added a commit that referenced this pull request Mar 31, 2022
@JonRowe
Changelog for #1464
2aebaa8
@JonRowe
Copy link
Member

JonRowe commented Mar 31, 2022

Released as 3.11.1

@graaff graaff mentioned this pull request Aug 3, 2022
Merged
pirj pushed a commit that referenced this pull request Nov 1, 2022
@JonRowe @pirj
Changelog for #1464
1309b32
pirj pushed a commit that referenced this pull request Nov 1, 2022
@JonRowe @pirj
Changelog for #1464
e8cc6b5
pirj pushed a commit that referenced this pull request Nov 1, 2022
@JonRowe @pirj
Changelog for #1464
e6ee41f
JonRowe added a commit that referenced this pull request Nov 10, 2022
@JonRowe
Changelog for #1464
c70aa17
@swrobel swrobel mentioned this pull request Feb 16, 2023
Closed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@JonRowe JonRowe Awaiting requested review from JonRowe

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@eregon @pirj @JonRowe