Fix tryTo steps appearing in test failure traces #5088

Original file line number	Diff line number	Diff line change
Expand Up		@@ -3,10 +3,14 @@ const event = require('../event')
		const store = require('../store')
		const output = require('../output')
		const { BeforeHook, AfterHook, BeforeSuiteHook, AfterSuiteHook } = require('../mocha/hooks')
	const recorder = require('../recorder')

		let currentTest
		let currentHook

	// Session names that should not contribute steps to the main test trace
	const EXCLUDED_SESSIONS = ['tryTo', 'hopeThat']

		/**
		* Register steps inside tests
		*/
Expand Down Expand Up		@@ -75,6 +79,14 @@ module.exports = function () {
		return currentHook.steps.push(step)
		}
		if (!currentTest \|\| !currentTest.steps) return

	// Check if we're in a session that should be excluded from main test steps
	const currentSessionId = recorder.getCurrentSessionId()
	if (currentSessionId && EXCLUDED_SESSIONS.includes(currentSessionId)) {
	// Skip adding this step to the main test steps
	return
	}

		currentTest.steps.push(step)
		})

Expand Down

9 changes: 9 additions & 0 deletions lib/recorder.js

Show comments View file Open in desktop

Original file line number	Diff line number	Diff line change
Expand Up		@@ -379,6 +379,15 @@ module.exports = {
		toString() {
		return `Queue: ${currentQueue()}\n\nTasks: ${this.scheduled()}`
		},

	/**
	* Get current session ID
	* @return {string\|null}
	* @inner
	*/
	getCurrentSessionId() {
	return sessionId
	},
		}

		function getTimeoutPromise(timeoutMs, taskName) {
Expand Down

118 changes: 118 additions & 0 deletions test/unit/listener/steps_issue_4619_test.js

Show comments View file Open in desktop

Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,118 @@
	const { expect } = require('chai')
	const sinon = require('sinon')
	const event = require('../../../lib/event')
	const recorder = require('../../../lib/recorder')
	const { tryTo, hopeThat } = require('../../../lib/effects')
	const Step = require('../../../lib/step')

	// Import and initialize the steps listener
	const stepsListener = require('../../../lib/listener/steps')

	describe('Steps Listener - Issue Fix #4619', () => {
	let currentTest

	beforeEach(() => {
	// Reset everything
	recorder.reset()
	recorder.start()
	event.cleanDispatcher()

	// Initialize the steps listener (it needs to be called as a function)
	stepsListener()

	// Create a mock test object
	currentTest = {
	title: 'Test Case for Issue #4619',
	steps: [],
	}

	// Emit test started event to properly initialize the listener
	event.emit(event.test.started, currentTest)
	})

	afterEach(() => {
	event.cleanDispatcher()
	recorder.reset()
	})

	it('should exclude steps emitted during tryTo sessions from main test trace', async () => {
	// This is the core fix: steps emitted inside tryTo should not pollute the main test trace

	const stepCountBefore = currentTest.steps.length

	// Execute tryTo and emit a step inside it
	await tryTo(() => {
	const tryToStep = new Step(
	{
	optionalAction: () => {
	throw new Error('Expected to fail')
	},
	},
	'optionalAction',
	)
	event.emit(event.step.started, tryToStep)
	recorder.add(() => {
	throw new Error('Expected to fail')
	})
	})

	const stepCountAfter = currentTest.steps.length

	// The manually emitted step should not appear in the main test trace
	const stepNames = currentTest.steps.map(step => step.name)
	expect(stepNames).to.not.include('optionalAction')

	return recorder.promise()
	})

	it('should exclude steps emitted during hopeThat sessions from main test trace', async () => {
	await hopeThat(() => {
	const hopeThatStep = new Step({ softAssertion: () => 'done' }, 'softAssertion')
	event.emit(event.step.started, hopeThatStep)
	})

	// The manually emitted step should not appear in the main test trace
	const stepNames = currentTest.steps.map(step => step.name)
	expect(stepNames).to.not.include('softAssertion')

	return recorder.promise()
	})

	it('should still allow regular steps to be added normally', () => {
	// Regular steps outside of special sessions should work normally
	const regularStep = new Step({ normalAction: () => 'done' }, 'normalAction')
	event.emit(event.step.started, regularStep)

	const stepNames = currentTest.steps.map(step => step.name)
	expect(stepNames).to.include('normalAction')
	})

	it('should validate the session filtering logic works correctly', async () => {
	// This test validates that the core logic in the fix is working

	// Add a regular step
	const regularStep = new Step({ regularAction: () => 'done' }, 'regularAction')
	event.emit(event.step.started, regularStep)

	// Execute tryTo and verify the filtering works
	await tryTo(() => {
	const filteredStep = new Step({ filteredAction: () => 'done' }, 'filteredAction')
	event.emit(event.step.started, filteredStep)
	})

	// Add another regular step
	const anotherRegularStep = new Step({ anotherRegularAction: () => 'done' }, 'anotherRegularAction')
	event.emit(event.step.started, anotherRegularStep)

	const stepNames = currentTest.steps.map(step => step.name)

	// Regular steps should be present
	expect(stepNames).to.include('regularAction')
	expect(stepNames).to.include('anotherRegularAction')

	// Filtered step should not be present
	expect(stepNames).to.not.include('filteredAction')

	return recorder.promise()
	})
	})

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Fix tryTo steps appearing in test failure traces #5088

Uh oh!

Fix tryTo steps appearing in test failure traces #5088

Filter by extension

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing