Rename withTimeout() to waitForResultWithTimeLimit() - #3124
Merged
cklin merged 1 commit intoSep 18, 2025
Merged
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
The name withTimeout() gives the impression that it would limit the execution of the promise to the given time bound. But that is not the case: it is only the _waiting_ that is limited, and the promise would keep running beyond the time bound. This commit renames withTimeout() to waitForResultWithTimeLimit() so that developers are more likely to understand the actual behavior of this function.
cklin
force-pushed
the
cklin/rename-withtimeout
branch
from
0856010 to
8185897
Compare
September 18, 2025 15:27
cklin
marked this pull request as ready for review
September 18, 2025 17:28
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR renames the withTimeout() function to waitForResultWithTimeLimit() to better clarify its behavior. The function doesn't actually stop promise execution after the timeout - it only stops waiting for the result while the promise continues running in the background.
Key changes:
- Function rename from withTimeout to waitForResultWithTimeLimit in the implementation
- Updated all call sites across the codebase to use the new function name
- Updated test names and comments to reflect the new naming
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file| File | Description |
|---|---|
| src/util.ts | Renamed the function definition and updated related comment |
| src/util.test.ts | Updated test names and function calls to use new name |
| src/trap-caching.ts | Updated import and function calls |
| src/overlay-database-utils.ts | Updated import and function calls |
| lib/init-action.js | Updated compiled JavaScript with function rename |
| lib/analyze-action.js | Updated compiled JavaScript with function rename |
Sorry, something went wrong.
esbena
approved these changes
Sep 18, 2025
8 tasks
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Reviewers
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.
The name withTimeout() gives the impression that it would limit the execution of the promise to the given time bound. But that is not the case: it is only the waiting that is limited, and the promise would keep running beyond the time bound.
This PR renames withTimeout() to waitForResultWithTimeLimit() so that developers are more likely to understand the actual behavior of this function.
Risk assessment
For internal use only. Please select the risk level of this change:
Merge / deployment checklist