Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 10 additions & 1 deletion activejob/lib/active_job/serializers.rb
Original file line number Diff line number Diff line change
Expand Up @@ -76,11 +76,20 @@ def index_serializers
@serializers_index.clear
serializers.each do |s|
if s.respond_to?(:klass)
@serializers_index[s.klass] = s
begin
@serializers_index[s.klass] = s
rescue NotImplementedError => e
ActiveJob.deprecator.warn(
<<~MSG.squish
#{e.message}. This will raise an error in Rails 8.2.
MSG
)
end
elsif s.respond_to?(:klass, true)
klass = s.send(:klass)
ActiveJob.deprecator.warn(<<~MSG.squish)
#{s.class.name}#klass method should be public.
This will raise an error in Rails 8.2.
MSG
@serializers_index[klass] = s
end
Expand Down
10 changes: 10 additions & 0 deletions activejob/test/cases/serializers_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ def klass
end
end

class TestSerializerWithoutKlass < ActiveJob::Serializers::ObjectSerializer; end

setup do
@value_object = DummyValueObject.new 123
@original_serializers = ActiveJob::Serializers.serializers
Expand Down Expand Up @@ -93,4 +95,12 @@ def klass
ActiveJob::Serializers.add_serializers DummySerializer
end
end

test "raises a deprecation warning if the klass method doesn't exist" do
expected_message = "TestSerializerWithoutKlass should implement a public #klass method. This will raise an error in Rails 8.2"

assert_deprecated(expected_message, ActiveJob.deprecator) do
ActiveJob::Serializers.add_serializers TestSerializerWithoutKlass
end
end
end
2 changes: 2 additions & 0 deletions guides/source/8_1_release_notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,8 @@ Please refer to the [Changelog][active-job] for detailed changes.

### Deprecations

* Custom Active Job serializers must have a public `#klass` method.

### Notable changes

Action Text
Expand Down