Skip to content

Fix generic ActiveJob signatures #2696

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

Open
iamhaseebn wants to merge 1 commit into
base: main
Choose a base branch
from
+61 −6
Open

Fix generic ActiveJob signatures #2696

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 22 additions & 2 deletions lib/tapioca/dsl/compilers/active_job.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ def decorate

root.create_path(constant) do |job|
method = constant.instance_method(:perform)
constant_name = name_of(constant)
constant_name = type_name_of(constant) #: as !nil
parameters = compile_method_parameters_to_rbi(method)
return_type = compile_method_return_type_to_rbi(method)

Expand All @@ -69,7 +69,27 @@ def decorate

private

#: (Array[RBI::TypedParam] parameters, String? constant_name) -> Array[RBI::TypedParam]
# Resolves a constant into a valid Sorbet type reference,
# applying `T.untyped` for any unfixed generic type variables.
#
# @example
# type_name_of(StandardJob) # => "::StandardJob"
# type_name_of(GenericJob) # => "::SomeModule::GenericJob[T.untyped]"
#: (Module[top] constant) -> String?
def type_name_of(constant)
type_name = qualified_name_of(constant)
return type_name if !type_name || type_name.end_with?("]")

type_variables = Runtime::GenericTypeRegistry.lookup_type_variables(constant)
return type_name unless type_variables

type_variables = type_variables.reject(&:fixed?)
return type_name if type_variables.empty?

"#{type_name}[#{type_variables.map { "T.untyped" }.join(", ")}]"
end

#: (Array[RBI::TypedParam] parameters, String constant_name) -> Array[RBI::TypedParam]
def perform_later_parameters(parameters, constant_name)
if ::Gem::Requirement.new(">= 7.0").satisfied_by?(::ActiveJob.gem_version)
parameters.reject! { |typed_param| RBI::BlockParam === typed_param.param }
Expand Down
43 changes: 39 additions & 4 deletions spec/tapioca/dsl/compilers/active_job_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ def perform(user_id)

class NotifyJob
class << self
sig { params(user_id: T.untyped, block: T.nilable(T.proc.params(job: NotifyJob).void)).returns(T.any(NotifyJob, FalseClass)) }
sig { params(user_id: T.untyped, block: T.nilable(T.proc.params(job: ::NotifyJob).void)).returns(T.any(::NotifyJob, FalseClass)) }
def perform_later(user_id, &block); end

sig { params(user_id: T.untyped).returns(T.untyped) }
Expand All @@ -100,7 +100,7 @@ def perform(user_id)

class NotifyJob
class << self
sig { params(user_id: ::Integer, block: T.nilable(T.proc.params(job: NotifyJob).void)).returns(T.any(NotifyJob, FalseClass)) }
sig { params(user_id: ::Integer, block: T.nilable(T.proc.params(job: ::NotifyJob).void)).returns(T.any(::NotifyJob, FalseClass)) }
def perform_later(user_id, &block); end

sig { params(user_id: ::Integer).void }
Expand All @@ -111,6 +111,41 @@ def perform_now(user_id); end
assert_equal(expected, rbi_for(:NotifyJob))
end

it "generates correct RBI file for a generic job" do
Comment thread
paracycle marked this conversation as resolved.
add_ruby_file("job.rb", <<~RUBY)
require "active_record"

class GenericJob < ActiveJob::Base
extend T::Sig
extend T::Generic

Input = type_member
Fixed = type_member { { fixed: String } }
Output = type_member { { upper: ActiveRecord::Base } }

sig { params(value: Input).returns(Output) }
def perform(value)
raise NotImplementedError
end
end
RUBY

expected = template(<<~RBI)
# typed: strong

class GenericJob
class << self
sig { params(value: Input, block: T.nilable(T.proc.params(job: ::GenericJob[T.untyped, T.untyped]).void)).returns(T.any(::GenericJob[T.untyped, T.untyped], FalseClass)) }
def perform_later(value, &block); end

sig { params(value: Input).returns(Output) }
def perform_now(value); end
end
end
RBI
assert_equal(expected, rbi_for(:GenericJob))
end

it "generates correct RBI file for subclass with block argument" do
add_ruby_file("job.rb", <<~RUBY)
class NotifyJob < ActiveJob::Base
Expand All @@ -125,7 +160,7 @@ def perform(user_id, &blk)

class NotifyJob
class << self
sig { params(user_id: T.untyped, block: T.nilable(T.proc.params(job: NotifyJob).void)).returns(T.any(NotifyJob, FalseClass)) }
sig { params(user_id: T.untyped, block: T.nilable(T.proc.params(job: ::NotifyJob).void)).returns(T.any(::NotifyJob, FalseClass)) }
def perform_later(user_id, &block); end

sig { params(user_id: T.untyped).returns(T.untyped) }
Expand Down Expand Up @@ -153,7 +188,7 @@ def perform(user_id)

class NotifyJob
class << self
sig { params(user_id: ::Integer, block: T.nilable(T.proc.params(job: NotifyJob).void)).returns(T.any(NotifyJob, FalseClass)) }
sig { params(user_id: ::Integer, block: T.nilable(T.proc.params(job: ::NotifyJob).void)).returns(T.any(::NotifyJob, FalseClass)) }
def perform_later(user_id, &block); end

sig { params(user_id: ::Integer).void }
Expand Down
Loading