Fix #6586: Reset retries and set UP status for successful push heartb…

server/determine-status.js

@@ -0,0 +1,65 @@
+const { UP, DOWN, PENDING, flipStatus } = require("../src/util");
+
+/**
+ * Determine the status of a monitor based on the current status, previous heartbeat, and configuration
+ * @param {number} status - The current status from the monitor
+ * @param {object} previousHeartbeat - The previous heartbeat object
+ * @param {number} maxretries - The maximum number of retries allowed
+ * @param {boolean} isUpsideDown - Indicates if the monitor is upside down
+ * @param {object} bean - The new heartbeat object
+ * @returns {void}
+ */
+function determineStatus(status, previousHeartbeat, maxretries, isUpsideDown, bean) {
+    if (isUpsideDown) {
+        status = flipStatus(status);
+    }
+
+    if (previousHeartbeat) {
+        if (previousHeartbeat.status === UP && status === DOWN) {
+            // Going Down
+            if (maxretries > 0 && previousHeartbeat.retries < maxretries) {
+                // Retries available
+                bean.retries = previousHeartbeat.retries + 1;
+                bean.status = PENDING;
+            } else {
+                // No more retries
+                bean.retries = 0;
+                bean.status = DOWN;
+            }
+        } else if (previousHeartbeat.status === PENDING && status === DOWN) {
+            if (previousHeartbeat.retries < maxretries) {
+                // Retries available
+                bean.retries = previousHeartbeat.retries + 1;
+                bean.status = PENDING;
+            } else {
+                // No more retries, set to DOWN and reset retries
+                bean.retries = 0;
+                bean.status = DOWN;
+            }
+        } else {
+            // No more retries or not pending
+            if (status === DOWN) {
+                bean.retries = previousHeartbeat.retries + 1;
+                bean.status = status;
+            } else {
+                bean.retries = 0;
+                bean.status = status;
+            }
+        }
+    } else {
+        // First beat?
+        if (status === DOWN && maxretries > 0) {
+            // Retries available
+            bean.retries = 1;
+            bean.status = PENDING;
+        } else {
+            // Retires not enabled
+            bean.retries = 0;
+            bean.status = status;
+        }
+    }
+}
+
+module.exports = {
+    determineStatus,
+};

server/model/monitor.js

@@ -729,7 +729,6 @@ class Monitor extends BeanModel {
                                 timeout += bufferTime;
                             }
                             // No need to insert successful heartbeat for push type, so end here
-                            retries = 0;
                             log.debug("monitor", `[${this.name}] timeout = ${timeout}`);
                             this.heartbeatInterval = setTimeout(safeBeat, timeout);
                             return;

server/routers/api-router.js

@@ -11,12 +11,13 @@ const { R } = require("redbean-node");
 const apicache = require("../modules/apicache");
 const Monitor = require("../model/monitor");
 const dayjs = require("dayjs");
-const { UP, MAINTENANCE, DOWN, PENDING, flipStatus, log, badgeConstants } = require("../../src/util");
+const { UP, MAINTENANCE, DOWN, PENDING, log, badgeConstants } = require("../../src/util");
 const StatusPage = require("../model/status_page");
 const { UptimeKumaServer } = require("../uptime-kuma-server");
 const { makeBadge } = require("badge-maker");
 const { Prometheus } = require("../prometheus");
 const Database = require("../database");
+const { determineStatus } = require("../determine-status");
 const { UptimeCalculator } = require("../uptime-calculator");
 
 let router = express.Router();
@@ -577,58 +578,4 @@ router.get("/api/badge/:id/response", cache("5 minutes"), async (request, respon
     }
 });
 
-/**
- * Determines the status of the next beat in the push route handling.
- * @param {string} status - The reported new status.
- * @param {object} previousHeartbeat - The previous heartbeat object.
- * @param {number} maxretries - The maximum number of retries allowed.
- * @param {boolean} isUpsideDown - Indicates if the monitor is upside down.
- * @param {object} bean - The new heartbeat object.
- * @returns {void}
- */
-function determineStatus(status, previousHeartbeat, maxretries, isUpsideDown, bean) {
-    if (isUpsideDown) {
-        status = flipStatus(status);
-    }
-
-    if (previousHeartbeat) {
-        if (previousHeartbeat.status === UP && status === DOWN) {
-            // Going Down
-            if (maxretries > 0 && previousHeartbeat.retries < maxretries) {
-                // Retries available
-                bean.retries = previousHeartbeat.retries + 1;
-                bean.status = PENDING;
-            } else {
-                // No more retries
-                bean.retries = 0;
-                bean.status = DOWN;
-            }
-        } else if (previousHeartbeat.status === PENDING && status === DOWN && previousHeartbeat.retries < maxretries) {
-            // Retries available
-            bean.retries = previousHeartbeat.retries + 1;
-            bean.status = PENDING;
-        } else {
-            // No more retries or not pending
-            if (status === DOWN) {
-                bean.retries = previousHeartbeat.retries + 1;
-                bean.status = status;
-            } else {
-                bean.retries = 0;
-                bean.status = status;
-            }
-        }
-    } else {
-        // First beat?
-        if (status === DOWN && maxretries > 0) {
-            // Retries available
-            bean.retries = 1;
-            bean.status = PENDING;
-        } else {
-            // Retires not enabled
-            bean.retries = 0;
-            bean.status = status;
-        }
-    }
-}
-
 module.exports = router;

test/backend-test/test-determineStatus.js

@@ -0,0 +1,71 @@
+const { describe, test } = require("node:test");
+const assert = require("node:assert");
+const { UP, DOWN, PENDING } = require("../../src/util");
+const { determineStatus } = require("../../server/determine-status");
+
+describe("Push API Retry Reset Issue #6586", () => {
+    test("determineStatus() resets retries to 0 when status changes from DOWN to UP", () => {
+        const previousHeartbeat = {
+            status: DOWN,
+            retries: 2,
+        };
+
+        const bean = {};
+
+        determineStatus(UP, previousHeartbeat, 3, false, bean);
+
+        assert.strictEqual(bean.status, UP);
+        assert.strictEqual(bean.retries, 0);
+    });
+
+    test("determineStatus() resets retries to 0 when status changes from PENDING to UP", () => {
+        const previousHeartbeat = {
+            status: PENDING,
+            retries: 1,
+        };
+
+        const bean = {};
+
+        determineStatus(UP, previousHeartbeat, 3, false, bean);
+
+        assert.strictEqual(bean.status, UP);
+        assert.strictEqual(bean.retries, 0);
+    });
+
+    test("determineStatus() handles PENDING status exceeding maxretries correctly", () => {
+        const previousHeartbeat = {
+            status: PENDING,
+            retries: 3,
+        };
+
+        const bean = {};
+
+        determineStatus(DOWN, previousHeartbeat, 3, false, bean);
+
+        assert.strictEqual(bean.status, DOWN);
+        assert.strictEqual(bean.retries, 0);
+    });
+
+    test("determineStatus() increments retries when status remains DOWN", () => {
+        const previousHeartbeat = {
+            status: DOWN,
+            retries: 1,
+        };
+
+        const bean = {};
+
+        determineStatus(DOWN, previousHeartbeat, 3, false, bean);
+
+        assert.strictEqual(bean.status, DOWN);
+        assert.strictEqual(bean.retries, 2);
+    });
+
+    test("determineStatus() handles first heartbeat correctly", () => {
+        const bean = {};
+
+        determineStatus(UP, null, 3, false, bean);
+
+        assert.strictEqual(bean.status, UP);
+        assert.strictEqual(bean.retries, 0);
+    });
+});