Skip to content

Commit 245a34c

Browse files
committed
docs: add caution about opt_timeout usage and update flow versioning guidelines
- Added a caution note about the current use of opt_timeout for visibility timeout - Clarified that future updates will use abort signals for job termination - Updated the table of safe and breaking changes in flow versioning documentation to include checkmarks for safe modifications and crosses for breaking changes
1 parent 098db98 commit 245a34c

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

pkgs/website/src/content/docs/how-to/update-flow-options.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,14 @@ You can safely modify these runtime options without creating a new flow version:
2020
| `opt_base_delay` | Base retry delay (seconds) | 1 | Flow only |
2121
| `opt_timeout` | Max execution time (seconds) | 60 | Flow & Steps |
2222

23+
<Aside title="About opt_timeout" type="caution">
24+
Currently, `opt_timeout` is only used to set the visibility timeout of messages in the queue. You should set this value to be higher than the maximum time a job can possibly run. If processing takes longer than the timeout, the message will become visible again and may be processed by another worker, leading to duplicate processing.
25+
26+
In the future, the Edge Worker will use abort signals to terminate jobs past their timeout, but currently, it does not do this.
27+
28+
For more details on visibility timeouts, see the [Edge Worker Configuration](/edge-worker/getting-started/configuration/#visibilitytimeout) documentation.
29+
</Aside>
30+
2331
## Configuration System
2432

2533
pgflow uses a two-level configuration approach:

pkgs/website/src/content/docs/how-to/version-your-flows.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ Before making changes to your flows, understand which modifications are safe:
3333

3434
| Safe Changes | Breaking Changes |
3535
| ------------ | --------------- |
36-
| Modifying step implementation | Adding/removing steps |
37-
| Adjusting retry parameters | Changing step dependencies |
38-
| Updating timeout values | Modifying input/output types |
39-
| Bug fixes within steps | Changing step slug names |
36+
| Modifying step implementation | Adding/removing steps |
37+
| Adjusting retry parameters | Changing step dependencies |
38+
| Updating timeout values | Modifying input/output types |
39+
| Bug fixes within steps | Changing step slug names |
4040

4141
## Version Management Strategy
4242

0 commit comments

Comments
 (0)