Add optional timeout argument to callService #835
Merged
Conversation
This file contains 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
bjsowa
force-pushed
the
feature/call-service-timeout
branch
from
522e658 to
72630a5
Compare
EzraBrooks
reviewed
Jan 23, 2025
src/core/Service.js
Outdated
Comment on lines
76
to
82
| args: request | ||
| }; | ||
|
|
||
| if (timeout !== undefined) { | ||
| call.timeout = timeout; | ||
| } | ||
|
|
There was a problem hiding this comment.
Is there a reason that this can't be put in the definition of the object above? Does passing timeout: undefined into rosbridge break it? That seems like an API issue, since it can be tricky to easily discern in a JavaScript application whether something is deliberately undefined or missing.
I'd rather this read
Suggested change
| args: request | |
| }; | |
| if (timeout !== undefined) { | |
| call.timeout = timeout; | |
| } | |
| args: request, | |
| timeout: timeout | |
| }; |
and if this causes an issue in rosbridge we should fix it there.
There was a problem hiding this comment.
It seems that properties with undefined value are just being omitted when converted to JSON.
EzraBrooks
approved these changes
Jan 23, 2025
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.
Public API Changes
Added optional
timeoutargument to callService.Description
After RobotWebTools/rosbridge_suite#984 was merged, it is now possible to specify a timeout when calling a service. This PR exposes this functionality to roslibjs public API.