refactor(database): clarify comments on heartbeat write logic to prevent workflow and audit log spamming

Author: nawazdhandala

App/FeatureSet/Telemetry/Jobs/ProbeIngest/ProcessProbeIngest.ts

@@ -122,9 +122,11 @@ export async function processIncomingEmailFromQueue(
   /*
    * Update monitor with last email received time. Heartbeat write:
    * single-statement UPDATE, no hooks and no `version` bump. These columns
-   * trigger no onUpdateSuccess work and Monitor enables no update
-   * workflow/realtime/audit, so nothing is lost. See
-   * ServiceService.updateLastSeen.
+   * trigger no onUpdateSuccess work, and this deliberately drops the
+   * per-update workflow trigger + audit-log entry Monitor's
+   * @EnableWorkflow / @EnableAuditLog would otherwise fire on every email
+   * (those are gated on the model flag, not on ignoreHooks) — a heartbeat
+   * should not spam workflows/audit. See ServiceService.updateLastSeen.
    */
   await MonitorService.updateColumnsByIdWithoutHooks({
     id: new ObjectID(monitor._id.toString()),

Common/Server/Services/ServiceService.ts

@@ -207,9 +207,12 @@ export class Service extends DatabaseService<Model> {
      * write lock across several round trips and, when an event loop stalls
      * mid-`save()` transaction, leaves it open as the head of a lock convoy
      * that starves the Postgres connection pool. lastSeenAt is an internal
-     * liveness timestamp with no update hooks on this model (connected /
-     * disconnected status is derived from it at read time), so a bare
-     * single-statement UPDATE is both correct and far cheaper.
+     * liveness timestamp with no onBeforeUpdate/onUpdateSuccess hooks on this
+     * model (connected / disconnected status is derived from it at read
+     * time), so a bare single-statement UPDATE is both correct and far
+     * cheaper. This also intentionally drops the per-update workflow trigger
+     * Service's @EnableWorkflow({ update: true }) fired on every heartbeat —
+     * a liveness ping should not trigger user workflows.
      */
     await this.updateColumnsByIdWithoutHooks({
       id: serviceId,

Common/Server/Utils/Monitor/MonitorResource.ts

@@ -318,10 +318,16 @@ export default class MonitorResourceUtil {
           if (!serverMonitorResponse.onlyCheckRequestReceivedAt) {
             /*
              * Heartbeat write: single-statement UPDATE, no hooks and no
-             * `version` bump. Monitor enables no update workflow/realtime/
-             * audit and these heartbeat columns trigger no onUpdateSuccess
-             * work, so nothing is lost; it also skips the pre-SELECT that
-             * would reload the large serverMonitorResponse jsonb row. See
+             * `version` bump. This DELIBERATELY drops the per-update workflow
+             * trigger and audit-log entry that Monitor's @EnableWorkflow /
+             * @EnableAuditLog fire on every changed update — the old
+             * `ignoreHooks: true` did NOT suppress those (they are gated on
+             * the model flag, not on ignoreHooks), so a heartbeat used to
+             * spam an on-update workflow + an audit row every ingest. A
+             * liveness ping should do neither. onUpdateSuccess is inert here
+             * regardless (gated on status/interval/steps/name/etc., none of
+             * which are written). Also skips the pre-SELECT that would reload
+             * the large serverMonitorResponse jsonb row. See
              * ServiceService.updateLastSeen.
              */
             await MonitorService.updateColumnsByIdWithoutHooks({
@@ -350,8 +356,10 @@ export default class MonitorResourceUtil {
 
           /*
            * Heartbeat write: single-statement UPDATE, no hooks and no
-           * `version` bump; skips the pre-SELECT of the large
-           * incomingMonitorRequest jsonb row. See
+           * `version` bump. As with the server-monitor branch above, this
+           * deliberately drops the per-update workflow trigger + audit-log
+           * entry Monitor would otherwise fire on every heartbeat, and skips
+           * the pre-SELECT of the large incomingMonitorRequest jsonb row. See
            * ServiceService.updateLastSeen.
            */
           await MonitorService.updateColumnsByIdWithoutHooks({