matrix-org / matrix-org/complement

sytest "Can delete canonical alias" is enforcing "MAY" wording in the spec as mandatory

Offen
#265 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Go
Sterne
99
Forks
72
Ø Merge
4 T. 1 Std.
Gemergte PRs (30 T.)
8

Beschreibung

Sytest "Can delete canonical alias" checks if the server automatically removes an alias from a `m.room.canonical_alias` event if it is deleted via the `/directory/` API.

However, it is probably wrong to enforce this behaviour in two different ways;

First, the spec talks only about `alt_aliases` being automatically updated, see the [following text](https://spec.matrix.org/v1.1/client-server-api/#get_matrixclientv3roomsroomidaliases);

> Note: Servers **may** choose to update the `alt_aliases` for the `m.room.canonical_alias` state event in the room when an alias is removed. Servers which choose to update the canonical alias event are recommended to, in addition to their other relevant permission checks, delete the alias and return a successful response even if the user does not have permission to update the `m.room.canonical_alias` event.

This does not mention anything about the `alias` part of the state event.

Secondly, this is a **MAY** recommendation, which, in the words of [RFC2119](https://datatracker.ietf.org/doc/html/rfc2119);

> This word, or the adjective "OPTIONAL", mean that an item is truly optional.

---

Thus, in my opinion, this sytest shouldn't become a *compliance*-testing complement test, but i'd like some input on this.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit dem sytest-Test "Can delete canonical alias" und vergleiche seine Assertion mit dem verlinkten Text der Matrix-Spezifikation und den RFC2119-Richtlinien. Ermittle, ob der Test das optionale MAY-Verhalten als verpflichtend behandelt; abgeschlossen ist die Aufgabe, wenn die Erwartung des Compliance-Tests mit der in der Spezifikation angegebenen Anforderung übereinstimmt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
go
Bereich
testing-qa
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.