The uniqueness of the queue

[garryseldon]

I'd like to be able to pass a string. If such a string exists, the job won't be created. Example: An online store sends a customer an email about a change to an order. The manager changes the order status, items, delivery time, and so on within a minute. It should be one email, not three.

Yii::$app->queue->delay(5 * 60)->name('email_' . $orderId)->push(new EmailJob([
    'order_id' => $orderId,
]));

[garryseldon]

Example for DB:

// vendor/yiisoft/yii2-queue/src/drivers/db/Queue.php
class Queue extends CliQueue
{
    // ...
    protected function pushMessage($message, $ttr, $delay, $priority, $name = null)
    {
        if (!$name || !(new Query())->from($this->tableName)->where(['name' => $name])->exists()) {
            $this->db->createCommand()->insert($this->tableName, [
                'channel' => $this->channel,
                'job' => $message,
                'pushed_at' => time(),
                'ttr' => $ttr,
                'delay' => $delay,
                'priority' => $priority ?: 1024,
                'name' => $name, 
            ])->execute();
            $tableSchema = $this->db->getTableSchema($this->tableName);
            return $this->db->getLastInsertID($tableSchema->sequenceName);
        }        
    }
}
    
// vendor/yiisoft/yii2-queue/src/Queue.php
abstract class Queue extends Component
{
    // ...
    private $name;
	
    public function name($name)
    {
        $this->name = $name;
        return $this;
    }
    
    public function push($job)
    {
        $event = new PushEvent([
            'job' => $job,
            'ttr' => $this->pushTtr ?: (
                $job instanceof RetryableJobInterface
                    ? $job->getTtr()
                    : $this->ttr
            ),
            'delay' => $this->pushDelay ?: 0,
            'priority' => $this->pushPriority,
        ]);
        $this->pushTtr = null;
        $this->pushDelay = null;
        $this->pushPriority = null;
        $name = $this->name;
        $this->name = null;

        $this->trigger(self::EVENT_BEFORE_PUSH, $event);
        if ($event->handled) {
            return null;
        }

        if ($this->strictJobType && !($event->job instanceof JobInterface)) {
            throw new InvalidArgumentException('Job must be instance of JobInterface.');
        }

        $message = $this->serializer->serialize($event->job);
        $event->id = $this->pushMessage($message, $event->ttr, $event->delay, $event->priority, $name);
        $this->trigger(self::EVENT_AFTER_PUSH, $event);

        return $event->id;
    }
}

// migration
class m260126_104406_alter_queue_table extends Migration
{
    public $tableName = '{{%queue}}';

    public function safeUp()
    {
        $this->addColumn($this->tableName, 'name', $this->string(155));
        $this->createIndex('name', $this->tableName, 'name');
    }

    public function safeDown()
    {
        $this->dropColumn($this->tableName, 'name');
    }
}

[s1lver]

How would this work with other queue drivers in your opinion?