4drian3d / 4drian3d/SignedVelocity

Issue warning, if possible, when behavior changes due to backend plugin handling

Ouverte
#17 4 commentaires 2 réactions 1 personne assignée Réclamée par @4drian3d Voir sur GitHub
bug
Langage dominant
Java
Étoiles
73
Forks
23
Merge moyen
11 h 19 min
PR mergées (30 j)
9

Description

In the pre-existing Velocity API, canceling a chat event prevents it from being sent to the backend servers. Chat canceled on the proxy is therefore invisible to Bukkit plugins. However, using SignedVelocity fundamentally alters this behavior by forwarding **all** chat events, even if canceled, to the backend servers. While this makes the plugin work, it is a behavioral change from the prior status quo, and leaks the abstraction SignedVelocity employs to shore up chat handling in a post-1.19.4 world.

This can be confusing for users who are acquainted to the previous behavior. For example, it may cause certain proxy plugin features to stop working when switching from pre-1.19.4 to post-1.19.4 with SignedVelocity, since the behavior of chat events is now different.

Most of the time, however, uncanceling a canceled chat event doesn't make sense. Fortunately, SignedVelocity is in the unique position of knowing exactly when a chat event was canceled by the proxy but uncanceled by the backend server. I therefore propose SignedVelocity add another listener on `EventPriority.HIGHEST` to log a brief warning if behavior has fundamentally changed as a result of a backend plugin *uncanceling* the event. It should be relatively straightforward given you already have a queue of chat data, so no additional data structure overhead would be incurred. If you want to avoid annoying users, the brief warning can be one-time, or it can be disabled by a config option. However, I argue it should be enabled by default, because it presents a behavioral change from the typical Velocity API proxy plugins are used to.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Piste de recherche

Look at the chat event handling code in SignedVelocity, likely where chat events are queued and forwarded. Identify the listener that currently uncancels events for backend servers. Add a HIGHEST priority listener to detect when a backend plugin uncancels a proxy-canceled event. Implement a configurable warning log, possibly one-time per event type. Check existing configuration options for adding a new toggle.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
java
Domaine
backend, devtools
Type d'issue
Fonctionnalité
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.