From 2ab0120e35ded3bd2c8bb1cee020c93504c6b492 Mon Sep 17 00:00:00 2001
From: michalsn <michal@sniatala.pl>
Date: Wed, 18 Sep 2024 15:42:56 +0200
Subject: [PATCH] add skipLocked config

---
 docs/configuration.md              |  1 +
 docs/running-queues.md             |  2 +-
 src/Config/Queue.php               |  3 ++
 src/Models/QueueJobModel.php       |  2 +-
 tests/Models/QueueJobModelTest.php | 64 ++++++++++++++++++++++++++++++
 tests/_support/Config/Queue.php    |  5 ++-
 6 files changed, 73 insertions(+), 4 deletions(-)
 create mode 100644 tests/Models/QueueJobModelTest.php

diff --git a/docs/configuration.md b/docs/configuration.md
index 858713e..a710146 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -37,6 +37,7 @@ The configuration settings for `database` handler.
 
 * `dbGroup` - The database group to use. Default value: `default`.
 * `getShared` - Weather to use shared instance. Default value: `true`.
+* `skipLocked` - Weather to use "skip locked" feature to maintain concurrency calls. Default to `true`.
 
 ### $redis
 
diff --git a/docs/running-queues.md b/docs/running-queues.md
index 10d4139..776289f 100644
--- a/docs/running-queues.md
+++ b/docs/running-queues.md
@@ -65,7 +65,7 @@ This way, worker will consume jobs with the `low` priority and then with `high`.
 
 ### Running many instances of the same queue
 
-As mentioned above, sometimes we may want to have multiple instances of the same command running at the same time. The queue is safe to use in that scenario with all databases except `SQLite3` since it doesn't guarantee that the job will be selected only by one process.
+As mentioned above, sometimes we may want to have multiple instances of the same command running at the same time. The queue is safe to use in that scenario with all databases if you keep the `skipLocked` to `true` in the config file. Only for SQLite3 driver this setting is not relevant.
 
 ### Handling long-running process
 
diff --git a/src/Config/Queue.php b/src/Config/Queue.php
index 8380e69..793ea85 100644
--- a/src/Config/Queue.php
+++ b/src/Config/Queue.php
@@ -45,6 +45,9 @@ class Queue extends BaseConfig
     public array $database = [
         'dbGroup'   => 'default',
         'getShared' => true,
+        // use skip locked feature to maintain concurrency calls
+        // this is not relevant for the SQLite3 database driver
+        'skipLocked' => true,
     ];
 
     /**
diff --git a/src/Models/QueueJobModel.php b/src/Models/QueueJobModel.php
index a086fad..121c8fb 100644
--- a/src/Models/QueueJobModel.php
+++ b/src/Models/QueueJobModel.php
@@ -90,7 +90,7 @@ public function getFromQueue(string $name, array $priority): ?QueueJob
      */
     private function skipLocked(string $sql): string
     {
-        if ($this->db->DBDriver === 'SQLite3') {
+        if ($this->db->DBDriver === 'SQLite3' || config('Queue')->database['skipLocked'] === false) {
             return $sql;
         }
 
diff --git a/tests/Models/QueueJobModelTest.php b/tests/Models/QueueJobModelTest.php
new file mode 100644
index 0000000..01c8532
--- /dev/null
+++ b/tests/Models/QueueJobModelTest.php
@@ -0,0 +1,64 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of CodeIgniter Queue.
+ *
+ * (c) CodeIgniter Foundation <admin@codeigniter.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Tests\Models;
+
+use CodeIgniter\Queue\Models\QueueJobModel;
+use CodeIgniter\Test\ReflectionHelper;
+use Tests\Support\TestCase;
+
+/**
+ * @internal
+ */
+final class QueueJobModelTest extends TestCase
+{
+    use ReflectionHelper;
+
+    public function testQueueJobModel(): void
+    {
+        $model = model(QueueJobModel::class);
+        $this->assertInstanceOf(QueueJobModel::class, $model);
+    }
+
+    public function testSkipLocked(): void
+    {
+        $model  = model(QueueJobModel::class);
+        $method = $this->getPrivateMethodInvoker($model, 'skipLocked');
+
+        $sql    = 'SELECT * FROM queue_jobs WHERE queue = "test" AND status = 0 AND available_at < 123456 LIMIT 1';
+        $result = $method($sql);
+
+        if ($model->db->DBDriver === 'SQLite3') {
+            $this->assertSame($sql, $result);
+        } elseif ($model->db->DBDriver === 'SQLSRV') {
+            $expected = 'SELECT * FROM queue_jobs WITH (ROWLOCK,UPDLOCK,READPAST) WHERE queue = "test" AND status = 0 AND available_at < 123456 LIMIT 1';
+            $this->assertSame($expected, $result);
+        } else {
+            $expected = 'SELECT * FROM queue_jobs WHERE queue = "test" AND status = 0 AND available_at < 123456 LIMIT 1 FOR UPDATE SKIP LOCKED';
+            $this->assertSame($expected, $result);
+        }
+    }
+
+    public function testSkipLockedFalse(): void
+    {
+        config('Queue')->database['skipLocked'] = false;
+
+        $model  = model(QueueJobModel::class);
+        $method = $this->getPrivateMethodInvoker($model, 'skipLocked');
+
+        $sql    = 'SELECT * FROM queue_jobs WHERE queue = "test" AND status = 0 AND available_at < 123456 LIMIT 1';
+        $result = $method($sql);
+
+        $this->assertSame($sql, $result);
+    }
+}
diff --git a/tests/_support/Config/Queue.php b/tests/_support/Config/Queue.php
index a7a3a48..cea913e 100644
--- a/tests/_support/Config/Queue.php
+++ b/tests/_support/Config/Queue.php
@@ -40,8 +40,9 @@ class Queue extends BaseQueue
      * Database handler config.
      */
     public array $database = [
-        'dbGroup'   => 'default',
-        'getShared' => true,
+        'dbGroup'    => 'default',
+        'getShared'  => true,
+        'skipLocked' => true,
     ];
 
     /**