Skip to content

Create Rubocop rule when enabling LB for idempotnent jobs

What does this MR do?

Create Rubocop rule to warn developers that they need to explicitly set including_scheduled: true when enabling LB for idempotent jobs. This is needed because jobs that are utilizing load balancing are delayed and scheduled 1s in the future in order to give the replication process time to complete.

If we want to deduplicate those workers, we need to explicitly enable deduplication for them.

https://docs.gitlab.com/ee/development/sidekiq_style_guide.html#scheduling-jobs-in-the-future

This COP detects:

  • If class is a worker
  • if worker includes ApplicationWorker
  • If worker utilizes load balancing capabilities (data_consistency is either :sticky or :delayed)
  • If a worker is idempotent!
# BAD
data_consistency :delayed

idempotent!
^^^^^^^^^^^
# BAD
data_consistency :delayed

deduplicate :until_executing
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
idempotent!
# BAD
data_consistency :delayed

deduplicate :until_executing, including_scheduled: false
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
idempotent!
# GOOD
data_consistency :delayed

deduplicate :none
idempotent!
# GOOD
data_consistency: delayed

deduplicate :until_executing, including_scheduled: true
idempotent!

I also added autocorrection for this Cop.

Screenshots or Screencasts (strongly suggested)

Screenshot_at_Aug_04_17-43-15

Screenshot_at_Aug_04_17-43-50

Screenshot_at_Aug_04_17-45-21

Screenshot_at_Aug_04_17-45-42

How to setup and validate locally (strongly suggested)

Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

Security

Does this MR contain changes to processing or storing of credentials or tokens, authorization and authentication methods or other items described in the security review guidelines? If not, then delete this Security section.

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • The MR includes necessary changes to maintain consistency between UI, API, email, or other methods
  • Security reports checked/validated by a reviewer from the AppSec team
Edited by Nikola Milojevic

Merge request reports

Loading