Invoke scenario hooks with correct options

CHANGELOG.md

@@ -12,6 +12,10 @@ Breaking changes:
 
   - String literal attachments are now base64-encoded in JSON reports, ref. [cucumber/cucumber-js#2261](https://github.com/cucumber/cucumber-js/pull/2261).
 
+Other changes:
+
+- Scenario hooks (`Before(..)` and `After(..)`) are now invoked with an object containing a bunch of relevant data. This is in line with how cucumber-js behaves.
+
 ## v18.0.6
 
 - Make the compile output play nicer with ESM, relates to [#1093](https://github.com/badeball/cypress-cucumber-preprocessor/issues/1093).

docs/cucumber-basics.md

@@ -148,6 +148,10 @@ Before({ tags: "@foo and @bar" }, function () {
 Before({ tags: "@foo or @bar" }, function () {
   // This hook will be executed before scenarios tagged with @foo or @bar.
 });
+
+Before(function ({ pickle, gherkinDocument, testCaseStartedId }) {
+  // Scenario hooks are invoked with an object containing a bunch of relevant data.
+});
 ```
 
 # Step hooks

features/hooks_argument.feature

@@ -0,0 +1,87 @@
+Feature: hooks argument
+
+  Rule: some hooks should be invoked with various arguments
+
+    Scenario: Before hook
+      Given a file named "cypress/e2e/a.feature" with:
+        """
+        Feature: a feature name
+          Scenario: a scenario name
+            Given a step
+        """
+      And a file named "cypress/support/step_definitions/steps.js" with:
+        """
+        const { When, Before } = require("@badeball/cypress-cucumber-preprocessor");
+        When("a step", function() {});
+        Before(function ({ gherkinDocument, pickle, testCaseStartedId }) {
+          expect(gherkinDocument.feature.name).to.equal("a feature name");
+          expect(pickle.name).to.equal("a scenario name");
+          expect(testCaseStartedId).to.be.a("string");
+        });
+        """
+    When I run cypress
+    Then it passes
+
+    Scenario: After hook
+      Given a file named "cypress/e2e/a.feature" with:
+        """
+        Feature: a feature name
+          Scenario: a scenario name
+            Given a step
+        """
+      And a file named "cypress/support/step_definitions/steps.js" with:
+        """
+        const { When, Before } = require("@badeball/cypress-cucumber-preprocessor");
+        When("a step", function() {});
+        Before(function ({ gherkinDocument, pickle, testCaseStartedId, result, willBeRetried }) {
+          expect(gherkinDocument.feature.name).to.equal("a feature name");
+          expect(pickle.name).to.equal("a scenario name");
+          expect(testCaseStartedId).to.be.a("string");
+        });
+        """
+    When I run cypress
+    Then it passes
+
+    Scenario: BeforeStep hook
+      Given a file named "cypress/e2e/a.feature" with:
+        """
+        Feature: a feature name
+          Scenario: a scenario name
+            Given a step
+        """
+      And a file named "cypress/support/step_definitions/steps.js" with:
+        """
+        const { When, BeforeStep } = require("@badeball/cypress-cucumber-preprocessor");
+        When("a step", function() {});
+        BeforeStep(function ({ pickle, pickleStep, gherkinDocument, testCaseStartedId, testStepId }) {
+          expect(pickle.name).to.equal("a scenario name");
+          expect(pickleStep.text).to.equal("a step");
+          expect(gherkinDocument.feature.name).to.equal("a feature name");
+          expect(testCaseStartedId).to.be.a("string");
+          expect(testStepId).to.be.a("string");
+        });
+        """
+    When I run cypress
+    Then it passes
+
+    Scenario: AfterStep hook
+      Given a file named "cypress/e2e/a.feature" with:
+        """
+        Feature: a feature name
+          Scenario: a scenario name
+            Given a step
+        """
+      And a file named "cypress/support/step_definitions/steps.js" with:
+        """
+        const { When, AfterStep } = require("@badeball/cypress-cucumber-preprocessor");
+        When("a step", function() {});
+        AfterStep(function ({ pickle, pickleStep, gherkinDocument, testCaseStartedId, testStepId }) {
+          expect(pickle.name).to.equal("a scenario name");
+          expect(pickleStep.text).to.equal("a step");
+          expect(gherkinDocument.feature.name).to.equal("a feature name");
+          expect(testCaseStartedId).to.be.a("string");
+          expect(testStepId).to.be.a("string");
+        });
+        """
+    When I run cypress
+    Then it passes

lib/browser-runtime.ts

@@ -63,7 +63,7 @@ import { runStepWithLogGroup } from "./helpers/cypress";
 
 import { getTags } from "./helpers/environment";
 
-import { IStepHookParameter } from "./public-member-types";
+import { IHookParameter, IStepHookParameter } from "./public-member-types";
 
 type Node = ReturnType<typeof parse>;
 
@@ -449,8 +449,14 @@ function createPickle(context: CompositionContext, pickle: messages.Pickle) {
           return cy.wrap(start, { log: false });
         })
           .then((start) => {
+            const options: IHookParameter = {
+              pickle,
+              gherkinDocument,
+              testCaseStartedId,
+            };
+
             runStepWithLogGroup({
-              fn: () => registry.runHook(this, hook),
+              fn: () => registry.runHook(this, hook, options),
               keyword: hook.keyword,
               text: hook.tags,
             });

lib/public-member-types.ts

@@ -7,7 +7,13 @@ export interface IParameterTypeDefinition<T, C extends Mocha.Context> {
 }
 
 export interface IHookBody {
-  (this: Mocha.Context): void;
+  (this: Mocha.Context, options: IHookParameter): void;
+}
+
+export interface IHookParameter {
+  pickle: messages.Pickle;
+  gherkinDocument: messages.GherkinDocument;
+  testCaseStartedId: string;
 }
 
 export interface IStepHookParameter {

lib/registry.ts

@@ -22,6 +22,7 @@ import {
   IStepHookParameter,
   IParameterTypeDefinition,
   IStepDefinitionBody,
+  IHookParameter,
 } from "./public-member-types";
 
 import {
@@ -275,8 +276,8 @@ export class Registry {
     return this.resolveHooks("After", tags).reverse();
   }
 
-  public runHook(world: Mocha.Context, hook: IHook) {
-    return hook.implementation.call(world);
+  public runHook(world: Mocha.Context, hook: IHook, options: IHookParameter) {
+    return hook.implementation.call(world, options);
   }
 
   public resolveStepHooks(keyword: StepHookKeyword, tags: string[]) {