Fix cron execution by replacing node-cron with croner.

Author: dgrelaud

CHANGELOG.md

@@ -1,4 +1,8 @@
 
+## v0.3.1
+
+- Fix cron execution by replacing `node-cron` with `croner`.
+
 ## v0.3.0
 
 - Fixed the connected-peers metric so it now reports the real-time value.

lib/index.js

@@ -6,7 +6,7 @@ const Debugger = require('debug');
 const EventEmitter = require('node:events');
 const assert = require('node:assert');
 const { performance } = require('node:perf_hooks');
-const cron = require('node-cron');
+const { Cron } = require('croner');
 
 // Remote peer index pointers in the peerStats array for fast access (avoiding map lookup of objects, ...)
 // [LAST_PATCH_AT_TIMESTAMP, LAST_SEQUENCE_ID, GUARANTEED_CONTIGUOUS_PATCH_AT_TIMESTAMP, GUARANTEED_CONTIGUOUS_SEQUENCE_ID, LAST_MESSAGE_TIMESTAMP]
@@ -116,10 +116,12 @@ const SQLiteOnSteroid = (db, myPeerId = null, options) => {
     heartbeatInterval = setInterval(_heartBeat, HEARTBEAT_INTERVAL_MS);
   }
   if (DATABASE_BACKUP_CRON) {
-    if (!cron.validate(DATABASE_BACKUP_CRON) ) {
-      throw new Error(`Invalid database backup cron syntax: ${DATABASE_BACKUP_CRON}`);
+    try {
+      backupTask = new Cron(DATABASE_BACKUP_CRON, { paused : true, protect : true }, backupDatabase);
+    }
+    catch (err) {
+      throw new Error(`Invalid database backup cron syntax: ${err.message}`);
     }
-    backupTask = cron.createTask(DATABASE_BACKUP_CRON, backupDatabase, { noOverlap : true });
   }
 
   /**
@@ -133,6 +135,9 @@ const SQLiteOnSteroid = (db, myPeerId = null, options) => {
    * @param {Function} callback
    */
   function backupDatabase (trigger = 'scheduled', callback) {
+    if (typeof trigger !== 'string') {
+      trigger = 'scheduled'; // Cron send the cron object as first argument
+    }
     DATABASE_BACKUP_ABSOLUTE_PATH_FN(trigger, (_backupFileName) => {
       if (!_backupFileName) {
         debug('No backup for ${trigger} trigger');
@@ -756,11 +761,11 @@ const SQLiteOnSteroid = (db, myPeerId = null, options) => {
     if (amITheLeaderCached !== _amITheLeader) {
       if (_amITheLeader === true) {
         debug('became leader');
-        backupTask?.start(); // manage backup cron
+        backupTask?.resume(); // manage backup cron
       }
       else {
         debug('lost leader role');
-        backupTask?.stop();
+        backupTask?.pause();
       }
     }
     amITheLeaderCached = _amITheLeader;

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "replic-sqlite",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Simple, Fast, Multi-writer, Convergent, Replicated SQLite with 800 LOC only",
   "main": "lib/index.js",
   "repository": {
@@ -35,7 +35,7 @@
   },
   "dependencies": {
     "better-sqlite3": "=12.6.2",
-    "debug": "=4.4.3",
-    "node-cron": "=4.2.1"
+    "croner": "=10.0.1",
+    "debug": "=4.4.3"
   }
 }

package.json

@@ -269,13 +269,14 @@ describe('main', function () {
 
     it('should detect the leader (and start backup cron or not)', function (done) {
       assert.strictEqual(app.amITheLeader(), true);
-      assert.strictEqual(app.backupTask.stateMachine.state, 'idle');
+      assert.strictEqual(app.backupTask.isRunning(), true);
       app.addRemotePeer(100, fakePeerSockets[100], { ip : '127.0.0.1', port : 10000 });
       app.addRemotePeer(101, fakePeerSockets[101], { ip : '127.0.0.1', port : 10001 });
       app.addRemotePeer(110, fakePeerSockets[110], { ip : '127.0.0.1', port : 10002 });
       assert.strictEqual(extractNbConnectedPeersFromMetrics( app.metrics()), 3);
       assert.strictEqual(app.amITheLeader(), false);
-      assert.strictEqual(app.backupTask.stateMachine.state, 'stopped');
+      assert.strictEqual(app.backupTask.isRunning(), false);
+      assert.strictEqual(app.backupTask.isStopped(), false);
       app.closeRemotePeer(101);
       assert.strictEqual(extractNbConnectedPeersFromMetrics( app.metrics()), 2);
       assert.strictEqual(app.amITheLeader(), false);
@@ -290,7 +291,7 @@ describe('main', function () {
       // should be the leader after 500ms (disconnection tolerance)
       setTimeout(() => {
         assert.strictEqual(app.amITheLeader(), true);
-        assert.strictEqual(app.backupTask.stateMachine.state, 'idle');
+        assert.strictEqual(app.backupTask.isRunning(), true);
         assert.strictEqual(extractNbConnectedPeersFromMetrics( app.metrics()), 1);
         done();
       }, 500);
@@ -1364,7 +1365,7 @@ describe('main', function () {
         finishTestIfReady();
       });
       // No callback to backupDatabase, so events must fire
-      _app.backupDatabase('scheduled');
+      _app.backupDatabase({}); // send the cron object as first argument to verify that the trigger is set to 'scheduled'
       // Helper to call done when both events are received
       function finishTestIfReady () {
         if (gotCompleted && gotProgress) {