mongodb-js / devtools-shared / 26910293254

79%

Build Type

push

github

Committed by web-flow

Commit Message

feat(devtools-connect): emit tunnel error events on the logger COMPASS-8355 (#774)

* feat(devtools-connect): emit tunnel error events on the logger COMPASS-8355

Add devtools-connect:tunnel-error and devtools-connect:tunnel-forwarding-error
events to ConnectEventMap, wired from the Tunnel object's 'error' and
'forwardingError' events respectively.

This allows callers to observe tunnel failures without needing to hold a
direct reference to the tunnel object. It is the prerequisite for removing
the duplicate SSH tunnel management code in Compass (connect-mongo-client.ts,
ssh-tunnel-helpers.ts, data-service.ts) in the next step.

* Update packages/devtools-connect/src/connect.ts

Co-authored-by: Anna Henningsen <anna.henningsen@mongodb.com>

* chore(devtools-connect): fix pre-existing prettier formatting in log-hook.ts COMPASS-8355

* chore(devtools-connect): reformat with prettier 3.8.3 COMPASS-8355

* chore(devtools-connect): fix formatting

* test(devtools-connect): add coverage for tunnel error event emission COMPASS-8355

Use Object.defineProperty to replace the getter-based createSocks5Tunnel
export (sinon.stub cannot replace non-writable getters) with a fake tunnel,
then verify that tunnel 'error' and 'forwardingError' events are forwarded
as devtools-connect:tunnel-error and devtools-connect:tunnel-forwarding-error
on the logger.

---------

Co-authored-by: Anna Henningsen <anna.henningsen@mongodb.com>

Coverage Stats

1903 of 2674 branches covered (71.17%)

Branch coverage included in aggregate %.

4 of 7 new or added lines in 1 file covered. (57.14%)

3 existing lines in 1 file now uncovered.

4101 of 4933 relevant lines covered (83.13%)

633.19 hits per line