Proposal: deduplicate pending jobs with coalesce

Aberta
#834 1 comentário 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 4 dias

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
25/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
rails, ruby
Domínio
backend, databases

Direção de pesquisa

Read the original uniqueness discussion (#105), concurrency discussions (#176 and #597), and exploratory PR #835 alongside the solid_queue-coalesce reference gem. Start by evaluating whether the proposed pending-job lifecycle and API fit Solid Queue's enqueue, dispatch, and cleanup paths. Done means maintainers agree on whether the feature belongs in core and, if so, define its minimal API and persistence model.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

Hi Rosa and team,

David (human) here. We've used Solid Queue in production for nearly a year and love it.

We found that limits_concurrency on_conflict: :discard doesn't deduplicate scheduled jobs. After causing us a production incident, we also discovered that it can discard important work on a retry. I feel that limits_concurrency is not the right tool for deduplication.

Below is my AI-authored issue that describes the problem and my proposed solution, introducing the concept I'm calling coalesce.

I've written a gem solid_queue-coalesce (that composes well with limits_concurrency) exploring these ideas further, including replacing arguments, collecting calls into batches, debouncing and throttling. For now, I'm only proposing basic deduplication, but check out the gem if you're curious about the rest.


Motivation

Issue #105 described one pending job per key, with another allowed as soon as the first starts. limits_concurrency on_conflict: :discard (#176, #594) controls execution, not pending jobs:

  • Scheduled jobs can accumulate, and more than one can run (#597).
  • Calls made during execution can be dropped, even if the running job has already read the state being updated.
  • Callers can't identify which existing job covers their request.

For example, repeated product changes should share one pending reindex. A change during that reindex should schedule the next one.

on_conflict: :discard remains useful for shedding load; coalescing would complement it.

Proposal

class ReindexProductJob < ApplicationJob
  coalesce key: ->(product_id) { product_id }

  def perform(product_id)
    Product.find(product_id).reindex!
  end
end
  • Calls with the same key, including scheduled ones, share one pending job.
  • The key is released when that job starts, so a call during execution queues the next one.
  • Keys are scoped to the job class and batch; retries never coalesce.
  • coalesce_status (:created or :discarded) and provider_job_id tell the caller what happened.
  • Semaphores from limits_concurrency are untouched.

The first job's arguments and scheduled time are retained. Collecting calls, replacing arguments and debouncing are outside this proposal.

Implementation

The standalone gem works but patches private Solid Queue methods, making upgrades fragile. Native support could avoid that. #835 illustrates a minimal implementation using a solid_queue_coalesce_keys table and row locks; it's intended to support discussion, not represent a complete solution. The gem also has benchmarks.

Trade-offs

  • A new table requires a migration.
  • Row locking introduces contention and potential deadlocks; #835 also enqueues coalesced bulk jobs individually, allowing partial batches on failure.
  • Two jobs with the same key can run at once. Add limits_concurrency to prevent that.

Questions

  1. Would you want pending-job coalescing in Solid Queue?
  2. Should it be its own coalesce key: declaration, or an option on limits_concurrency?
  3. If it stays a gem, would you take small public extension points so it doesn't have to patch private methods?

🤖 Written by @dtcristo's agent (Claude Opus 5.5)

Linguagem predominante
Ruby
Estrelas
2.5k
Forks
271
Merge médio
5d 6h
PRs com merge (30d)
5

Preparar o ambiente

Abrir no Codespaces

Inicia o contêiner de desenvolvimento do projeto no navegador, com a sua própria conta do GitHub.

  • Inclui um Dockerfile ou arquivo Docker Compose
  • Sem modelo de pull request
  • Sem guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de rails/solid_queue

Todas as issues de rails/solid_queue

Issues semelhantes

Mais issues de Ruby

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.