feat: add cleanup function for cron job run details

[jumski]

Add cleanup function for cron job run details

This PR adds a new cleanup_ensure_workers_logs function to prevent the cron.job_run_details table from growing indefinitely. The function:

• Deletes cron job run details older than a configurable retention period (default 24 hours)
• Returns the count of deleted records
• Is implemented as a security definer function with appropriate search path settings
• Includes comprehensive documentation explaining its purpose and behavior

The PR includes:

• SQL schema definition for the function
• TypeScript type definitions for the function's arguments and return values
• Migration file for Supabase deployment
• Two test files to verify the function works correctly:
  • Basic cleanup functionality with custom retention period
  • Proper handling when no records need deletion

Note that HTTP response logs (net._http_response) are not cleaned by this function as they are automatically managed by pg_net with a 6-hour TTL.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 19991aa

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[jumski]

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

• feat: add automatic worker restart via cron job and worker health tracking #517
• refactor: add handler spy utilities for queue worker tests #514
• feat: add worker tracking and graceful shutdown for edge functions #513
• feat: add setup_ensure_workers_cron function for worker management #512
• feat: add cleanup function for cron job run details #511 👈 (View in Graphite)
• feat: add ensure_workers function to automatically restart dead workers #510
• feat: add pg_cron, pg_net, pgsodium, and supabase_vault extensions to Atlas database #508
• feat: add mark_worker_stopped function for graceful worker shutdown #506
• feat: add track_worker_function for edge function monitoring #505
• feat: add worker_functions table and stopped_at column to workers #504
• refactor: auto-detect environment in ensure_flow_compiled instead of requiring mode parameter #503
• feat: add is_local() function to detect Supabase CLI environment #502
• refactor: improve Atlas migration management with better baseline handling #507
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[nx-cloud]

View your CI Pipeline Execution ↗ for commit 19991aa

Command	Status	Duration	Result
nx run client:e2e	✅ Succeeded	1m 9s	View ↗
nx run edge-worker:test:integration	✅ Succeeded	3m 46s	View ↗
nx run cli:e2e	✅ Succeeded	3s	View ↗
nx run core:pgtap	✅ Succeeded	1m 40s	View ↗
nx affected -t verify-exports --base=origin/mai...	✅ Succeeded	3s	View ↗
nx affected -t build --configuration=production...	✅ Succeeded	30s	View ↗
nx affected -t lint typecheck test --parallel -...	✅ Succeeded	1m 43s	View ↗
nx run edge-worker:e2e	✅ Succeeded	46s	View ↗

---

☁️ Nx Cloud last updated this comment at 2025-12-07 16:56:58 UTC

[graphite-app]

The function lacks validation for the retention_hours parameter. Passing a negative value or zero could cause catastrophic data loss:

• Negative value: retention_hours => -5 creates the condition end_time < now() + 5 hours, deleting records including those with recent or future end times
• Zero: retention_hours => 0 creates end_time < now(), deleting ALL completed job records

Fix by adding validation at the start:

create or replace function pgflow.cleanup_ensure_workers_logs(
  retention_hours integer default 24
)
returns table (cron_deleted bigint)
language sql
security definer
set search_path = pgflow, cron, pg_temp
as $$
  with deleted as (
    delete from cron.job_run_details
    where job_run_details.end_time < now() - (cleanup_ensure_workers_logs.retention_hours || ' hours')::interval
      and cleanup_ensure_workers_logs.retention_hours > 0  -- Add validation
    returning 1
  )
  select count(*)::bigint as cron_deleted from deleted
$$;

Or raise an exception for invalid input before the DELETE.

Suggested change

	create or replace function pgflow.cleanup_ensure_workers_logs(
	retention_hours integer default 24
	)
	returns table (cron_deleted bigint)
	language sql
	security definer
	set search_path = pgflow, cron, pg_temp
	as $$
	with deleted as (
	delete from cron.job_run_details
	where job_run_details.end_time < now() - (cleanup_ensure_workers_logs.retention_hours || ' hours')::interval
	returning 1
	)
	select count(*)::bigint as cron_deleted from deleted
	$$;
	create or replace function pgflow.cleanup_ensure_workers_logs(
	retention_hours integer default 24
	)
	returns table (cron_deleted bigint)
	language sql
	security definer
	set search_path = pgflow, cron, pg_temp
	as $$
	with deleted as (
	delete from cron.job_run_details
	where job_run_details.end_time < now() - (cleanup_ensure_workers_logs.retention_hours || ' hours')::interval
	and cleanup_ensure_workers_logs.retention_hours > 0
	returning 1
	)
	select count(*)::bigint as cron_deleted from deleted
	$$;

Spotted by Graphite Agent



Is this helpful? React 👍 or 👎 to let us know.

[github-actions]

🔍 Preview Deployment: Website

✅ Deployment successful!

🔗 Preview URL: https://pr-511.pgflow.pages.dev

📝 Details:

• Branch: 12-05-add_cleanup_ensure_workers_logs_sql_function_for_cron_job_log_maintenance
• Commit: aa780dd8d7856514d47fbff00e560f971656aff7
• View Logs

_Last updated: _