@describe-me/react 0.5.0-next.0 → 0.5.0-next.2

package/README.md

@@ -24,7 +24,10 @@ Each entry point re-exports everything its test library offers, with the
 recording functions swapped in, so switching an existing test is one import.
 `@describe-me/react` swaps `render`. The Testing Library entry swaps `render`,
 `fireEvent` and `cleanup`: every `fireEvent` call records a frame, and
-`cleanup` takes the closing frame before it unmounts.
+`cleanup` takes the closing frame before it unmounts. When the render frame is
+taken follows the plugin's
+[`renderFrame`](https://github.com/grzehub/describe-me#render-frame-timing)
+option.
 
 ```tsx
 import { render, step } from '@describe-me/react'

package/dist/cleanup.js

@@ -6,6 +6,7 @@ import { recorder } from '@describe-me/core';
  * state instead of an empty page.
  */
 export function cleanup() {
+    recorder.beforeInteraction();
     void recorder.capture('end', 'end of test', undefined, { settle: false });
     unmountAll();
 }

package/dist/record-sync-action.js

@@ -12,6 +12,7 @@ let depth = 0;
  * settling.
  */
 export function recordSyncAction(label, run) {
+    recorder.beforeInteraction();
     depth++;
     let result;
     try {

package/dist/render-testing-library.d.ts

@@ -11,6 +11,8 @@ type RenderResult = ReturnType<typeof baseRender>;
  * keeps working. Testing Library wraps mounting in `act()`, which means the DOM
  * is committed when it returns, so frames are captured without settling: the
  * snapshot is taken right here, before the test's next line can change the DOM.
+ * `render`, `rerender` and `unmount` first take a render frame the plugin's
+ * `renderFrame` option deferred.
  *
  * Importing this module hands unmounting to the recorder's teardown rather
  * than to Testing Library's own auto-cleanup, which would run before the

package/dist/render-testing-library.js

@@ -15,6 +15,8 @@ recorder.onTeardown(unmountAll);
  * keeps working. Testing Library wraps mounting in `act()`, which means the DOM
  * is committed when it returns, so frames are captured without settling: the
  * snapshot is taken right here, before the test's next line can change the DOM.
+ * `render`, `rerender` and `unmount` first take a render frame the plugin's
+ * `renderFrame` option deferred.
  *
  * Importing this module hands unmounting to the recorder's teardown rather
  * than to Testing Library's own auto-cleanup, which would run before the
@@ -22,6 +24,7 @@ recorder.onTeardown(unmountAll);
  * `RTL_SKIP_AUTO_CLEANUP`.
  */
 export function render(ui, options) {
+    recorder.beforeInteraction();
     const result = baseRender(ui, options);
     if (recorder.isActive && isValidElement(ui)) {
         const info = describeElement(ui);
@@ -30,11 +33,18 @@ export function render(ui, options) {
     }
     const originalRerender = result.rerender;
     result.rerender = (next) => {
+        recorder.beforeInteraction();
         originalRerender(next);
         if (recorder.isActive && isValidElement(next)) {
             const info = describeElement(next);
             void recorder.capture('render', `rerender ${labelFor(info)}`, { props: info.props }, { settle: false });
         }
     };
+    const originalUnmount = result.unmount;
+    // Without this, a lazy test that ends with `unmount()` documents an empty page.
+    result.unmount = () => {
+        recorder.beforeInteraction();
+        originalUnmount();
+    };
     return result;
 }

package/dist/render.d.ts

@@ -5,7 +5,8 @@ type RenderOptions = Parameters<BaseRender>[1];
 type Screen = Awaited<ReturnType<BaseRender>>;
 /**
  * Drop-in for `render` from vitest-browser-react. Records a frame after mount
- * and after every `rerender`.
+ * and after every `rerender`. `render`, `rerender` and `unmount` first take a
+ * render frame the plugin's `renderFrame` option deferred.
  */
 export declare function render(ui: ReactElement, options?: RenderOptions): Promise<Screen>;
 export {};

package/dist/render.js

@@ -5,23 +5,34 @@ import { describeElement } from './describe-element.js';
 import { labelFor } from './label-for.js';
 /**
  * Drop-in for `render` from vitest-browser-react. Records a frame after mount
- * and after every `rerender`.
+ * and after every `rerender`. `render`, `rerender` and `unmount` first take a
+ * render frame the plugin's `renderFrame` option deferred.
  */
 export async function render(ui, options) {
+    const generation = recorder.generation;
+    recorder.beforeInteraction();
     const screen = await baseRender(ui, options);
     if (isValidElement(ui)) {
         const info = describeElement(ui);
         recorder.setComponent(info);
-        await recorder.capture('render', labelFor(info), { props: info.props });
+        await recorder.capture('render', labelFor(info), { props: info.props }, { generation });
     }
     const originalRerender = screen.rerender.bind(screen);
     screen.rerender = (async (next) => {
+        const rerenderGeneration = recorder.generation;
+        recorder.beforeInteraction();
         const result = await originalRerender(next);
         if (isValidElement(next)) {
             const info = describeElement(next);
-            await recorder.capture('render', `rerender ${labelFor(info)}`, { props: info.props });
+            await recorder.capture('render', `rerender ${labelFor(info)}`, { props: info.props }, { generation: rerenderGeneration });
         }
         return result;
     });
+    const originalUnmount = screen.unmount.bind(screen);
+    // Without this, a lazy test that ends with `unmount()` documents an empty page.
+    screen.unmount = () => {
+        recorder.beforeInteraction();
+        return originalUnmount();
+    };
     return screen;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@describe-me/react",
-  "version": "0.5.0-next.0",
+  "version": "0.5.0-next.2",
   "description": "React adapter for describe-me: drop-in render functions that record frames",
   "keywords": [
     "vitest",
@@ -46,7 +46,7 @@
     "./dist/render-testing-library.js"
   ],
   "dependencies": {
-    "@describe-me/core": "^0.5.0-next.0"
+    "@describe-me/core": "^0.5.0-next.2"
   },
   "peerDependencies": {
     "@testing-library/react": "^16.0.0",