generated from amazon-archives/__template_Apache-2.0
-
Notifications
You must be signed in to change notification settings - Fork 2
feat: add running operations tracking to prevent unsafe termination #10
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
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
- Add hasRunningOperations() method to DurableContext interface - Track critical operations (ctx.step and ctx.waitForCondition) with try/finally cleanup - Prevent termination during user code execution to avoid workflow state corruption - Add unit test coverage for hasRunningOperations method This enables safe termination checks: if (durableContext.hasRunningOperations()) return; // Wait for critical ops terminate(); // Safe to terminate
bchampp
approved these changes
Sep 6, 2025
packages/lambda-durable-functions-sdk-js/src/context/durable-context/durable-context.ts
Show resolved
Hide resolved
ParidelPooya
added a commit
that referenced
this pull request
Oct 10, 2025
) ## Running Operations Tracking ### **What We Built:** 1. hasRunningOperations() method - Clean API to check if critical operations are running 2. Internal tracking system - addRunningOperation() / removeRunningOperation() with Set-based storage 3. Automatic cleanup - try/finally blocks ensure operations are removed even on errors ### **Where We Added Tracking (Only 2 Operations):** ✅ ctx.step: • **Executes user code** • **Critical for workflow state** - if interrupted, workflow state becomes inconsistent ✅ ctx.waitForCondition: • **Executes user condition checks** • **Critical for workflow logic** - if interrupted, condition evaluation becomes unreliable ### **Why NOT Other Operations:** ❌ ctx.runInChildContext - Safe to interrupt, just context management ❌ ctx.wait - Simple timer, no user code execution ❌ ctx.createCallback - Just creates callback config, no execution ❌ ctx.waitForCallback - Uses ctx.step internally, so already tracked automatically ❌ ctx.map/parallel/executeConcurrently - Use ctx.runInChildContext internally, which is safe to interrupt ### **Key Insight:** We only needed to add tracking to the 2 fundamental operations that execute user code: • ctx.step - Direct user code execution • ctx.waitForCondition - User condition evaluation All other operations either: • Are safe to interrupt (context/config operations) • Delegate to tracked operations (so get protection automatically) ### **The Result:** ```typescript // Safe termination check if (durableContext.hasRunningOperations()) { return; // Critical user code is running - wait } terminate(); // Safe to terminate ``` Surgical precision - Only the 2 operations that actually execute user code are tracked! 🎯 Co-authored-by: Pooya Paridel <parpooya@amazon.com>
ParidelPooya
added a commit
that referenced
this pull request
Oct 12, 2025
) ## Running Operations Tracking ### **What We Built:** 1. hasRunningOperations() method - Clean API to check if critical operations are running 2. Internal tracking system - addRunningOperation() / removeRunningOperation() with Set-based storage 3. Automatic cleanup - try/finally blocks ensure operations are removed even on errors ### **Where We Added Tracking (Only 2 Operations):** ✅ ctx.step: • **Executes user code** • **Critical for workflow state** - if interrupted, workflow state becomes inconsistent ✅ ctx.waitForCondition: • **Executes user condition checks** • **Critical for workflow logic** - if interrupted, condition evaluation becomes unreliable ### **Why NOT Other Operations:** ❌ ctx.runInChildContext - Safe to interrupt, just context management ❌ ctx.wait - Simple timer, no user code execution ❌ ctx.createCallback - Just creates callback config, no execution ❌ ctx.waitForCallback - Uses ctx.step internally, so already tracked automatically ❌ ctx.map/parallel/executeConcurrently - Use ctx.runInChildContext internally, which is safe to interrupt ### **Key Insight:** We only needed to add tracking to the 2 fundamental operations that execute user code: • ctx.step - Direct user code execution • ctx.waitForCondition - User condition evaluation All other operations either: • Are safe to interrupt (context/config operations) • Delegate to tracked operations (so get protection automatically) ### **The Result:** ```typescript // Safe termination check if (durableContext.hasRunningOperations()) { return; // Critical user code is running - wait } terminate(); // Safe to terminate ``` Surgical precision - Only the 2 operations that actually execute user code are tracked! 🎯 Co-authored-by: Pooya Paridel <parpooya@amazon.com>
ParidelPooya
added a commit
that referenced
this pull request
Oct 24, 2025
) ## Running Operations Tracking ### **What We Built:** 1. hasRunningOperations() method - Clean API to check if critical operations are running 2. Internal tracking system - addRunningOperation() / removeRunningOperation() with Set-based storage 3. Automatic cleanup - try/finally blocks ensure operations are removed even on errors ### **Where We Added Tracking (Only 2 Operations):** ✅ ctx.step: • **Executes user code** • **Critical for workflow state** - if interrupted, workflow state becomes inconsistent ✅ ctx.waitForCondition: • **Executes user condition checks** • **Critical for workflow logic** - if interrupted, condition evaluation becomes unreliable ### **Why NOT Other Operations:** ❌ ctx.runInChildContext - Safe to interrupt, just context management ❌ ctx.wait - Simple timer, no user code execution ❌ ctx.createCallback - Just creates callback config, no execution ❌ ctx.waitForCallback - Uses ctx.step internally, so already tracked automatically ❌ ctx.map/parallel/executeConcurrently - Use ctx.runInChildContext internally, which is safe to interrupt ### **Key Insight:** We only needed to add tracking to the 2 fundamental operations that execute user code: • ctx.step - Direct user code execution • ctx.waitForCondition - User condition evaluation All other operations either: • Are safe to interrupt (context/config operations) • Delegate to tracked operations (so get protection automatically) ### **The Result:** ```typescript // Safe termination check if (durableContext.hasRunningOperations()) { return; // Critical user code is running - wait } terminate(); // Safe to terminate ``` Surgical precision - Only the 2 operations that actually execute user code are tracked! 🎯 Co-authored-by: Pooya Paridel <parpooya@amazon.com>
ParidelPooya
added a commit
that referenced
this pull request
Oct 26, 2025
) ## Running Operations Tracking ### **What We Built:** 1. hasRunningOperations() method - Clean API to check if critical operations are running 2. Internal tracking system - addRunningOperation() / removeRunningOperation() with Set-based storage 3. Automatic cleanup - try/finally blocks ensure operations are removed even on errors ### **Where We Added Tracking (Only 2 Operations):** ✅ ctx.step: • **Executes user code** • **Critical for workflow state** - if interrupted, workflow state becomes inconsistent ✅ ctx.waitForCondition: • **Executes user condition checks** • **Critical for workflow logic** - if interrupted, condition evaluation becomes unreliable ### **Why NOT Other Operations:** ❌ ctx.runInChildContext - Safe to interrupt, just context management ❌ ctx.wait - Simple timer, no user code execution ❌ ctx.createCallback - Just creates callback config, no execution ❌ ctx.waitForCallback - Uses ctx.step internally, so already tracked automatically ❌ ctx.map/parallel/executeConcurrently - Use ctx.runInChildContext internally, which is safe to interrupt ### **Key Insight:** We only needed to add tracking to the 2 fundamental operations that execute user code: • ctx.step - Direct user code execution • ctx.waitForCondition - User condition evaluation All other operations either: • Are safe to interrupt (context/config operations) • Delegate to tracked operations (so get protection automatically) ### **The Result:** ```typescript // Safe termination check if (durableContext.hasRunningOperations()) { return; // Critical user code is running - wait } terminate(); // Safe to terminate ``` Surgical precision - Only the 2 operations that actually execute user code are tracked! 🎯 Co-authored-by: Pooya Paridel <parpooya@amazon.com>
ParidelPooya
added a commit
that referenced
this pull request
Nov 2, 2025
) ## Running Operations Tracking ### **What We Built:** 1. hasRunningOperations() method - Clean API to check if critical operations are running 2. Internal tracking system - addRunningOperation() / removeRunningOperation() with Set-based storage 3. Automatic cleanup - try/finally blocks ensure operations are removed even on errors ### **Where We Added Tracking (Only 2 Operations):** ✅ ctx.step: • **Executes user code** • **Critical for workflow state** - if interrupted, workflow state becomes inconsistent ✅ ctx.waitForCondition: • **Executes user condition checks** • **Critical for workflow logic** - if interrupted, condition evaluation becomes unreliable ### **Why NOT Other Operations:** ❌ ctx.runInChildContext - Safe to interrupt, just context management ❌ ctx.wait - Simple timer, no user code execution ❌ ctx.createCallback - Just creates callback config, no execution ❌ ctx.waitForCallback - Uses ctx.step internally, so already tracked automatically ❌ ctx.map/parallel/executeConcurrently - Use ctx.runInChildContext internally, which is safe to interrupt ### **Key Insight:** We only needed to add tracking to the 2 fundamental operations that execute user code: • ctx.step - Direct user code execution • ctx.waitForCondition - User condition evaluation All other operations either: • Are safe to interrupt (context/config operations) • Delegate to tracked operations (so get protection automatically) ### **The Result:** ```typescript // Safe termination check if (durableContext.hasRunningOperations()) { return; // Critical user code is running - wait } terminate(); // Safe to terminate ``` Surgical precision - Only the 2 operations that actually execute user code are tracked! 🎯 Co-authored-by: Pooya Paridel <parpooya@amazon.com>
ParidelPooya
added a commit
that referenced
this pull request
Nov 6, 2025
) ## Running Operations Tracking ### **What We Built:** 1. hasRunningOperations() method - Clean API to check if critical operations are running 2. Internal tracking system - addRunningOperation() / removeRunningOperation() with Set-based storage 3. Automatic cleanup - try/finally blocks ensure operations are removed even on errors ### **Where We Added Tracking (Only 2 Operations):** ✅ ctx.step: • **Executes user code** • **Critical for workflow state** - if interrupted, workflow state becomes inconsistent ✅ ctx.waitForCondition: • **Executes user condition checks** • **Critical for workflow logic** - if interrupted, condition evaluation becomes unreliable ### **Why NOT Other Operations:** ❌ ctx.runInChildContext - Safe to interrupt, just context management ❌ ctx.wait - Simple timer, no user code execution ❌ ctx.createCallback - Just creates callback config, no execution ❌ ctx.waitForCallback - Uses ctx.step internally, so already tracked automatically ❌ ctx.map/parallel/executeConcurrently - Use ctx.runInChildContext internally, which is safe to interrupt ### **Key Insight:** We only needed to add tracking to the 2 fundamental operations that execute user code: • ctx.step - Direct user code execution • ctx.waitForCondition - User condition evaluation All other operations either: • Are safe to interrupt (context/config operations) • Delegate to tracked operations (so get protection automatically) ### **The Result:** ```typescript // Safe termination check if (durableContext.hasRunningOperations()) { return; // Critical user code is running - wait } terminate(); // Safe to terminate ``` Surgical precision - Only the 2 operations that actually execute user code are tracked! 🎯 Co-authored-by: Pooya Paridel <parpooya@amazon.com>
ParidelPooya
added a commit
that referenced
this pull request
Nov 6, 2025
) ## Running Operations Tracking ### **What We Built:** 1. hasRunningOperations() method - Clean API to check if critical operations are running 2. Internal tracking system - addRunningOperation() / removeRunningOperation() with Set-based storage 3. Automatic cleanup - try/finally blocks ensure operations are removed even on errors ### **Where We Added Tracking (Only 2 Operations):** ✅ ctx.step: • **Executes user code** • **Critical for workflow state** - if interrupted, workflow state becomes inconsistent ✅ ctx.waitForCondition: • **Executes user condition checks** • **Critical for workflow logic** - if interrupted, condition evaluation becomes unreliable ### **Why NOT Other Operations:** ❌ ctx.runInChildContext - Safe to interrupt, just context management ❌ ctx.wait - Simple timer, no user code execution ❌ ctx.createCallback - Just creates callback config, no execution ❌ ctx.waitForCallback - Uses ctx.step internally, so already tracked automatically ❌ ctx.map/parallel/executeConcurrently - Use ctx.runInChildContext internally, which is safe to interrupt ### **Key Insight:** We only needed to add tracking to the 2 fundamental operations that execute user code: • ctx.step - Direct user code execution • ctx.waitForCondition - User condition evaluation All other operations either: • Are safe to interrupt (context/config operations) • Delegate to tracked operations (so get protection automatically) ### **The Result:** ```typescript // Safe termination check if (durableContext.hasRunningOperations()) { return; // Critical user code is running - wait } terminate(); // Safe to terminate ``` Surgical precision - Only the 2 operations that actually execute user code are tracked! 🎯 Co-authored-by: Pooya Paridel <parpooya@amazon.com>
ParidelPooya
added a commit
that referenced
this pull request
Nov 6, 2025
) ## Running Operations Tracking ### **What We Built:** 1. hasRunningOperations() method - Clean API to check if critical operations are running 2. Internal tracking system - addRunningOperation() / removeRunningOperation() with Set-based storage 3. Automatic cleanup - try/finally blocks ensure operations are removed even on errors ### **Where We Added Tracking (Only 2 Operations):** ✅ ctx.step: • **Executes user code** • **Critical for workflow state** - if interrupted, workflow state becomes inconsistent ✅ ctx.waitForCondition: • **Executes user condition checks** • **Critical for workflow logic** - if interrupted, condition evaluation becomes unreliable ### **Why NOT Other Operations:** ❌ ctx.runInChildContext - Safe to interrupt, just context management ❌ ctx.wait - Simple timer, no user code execution ❌ ctx.createCallback - Just creates callback config, no execution ❌ ctx.waitForCallback - Uses ctx.step internally, so already tracked automatically ❌ ctx.map/parallel/executeConcurrently - Use ctx.runInChildContext internally, which is safe to interrupt ### **Key Insight:** We only needed to add tracking to the 2 fundamental operations that execute user code: • ctx.step - Direct user code execution • ctx.waitForCondition - User condition evaluation All other operations either: • Are safe to interrupt (context/config operations) • Delegate to tracked operations (so get protection automatically) ### **The Result:** ```typescript // Safe termination check if (durableContext.hasRunningOperations()) { return; // Critical user code is running - wait } terminate(); // Safe to terminate ``` Surgical precision - Only the 2 operations that actually execute user code are tracked! 🎯 Co-authored-by: Pooya Paridel <parpooya@amazon.com>
ParidelPooya
added a commit
that referenced
this pull request
Nov 7, 2025
) ## Running Operations Tracking ### **What We Built:** 1. hasRunningOperations() method - Clean API to check if critical operations are running 2. Internal tracking system - addRunningOperation() / removeRunningOperation() with Set-based storage 3. Automatic cleanup - try/finally blocks ensure operations are removed even on errors ### **Where We Added Tracking (Only 2 Operations):** ✅ ctx.step: • **Executes user code** • **Critical for workflow state** - if interrupted, workflow state becomes inconsistent ✅ ctx.waitForCondition: • **Executes user condition checks** • **Critical for workflow logic** - if interrupted, condition evaluation becomes unreliable ### **Why NOT Other Operations:** ❌ ctx.runInChildContext - Safe to interrupt, just context management ❌ ctx.wait - Simple timer, no user code execution ❌ ctx.createCallback - Just creates callback config, no execution ❌ ctx.waitForCallback - Uses ctx.step internally, so already tracked automatically ❌ ctx.map/parallel/executeConcurrently - Use ctx.runInChildContext internally, which is safe to interrupt ### **Key Insight:** We only needed to add tracking to the 2 fundamental operations that execute user code: • ctx.step - Direct user code execution • ctx.waitForCondition - User condition evaluation All other operations either: • Are safe to interrupt (context/config operations) • Delegate to tracked operations (so get protection automatically) ### **The Result:** ```typescript // Safe termination check if (durableContext.hasRunningOperations()) { return; // Critical user code is running - wait } terminate(); // Safe to terminate ``` Surgical precision - Only the 2 operations that actually execute user code are tracked! 🎯 Co-authored-by: Pooya Paridel <parpooya@amazon.com>
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.
Running Operations Tracking
What We Built:
Where We Added Tracking (Only 2 Operations):
✅ ctx.step:
• Executes user code
• Critical for workflow state - if interrupted, workflow state becomes inconsistent
✅ ctx.waitForCondition:
• Executes user condition checks
• Critical for workflow logic - if interrupted, condition evaluation becomes unreliable
Why NOT Other Operations:
❌ ctx.runInChildContext - Safe to interrupt, just context management
❌ ctx.wait - Simple timer, no user code execution
❌ ctx.createCallback - Just creates callback config, no execution
❌ ctx.waitForCallback - Uses ctx.step internally, so already tracked automatically
❌ ctx.map/parallel/executeConcurrently - Use ctx.runInChildContext internally, which is safe to interrupt
Key Insight:
We only needed to add tracking to the 2 fundamental operations that execute user code:
• ctx.step - Direct user code execution
• ctx.waitForCondition - User condition evaluation
All other operations either:
• Are safe to interrupt (context/config operations)
• Delegate to tracked operations (so get protection automatically)
The Result:
Surgical precision - Only the 2 operations that actually execute user code are tracked! 🎯