fix: Ensure data is only transmitted on open and ready connections. #1051

hjdhjd · 2024-07-04T01:09:28Z

♻️ Current situation

When a HomeKit Secure Video recording event is closed while inflight, HAP-NodeJS still attempts to send data over a closed connection resulting in errors like:

[HDS ::ffff:1.2.3.4] Encountered unexpected error for recording stream 1: Error: Cannot send message on closing/closed socket!
    at new HDSConnectionError (/opt/homebrew/lib/node_modules/homebridge/node_modules/hap-nodejs/src/lib/datastream/DataStreamServer.ts:578:10)
    at DataStreamConnection.sendHDSFrame (/opt/homebrew/lib/node_modules/homebridge/node_modules/hap-nodejs/src/lib/datastream/DataStreamServer.ts:1066:13)
    at DataStreamConnection.sendEvent (/opt/homebrew/lib/node_modules/homebridge/node_modules/hap-nodejs/src/lib/datastream/DataStreamServer.ts:718:10)
    at CameraRecordingStream.<anonymous> (/opt/homebrew/lib/node_modules/homebridge/node_modules/hap-nodejs/src/lib/camera/RecordingManagement.ts:1042:27)
    at step (/opt/homebrew/lib/node_modules/homebridge/node_modules/tslib/tslib.js:195:27)
    at Object.next (/opt/homebrew/lib/node_modules/homebridge/node_modules/tslib/tslib.js:176:57)
    at fulfilled (/opt/homebrew/lib/node_modules/homebridge/node_modules/tslib/tslib.js:166:62)
    at processTicksAndRejections (node:internal/process/task_queues:95:5)

💡 Proposed solution

This PR addresses the problem in two places:

In the DataStreamServer module, ensure sendEvent only ever attempts to send if the connection is in the READY state.
In the RecordingManagement module, ensure our connection hasn’t been closed while we are processing data from the recording delegate.

⚙️ Release Notes

fix: For HomeKit Secure Video events, ensure data is only transmitted on open and ready connections.

Reviewer Nudging

@Supereg

The base branch was changed.

@hjdhjd

## v1.0.0 (2025-07-11) ### Breaking Changes - **The minimum Node.js version required is now `v18`.** - **Important notice:** Because of the cleanup of the Deprecated code, you will need to migrate you code base. - Remove the long-deprecated init(). - Deprecate Core, BridgedCore, legacy Camera characteristics. (#1058) (@hjdhjd) - For deprecated `Core` and `BridgedCore` see: https://github.com/homebridge/HAP-NodeJS/wiki/Deprecation-of-Core-and-BridgeCore - Legacy code deprecation cleanup. (#1059) (@hjdhjd) - For deprecated `storagePath` switch to `HAPStorage.setCustomStoragePath`, `AudioCodec` switch to `AudioStreamingCodec`, `VideoCodec` switch to `H264CodecParameters`,`StreamAudioParams` switch to `AudioStreamingOptions`, `StreamVideoParams` switch to `VideoStreamingOptions`,`cameraSource` switch to `CameraController`. - Others deprecated code to highlight removed: `useLegacyAdvertiser`, `AccessoryLoader`, ### Fixed - Fix: Build Issues (#1041) (@NorthernMan54) - Fix: Ensure data is only transmitted on open and ready connections. (#1051) (@hjdhjd) - Fix: Ensure we check names using the full UTF-8 character set. (#1052) (@hjdhjd) - Fix: ConfiguredName (#1049) (@donavanbecker) - Fix: Manufacturer looking at checkName but should look at checkValue. (#1053) (@donavanbecker) ### Other Changes - Implement warning messages for invalid characters in names (#1009) (@NorthernMan54) - Mitigate event emitter "memory leak" warnings when a significant number of camera streaming events occur simultaneously (#1037) (@hjdhjd) - AdaptiveLightingController fix & improvement (#1038) (@Shaquu) - Minor fixes to recording logging and one change in logging. (#1040) (@hjdhjd) - Bridged core and core cleanup (#1048) (@Shaquu) - Increase snapshot handler warning timeout to 8000ms. (#1055) (@hjdhjd) - Cleanup and refactor getLocalNetworkInterface and address a potential edge case. (#1056) (@hjdhjd) - Correct log spacing - Updated and fixed `typedoc` config file - Updated dependencies ### Homebridge Dependencies - `@homebridge/ciao` @ `v1.3.0` - `bonjour-hap` @ `v3.8.0`

@hjdhjd

- **The minimum Node.js version required is now `v18`.** - **Important notice:** Because of the cleanup of the Deprecated code, you will need to migrate you code base. - Remove the long-deprecated init(). - Deprecate Core, BridgedCore, legacy Camera characteristics. (#1058) (@hjdhjd) - For deprecated `Core` and `BridgedCore` see: https://github.com/homebridge/HAP-NodeJS/wiki/Deprecation-of-Core-and-BridgeCore - Legacy code deprecation cleanup. (#1059) (@hjdhjd) - For deprecated `storagePath` switch to `HAPStorage.setCustomStoragePath`, `AudioCodec` switch to `AudioStreamingCodec`, `VideoCodec` switch to `H264CodecParameters`,`StreamAudioParams` switch to `AudioStreamingOptions`, `StreamVideoParams` switch to `VideoStreamingOptions`,`cameraSource` switch to `CameraController`. - Others deprecated code to highlight removed: `useLegacyAdvertiser`, `AccessoryLoader`. - Fix: Naming for Characteristic.ProgramMode has been corrected from `PROGRAM_SCHEDULED_MANUAL_MODE_` to `PROGRAM_SCHEDULED_MANUAL_MODE` - Fix: Build Issues (#1041) (@NorthernMan54) - Fix: Ensure data is only transmitted on open and ready connections. (#1051) (@hjdhjd) - Fix: Ensure we check names using the full UTF-8 character set. (#1052) (@hjdhjd) - Fix: ConfiguredName (#1049) (@donavanbecker) - Fix: Manufacturer looking at checkName but should look at checkValue. (#1053) (@donavanbecker) - Implement warning messages for invalid characters in names (#1009) (@NorthernMan54) - Mitigate event emitter "memory leak" warnings when a significant number of camera streaming events occur simultaneously (#1037) (@hjdhjd) - AdaptiveLightingController fix & improvement (#1038) (@Shaquu) - Minor fixes to recording logging and one change in logging. (#1040) (@hjdhjd) - Bridged core and core cleanup (#1048) (@Shaquu) - Increase snapshot handler warning timeout to 8000ms. (#1055) (@hjdhjd) - Cleanup and refactor getLocalNetworkInterface and address a potential edge case. (#1056) (@hjdhjd) - Correct log spacing - Updated and fixed `typedoc` config file - Updated dependencies - `@homebridge/ciao` @ `v1.3.0` - `bonjour-hap` @ `v3.8.0`

@hjdhjd

## v1.0.0 (2024-07-10) ### Breaking Changes - **The minimum Node.js version required is now `v18`.** - **Important notice:** Because of the cleanup of the Deprecated code, you will need to migrate you code base. - Remove the long-deprecated init(). - Deprecate Core, BridgedCore, legacy Camera characteristics. (#1058) (@hjdhjd) - For deprecated `Core` and `BridgedCore` see: https://github.com/homebridge/HAP-NodeJS/wiki/Deprecation-of-Core-and-BridgeCore - Legacy code deprecation cleanup. (#1059) (@hjdhjd) - For deprecated `storagePath` switch to `HAPStorage.setCustomStoragePath`, `AudioCodec` switch to `AudioStreamingCodec`, `VideoCodec` switch to `H264CodecParameters`,`StreamAudioParams` switch to `AudioStreamingOptions`, `StreamVideoParams` switch to `VideoStreamingOptions`,`cameraSource` switch to `CameraController`. - Others deprecated code to highlight removed: `useLegacyAdvertiser`, `AccessoryLoader`. - Fix: Naming for Characteristic.ProgramMode has been corrected from `PROGRAM_SCHEDULED_MANUAL_MODE_` to `PROGRAM_SCHEDULED_MANUAL_MODE` ### Fixed - Fix: Build Issues (#1041) (@NorthernMan54) - Fix: Ensure data is only transmitted on open and ready connections. (#1051) (@hjdhjd) - Fix: Ensure we check names using the full UTF-8 character set. (#1052) (@hjdhjd) - Fix: ConfiguredName (#1049) (@donavanbecker) - Fix: Manufacturer looking at checkName but should look at checkValue. (#1053) (@donavanbecker) ### Other Changes - Implement warning messages for invalid characters in names (#1009) (@NorthernMan54) - Mitigate event emitter "memory leak" warnings when a significant number of camera streaming events occur simultaneously (#1037) (@hjdhjd) - AdaptiveLightingController fix & improvement (#1038) (@Shaquu) - Minor fixes to recording logging and one change in logging. (#1040) (@hjdhjd) - Bridged core and core cleanup (#1048) (@Shaquu) - Increase snapshot handler warning timeout to 8000ms. (#1055) (@hjdhjd) - Cleanup and refactor getLocalNetworkInterface and address a potential edge case. (#1056) (@hjdhjd) - Correct log spacing - Updated and fixed `typedoc` config file - Updated dependencies ### Homebridge Dependencies - `@homebridge/ciao` @ `v1.3.0` - `bonjour-hap` @ `v3.8.0`

…1051) Co-Authored-By: hjdhjd <hjdhjd@users.noreply.github.com>

fix: Ensure data is only transmitted on open and ready connections.

87c9077

hjdhjd requested a review from bauer-andreas July 4, 2024 01:09

github-actions bot added latest fix labels Jul 4, 2024

hjdhjd enabled auto-merge (squash) July 4, 2024 03:24

donavanbecker previously approved these changes Jul 4, 2024

View reviewed changes

donavanbecker changed the base branch from latest to beta-0.12.3 July 4, 2024 04:16

Merge branch 'beta-0.12.3' into hjd-datastream-bugfix

8f3ffdd

github-actions bot added the beta This is in some form related to the current beta release label Jul 4, 2024

Merge branch 'beta-0.12.3' into hjd-datastream-bugfix

594eb0e

donavanbecker merged commit 11b83d4 into beta-0.12.3 Jul 4, 2024

donavanbecker deleted the hjd-datastream-bugfix branch July 4, 2024 04:33

donavanbecker mentioned this pull request Jul 4, 2024

v1.0.0 #1042

Merged

bwp91 mentioned this pull request Jul 27, 2024

v0.13.0 release #1070

Closed

bwp91 added a commit that referenced this pull request Jun 1, 2025

fix: Ensure data is only transmitted on open and ready connections. (#…

ff868af

…1051) Co-Authored-By: hjdhjd <hjdhjd@users.noreply.github.com>

bwp91 added a commit that referenced this pull request Jun 4, 2025

fix: Ensure data is only transmitted on open and ready connections. (#…

6c46e16

…1051) Co-Authored-By: hjdhjd <hjdhjd@users.noreply.github.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix: Ensure data is only transmitted on open and ready connections. #1051

fix: Ensure data is only transmitted on open and ready connections. #1051

Uh oh!

hjdhjd commented Jul 4, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

fix: Ensure data is only transmitted on open and ready connections. #1051

fix: Ensure data is only transmitted on open and ready connections. #1051

Uh oh!

Conversation

hjdhjd commented Jul 4, 2024

♻️ Current situation

💡 Proposed solution

⚙️ Release Notes

Reviewer Nudging

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants