ActionMailer::Base can unregister observer(s) and interceptor(s). #32207

kmiyake · 2018-03-08T22:04:09Z

Summary

This adds the ability to unregister previously registered observer(s) and interceptor(s).

Other Information

This changes was re-implemented this.

One or multiple mail observers can be unregistered using `ActionMailer::Base.unregister_observers` or `ActionMailer::Base.unregister_observer`. One or multiple mail interceptors can be unregistered using `ActionMailer::Base.unregister_interceptors` or `ActionMailer::Base.unregister_interceptor`. For preview interceptors, it's possible to use `ActionMailer::Base.unregister_preview_interceptors` or `ActionMailer::Base.unregister_preview_interceptor`.

rails-bot · 2018-03-08T22:04:12Z

Thanks for the pull request, and welcome! The Rails team is excited to review your changes, and you should hear from @sgrif (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

This repository is being automatically checked for code quality issues using Code Climate. You can see results for this analysis in the PR status below. Newly introduced issues should be fixed before a Pull Request is considered ready to review.

Please see the contribution instructions for more information.

rafaelfranca · 2018-03-08T22:31:03Z

actionmailer/test/base_test.rb

+      mail.deliver_now
+    end
+
+    ActionMailer::Base.unregister_observer(MyObserver)


This needs to be called inside the ensure otherwise if the test fail in the lines above this the observer will still be registered.

Thanks for your review. I'll fix it as soon as possible.

@rafaelfranca
How about the commit below.
1286c12

sikachu

Looks good to me.

@kmiyake do you mind adding changeling for this feature as well?

eugeneius · 2018-05-29T13:59:51Z

actionmailer/CHANGELOG.md

+    This makes it possible to dynamically add and remove email observers and
+    interceptors at runtime in the same way they're registered.
+
+    *Kota Miyake*


Since this builds on #18446, could you add the original author's name here too?

Since this builds on #18446, could you add the original author's name here too?

Fixed.

kmiyake · 2018-05-30T13:26:16Z

@kmiyake do you mind adding changeling for this feature as well?

Done.

**Only intercept when necessary** This was the original intention but after many attempts realised that the initializers are called before any kind of mocking/stubbing goes on in the RSpec test. So we would never be able to control whether the interceptor is registered within our tests. So next we looked at ignoring the interceptor and using either RSpec filters or hooks to control the registering and unregistering of the interceptor. However we hit an issue there as well. Registering the interceptor was fine, but unregistering was only merged into ActionMailer in May 2018 (rails/rails#32207). So we'd be left with having to also introduce a monkey patch to ensure the tests were clean and the interceptor was removed. 😩 This seemed overkill for what we wanted to achieve. Hence we hit on a final hack, which is to always register the interceptor in the initializer if we are running in "test". **Fixing the test** Realised when working through trying to control whether the interceptor is registered or not that the previous version of the test wasn't actually testing its intent. It is based on the fact that the last email cache feature is enabled, and as such when we check the response we expect to see some email content. However when the interceptor was not being registered `LastEmailCache` was just returning its default error message. As the test was just comparing the response to `LastEmailCache.last_email_json` they were always going to match whether the interceptor was registered or not. So this also tweaks the test such that it matches the intent of checking that the response contains content from an actual sent email.

rails-bot assigned sgrif Mar 8, 2018

rafaelfranca requested changes Mar 8, 2018

View reviewed changes

Ensure to be reset registered observer(s) and interceptor(s)

1286c12

sikachu reviewed May 28, 2018

View reviewed changes

Add explanation to CHANGELOG

5d8a8b7

eugeneius reviewed May 29, 2018

View reviewed changes

Add original author's name

05dea30

rafaelfranca approved these changes May 30, 2018

View reviewed changes

rafaelfranca merged commit b74edd3 into rails:master May 30, 2018

ActionMailer::Base can unregister observer(s) and interceptor(s). #32207

ActionMailer::Base can unregister observer(s) and interceptor(s). #32207

kmiyake commented Mar 8, 2018

rails-bot commented Mar 8, 2018

rafaelfranca Mar 8, 2018

kmiyake Mar 9, 2018

kmiyake Mar 19, 2018 •

edited

sikachu left a comment

eugeneius May 29, 2018

kmiyake May 30, 2018

kmiyake commented May 30, 2018

ActionMailer::Base can unregister observer(s) and interceptor(s). #32207

ActionMailer::Base can unregister observer(s) and interceptor(s). #32207

Conversation

kmiyake commented Mar 8, 2018

Summary

Other Information

rails-bot commented Mar 8, 2018

rafaelfranca Mar 8, 2018

Choose a reason for hiding this comment

kmiyake Mar 9, 2018

Choose a reason for hiding this comment

kmiyake Mar 19, 2018 • edited

Choose a reason for hiding this comment

sikachu left a comment

Choose a reason for hiding this comment

eugeneius May 29, 2018

Choose a reason for hiding this comment

kmiyake May 30, 2018

Choose a reason for hiding this comment

kmiyake commented May 30, 2018

kmiyake Mar 19, 2018 •

edited