search

matrix-org / matrix-hookshot

A bridge between Matrix and multiple project management services, such as GitHub, GitLab and JIRA.
https://matrix-org.github.io/matrix-hookshot/
Apache License 2.0
282 stars 67 forks source link

Add an ID for "See logs for details" notices #268

Open jaller94 opened 2 years ago

jaller94 commented 2 years ago

Is your feature request related to a problem? Please describe. As a user i don't know how to tell my bridge admin how to find the As a bridge admin I'm frustrated to ask and look for timestamps while possibly having to convert timezones and finding the wrong error.

Describe the solution you'd like A unique ID that I can give to grep and get the correct error for.

Describe alternatives you've considered Getting rid of "See logs for details" wherever possible. See #269.

Additional context For confidentiality it might be good to make these IDs very hard to guess (pretty much like YouTube video IDs). That way an admin won't accidentally provide a malicious user any confidential info about a error that doesn't belong to them.

Instances https://github.com/matrix-org/matrix-hookshot/blob/75a91d0ab4a4285a38f59c07f3a5a3682021b38c/src/AdminRoom.ts#L220-L221

Half-Shot commented 2 years ago

IDs are good. I'd like to move to request IDs internally so that every interaction is tracked (like we have for the IRC bridge). We can then log that request ID up to the user for further investigation.

We also have a CommandError type which should report a insensitive error to the user but a full error in the logs.