ryanwinchester

ryanwinchester

`Workflow.add_cascade` dialyzer error when adding deps

When adding :deps to Workflow.add_cascade/4 I get a LSP/Dialyzer error

The function call will not succeed.

Oban.Pro.Workflow.add_cascade(
  %Oban.Pro.Workflow{
    :changesets => [
      %Ecto.Changeset{
        :action => atom(),
        :changes => %{atom() => _},
        :constraints => [
          %{
            :constraint =>
              binary()
              | %Regex{
                  :opts => binary() | [any()],
                  :re_pattern => _,
                  :re_version => _,
                  :source => binary()
                },
            :error_message => binary(),
            :error_type => atom(),
            :field => atom(),
            :match => :exact | :prefix | :suffix,
            :type => :check | :exclusion | :foreign_key | :unique
          }
        ],
        :data => %Oban.Job{
          :__meta__ => _,
          :args => map(),
          :attempt => non_neg_integer(),
          :attempted_at =>
            nil
            | %DateTime{
                :calendar => atom(),
                :day => pos_integer(),
                :hour => non_neg_integer(),
                :microsecond => {non_neg_integer(), non_neg_integer()},
                :minute => non_neg_integer(),
                :month => pos_integer(),
                :second => non_neg_integer(),
                :std_offset => integer(),
                :time_zone => binary(),
                :utc_offset => integer(),
                :year => integer(),
                :zone_abbr => binary()
              },
          :attempted_by => nil | [binary()],
          :cancelled_at =>
            nil
            | %DateTime{
                :calendar => atom(),
                :day => pos_integer(),
                :hour => non_neg_integer(),
                :microsecond => {non_neg_integer(), non_neg_integer()},
                :minute => non_neg_integer(),
                :month => pos_integer(),
                :second => non_neg_integer(),
                :std_offset => integer(),
                :time_zone => binary(),
                :utc_offset => integer(),
                :year => integer(),
                :zone_abbr => binary()
              },
          :completed_at =>
            nil
            | %DateTime{
                :calendar => atom(),
                :day => pos_integer(),
                :hour => non_neg_integer(),
                :microsecond => {non_neg_integer(), non_neg_integer()},
                :minute => non_neg_integer(),
                :month => pos_integer(),
                :second => non_neg_integer(),
                :std_offset => integer(),
                :time_zone => binary(),
                :utc_offset => integer(),
                :year => integer(),
                :zone_abbr => binary()
              },
          :conf =>
            nil
            | %Oban.Config{
                :dispatch_cooldown => pos_integer(),
                :engine => atom(),
                :get_dynamic_repo => nil | (-> atom() | pid()) | {atom(), atom(), [any()]},
                :insert_trigger => boolean(),
                :log =>
                  :alert
                  | :critical
                  | :debug
                  | :emergency
                  | :error
                  | false
                  | :info
                  | :notice
                  | :warn
                  | :warning,
                :name => _,
                :node => binary(),
                :notifier => {atom(), Keyword.t()},
                :peer => {atom(), Keyword.t()},
                :plugins => [atom() | {atom() | Keyword.t()}],
                :prefix => false | binary(),
                :queues => Keyword.t(Keyword.t()),
                :repo => atom(),
                :shutdown_grace_period => non_neg_integer(),
                :stage_interval => timeout(),
                :testing => :disabled | :inline | :manual
              },
          :conflict? => boolean(),
          :discarded_at =>
            nil
            | %DateTime{
                :calendar => atom(),
                :day => pos_integer(),
                :hour => non_neg_integer(),
                :microsecond => {non_neg_integer(), non_neg_integer()},
                :minute => non_neg_integer(),
                :month => pos_integer(),
                :second => non_neg_integer(),
                :std_offset => integer(),
                :time_zone => binary(),
                :utc_offset => integer(),
                :year => integer(),
                :zone_abbr => binary()
              },
          :errors => [
            %{
              :at => %DateTime{
                :calendar => atom(),
                :day => pos_integer(),
                :hour => non_neg_integer(),
                :microsecond => {non_neg_integer(), non_neg_integer()},
                :minute => non_neg_integer(),
                :month => pos_integer(),
                :second => non_neg_integer(),
                :std_offset => integer(),
                :time_zone => binary(),
                :utc_offset => integer(),
                :year => integer(),
                :zone_abbr => binary()
              },
              :attempt => pos_integer(),
              :error => binary()
            }
          ],
          :id => pos_integer(),
          :inserted_at => %DateTime{
            :calendar => atom(),
            :day => pos_integer(),
            :hour => non_neg_integer(),
            :microsecond => {non_neg_integer(), non_neg_integer()},
            :minute => non_neg_integer(),
            :month => pos_integer(),
            :second => non_neg_integer(),
            :std_offset => integer(),
            :time_zone => binary(),
            :utc_offset => integer(),
            :year => integer(),
            :zone_abbr => binary()
          },
          :max_attempts => pos_integer(),
          :meta => map(),
          :priority => 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9,
          :queue => binary(),
          :replace =>
            nil
            | [
                [
                  :args
                  | :max_attempts
                  | :meta
                  | :priority
                  | :queue
                  | :scheduled_at
                  | :tags
                  | :worker
                ]
                | {:available
                   | :cancelled
                   | :completed
                   | :discarded
                   | :executing
                   | :retryable
                   | :scheduled,
                   [
                     [
                       :args
                       | :max_attempts
                       | :meta
                       | :priority
                       | :queue
                       | :scheduled_at
                       | :tags
                       | :worker
                     ]
                   ]}
              ],
          :scheduled_at => %DateTime{
            :calendar => atom(),
            :day => pos_integer(),
            :hour => non_neg_integer(),
            :microsecond => {non_neg_integer(), non_neg_integer()},
            :minute => non_neg_integer(),
            :month => pos_integer(),
            :second => non_neg_integer(),
            :std_offset => integer(),
            :time_zone => binary(),
            :utc_offset => integer(),
            :year => integer(),
            :zone_abbr => binary()
          },
          :state => binary(),
          :tags => [binary()],
          :unique =>
            nil
            | %{
                :fields => [:args | :meta | :queue | :worker],
                :keys => [atom()],
                :period =>
                  :infinity
                  | pos_integer()
                  | {pos_integer(),
                     :day
                     | :days
                     | :hour
                     | :hours
                     | :minute
                     | :minutes
                     | :second
                     | :seconds
                     | :week
                     | :weeks},
                :states => [
                  [
                    :available
                    | :cancelled
                    | :completed
                    | :discarded
                    | :executing
                    | :retryable
                    | :scheduled
                  ]
                ],
                :timestamp => :inserted_at | :scheduled_at
              },
          :unsaved_error =>
            nil
            | %{
                :kind => :error | :exit | :throw | {:EXIT, pid()},
                :reason => _,
                :stacktrace => [
                  {(... -> any), [any()] | non_neg_integer(), Keyword.t()}
                  | {atom(), atom(), [any()] | non_neg_integer(), Keyword.t()}
                ]
              },
          :worker => binary()
        },
        :empty_values => _,
        :errors => Keyword.t({binary(), Keyword.t()}),
        :filters => %{atom() => _},
        :params => nil | %{binary() => _},
        :prepare => [
          (%Ecto.Changeset{:action => atom(), :changes => map(), _ => _} ->
             %Ecto.Changeset{:action => atom(), :changes => map(), _ => _})
        ],
        :repo => atom(),
        :repo_opts => Keyword.t(),
        :required => [atom()],
        :types => %{
          atom() =>
            atom()
            | {:array | :assoc | :embed | :in | :map | :parameterized | :supertype | :try,
               _}
        },
        :valid? => boolean(),
        :validations => Keyword.t()
      },
      ...
    ],
    :check_deps => boolean(),
    :grafts => _,
    :id => binary(),
    :names => %MapSet{:map => MapSet.internal(_) | :sets.set(_)},
    :opts => map(),
    :subs => map()
  },
  :orders,
  (_ -> {[any()], [any()]}),
  [{:deps, :init}]
)

breaks the contract
(t(), name(), cascade_capture(), add_cascade_opts()) :: t()

Marked As Solved

al2o3cr

al2o3cr

I believe there’s a bug in the type for add_cascade_opts():

@type add_cascade_opts() :: [Oban.Job.option() | add_opts()]

@type add_opts() :: [
  deps: name() | [name()],
  ignore_cancelled: boolean(),
  ignore_deleted: boolean(),
  ignore_discarded: boolean()
]

The | operator normally expects options also separated with |, like Oban.Job.option():

@type option() ::
  {:args, args()}
  | {:max_attempts, pos_integer()}
  | {:meta, map()}
  | {:priority, 0..9}
  | etc

As currently written, the type means “a list where elements are either tuples from Oban.Job.option() or a keyword list shaped like add_opts()”, so something like [[deps: :init]] would match the current spec. (but presumably fail catastrophically where options are parsed)

I don’t currently have access to Oban Pro, but updating the definition of add_cascade_opts would likely remove the error you’re seeing:

@type add_cascade_opts() :: [Oban.Job.option() | add_opt()]

@type add_opts() :: [add_opt()]

@type add_opt() ::
  {:deps, name() | [name()]}
  | {:ignore_cancelled, boolean()}
  | {:ignore_deleted, boolean()}
  | {:ignore_discarded, boolean()}

Beware that changes to files in deps/ won’t get picked up by Dialyzer until you nuke _build and any cached PLTs.

Also Liked

sorentwo

sorentwo

Oban Core Team

Thanks for reporting the issue (and thanks @al2o3cr for the resolution). This is fixed for the Pro v1.6 release :slightly_smiling_face:

Where Next?

Popular in Questions Top

RisingFromAshes
I’ve read in another post that it may be possible with a router helper - but I couldn’t find an appropriate one, and tbh, I’m still just ...
New
jononomo
I am trying to figure out how Mix knows whether the environment is test, dev, or prod – where is this set? Thanks.
New
jononomo
For some reason my phoenix channels are working for me in my local dev environment, but as soon as I deploy via Docker, I get a 403 error...
New
Darmani72
If I have a post route which an argument: post /my_post_route/:my_param1, MyController.my_post_handler How would get the post params ...
New
stefanluptak
Hello everybody, usually, I use a 29" ultra-wide monitor for VSCode which can easily accomodate explorer (files panel) + file with code ...
New
siddhant3030
Hi, I have to write a raw query for one of my project. But till now I have used ecto queries and don’t have much experience writing raw ...
New
albydarned
Hello all! I am typing this post from my new MacBook Pro with the M1 chip. I’m loving it so far, and will probably use it as my daily dr...
New

Other popular topics Top

Qqwy
Update: How to use the Blogs & Podcasts section You can post links to your blog posts or podcasts either in one of the Official Blog...
3271 131117 1222
New
nsuchy
Hi. I’ve noticed that Windows Powershell has it’s own IEX command and you cannot access Elixir’s IEX due to the conflict. This isn’t a cr...
New
gshaw
What is the idiomatic way of matching for not nil in Elixir? E.g., First way: defp halt_if_not_signed_in(conn, signed_in_account) when...
New
sen
Hi All, I set a environment variables in dev.exs , like below code. when i start server, how can i set the ${enable} value? thanks. d...
New
saif
Hello everyone, Long time lurker first time poster here. I’ve recently begun working on Elixir full-time again! :raised_hands: It’s been...
New
romenigld
I am trying to run a deploy with docker and I successfully runned with this command: docker build -t romenigld/blog-prod . but when I t...
New

We're in Beta

About us Mission Statement