Skip to content

fix: remove call to ActiveSupport::Notifications.notifier#synchronize deprecated in Rails 7.2 #707

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

Merged
arielvalentin merged 6 commits into from
Oct 31, 2023
Merged

fix: remove call to ActiveSupport::Notifications.notifier#synchronize deprecated in Rails 7.2 #707

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5f7808d
wrap call to depcrecated private API behind version conditional
octokatherine Oct 25, 2023
089d112
convert Rails version string to Gem::Version
octokatherine Oct 25, 2023
f630371
fix module access?
octokatherine Oct 26, 2023
bb699be
check for synchronize method instead of Rails version
octokatherine Oct 29, 2023
5b29795
Merge branch 'main' into rm-synchronize-call
arielvalentin Oct 30, 2023
8c2c2e7
add comment
octokatherine Oct 31, 2023
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
28 changes: 15 additions & 13 deletions ...tation/active_support/lib/opentelemetry/instrumentation/active_support/span_subscriber.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,19 +30,21 @@ def self.subscribe(

subscriber_object = ::ActiveSupport::Notifications.subscribe(pattern, subscriber)

::ActiveSupport::Notifications.notifier.synchronize do
subscribers = ::ActiveSupport::Notifications.notifier.instance_variable_get(:@string_subscribers)[pattern]

if subscribers.nil?
OpenTelemetry.handle_error(
message: 'Unable to move OTEL ActiveSupport Notifications subscriber to the front of the notifications list which may cause incomplete traces.' \
'Please report an issue here: ' \
'https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues/new?labels=bug&template=bug_report.md&title=ActiveSupport%20Notifications%20subscribers%20list%20is%20nil'
)
else
subscribers.unshift(
subscribers.delete(subscriber_object)
)
if Gem::Version.new(::Rails.version) < Gem::Version.new('7.2')
Copy link
Contributor

@simi simi Oct 28, 2023

Choose a reason for hiding this comment

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

Not sure what's best practice, but alternative would be to check if synchronize method is present to make it more like feature detection instead of version detection.

Copy link
Contributor Author

@octokatherine octokatherine Oct 29, 2023

Choose a reason for hiding this comment

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

I like that idea, I'll update it

::ActiveSupport::Notifications.notifier.synchronize do
subscribers = ::ActiveSupport::Notifications.notifier.instance_variable_get(:@string_subscribers)[pattern]

if subscribers.nil?
OpenTelemetry.handle_error(
message: 'Unable to move OTEL ActiveSupport Notifications subscriber to the front of the notifications list which may cause incomplete traces.' \
'Please report an issue here: ' \
'https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues/new?labels=bug&template=bug_report.md&title=ActiveSupport%20Notifications%20subscribers%20list%20is%20nil'
)
else
subscribers.unshift(
subscribers.delete(subscriber_object)
)
end
end
end
subscriber_object
Expand Down