@antelopejs/interface-redis-scheduler 0.0.8 → 0.0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.js CHANGED
@@ -217,6 +217,15 @@ async function updateTimer() {
217
217
  }
218
218
  }
219
219
  }
220
+ const TakeDueTasksScript = `
221
+ local due = redis.call("ZRANGEBYSCORE", KEYS[1], 0, ARGV[1])
222
+ redis.call("ZREMRANGEBYSCORE", KEYS[1], 0, ARGV[1])
223
+ return due
224
+ `;
225
+ async function takeDueTasks(client) {
226
+ const tasks = await client.eval(TakeDueTasksScript, 1, RedisKey, Date.now());
227
+ return Array.isArray(tasks) ? tasks.map(String) : [];
228
+ }
220
229
  /**
221
230
  * Executes all due tasks
222
231
  * This is called internally by the timer when tasks are due for execution
@@ -225,9 +234,8 @@ async function updateTimer() {
225
234
  async function runTasks() {
226
235
  locked = true;
227
236
  const client = await (0, interface_redis_1.GetClient)();
228
- const tasks = await client.zrangebyscore(RedisKey, 0, Date.now());
237
+ const tasks = await takeDueTasks(client);
229
238
  if (tasks.length > 0) {
230
- await client.zrem(RedisKey, ...tasks);
231
239
  for (const task of tasks) {
232
240
  const m = task.match(RetryPattern);
233
241
  try {
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAyDA,gCAEC;AAgCD,wCAgBC;AAkBD,0CAEC;AA8BD,0BAcC;AA0BD,gCAMC;AAWD,kCAyBC;AAOD,4BA6BC;AAlRD,iEAAwD;AACxD,gEAA6D;AAC7D,+DAA8D;AAQ9D,8DAA8D;AAC9D,MAAM,QAAQ,GAAG,qBAAqB,CAAC;AACvC,MAAM,gBAAgB,GAAG,eAAe,CAAC;AACzC,MAAM,sBAAsB,GAAG,QAAQ,CAAC;AACxC,MAAM,UAAU,GAAG,CAAC,CAAC;AACrB,MAAM,YAAY,GAAG,IAAI,CAAC;AAC1B,MAAM,eAAe,GAAG,QAAQ,CAAC;AACjC,MAAM,YAAY,GAAG,iCAAiC,CAAC;AAEvD,8CAA8C;AAC9C,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAuB,CAAC;AAChD,wDAAwD;AACxD,MAAM,KAAK,GAAG,IAAI,iCAAgB,EAE/B,CAAC;AACJ,KAAK,CAAC,UAAU,CAAC,CAAC,WAAmB,EAAE,OAAoB,EAAE,EAAE;IAC7D,IAAI,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;IACpE,CAAC;IACD,QAAQ,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;AACrC,CAAC,EAAE,IAAI,CAAC,CAAC;AACT,KAAK,CAAC,YAAY,CAAC,CAAC,WAAW,EAAE,EAAE;IACjC,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAgB,UAAU,CAAC,WAAmB,EAAE,OAAoB;IAClE,KAAK,CAAC,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;AACvC,CAAC;AAED,yDAAyD;AACzD,IAAI,UAAiB,CAAC;AAEtB,MAAM,yBAAyB,GAA+B;IAC5D,CAAC,sBAAsB,CAAC,EAAE,GAAG,EAAE,CAAC,KAAK,WAAW,EAAE;CACnD,CAAC;AAEF,SAAS,gBAAgB,CAAC,WAAmB,EAAE,QAAgB;IAC7D,OAAO,GAAG,WAAW,IAAI,QAAQ,EAAE,CAAC;AACtC,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACI,KAAK,UAAU,cAAc;IAClC,UAAU,GAAG,CAAC,MAAM,IAAA,2BAAS,GAAE,CAAC,CAAC,SAAS,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;IAClE,MAAM,UAAU,CAAC,OAAO,EAAE,CAAC;IAC3B,MAAM,UAAU,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;IAC7C,UAAU,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE;QAC5C,IAAI,OAAO,KAAK,gBAAgB,EAAE,CAAC;YACjC,OAAO;QACT,CAAC;QACD,MAAM,OAAO,GAAG,yBAAyB,CAAC,OAAO,CAAC,CAAC;QACnD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO;QACT,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC,CAAC,CAAC;IAEH,KAAK,WAAW,EAAE,CAAC;AACrB,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACI,KAAK,UAAU,eAAe;IACnC,MAAM,UAAU,CAAC,IAAI,EAAE,CAAC;AAC1B,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACI,KAAK,UAAU,OAAO,CAC3B,WAAmB,EACnB,OAAe,EACf,QAAgB;IAEhB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,kCAAkC,WAAW,EAAE,CAAC,CAAC;IACnE,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,IAAA,2BAAS,GAAE,CAAC;IACjC,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,EAAE,gBAAgB,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC9E,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,KAAK,MAAM,CAAC,OAAO,CAAC,gBAAgB,EAAE,sBAAsB,CAAC,CAAC;IAChE,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACI,KAAK,UAAU,UAAU,CAAC,WAAmB,EAAE,QAAgB;IACpE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,kCAAkC,WAAW,EAAE,CAAC,CAAC;IACnE,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,IAAA,2BAAS,GAAE,CAAC;IACjC,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,gBAAgB,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC;AACvE,CAAC;AAED,gDAAgD;AAChD,IAAI,MAAM,GAAG,KAAK,CAAC;AACnB,+CAA+C;AAC/C,IAAI,KAAqB,CAAC;AAE1B;;;GAGG;AACI,KAAK,UAAU,WAAW;IAC/B,IAAI,MAAM,EAAE,CAAC;QACX,OAAO;IACT,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,IAAA,2BAAS,GAAE,CAAC;IACjC,MAAM,QAAQ,GAAG,CAAC,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1D,IAAI,QAAQ,EAAE,CAAC;QACb,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC3D,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO;QACT,CAAC;QACD,MAAM,KAAK,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;QACjC,IAAI,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;YACvB,MAAM,QAAQ,EAAE,CAAC;QACnB,CAAC;aAAM,CAAC;YACN,IAAI,KAAK,EAAE,CAAC;gBACV,YAAY,CAAC,KAAK,CAAC,CAAC;YACtB,CAAC;YACD,KAAK,GAAG,UAAU,CAChB,GAAG,EAAE,CAAC,KAAK,QAAQ,EAAE,EACrB,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,EAAE,eAAe,CAAC,CAC9C,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,QAAQ;IAC5B,MAAM,GAAG,IAAI,CAAC;IACd,MAAM,MAAM,GAAG,MAAM,IAAA,2BAAS,GAAE,CAAC;IACjC,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IAClE,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrB,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,KAAK,CAAC,CAAC;QACtC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YACnC,IAAI,CAAC;gBACH,IAAI,CAAC,IAAI,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;oBAC5B,MAAM,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACnC,CAAC;YACH,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,iBAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACnB,IAAI,CAAC,EAAE,CAAC;oBACN,MAAM,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;oBACjD,IAAI,UAAU,GAAG,UAAU,EAAE,CAAC;wBAC5B,MAAM,MAAM,CAAC,IAAI,CACf,QAAQ,EACR,IAAI,CAAC,GAAG,EAAE,GAAG,YAAY,EACzB,SAAS,UAAU,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAC1C,CAAC;oBACJ,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IACD,MAAM,GAAG,KAAK,CAAC;IACf,MAAM,WAAW,EAAE,CAAC;AACtB,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAyDA,gCAEC;AAgCD,wCAgBC;AAkBD,0CAEC;AA8BD,0BAcC;AA0BD,gCAMC;AAWD,kCAyBC;AAkBD,4BA4BC;AA5RD,iEAAwD;AACxD,gEAA6D;AAC7D,+DAA8D;AAQ9D,8DAA8D;AAC9D,MAAM,QAAQ,GAAG,qBAAqB,CAAC;AACvC,MAAM,gBAAgB,GAAG,eAAe,CAAC;AACzC,MAAM,sBAAsB,GAAG,QAAQ,CAAC;AACxC,MAAM,UAAU,GAAG,CAAC,CAAC;AACrB,MAAM,YAAY,GAAG,IAAI,CAAC;AAC1B,MAAM,eAAe,GAAG,QAAQ,CAAC;AACjC,MAAM,YAAY,GAAG,iCAAiC,CAAC;AAEvD,8CAA8C;AAC9C,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAuB,CAAC;AAChD,wDAAwD;AACxD,MAAM,KAAK,GAAG,IAAI,iCAAgB,EAE/B,CAAC;AACJ,KAAK,CAAC,UAAU,CAAC,CAAC,WAAmB,EAAE,OAAoB,EAAE,EAAE;IAC7D,IAAI,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;IACpE,CAAC;IACD,QAAQ,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;AACrC,CAAC,EAAE,IAAI,CAAC,CAAC;AACT,KAAK,CAAC,YAAY,CAAC,CAAC,WAAW,EAAE,EAAE;IACjC,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAgB,UAAU,CAAC,WAAmB,EAAE,OAAoB;IAClE,KAAK,CAAC,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;AACvC,CAAC;AAED,yDAAyD;AACzD,IAAI,UAAiB,CAAC;AAEtB,MAAM,yBAAyB,GAA+B;IAC5D,CAAC,sBAAsB,CAAC,EAAE,GAAG,EAAE,CAAC,KAAK,WAAW,EAAE;CACnD,CAAC;AAEF,SAAS,gBAAgB,CAAC,WAAmB,EAAE,QAAgB;IAC7D,OAAO,GAAG,WAAW,IAAI,QAAQ,EAAE,CAAC;AACtC,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACI,KAAK,UAAU,cAAc;IAClC,UAAU,GAAG,CAAC,MAAM,IAAA,2BAAS,GAAE,CAAC,CAAC,SAAS,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;IAClE,MAAM,UAAU,CAAC,OAAO,EAAE,CAAC;IAC3B,MAAM,UAAU,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;IAC7C,UAAU,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE;QAC5C,IAAI,OAAO,KAAK,gBAAgB,EAAE,CAAC;YACjC,OAAO;QACT,CAAC;QACD,MAAM,OAAO,GAAG,yBAAyB,CAAC,OAAO,CAAC,CAAC;QACnD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO;QACT,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC,CAAC,CAAC;IAEH,KAAK,WAAW,EAAE,CAAC;AACrB,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACI,KAAK,UAAU,eAAe;IACnC,MAAM,UAAU,CAAC,IAAI,EAAE,CAAC;AAC1B,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACI,KAAK,UAAU,OAAO,CAC3B,WAAmB,EACnB,OAAe,EACf,QAAgB;IAEhB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,kCAAkC,WAAW,EAAE,CAAC,CAAC;IACnE,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,IAAA,2BAAS,GAAE,CAAC;IACjC,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,EAAE,gBAAgB,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC9E,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,KAAK,MAAM,CAAC,OAAO,CAAC,gBAAgB,EAAE,sBAAsB,CAAC,CAAC;IAChE,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACI,KAAK,UAAU,UAAU,CAAC,WAAmB,EAAE,QAAgB;IACpE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,kCAAkC,WAAW,EAAE,CAAC,CAAC;IACnE,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,IAAA,2BAAS,GAAE,CAAC;IACjC,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,gBAAgB,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC;AACvE,CAAC;AAED,gDAAgD;AAChD,IAAI,MAAM,GAAG,KAAK,CAAC;AACnB,+CAA+C;AAC/C,IAAI,KAAqB,CAAC;AAE1B;;;GAGG;AACI,KAAK,UAAU,WAAW;IAC/B,IAAI,MAAM,EAAE,CAAC;QACX,OAAO;IACT,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,IAAA,2BAAS,GAAE,CAAC;IACjC,MAAM,QAAQ,GAAG,CAAC,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1D,IAAI,QAAQ,EAAE,CAAC;QACb,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC3D,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO;QACT,CAAC;QACD,MAAM,KAAK,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;QACjC,IAAI,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;YACvB,MAAM,QAAQ,EAAE,CAAC;QACnB,CAAC;aAAM,CAAC;YACN,IAAI,KAAK,EAAE,CAAC;gBACV,YAAY,CAAC,KAAK,CAAC,CAAC;YACtB,CAAC;YACD,KAAK,GAAG,UAAU,CAChB,GAAG,EAAE,CAAC,KAAK,QAAQ,EAAE,EACrB,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,EAAE,eAAe,CAAC,CAC9C,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAED,MAAM,kBAAkB,GAAG;;;;CAI1B,CAAC;AAEF,KAAK,UAAU,YAAY,CAAC,MAAa;IACvC,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IAC7E,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACvD,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,QAAQ;IAC5B,MAAM,GAAG,IAAI,CAAC;IACd,MAAM,MAAM,GAAG,MAAM,IAAA,2BAAS,GAAE,CAAC;IACjC,MAAM,KAAK,GAAG,MAAM,YAAY,CAAC,MAAM,CAAC,CAAC;IACzC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YACnC,IAAI,CAAC;gBACH,IAAI,CAAC,IAAI,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;oBAC5B,MAAM,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACnC,CAAC;YACH,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,iBAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACnB,IAAI,CAAC,EAAE,CAAC;oBACN,MAAM,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;oBACjD,IAAI,UAAU,GAAG,UAAU,EAAE,CAAC;wBAC5B,MAAM,MAAM,CAAC,IAAI,CACf,QAAQ,EACR,IAAI,CAAC,GAAG,EAAE,GAAG,YAAY,EACzB,SAAS,UAAU,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAC1C,CAAC;oBACJ,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IACD,MAAM,GAAG,KAAK,CAAC;IACf,MAAM,WAAW,EAAE,CAAC;AACtB,CAAC"}
@@ -2,7 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  const chai_1 = require("chai");
4
4
  const interface_redis_1 = require("@antelopejs/interface-redis");
5
- const interface_redis_scheduler_1 = require("@antelopejs/interface-redis-scheduler");
5
+ const index_1 = require("../index");
6
6
  const RedisKey = "SchedulerUtil.Tasks";
7
7
  async function cleanupRedis() {
8
8
  const client = await (0, interface_redis_1.GetClient)();
@@ -27,20 +27,81 @@ describe("Redis Scheduler - enableListener / disableListener", () => {
27
27
  describe("Redis Scheduler - runTasks", () => {
28
28
  it("should execute due tasks", async () => RunDueTasksTest());
29
29
  it("should not execute future tasks", async () => SkipFutureTasksTest());
30
+ it("should keep a task rescheduled while due tasks are collected", async () => {
31
+ await cleanupRedis();
32
+ const results = [];
33
+ (0, index_1.setHandler)("test-reschedule", (taskInfo) => {
34
+ results.push(taskInfo);
35
+ });
36
+ const client = await (0, interface_redis_1.GetClient)();
37
+ const later = Date.now() + 60000;
38
+ await client.zadd(RedisKey, Date.now() - 1000, "test-reschedule:renewal");
39
+ await Promise.all([
40
+ (0, index_1.runTasks)(),
41
+ (0, index_1.addTask)("test-reschedule", later, "renewal"),
42
+ ]);
43
+ (0, chai_1.expect)(results).to.deep.equal(["renewal"]);
44
+ (0, chai_1.expect)(await client.zscore(RedisKey, "test-reschedule:renewal")).to.equal(String(later));
45
+ await cleanupRedis();
46
+ });
47
+ it("should keep due tasks when reading them fails", async () => {
48
+ await cleanupRedis();
49
+ const results = [];
50
+ (0, index_1.setHandler)("test-read-failure", (taskInfo) => {
51
+ results.push(taskInfo);
52
+ });
53
+ const client = await (0, interface_redis_1.GetClient)();
54
+ const due = Date.now() - 1000;
55
+ await client.zadd(RedisKey, due, "test-read-failure:renewal");
56
+ if (!isMockClient(client))
57
+ throw new Error("The test project must use the Redis mock");
58
+ const mock = client;
59
+ const store = mock.data;
60
+ let failed = false;
61
+ const failFirstRead = (key) => {
62
+ if (!failed && key === RedisKey) {
63
+ failed = true;
64
+ throw new Error("ERR injected read failure");
65
+ }
66
+ };
67
+ mock.data = {
68
+ ...store,
69
+ get: (key) => (failFirstRead(key), store.get(key)),
70
+ has: (key) => (failFirstRead(key), store.has(key)),
71
+ };
72
+ let rejected = false;
73
+ try {
74
+ await (0, index_1.runTasks)();
75
+ }
76
+ catch {
77
+ rejected = true;
78
+ }
79
+ finally {
80
+ mock.data = store;
81
+ }
82
+ (0, chai_1.expect)(failed).to.equal(true);
83
+ (0, chai_1.expect)(rejected).to.equal(true);
84
+ (0, chai_1.expect)(results).to.deep.equal([]);
85
+ (0, chai_1.expect)(await client.zscore(RedisKey, "test-read-failure:renewal")).to.equal(String(due));
86
+ await cleanupRedis();
87
+ });
30
88
  });
89
+ function isMockClient(client) {
90
+ return "data" in client;
91
+ }
31
92
  describe("Redis Scheduler - retry logic", () => {
32
93
  it("should retry failed tasks up to 3 times", async () => RetryFailedTasksTest());
33
94
  });
34
95
  async function RegisterHandlerTest() {
35
96
  let called = false;
36
- (0, interface_redis_scheduler_1.setHandler)("test-register", () => {
97
+ (0, index_1.setHandler)("test-register", () => {
37
98
  called = true;
38
99
  });
39
100
  (0, chai_1.expect)(called).to.equal(false);
40
101
  }
41
102
  async function RejectColonInNameTest() {
42
103
  try {
43
- (0, interface_redis_scheduler_1.setHandler)("invalid:name", () => { });
104
+ (0, index_1.setHandler)("invalid:name", () => { });
44
105
  chai_1.expect.fail("should have thrown");
45
106
  }
46
107
  catch (err) {
@@ -49,9 +110,9 @@ async function RejectColonInNameTest() {
49
110
  }
50
111
  async function AddTaskTest() {
51
112
  await cleanupRedis();
52
- (0, interface_redis_scheduler_1.setHandler)("test-add", () => { });
113
+ (0, index_1.setHandler)("test-add", () => { });
53
114
  const dueTime = Date.now() + 60000;
54
- await (0, interface_redis_scheduler_1.addTask)("test-add", dueTime, "task-data");
115
+ await (0, index_1.addTask)("test-add", dueTime, "task-data");
55
116
  const client = await (0, interface_redis_1.GetClient)();
56
117
  const members = await client.zrange(RedisKey, 0, -1);
57
118
  (0, chai_1.expect)(members).to.include("test-add:task-data");
@@ -59,7 +120,7 @@ async function AddTaskTest() {
59
120
  }
60
121
  async function AddTaskUnknownHandlerTest() {
61
122
  try {
62
- await (0, interface_redis_scheduler_1.addTask)("nonexistent-handler", Date.now(), "data");
123
+ await (0, index_1.addTask)("nonexistent-handler", Date.now(), "data");
63
124
  chai_1.expect.fail("should have thrown");
64
125
  }
65
126
  catch (err) {
@@ -68,17 +129,17 @@ async function AddTaskUnknownHandlerTest() {
68
129
  }
69
130
  async function RemoveTaskTest() {
70
131
  await cleanupRedis();
71
- (0, interface_redis_scheduler_1.setHandler)("test-remove", () => { });
132
+ (0, index_1.setHandler)("test-remove", () => { });
72
133
  const client = await (0, interface_redis_1.GetClient)();
73
134
  await client.zadd(RedisKey, Date.now() + 60000, "test-remove:remove-data");
74
- await (0, interface_redis_scheduler_1.removeTask)("test-remove", "remove-data");
135
+ await (0, index_1.removeTask)("test-remove", "remove-data");
75
136
  const members = await client.zrange(RedisKey, 0, -1);
76
137
  (0, chai_1.expect)(members).to.not.include("test-remove:remove-data");
77
138
  await cleanupRedis();
78
139
  }
79
140
  async function RemoveTaskUnknownHandlerTest() {
80
141
  try {
81
- await (0, interface_redis_scheduler_1.removeTask)("nonexistent-handler", "data");
142
+ await (0, index_1.removeTask)("nonexistent-handler", "data");
82
143
  chai_1.expect.fail("should have thrown");
83
144
  }
84
145
  catch (err) {
@@ -86,8 +147,8 @@ async function RemoveTaskUnknownHandlerTest() {
86
147
  }
87
148
  }
88
149
  async function EnableDisableListenerTest() {
89
- await (0, interface_redis_scheduler_1.enableListener)();
90
- await (0, interface_redis_scheduler_1.disableListener)();
150
+ await (0, index_1.enableListener)();
151
+ await (0, index_1.disableListener)();
91
152
  }
92
153
  async function EnableListenerUsesLazyConnectTest() {
93
154
  const client = await (0, interface_redis_1.GetClient)();
@@ -97,21 +158,21 @@ async function EnableListenerUsesLazyConnectTest() {
97
158
  duplicateOptions = override;
98
159
  return originalDuplicate(override);
99
160
  });
100
- await (0, interface_redis_scheduler_1.enableListener)();
161
+ await (0, index_1.enableListener)();
101
162
  (0, chai_1.expect)(duplicateOptions).to.deep.include({ lazyConnect: true });
102
- await (0, interface_redis_scheduler_1.disableListener)();
163
+ await (0, index_1.disableListener)();
103
164
  client.duplicate = originalDuplicate;
104
165
  }
105
166
  async function RunDueTasksTest() {
106
167
  await cleanupRedis();
107
168
  const results = [];
108
- (0, interface_redis_scheduler_1.setHandler)("test-run", (taskInfo) => {
169
+ (0, index_1.setHandler)("test-run", (taskInfo) => {
109
170
  results.push(taskInfo);
110
171
  });
111
172
  const client = await (0, interface_redis_1.GetClient)();
112
173
  await client.zadd(RedisKey, Date.now() - 1000, "test-run:payload1");
113
174
  await client.zadd(RedisKey, Date.now() - 500, "test-run:payload2");
114
- await (0, interface_redis_scheduler_1.runTasks)();
175
+ await (0, index_1.runTasks)();
115
176
  (0, chai_1.expect)(results).to.include("payload1");
116
177
  (0, chai_1.expect)(results).to.include("payload2");
117
178
  const remaining = await client.zrange(RedisKey, 0, -1);
@@ -121,12 +182,12 @@ async function RunDueTasksTest() {
121
182
  async function SkipFutureTasksTest() {
122
183
  await cleanupRedis();
123
184
  const results = [];
124
- (0, interface_redis_scheduler_1.setHandler)("test-future", (taskInfo) => {
185
+ (0, index_1.setHandler)("test-future", (taskInfo) => {
125
186
  results.push(taskInfo);
126
187
  });
127
188
  const client = await (0, interface_redis_1.GetClient)();
128
189
  await client.zadd(RedisKey, Date.now() + 60000, "test-future:future-data");
129
- await (0, interface_redis_scheduler_1.runTasks)();
190
+ await (0, index_1.runTasks)();
130
191
  (0, chai_1.expect)(results).to.have.length(0);
131
192
  const remaining = await client.zrange(RedisKey, 0, -1);
132
193
  (0, chai_1.expect)(remaining).to.have.length(1);
@@ -135,13 +196,13 @@ async function SkipFutureTasksTest() {
135
196
  async function RetryFailedTasksTest() {
136
197
  await cleanupRedis();
137
198
  let callCount = 0;
138
- (0, interface_redis_scheduler_1.setHandler)("test-retry", () => {
199
+ (0, index_1.setHandler)("test-retry", () => {
139
200
  callCount++;
140
201
  throw new Error("intentional failure");
141
202
  });
142
203
  const client = await (0, interface_redis_1.GetClient)();
143
204
  await client.zadd(RedisKey, Date.now() - 1000, "test-retry:retry-data");
144
- await (0, interface_redis_scheduler_1.runTasks)();
205
+ await (0, index_1.runTasks)();
145
206
  (0, chai_1.expect)(callCount).to.equal(1);
146
207
  const retryMembers = await client.zrange(RedisKey, 0, -1);
147
208
  (0, chai_1.expect)(retryMembers).to.have.length(1);
@@ -1 +1 @@
1
- {"version":3,"file":"index.test.js","sourceRoot":"","sources":["../../src/tests/index.test.ts"],"names":[],"mappings":";;AAAA,+BAA8B;AAC9B,iEAAwD;AACxD,qFAO+C;AAE/C,MAAM,QAAQ,GAAG,qBAAqB,CAAC;AAEvC,KAAK,UAAU,YAAY;IACzB,MAAM,MAAM,GAAG,MAAM,IAAA,2BAAS,GAAE,CAAC;IACjC,MAAM,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AAC7B,CAAC;AAED,QAAQ,CAAC,8BAA8B,EAAE,GAAG,EAAE;IAC5C,EAAE,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE,CAAC,mBAAmB,EAAE,CAAC,CAAC;IACnE,EAAE,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE,CACxD,qBAAqB,EAAE,CAAC,CAAC;AAC7B,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,2BAA2B,EAAE,GAAG,EAAE;IACzC,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;IACrE,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE,CAChD,yBAAyB,EAAE,CAAC,CAAC;AACjC,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,8BAA8B,EAAE,GAAG,EAAE;IAC5C,EAAE,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE,CAAC,cAAc,EAAE,CAAC,CAAC;IAC7E,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE,CAChD,4BAA4B,EAAE,CAAC,CAAC;AACpC,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,oDAAoD,EAAE,GAAG,EAAE;IAClE,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE,CACtD,yBAAyB,EAAE,CAAC,CAAC;IAC/B,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE,CAC9D,iCAAiC,EAAE,CAAC,CAAC;AACzC,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;IAC1C,EAAE,CAAC,0BAA0B,EAAE,KAAK,IAAI,EAAE,CAAC,eAAe,EAAE,CAAC,CAAC;IAC9D,EAAE,CAAC,iCAAiC,EAAE,KAAK,IAAI,EAAE,CAAC,mBAAmB,EAAE,CAAC,CAAC;AAC3E,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,+BAA+B,EAAE,GAAG,EAAE;IAC7C,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE,CACvD,oBAAoB,EAAE,CAAC,CAAC;AAC5B,CAAC,CAAC,CAAC;AAEH,KAAK,UAAU,mBAAmB;IAChC,IAAI,MAAM,GAAG,KAAK,CAAC;IACnB,IAAA,sCAAU,EAAC,eAAe,EAAE,GAAG,EAAE;QAC/B,MAAM,GAAG,IAAI,CAAC;IAChB,CAAC,CAAC,CAAC;IACH,IAAA,aAAM,EAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AACjC,CAAC;AAED,KAAK,UAAU,qBAAqB;IAClC,IAAI,CAAC;QACH,IAAA,sCAAU,EAAC,cAAc,EAAE,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QACrC,aAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IACpC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAA,aAAM,EAAE,GAAa,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC/D,CAAC;AACH,CAAC;AAED,KAAK,UAAU,WAAW;IACxB,MAAM,YAAY,EAAE,CAAC;IACrB,IAAA,sCAAU,EAAC,UAAU,EAAE,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;IAEjC,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;IACnC,MAAM,IAAA,mCAAO,EAAC,UAAU,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAEhD,MAAM,MAAM,GAAG,MAAM,IAAA,2BAAS,GAAE,CAAC;IACjC,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACrD,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAEjD,MAAM,YAAY,EAAE,CAAC;AACvB,CAAC;AAED,KAAK,UAAU,yBAAyB;IACtC,IAAI,CAAC;QACH,MAAM,IAAA,mCAAO,EAAC,qBAAqB,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,CAAC;QACzD,aAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IACpC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAA,aAAM,EAAE,GAAa,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,+BAA+B,CAAC,CAAC;IAC7E,CAAC;AACH,CAAC;AAED,KAAK,UAAU,cAAc;IAC3B,MAAM,YAAY,EAAE,CAAC;IACrB,IAAA,sCAAU,EAAC,aAAa,EAAE,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;IAEpC,MAAM,MAAM,GAAG,MAAM,IAAA,2BAAS,GAAE,CAAC;IACjC,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,EAAE,yBAAyB,CAAC,CAAC;IAE3E,MAAM,IAAA,sCAAU,EAAC,aAAa,EAAE,aAAa,CAAC,CAAC;IAE/C,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACrD,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAE1D,MAAM,YAAY,EAAE,CAAC;AACvB,CAAC;AAED,KAAK,UAAU,4BAA4B;IACzC,IAAI,CAAC;QACH,MAAM,IAAA,sCAAU,EAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;QAChD,aAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IACpC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAA,aAAM,EAAE,GAAa,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,+BAA+B,CAAC,CAAC;IAC7E,CAAC;AACH,CAAC;AAED,KAAK,UAAU,yBAAyB;IACtC,MAAM,IAAA,0CAAc,GAAE,CAAC;IACvB,MAAM,IAAA,2CAAe,GAAE,CAAC;AAC1B,CAAC;AAED,KAAK,UAAU,iCAAiC;IAC9C,MAAM,MAAM,GAAG,MAAM,IAAA,2BAAS,GAAE,CAAC;IACjC,MAAM,iBAAiB,GAAG,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACxD,IAAI,gBAAqD,CAAC;IAE1D,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,QAAkC,EAAE,EAAE;QACzD,gBAAgB,GAAG,QAAQ,CAAC;QAC5B,OAAO,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC,CAA4B,CAAC;IAE9B,MAAM,IAAA,0CAAc,GAAE,CAAC;IAEvB,IAAA,aAAM,EAAC,gBAAgB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;IAEhE,MAAM,IAAA,2CAAe,GAAE,CAAC;IACxB,MAAM,CAAC,SAAS,GAAG,iBAAiB,CAAC;AACvC,CAAC;AAED,KAAK,UAAU,eAAe;IAC5B,MAAM,YAAY,EAAE,CAAC;IACrB,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,IAAA,sCAAU,EAAC,UAAU,EAAE,CAAC,QAAgB,EAAE,EAAE;QAC1C,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,MAAM,IAAA,2BAAS,GAAE,CAAC;IACjC,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,EAAE,mBAAmB,CAAC,CAAC;IACpE,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,EAAE,mBAAmB,CAAC,CAAC;IAEnE,MAAM,IAAA,oCAAQ,GAAE,CAAC;IAEjB,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACvC,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAEvC,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACvD,IAAA,aAAM,EAAC,SAAS,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAEpC,MAAM,YAAY,EAAE,CAAC;AACvB,CAAC;AAED,KAAK,UAAU,mBAAmB;IAChC,MAAM,YAAY,EAAE,CAAC;IACrB,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,IAAA,sCAAU,EAAC,aAAa,EAAE,CAAC,QAAgB,EAAE,EAAE;QAC7C,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,MAAM,IAAA,2BAAS,GAAE,CAAC;IACjC,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,EAAE,yBAAyB,CAAC,CAAC;IAE3E,MAAM,IAAA,oCAAQ,GAAE,CAAC;IAEjB,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAElC,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACvD,IAAA,aAAM,EAAC,SAAS,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAEpC,MAAM,YAAY,EAAE,CAAC;AACvB,CAAC;AAED,KAAK,UAAU,oBAAoB;IACjC,MAAM,YAAY,EAAE,CAAC;IACrB,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,IAAA,sCAAU,EAAC,YAAY,EAAE,GAAG,EAAE;QAC5B,SAAS,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,MAAM,IAAA,2BAAS,GAAE,CAAC;IACjC,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,EAAE,uBAAuB,CAAC,CAAC;IAExE,MAAM,IAAA,oCAAQ,GAAE,CAAC;IACjB,IAAA,aAAM,EAAC,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAE9B,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC1D,IAAA,aAAM,EAAC,YAAY,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACvC,IAAA,aAAM,EAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,iCAAiC,CAAC,CAAC;IAEpE,MAAM,YAAY,EAAE,CAAC;AACvB,CAAC"}
1
+ {"version":3,"file":"index.test.js","sourceRoot":"","sources":["../../src/tests/index.test.ts"],"names":[],"mappings":";;AAAA,+BAA8B;AAC9B,iEAAwD;AACxD,oCAOkB;AAElB,MAAM,QAAQ,GAAG,qBAAqB,CAAC;AAEvC,KAAK,UAAU,YAAY;IACzB,MAAM,MAAM,GAAG,MAAM,IAAA,2BAAS,GAAE,CAAC;IACjC,MAAM,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AAC7B,CAAC;AAED,QAAQ,CAAC,8BAA8B,EAAE,GAAG,EAAE;IAC5C,EAAE,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE,CAAC,mBAAmB,EAAE,CAAC,CAAC;IACnE,EAAE,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE,CACxD,qBAAqB,EAAE,CAAC,CAAC;AAC7B,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,2BAA2B,EAAE,GAAG,EAAE;IACzC,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;IACrE,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE,CAChD,yBAAyB,EAAE,CAAC,CAAC;AACjC,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,8BAA8B,EAAE,GAAG,EAAE;IAC5C,EAAE,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE,CAAC,cAAc,EAAE,CAAC,CAAC;IAC7E,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE,CAChD,4BAA4B,EAAE,CAAC,CAAC;AACpC,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,oDAAoD,EAAE,GAAG,EAAE;IAClE,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE,CACtD,yBAAyB,EAAE,CAAC,CAAC;IAC/B,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE,CAC9D,iCAAiC,EAAE,CAAC,CAAC;AACzC,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;IAC1C,EAAE,CAAC,0BAA0B,EAAE,KAAK,IAAI,EAAE,CAAC,eAAe,EAAE,CAAC,CAAC;IAC9D,EAAE,CAAC,iCAAiC,EAAE,KAAK,IAAI,EAAE,CAAC,mBAAmB,EAAE,CAAC,CAAC;IACzE,EAAE,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;QAC5E,MAAM,YAAY,EAAE,CAAC;QACrB,MAAM,OAAO,GAAa,EAAE,CAAC;QAC7B,IAAA,kBAAU,EAAC,iBAAiB,EAAE,CAAC,QAAgB,EAAE,EAAE;YACjD,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACzB,CAAC,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,MAAM,IAAA,2BAAS,GAAE,CAAC;QACjC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;QACjC,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,EAAE,yBAAyB,CAAC,CAAC;QAE1E,MAAM,OAAO,CAAC,GAAG,CAAC;YAChB,IAAA,gBAAQ,GAAE;YACV,IAAA,eAAO,EAAC,iBAAiB,EAAE,KAAK,EAAE,SAAS,CAAC;SAC7C,CAAC,CAAC;QAEH,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;QAC3C,IAAA,aAAM,EAAC,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,yBAAyB,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CACvE,MAAM,CAAC,KAAK,CAAC,CACd,CAAC;QAEF,MAAM,YAAY,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;QAC7D,MAAM,YAAY,EAAE,CAAC;QACrB,MAAM,OAAO,GAAa,EAAE,CAAC;QAC7B,IAAA,kBAAU,EAAC,mBAAmB,EAAE,CAAC,QAAgB,EAAE,EAAE;YACnD,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACzB,CAAC,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,MAAM,IAAA,2BAAS,GAAE,CAAC;QACjC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;QAC9B,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE,2BAA2B,CAAC,CAAC;QAC9D,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAC9D,MAAM,IAAI,GAAG,MAAM,CAAC;QACpB,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC;QACxB,IAAI,MAAM,GAAG,KAAK,CAAC;QACnB,MAAM,aAAa,GAAG,CAAC,GAAW,EAAE,EAAE;YACpC,IAAI,CAAC,MAAM,IAAI,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAChC,MAAM,GAAG,IAAI,CAAC;gBACd,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;YAC/C,CAAC;QACH,CAAC,CAAC;QACF,IAAI,CAAC,IAAI,GAAG;YACV,GAAG,KAAK;YACR,GAAG,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAClD,GAAG,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;SACnD,CAAC;QAEF,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,IAAI,CAAC;YACH,MAAM,IAAA,gBAAQ,GAAE,CAAC;QACnB,CAAC;QAAC,MAAM,CAAC;YACP,QAAQ,GAAG,IAAI,CAAC;QAClB,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC;QACpB,CAAC;QAED,IAAA,aAAM,EAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAA,aAAM,EAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAChC,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAClC,IAAA,aAAM,EAAC,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,2BAA2B,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CACzE,MAAM,CAAC,GAAG,CAAC,CACZ,CAAC;QAEF,MAAM,YAAY,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAOH,SAAS,YAAY,CACnB,MAAS;IAET,OAAO,MAAM,IAAI,MAAM,CAAC;AAC1B,CAAC;AAED,QAAQ,CAAC,+BAA+B,EAAE,GAAG,EAAE;IAC7C,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE,CACvD,oBAAoB,EAAE,CAAC,CAAC;AAC5B,CAAC,CAAC,CAAC;AAEH,KAAK,UAAU,mBAAmB;IAChC,IAAI,MAAM,GAAG,KAAK,CAAC;IACnB,IAAA,kBAAU,EAAC,eAAe,EAAE,GAAG,EAAE;QAC/B,MAAM,GAAG,IAAI,CAAC;IAChB,CAAC,CAAC,CAAC;IACH,IAAA,aAAM,EAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AACjC,CAAC;AAED,KAAK,UAAU,qBAAqB;IAClC,IAAI,CAAC;QACH,IAAA,kBAAU,EAAC,cAAc,EAAE,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QACrC,aAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IACpC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAA,aAAM,EAAE,GAAa,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC/D,CAAC;AACH,CAAC;AAED,KAAK,UAAU,WAAW;IACxB,MAAM,YAAY,EAAE,CAAC;IACrB,IAAA,kBAAU,EAAC,UAAU,EAAE,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;IAEjC,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;IACnC,MAAM,IAAA,eAAO,EAAC,UAAU,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAEhD,MAAM,MAAM,GAAG,MAAM,IAAA,2BAAS,GAAE,CAAC;IACjC,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACrD,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAEjD,MAAM,YAAY,EAAE,CAAC;AACvB,CAAC;AAED,KAAK,UAAU,yBAAyB;IACtC,IAAI,CAAC;QACH,MAAM,IAAA,eAAO,EAAC,qBAAqB,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,CAAC;QACzD,aAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IACpC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAA,aAAM,EAAE,GAAa,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,+BAA+B,CAAC,CAAC;IAC7E,CAAC;AACH,CAAC;AAED,KAAK,UAAU,cAAc;IAC3B,MAAM,YAAY,EAAE,CAAC;IACrB,IAAA,kBAAU,EAAC,aAAa,EAAE,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;IAEpC,MAAM,MAAM,GAAG,MAAM,IAAA,2BAAS,GAAE,CAAC;IACjC,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,EAAE,yBAAyB,CAAC,CAAC;IAE3E,MAAM,IAAA,kBAAU,EAAC,aAAa,EAAE,aAAa,CAAC,CAAC;IAE/C,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACrD,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAE1D,MAAM,YAAY,EAAE,CAAC;AACvB,CAAC;AAED,KAAK,UAAU,4BAA4B;IACzC,IAAI,CAAC;QACH,MAAM,IAAA,kBAAU,EAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;QAChD,aAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IACpC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAA,aAAM,EAAE,GAAa,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,+BAA+B,CAAC,CAAC;IAC7E,CAAC;AACH,CAAC;AAED,KAAK,UAAU,yBAAyB;IACtC,MAAM,IAAA,sBAAc,GAAE,CAAC;IACvB,MAAM,IAAA,uBAAe,GAAE,CAAC;AAC1B,CAAC;AAED,KAAK,UAAU,iCAAiC;IAC9C,MAAM,MAAM,GAAG,MAAM,IAAA,2BAAS,GAAE,CAAC;IACjC,MAAM,iBAAiB,GAAG,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACxD,IAAI,gBAAqD,CAAC;IAE1D,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,QAAkC,EAAE,EAAE;QACzD,gBAAgB,GAAG,QAAQ,CAAC;QAC5B,OAAO,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC,CAA4B,CAAC;IAE9B,MAAM,IAAA,sBAAc,GAAE,CAAC;IAEvB,IAAA,aAAM,EAAC,gBAAgB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;IAEhE,MAAM,IAAA,uBAAe,GAAE,CAAC;IACxB,MAAM,CAAC,SAAS,GAAG,iBAAiB,CAAC;AACvC,CAAC;AAED,KAAK,UAAU,eAAe;IAC5B,MAAM,YAAY,EAAE,CAAC;IACrB,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,IAAA,kBAAU,EAAC,UAAU,EAAE,CAAC,QAAgB,EAAE,EAAE;QAC1C,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,MAAM,IAAA,2BAAS,GAAE,CAAC;IACjC,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,EAAE,mBAAmB,CAAC,CAAC;IACpE,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,EAAE,mBAAmB,CAAC,CAAC;IAEnE,MAAM,IAAA,gBAAQ,GAAE,CAAC;IAEjB,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACvC,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAEvC,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACvD,IAAA,aAAM,EAAC,SAAS,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAEpC,MAAM,YAAY,EAAE,CAAC;AACvB,CAAC;AAED,KAAK,UAAU,mBAAmB;IAChC,MAAM,YAAY,EAAE,CAAC;IACrB,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,IAAA,kBAAU,EAAC,aAAa,EAAE,CAAC,QAAgB,EAAE,EAAE;QAC7C,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,MAAM,IAAA,2BAAS,GAAE,CAAC;IACjC,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,EAAE,yBAAyB,CAAC,CAAC;IAE3E,MAAM,IAAA,gBAAQ,GAAE,CAAC;IAEjB,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAElC,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACvD,IAAA,aAAM,EAAC,SAAS,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAEpC,MAAM,YAAY,EAAE,CAAC;AACvB,CAAC;AAED,KAAK,UAAU,oBAAoB;IACjC,MAAM,YAAY,EAAE,CAAC;IACrB,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,IAAA,kBAAU,EAAC,YAAY,EAAE,GAAG,EAAE;QAC5B,SAAS,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,MAAM,IAAA,2BAAS,GAAE,CAAC;IACjC,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,EAAE,uBAAuB,CAAC,CAAC;IAExE,MAAM,IAAA,gBAAQ,GAAE,CAAC;IACjB,IAAA,aAAM,EAAC,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAE9B,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC1D,IAAA,aAAM,EAAC,YAAY,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACvC,IAAA,aAAM,EAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,iCAAiC,CAAC,CAAC;IAEpE,MAAM,YAAY,EAAE,CAAC;AACvB,CAAC"}
@@ -6,6 +6,17 @@ Interface Redis Scheduler stores tasks in a Redis sorted set with their due time
6
6
 
7
7
  Use one active listener for a queue and make handlers idempotent. Concurrent listeners can read the same due tasks before either removes them, and a process failure after removal but before handler completion can lose a task. Redis persistence protects queued entries only according to the server's persistence configuration.
8
8
 
9
+ ## Schedule a task safely
10
+
11
+ 1. Register the task type with [`setHandler`](#sethandler), including in processes that enqueue or remove tasks.
12
+ 2. Start one active [`enableListener`](#enablelistener) for the queue after registering its handlers.
13
+ 3. Save the serialized payload, then call [`addTask`](#addtask) with a due time in milliseconds.
14
+ 4. Use that exact payload for [`removeTask`](#removetask); do not recreate timestamps when canceling.
15
+
16
+ ![Due tasks are read and removed before their handlers run. A thrown handler retries after five seconds, up to three retries; a process crash in that gap can lose work.](./assets/task-delivery.svg){width="480"}
17
+
18
+ **Decide before adopting:** this scheduler fits work whose loss or repetition your application can tolerate or reconcile. It does not promise exactly-once execution, durable in-flight ownership, or a full shutdown/drain API. Review [retry logic](#retry-logic) and [shutdown limits](#disablelistener) before production use.
19
+
9
20
  ## Getting Started
10
21
 
11
22
  Install the package in your project:
@@ -16,6 +27,36 @@ npm install @antelopejs/interface-redis-scheduler
16
27
 
17
28
  > **Note:** This package depends on `@antelopejs/interface-redis`. You must have it installed and configured for the scheduler to connect to Redis.
18
29
 
30
+ ## Try one scheduled task
31
+
32
+ Run this from an initialized application against a disposable Redis database,
33
+ with no other scheduler listener. It logs a reminder after about one minute;
34
+ it does not send an email or charge a payment.
35
+
36
+ ```typescript
37
+ import {
38
+ setHandler,
39
+ enableListener,
40
+ addTask,
41
+ } from "@antelopejs/interface-redis-scheduler";
42
+
43
+ setHandler("docs-reminder", (taskInfo) => {
44
+ console.log("Reminder:", taskInfo);
45
+ });
46
+
47
+ await enableListener();
48
+ const taskInfo = JSON.stringify({
49
+ jobId: "demo-001",
50
+ message: "Review your draft",
51
+ });
52
+ await addTask("docs-reminder", Date.now() + 60_000, taskInfo);
53
+ ```
54
+
55
+ Keep the process alive to observe the reminder. The due time is a Unix timestamp
56
+ in milliseconds, not a delay. Save `taskInfo` if you may later remove the queued
57
+ entry; [removal is not a cancellation guarantee](#removetask). The public API does
58
+ not fully stop timers, so end this disposable process when finished.
59
+
19
60
  ## Core Concepts
20
61
 
21
62
  The scheduler operates around three main ideas:
@@ -26,7 +67,7 @@ The scheduler operates around three main ideas:
26
67
 
27
68
  ## `setHandler`
28
69
 
29
- The `setHandler` function registers a handler for a specific task type. Each handler has a unique name and a callback function that receives the task data as a string.
70
+ The `setHandler` function registers a handler for a specific task type. Each handler has a unique name and a callback function that receives the task data as a string. The `sendEmail` function below belongs to your application; it is not a scheduler export.
30
71
 
31
72
  ```typescript
32
73
  import { setHandler } from "@antelopejs/interface-redis-scheduler";
@@ -91,22 +132,26 @@ The `addTask` function schedules a task for execution at a specific time. The ta
91
132
  ```typescript
92
133
  import { addTask } from "@antelopejs/interface-redis-scheduler";
93
134
 
94
- async function scheduleReminder(userId: string) {
135
+ async function scheduleReminder(recipient: string) {
95
136
  // Schedule for 3 days from now
96
137
  const dueTime = Date.now() + 3 * 24 * 60 * 60 * 1000;
97
138
 
98
139
  const taskInfo = JSON.stringify({
99
- userId,
100
- type: "password_reminder",
140
+ recipient,
141
+ subject: "Review your draft",
142
+ body: "Your draft is waiting for review.",
101
143
  createdAt: new Date().toISOString(),
102
144
  });
103
145
 
104
146
  await addTask("send-email", dueTime, taskInfo);
147
+ return taskInfo; // Persist this exact string for removal.
105
148
  }
106
149
  ```
107
150
 
108
151
  The function throws an error if the specified handler name has not been registered.
109
152
 
153
+ The pair `handlerName` + `taskInfo` identifies the queued member. Adding the same pair again changes its due time rather than creating another independent task. Include a stable job ID in the payload when two otherwise identical jobs must remain distinct.
154
+
110
155
  ### Parameters
111
156
 
112
157
  | Parameter | Type | Description |
@@ -117,19 +162,13 @@ The function throws an error if the specified handler name has not been register
117
162
 
118
163
  ## `removeTask`
119
164
 
120
- The `removeTask` function cancels a previously scheduled task. The `taskInfo` string must match the one used when the task was added.
165
+ The `removeTask` function removes the original queued entry, if it is still present. Pass the saved `taskInfo` string returned by `scheduleReminder`, rather than reconstructing the JSON.
121
166
 
122
167
  ```typescript
123
168
  import { removeTask } from "@antelopejs/interface-redis-scheduler";
124
169
 
125
- async function cancelReminder(userId: string) {
126
- const taskInfo = JSON.stringify({
127
- userId,
128
- type: "password_reminder",
129
- createdAt: "2025-04-05T12:00:00.000Z", // Must match exactly
130
- });
131
-
132
- await removeTask("send-email", taskInfo);
170
+ async function removeQueuedReminder(savedTaskInfo: string) {
171
+ await removeTask("send-email", savedTaskInfo);
133
172
  }
134
173
  ```
135
174
 
@@ -137,6 +176,8 @@ The function throws an error if the specified handler name has not been register
137
176
 
138
177
  > **Warning:** The `taskInfo` must be an exact string match of the original task. If the serialized JSON differs in key order or whitespace, the removal fails silently.
139
178
 
179
+ Removal targets the original queued member only. It does not stop a running handler or remove a retry stored with a `RETRY-` prefix. If cancellation must survive races and retries, make the handler check application-owned cancellation state before applying effects.
180
+
140
181
  ### Parameters
141
182
 
142
183
  | Parameter | Type | Description |
@@ -150,7 +191,7 @@ The scheduler automatically retries failed tasks. When a handler throws an error
150
191
 
151
192
  - **Maximum retries:** 3 retries after the initial attempt (4 attempts total)
152
193
  - **Retry delay:** 5 seconds between each attempt
153
- - **Behavior on exhaustion:** After 3 failed retries, the task is discarded and the error is logged to the console
194
+ - **Behavior on exhaustion:** After 3 failed retries, the task is discarded; failures are reported through `Logging.Error`
154
195
 
155
196
  No additional code is required to enable retries. The mechanism is built into the task execution loop.
156
197
 
@@ -158,13 +199,17 @@ No additional code is required to enable retries. The mechanism is built into th
158
199
  import { setHandler } from "@antelopejs/interface-redis-scheduler";
159
200
 
160
201
  // If this handler throws, the scheduler retries up to 3 times
161
- setHandler("process-payment", async (taskInfo) => {
202
+ setHandler("refresh-summary", async (taskInfo) => {
162
203
  const data = JSON.parse(taskInfo);
163
- await processPayment(data);
204
+ await refreshSummary(data);
164
205
  // On failure: retry after 5s, then 5s, then 5s, then discard
165
206
  });
166
207
  ```
167
208
 
209
+ `refreshSummary` is an application function that recomputes a replaceable summary.
210
+ Choose retryable, idempotent work; a retry is not proof that the previous attempt
211
+ had no effect. Do not use this sketch as a durable payment-processing queue.
212
+
168
213
  ## Redis Storage
169
214
 
170
215
  The scheduler uses a single Redis sorted set with the key `SchedulerUtil.Tasks`. Each member in the sorted set follows the format `handlerName:taskInfo`, and its score is the due timestamp in milliseconds.
@@ -197,7 +242,7 @@ await runTasks();
197
242
 
198
243
  ## Complete Example
199
244
 
200
- Here is a full integration example showing handler registration, listener startup, task scheduling, and shutdown.
245
+ This integration sketch shows handler registration, listener startup, scheduling, and subscriber cleanup. `sendEmail`, `deleteSession`, and `refreshSummary` in these examples stand for application functions you supply; they are not scheduler exports. The examples require a configured Redis implementation and do not run a service from this page.
201
246
 
202
247
  ```typescript
203
248
  import {
@@ -0,0 +1,18 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" width="480" height="760" viewBox="0 0 480 760" role="img" aria-labelledby="title desc">
2
+ <title id="title">Task delivery and the in-flight gap</title>
3
+ <desc id="desc">A timer reads due tasks from a sorted set and removes them before calling handlers. Successful handlers finish. Thrown errors requeue after five seconds, up to three retries. A crash after removal can lose work; pub/sub only refreshes timers.</desc>
4
+ <defs><marker id="arrow" markerWidth="8" markerHeight="8" refX="7" refY="4" orient="auto"><path d="M0 0 8 4 0 8" fill="#627d98"/></marker></defs>
5
+ <rect width="480" height="760" rx="16" fill="#f4f7fb"/>
6
+ <g font-family="system-ui, sans-serif" fill="#17324d" font-size="18">
7
+ <text x="24" y="36" font-size="24" font-weight="700">Remove first. Run the handler.</text><text x="24" y="70">One listener · idempotent handlers</text><text x="24" y="99">Application-owned recovery</text>
8
+ <rect x="24" y="126" width="400" height="86" rx="10" fill="#e2edf8" stroke="#b0c9e0"/><text x="44" y="160" font-size="22" font-weight="700">Queued in Redis</text><text x="44" y="190">Score = due time (milliseconds)</text>
9
+ <path d="M224 212V246" stroke="#627d98" stroke-width="2" marker-end="url(#arrow)"/>
10
+ <rect x="24" y="258" width="400" height="86" rx="10" fill="#fff0cf"/><text x="44" y="292" font-size="22" font-weight="700">Read + remove due tasks</text><text x="44" y="322">Not an atomic claim</text>
11
+ <path d="M224 344V378" stroke="#627d98" stroke-width="2" marker-end="url(#arrow)"/>
12
+ <rect x="24" y="390" width="400" height="86" rx="10" fill="#17324d"/><text x="44" y="424" fill="#fff" font-size="22" font-weight="700">Run handler</text><text x="44" y="454" fill="#d5e5f3">Success → done</text>
13
+ <path d="M424 433H448V169H424" fill="none" stroke="#627d98" stroke-width="2" stroke-dasharray="5 5" marker-end="url(#arrow)"/>
14
+ <text x="24" y="514" font-weight="600">Dashed path: handler throws</text><text x="24" y="544">Retry after 5s · at most 3 retries</text>
15
+ <rect x="24" y="573" width="432" height="164" rx="8" fill="#fbe6e2"/>
16
+ <text x="44" y="606" font-size="20" font-weight="600">Crash after removal?</text><text x="44" y="635">The in-flight task can be lost.</text><text x="44" y="669" font-size="16">Pub/sub refreshes timers, not ownership.</text><text x="44" y="699" font-size="16">disableListener() closes notifications only.</text>
17
+ </g>
18
+ </svg>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@antelopejs/interface-redis-scheduler",
3
- "version": "0.0.8",
3
+ "version": "0.0.9",
4
4
  "description": "AntelopeJS interface for scheduling tasks on Redis, with retries on failure",
5
5
  "keywords": [
6
6
  "antelopejs",
@@ -45,7 +45,15 @@
45
45
  "release": "pnpm run lint && pnpm run prepack && release-it",
46
46
  "test": "pnpm run build && ajs module test .",
47
47
  "format:check": "oxfmt --check .",
48
- "knip": "knip"
48
+ "knip": "knip",
49
+ "prepare": "if git rev-parse --is-inside-work-tree >/dev/null 2>&1 && command -v lefthook >/dev/null 2>&1; then lefthook install; fi",
50
+ "checks": "antelopejs-checks",
51
+ "size": "antelopejs-check-size",
52
+ "ratchet": "antelopejs-ratchet",
53
+ "sync": "antelopejs-sync",
54
+ "ratchet:update": "antelopejs-ratchet --update",
55
+ "sync:check": "antelopejs-sync --check",
56
+ "typecheck": "tsc --noEmit"
49
57
  },
50
58
  "dependencies": {
51
59
  "ioredis": "^5.10.1"
@@ -54,13 +62,14 @@
54
62
  "@antelopejs/core": "^1.16.0",
55
63
  "@antelopejs/interface-core": "^0.2.4",
56
64
  "@antelopejs/interface-redis": "^0.0.9",
57
- "@antelopejs/tooling-configs": "^0.0.9",
65
+ "@antelopejs/tooling-configs": "^0.2.0",
58
66
  "@types/chai": "^4.3.20",
59
67
  "@types/mocha": "^10.0.10",
60
68
  "@types/node": "^22.19.15",
61
69
  "chai": "^4.5.0",
62
70
  "eslint-plugin-perfectionist": "^5.11.0",
63
71
  "knip": "^6.34.0",
72
+ "lefthook": "^2.2.2",
64
73
  "oxfmt": "^0.66.0",
65
74
  "oxlint": "1.81.0",
66
75
  "oxlint-tsgolint": "^7.0.2001",