matrix-org / matrix-org/matrix-hookshot
Add an ID for "See logs for details" notices
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 450
- Forks
- 95
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 23
Description
**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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read src/AdminRoom.ts around lines 220-221, then review the related alternative in issue #269. Define the notice scope that needs coverage and confirm that each relevant “See logs for details” message exposes a unique, grep-able ID that is difficult to guess.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- backend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100