peers/peerjs

Seemingly valid peer ids rejected by validateId function

Open

#849 opened on May 19, 2021

View on GitHub
 (1 comment) (2 reactions) (0 assignees)TypeScript (11,580 stars) (1,406 forks)batch import
bugclientconfirmedhelp wanted

Description

The API documentation states: The ID must start and end with an alphanumeric character (lower or upper case character or a digit). In the middle of the ID spaces, dashes (-) and underscores (_) are allowed.

Problem: According to the documentation the below ids should be valid but instead throw the error "invalid-id". The docs fail to mention that spaces, dashes, and underscores cannot be next to each other. acb123_-xyz acb123__xyz acb123--xyz acb123 -xyz

Solution: If there is no functional reason for this limitation the validateId function regex could be updated to reflect the documentation. Alternatively the documentation could be amended.

The regex that validate the peer id is currently: ^[A-Za-z0-9]+(?:[ _-][A-Za-z0-9]+)*$

Updated regex to match documentation: ^[A-Za-z0-9][A-Za-z0-9_- ]*[A-Za-z0-9]$

Contributor guide

Tech stack
typescript
Domain
backend
Issue type
bug
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.
under 1 hour
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
JavaScriptregular expressions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Locate the validateId function in the PeerJS source code (likely in a file like 'lib/util.ts' or similar). Update the regex from `^[A Za z0-9]+(?:[ ][A Za z0-9]+)*$` to `^[A Za z0-9][A Za z0-9 ]*[A Za z0-9]$` as suggested, ensuring it matches the documented constraints. Check if any existing tests need to be updated to cover the new valid IDs. If the current regex is intentional for other reasons, consider amending the documentation instead.