chore(logs): convert inline marker comments to TSDoc

Author: waleedlatif1

apps/sim/lib/logs/execution/logging-session.ts

@@ -193,9 +193,12 @@ export class LoggingSession {
     }
   }
 
+  /**
+   * Persist the last-started-block marker. Redis is the primary path when the
+   * flag is on; falls back to the durable jsonb_set UPDATE when Redis is
+   * unavailable or the write fails, so a marker is never dropped.
+   */
   private async persistLastStartedBlock(marker: ExecutionLastStartedBlock): Promise<void> {
-    // Redis is the primary path when enabled; fall back to the durable SQL write
-    // when Redis is unavailable or the write fails, so a marker is never dropped.
     if (this.useRedisMarkers && (await setLastStartedBlock(this.executionId, marker))) {
       return
     }
@@ -216,9 +219,12 @@ export class LoggingSession {
     }
   }
 
+  /**
+   * Persist the last-completed-block marker. Redis is the primary path when the
+   * flag is on; falls back to the durable jsonb_set UPDATE when Redis is
+   * unavailable or the write fails, so a marker is never dropped.
+   */
   private async persistLastCompletedBlock(marker: ExecutionLastCompletedBlock): Promise<void> {
-    // Redis is the primary path when enabled; fall back to the durable SQL write
-    // when Redis is unavailable or the write fails, so a marker is never dropped.
     if (this.useRedisMarkers && (await setLastCompletedBlock(this.executionId, marker))) {
       return
     }
@@ -1022,6 +1028,13 @@ export class LoggingSession {
     )
   }
 
+  /**
+   * Force-fail terminal boundary that bypasses completeWorkflowExecution. Folds
+   * any live Redis progress markers into execution_data before clearing the key,
+   * so a run whose markers only ever lived in Redis still keeps its
+   * last-started/last-completed breadcrumb. Both the fold and clear are no-ops
+   * when the standard completion path already persisted and cleared them.
+   */
   static async markExecutionAsFailed(
     executionId: string,
     errorMessage: string | undefined,
@@ -1031,11 +1044,6 @@ export class LoggingSession {
     try {
       const message = errorMessage || 'Run failed'
 
-      // This terminal boundary bypasses completeWorkflowExecution, so fold any
-      // live Redis markers into the row here too — otherwise a run whose markers
-      // only ever lived in Redis would be saved with error data but no
-      // last-started/last-completed breadcrumb. Empty when the standard
-      // completion path already folded and cleared them.
       const markers = await getProgressMarkers(executionId)
 
       let executionData = sql`jsonb_set(
@@ -1068,8 +1076,6 @@ export class LoggingSession {
           )
         )
 
-      // Markers are now durable on the row; drop the Redis key to match the
-      // standard clear-at-every-boundary invariant.
       void clearProgressMarkers(executionId)
 
       logger.info(`[${requestId || 'unknown'}] Marked execution ${executionId} as failed`)

apps/sim/lib/logs/execution/progress-markers.test.ts

@@ -61,15 +61,15 @@ describe('progress-markers', () => {
       await setLastStartedBlock(EXECUTION_ID, startedMarker)
 
       expect(mockRedis.eval).toHaveBeenCalledTimes(1)
-      const args = mockRedis.eval.mock.calls[0]
-      // [script, numKeys, key, field, tsField, timestamp, json, ttl]
-      expect(args[1]).toBe(1)
-      expect(args[2]).toBe(KEY)
-      expect(args[3]).toBe('started')
-      expect(args[4]).toBe('startedAt')
-      expect(args[5]).toBe(startedMarker.startedAt)
-      expect(JSON.parse(args[6] as string)).toEqual(startedMarker)
-      expect(args[7]).toBe(EXPECTED_TTL_MS)
+      const [, numKeys, key, field, timestampField, timestamp, json, ttl] =
+        mockRedis.eval.mock.calls[0]
+      expect(numKeys).toBe(1)
+      expect(key).toBe(KEY)
+      expect(field).toBe('started')
+      expect(timestampField).toBe('startedAt')
+      expect(timestamp).toBe(startedMarker.startedAt)
+      expect(JSON.parse(json as string)).toEqual(startedMarker)
+      expect(ttl).toBe(EXPECTED_TTL_MS)
     })
 
     it('returns true when the Redis write succeeds', async () => {

apps/sim/lib/logs/fetch-log-detail.ts

@@ -78,6 +78,10 @@ interface FetchLogDetailArgs {
  * Shared loader for the workflow-log detail shape returned by the by-id and
  * by-execution routes. Returns `null` when no matching row exists in either
  * the workflow-execution or job-execution tables for this user + workspace.
+ *
+ * For in-flight (running/pending) executions, live progress markers are merged
+ * from Redis, since they are only folded into the row at a terminal/pause
+ * boundary.
  */
 export async function fetchLogDetail({
   userId,
@@ -166,7 +170,6 @@ export async function fetchLogDetail({
       { workspaceId, workflowId: log.workflowId, executionId: log.executionId }
     )
 
-    // In-flight markers live in Redis until folded into the row at a terminal/pause boundary.
     const liveMarkers =
       log.status === 'running' || log.status === 'pending'
         ? await getProgressMarkers(log.executionId)