gitlab-org--gitlab-foss/spec/workers
Yorick Peterse 88e627cf14
Fix race conditions for AuthorizedProjectsWorker
There were two cases that could be problematic:

1. Because sometimes AuthorizedProjectsWorker would be scheduled in a
   transaction it was possible for a job to run/complete before a
   COMMIT; resulting in it either producing an error, or producing no
   new data.

2. When scheduling jobs the code would not wait until completion. This
   could lead to a user creating a project and then immediately trying
   to push to it. Usually this will work fine, but given enough load it
   might take a few seconds before a user has access.

The first one is problematic, the second one is mostly just annoying
(but annoying enough to warrant a solution).

This commit changes two things to deal with this:

1. Sidekiq scheduling now takes places after a COMMIT, this is ensured
   by scheduling using Rails' after_commit hook instead of doing so in
   an arbitrary method.

2. When scheduling jobs the calling thread now waits for all jobs to
   complete.

Solution 2 requires tracking of job completions. Sidekiq provides a way
to find a job by its ID, but this involves scanning over the entire
queue; something that is very in-efficient for large queues. As such a
more efficient solution is necessary. There are two main Gems that can
do this in a more efficient manner:

* sidekiq-status
* sidekiq_status

No, this is not a joke. Both Gems do a similar thing (but slightly
different), and the only difference in their name is a dash vs an
underscore. Both Gems however provide far more than just checking if a
job has been completed, and both have their problems. sidekiq-status
does not appear to be actively maintained, with the last release being
in 2015. It also has some issues during testing as API calls are not
stubbed in any way. sidekiq_status on the other hand does not appear to
be very popular, and introduces a similar amount of code.

Because of this I opted to write a simple home grown solution. After
all, all we need is storing a job ID somewhere so we can efficiently
look it up; we don't need extra web UIs (as provided by sidekiq-status)
or complex APIs to update progress, etc.

This is where Gitlab::SidekiqStatus comes in handy. This namespace
contains some code used for tracking, removing, and looking up job IDs;
all without having to scan over an entire queue. Data is removed
explicitly, but also expires automatically just in case.

Using this API we can now schedule jobs in a fork-join like manner: we
schedule the jobs in Sidekiq, process them in parallel, then wait for
completion. By using Sidekiq we can leverage all the benefits such as
being able to scale across multiple cores and hosts, retrying failed
jobs, etc.

The one downside is that we need to make sure we can deal with
unexpected increases in job processing timings. To deal with this the
class Gitlab::JobWaiter (used for waiting for jobs to complete) will
only wait a number of seconds (30 by default). Once this timeout is
reached it will simply return.

For GitLab.com almost all AuthorizedProjectWorker jobs complete in
seconds, only very rarely do we spike to job timings of around a minute.
These in turn seem to be the result of external factors (e.g. deploys),
in which case a user is most likely not able to use the system anyway.

In short, this new solution should ensure that jobs are processed
properly and that in almost all cases a user has access to their
resources whenever they need to have access.
2017-01-25 13:22:15 +01:00
..
concerns Re-organize queues to use for Sidekiq 2016-10-21 18:17:07 +02:00
repository_check Project tools visibility level 2016-09-01 11:47:59 -03:00
authorized_projects_worker_spec.rb Fix race conditions for AuthorizedProjectsWorker 2017-01-25 13:22:15 +01:00
build_coverage_worker_spec.rb Update code coverage for CI build asynchronously 2016-10-13 15:22:55 +02:00
build_email_worker_spec.rb Only include EmailHelpers in mailer specs and specs using them 2016-12-01 12:17:33 +08:00
build_finished_worker_spec.rb Add build finished worker that creates a workflow 2016-10-14 14:45:14 +02:00
build_hooks_worker_spec.rb Perform CI build hooks asynchronously using worker 2016-10-13 12:45:16 +02:00
build_success_worker_spec.rb Do not process build success if project was removed 2016-10-13 14:56:32 +02:00
delete_merged_branches_worker_spec.rb Add button to delete all merged branches 2016-11-09 21:04:03 +01:00
delete_user_worker_spec.rb Specs for the DeleteUserService 2016-03-15 22:19:51 +01:00
email_receiver_worker_spec.rb so we use separate classes to handle different tasks 2016-05-18 17:25:45 -05:00
emails_on_push_worker_spec.rb Only include EmailHelpers in mailer specs and specs using them 2016-12-01 12:17:33 +08:00
every_sidekiq_worker_spec.rb Re-organize queues to use for Sidekiq 2016-10-21 18:17:07 +02:00
expire_build_artifacts_worker_spec.rb ExpireBuildArtifactsWorker query builds table without ordering enqueuing one job per build to cleanup 2016-10-07 15:33:58 +02:00
expire_build_instance_artifacts_worker_spec.rb Avoid race condition when expiring artifacts 2016-10-17 19:47:03 +02:00
git_garbage_collect_worker_spec.rb Remove unused 'require' 2016-11-04 14:34:10 +01:00
group_destroy_worker_spec.rb Fix bug where destroying a namespace would not always destroy projects 2016-08-11 15:36:35 -07:00
merge_worker_spec.rb Unify check branch name exist 2016-06-20 21:44:21 +02:00
new_note_worker_spec.rb Does not raise error when Note not found when processing NewNoteWorker 2016-11-11 22:54:11 -02:00
pipeline_hooks_worker_spec.rb Execute pipeline hooks asynchronously 2016-10-12 20:20:01 +02:00
pipeline_metrics_worker_spec.rb Added test events specs and logic. Also fixed some SQL and refactored the pipeline worker spec. 2016-11-17 08:22:55 +01:00
pipeline_notification_worker_spec.rb Update effected tests 2016-12-04 17:32:33 +01:00
pipeline_proccess_worker_spec.rb Rename pipeline workers to match current convention 2016-10-06 14:52:00 +02:00
pipeline_success_worker_spec.rb Rename MWBS service to Merge When Pipeline Succeeds 2016-11-21 10:22:09 +01:00
pipeline_update_worker_spec.rb Rename pipeline workers to match current convention 2016-10-06 14:52:00 +02:00
post_receive_spec.rb Extract project#update_merge_requests and SystemHooks to its own worker from GitPushService 2016-10-13 17:23:24 +02:00
process_commit_worker_spec.rb Pass commit data to ProcessCommitWorker 2016-12-01 13:36:06 +01:00
project_cache_worker_spec.rb Add more storage statistics 2016-12-21 16:39:49 +01:00
project_destroy_worker_spec.rb Fix skip_repo parameter being ignored when destroying a namespace 2016-08-03 17:07:38 -07:00
prune_old_events_worker_spec.rb Added cron to prune events older than 12 months. 2016-09-07 19:41:25 +02:00
reactive_caching_worker_spec.rb Add a ReactiveCaching concern for use in the KubernetesService 2016-12-19 19:53:03 +00:00
remove_expired_group_links_worker_spec.rb Allow project group links to be expired 2016-08-18 22:45:41 +01:00
remove_expired_members_worker_spec.rb Allow project group links to be expired 2016-08-18 22:45:41 +01:00
remove_unreferenced_lfs_objects_worker_spec.rb Remove unreferenced LFS objects from DB and fs 2016-10-28 19:39:20 +02:00
repository_fork_worker_spec.rb Fix a bug where forking a project from a repository storage to another would fail 2016-07-26 17:22:13 -04:00
repository_import_worker_spec.rb Mask credentials from URL when import of project has failed. 2016-05-18 21:16:36 -05:00
stuck_ci_builds_worker_spec.rb Don't fail builds for projects that are deleted when they are stuck 2016-06-12 15:15:58 +02:00
trending_projects_worker_spec.rb Precalculate trending projects 2016-10-10 12:27:08 +02:00
update_merge_requests_worker_spec.rb Extract project#update_merge_requests and SystemHooks to its own worker from GitPushService 2016-10-13 17:23:24 +02:00
use_key_worker_spec.rb Record and show last used date of SSH Keys 2017-01-09 04:15:39 +11:00