Allow doesFeatureMatch to be called in support files

This feature broke during 084897f of #908 [1].

This patch fixes #1025 [2].

[1] #908
[2] #1025

Author: badeball

CHANGELOG.md

@@ -8,6 +8,8 @@ All notable changes to this project will be documented in this file.
 
 - Fix error in non-feature specs under certain conditions, fixes [#1028](https://github.com/badeball/cypress-cucumber-preprocessor/issues/1028).
 
+- Allow doesFeatureMatch to be called in support files, fixes [#1025](https://github.com/badeball/cypress-cucumber-preprocessor/issues/1025).
+
 ## v17.2.0
 
 - Add BeforeStep and AfterStep hooks, fixes [#847](https://github.com/badeball/cypress-cucumber-preprocessor/issues/847).

features/issues/908.feature

@@ -6,14 +6,17 @@ Feature: hide internals from cypress environment
       """
       Feature: a feature
         Scenario: hide internal state by default
-          Then the visible internal state should be a mere reference
+          Then the visible internal state should be stringified to a replacement text
       """
     And a file named "cypress/support/step_definitions/steps.js" with:
       """
       const { Then } = require("@badeball/cypress-cucumber-preprocessor");
-      Then("the visible internal state should be a mere reference", () => {
-        const properties = Cypress.env("__cypress_cucumber_preprocessor_dont_use_this_spec");
-        expect(properties).to.be.a("number");
+      Then("the visible internal state should be stringified to a replacement text", () => {
+        const {
+          __cypress_cucumber_preprocessor_dont_use_this_spec: internalProperties
+        } = JSON.parse(JSON.stringify(Cypress.env()));
+
+        expect(internalProperties).to.equal("Internal properties of cypress-cucumber-preprocessor omitted from report.");
       });
       """
     When I run cypress

features/mixing_types.feature

@@ -1,4 +1,4 @@
-Feature: mixing feature and non-feature specs
+Feature: mixing feature and non-feature specs: API
   Background:
     Given additional Cypress configuration
       """
@@ -9,7 +9,7 @@ Feature: mixing feature and non-feature specs
       }
       """
 
-  Scenario: one feature and non-feature specs
+  Scenario: feature
     Given a file named "cypress/e2e/a.feature" with:
       """
       @foo
@@ -25,13 +25,33 @@ Feature: mixing feature and non-feature specs
         expect(doesFeatureMatch("@foo")).to.be.true;
       });
       """
-    And a file named "cypress/e2e/b.spec.js" with:
+    And a file named "cypress/support/e2e.js" with:
       """
-      const { isFeature } = require("@badeball/cypress-cucumber-preprocessor");
+      const { isFeature, doesFeatureMatch } = require("@badeball/cypress-cucumber-preprocessor");
+      beforeEach(() => {
+        expect(isFeature()).to.be.true;
+        expect(doesFeatureMatch("@foo")).to.be.true;
+      });
+      """
+    When I run cypress
+    Then it passes
+
+  Scenario: non-feature
+    Given a file named "cypress/e2e/a.spec.js" with:
+      """
+      const { isFeature, doesFeatureMatch } = require("@badeball/cypress-cucumber-preprocessor");
       it("should work", () => {
         expect(isFeature()).to.be.false;
+        expect(doesFeatureMatch).to.throw("Expected to find internal properties, but didn't. This is likely because you're calling doesFeatureMatch() in a non-feature spec. Use doesFeatureMatch() in combination with isFeature() if you have both feature and non-feature specs");
+      });
+      """
+    And a file named "cypress/support/e2e.js" with:
+      """
+      const { isFeature, doesFeatureMatch } = require("@badeball/cypress-cucumber-preprocessor");
+      beforeEach(() => {
+        expect(isFeature()).to.be.false;
+        expect(doesFeatureMatch).to.throw("Expected to find internal properties, but didn't. This is likely because you're calling doesFeatureMatch() in a non-feature spec. Use doesFeatureMatch() in combination with isFeature() if you have both feature and non-feature specs");
       });
       """
     When I run cypress
     Then it passes
-    And it should appear to have ran spec "a.feature" and "b.spec.js"

lib/browser-runtime.ts

@@ -94,37 +94,25 @@ interface IStep {
   pickleStep?: messages.PickleStep;
 }
 
+const internalPropertiesReplacementText =
+  "Internal properties of cypress-cucumber-preprocessor omitted from report.";
+
 export interface InternalSpecProperties {
   pickle: messages.Pickle;
   testCaseStartedId: string;
   currentStepStartedAt?: StrictTimestamp;
   currentStep?: IStep;
   allSteps: IStep[];
   remainingSteps: IStep[];
+  toJSON(): typeof internalPropertiesReplacementText;
 }
 
 export interface InternalSuiteProperties {
   isEventHandlersAttached?: boolean;
 }
 
-let specId = 0;
-
-const internalSpecProperties = new Map<number, InternalSpecProperties>();
-
-function createInternalSpecProperties(
-  properties: InternalSpecProperties
-): number {
-  internalSpecProperties.set(++specId, properties);
-  return specId;
-}
-
 export function retrieveInternalSpecProperties(): InternalSpecProperties {
-  const reference = Cypress.env(INTERNAL_SPEC_PROPERTIES) as number;
-
-  return assertAndReturn(
-    internalSpecProperties.get(reference),
-    `Expected to find internal spec properties with reference = ${reference}`
-  );
+  return Cypress.env(INTERNAL_SPEC_PROPERTIES) as InternalSpecProperties;
 }
 
 function updateInternalSpecProperties(
@@ -315,11 +303,11 @@ function createPickle(context: CompositionContext, pickle: messages.Pickle) {
     testCaseStartedId: context.newId(),
     allSteps: steps,
     remainingSteps: [...steps],
+    toJSON: () => internalPropertiesReplacementText,
   };
 
   const internalEnv = {
-    [INTERNAL_SPEC_PROPERTIES]:
-      createInternalSpecProperties(internalProperties),
+    [INTERNAL_SPEC_PROPERTIES]: internalProperties,
   };
 
   const suiteOptions = tags