redis-smq 8.0.0-rc.2 → 8.0.0-rc.4

package/CHANGELOG.md

@@ -1,5 +1,35 @@
 
 
+## [8.0.0-rc.4](https://github.com/weyoss/redis-smq/compare/v8.0.0-rc.3...v8.0.0-rc.4) (2023-12-02)
+
+
+### Documentation
+
+* clean up outdated examples ([dd1c68b](https://github.com/weyoss/redis-smq/commit/dd1c68bdd7cf7de2dfa309dbe7efff76fed5c983))
+
+
+### Misc
+
+* move redis-smq-common from dev-deps to deps ([675880d](https://github.com/weyoss/redis-smq/commit/675880d3803cca9c89aa860486bae43dbe7e2f70))
+
+## [8.0.0-rc.3](https://github.com/weyoss/redis-smq/compare/v8.0.0-rc.2...v8.0.0-rc.3) (2023-12-02)
+
+
+### Bug Fixes
+
+* **scheduler:** handle unacked messages with retry delay correctly ([a97b145](https://github.com/weyoss/redis-smq/commit/a97b145f605d6b5c7d9f6f83c844c9d2447c5786))
+
+
+### Documentation
+
+* update Message reference ([1cff3e3](https://github.com/weyoss/redis-smq/commit/1cff3e3fe3634ffa2d502a4bbb589948ed8e56ea))
+* update TRedisSMQEvent reference ([5afa22e](https://github.com/weyoss/redis-smq/commit/5afa22ea1d2de00cb9c4708c55ec8fe1ef5a39b5))
+
+
+### Tests
+
+* **message:** add new test cases covering message status ([9eec7e9](https://github.com/weyoss/redis-smq/commit/9eec7e9e2a39244ab62b9f8db4d049d3363a534d))
+
 ## [8.0.0-rc.2](https://github.com/weyoss/redis-smq/compare/v8.0.0-rc.1...v8.0.0-rc.2) (2023-11-27)
 
 

package/dist/index.cjs

@@ -3745,11 +3745,13 @@ var PublishScheduledWorker = class extends import_redis_smq_common33.Worker {
           (msg, _, done) => {
             var _a;
             const ts = Date.now();
-            const message = _fromMessage(msg, null, null);
-            const messageState = message.resetScheduledParams().getSetMessageState().setPublishedAt(ts).setScheduledMessageId(msg.getRequiredId());
-            const messageId = messageState.getId();
-            const messagePriority = (_a = message.getPriority()) != null ? _a : "";
-            const queue = message.getDestinationQueue();
+            const messagePriority = (_a = msg.getPriority()) != null ? _a : "";
+            const queue = msg.getDestinationQueue();
+            const { keyMessage: keyScheduledMessage } = redisKeys.getMessageKeys(
+              msg.getRequiredId()
+            );
+            const nextScheduleTimestamp = msg.getNextScheduledTimestamp();
+            const scheduledMessageState = msg.getRequiredMessageState().setLastScheduledAt(ts);
             const {
               keyQueueProperties,
               keyQueuePending,
@@ -3757,26 +3759,31 @@ var PublishScheduledWorker = class extends import_redis_smq_common33.Worker {
               keyQueueScheduled,
               keyQueueMessages
             } = redisKeys.getQueueKeys(queue);
-            const { keyMessage } = redisKeys.getMessageKeys(messageId);
-            const { keyMessage: keyScheduledMessage } = redisKeys.getMessageKeys(
-              msg.getRequiredId()
-            );
-            const nextScheduleTimestamp = msg.getNextScheduledTimestamp();
-            const scheduledMessageState = msg.getRequiredMessageState().setLastScheduledAt(ts);
+            let newMessage = null;
+            let newMessageState = null;
+            let newMessageId = "";
+            let newKeyMessage = "";
+            const hasBeenUnacknowledged = msg.getRetryDelay() > 0 && msg.getRequiredMessageState().getAttempts() > 0;
+            if (!hasBeenUnacknowledged) {
+              newMessage = _fromMessage(msg, null, null);
+              newMessageState = newMessage.resetScheduledParams().getSetMessageState().setPublishedAt(ts).setScheduledMessageId(msg.getRequiredId());
+              newMessageId = newMessageState.getId();
+              newKeyMessage = redisKeys.getMessageKeys(newMessageId).keyMessage;
+            }
             keys.push(
-              keyMessage,
+              newKeyMessage,
               keyQueuePending,
               keyQueueProperties,
+              keyQueueMessages,
               keyPriorityQueuePending,
               keyQueueScheduled,
               keyScheduledMessage
             );
             argv.push(
-              messageId,
+              newMessageId,
+              newMessage ? JSON.stringify(newMessage) : "",
+              newMessageState ? JSON.stringify(newMessageState) : "",
               messagePriority,
-              JSON.stringify(message),
-              JSON.stringify(messageState),
-              keyQueueMessages,
               msg.getRequiredId(),
               nextScheduleTimestamp,
               JSON.stringify(scheduledMessageState)

package/dist/index.js

@@ -3735,11 +3735,13 @@ var PublishScheduledWorker = class extends Worker4 {
           (msg, _, done) => {
             var _a;
             const ts = Date.now();
-            const message = _fromMessage(msg, null, null);
-            const messageState = message.resetScheduledParams().getSetMessageState().setPublishedAt(ts).setScheduledMessageId(msg.getRequiredId());
-            const messageId = messageState.getId();
-            const messagePriority = (_a = message.getPriority()) != null ? _a : "";
-            const queue = message.getDestinationQueue();
+            const messagePriority = (_a = msg.getPriority()) != null ? _a : "";
+            const queue = msg.getDestinationQueue();
+            const { keyMessage: keyScheduledMessage } = redisKeys.getMessageKeys(
+              msg.getRequiredId()
+            );
+            const nextScheduleTimestamp = msg.getNextScheduledTimestamp();
+            const scheduledMessageState = msg.getRequiredMessageState().setLastScheduledAt(ts);
             const {
               keyQueueProperties,
               keyQueuePending,
@@ -3747,26 +3749,31 @@ var PublishScheduledWorker = class extends Worker4 {
               keyQueueScheduled,
               keyQueueMessages
             } = redisKeys.getQueueKeys(queue);
-            const { keyMessage } = redisKeys.getMessageKeys(messageId);
-            const { keyMessage: keyScheduledMessage } = redisKeys.getMessageKeys(
-              msg.getRequiredId()
-            );
-            const nextScheduleTimestamp = msg.getNextScheduledTimestamp();
-            const scheduledMessageState = msg.getRequiredMessageState().setLastScheduledAt(ts);
+            let newMessage = null;
+            let newMessageState = null;
+            let newMessageId = "";
+            let newKeyMessage = "";
+            const hasBeenUnacknowledged = msg.getRetryDelay() > 0 && msg.getRequiredMessageState().getAttempts() > 0;
+            if (!hasBeenUnacknowledged) {
+              newMessage = _fromMessage(msg, null, null);
+              newMessageState = newMessage.resetScheduledParams().getSetMessageState().setPublishedAt(ts).setScheduledMessageId(msg.getRequiredId());
+              newMessageId = newMessageState.getId();
+              newKeyMessage = redisKeys.getMessageKeys(newMessageId).keyMessage;
+            }
             keys.push(
-              keyMessage,
+              newKeyMessage,
               keyQueuePending,
               keyQueueProperties,
+              keyQueueMessages,
               keyPriorityQueuePending,
               keyQueueScheduled,
               keyScheduledMessage
             );
             argv.push(
-              messageId,
+              newMessageId,
+              newMessage ? JSON.stringify(newMessage) : "",
+              newMessageState ? JSON.stringify(newMessageState) : "",
               messagePriority,
-              JSON.stringify(message),
-              JSON.stringify(messageState),
-              keyQueueMessages,
               msg.getRequiredId(),
               nextScheduleTimestamp,
               JSON.stringify(scheduledMessageState)

package/dist/lua/publish-scheduled-message.lua

@@ -16,16 +16,16 @@ local EMessagePropertyMessage = ARGV[9]
 
 local keyMessage = ''
 local keyQueuePending = ''
+local keyQueueMessages = ''
 local keyQueueProperties = ''
 local keyPriorityQueuePending = ''
 local keyQueueScheduled = ''
 local keyScheduledMessage = ''
 
 local messageId = ''
-local messagePriority = ''
 local message = ''
 local messageState = ''
-local keyQueueMessages = ''
+local messagePriority = ''
 local scheduledMessageId = ''
 local scheduledMessageNextScheduleTimestamp = ''
 local scheduledMessageState = ''
@@ -37,14 +37,7 @@ local argvIndexOffset = 9
 
 ---
 
-local function publishMessage(queueType)
-    if queueType == EQueuePropertyQueueTypeLIFOQueue then
-        redis.call("RPUSH", keyQueuePending, messageId)
-    elseif queueType == EQueuePropertyQueueTypeFIFOQueue then
-        redis.call("LPUSH", keyQueuePending, messageId)
-    else
-        redis.call("ZADD", keyPriorityQueuePending, messagePriority, messageId)
-    end
+local function addToQueueMessages()
     redis.call("SADD", keyQueueMessages, messageId)
     redis.call(
             "HMSET", keyMessage,
@@ -55,62 +48,96 @@ local function publishMessage(queueType)
     redis.call("HINCRBY", keyQueueProperties, EQueuePropertyMessagesCount, 1)
 end
 
-local function deleteScheduledMessage(queueExists)
-    redis.call("ZREM", keyScheduledMessages, scheduledMessageId)
-    redis.call("ZREM", keyQueueScheduled, scheduledMessageId)
+local function publishMessage(queueType, msgId)
+    if queueType == EQueuePropertyQueueTypeLIFOQueue then
+        redis.call("RPUSH", keyQueuePending, msgId)
+    elseif queueType == EQueuePropertyQueueTypeFIFOQueue then
+        redis.call("LPUSH", keyQueuePending, msgId)
+    else
+        redis.call("ZADD", keyPriorityQueuePending, messagePriority, msgId)
+    end
+end
+
+local function deletedScheduledMessage(updateMessageCount)
     redis.call("DEL", keyScheduledMessage)
-    if queueExists == true then
+    if updateMessageCount == true then
         redis.call("HINCRBY", keyQueueProperties, EQueuePropertyMessagesCount, -1)
     end
 end
 
-local function scheduleMessage()
-    if scheduledMessageNextScheduleTimestamp == "0" then
-        deleteScheduledMessage(true)
-    else
-        redis.call("ZADD", keyScheduledMessages, scheduledMessageNextScheduleTimestamp, scheduledMessageId)
-        redis.call("ZADD", keyQueueScheduled, scheduledMessageNextScheduleTimestamp, scheduledMessageId)
+local function removeFromScheduled()
+    redis.call("ZREM", keyScheduledMessages, scheduledMessageId)
+    redis.call("ZREM", keyQueueScheduled, scheduledMessageId)
+end
+
+local function updateScheduledMessageProperties(status )
+    if status == '' then
         redis.call("HSET", keyScheduledMessage, EMessagePropertyState, scheduledMessageState)
+    else
+        redis.call(
+            "HMSET", keyScheduledMessage,
+            EMessagePropertyState, scheduledMessageState,
+            EMessagePropertyStatus, status
+        )
     end
 end
 
+local function scheduleMessage()
+    redis.call("ZADD", keyScheduledMessages, scheduledMessageNextScheduleTimestamp, scheduledMessageId)
+    redis.call("ZADD", keyQueueScheduled, scheduledMessageNextScheduleTimestamp, scheduledMessageId)
+end
+
 local function handleMessage()
     local properties = redis.call("HMGET", keyQueueProperties, EQueuePropertyQueueType)
     local queueType = properties[1]
-    if (queueType == false) or (queueType ~= EQueuePropertyQueueTypeLIFOQueue and queueType ~= EQueuePropertyQueueTypeFIFOQueue and queueType ~= EQueuePropertyQueueTypePriorityQueue) then
-        deleteScheduledMessage(false)
+    if (queueType == false) then
+        removeFromScheduled()
+        deletedScheduledMessage(false)
+    elseif (queueType ~= EQueuePropertyQueueTypeLIFOQueue and queueType ~= EQueuePropertyQueueTypeFIFOQueue and queueType ~= EQueuePropertyQueueTypePriorityQueue) then
+        removeFromScheduled()
+        deletedScheduledMessage(true)
+    elseif messageId == '' then
+        publishMessage(queueType, scheduledMessageId)
+        removeFromScheduled()
+        updateScheduledMessageProperties(EMessagePropertyStatusPending)
     else
-        publishMessage(queueType)
-        scheduleMessage()
+        publishMessage(queueType, messageId)
+        addToQueueMessages();
+        if scheduledMessageNextScheduleTimestamp == "0" then
+            removeFromScheduled()
+            deletedScheduledMessage(true)
+        else
+            scheduleMessage()
+            updateScheduledMessageProperties('')
+        end
     end
 end
 
 if #ARGV > argvIndexOffset then
     for index in pairs(ARGV) do
         if (index > argvIndexOffset) then
-            local idx = index % 8
-            if idx == 2 then
+            local idx = index % 7
+            if idx == 3 then
                 messageId = ARGV[index]
                 keyMessage = KEYS[keyIndexOffset + 1]
                 keyQueuePending = KEYS[keyIndexOffset + 2]
                 keyQueueProperties = KEYS[keyIndexOffset + 3]
-                keyPriorityQueuePending = KEYS[keyIndexOffset + 4]
-                keyQueueScheduled = KEYS[keyIndexOffset + 5]
-                keyScheduledMessage = KEYS[keyIndexOffset + 6]
-                keyIndexOffset = keyIndexOffset + 6
-            elseif idx == 3 then
-                messagePriority = ARGV[index]
+                keyQueueMessages = KEYS[keyIndexOffset + 4]
+                keyPriorityQueuePending = KEYS[keyIndexOffset + 5]
+                keyQueueScheduled = KEYS[keyIndexOffset + 6]
+                keyScheduledMessage = KEYS[keyIndexOffset + 7]
+                keyIndexOffset = keyIndexOffset + 7
             elseif idx == 4 then
                 message = ARGV[index]
             elseif idx == 5 then
                 messageState = ARGV[index]
             elseif idx == 6 then
-                keyQueueMessages = ARGV[index]
-            elseif idx == 7 then
-                scheduledMessageId = ARGV[index]
+                messagePriority = ARGV[index]
             elseif idx == 0 then
-                scheduledMessageNextScheduleTimestamp = ARGV[index]
+                scheduledMessageId = ARGV[index]
             elseif idx == 1 then
+                scheduledMessageNextScheduleTimestamp = ARGV[index]
+            elseif idx == 2 then
                 scheduledMessageState = ARGV[index]
                 handleMessage()
             end

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "redis-smq",
-  "version": "8.0.0-rc.2",
+  "version": "8.0.0-rc.4",
   "description": "A simple high-performance Redis message queue for Node.js.",
   "author": "Weyoss <weyoss@protonmail.com>",
   "license": "MIT",
@@ -35,9 +35,9 @@
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "bluebird": "3.7.2",
     "cron-parser": "4.7.1",
     "lodash": "4.17.21",
+    "redis-smq-common": "3.0.0-rc.7",
     "uuid": "9.0.0"
   },
   "devDependencies": {
@@ -45,11 +45,12 @@
     "@types/debug": "4.1.7",
     "@types/jest": "27.0.2",
     "@types/lodash": "4.14.191",
-    "@types/node": "16.10.2",
+    "@types/node": "18.19.1",
     "@types/supertest": "2.0.11",
     "@types/uuid": "9.0.0",
     "@typescript-eslint/eslint-plugin": "6.10.0",
     "@typescript-eslint/parser": "6.10.0",
+    "bluebird": "3.7.2",
     "eslint": "8.53.0",
     "eslint-config-prettier": "9.0.0",
     "eslint-plugin-prettier": "5.0.1",
@@ -57,7 +58,6 @@
     "jest": "27.2.4",
     "lint-staged": "11.1.2",
     "prettier": "3.0.3",
-    "redis-smq-common": "3.0.0-rc.7",
     "supertest": "6.1.6",
     "type-coverage": "2.27.0",
     "typescript": "4.9.4"