Provide deprecation on ProxyDepositListener #5550
Conversation
hackartisan
force-pushed
the
5457-deprecate-listener
branch
from
2d97e0f
to
621fbf5
Compare
hackartisan
force-pushed
the
5457-deprecate-listener
branch
from
621fbf5
to
42c13ab
Compare
| DefaultMiddlewareStack is configured to use \ | ||
| Hyrax::Actors::TransferRequestActor and unregister this listener \ | ||
| in config/initializers/listeners.rb by adding the line: \n | ||
| Hyrax.publisher.unsubscribe(Hyrax::Listeners::ProxyDepositListener.new)" |
There was a problem hiding this comment.
Does this require that they copy listeners.rb to their /config/initializers? Or will the engine version of this file run first and then the local one of the same name will run second?
There was a problem hiding this comment.
If having a file of the same name causes an override of Hyrax's listeners.rb initializer, would it work to recommend they create a local file called config/initializers/listeners_ext.rb and put the unsubscribe there?
There was a problem hiding this comment.
These are great questions and I spent some time trying this recommendation.
The engine initializers run first. The existence of an initializer by the same name in an app is fine; both load. However, it seems like you maybe have to unsubscribe the same instance of the listener that you subscribed? For example, if I put an unsubscribe in the local initializer it doesn't affect the listener list. If I put another subscribe of the same listener then it's in there twice (once for each instance).
So the options I see are
- Don't subscribe the listener in our initializer. If someone has for some reason subscribed it in their own, they will see the deprecation. Probably no one has done this and this means no one will ever see the deprecation.
- Have a noisy deprecation no one can do anything about. I guess make it a lot shorter.
There was a problem hiding this comment.
The first option has a great deal of appeal. I wouldn't like have a noise deprecation with no way to quiet it.
followup to #5529
related documentation: https://dry-rb.org/gems/dry-events/0.2/