Refactor option handling and extract common routines

Author: badeball

features/suite_only_options.feature

@@ -79,7 +79,7 @@ Feature: suite only options
       Then it fails
       And the output should contain
         """
-        Tag @testIsolation(false) can only be used on a Feature or a Rule
+        Tag testIsolation can only be used on a Feature or a Rule
         """
 
     Scenario: Configuring testIsolation on a Scenario Outline
@@ -105,7 +105,7 @@ Feature: suite only options
       Then it fails
       And the output should contain
         """
-        Tag @testIsolation(false) can only be used on a Feature or a Rule
+        Tag testIsolation can only be used on a Feature or a Rule
         """
 
     Scenario: Configuring testIsolation on Examples
@@ -131,5 +131,5 @@ Feature: suite only options
       Then it fails
       And the output should contain
         """
-        Tag @testIsolation(false) can only be used on a Feature or a Rule
+        Tag testIsolation can only be used on a Feature or a Rule
         """

lib/browser-runtime.ts

@@ -34,7 +34,6 @@ import {
   HOOK_FAILURE_EXPR,
   INTERNAL_SPEC_PROPERTIES,
   INTERNAL_SUITE_PROPERTIES,
-  TEST_ISOLATION_CONFIGURATION_OPTION,
 } from "./constants";
 
 import {
@@ -66,6 +65,12 @@ import { getTags } from "./helpers/environment";
 
 import { ICaseHookParameter, IStepHookParameter } from "./public-member-types";
 
+import {
+  isExclusivelySuiteConfiguration,
+  isNotExclusivelySuiteConfiguration,
+  tagsToOptions,
+} from "./helpers/options";
+
 type Node = ReturnType<typeof parse>;
 
 type TestStepIds = Map<string, Map<string, string>>;
@@ -288,13 +293,7 @@ function createStepDescription({
 
 function createFeature(context: CompositionContext, feature: messages.Feature) {
   const suiteOptions = Object.fromEntries(
-    collectTagNames(feature.tags)
-      .filter(looksLikeOptions)
-      .map(tagToCypressOptions)
-      .filter(
-        ([property]) =>
-          property === (TEST_ISOLATION_CONFIGURATION_OPTION as string)
-      )
+    tagsToOptions(feature.tags).filter(isExclusivelySuiteConfiguration)
   ) as Cypress.TestConfigOverrides;
 
   describe(feature.name || "<unamed feature>", suiteOptions, () => {
@@ -358,13 +357,7 @@ function createRule(context: CompositionContext, rule: messages.Rule) {
   }
 
   const suiteOptions = Object.fromEntries(
-    collectTagNames(rule.tags)
-      .filter(looksLikeOptions)
-      .map(tagToCypressOptions)
-      .filter(
-        ([property]) =>
-          property === (TEST_ISOLATION_CONFIGURATION_OPTION as string)
-      )
+    tagsToOptions(rule.tags).filter(isExclusivelySuiteConfiguration)
   ) as Cypress.TestConfigOverrides;
 
   describe(rule.name || "<unamed rule>", suiteOptions, () => {
@@ -458,51 +451,33 @@ function createPickle(context: CompositionContext, pickle: messages.Pickle) {
     "Expected a scenario to have a examples property"
   );
 
-  const tagsDefinedOnThisScenarioTagNameAstIdMap = scenario.tags.reduce(
-    (acc, tag) => {
-      acc[tag.name] = tag.id;
-      return acc;
-    },
-    {} as Record<string, string>
-  );
-
-  for (const example of scenario.examples) {
-    example.tags.forEach((tag) => {
-      tagsDefinedOnThisScenarioTagNameAstIdMap[tag.name] = tag.id;
-    });
-  }
+  const testSpecificOptions = tagsToOptions([
+    ...scenario.tags,
+    ...scenario.examples.flatMap((example) => example.tags),
+  ]);
 
-  for (const tag of pickle.tags) {
-    if (
-      looksLikeOptions(tag.name) &&
-      tagsDefinedOnThisScenarioTagNameAstIdMap[tag.name] === tag.astNodeId &&
-      Object.keys(tagToCypressOptions(tag.name)).every(
-        (key) => key === TEST_ISOLATION_CONFIGURATION_OPTION
-      )
-    ) {
+  for (const entry of testSpecificOptions) {
+    if (isExclusivelySuiteConfiguration(entry)) {
       throw new Error(
-        `Tag ${tag.name} can only be used on a Feature or a Rule`
+        `Tag ${entry[0]} can only be used on a Feature or a Rule`
       );
     }
   }
 
-  const suiteOptions = Object.fromEntries(
+  const inheritedTestOptions = Object.fromEntries(
     tags
       .filter(looksLikeOptions)
       .map(tagToCypressOptions)
-      .filter(
-        ([property]) =>
-          property !== (TEST_ISOLATION_CONFIGURATION_OPTION as string)
-      )
+      .filter(isNotExclusivelySuiteConfiguration)
   ) as Cypress.TestConfigOverrides;
 
-  if (suiteOptions.env) {
-    Object.assign(suiteOptions.env, internalEnv);
+  if (inheritedTestOptions.env) {
+    Object.assign(inheritedTestOptions.env, internalEnv);
   } else {
-    suiteOptions.env = internalEnv;
+    inheritedTestOptions.env = internalEnv;
   }
 
-  it(scenarioName, suiteOptions, function () {
+  it(scenarioName, inheritedTestOptions, function () {
     const { remainingSteps, testCaseStartedId } =
       retrieveInternalSpecProperties();
 

lib/helpers/options.ts

@@ -0,0 +1,32 @@
+import * as messages from "@cucumber/messages";
+
+import { collectTagNames } from "./ast";
+
+import {
+  ConfigurationEntry,
+  looksLikeOptions,
+  tagToCypressOptions,
+} from "./tag-parser";
+import { TEST_ISOLATION_CONFIGURATION_OPTION } from "../constants";
+
+export function tagsToOptions(tags: readonly messages.Tag[]) {
+  return collectTagNames(tags)
+    .filter(looksLikeOptions)
+    .map(tagToCypressOptions);
+}
+
+export function isExclusivelySuiteConfiguration(entry: ConfigurationEntry) {
+  // TODO: Remove type cast once support for v10 is removed.
+  return entry[0] === (TEST_ISOLATION_CONFIGURATION_OPTION as string);
+}
+
+export function isNotExclusivelySuiteConfiguration(entry: ConfigurationEntry) {
+  // TODO: Remove type cast once support for v10 is removed.
+  return entry[0] !== (TEST_ISOLATION_CONFIGURATION_OPTION as string);
+}
+
+export function hasExclusivelySuiteConfiguration(
+  config: Cypress.TestConfigOverrides
+) {
+  return Object.keys(config).includes(TEST_ISOLATION_CONFIGURATION_OPTION);
+}