fix: remove await from OTEL handleSignal interceptor #1803
+2,148
−85
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
chris-olszewski
force-pushed
the
olszewski/fix_otel_interceptor_nde
branch
from
717716c to
1006b2b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What was changed
Remove yield points from the
@temporalio/interceptors-opentelemetryworkflow interceptors. Some yield points were there since the initial version of the package and others were added in #1449 and #1577Why?
These yield points have the ability to cause NDE due to the inclusion of these interceptors. In addition, it broke
startWithSignaloperations as signal handlers were not immediately processed upon registration if the workflow was started with the given signal.Depends on temporalio/sdk-core#1040
Checklist
Closes [Bug] Upgrading OTel Interceptor to 1.11.5+ breaks signal-with-start and may cause NDE #1677
How was this tested:
Created histories from the affected versions and added tests that replay these histories. These are red/green tests where they initially failed without the changes, but with the flagging logic they passed.
The only interceptors that are not covered by these replay tests are:
executescheduleLocalActivitycontinueAsNewAs I was unable to trigger NDE from removing/adding yield points to these interceptors.
Possibly a warning on https://docs.temporal.io/develop/typescript/interceptors#workflow-interceptors-registration about adding yield points to workflow interceptors.