Emit dial events rather than logging them #563
Closed
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
DTCurrie
reviewed
May 21, 2025
DTCurrie
approved these changes
May 21, 2025
njooma
reviewed
May 23, 2025
| // eslint-disable-next-line no-console | ||
| console.debug('Reconnected successfully!'); | ||
| this.emit(MachineConnectionEvent.DIAL_EVENT, { | ||
| message: 'Reconnected successfully', |
There was a problem hiding this comment.
Why is this a DIAL_EVENT and not CONNECTED?
| await client.connect({ | ||
| priority: conf.priority, | ||
| dialTimeout: conf.dialTimeout ?? DIAL_TIMEOUT, | ||
| creds: conf.credentials, | ||
| }); | ||
|
|
||
| // eslint-disable-next-line no-console | ||
| console.debug('connected via WebRTC'); | ||
| client.emit(MachineConnectionEvent.DIAL_EVENT, { |
There was a problem hiding this comment.
Similarly, why is this a DIAL_EVENT and not CONNECTED?
| @@ -9,21 +9,22 @@ export enum MachineConnectionEvent { | |||
| CONNECTED = 'connected', | |||
| DISCONNECTING = 'disconnecting', | |||
| DISCONNECTED = 'disconnected', | |||
| DIAL_EVENT = 'dialing', | |||
There was a problem hiding this comment.
Is DIALING different than CONNECTING?
|
Solved by #619 |
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.
Currently we don't allow end-users to consume dial events, we only log them to the JS console. Logging isn't a good idea for production apps because:
This PR improves both situations by instead having the RobotClient emit dial events, which we can present in UIs, and removing logs.