Add `net/smtp` gem for bug report templates to support Ruby 3.1 #42366

yahonda · 2021-06-02T23:25:27Z

Summary

Ruby 3.1 extracts some gems to bundled one, which requires adding these gems to Gemfile explicitly.
net/smtp is one of them, which affected Action Mailbox bug report templates.

Steps to reproduce

Install ruby 3.1.0dev

git clone https://github.com/rails/rails.git
cd rails/guides
ruby bug_report_templates/action_mailbox_gem.rb
ruby bug_report_templates/action_mailbox_main.rb

This commit addresses the following error cannot load such file -- net/smtp (LoadError)

$ ruby bug_report_templates/action_mailbox_gem.rb
... snip ...
Using rails 6.1.0
/home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:332:in `require': cannot load such file -- net/smtp (LoadError)
	from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:332:in `block in require'
	from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:299:in `load_dependency'
	from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:332:in `require'
	from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/mail-2.7.1/lib/mail.rb:9:in `<module:Mail>'
	from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/mail-2.7.1/lib/mail.rb:3:in `<top (required)>'
	from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:332:in `require'
	from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:332:in `block in require'
	from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:299:in `load_dependency'
	from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:332:in `require'
	from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/actionmailbox-6.1.0/lib/action_mailbox/mail_ext.rb:3:in `<top (required)>'
	from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:332:in `require'
	from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:332:in `block in require'
	from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:299:in `load_dependency'
	from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:332:in `require'
	from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/actionmailbox-6.1.0/lib/action_mailbox.rb:3:in `<top (required)>'
	from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:332:in `require'
	from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:332:in `block in require'
	from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:299:in `load_dependency'
	from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:332:in `require'
	from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/actionmailbox-6.1.0/lib/action_mailbox/engine.rb:9:in `<top (required)>'
	from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:332:in `require'
	from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:332:in `block in require'
	from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:299:in `load_dependency'
	from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:332:in `require'
	from bug_report_templates/action_mailbox_gem.rb:17:in `<main>'

Refer
https://bugs.ruby-lang.org/issues/17873
ruby/ruby#4530

HParker · 2021-06-02T23:38:15Z

I saw this failing in the guides build as well, thanks for fixing this @yahonda!

Looks like the other guides builds for 3.0 and 2.7 are unhappy though due to net-protocol. Hopefully that isn't too difficult to fix.

yahonda · 2021-06-03T00:14:39Z

Let me take a look at these failures for Ruby 2.7 and 3.0.

https://buildkite.com/rails/rails/builds/77864#a957003c-605f-45e7-a3d8-e02a5a78e23e

Traceback (most recent call last):
	9: from bug_report_templates/action_mailbox_gem.rb:5:in `<main>'
	8: from /usr/local/bundle/gems/bundler-2.2.9/lib/bundler/inline.rb:54:in `gemfile'
	7: from /usr/local/bundle/gems/bundler-2.2.9/lib/bundler/settings.rb:115:in `temporary'
	6: from /usr/local/bundle/gems/bundler-2.2.9/lib/bundler/inline.rb:70:in `block in gemfile'
	5: from /usr/local/bundle/gems/bundler-2.2.9/lib/bundler/runtime.rb:26:in `setup'
	4: from /usr/local/bundle/gems/bundler-2.2.9/lib/bundler/runtime.rb:26:in `map'
	3: from /usr/local/bundle/gems/bundler-2.2.9/lib/bundler/spec_set.rb:150:in `each'
	2: from /usr/local/bundle/gems/bundler-2.2.9/lib/bundler/spec_set.rb:150:in `each'
	1: from /usr/local/bundle/gems/bundler-2.2.9/lib/bundler/runtime.rb:31:in `block in setup'
/usr/local/bundle/gems/bundler-2.2.9/lib/bundler/runtime.rb:302:in `check_for_activated_spec!': You have already activated timeout 0.1.0, but your Gemfile requires timeout 0.1.1. Since timeout is a default gem, you can either remove your dependency on it or try updating to a newer version of bundler that supports timeout as a default gem. (Gem::LoadError)

zzak · 2021-06-03T02:47:46Z

guides/bug_report_templates/action_mailbox_main.rb

@@ -9,6 +9,7 @@

  gem "rails", github: "rails/rails", branch: "main"
  gem "sqlite3"
+  gem "net-smtp"


@yahonda Should this be added to actionmailbox.gemspec?

Thanks for the review. I've found actonmailbox.gemspec already has dependency on mail gem.

rails/actionmailbox/actionmailbox.gemspec

Line 40 in 3c165ad

s.add_dependency "mail", ">= 2.7.1"

s.add_dependency "mail", ">= 2.7.1"

Once the newer versions of mail gem which includes this pull request mikel/mail#1439 ,
at least we do not need to add another dependency to net/smtp gem inside of actonmailbox.gemspec .

I prefer to adding dependency inside of each test file by using require 'bundler/inline' like 48f2f1aa078 did for Gemfile. We can remove these dependency once newer verions of mail is released.

If we can remove these dependency once newer verions of mail is released, how about adding the mail with head dependency with the note instead?

ah mikel/mail#1439 isn't merged in master yet, nvm.

Ruby 3.1 extracts some gems to bundled one, which requires to add these gems to Gemfile explicitly. `net/smtp` is one of them, which affected Action Mailbox bug report templates. * Steps to reproduce Install `ruby 3.1.0dev` ``` git clone https://github.com/rails/rails.git cd rails/guides ruby bug_report_templates/action_mailbox_gem.rb ruby bug_report_templates/action_mailbox_main.rb ``` * This commit addresses the following error `cannot load such file -- net/smtp (LoadError)` ``` $ ruby bug_report_templates/action_mailbox_gem.rb ... snip ... Using rails 6.1.0 /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:332:in `require': cannot load such file -- net/smtp (LoadError) from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:332:in `block in require' from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:299:in `load_dependency' from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:332:in `require' from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/mail-2.7.1/lib/mail.rb:9:in `<module:Mail>' from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/mail-2.7.1/lib/mail.rb:3:in `<top (required)>' from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:332:in `require' from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:332:in `block in require' from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:299:in `load_dependency' from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:332:in `require' from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/actionmailbox-6.1.0/lib/action_mailbox/mail_ext.rb:3:in `<top (required)>' from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:332:in `require' from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:332:in `block in require' from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:299:in `load_dependency' from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:332:in `require' from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/actionmailbox-6.1.0/lib/action_mailbox.rb:3:in `<top (required)>' from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:332:in `require' from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:332:in `block in require' from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:299:in `load_dependency' from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:332:in `require' from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/actionmailbox-6.1.0/lib/action_mailbox/engine.rb:9:in `<top (required)>' from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:332:in `require' from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:332:in `block in require' from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:299:in `load_dependency' from /home/yahonda/.rbenv/versions/3.1.0-dev/lib/ruby/gems/3.1.0/gems/activesupport-6.1.0/lib/active_support/dependencies.rb:332:in `require' from bug_report_templates/action_mailbox_gem.rb:17:in `<main>' ``` * Added comment when this dependency can be removed based on https://bugs.ruby-lang.org/issues/17873 Refer ruby/ruby#4530 rails#42308 Co-authored-by: Jean Boussier <jean.boussier@gmail.com>

yahonda · 2021-06-06T15:39:10Z

Updated this pull request referring to #42308 .
Now all CI are green.

…_ruby31 Add `net/smtp` gem for bug report templates to support Ruby 3.1

See the following: * rails/rails#42366 * mikel/mail#1439 * https://bugs.ruby-lang.org/issues/17873 In essence, the net/smtp gem config was changed in ruby 3.1 and the mail gem needs to merge in their fix.

rails-bot bot added the docs label Jun 2, 2021

ghiculescu approved these changes Jun 2, 2021

View reviewed changes

zzak reviewed Jun 3, 2021

View reviewed changes

yahonda force-pushed the net_smtp_willbe_bundled_gem_in_ruby31 branch 2 times, most recently from c6a7930 to e51a620 Compare June 6, 2021 14:49

yahonda force-pushed the net_smtp_willbe_bundled_gem_in_ruby31 branch from e51a620 to 255e3b9 Compare June 6, 2021 15:22

HParker approved these changes Jun 6, 2021

View reviewed changes

zzak approved these changes Jun 7, 2021

View reviewed changes

kamipo merged commit 2fd78b1 into rails:main Jun 7, 2021

yahonda deleted the net_smtp_willbe_bundled_gem_in_ruby31 branch June 23, 2021 05:53

kamipo added a commit that referenced this pull request Jul 24, 2021

Merge pull request #42366 from yahonda/net_smtp_willbe_bundled_gem_in…

4d61750

…_ruby31 Add `net/smtp` gem for bug report templates to support Ruby 3.1

dillonwelch mentioned this pull request Oct 11, 2021

Add fix to ruby-head issue devise-security/devise-security#328

Merged

jrochkind mentioned this pull request Dec 29, 2021

test on Rails 7 sciencehistory/kithe#137

Merged

halan mentioned this pull request Feb 8, 2022

Task-1 feperessim/codeminer42-trainee-semana-4#1

Merged

This was referenced Mar 2, 2022

Ruby 3.1 smoke test mastodon/mastodon#17680

Closed

Ruby 3.1.1 Smoketesting mastodon/mastodon#17681

Closed

vishnu-narayanan mentioned this pull request Oct 5, 2022

chore: upgrade ruby to 3.1.3 chatwoot/chatwoot#5555

Merged

10 tasks

Add `net/smtp` gem for bug report templates to support Ruby 3.1 #42366

Add `net/smtp` gem for bug report templates to support Ruby 3.1 #42366

yahonda commented Jun 2, 2021

HParker commented Jun 2, 2021

yahonda commented Jun 3, 2021

zzak Jun 3, 2021

yahonda Jun 3, 2021

kamipo Jun 3, 2021

kamipo Jun 3, 2021

yahonda commented Jun 6, 2021

Add net/smtp gem for bug report templates to support Ruby 3.1 #42366

Add net/smtp gem for bug report templates to support Ruby 3.1 #42366

Conversation

yahonda commented Jun 2, 2021

Summary

HParker commented Jun 2, 2021

yahonda commented Jun 3, 2021

zzak Jun 3, 2021

Choose a reason for hiding this comment

yahonda Jun 3, 2021

Choose a reason for hiding this comment

kamipo Jun 3, 2021

Choose a reason for hiding this comment

kamipo Jun 3, 2021

Choose a reason for hiding this comment

yahonda commented Jun 6, 2021

Add `net/smtp` gem for bug report templates to support Ruby 3.1 #42366

Add `net/smtp` gem for bug report templates to support Ruby 3.1 #42366