Skip to content
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

Add support for ActiveSupport classes in Sidekiq::Worker methods #2104

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Add support for ActiveSupport classes in Sidekiq::Worker methods #2104

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
16ddab2
Add support for ActiveSupport classes in Sidekiq::Worker #perform_at …
iMacTia Dec 2, 2024
8e26193
Update Tapioca::DslSpec as well
iMacTia Dec 2, 2024
c6f12ae
Update documentation with new signatures
iMacTia Dec 2, 2024
e28fb22
Fix Rubocop issue with updated doc comment
iMacTia Dec 2, 2024
06e9c54
Revert default behaviour, add new classes only when ActiveSupport is …
iMacTia Dec 3, 2024
7ff6fa9
Remove ActiveSupport when running SidekiqWorkerSpec
iMacTia Dec 3, 2024
dbe374c
Update Sidekiq::Worker tests expectations
iMacTia Dec 4, 2024
6ebe0ef
Check if correct class is defined
iMacTia Dec 10, 2024
11b40cb
Improve tests by using test isolation
iMacTia Dec 10, 2024
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
13 changes: 9 additions & 4 deletions lib/tapioca/dsl/compilers/sidekiq_worker.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,15 @@ module Compilers
# sig { params(customer_id: T.untyped).returns(String) }
# def self.perform_async(customer_id); end
#
# sig { params(interval: T.any(DateTime, Time), customer_id: T.untyped).returns(String) }
# sig do
# params(
# interval: T.any(DateTime, Time, ActiveSupport::TimeWithZone),
# customer_id: T.untyped
# ).returns(String)
# end
# def self.perform_at(interval, customer_id); end
#
# sig { params(interval: Numeric, customer_id: T.untyped).returns(String) }
# sig { params(interval: T.any(Numeric, ActiveSupport::Duration), customer_id: T.untyped).returns(String) }
# def self.perform_in(interval, customer_id); end
# end
# ~~~
Expand All @@ -54,11 +59,11 @@ def decorate
# accept a datetime, time, or numeric but we're typing them differently so they
# semantically make sense.
at_params = [
create_param("interval", type: "T.any(DateTime, Time)"),
create_param("interval", type: "T.any(DateTime, Time, ActiveSupport::TimeWithZone)"),
*async_params,
]
in_params = [
create_param("interval", type: "Numeric"),
create_param("interval", type: "T.any(Numeric, ActiveSupport::Duration)"),
*async_params,
]

Expand Down
4 changes: 2 additions & 2 deletions manual/compiler_sidekiqworker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ class NotifierWorker
sig { params(customer_id: T.untyped).returns(String) }
def self.perform_async(customer_id); end

sig { params(interval: T.any(DateTime, Time), customer_id: T.untyped).returns(String) }
sig { params(interval: T.any(DateTime, Time, ActiveSupport::TimeWithZone), customer_id: T.untyped).returns(String) }
def self.perform_at(interval, customer_id); end

sig { params(interval: Numeric, customer_id: T.untyped).returns(String) }
sig { params(interval: T.any(T.any(Numeric, ActiveSupport::Duration), ActiveSupport::Duration), customer_id: T.untyped).returns(String) }
def self.perform_in(interval, customer_id); end
end
~~~
4 changes: 2 additions & 2 deletions spec/tapioca/cli/dsl_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1158,10 +1158,10 @@ class << self
sig { params(foo: T.untyped, bar: T.untyped).returns(String) }
def perform_async(foo, bar); end

sig { params(interval: T.any(DateTime, Time), foo: T.untyped, bar: T.untyped).returns(String) }
sig { params(interval: T.any(DateTime, Time, ActiveSupport::TimeWithZone), foo: T.untyped, bar: T.untyped).returns(String) }
def perform_at(interval, foo, bar); end

sig { params(interval: Numeric, foo: T.untyped, bar: T.untyped).returns(String) }
sig { params(interval: T.any(Numeric, ActiveSupport::Duration), foo: T.untyped, bar: T.untyped).returns(String) }
def perform_in(interval, foo, bar); end
end

Expand Down
14 changes: 7 additions & 7 deletions spec/tapioca/dsl/compilers/sidekiq_worker_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,10 +68,10 @@ class << self
sig { params(customer_id: T.untyped).returns(String) }
def perform_async(customer_id); end

sig { params(interval: T.any(DateTime, Time), customer_id: T.untyped).returns(String) }
sig { params(interval: T.any(DateTime, Time, ActiveSupport::TimeWithZone), customer_id: T.untyped).returns(String) }
def perform_at(interval, customer_id); end

sig { params(interval: Numeric, customer_id: T.untyped).returns(String) }
sig { params(interval: T.any(Numeric, ActiveSupport::Duration), customer_id: T.untyped).returns(String) }
def perform_in(interval, customer_id); end
end
end
Expand Down Expand Up @@ -100,10 +100,10 @@ class << self
sig { params(customer_id: ::Integer).returns(String) }
def perform_async(customer_id); end

sig { params(interval: T.any(DateTime, Time), customer_id: ::Integer).returns(String) }
sig { params(interval: T.any(DateTime, Time, ActiveSupport::TimeWithZone), customer_id: ::Integer).returns(String) }
def perform_at(interval, customer_id); end

sig { params(interval: Numeric, customer_id: ::Integer).returns(String) }
sig { params(interval: T.any(Numeric, ActiveSupport::Duration), customer_id: ::Integer).returns(String) }
def perform_in(interval, customer_id); end
end
end
Expand Down Expand Up @@ -133,10 +133,10 @@ class << self
sig { params(customer_id: T.untyped).returns(String) }
def perform_async(customer_id); end

sig { params(interval: T.any(DateTime, Time), customer_id: T.untyped).returns(String) }
sig { params(interval: T.any(DateTime, Time, ActiveSupport::TimeWithZone), customer_id: T.untyped).returns(String) }
def perform_at(interval, customer_id); end

sig { params(interval: Numeric, customer_id: T.untyped).returns(String) }
sig { params(interval: T.any(Numeric, ActiveSupport::Duration), customer_id: T.untyped).returns(String) }
def perform_in(interval, customer_id); end
end
end
Expand Down Expand Up @@ -171,7 +171,7 @@ class << self
sig { params(customer_id: T.untyped, other_id: T.untyped).returns(String) }
def perform_async(customer_id, other_id); end

sig { params(interval: Numeric, customer_id: T.untyped, other_id: T.untyped).returns(String) }
sig { params(interval: T.any(Numeric, ActiveSupport::Duration), customer_id: T.untyped, other_id: T.untyped).returns(String) }
def perform_in(interval, customer_id, other_id); end
end
end
Expand Down