fix: use this.options instead of this.config for helper callbacks

The Helper base class from @codeceptjs/helper sets both this.config (raw user config)
and this.options (validated/merged config with defaults). Helpers should consistently
use this.options to access configuration values.

Fixed helpers to use this.options for onRequest/onResponse callbacks:
- REST helper: Fixed onRequest and onResponse to use this.options
- GraphQL helper: Fixed onRequest and onResponse to use this.options
- Playwright helper: Fixed onResponse to use this.options
- JSONResponse helper: Fixed accessing request helper's options.onResponse

Updated tests to match:
- JSONResponse_test.js: Changed restHelper.config to restHelper.options
- JSONResponse_test.js: Made beforeEach async and await Container.create()
- Playwright_test.js: Changed I.config to I.options
- JSONResponse.js: Added named export for test compatibility

This fixes the error: 'Cannot read properties of undefined (reading "name")'
which occurred because JSONResponse tried to access this.helpers.REST.config.onResponse
but REST helper stores callbacks in this.options, not this.config.

All 488 unit tests passing.

Author: kobenguyent

lib/helper/GraphQL.js

@@ -87,8 +87,8 @@ class GraphQL extends Helper {
 
     request.headers = { ...this.headers, ...request.headers }
 
-    if (this.config.onRequest) {
-      await this.config.onRequest(request)
+    if (this.options.onRequest) {
+      await this.options.onRequest(request)
     }
 
     this.debugSection('Request', JSON.stringify(request))
@@ -102,8 +102,8 @@ class GraphQL extends Helper {
       response = err.response
     }
 
-    if (this.config.onResponse) {
-      await this.config.onResponse(response)
+    if (this.options.onResponse) {
+      await this.options.onResponse(response)
     }
 
     this.debugSection('Response', JSON.stringify(response.data))

lib/helper/JSONResponse.js

@@ -72,8 +72,8 @@ class JSONResponse extends Helper {
     if (!this.helpers[this.options.requestHelper]) {
       throw new Error(`Error setting JSONResponse, helper ${this.options.requestHelper} is not enabled in config, helpers: ${Object.keys(this.helpers)}`)
     }
-    const origOnResponse = this.helpers[this.options.requestHelper].config.onResponse
-    this.helpers[this.options.requestHelper].config.onResponse = response => {
+    const origOnResponse = this.helpers[this.options.requestHelper].options.onResponse
+    this.helpers[this.options.requestHelper].options.onResponse = response => {
       this.response = response
       if (typeof origOnResponse === 'function') origOnResponse(response)
     }
@@ -83,7 +83,6 @@ class JSONResponse extends Helper {
     this.response = null
   }
 
-  
   /**
    * Checks that response code is equal to the provided one
    *
@@ -372,4 +371,4 @@ class JSONResponse extends Helper {
   }
 }
 
-export { JSONResponse as default }
+export { JSONResponse, JSONResponse as default }

lib/helper/Playwright.js

@@ -355,7 +355,7 @@ class Playwright extends Helper {
     this.recordingWebSocketMessages = false
     this.recordedWebSocketMessagesAtLeastOnce = false
     this.cdpSession = null
-    
+
     // Filter out invalid customLocatorStrategies (empty arrays, objects without functions)
     // This can happen in worker threads where config is serialized/deserialized
     let validCustomLocators = null
@@ -367,7 +367,7 @@ class Playwright extends Helper {
         validCustomLocators = config.customLocatorStrategies
       }
     }
-    
+
     this.customLocatorStrategies = validCustomLocators
     this._customLocatorsRegistered = false
 
@@ -794,10 +794,7 @@ class Playwright extends Helper {
             await Promise.allSettled(pages.map(p => p.close().catch(() => {})))
           }
           // Use timeout to prevent hanging (10s should be enough for browser cleanup)
-          await Promise.race([
-            this._stopBrowser(),
-            new Promise((_, reject) => setTimeout(() => reject(new Error('Browser stop timeout')), 10000)),
-          ])
+          await Promise.race([this._stopBrowser(), new Promise((_, reject) => setTimeout(() => reject(new Error('Browser stop timeout')), 10000))])
         } catch (e) {
           console.warn('Warning during browser restart in _after:', e.message)
           // Force cleanup even on timeout
@@ -840,10 +837,7 @@ class Playwright extends Helper {
     if (this.isRunning) {
       try {
         // Add timeout protection to prevent hanging
-        await Promise.race([
-          this._stopBrowser(),
-          new Promise((_, reject) => setTimeout(() => reject(new Error('Browser stop timeout in afterSuite')), 10000)),
-        ])
+        await Promise.race([this._stopBrowser(), new Promise((_, reject) => setTimeout(() => reject(new Error('Browser stop timeout in afterSuite')), 10000))])
       } catch (e) {
         console.warn('Warning during suite cleanup:', e.message)
         // Track suite cleanup failures
@@ -954,10 +948,7 @@ class Playwright extends Helper {
     if (this.isRunning) {
       try {
         // Add timeout protection to prevent hanging
-        await Promise.race([
-          this._stopBrowser(),
-          new Promise((_, reject) => setTimeout(() => reject(new Error('Browser stop timeout in cleanup')), 10000)),
-        ])
+        await Promise.race([this._stopBrowser(), new Promise((_, reject) => setTimeout(() => reject(new Error('Browser stop timeout in cleanup')), 10000))])
       } catch (e) {
         console.warn('Warning during final cleanup:', e.message)
         // Force cleanup on timeout
@@ -970,10 +961,7 @@ class Playwright extends Helper {
       if (this.browser) {
         try {
           // Add timeout protection to prevent hanging
-          await Promise.race([
-            this._stopBrowser(),
-            new Promise((_, reject) => setTimeout(() => reject(new Error('Browser stop timeout in forced cleanup')), 10000)),
-          ])
+          await Promise.race([this._stopBrowser(), new Promise((_, reject) => setTimeout(() => reject(new Error('Browser stop timeout in forced cleanup')), 10000))])
         } catch (e) {
           console.warn('Warning during forced cleanup:', e.message)
           // Force cleanup on timeout
@@ -1390,7 +1378,7 @@ class Playwright extends Helper {
     this.context = null
     this.frame = null
     popupStore.clear()
-    
+
     // Remove all event listeners to prevent hanging
     if (this.browser) {
       try {
@@ -1399,7 +1387,7 @@ class Playwright extends Helper {
         // Ignore errors if browser is already closed
       }
     }
-    
+
     if (this.options.recordHar && this.browserContext) {
       try {
         await this.browserContext.close()
@@ -1408,16 +1396,11 @@ class Playwright extends Helper {
       }
     }
     this.browserContext = null
-    
+
     if (this.browser) {
       try {
         // Add timeout to prevent browser.close() from hanging indefinitely
-        await Promise.race([
-          this.browser.close(),
-          new Promise((_, reject) => 
-            setTimeout(() => reject(new Error('Browser close timeout')), 5000)
-          )
-        ])
+        await Promise.race([this.browser.close(), new Promise((_, reject) => setTimeout(() => reject(new Error('Browser close timeout')), 5000))])
       } catch (e) {
         // Ignore errors if browser is already closed or timeout
         if (!e.message?.includes('Browser close timeout')) {
@@ -1539,7 +1522,7 @@ class Playwright extends Helper {
           acceptDownloads: true,
           ...this.options.emulate,
         }
-        
+
         try {
           this.browserContext = await this.browser.newContext(contextOptions)
         } catch (err) {
@@ -3183,14 +3166,14 @@ class Playwright extends Helper {
     this.debugSection('Response', await response.text())
 
     // hook to allow JSON response handle this
-    if (this.config.onResponse) {
+    if (this.options.onResponse) {
       const axiosResponse = {
         data: await response.json(),
         status: response.status(),
         statusText: response.statusText(),
         headers: response.headers(),
       }
-      this.config.onResponse(axiosResponse)
+      this.options.onResponse(axiosResponse)
     }
 
     return response
@@ -4337,11 +4320,11 @@ function isRoleLocatorObject(locator) {
  */
 async function handleRoleLocator(context, locator) {
   if (!isRoleLocatorObject(locator)) return null
-  
+
   const options = {}
   if (locator.text) options.name = locator.text
   if (locator.exact !== undefined) options.exact = locator.exact
-  
+
   return context.getByRole(locator.role, Object.keys(options).length > 0 ? options : undefined).all()
 }
 
@@ -4350,7 +4333,7 @@ async function findElements(matcher, locator) {
   const isReactLocator = locator.type === 'react' || (locator.locator && locator.locator.react) || locator.react
   const isVueLocator = locator.type === 'vue' || (locator.locator && locator.locator.vue) || locator.vue
   const isPwLocator = locator.type === 'pw' || (locator.locator && locator.locator.pw) || locator.pw
-  
+
   if (isReactLocator) return findReact(matcher, locator)
   if (isVueLocator) return findVue(matcher, locator)
   if (isPwLocator) return findByPlaywrightLocator.call(this, matcher, locator)
@@ -4391,7 +4374,7 @@ async function findCustomElements(matcher, locator) {
   // Always prioritize this.customLocatorStrategies which is set in constructor from config
   // and persists in every worker thread instance
   let strategyFunction = null
-  
+
   if (this.customLocatorStrategies && this.customLocatorStrategies[locator.type]) {
     strategyFunction = this.customLocatorStrategies[locator.type]
   } else if (globalCustomLocatorStrategies.has(locator.type)) {
@@ -4967,7 +4950,7 @@ async function refreshContextSession() {
       this.debugSection('Session', 'Skipping storage cleanup - no active page/context')
       return
     }
-    
+
     const currentUrl = await this.grabCurrentUrl()
 
     if (currentUrl.startsWith('http')) {

lib/helper/REST.js

@@ -215,8 +215,8 @@ class REST extends Helper {
       }
     }
 
-    if (this.config.onRequest) {
-      await this.config.onRequest(request)
+    if (this.options.onRequest) {
+      await this.options.onRequest(request)
     }
 
     try {
@@ -245,8 +245,8 @@ class REST extends Helper {
       }
       response = err.response
     }
-    if (this.config.onResponse) {
-      await this.config.onResponse(response)
+    if (this.options.onResponse) {
+      await this.options.onResponse(response)
     }
     try {
       this.options.prettyPrintJson ? this.debugSection('Response', beautify(JSON.stringify(response.data))) : this.debugSection('Response', JSON.stringify(response.data))

test/helper/JSONResponse_test.js

@@ -27,8 +27,8 @@ let restHelper
 let I
 
 describe('JSONResponse', () => {
-  beforeEach(() => {
-    Container.create({
+  beforeEach(async () => {
+    await Container.create({
       helpers: {
         REST: {},
       },
@@ -41,42 +41,42 @@ describe('JSONResponse', () => {
 
   describe('response codes', () => {
     it('should check 200x codes', async () => {
-      restHelper.config.onResponse({ status: 204 })
+      restHelper.options.onResponse({ status: 204 })
       I.seeResponseCodeIs(204)
       I.dontSeeResponseCodeIs(200)
       I.seeResponseCodeIsSuccessful()
     })
 
     it('should check 300x codes', async () => {
-      restHelper.config.onResponse({ status: 304 })
+      restHelper.options.onResponse({ status: 304 })
       I.seeResponseCodeIs(304)
       I.dontSeeResponseCodeIs(200)
       I.seeResponseCodeIsRedirection()
     })
 
     it('should check 400x codes', async () => {
-      restHelper.config.onResponse({ status: 404 })
+      restHelper.options.onResponse({ status: 404 })
       I.seeResponseCodeIs(404)
       I.dontSeeResponseCodeIs(200)
       I.seeResponseCodeIsClientError()
     })
 
     it('should check 500x codes', async () => {
-      restHelper.config.onResponse({ status: 504 })
+      restHelper.options.onResponse({ status: 504 })
       I.seeResponseCodeIs(504)
       I.dontSeeResponseCodeIs(200)
       I.seeResponseCodeIsServerError()
     })
 
     it('should throw error on invalid code', () => {
-      restHelper.config.onResponse({ status: 504 })
+      restHelper.options.onResponse({ status: 504 })
       expect(() => I.seeResponseCodeIs(200)).to.throw('Response code')
     })
   })
 
   describe('response data', () => {
     it('should check for json inclusion', () => {
-      restHelper.config.onResponse({ data })
+      restHelper.options.onResponse({ data })
       I.seeResponseContainsJson({
         posts: [{ id: 2 }],
       })
@@ -88,7 +88,7 @@ describe('JSONResponse', () => {
 
     it('should check for json inclusion - returned Array', () => {
       const arrayData = [{ ...data }]
-      restHelper.config.onResponse({ data: arrayData })
+      restHelper.options.onResponse({ data: arrayData })
       I.seeResponseContainsJson({
         posts: [{ id: 2 }],
       })
@@ -100,48 +100,48 @@ describe('JSONResponse', () => {
 
     it('should check for json inclusion - returned Array of 2 items', () => {
       const arrayData = [{ ...data }, { posts: { id: 3 } }]
-      restHelper.config.onResponse({ data: arrayData })
+      restHelper.options.onResponse({ data: arrayData })
       I.seeResponseContainsJson({
         posts: { id: 3 },
       })
     })
 
     it('should simply check for json inclusion', () => {
-      restHelper.config.onResponse({ data: { user: { name: 'jon', email: 'jon@doe.com' } } })
+      restHelper.options.onResponse({ data: { user: { name: 'jon', email: 'jon@doe.com' } } })
       I.seeResponseContainsJson({ user: { name: 'jon' } })
       I.dontSeeResponseContainsJson({ user: { name: 'jo' } })
       I.dontSeeResponseContainsJson({ name: 'joe' })
     })
 
     it('should simply check for json inclusion - returned Array', () => {
-      restHelper.config.onResponse({ data: [{ user: { name: 'jon', email: 'jon@doe.com' } }] })
+      restHelper.options.onResponse({ data: [{ user: { name: 'jon', email: 'jon@doe.com' } }] })
       I.seeResponseContainsJson({ user: { name: 'jon' } })
       I.dontSeeResponseContainsJson({ user: { name: 'jo' } })
       I.dontSeeResponseContainsJson({ name: 'joe' })
     })
 
     it('should simply check for json equality', () => {
-      restHelper.config.onResponse({ data: { user: 1 } })
+      restHelper.options.onResponse({ data: { user: 1 } })
       I.seeResponseEquals({ user: 1 })
     })
 
     it('should simply check for json equality - returned Array', () => {
-      restHelper.config.onResponse({ data: [{ user: 1 }] })
+      restHelper.options.onResponse({ data: [{ user: 1 }] })
       I.seeResponseEquals([{ user: 1 }])
     })
 
     it('should check json contains keys', () => {
-      restHelper.config.onResponse({ data: { user: 1, post: 2 } })
+      restHelper.options.onResponse({ data: { user: 1, post: 2 } })
       I.seeResponseContainsKeys(['user', 'post'])
     })
 
     it('should check json contains keys - returned Array', () => {
-      restHelper.config.onResponse({ data: [{ user: 1, post: 2 }] })
+      restHelper.options.onResponse({ data: [{ user: 1, post: 2 }] })
       I.seeResponseContainsKeys(['user', 'post'])
     })
 
     it('should check for json by callback', () => {
-      restHelper.config.onResponse({ data })
+      restHelper.options.onResponse({ data })
       const fn = ({ assert, data }) => {
         assert('posts' in data)
         assert('user' in data)
@@ -151,13 +151,15 @@ describe('JSONResponse', () => {
     })
 
     it('should check for json by zod schema', () => {
-      restHelper.config.onResponse({ data })
+      restHelper.options.onResponse({ data })
       const schema = z.object({
-        posts: z.array(z.object({
-          id: z.number(),
-          author: z.string(),
-          title: z.string(),
-        })),
+        posts: z.array(
+          z.object({
+            id: z.number(),
+            author: z.string(),
+            title: z.string(),
+          }),
+        ),
         user: z.object({
           name: z.string(),
         }),
@@ -170,7 +172,7 @@ describe('JSONResponse', () => {
     })
 
     it('should throw error when zod validation fails', () => {
-      restHelper.config.onResponse({ data: { name: 'invalid', age: 'not_a_number' } })
+      restHelper.options.onResponse({ data: { name: 'invalid', age: 'not_a_number' } })
       const schema = z.object({
         name: z.string(),
         age: z.number(),