matrix-org / matrix-org/patience

Add room DAG visualizations

Open
#7 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
21
Forks
3
PR merge metrics
No merged PRs in 30d

Description

During monthly wrap-up demos today, I heard that @jryans had plans to add the room DAG visualization to the [`patience` test harness](https://github.com/matrix-org/collaborative-documents/tree/main/test/patience) interface 😍 This is exactly what I have been aspiring to add as well!

> Would be cool to make a generalized solution to make a TARDIS visualization for any test run in Complement (after hook to save a file which we can view in TARDIS)
>
> *-- https://github.com/matrix-org/complement/pull/68*

Patience already automates hooking up Element to the homeserver which I was doing manually and added docs for, https://github.com/matrix-org/complement/blob/master/ONBOARDING.md#how-do-i-hook-up-a-matrix-client-like-element-to-the-homeservers-spun-up-by-complement-after-a-test-runs

So it sounds like a perfect opportunity to combine some efforts 🤠. My use case is a little different as I am after testing the homeserver vs testing a client but there is so much overlap here.

For reference on the DAG visualizations I have been generating so far, I adapted TARDIS to work with Synapse, https://github.com/matrix-org/tardis/pull/1

![](https://user-images.githubusercontent.com/558581/106591475-f094ce00-6513-11eb-8022-d9df1a229edc.png)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the test/patience harness interface and the referenced Complement PR 68, then compare the Synapse adaptation in TARDIS. Define how a test run exposes its room DAG and how the generated file is opened in TARDIS; done means the patience harness can produce a visualization for the relevant test runs.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
data-visualization, testing-qa
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.