@wdio/cucumber-framework 8.22.0 → 8.23.1

package/build/constants.d.ts

@@ -1,4 +1,5 @@
 import type { CucumberOptions } from './types.js';
 export declare const DEFAULT_TIMEOUT = 60000;
 export declare const DEFAULT_OPTS: CucumberOptions;
+export declare const CUCUMBER_HOOK_DEFINITION_TYPES: readonly ["beforeTestRunHookDefinitionConfigs", "beforeTestCaseHookDefinitionConfigs", "afterTestCaseHookDefinitionConfigs", "afterTestRunHookDefinitionConfigs"];
 //# sourceMappingURL=constants.d.ts.map

package/build/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAEjD,eAAO,MAAM,eAAe,QAAQ,CAAA;AAEpC,eAAO,MAAM,YAAY,EAAE,eA0B1B,CAAA"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAEjD,eAAO,MAAM,eAAe,QAAQ,CAAA;AAEpC,eAAO,MAAM,YAAY,EAAE,eA0B1B,CAAA;AAED,eAAO,MAAM,8BAA8B,mKAKjC,CAAA"}

package/build/constants.js

@@ -26,3 +26,9 @@ export const DEFAULT_OPTS = {
     tagExpression: '',
     profiles: []
 };
+export const CUCUMBER_HOOK_DEFINITION_TYPES = [
+    'beforeTestRunHookDefinitionConfigs',
+    'beforeTestCaseHookDefinitionConfigs',
+    'afterTestCaseHookDefinitionConfigs',
+    'afterTestRunHookDefinitionConfigs',
+];

package/build/index.d.ts

@@ -4,7 +4,7 @@ import type { Capabilities, Options } from '@wdio/types';
 import { After, AfterAll, AfterStep, Before, BeforeAll, BeforeStep, Given, When, Then, setDefaultTimeout, setDefinitionFunctionWrapper, setWorldConstructor, defineParameterType, defineStep, DataTable, World } from '@cucumber/cucumber';
 import type { GherkinDocument } from '@cucumber/messages';
 import type Cucumber from '@cucumber/cucumber';
-import type { CucumberOptions, HookFunctionExtension as HookFunctionExtensionImport } from './types.js';
+import type { CucumberOptions, HookFunctionExtension as HookFunctionExtensionImport, StepDefinitionOptions } from './types.js';
 export declare const FILE_PROTOCOL = "file://";
 declare class CucumberAdapter {
     private _cid;
@@ -44,7 +44,24 @@ declare class CucumberAdapter {
      * set `beforeFeature`, `afterFeature`, `beforeScenario`, `afterScenario`, 'beforeStep', 'afterStep'
      * @param {object} config config
      */
-    addWdioHooksAndWrapSteps(config: Options.Testrunner, supportCodeLibraryBuilder: typeof Cucumber.supportCodeLibraryBuilder): void;
+    addWdioHooks(config: Options.Testrunner, supportCodeLibraryBuilder: typeof Cucumber.supportCodeLibraryBuilder): void;
+    /**
+     * wraps step definition code with sync/async runner with a retry option
+     * @param {object} config
+     */
+    wrapSteps(config: Options.Testrunner): void;
+    /**
+     * wrap step definition to enable retry ability
+     * @param   {Function}  code            step definition
+     * @param   {boolean}   isStep
+     * @param   {object}    config
+     * @param   {string}    cid             cid
+     * @param   {StepDefinitionOptions} options
+     * @param   {Function}  getHookParams  step definition
+     * @param   {number}    timeout        the maximum time (in milliseconds) to wait for
+     * @return  {Function}                 wrapped step definition for sync WebdriverIO code
+     */
+    wrapStep(code: Function, isStep: boolean, config: Options.Testrunner, cid: string, options: StepDefinitionOptions, getHookParams: Function, timeout?: number, hookName?: string | undefined): Function;
 }
 /**
  * Publishes a Cucumber report to a specified URL using NDJSON files from a directory.

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAKA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAS1C,OAAO,KAAK,EAAE,YAAY,EAAE,OAAO,EAAc,MAAM,aAAa,CAAA;AAEpE,OAAO,EACH,KAAK,EACL,QAAQ,EACR,SAAS,EAET,MAAM,EACN,SAAS,EACT,UAAU,EAEV,KAAK,EACL,IAAI,EACJ,IAAI,EAEJ,iBAAiB,EACjB,4BAA4B,EAE5B,mBAAmB,EACnB,mBAAmB,EACnB,UAAU,EAEV,SAAS,EACT,KAAK,EAER,MAAM,oBAAoB,CAAA;AAG3B,OAAO,KAAK,EAAW,eAAe,EAAE,MAAM,oBAAoB,CAAA;AAClE,OAAO,KAAK,QAAQ,MAAM,oBAAoB,CAAA;AAM9C,OAAO,KAAK,EACR,eAAe,EACf,qBAAqB,IAAI,2BAA2B,EAEvD,MAAM,YAAY,CAAA;AAEnB,eAAO,MAAM,aAAa,YAAY,CAAA;AAkBtC,cAAM,eAAe;IAUb,OAAO,CAAC,IAAI;IACZ,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,iBAAiB;IACzB,OAAO,CAAC,kBAAkB;IAhB9B,OAAO,CAAC,IAAI,CAAgB;IAC5B,OAAO,CAAC,MAAM,CAA6B;IAC3C,OAAO,CAAC,aAAa,CAA2B;IAEhD,OAAO,CAAC,SAAS,CAAO;IAExB,OAAO,CAAC,aAAa,CAAqC;gBAG9C,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,OAAO,CAAC,UAAU,EAC3B,MAAM,EAAE,MAAM,EAAE,EAChB,aAAa,EAAE,YAAY,CAAC,gBAAgB,EAC5C,SAAS,EAAE,YAAY,EACvB,aAAa,EAAE,YAAY,EAC3B,iBAAiB,GAAE,OAAc,EACjC,kBAAkB,GAAE,MAA+G;IAkE/I,SAAS,CACL,SAAS,GAAE,OAAO,CAAC,UAAU,CAAC,OAAO,CAAM,GAC5C,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,EAAE;IAUxB,mBAAmB,CACf,KAAK,GAAE,OAAO,CAAC,UAAU,CAAC,OAAO,CAAM,GACxC,CAAC,eAAe,GAAG,eAAe,EAAE,CAAC,EAAE;IAkB1C,uBAAuB;IAWjB,IAAI;IA6BV,QAAQ;IAIF,GAAG;IAmFT;;;;;;;;OAQG;IACH,uBAAuB;IAgBjB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE;IAQpC,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE;IA0BtC,SAAS;IAWf;;;OAGG;IACH,wBAAwB,CACpB,MAAM,EAAE,OAAO,CAAC,UAAU,EAC1B,yBAAyB,EAAE,OAAO,QAAQ,CAAC,yBAAyB;CA8E3E;AACD;;;;;;GAMG;AACH,QAAA,MAAM,qBAAqB,uBAA8B,MAAM,KAAG,QAAQ,IAAI,CAmC7E,CAAA;AAGD,QAAA,MAAM,cAAc,EAAE;IAAE,IAAI,CAAC,EAAE,QAAQ,CAAA;CAAO,CAAA;AAa9C,eAAe,cAAc,CAAA;AAC7B,OAAO,EACH,eAAe,EACf,cAAc,EAEd,KAAK,EACL,QAAQ,EACR,SAAS,EAET,MAAM,EACN,SAAS,EACT,UAAU,EAEV,KAAK,EACL,IAAI,EACJ,IAAI,EAEJ,SAAS,EAET,KAAK,EAEL,iBAAiB,EACjB,4BAA4B,EAC5B,mBAAmB,EACnB,mBAAmB,EACnB,UAAU,EAEV,qBAAqB,EACxB,CAAA;AAED,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,WAAW,CAAC;QAClB,UAAU,YAAa,SAAQ,eAAe;SAAG;QACjD,UAAU,qBAAsB,SAAQ,2BAA2B;SAAG;KACzE;CACJ"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAKA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAS1C,OAAO,KAAK,EAAE,YAAY,EAAE,OAAO,EAAc,MAAM,aAAa,CAAA;AAEpE,OAAO,EACH,KAAK,EACL,QAAQ,EACR,SAAS,EAET,MAAM,EACN,SAAS,EACT,UAAU,EAEV,KAAK,EACL,IAAI,EACJ,IAAI,EAEJ,iBAAiB,EACjB,4BAA4B,EAE5B,mBAAmB,EACnB,mBAAmB,EACnB,UAAU,EAEV,SAAS,EACT,KAAK,EAER,MAAM,oBAAoB,CAAA;AAG3B,OAAO,KAAK,EAAW,eAAe,EAAE,MAAM,oBAAoB,CAAA;AAClE,OAAO,KAAK,QAAQ,MAAM,oBAAoB,CAAA;AAM9C,OAAO,KAAK,EACR,eAAe,EACf,qBAAqB,IAAI,2BAA2B,EACpD,qBAAqB,EACxB,MAAM,YAAY,CAAA;AAEnB,eAAO,MAAM,aAAa,YAAY,CAAA;AAkBtC,cAAM,eAAe;IAUb,OAAO,CAAC,IAAI;IACZ,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,iBAAiB;IACzB,OAAO,CAAC,kBAAkB;IAhB9B,OAAO,CAAC,IAAI,CAAgB;IAC5B,OAAO,CAAC,MAAM,CAA6B;IAC3C,OAAO,CAAC,aAAa,CAA2B;IAEhD,OAAO,CAAC,SAAS,CAAO;IAExB,OAAO,CAAC,aAAa,CAAqC;gBAG9C,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,OAAO,CAAC,UAAU,EAC3B,MAAM,EAAE,MAAM,EAAE,EAChB,aAAa,EAAE,YAAY,CAAC,gBAAgB,EAC5C,SAAS,EAAE,YAAY,EACvB,aAAa,EAAE,YAAY,EAC3B,iBAAiB,GAAE,OAAc,EACjC,kBAAkB,GAAE,MAA+G;IAkE/I,SAAS,CACL,SAAS,GAAE,OAAO,CAAC,UAAU,CAAC,OAAO,CAAM,GAC5C,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,EAAE;IAUxB,mBAAmB,CACf,KAAK,GAAE,OAAO,CAAC,UAAU,CAAC,OAAO,CAAM,GACxC,CAAC,eAAe,GAAG,eAAe,EAAE,CAAC,EAAE;IAkB1C,uBAAuB;IAWjB,IAAI;IA6BV,QAAQ;IAIF,GAAG;IAmFT;;;;;;;;OAQG;IACH,uBAAuB;IAgBjB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE;IAQpC,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE;IA0BtC,SAAS;IAWf;;;OAGG;IACH,YAAY,CACR,MAAM,EAAE,OAAO,CAAC,UAAU,EAC1B,yBAAyB,EAAE,OAAO,QAAQ,CAAC,yBAAyB;IAwDxE;;;OAGG;IACH,SAAS,CAAE,MAAM,EAAE,OAAO,CAAC,UAAU;IAgCrC;;;;;;;;;;OAUG;IACH,QAAQ,CACJ,IAAI,EAAE,QAAQ,EACd,MAAM,EAAE,OAAO,EACf,MAAM,EAAE,OAAO,CAAC,UAAU,EAC1B,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,qBAAqB,EAC9B,aAAa,EAAE,QAAQ,EACvB,OAAO,CAAC,EAAE,MAAM,EAChB,QAAQ,GAAE,MAAM,GAAG,SAAqB,GACzC,QAAQ;CAmBd;AACD;;;;;;GAMG;AACH,QAAA,MAAM,qBAAqB,uBAA8B,MAAM,KAAG,QAAQ,IAAI,CAmC7E,CAAA;AAGD,QAAA,MAAM,cAAc,EAAE;IAAE,IAAI,CAAC,EAAE,QAAQ,CAAA;CAAO,CAAA;AAa9C,eAAe,cAAc,CAAA;AAC7B,OAAO,EACH,eAAe,EACf,cAAc,EAEd,KAAK,EACL,QAAQ,EACR,SAAS,EAET,MAAM,EACN,SAAS,EACT,UAAU,EAEV,KAAK,EACL,IAAI,EACJ,IAAI,EAEJ,SAAS,EAET,KAAK,EAEL,iBAAiB,EACjB,4BAA4B,EAC5B,mBAAmB,EACnB,mBAAmB,EACnB,UAAU,EAEV,qBAAqB,EACxB,CAAA;AAED,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,WAAW,CAAC;QAClB,UAAU,YAAa,SAAQ,eAAe;SAAG;QACjD,UAAU,qBAAsB,SAAQ,2BAA2B;SAAG;KACzE;CACJ"}

package/build/index.js

@@ -9,13 +9,13 @@ import got from 'got';
 import isGlob from 'is-glob';
 import { sync as globSync } from 'glob';
 import logger from '@wdio/logger';
-import { executeHooksWithArgs } from '@wdio/utils';
+import { executeHooksWithArgs, testFnWrapper } from '@wdio/utils';
 import { After, AfterAll, AfterStep, Before, BeforeAll, BeforeStep, Given, When, Then, setDefaultTimeout, setDefinitionFunctionWrapper, supportCodeLibraryBuilder, setWorldConstructor, defineParameterType, defineStep, DataTable, World, Status } from '@cucumber/cucumber';
 import Gherkin from '@cucumber/gherkin';
 import { IdGenerator } from '@cucumber/messages';
 import { loadConfiguration, loadSources, runCucumber } from '@cucumber/cucumber/api';
 import { DEFAULT_OPTS } from './constants.js';
-import { generateSkipTagsFromCapabilities } from './utils.js';
+import { generateSkipTagsFromCapabilities, setUserHookNames } from './utils.js';
 export const FILE_PROTOCOL = 'file://';
 const uuidFn = IdGenerator.uuid();
 const log = logger('@wdio/cucumber-framework');
@@ -165,9 +165,11 @@ class CucumberAdapter {
                 requirePaths: this._cucumberOpts.require,
                 importPaths: this._cucumberOpts.import,
             });
-            this.addWdioHooksAndWrapSteps(this._config, supportCodeLibraryBuilder);
-            setDefaultTimeout(this._cucumberOpts.timeout);
+            this.addWdioHooks(this._config, supportCodeLibraryBuilder);
             await this.loadFiles();
+            this.wrapSteps(this._config);
+            setUserHookNames(supportCodeLibraryBuilder);
+            setDefaultTimeout(this._cucumberOpts.timeout);
             const supportCodeLibrary = supportCodeLibraryBuilder.finalize();
             outStream = new Writable({
                 write(chunk, encoding, callback) {
@@ -270,29 +272,29 @@ class CucumberAdapter {
      * set `beforeFeature`, `afterFeature`, `beforeScenario`, `afterScenario`, 'beforeStep', 'afterStep'
      * @param {object} config config
      */
-    addWdioHooksAndWrapSteps(config, supportCodeLibraryBuilder) {
+    addWdioHooks(config, supportCodeLibraryBuilder) {
         const params = {};
         this._eventEmitter.on('getHookParams', (payload) => {
             params.uri = payload.uri;
             params.feature = payload.feature;
         });
-        supportCodeLibraryBuilder.methods.BeforeAll(async function () {
+        supportCodeLibraryBuilder.methods.BeforeAll(async function wdioHookBeforeFeature() {
             await executeHooksWithArgs('beforeFeature', config.beforeFeature, [
                 params.uri,
                 params.feature,
             ]);
         });
-        supportCodeLibraryBuilder.methods.Before(async function (world) {
+        supportCodeLibraryBuilder.methods.Before(async function wdioHookBeforeScenario(world) {
             await executeHooksWithArgs('beforeScenario', config.beforeScenario, [world, this]);
         });
-        supportCodeLibraryBuilder.methods.BeforeStep(async function (world) {
+        supportCodeLibraryBuilder.methods.BeforeStep(async function wdioHookBeforeStep(world) {
             await executeHooksWithArgs('beforeStep', config.beforeStep, [
                 world.pickleStep,
                 world.pickle,
                 this,
             ]);
         });
-        supportCodeLibraryBuilder.methods.AfterStep(async function (world) {
+        supportCodeLibraryBuilder.methods.AfterStep(async function wdioHookAfterStep(world) {
             await executeHooksWithArgs('afterStep', config.afterStep, [
                 world.pickleStep,
                 world.pickle,
@@ -300,41 +302,71 @@ class CucumberAdapter {
                 this,
             ]);
         });
-        supportCodeLibraryBuilder.methods.After(async function (world) {
+        supportCodeLibraryBuilder.methods.After(async function wdioHookAfterScenario(world) {
             await executeHooksWithArgs('afterScenario', config.afterScenario, [
                 world,
                 getResultObject(world),
                 this,
             ]);
         });
-        supportCodeLibraryBuilder.methods.AfterAll(async function () {
+        supportCodeLibraryBuilder.methods.AfterAll(async function wdioHookAfterFeature() {
             await executeHooksWithArgs('afterFeature', config.afterFeature, [
                 params.uri,
                 params.feature,
             ]);
         });
-        supportCodeLibraryBuilder.methods.setDefinitionFunctionWrapper(function (fn, options = { retry: 0 }) {
-            const retries = { attempts: 0, limit: isFinite(options?.retry) ? options.retry : 0 };
-            if (retries.limit !== 0) {
-                return async function (...args) {
-                    while (retries.limit >= retries.attempts) {
-                        this.wdioRetries = retries.attempts;
-                        try {
-                            await fn.apply(this, args);
-                            break;
-                        }
-                        catch (error) {
-                            if (retries.limit === retries.attempts) {
-                                throw error;
-                            }
-                            retries.attempts++;
-                        }
-                    }
-                };
+    }
+    /**
+     * wraps step definition code with sync/async runner with a retry option
+     * @param {object} config
+     */
+    wrapSteps(config) {
+        const wrapStep = this.wrapStep;
+        const cid = this._cid;
+        let params;
+        this._eventEmitter.on('getHookParams', (payload) => {
+            params = payload;
+        });
+        const getHookParams = () => params;
+        setDefinitionFunctionWrapper((fn, options = { retry: 0 }) => {
+            /**
+             * hooks defined in wdio.conf are already wrapped
+             */
+            if (fn.name.startsWith('wdioHook')) {
+                return fn;
             }
-            return fn;
+            /**
+             * this flag is used to:
+             * - avoid hook retry
+             * - avoid wrap hooks with beforeStep and afterStep
+             */
+            const isStep = !fn.name.startsWith('userHook');
+            return wrapStep(fn, isStep, config, cid, options, getHookParams, this._cucumberOpts.timeout);
         });
     }
+    /**
+     * wrap step definition to enable retry ability
+     * @param   {Function}  code            step definition
+     * @param   {boolean}   isStep
+     * @param   {object}    config
+     * @param   {string}    cid             cid
+     * @param   {StepDefinitionOptions} options
+     * @param   {Function}  getHookParams  step definition
+     * @param   {number}    timeout        the maximum time (in milliseconds) to wait for
+     * @return  {Function}                 wrapped step definition for sync WebdriverIO code
+     */
+    wrapStep(code, isStep, config, cid, options, getHookParams, timeout, hookName = undefined) {
+        return function (...args) {
+            const hookParams = getHookParams();
+            const retryTest = isStep && isFinite(options.retry) ? options.retry : 0;
+            /**
+             * wrap user step/hook with wdio before/after hooks
+             */
+            const beforeFn = config.beforeHook;
+            const afterFn = config.afterHook;
+            return testFnWrapper.call(this, isStep ? 'Step' : 'Hook', { specFn: code, specFnArgs: args }, { beforeFn: beforeFn, beforeFnArgs: (context) => [hookParams?.step, context] }, { afterFn: afterFn, afterFnArgs: (context) => [hookParams?.step, context] }, cid, retryTest, hookName, timeout);
+        };
+    }
 }
 /**
  * Publishes a Cucumber report to a specified URL using NDJSON files from a directory.

package/build/types.d.ts

@@ -219,4 +219,10 @@ export interface HookFunctionExtension {
 export interface StepDefinitionOptions {
     retry: number;
 }
+export interface TestHookDefinitionConfig {
+    code: Function;
+    line: number;
+    options: any;
+    uri: string;
+}
 //# sourceMappingURL=types.d.ts.map

package/build/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAA;AAChE,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAE/E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAE7C,MAAM,WAAW,eAAe;IAC5B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAC3C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,eAAe,CAAC,EAAE,GAAG,CAAC;IACtB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC;;;;;;OAMG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,UAAU;IACvB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,UAAU,GAAG,QAAQ,CAAA;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,MAAM;IAC5C,IAAI,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,qBAAqB;IAClC;;;;;OAKG;IACH,aAAa,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpD;;;;;OAKG;IACH,cAAc,CAAC,CAAC,KAAK,EAAE,sBAAsB,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtE;;;;;;OAMG;IACH,UAAU,CAAC,CAAC,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvE;;;;;;;;;;OAUG;IACH,SAAS,CAAC,CAAC,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,YAAY,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvG;;;;;;;;;OASG;IACH,aAAa,CAAC,CAAC,KAAK,EAAE,sBAAsB,EAAE,MAAM,EAAE,UAAU,CAAC,YAAY,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtG;;;;;OAKG;IACH,YAAY,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;CACtD;AAED,MAAM,WAAW,qBAAqB;IAClC,KAAK,EAAE,MAAM,CAAC;CACjB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAA;AAChE,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAE/E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAE7C,MAAM,WAAW,eAAe;IAC5B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAC3C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,eAAe,CAAC,EAAE,GAAG,CAAC;IACtB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC;;;;;;OAMG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,UAAU;IACvB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,UAAU,GAAG,QAAQ,CAAA;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,MAAM;IAC5C,IAAI,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,qBAAqB;IAClC;;;;;OAKG;IACH,aAAa,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpD;;;;;OAKG;IACH,cAAc,CAAC,CAAC,KAAK,EAAE,sBAAsB,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtE;;;;;;OAMG;IACH,UAAU,CAAC,CAAC,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvE;;;;;;;;;;OAUG;IACH,SAAS,CAAC,CAAC,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,YAAY,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvG;;;;;;;;;OASG;IACH,aAAa,CAAC,CAAC,KAAK,EAAE,sBAAsB,EAAE,MAAM,EAAE,UAAU,CAAC,YAAY,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtG;;;;;OAKG;IACH,YAAY,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;CACtD;AAED,MAAM,WAAW,qBAAqB;IAClC,KAAK,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,wBAAwB;IACrC,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,GAAG,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACf"}

package/build/utils.d.ts

@@ -1,3 +1,4 @@
+import type { supportCodeLibraryBuilder } from '@cucumber/cucumber';
 import type { PickleStep, TestStep, Feature, Pickle, TestStepResultStatus } from '@cucumber/messages';
 import type { Capabilities } from '@wdio/types';
 import type { ReporterStep } from './types.js';
@@ -85,5 +86,11 @@ export declare function generateSkipTagsFromCapabilities(capabilities: Capabilit
  * Retrives scenario description if available.
  */
 export declare function getScenarioDescription(feature: Feature, scenarioId: string): string;
+/**
+ * wrap every user defined hook with function named `userHookFn`
+ * to identify later on is function a step, user hook or wdio hook.
+ * @param {object} options `Cucumber.supportCodeLibraryBuilder.options`
+ */
+export declare function setUserHookNames(options: typeof supportCodeLibraryBuilder): void;
 export {};
 //# sourceMappingURL=utils.d.ts.map

package/build/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAGR,UAAU,EACV,QAAQ,EACR,OAAO,EACP,MAAM,EACN,oBAAoB,EACvB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAI9C;;GAEG;AACH,wBAAgB,kBAAkB,CAAE,EAAE,QAAQ,EAAE,EAAE,UAAU;;;;cAoB3D;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAE,EAAE,OAAY,EAAE,EAAE,GAAG,OAgBnD;AAED,aAAK,QAAQ;IACT,IAAI,SAAS;IACb,IAAI,SAAS;CAChB;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAE,IAAI,EAAE,QAAQ,YAE1C;AAED,wBAAgB,YAAY,CAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,UAE1D;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAE,OAAO,oBAAY,EAAE,IAAI,oBAAY,EAAE,IAAI,EAAC,MAAM,UAGnF;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC5B,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,OAAO,EAChB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,YAAY,EAClB,MAAM,EAAE;IACJ,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,oBAAoB,GAAG,MAAM,GAAG,IAAI,CAAA;IAC5C,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;CAChB;;;;;;;;;;;;;UAPS,MAAM;;;;;EAqBnB;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,sBAS3D;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,YAAY,EAAE,EAAE,OAAO,EAAE,OAAO,kBA4BvE;AAED;;;;;;GAMG;AACH,wBAAgB,gCAAgC,CAAC,YAAY,EAAE,YAAY,CAAC,gBAAgB,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,GAAG,MAAM,EAAE,CA6CxH;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,UAG1E"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,yBAAyB,EAAS,MAAM,oBAAoB,CAAA;AAE1E,OAAO,KAAK,EAGR,UAAU,EACV,QAAQ,EACR,OAAO,EACP,MAAM,EACN,oBAAoB,EACvB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,KAAK,EAAE,YAAY,EAA4B,MAAM,YAAY,CAAA;AAIxE;;GAEG;AACH,wBAAgB,kBAAkB,CAAE,EAAE,QAAQ,EAAE,EAAE,UAAU;;;;cAoB3D;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAE,EAAE,OAAY,EAAE,EAAE,GAAG,OAgBnD;AAED,aAAK,QAAQ;IACT,IAAI,SAAS;IACb,IAAI,SAAS;CAChB;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAE,IAAI,EAAE,QAAQ,YAE1C;AAED,wBAAgB,YAAY,CAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,UAE1D;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAE,OAAO,oBAAY,EAAE,IAAI,oBAAY,EAAE,IAAI,EAAC,MAAM,UAGnF;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC5B,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,OAAO,EAChB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,YAAY,EAClB,MAAM,EAAE;IACJ,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,oBAAoB,GAAG,MAAM,GAAG,IAAI,CAAA;IAC5C,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;CAChB;;;;;;;;;;;;;UAPS,MAAM;;;;;EAqBnB;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,sBAS3D;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,YAAY,EAAE,EAAE,OAAO,EAAE,OAAO,kBA4BvE;AAED;;;;;;GAMG;AACH,wBAAgB,gCAAgC,CAAC,YAAY,EAAE,YAAY,CAAC,gBAAgB,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,GAAG,MAAM,EAAE,CA6CxH;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,UAG1E;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAE,OAAO,EAAE,OAAO,yBAAyB,QAe1E"}

package/build/utils.js

@@ -1,5 +1,7 @@
 import path from 'node:path';
 import logger from '@wdio/logger';
+import { isFunctionAsync } from '@wdio/utils';
+import { CUCUMBER_HOOK_DEFINITION_TYPES } from './constants.js';
 const log = logger('@wdio/cucumber-framework:utils');
 /**
  * NOTE: this function is exported for testing only
@@ -178,3 +180,24 @@ export function getScenarioDescription(feature, scenarioId) {
     const children = feature.children?.find((child) => child?.scenario?.id === scenarioId);
     return children?.scenario?.description || '';
 }
+/**
+ * wrap every user defined hook with function named `userHookFn`
+ * to identify later on is function a step, user hook or wdio hook.
+ * @param {object} options `Cucumber.supportCodeLibraryBuilder.options`
+ */
+export function setUserHookNames(options) {
+    CUCUMBER_HOOK_DEFINITION_TYPES.forEach(hookName => {
+        options[hookName].forEach((testRunHookDefinition) => {
+            const hookFn = testRunHookDefinition.code;
+            if (!hookFn.name.startsWith('wdioHook')) {
+                const userHookAsyncFn = async function (...args) {
+                    return hookFn.apply(this, args);
+                };
+                const userHookFn = function (...args) {
+                    return hookFn.apply(this, args);
+                };
+                testRunHookDefinition.code = (isFunctionAsync(hookFn)) ? userHookAsyncFn : userHookFn;
+            }
+        });
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/cucumber-framework",
-  "version": "8.22.0",
+  "version": "8.23.1",
   "description": "A WebdriverIO plugin. Adapter for Cucumber.js testing framework.",
   "author": "Christian Bromann <mail@bromann.dev>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-cucumber-framework",
@@ -43,8 +43,8 @@
     "@cucumber/messages": "23.0.0",
     "@types/node": "^20.1.0",
     "@wdio/logger": "8.16.17",
-    "@wdio/types": "8.21.0",
-    "@wdio/utils": "8.22.0",
+    "@wdio/types": "8.23.1",
+    "@wdio/utils": "8.23.1",
     "glob": "^10.2.2",
     "got": "^13.0.0",
     "is-glob": "^4.0.0"
@@ -55,5 +55,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "81496a30b1c50e7d4129be6997f1a557f9659224"
+  "gitHead": "64633b802ba4d00d23f6531dadc3fc724d8d7dd5"
 }