Restrict the following DSLs to prevent sessions named child window or…

… child tab

CHANGELOG

@@ -1,3 +1,11 @@
+3.72.2
+======
+20 August 2024
+- Restrict the following DSLs to prevent sessions named "child window" or "child tab"
+  - `I start a browser for <name>`
+  - `I switch to <name>`
+  - `I close the browser for <name>`
+
 3.72.1
 ======
 18 August 2024

build.sbt

@@ -2,7 +2,7 @@ enablePlugins(GitVersioning)
 
 // gwen core & web versions
 val gwenVersion = "3.61.4"
-val gwenWebVersion = "3.72.1"
+val gwenWebVersion = "3.72.2"
 
 git.baseVersion := gwenWebVersion
 git.useGitDescribe := true

src/main/scala/gwen/web/eval/WebErrors.scala

@@ -43,6 +43,7 @@ object WebErrors {
     def invalidActionError(action: ElementAction) = throw new InvalidActionException(action)
     def invalidSelectorTypeError(selectorType: String) = throw new InvalidSelectorTypeException(selectorType)
     def multipleBrowserSettingsError(settingsFiles: List[File]) = throw new MultipleBrowserSettingsException(settingsFiles)
+    def illegalSessionNameError(name: String, msg: Option[String]) = throw new IllegalSessionNameException(name, msg)
 
     /** Thrown when a locator binding error is detected . */
     class LocatorBindingException(msg: String) extends GwenException(msg)
@@ -89,4 +90,8 @@ object WebErrors {
     /** Thrown when more than one browser setting file is active.*/
     class MultipleBrowserSettingsException(settingsFiles: List[File]) extends GwenException(s"Multiple browser settings provided (only 1 expected): ${settingsFiles.mkString(", ")}")
 
+    /** Thrown when an unsupported web driver is detected. */
+    class IllegalSessionNameException(name: String, msg: Option[String])
+      extends GwenException(s"Illegal (reserved) browser session name: $name${msg.map(m => s". $m").getOrElse("")}")
+
 }

src/main/scala/gwen/web/eval/lambda/unit/OpenOrCloseBrowser.scala

@@ -17,6 +17,7 @@
 package gwen.web.eval.lambda.unit
 
 import gwen.web.eval.WebContext
+import gwen.web.eval.WebErrors
 
 import gwen.core.behavior.BehaviorType
 import gwen.core.eval.lambda.UnitStep
@@ -28,6 +29,9 @@ import scala.util.chaining._
 class OpenOrCloseBrowser(open: Boolean, name: Option[String], behaviorType: BehaviorType) extends UnitStep[WebContext] {
 
   override def apply(parent: GwenNode, step: Step, ctx: WebContext): Step = {
+    name.filter(_.matches("child (window|tab)")) foreach { n => 
+      WebErrors.illegalSessionNameError(n, None)
+    }
     step tap { _ =>
       checkStepRules(step, behaviorType, ctx)
       if (open) {

src/main/scala/gwen/web/eval/lambda/unit/StartBrowserSession.scala

@@ -17,6 +17,7 @@
 package gwen.web.eval.lambda.unit
 
 import gwen.web.eval.WebContext
+import gwen.web.eval.WebErrors
 
 import gwen.core.behavior.BehaviorType
 import gwen.core.eval.lambda.UnitStep
@@ -28,6 +29,7 @@ import scala.util.chaining._
 class StartBrowserSession(name: String) extends UnitStep[WebContext] {
 
   override def apply(parent: GwenNode, step: Step, ctx: WebContext): Step = {
+    if (name.matches("child (window|tab)")) WebErrors.illegalSessionNameError(name, None)
     step tap { _ =>
       checkStepRules(step, BehaviorType.Action, ctx)
       ctx.close(name)

src/main/scala/gwen/web/eval/lambda/unit/SwitchToBrowserSession.scala

@@ -17,6 +17,7 @@
 package gwen.web.eval.lambda.unit
 
 import gwen.web.eval.WebContext
+import gwen.web.eval.WebErrors
 
 import gwen.core.behavior.BehaviorType
 import gwen.core.eval.lambda.UnitStep
@@ -28,6 +29,7 @@ import scala.util.chaining._
 class SwitchToBrowserSession(name: String) extends UnitStep[WebContext] {
 
   override def apply(parent: GwenNode, step: Step, ctx: WebContext): Step = {
+    if (name.matches("child (window|tab)")) WebErrors.illegalSessionNameError(name, Some(s"Did you instead mean to call: I switch to the $name"))
     step tap { _ =>
       checkStepRules(step, BehaviorType.Action, ctx)
       ctx.switchToSession(name)