Bogdanp/dramatiq

Feature Request: Considering handling a SkipEnqueue MiddlewareError

Open

#276 opened on Feb 26, 2020

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Python (277 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (3,884 stars)
PR merge metrics
 (Avg merge 20d 20h) (10 merged PRs in 30d)

Description

I've just implemented a "DedupMiddleware" which can be used prevent a message from being enqueued if a similar message already exists in the queue. Unfortunately it requires to override RedisBroker.enqueue() in order to gracefully catch the SkipEnqueue middleware error I raise when needed.

Would you consider accepting a PR that would:

  1. Define a SkipEnqueue(MiddlewareError).
  2. try...except this error around self.emit_before here, so a middleware could be given the possibility to interrupt an enqueuing in that hook?

Thanks.

Contributor guide

Research direction
Implement a SkipEnqueue exception class inheriting from MiddlewareError. Modify RedisBroker.enqueue to catch this exception when calling self.emit before and handle it gracefully to prevent enqueue.
Tech stack
python
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65