temporalio / temporalio/sdk-java
Improve diagnostic message printed by TestWorkflowRule on timeout.
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 433
- Forks
- 249
- Avg merge
- 5d 6h
- Merged PRs (30d)
- 26
Description
When JUnit test timeouts (because a timeout was specified), the TestWorkflowRule prints out a diagnostic message that contains
histories of all workflows started by the test. This is useful, but misses a lot of useful information that could be used to troubleshoot a stuck test problem.
Some of the potential additions:
- Result of DescribeWorkflowExecution call for each workflow. Especially useful information about activities and workflow tasks in retry.
- Stack trace query result for each open workflow.
- I would also improve the formatting of the printed history
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 by locating TestWorkflowRule and its timeout diagnostic output, then inspect how it currently gathers and formats workflow histories. Determine how DescribeWorkflowExecution and stack trace query results can be included for open workflows, and verify that timeout output contains the additional diagnostics with clearer history formatting.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- distributed-systems
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100