Support ReactTestUtilsConfig.aroundReact in new testing API

japgolly · japgolly · commit c1056050f2d6 · 2025-10-17T13:47:36.000+11:00
diff --git a/doc/CONFIG.md b/doc/CONFIG.md
@@ -164,7 +164,7 @@ object CustomConfig extends ScalaJsReactConfig.Defaults {
 
 # `.test.warnings.react`
 
-When using `LegacyReactTestUtils`, this setting can be used to catch React warnings and turn them into exceptions.
+When using `ReactTestUtils` or `LegacyReactTestUtils`, this setting can be used to catch React warnings and turn them into exceptions.
 
 ### Usage:
 
@@ -196,9 +196,8 @@ object ExampleTest extends TestSuite {
   override def tests = Tests {
     "example" - {
       val comp = ScalaFnComponent[Int](i => <.p(<.td(s"i = $i")))
-      LegacyReactTestUtils.withRenderedIntoBody(comp(123)).withParent { m =>
-        val html = m.outerHTML
-        assert(html == "<p><td>i = 123</td></p>")
+      ReactTestUtils.withRenderedSync(comp(123)) { t =>
+        t.outerHTML.assert("<p><td>i = 123</td></p>")
       }
     }
   }
@@ -241,7 +240,8 @@ object Main {
 
     // Start app
     val container = dom.document.getElementById("root")
-    MyApp().renderIntoDOM(container)
+    val root = ReactDOMClient.createRoot(container)
+    root.render(MyApp())
   }
 }
 ```
@@ -293,7 +293,8 @@ object Main {
 
     // Start app
     val container = dom.document.getElementById("root")
-    MyApp().renderIntoDOM(container)
+    val root = ReactDOMClient.createRoot(container)
+    root.render(MyApp())
   }
 }
 ```
diff --git a/doc/TESTING.md b/doc/TESTING.md
@@ -290,7 +290,7 @@ for how to write tests for real-world scalajs-react applications.
 
 # Fatal React warnings
 
-The easiest way to make `LegacyReactTestUtils` to turn React warnings into runtime exceptions,
+The easiest way to make `ReactTestUtils` or `LegacyReactTestUtils` to turn React warnings into runtime exceptions,
 is via a [config option](./CONFIG.md#testwarningsreact).
 
 Alternatively, you can do any of the following...
@@ -304,7 +304,7 @@ Alternatively, you can do any of the following...
   }
   ```
 
-- Installing for all `LegacyReactTestUtils` usage
+- Installing for all `ReactTestUtils` usage
 
   ```scala
   import japgolly.scalajs.react.test.ReactTestUtilsConfig
diff --git a/downstream-tests/js/src/test/scala/downstream/RuntimeTests.scala b/downstream-tests/js/src/test/scala/downstream/RuntimeTests.scala
@@ -97,6 +97,7 @@ object RuntimeTests extends AsyncTestSuite {
         val c = ScalaFnComponent[Int](i => <.p(<.td(s"i = $i")))
         ReactTestUtils.withRendered_(c(123))(_ => ()).attemptTry.map { t =>
           assertEq(t.isFailure, testWarningsReact.contains("react"))
+          t.toEither
         }
       }
 
diff --git a/library/testUtil/src/main/scala/japgolly/scalajs/react/test/LegacyReactTestUtils.scala b/library/testUtil/src/main/scala/japgolly/scalajs/react/test/LegacyReactTestUtils.scala
@@ -4,7 +4,6 @@ import japgolly.scalajs.react._
 import japgolly.scalajs.react.facade.{React => RawReact, ReactDOM => RawReactDOM}
 import japgolly.scalajs.react.hooks.Hooks
 import japgolly.scalajs.react.internal.CoreGeneral._
-import japgolly.scalajs.react.test.ReactTestUtilsConfig.aroundReact
 import japgolly.scalajs.react.util.DefaultEffects.{Async => DA, Sync => DS}
 import japgolly.scalajs.react.util.Effect._
 import japgolly.scalajs.react.util.JsUtil
@@ -106,30 +105,13 @@ object LegacyReactTestUtils extends LegacyReactTestUtils {
 
     def _withRenderedAsync[F[_], M, A](u: Unmounted[M], parent: Element, f: (M, Element) => F[A])
                                       (implicit F: Async[F]): F[A] =
-      aroundReactAsync {
+      ReactTestUtilsConfig.aroundReact.async {
         F.flatMap(F.delay(act(RawReactDOM.render(u.raw, parent)))) { c =>
           val m = u.mountRawOrNull(c)
           F.finallyRun(f(m, parent), F.delay(act(unmountRawComponent(c))))
         }
       }
 
-    def aroundReactAsync[F[_], A](body: F[A])(implicit F: Async[F]): F[A] = {
-      val start = F.delay {
-        val stop = aroundReact.start()
-        F.delay(stop())
-      }
-      F.flatMap(start) { stop =>
-        F.finallyRun(body, stop)
-      }
-    }
-
-    def aroundReactFuture[A](body: => Future[A])(implicit ec: ExecutionContext): Future[A] = {
-      val stop = aroundReact.start()
-      val f    = body
-      f.onComplete { _ => stop() }
-      f
-    }
-
   } // Internals
 }
 
@@ -279,7 +261,7 @@ trait LegacyReactTestUtils extends japgolly.scalajs.react.test.internal.ReactTes
     new WithRenderedDsl[M, Element] {
       override def apply[A](f: (M, Element) => A): A =
         withNewBodyElement { parent =>
-          aroundReact.sync {
+          ReactTestUtilsConfig.aroundReact.sync {
             val c = act(RawReactDOM.render(u.raw, parent))
             try
               f(u.mountRawOrNull(c), parent)
@@ -308,7 +290,7 @@ trait LegacyReactTestUtils extends japgolly.scalajs.react.test.internal.ReactTes
     */
   def withRenderedIntoBodyFuture[M, A](u: Unmounted[M])(f: M => Future[A])(implicit ec: ExecutionContext): Future[A] =
     withNewBodyElementFuture { parent =>
-      aroundReactFuture {
+      ReactTestUtilsConfig.aroundReact.future {
         val c = act(RawReactDOM.render(u.raw, parent))
         val m = u.mountRawOrNull(c)
         attemptFuture(f(m)).andThen { case _ => act(unmountRawComponent(c)) }
@@ -357,7 +339,7 @@ trait LegacyReactTestUtils extends japgolly.scalajs.react.test.internal.ReactTes
   def withRenderedIntoDocument[M](u: Unmounted[M]): WithRenderedDsl[M, Element] =
     new WithRenderedDsl[M, Element] {
       override def apply[A](f: (M, Element) => A): A =
-        aroundReact.sync {
+        ReactTestUtilsConfig.aroundReact.sync {
           val c = act(raw.renderIntoDocument(u.raw))
           try {
             val p = parentElement(c)
@@ -377,7 +359,7 @@ trait LegacyReactTestUtils extends japgolly.scalajs.react.test.internal.ReactTes
     * and asynchronously waits for the Future to complete before unmounting.
     */
   def withRenderedIntoDocumentFuture[M, A](u: Unmounted[M])(f: M => Future[A])(implicit ec: ExecutionContext): Future[A] =
-    aroundReactFuture {
+    ReactTestUtilsConfig.aroundReact.future {
       val c = act(raw.renderIntoDocument(u.raw))
       val m = u.mountRawOrNull(c)
       attemptFuture(f(m)).andThen { case _ => act(unmountRawComponent(c)) }
diff --git a/library/testUtil/src/main/scala/japgolly/scalajs/react/test/ReactTestUtils.scala b/library/testUtil/src/main/scala/japgolly/scalajs/react/test/ReactTestUtils.scala
@@ -120,11 +120,18 @@ trait ReactTestUtils extends japgolly.scalajs.react.test.internal.ReactTestUtilE
     Resource.make(Effect[F].delay(newElement()), e => Effect[F].delay(removeElement(e)))
 
   val withReactRootSync: WithDsl[TestReactRoot, ImplicitUnit] =
-    withElementSync.mapResource(TestReactRoot(_))(_.unmountSync())
-
-  def withReactRoot[F[_]: Async]: Resource[F, TestReactRoot] =
-    withElement[F].flatMap{ e =>
-      Resource.make_[F, TestReactRoot](TestReactRoot(e), _.unmount[F]())
+    withElementSync
+      .mapResource(e => {
+        val stop = ReactTestUtilsConfig.aroundReact.start()
+        (e, stop)
+      })(_._2())
+      .mapResource(x => TestReactRoot(x._1))(_.unmountSync())
+
+  def withReactRoot[F[_]](implicit F: Async[F]): Resource[F, TestReactRoot] =
+    withElement[F].flatMap { e =>
+      Resource.make_[F, () => Unit](ReactTestUtilsConfig.aroundReact.start(), stop => F.delay(stop())).flatMap { _ =>
+        Resource.make_[F, TestReactRoot](TestReactRoot(e), _.unmount[F]())
+      }
     }
 
   def withRenderedSync[A](unmounted: A): WithDsl[TestDomWithRoot, Renderable[A]] =
diff --git a/library/testUtil/src/main/scala/japgolly/scalajs/react/test/ReactTestUtilsConfig.scala b/library/testUtil/src/main/scala/japgolly/scalajs/react/test/ReactTestUtilsConfig.scala
@@ -1,6 +1,9 @@
 package japgolly.scalajs.react.test
 
 import japgolly.scalajs.react.test.internal._
+import japgolly.scalajs.react.util.Effect.Async
+import scala.concurrent.ExecutionContext
+import scala.concurrent.Future
 
 object ReactTestUtilsConfig extends ReactTestUtilsConfigTypes {
 
@@ -20,5 +23,22 @@ object ReactTestUtilsConfig extends ReactTestUtilsConfigTypes {
 
     override def start(): () => Unit =
       value.start()
+
+    def async[F[_], A](body: F[A])(implicit F: Async[F]): F[A] = {
+      val start = F.delay {
+        val stop = ReactTestUtilsConfig.aroundReact.start()
+        F.delay(stop())
+      }
+      F.flatMap(start) { stop =>
+        F.finallyRun(body, stop)
+      }
+    }
+
+    def future[A](body: => Future[A])(implicit ec: ExecutionContext): Future[A] = {
+      val stop = ReactTestUtilsConfig.aroundReact.start()
+      val f    = body
+      f.onComplete { _ => stop() }
+      f
+    }
   }
 }
diff --git a/library/tests/src/test/scala/japgolly/scalajs/react/test/ReactTestUtilsConfigTest.scala b/library/tests/src/test/scala/japgolly/scalajs/react/test/ReactTestUtilsConfigTest.scala
@@ -28,9 +28,10 @@ object ReactTestUtilsConfigTest extends AsyncTestSuite {
     "warnings" - {
       "react" - AroundReact.fatalReactWarnings {
         val c = ScalaFnComponent[Int](i => <.p(<.td(s"i = $i")))
-        ReactTestUtils.withRendered_(c(123))(_ => ()).attemptTry.map( t =>
+        ReactTestUtils.withRendered_(c(123))(_ => ()).attemptTry.map { t =>
           assertEq(t.isFailure, true)
-        )
+          t.toEither
+        }
       }
 
       "unlreated" - AroundReact.fatalReactWarnings {

Original file line number	Diff line number	Diff line change
`@@ -164,7 +164,7 @@ object CustomConfig extends ScalaJsReactConfig.Defaults {`
`164`	`164`
`165`	`165`	# `.test.warnings.react`
`166`	`166`
`167`		-When using `LegacyReactTestUtils`, this setting can be used to catch React warnings and turn them into exceptions.
	`167`	+When using `ReactTestUtils` or `LegacyReactTestUtils`, this setting can be used to catch React warnings and turn them into exceptions.
`168`	`168`
`169`	`169`	`### Usage:`
`170`	`170`
`@@ -196,9 +196,8 @@ object ExampleTest extends TestSuite {`
`196`	`196`	`override def tests = Tests {`
`197`	`197`	`"example" - {`
`198`	`198`	`val comp = ScalaFnComponent[Int](i => <.p(<.td(s"i = $i")))`
`199`		`- LegacyReactTestUtils.withRenderedIntoBody(comp(123)).withParent { m =>`
`200`		`- val html = m.outerHTML`
`201`		`- assert(html == "<p><td>i = 123</td></p>")`
	`199`	`+ ReactTestUtils.withRenderedSync(comp(123)) { t =>`
	`200`	`+ t.outerHTML.assert("<p><td>i = 123</td></p>")`
`202`	`201`	`}`
`203`	`202`	`}`
`204`	`203`	`}`
`@@ -241,7 +240,8 @@ object Main {`
`241`	`240`
`242`	`241`	`// Start app`
`243`	`242`	`val container = dom.document.getElementById("root")`
`244`		`- MyApp().renderIntoDOM(container)`
	`243`	`+ val root = ReactDOMClient.createRoot(container)`
	`244`	`+ root.render(MyApp())`
`245`	`245`	`}`
`246`	`246`	`}`
`247`	`247`	```
`@@ -293,7 +293,8 @@ object Main {`
`293`	`293`
`294`	`294`	`// Start app`
`295`	`295`	`val container = dom.document.getElementById("root")`
`296`		`- MyApp().renderIntoDOM(container)`
	`296`	`+ val root = ReactDOMClient.createRoot(container)`
	`297`	`+ root.render(MyApp())`
`297`	`298`	`}`
`298`	`299`	`}`
`299`	`300`	```
Original file line number	Diff line number	Diff line change
`@@ -97,6 +97,7 @@ object RuntimeTests extends AsyncTestSuite {`
`97`	`97`	`val c = ScalaFnComponent[Int](i => <.p(<.td(s"i = $i")))`
`98`	`98`	`ReactTestUtils.withRendered_(c(123))(_ => ()).attemptTry.map { t =>`
`99`	`99`	`assertEq(t.isFailure, testWarningsReact.contains("react"))`
	`100`	`+ t.toEither`
`100`	`101`	`}`
`101`	`102`	`}`
`102`	`103`