mumble-voip/mumble

Improve error message for invalid channel name

Open

#3993 opened on Mar 13, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C++ (5,642 stars) (1,062 forks)batch import
feature-requestgood first issueserver

Description

Context We had a bunch of users that have been confused as to why they can't name their channels in a certain way. This is because from the error message it isn't clear what names would be allowed and that this is a server setting that can be tweaked.

Describe the feature you have in mind We should enhance the error message to include the RegEx that is currently set for the server when stating that the name is invalid. And potentially we also want to include a hint that this is a setting of the server and nothing hard-coded.

Contributor guide

Tech stack
cpp
Domain
desktop
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
C++knowledge of Mumble's codebase structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
First, find the error message for invalid channel names in the Mumble codebase; it is likely in the server or client code for channel creation (e.g., Server.cpp or Channel.cpp). Then, access the server's channel name regex setting (likely from the ServerConfig or similar) and include that regex in the error message. Also add a note that the regex is configurable by the server admin. Test the change by creating invalid channel names on a test server.