Skip to content

Commit 87655c3

Browse files
jumskijumski
committed
feat: add environment variable to disable auto-respawn of Edge Workers
Implement a simple check in SupabasePlatformAdapter to prevent spawning new edge functions during shutdown when EDGE_WORKER_DISABLE_AUTO_RESPAWN is set to true. Include documentation explaining how to disable auto-respawn via environment variables and outline use cases. Also, add a new test file to verify the environment variable behavior. This minimal change provides temporary control over worker respawning with minimal code modifications and documentation updates.
1 parent 5230a2d commit 87655c3

File tree

4 files changed

+223
-2
lines changed

4 files changed

+223
-2
lines changed

‎pkgs/edge-worker/src/platform/SupabasePlatformAdapter.ts‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ interface SupabaseEnv extends Record<string, string | undefined> {
2020
EDGE_WORKER_DB_URL: string;
2121
SB_EXECUTION_ID: string;
2222
EDGE_WORKER_LOG_LEVEL?: string;
23+
EDGE_WORKER_DISABLE_AUTO_RESPAWN?: string;
2324
}
2425

2526
/**
@@ -172,10 +173,21 @@ export class SupabasePlatformAdapter implements PlatformAdapter<SupabaseResource
172173
globalThis.onbeforeunload = async () => {
173174
this.logger.debug('Shutting down...');
174175

175-
if (this.worker) {
176-
await this.spawnNewEdgeFunction();
176+
// Early return if no worker to respawn
177+
if (!this.worker) {
178+
await this.stopWorker();
179+
return;
180+
}
181+
182+
// Check if auto-respawn is disabled
183+
if (this.validatedEnv.EDGE_WORKER_DISABLE_AUTO_RESPAWN === 'true') {
184+
this.logger.debug('Auto-respawn disabled via EDGE_WORKER_DISABLE_AUTO_RESPAWN');
185+
await this.stopWorker();
186+
return;
177187
}
178188

189+
// Default behavior: spawn new function before stopping
190+
await this.spawnNewEdgeFunction();
179191
await this.stopWorker();
180192
};
181193
}

‎pkgs/website/src/content/docs/how-to/disable-worker-auto-respawn.mdx‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
title: Disable Worker Auto-Respawn
3+
description: How to disable automatic worker respawning in Supabase Edge Functions
4+
sidebar:
5+
order: 116
6+
---
7+
8+
import { Aside } from "@astrojs/starlight/components";
9+
10+
<Aside type="caution" title="Temporary Feature">
11+
This is a temporary solution using environment variables. In future versions, this may be replaced with a proper configuration option.
12+
</Aside>
13+
14+
By default, pgflow Edge Workers automatically spawn a new instance when shutting down to ensure continuous processing. You can disable this behavior if you're using external orchestration like pg_cron.
15+
16+
## Disabling Auto-Respawn
17+
18+
### For Local Development
19+
20+
Add to your `supabase/functions/.env` file:
21+
22+
```diff
23+
# supabase/functions/.env
24+
EDGE_WORKER_DB_URL=postgres://...
25+
EDGE_WORKER_LOG_LEVEL=info
26+
+EDGE_WORKER_DISABLE_AUTO_RESPAWN=true
27+
```
28+
29+
### For Production (Supabase Dashboard)
30+
31+
1. Go to your project's Edge Functions settings
32+
2. Find your worker function
33+
3. Add the environment variable:
34+
- Key: `EDGE_WORKER_DISABLE_AUTO_RESPAWN`
35+
- Value: `true`
36+
37+
## When to Use This
38+
39+
Disable auto-respawn when:
40+
41+
- You're using pg_cron to schedule worker restarts
42+
- You want manual control over worker lifecycle
43+
- You're debugging shutdown behavior
44+
- You need to prevent duplicate workers
45+
46+
## Example with pg_cron
47+
48+
If you're using pg_cron to restart workers periodically:
49+
50+
```sql
51+
-- Schedule worker restart every hour
52+
SELECT cron.schedule(
53+
'restart-edge-worker',
54+
'0 * * * *', -- Every hour
55+
$$
56+
-- Your restart logic here
57+
$$
58+
);
59+
```
60+
61+
With auto-respawn disabled, only pg_cron controls when new workers start.
62+
63+
<Aside type="note">
64+
Without auto-respawn, ensure you have another mechanism (like pg_cron) to restart workers, otherwise processing will stop when the worker shuts down.
65+
</Aside>

‎pkgs/website/src/content/docs/how-to/keep-workers-up.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ Set up a pg_cron safety net that checks worker status and only starts new worker
1919

2020
Edge Workers normally auto-respawn by sending their own HTTP requests. In rare cases during high load, workers may fail to respawn if they hit execution time limits before sending restart requests. Basic safety nets can cause Supabase's Edge Runtime to spawn multiple workers simultaneously, leading to unpredictable costs.
2121

22+
<Aside type="tip">
23+
You can [disable auto-respawn](/how-to/disable-worker-auto-respawn/) if you want full control over worker lifecycle through pg_cron.
24+
</Aside>
25+
2226
## Smart Safety Net Solution
2327

2428
This approach checks existing worker counts before spawning new ones:

‎plan.md‎

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
# Feature Plan: Disable Worker Auto-Respawning (Minimal MVP)
2+
3+
## Overview
4+
5+
Add a simple environment variable to disable the automatic respawning of Edge Workers when they shut down. This is a minimal, temporary solution that can be improved later based on user feedback.
6+
7+
## Implementation (Super Simple)
8+
9+
### 1. Code Change
10+
11+
**File:** `pkgs/edge-worker/src/platform/SupabasePlatformAdapter.ts`
12+
13+
In the `setupShutdownHandler()` method, check for env var:
14+
15+
```typescript
16+
private setupShutdownHandler(): void {
17+
globalThis.onbeforeunload = async () => {
18+
this.logger.debug('Shutting down...');
19+
20+
// Check if auto-respawn is disabled via env var
21+
const disableAutoRespawn = this.validatedEnv.EDGE_WORKER_DISABLE_AUTO_RESPAWN === 'true';
22+
23+
if (this.worker && !disableAutoRespawn) {
24+
await this.spawnNewEdgeFunction();
25+
} else if (this.worker && disableAutoRespawn) {
26+
this.logger.debug('Auto-respawn disabled via EDGE_WORKER_DISABLE_AUTO_RESPAWN');
27+
}
28+
29+
await this.stopWorker();
30+
};
31+
}
32+
```
33+
34+
That's it for the code change! One if statement.
35+
36+
### 2. Documentation
37+
38+
**Create File:** `pkgs/website/src/content/docs/how-to/disable-worker-auto-respawn.mdx`
39+
40+
```markdown
41+
---
42+
title: Disable Worker Auto-Respawn
43+
description: How to disable automatic worker respawning in Supabase Edge Functions
44+
sidebar:
45+
order: 100
46+
---
47+
48+
import { Aside } from "@astrojs/starlight/components";
49+
50+
<Aside type="caution" title="Temporary Feature">
51+
This is a temporary solution using environment variables. In future versions, this may be replaced with a proper configuration option.
52+
</Aside>
53+
54+
By default, pgflow Edge Workers automatically spawn a new instance when shutting down to ensure continuous processing. You can disable this behavior if you're using external orchestration like pg_cron.
55+
56+
## Disabling Auto-Respawn
57+
58+
Set the following environment variable in your Edge Function:
59+
60+
```bash
61+
EDGE_WORKER_DISABLE_AUTO_RESPAWN=true
62+
```
63+
64+
### In Supabase Dashboard
65+
66+
1. Go to your project's Edge Functions settings
67+
2. Find your worker function
68+
3. Add the environment variable:
69+
- Key: `EDGE_WORKER_DISABLE_AUTO_RESPAWN`
70+
- Value: `true`
71+
72+
### In .env.local
73+
74+
For local development:
75+
76+
```bash
77+
EDGE_WORKER_DISABLE_AUTO_RESPAWN=true
78+
```
79+
80+
## When to Use This
81+
82+
Disable auto-respawn when:
83+
84+
- You're using pg_cron to schedule worker restarts
85+
- You want manual control over worker lifecycle
86+
- You're debugging shutdown behavior
87+
- You need to prevent duplicate workers
88+
89+
## Example with pg_cron
90+
91+
If you're using pg_cron to restart workers periodically:
92+
93+
```sql
94+
-- Schedule worker restart every hour
95+
SELECT cron.schedule(
96+
'restart-edge-worker',
97+
'0 * * * *', -- Every hour
98+
$$
99+
-- Your restart logic here
100+
$$
101+
);
102+
```
103+
104+
With auto-respawn disabled, only pg_cron controls when new workers start.
105+
106+
<Aside type="note">
107+
Without auto-respawn, ensure you have another mechanism (like pg_cron) to restart workers, otherwise processing will stop when the worker shuts down.
108+
</Aside>
109+
```
110+
111+
### 3. Testing (Optional - Only if Easy)
112+
113+
If testing is straightforward, create a simple test:
114+
115+
**File:** `pkgs/edge-worker/tests/unit/autoRespawn.test.ts`
116+
117+
```typescript
118+
describe('Auto-respawn environment variable', () => {
119+
it('should respect EDGE_WORKER_DISABLE_AUTO_RESPAWN env var', () => {
120+
// Mock env var
121+
// Verify spawnNewEdgeFunction is not called
122+
});
123+
});
124+
```
125+
126+
## Implementation Checklist
127+
128+
- [ ] Add env var check to SupabasePlatformAdapter.ts (~5 lines)
129+
- [ ] Create how-to documentation page
130+
- [ ] (Optional) Add simple test if easy
131+
132+
## Total Effort: ~30 minutes
133+
134+
This minimal approach:
135+
- Solves the immediate need
136+
- Requires minimal code changes (5-10 lines)
137+
- Easy to remove/replace later
138+
- No API changes
139+
- No breaking changes
140+
- Clear documentation about temporary nature

0 commit comments

Comments
 (0)