[node:test] Incorrect SuiteContext description

Affected URL(s)

https://nodejs.org/docs/latest-v18.x/api/test.html#describename-options-fn

Description of the problem

Docs said that tha callback function in describe:

declaring all subtests and subsuites. The first argument to this function is a SuiteContext object.

But in fact SuiteContext is not the first argument. SuiteContext is this context:

import { describe } from 'node:test'

describe(function(foo) {
    console.log('First argument: ', foo)
    console.log('this: ', this)
})

> First argument:  []
> this:  { signal: AbortSignal { aborted: false }, name: '<anonymous>' }

But TestContext is the first argument:

import { test } from 'node:test'

test(function(foo) {
    console.log('First argument: ', foo)
    console.log('this: ', this)
})

> First argument:  TestContext {}
> this:  TestContext {}

@MoLow

@MoLow it looks like the SuiteContext language was added in 389b7e1. It doesn't look like SuiteContext exists in the code though. Should all references to SuiteContext be replaced with TestContext?

@cjihrig

@cjihrig it is simply generated as an object literal

node/lib/internal/test_runner/test.js

Lines 739 to 741 in f8ce911

    
           getRunArgs() { 
        
             return { ctx: { signal: this.signal, name: this.name }, args: [] }; 
        
           }

I think we should either change the docs to remove the use of SuiteContext since it doesn't really exist as a class or update the code to make it an actual class. I think updating the code would be easiest in this case.

lib: added SuiteContext class

@cjihrig

Have added PR for the same @cjihrig

lib: added SuiteContext class

Navigation Menu

Repository navigation

[node:test] Incorrect `SuiteContext` description #45641

Affected URL(s)

Description of the problem

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

	getRunArgs() {
	return { ctx: { signal: this.signal, name: this.name }, args: [] };
	}

[node:test] Incorrect SuiteContext description #45641

Description

Affected URL(s)

Description of the problem

Activity

Semigradsky commented on Nov 27, 2022

cjihrig commented on Nov 27, 2022

MoLow commented on Nov 28, 2022

cjihrig commented on Nov 29, 2022

debadree25 commented on Nov 30, 2022

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions

[node:test] Incorrect `SuiteContext` description #45641