Merge pull request #1126 from japgolly/legacy_test_util

Rename `{ => Legacy}ReactTestUtils` & `ReactTestUtils{2 => }`

Author: japgolly

doc/CONFIG.md

@@ -164,7 +164,7 @@ object CustomConfig extends ScalaJsReactConfig.Defaults {
 
 # `.test.warnings.react`
 
-When using `ReactTestUtils`, this setting can be used to catch React warnings and turn them into exceptions.
+When using `LegacyReactTestUtils`, this setting can be used to catch React warnings and turn them into exceptions.
 
 ### Usage:
 
@@ -196,7 +196,7 @@ object ExampleTest extends TestSuite {
   override def tests = Tests {
     "example" - {
       val comp = ScalaFnComponent[Int](i => <.p(<.td(s"i = $i")))
-      ReactTestUtils.withRenderedIntoBody(comp(123)).withParent { m =>
+      LegacyReactTestUtils.withRenderedIntoBody(comp(123)).withParent { m =>
         val html = m.outerHTML
         assert(html == "<p><td>i = 123</td></p>")
       }

doc/TESTING.md

@@ -11,8 +11,8 @@ for how to write tests for real-world scalajs-react applications.
 #### Contents
 
 - [Setup](#setup)
-- [`ReactTestUtils2`](#reacttestutils2-since-300)
-- [`ReactTestUtils [DEPRECATED IN 3.0.0]`](#reacttestutils-deprecated-in-300)
+- [`ReactTestUtils`](#reacttestutils-since-300)
+- [`LegacyReactTestUtils [DEPRECATED IN 3.0.0]`](#legacyreacttestutils-deprecated-in-300)
 - [`Simulate` and `Simulation`](#simulate-and-simulation)
 - [`Testing props changes`](#testing-props-changes)
 - [`ReactTestVar`](#reacttestvar)
@@ -40,9 +40,12 @@ for how to write tests for real-world scalajs-react applications.
        commonJSName "ReactTestUtils"
    ```
 
-# `ReactTestUtils2 [SINCE 3.0.0]`
+# `ReactTestUtils [SINCE 3.0.0]`
 
-Read through the following for how to test with `ReactTestUtils2`.
+`ReactTestUtils` has been rewritten for scalajs-react v3 and React v18.
+What used to be `ReactTestUtils` prior to scalajs-react v3 has been renamed to `LegacyReactTestUtils`.
+
+Read through the following for how to test with `ReactTestUtils`.
 
 ```scala
 import japgolly.scalajs.react._
@@ -66,7 +69,7 @@ object TestUtilsDemo extends TestSuite {
   override def tests = Tests {
 
     // First we render the component
-    ReactTestUtils2.withRenderedSync(Component("Axe")) { t =>
+    ReactTestUtils.withRenderedSync(Component("Axe")) { t =>
 
       // We have a variety of ways to test the HTML
       t.outerHTML.assert("<div><p>Hi Axe. You clicked 0 times</p><button>Click me</button></div>")
@@ -86,9 +89,11 @@ object TestUtilsDemo extends TestSuite {
 }
 ```
 
-# `ReactTestUtils [DEPRECATED IN 3.0.0]`
+# `LegacyReactTestUtils [DEPRECATED IN 3.0.0]`
+
+This used to be called `ReactTestUtils` prior to scalajs-react v3 and React v18.
 
-The main bucket of testing utilities lies in `japgolly.scalajs.react.test.ReactTestUtils`.
+The main bucket of testing utilities lies in `japgolly.scalajs.react.test.LegacyReactTestUtils`.
 
 Half of the methods delegate to React.JS's [React.addons.TestUtils](https://facebook.github.io/react/docs/test-utils.html)
 (for which there is a raw facade in `japgolly.scalajs.react.test.raw.ReactAddonsTestUtils` if you're interested).
@@ -116,7 +121,7 @@ The other half are new functions added specifically in scalajs-react.
 
 There's only one magic implicit method this time around:
 Mounted components get `.outerHtmlScrubbed()` which is shorthand for
-`ReactTestUtils.removeReactInternals(m.getDOMNode.outerHTML)`.
+`LegacyReactTestUtils.removeReactInternals(m.getDOMNode.outerHTML)`.
 
 # `Simulate` and `Simulation`
 
@@ -161,8 +166,20 @@ s run component
 
 # Testing props changes
 
-When you want to simulate a parent component re-rendering a child component with different props,
-you can test the child directly using `ReactTestUtils.{modify,replace}Props`.
+If you're using scalajs-react v3 and React v18, simply call `.render` from your React root. Example:
+
+```scala
+ReactTestUtils.withRendered(Carrot.Props("1").render) { t =>
+  for {
+    _ <- t.root.render(Carrot.Props("1").render)
+    _ <- t.root.render(Carrot.Props("2").render)
+  } yield ()
+}
+```
+
+If you're not using scalajs-react v3 and React v18, then
+when you want to simulate a parent component re-rendering a child component with different props,
+you can test the child directly using `LegacyReactTestUtils.{modify,replace}Props`.
 
 Example of code to test:
 
@@ -181,13 +198,13 @@ val CP = ScalaComponent.builder[String]("asd")
 Example test case:
 
 ```scala
-ReactTestUtils.withRenderedIntoDocument(CP("start")) { m =>
+LegacyReactTestUtils.withRenderedIntoDocument(CP("start")) { m =>
   assert(m.outerHtmlScrubbed(), "<div>none → start</div>")
 
-  ReactTestUtils.modifyProps(CP, m)(_ + "ed")
+  LegacyReactTestUtils.modifyProps(CP, m)(_ + "ed")
   assert(m.outerHtmlScrubbed(), "<div>start → started</div>")
 
-  ReactTestUtils.replaceProps(CP, m)("done!")
+  LegacyReactTestUtils.replaceProps(CP, m)("done!")
   assert(m.outerHtmlScrubbed(), "<div>started → done!</div>")
 }
 ```
@@ -227,7 +244,7 @@ object ExampleTest extends TestSuite {
   override def tests = TestSuite {
 
     val nameVar = ReactTestVar("guy")
-    ReactTestUtils.withRenderedIntoDocument(NameChanger(nameVar.stateSnapshot())) { m =>
+    LegacyReactTestUtils.withRenderedIntoDocument(NameChanger(nameVar.stateSnapshot())) { m =>
       SimEvent.Change("bob").simulate(m)
       assert(nameVar.value() == "bob")
     }
@@ -245,7 +262,7 @@ via `.forceUpdate`.
 val component: ScalaComponent[StateAccessPure[Int], Unit, Unit] = ...
 
 val testVar = ReactTestVar(1)
-ReactTestUtils.withRenderedIntoDocument(component(testVar.stateAccess)) { m =>
+LegacyReactTestUtils.withRenderedIntoDocument(component(testVar.stateAccess)) { m =>
   testVar.onUpdate(m.forceUpdate) // Update the component when it changes the state
 
   assert(m.outerHtmlScrubbed() == "<div>1</div>")
@@ -273,7 +290,7 @@ for how to write tests for real-world scalajs-react applications.
 
 # Fatal React warnings
 
-The easiest way to make `ReactTestUtils` to turn React warnings into runtime exceptions,
+The easiest way to make `LegacyReactTestUtils` to turn React warnings into runtime exceptions,
 is via a [config option](./CONFIG.md#testwarningsreact).
 
 Alternatively, you can do any of the following...
@@ -287,7 +304,7 @@ Alternatively, you can do any of the following...
   }
   ```
 
-- Installing for all `ReactTestUtils` usage
+- Installing for all `LegacyReactTestUtils` usage
 
   ```scala
   import japgolly.scalajs.react.test.ReactTestUtilsConfig

doc/changelog/3.0.0.md

@@ -23,7 +23,7 @@
 
 - Monadic hooks! [See documentation here](../HOOKS.md).
 
-- `ReactTestUtils2`: Replacement for `ReactTestUtils`. [See a demo here](../TESTING.md).
+- `ReactTestUtils` has been replaced. The old version has been renamed to `LegacyReactTestUtils`. [See a demo here](../TESTING.md), and see a migration script below.
 
 - `Renderable` typeclass for anything that React can render
 
@@ -41,7 +41,7 @@
 
 - `.renderBackend` — see https://github.com/japgolly/scalajs-react/pull/1125 for how to replace it
 
-- `ReactTestUtils` - Migrate to `ReactTestUtils2` instead
+- `ReactTestUtils` is now `LegacyReactTestUtils` and deprecated
 
 ### Upgrades
 
@@ -54,7 +54,16 @@
 - ScalaJsDom 2.8.1
 - Sourcecode 0.4.4
 
-### Upgrade notes
+### Migration
+
+- Run this to switch from `{ => Legacy}ReactTestUtils`, and if you were on the betas `ReactTestUtils{2 => }`:
+
+    ```sh
+    find . -type f -name '*.scala' -exec perl -pi -e '
+      s/\bReactTestUtils\b/LegacyReactTestUtils/g;
+      s/\bReactTestUtils2\b/ReactTestUtils/g;
+    ' {} +
+    ```
 
 - To upgrade when using `jsDependencies`, make your sbt config look like this (comments for clarity)
 

downstream-tests/README.md

@@ -0,0 +1,24 @@
+These are tests that rely on a locally-published version of scalajs-react.
+
+### How does it work?
+
+The tests are executed outside of sbt via the `./run` script.
+
+Execute `./run -n` to see the test commands.
+
+### What does it do?
+
+For each test, sbt runs the custom `cleanTestAll` task which does the following:
+
+  * the `jvm` module tests:
+    * the JS generated by the `main` branch (as opposed to `test`) of the `js` module, making sure certain bits of code and present or removed by ScalaJS and related compile-time macros (according to system props)
+
+  * the `js` module tests:
+    * semver compatibility (aka MIMA)
+    * other runtime tests (based on system props)
+
+  * the `jsCE` module tests:
+    * Cats Effect as the default effect library
+
+  * the `jsCBIO` module tests:
+    * scalajs-react's Callbacks as the default effect library

downstream-tests/build.sbt

@@ -79,7 +79,7 @@ lazy val root = Project("root", file("."))
     cleanTestAll := (
       if (enableJSCE) // How to do this in a better way?
         Def.sequential(
-          mima200       / clean,
+          // mima200       / clean,
           macros        / clean,
           jvm           / clean,
           js            / clean,
@@ -93,7 +93,7 @@ lazy val root = Project("root", file("."))
         ).value
       else
         Def.sequential(
-          mima200       / clean,
+          // mima200       / clean,
           macros        / clean,
           jvm           / clean,
           js            / clean,
@@ -133,20 +133,21 @@ lazy val jvm = project
     },
   )
 
-lazy val mima200 = project
-  .in(file("mima-2.0.0"))
-  .enablePlugins(ScalaJSPlugin)
-  .configure(commonSettings, utestSettings(Compile))
-  .settings(
-    libraryDependencies ++= Seq(
-      "com.github.japgolly.scalajs-react" %%% "core" % "2.0.0" % Provided,
-      "com.github.japgolly.scalajs-react" %%% "test" % "2.0.0" % Provided,
-    ),
-  )
+// lazy val mima200 = project
+//   .in(file("mima-2.0.0"))
+//   .enablePlugins(ScalaJSPlugin)
+//   .configure(commonSettings, utestSettings(Compile))
+//   .settings(
+//     libraryDependencies ++= Seq(
+//       "com.github.japgolly.scalajs-react" %%% "core" % "2.0.0" % Provided,
+//       "com.github.japgolly.scalajs-react" %%% "test" % "2.0.0" % Provided,
+//     ),
+//   )
 
 lazy val js = project
   .enablePlugins(ScalaJSPlugin)
-  .dependsOn(macros, mima200)
+  .dependsOn(macros)
+  // .dependsOn(mima200)
   .configure(commonSettings, utestSettings, addReactJsDependencies(Test))
   .settings(
     scalaJSStage := jsStage,

downstream-tests/js-cbio/src/test/scala/downstream/CBIOBundleTests.scala

@@ -1,7 +1,7 @@
 package downstream
 
 import japgolly.microlibs.testutil.TestUtil._
-import japgolly.scalajs.react.test.ReactTestUtils2
+import japgolly.scalajs.react.test.ReactTestUtils
 import utest._
 import cats.effect.testing.utest.EffectTestSuite
 import cats.effect.IO
@@ -13,7 +13,7 @@ object CBIOBundleTests extends EffectTestSuite[IO] {
     Globals.clear()
 
     "catnip" - {
-      ReactTestUtils2.withRendered(Catnip.Component("omg")) { m =>
+      ReactTestUtils.withRendered(Catnip.Component("omg")) { m =>
         IO.sleep(500.millis).map { _ =>
           assertEq(Globals.catnipMounts, List("omg"))
           m.outerHTML.assert("<div>Hello(1) omg</div>")

downstream-tests/js-ce/src/test/scala/downstream/CatsEffectBundleTests.scala

@@ -1,7 +1,7 @@
 package downstream
 
 import japgolly.microlibs.testutil.TestUtil._
-import japgolly.scalajs.react.test.ReactTestUtils2
+import japgolly.scalajs.react.test.ReactTestUtils
 import utest._
 import cats.effect.testing.utest.EffectTestSuite
 import cats.effect.IO
@@ -12,7 +12,7 @@ object CatsEffectBundleTests extends EffectTestSuite[IO] {
     Globals.clear()
 
     "catnip" - {
-      ReactTestUtils2.withRendered_(Catnip.Component("omg")) { m =>
+      ReactTestUtils.withRendered_(Catnip.Component("omg")) { m =>
         assertEq(Globals.catnipMounts, List("omg"))
         m.outerHTML.assert("<div>Hello omg</div>")
       }.map(_ =>

downstream-tests/js/src/test/scala/downstream/RuntimeTests.scala

@@ -5,7 +5,7 @@ import japgolly.microlibs.compiletime.CompileTimeInfo
 import japgolly.microlibs.testutil.TestUtil._
 import japgolly.scalajs.react._
 import japgolly.scalajs.react.vdom.html_<^._
-import japgolly.scalajs.react.test.ReactTestUtils2
+import japgolly.scalajs.react.test.ReactTestUtils
 import japgolly.scalajs.react.util.JsUtil
 import org.scalajs.dom.console
 import scala.scalajs.js
@@ -66,13 +66,13 @@ object RuntimeTests extends AsyncTestSuite {
       val io = IO(completePromise(Try(()))())
 
       for {
-        _ <- ReactTestUtils2.withRendered(Carrot.Props("1", io).render) { m =>
+        _ <- ReactTestUtils.withRendered(Carrot.Props("1", io).render) { m =>
           for {
             _ <- m.root.render(Carrot.Props("1").render)
             _ <- m.root.render(Carrot.Props("2").render)
           } yield ()
         }
-        _ <- ReactTestUtils2.withRendered(Pumpkin.Component("1")) { m =>
+        _ <- ReactTestUtils.withRendered(Pumpkin.Component("1")) { m =>
           for {
             _ <- m.root.render(Pumpkin.Component("1"))
             _ <- m.root.render(Pumpkin.Component("2"))
@@ -95,14 +95,14 @@ object RuntimeTests extends AsyncTestSuite {
 
       "react" - {
         val c = ScalaFnComponent[Int](i => <.p(<.td(s"i = $i")))
-        ReactTestUtils2.withRendered_(c(123))(_ => ()).attemptTry.map { t =>
+        ReactTestUtils.withRendered_(c(123))(_ => ()).attemptTry.map { t =>
           assertEq(t.isFailure, testWarningsReact.contains("react"))
         }
       }
 
       "unlreated" - {
         val c = ScalaFnComponent[Int](i => <.p(s"i = $i"))
-        ReactTestUtils2.withRendered_(c(123)) { _ =>
+        ReactTestUtils.withRendered_(c(123)) { _ =>
           console.info(".")
           console.log(".")
           console.warn(".")

downstream-tests/mima-2.0.0/src/main/scala/DomTester.scala

@@ -0,0 +1 @@
+../../../../../library/tests/src/test/scala/japgolly/scalajs/react/test/DomTester.scala