Replace react dom's testing library with ReactTestingLibrary (#859)

* Install melange-testing-library * Install melange-testing-library npm deps * Vendor melange-testing-library * Fix Form__test with RTL * Start migrating Hooks__test * Remove dependency * Remove unused code from Form__test * Add a jest-devtoolsgs * Add a jest-devtools * Migrate Hooks and Form into RTL * Add demo to manually test easily * Use Uncurried for tests * Migrate all React__test * Force install since we are dealing with R19 * Snapshot with lower {} * Remove jest from demo/dune * Add comment on install --force * Bind React.act and React.actAsync * Bind React.act and React.actAsync * Use React.act as async version only * Test react.act and react.actasync * Fix hola test :(
reasonml · Nov 25, 2024 · 66cd920 · 66cd920
1 parent f5f5579
commit 66cd920
Show file tree

Hide file tree

Showing 30 changed files with 5,859 additions and 837 deletions.
diff --git a/Makefile b/Makefile
@@ -31,6 +31,11 @@ jest: ## Run the jest unit tests
 jest-watch: ## Run the jest unit tests in watch mode
 	@npx jest --watch
 
+.PHONY: jest-devtools
+jest-devtools: ## Run the jest unit tests in watch mode
+	@echo "open Chrome and go to chrome://inspect"
+	@node --inspect-brk node_modules/.bin/jest --runInBand --detectOpenHandles
+
 .PHONY: test
 test: ## Run the runtests from dune (snapshot)
 	@$(DUNE) build @runtest
@@ -54,11 +59,22 @@ format-check: ## Checks if format is correct
 .PHONY: install
 install: ## Update the package dependencies when new deps are added to dune-project
 	@opam install . --deps-only --with-test
-	@npm install
+# --force is needed because we are installing react@19 while other dependencies
+# require react@18. It's a good workaround to bypass the npm validation error
+# and test the rc versions of React
+	@npm install --force
 
 .PHONY: init
 create-switch: ## Create a local opam switch
 	@opam switch create . 5.2.0 --no-install
 
 .PHONY: init
 init: create-switch install ## Create a local opam switch, install deps
+
+.PHONY: demo-watch
+demo-watch: ## Build the demo in watch mode
+	@$(DUNE) build @melange-app --watch
+
+.PHONY: demo-serve
+demo-serve: ## Build the demo and serve it
+	npx http-server -p 8080 _build/default/demo/
diff --git a/demo/dune b/demo/dune
@@ -0,0 +1,9 @@
+(melange.emit
+ (target demo)
+ (alias melange-app)
+ (module_systems
+  (es6 mjs))
+ (libraries reason-react melange.belt melange.dom)
+ (runtime_deps index.html)
+ (preprocess
+  (pps melange.ppx reason-react-ppx)))
diff --git a/demo/index.html b/demo/index.html
@@ -0,0 +1,42 @@
+<!DOCTYPE html>
+<html lang="en">
+
+  <head>
+    <meta charset="UTF-8" />
+    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Demo reason-react</title>
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/yegor256/tacit@gh-pages/tacit-css-1.8.1.min.css" />
+    <style>
+      body {
+        padding: 2rem;
+      }
+
+      #root {
+        margin-left: auto;
+        margin-right: auto;
+        width: 900px;
+      }
+    </style>
+    <script type="importmap">
+      {
+        "imports": {
+          "melange/": "./demo/node_modules/melange/",
+          "melange.belt/": "./demo/node_modules/melange.belt/",
+          "melange.js/": "./demo/node_modules/melange.js/",
+          "reason-react/": "./demo/node_modules/reason-react/",
+          "react/jsx-runtime": "https://esm.sh/[email protected]/jsx-runtime",
+          "react": "https://esm.sh/[email protected]",
+          "react-dom": "https://esm.sh/[email protected]",
+          "react-dom/client": "https://esm.sh/[email protected]/client"
+        }
+      }
+    </script>
+  </head>
+
+  <body>
+    <div id="root"></div>
+  </body>
+  <script type="module" src="./demo/demo/main.mjs"></script>
+
+</html>
diff --git a/demo/main.re b/demo/main.re
@@ -0,0 +1,187 @@
+module Stateful = {
+  [@react.component]
+  let make = (~title, ~initialValue=0, ~children=React.null) => {
+    let (value, setValue) = React.useState(() => initialValue);
+    let onClick = _ => setValue(value => value + 1);
+
+    <section>
+      <h3> {React.string(title)} </h3>
+      <button key="asdf" onClick> value->React.int </button>
+      children
+    </section>;
+  };
+};
+
+module Reducer = {
+  type action =
+    | Increment
+    | Decrement;
+
+  [@react.component]
+  let make = (~initialValue=0) => {
+    let (state, send) =
+      React.useReducer(
+        (state, action) =>
+          switch (action) {
+          | Increment => state + 1
+          | Decrement => state - 1
+          },
+        initialValue,
+      );
+
+    Js.log2("Reducer state", state);
+
+    <section>
+      <h3> {React.string("React.useReducer")} </h3>
+      <main> state->React.int </main>
+      <button onClick={_ => send(Increment)}>
+        "Increment"->React.string
+      </button>
+      <button onClick={_ => send(Decrement)}>
+        "Decrement"->React.string
+      </button>
+    </section>;
+  };
+};
+
+module ReducerWithMapState = {
+  type action =
+    | Increment
+    | Decrement;
+
+  [@react.component]
+  let make = (~initialValue=0) => {
+    let (state, send) =
+      React.useReducerWithMapState(
+        (state, action) =>
+          switch (action) {
+          | Increment => state + 1
+          | Decrement => state - 1
+          },
+        initialValue,
+        initialValue => initialValue + 75,
+      );
+
+    Js.log2("ReducerWithMapState state", state);
+
+    <section>
+      <h3> {React.string("React.useReducerWithMapState")} </h3>
+      <main> state->React.int </main>
+      <button onClick={_ => send(Increment)}>
+        "Increment"->React.string
+      </button>
+      <button onClick={_ => send(Decrement)}>
+        "Decrement"->React.string
+      </button>
+    </section>;
+  };
+};
+
+module WithEffect = {
+  [@react.component]
+  let make = (~value) => {
+    React.useEffect1(
+      () => {
+        Js.log("useEffect");
+        None;
+      },
+      [|value|],
+    );
+
+    React.string("React.useEffect");
+  };
+};
+
+module RerenderOnEachClick = {
+  [@react.component]
+  let make = (~value=0, ~callback as _) => {
+    let (value, setValue) = React.useState(() => value);
+    let onClick = _ =>
+      if (value < 3) {
+        Js.log2("Clicked with:", value);
+        setValue(value => value + 1);
+      } else {
+        Js.log("Max value reached, not firing a rerender");
+        setValue(value => value);
+      };
+
+    <section>
+      <h3> {React.string("RerenderOnEachClick")} </h3>
+      <button onClick> <WithEffect value /> </button>
+    </section>;
+  };
+};
+
+module WithLayoutEffect = {
+  [@react.component]
+  let make = (~value=0, ~callback) => {
+    React.useLayoutEffect1(
+      () => {
+        callback(value);
+        Js.log("useLayoutEffect");
+        None;
+      },
+      [|value|],
+    );
+
+    <section> <h3> {React.string("React.useLayoutEffect")} </h3> </section>;
+  };
+};
+
+module WithRefAndEffect = {
+  [@react.component]
+  let make = (~callback) => {
+    let myRef = React.useRef(1);
+    React.useEffect0(() => {
+      myRef.current = myRef.current + 1;
+      callback(myRef);
+      None;
+    });
+
+    <section>
+      <h3> {React.string("React.useRef and useEffect")} </h3>
+      <main> {React.int(myRef.current)} </main>
+    </section>;
+  };
+};
+
+[@mel.module "react"]
+external useReducer:
+  ([@mel.uncurry] (('state, 'action) => 'state), 'state) =>
+  ('state, 'action => unit) =
+  "useReducer";
+
+module UseReducerNoProblemo = {
+  [@react.component]
+  let make = () => {
+    let reducer = (v, _) => v + 1;
+    let (state, send) = useReducer(reducer, 0);
+    Js.log("asdfasd");
+    <button onClick={_ => send(0)}> {React.int(state)} </button>;
+  };
+};
+
+module App = {
+  [@react.component]
+  let make = (~initialValue) => {
+    let value = 99;
+    let callback = _number => ();
+
+    <main>
+      <Stateful title="Stateful" initialValue />
+      <Reducer key="reducer" initialValue />
+      <ReducerWithMapState key="reducer-with-map-state" initialValue />
+      <RerenderOnEachClick key="rerender-on-each-click" value=0 callback />
+      <WithLayoutEffect key="layout-effect" value callback />
+      <WithRefAndEffect key="ref-and-effect" callback />
+      <UseReducerNoProblemo />
+    </main>;
+  };
+};
+
+switch (ReactDOM.querySelector("#root")) {
+| Some(el) =>
+  let root = ReactDOM.Client.createRoot(el);
+  ReactDOM.Client.render(root, <App initialValue=0 />);
+| None => Js.log("No root element found")
+};
diff --git a/dune b/dune
@@ -1 +1 @@
-(dirs src test ppx)
+(dirs src test ppx demo)