[RFC] Plugin Feedback API

[KazWolfe]

RFC-lite/tracker for the following changes:

• Implement a new BugBait service so that plugins may attach their own data to feedback requests. This would be useful for, e.g., providing snippets of configuration or other settings when feedback is sent. The user should be able to disable submitting plugin-provided metadata alongside their feedback.
  • Ideally, plugins would return a string containing a JSON blob of the most relevant information.
  • This string should be no longer than 1024 characters to comply with Discord embed limits. Any trimming will happen server-side.
  • This will (obviously) not be called for plugins that are unloaded or errored.
• Implement a better log filter to show the last exception raised by that specific plugin.
  • Serilog already should know which plugin any given log line comes from, so we can track LastException on a per-plugin basis.
• Change BugBait URL to https://api.dalamud.dev/feedback (TBD) hosting new bugbait.

[nathanctech]

Would allowing the use of file attachments (for text, at least) for information exceeding the limit be considered? Since Serilog is aware of the plugin, it might be useful for plugin devs to have relevant log output for the plugin itself when feedback is submitted. The user sending feedback could have a button to attach plugin logs. Of course, for privacy reasons only the plugin-scoped logs should be included.

[KazWolfe]

I'm not opposed to the idea, though I do worry that that'll just make a lot of noise given plugin logs can be relatively big. It'd definitely be a larger shift and not something I want to target in the initial feedback improvements.

[nathanctech]

Makes sense, something to look at down the line if the 1024 characters isn't enough. Discord does allow multiple fields (~8000 character total payload for the embed, 1024 characters per field, as noted) if a dev needed more, but that should be enough for most cases, I'd think.