matrix-org / matrix-org/matrix-bifrost

XMPP errors: provide human-readable reason of join failure

Open
#172 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

T-Enhancement
Dominant language
TypeScript
Stars
187
Forks
38
PR merge metrics
No merged PRs in 30d

Description

When an XMPP client fails to join a room, the error response is

<presence type="error" from="#bridged-room#matrix.org@matrix.org/nickname">
  <x xmlns="http://jabber.org/protocol/muc" />
  <error type="cancel" by="#bridged-room#matrix.org@matrix.org">
    <service-unavailable xmlns="urn:ietf:params:xml:ns:xmpp-stanzas" />
  </error>
</presence>

It would be great to also have a <text> element that would explain the actual cause of the error.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the join-failure path that emits the shown XMPP presence error, then inspect how the error response is constructed. Compare the output with the linked XMPP stanza-error specification; done means failed room joins include a text element explaining the actual cause.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
networking
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.