peers/peerjs

Error expected on DataConnection when not establishing a connection

Open

#924 opened on Feb 17, 2022

View on GitHub
 (5 comments) (7 reactions) (0 assignees)TypeScript (11,580 stars) (1,406 forks)batch import
clientfeaturehelp wanted

Description

When a DataConnection fails to establish, for example, due to connecting to an invalid ID or to one's own ID, I would expect the dataConnection.on('error', () => {...}) callback to be executed. Instead, only peer.on('error', () => {}) catches such kinds of errors. This is especially annoying when you want to for example connect to multiple peers at once since we cannot know which one has failed to connect, making it hard to tell the user which peer(s) has issues.

Contributor guide

Tech stack
typescriptjavascript
Domain
api
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic understanding of WebRTCFamiliarity with PeerJS API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Investigate the DataConnection class in the source code (likely `src/dataconnection.ts`). Understand how the base Peer class emits errors and replicate that pattern in DataConnection. Ensure that errors during connection setup (e.g., invalid ID or connecting to self) trigger the new event. Update the TypeScript typings and write tests for the new event.