Prepare CI minutes consumption update to be idempotent
What does this MR do?
Related to #331785 (closed)
When a job completes, BuildFinishedWorker
runs and in turns schedules other workers, including Ci::Minutes::UpdateProjectAndNamespaceUsageWorker
. This worker is responsible for incrementing the CI minutes consumption. It's necessary for this worker to be idempotent to avoid counting multiple times CI minutes consumption (equivalent to billing the customer multiple times for service).
In order to make Ci::Minutes::UpdateProjectAndNamespaceUsageWorker
to be idempotent we need to:
- differentiate parameters uniquely by adding a new
build_id
parameter in a multi-step deployment. - having unique set of params we can deduplicate jobs and mark the worker as idempotent
- track any updates already occurred for the same job (we are using Redis for that) and skip if already done
In this MR we are introducing a new parameter build_id
(being nil
by default) and a mechanism that uses Redis to check if the same update has already occurrent in the past 24 hours. Since this worker is scheduled by BuildFinishedWorker
, there could be chances that BuildFinishedWorker
fails and is retried, causing Ci::Minutes::UpdateProjectAndNamespaceUsageWorker
to be also retried. 24 hours should be enough time to prevent duplicates. Also, given that BuildFinishedWorker
is scheduled once when a build completes, it should not happen that a build finishes again in the future.
In a follow-up MR (to be merged after this is deployed) we will make build_id
to always be passed as parameter. Finally in a 3rd MR we will remove the default value nil
as per https://docs.gitlab.com/ee/development/sidekiq_style_guide.html#multi-step-deployment.
Screenshots or Screencasts (strongly suggested)
How to setup and validate locally (strongly suggested)
Does this MR meet the acceptance criteria?
Conformity
-
I have included changelog trailers, or none are needed. (Does this MR need a changelog?) -
I have added/updated documentation, or it's not needed. (Is documentation required?) -
I have properly separated EE content from FOSS, or this MR is FOSS only. (Where should EE code go?) -
I have added information for database reviewers in the MR description, or it's not needed. (Does this MR have database related changes?) -
I have self-reviewed this MR per code review guidelines. -
This MR does not harm performance, or I have asked a reviewer to help assess the performance impact. (Merge request performance guidelines) -
I have followed the style guides. -
This change is backwards compatible across updates, or this does not apply.
Availability and Testing
-
I have added/updated tests following the Testing Guide, or it's not needed. (Consider all test levels. See the Test Planning Process.) -
I have tested this MR in all supported browsers, or it's not needed. -
I have informed the Infrastructure department of a default or new setting change per definition of done, or it's not needed.
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