wix/Detox

Detox log artifact (at test level)

Open

#3,663 opened on Nov 3, 2022

View on GitHubContributor guide
 (1 comment) (0 reactions) (1 assignee)JavaScript (1,942 forks)batch import
domain: uxhacktoberfeststatus: acceptedtype: enhancement ⚡️user: looking for contributors

Repository metrics

Stars
 (10,558 stars)
PR merge metrics
 (PR metrics pending)

Description

Description

It can sometimes be a bit difficult to be able to trace the cause of a test failure based on the existing artifacts. At often times, on top of things such as the error message and screenshots/video, being able to review the Detox log itself can be beneficial.

While the logs are generally available (e.g. in the context of a CI build / general artifact), they are only recorded as a part of the entire testing session, and not under the context of each specific test. It make the debugging/inspection use case feel cluttered and inefficient.

Proposal: An opt-out, (trace-level?) Detox log artifact in the scope of each test.

@noomorph

Contributor guide

Research direction
Examine the current Detox logging system to understand how session level logs are generated. Then, design a mechanism to produce per test log artifacts that can be independently accessed and stored. Consider trace level logging and opt out options.
Tech stack
javascripttypescriptreact native
Domain
testingmobile dev
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptTypeScriptReact Native
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70