fix: prevent TypeError in PreparedStatement.execute() when streaming without callback#1849
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Fixes a bug in the base PreparedStatement execution path so streaming prepared statements can be executed without supplying a callback, matching the event-driven streaming pattern already used elsewhere in the library.
Changes:
- Guarded the callback passed from
PreparedStatement._execute()to the innerRequest.execute()call. - Added a regression test for
ps.execute({})withps.stream = trueand no callback. - Kept the change localized to the base prepared-statement implementation and unit tests.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
lib/base/prepared-statement.js |
Replaces the unconditional callback handoff with a guarded no-op fallback in prepared-statement execution. |
test/common/unit.js |
Adds a regression test covering streaming PreparedStatement.execute() without a callback. |
Collaborator
Author
|
Good point — added an integration test ( |
…without callback When stream=true and no callback is provided, _execute() would call callback(null, result) on the undefined callback, throwing TypeError. Guard the callback in _execute() so a no-op is used when no callback is provided, allowing stream consumers to receive results via events on the returned Request object. Closes tediousjs#1848 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
dhensby
force-pushed
the
fix/ps-execute-stream
branch
from
127190a to
7934ff1
Compare
|
🎉 This PR is included in version 12.5.2 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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
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.
Summary
Fixes a
TypeError: callback is not a functionthat occurs when callingps.execute(values)withps.stream = trueand no callback provided.Root Cause
In
_execute(), the innerreq.execute('sp_execute', callback)unconditionally callscallback(null, result)on completion — but when streaming without a callback,callbackisundefined.Fix
Guard the callback parameter in
_execute()so a no-op function is used when no callback is provided. This allows stream consumers to receive results viarow/error/doneevents on the returned Request object, consistent with howRequest.query(),Request.batch(), andRequest.execute()handle streaming.Test
Added a unit test that verifies
ps.execute({})does not throw whenstream = trueand no callback is given. The test confirms the TypeError regression on master and passes with the fix.Closes #1848