matrix-org / matrix-org/matrix-hookshot
Integration tests diverge from real world usage
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 450
- Forks
- 95
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 23
Description
We observed in #1205 that the help command was only broken in the release builds, but the tests would continue to pass. This seemed to just be because the import order / compilation steps differ, so in practice we're not quite testing the same code as we are releasing.
The solution is probably quite simple here: We should build Hookshot, run it as a container alongside our other components and only pilot it through our APIs and Matrix layers. We already do this to a large extent and I think we rarely "reach in" to the application.
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
Start with issue #1205 and the existing integration-test setup to understand why release builds exercise different code from tests. Define the containerized release-build path, run Hookshot alongside the other components, and verify it only through the APIs and Matrix layers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- testing
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100