Comprehensive Jest Reporting Challenge: Detailed Test Results

This challenge focuses on enhancing Jest's reporting capabilities to provide more detailed and actionable insights into test failures. Often, Jest's default reports lack sufficient context to quickly diagnose and resolve issues, especially in complex projects. Your task is to create a Jest reporter that generates a detailed report, including stack traces, error messages, and relevant context for each failed test.

Problem Description

You are tasked with creating a custom Jest reporter that extends the default Jest reporting functionality. This reporter should provide significantly more detailed information when a test fails, going beyond the basic "Test Failed" message. The goal is to make debugging test failures faster and easier by providing all necessary information in a single, comprehensive report.

What needs to be achieved:

• Create a Jest reporter plugin.
• The reporter should log detailed information for each failed test case. This information must include:
  • The full error message.
  • A complete stack trace for the error.
  • The test case description (title).
  • The test suite description (name).
• The report should be human-readable and easily parsable (e.g., suitable for logging to a file).
• The reporter should integrate seamlessly with Jest's existing reporting infrastructure.

Key Requirements:

• The reporter must be written in TypeScript.
• The reporter must be compatible with Jest versions 18 or higher.
• The reporter should not significantly impact Jest's performance.
• The reporter should be configurable (e.g., allow users to enable/disable detailed stack traces).

Expected Behavior:

When a test fails, the reporter should output a detailed report to the console (or a file, if configured) containing the information listed above. Successful tests should not generate any additional output from the custom reporter. The reporter should not interfere with Jest's default reporting.

Edge Cases to Consider:

• Tests that throw errors synchronously.
• Tests that fail due to asynchronous operations (e.g., promises, async/await).
• Tests that fail due to timeouts.
• Tests with complex stack traces spanning multiple files and modules.
• Tests that fail within beforeEach or afterEach hooks.
• Tests that use expect.assertions and fail to meet the assertion count.

Examples

Example 1:

Input: A test case that throws an error synchronously:

describe('My Component', () => {
  it('should throw an error', () => {
    throw new Error('Something went wrong!');
  });
});

Output:

[Detailed Report]
Test Suite: My Component
Test Case: should throw an error
Error Message: Error: Something went wrong!
Stack Trace:
Error: Something went wrong!
    at MyComponent.it (path/to/your/file.ts:5:9)

Example 2:

Input: A test case that fails due to an unhandled promise rejection:

describe('Async Test', () => {
  it('should reject a promise', async () => {
    return Promise.reject(new Error('Promise rejected'));
  });
});

Output:

[Detailed Report]
Test Suite: Async Test
Test Case: should reject a promise
Error Message: Error: Promise rejected
Stack Trace:
Error: Promise rejected
    at MyAsyncFile.it (path/to/your/file.ts:6:9)

Constraints

• Performance: The reporter should not increase the overall test execution time by more than 10%.
• Input Format: The input to the reporter plugin will be the standard Jest TestResult object.
• Output Format: The output should be a human-readable string suitable for console logging. Consider using a consistent format (e.g., JSON or a structured text format) for easier parsing.
• Configuration: The reporter should accept a configuration object with at least one option: showStackTraces (boolean, default: true).

Notes

• You'll need to create a Jest reporter plugin, which involves implementing the JestReporter interface.
• Utilize Jest's TestResult object to access information about the tests and their results.
• Consider using a library like util.inspect or a custom formatting function to create a readable stack trace.
• Think about how to handle asynchronous errors and timeouts gracefully.
• Focus on providing clear and concise information that will help developers quickly identify and fix test failures.
• Remember to include a jest.config.js or similar configuration file demonstrating how to use your reporter.