add ensureCompiledOnStartup config flag to opt-out of auto-compilation #499
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 0b84bb0 The changes in this PR will be included in the next version bump. This PR includes changesets to release 6 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
This was referenced Dec 3, 2025
Contributor
Author
This was referenced Dec 3, 2025
|
View your CI Pipeline Execution ↗ for commit 0b84bb0
☁️ Nx Cloud last updated this comment at |
Contributor
Merge activity
|
#499) ### TL;DR Add automatic flow compilation at worker startup with the ability to opt-out. ### What changed? - Added a new `ensureCompiledOnStartup` configuration option to `FlowWorkerConfig` (defaults to `true`) - When enabled (default), workers call `pgflow.ensure_flow_compiled()` at startup to verify flows are up-to-date - In development mode, mismatched flows are automatically recompiled - In production mode, mismatches cause errors - Added comprehensive tests for the new configuration option ### How to test? 1. Create a flow worker with default settings to see automatic compilation: ```typescript const worker = createFlowWorker(MyFlow, { /* config */ }); ``` 2. Opt-out of automatic compilation: ```typescript const worker = createFlowWorker(MyFlow, { ensureCompiledOnStartup: false, // other config }); ``` 3. Run tests to verify behavior: ``` deno test pkgs/edge-worker/tests/integration/flow/compilationAtStartup.test.ts deno test pkgs/edge-worker/tests/unit/FlowWorkerLifecycle.compilation.test.ts ``` ### Why make this change? This change improves the developer experience by ensuring flows are properly compiled at worker startup. It helps catch flow definition mismatches early, automatically recompiling in development environments while failing fast in production. The opt-out option provides flexibility for environments where flows are pre-compiled via CLI or other means.
graphite-app
bot
force-pushed
the
12-01-add_advisory_lock_to_ensure_flow_compiled_to_prevent_race_conditions
branch
from
bcc4f76 to
cf8811b
Compare
graphite-app
bot
force-pushed
the
12-01-add_ensurecompiledonstartup_config_flag_to_opt-out_of_auto-compilation
branch
from
e4cea89 to
0b84bb0
Compare
graphite-app
bot
changed the base branch from
12-01-add_advisory_lock_to_ensure_flow_compiled_to_prevent_race_conditions
to
main
Contributor
🚀 Production Deployment: Website✅ Successfully deployed to production! 🔗 Production URL: https://pgflow.dev 📝 Details:
Deployed at: 2025-12-04T11:09:29Z |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
TL;DR
Add automatic flow compilation at worker startup with the ability to opt-out.
What changed?
ensureCompiledOnStartupconfiguration option toFlowWorkerConfig(defaults totrue)pgflow.ensure_flow_compiled()at startup to verify flows are up-to-dateHow to test?
Create a flow worker with default settings to see automatic compilation:
Opt-out of automatic compilation:
Run tests to verify behavior:
Why make this change?
This change improves the developer experience by ensuring flows are properly compiled at worker startup. It helps catch flow definition mismatches early, automatically recompiling in development environments while failing fast in production. The opt-out option provides flexibility for environments where flows are pre-compiled via CLI or other means.