Skip to content

Fix TS na Vitest issues #477

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bvaughn merged 4 commits into from
May 1, 2025
Merged

Fix TS na Vitest issues #477

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
67ff7be
fixed tsc
Andarist May 1, 2025
9d6defb
fix tests
Andarist May 1, 2025
a5ae564
switch back to jsdom
Andarist May 1, 2025
da52439
try this
Andarist May 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/vitest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,5 @@ jobs:
run: pnpm run prerelease
- name: Run tests
run: cd packages/react-resizable-panels && pnpm run test
- name: Run node tests
run: cd packages/react-resizable-panels && pnpm run test:node
4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"devDependencies": {
"@babel/preset-typescript": "^7.22.5",
"@playwright/test": "^1.37.0",
"@types/node": "^18.17.5",
"@types/node": "^22.15.3",
"@types/react": "latest",
"@types/react-dom": "latest",
"@typescript-eslint/eslint-plugin": "^5.62.0",
Expand All @@ -35,7 +35,7 @@
"parcel": "^2.9.3",
"prettier": "latest",
"process": "^0.11.10",
"typescript": "^5.1.6"
"typescript": "^5.8.3"
},
"dependencies": {
"@parcel/config-default": "^2.9.3",
Expand Down
3 changes: 2 additions & 1 deletion packages/react-resizable-panels/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
"clear:node_modules": "rm -rf ./node_modules",
"lint": "eslint \"src/**/*.{ts,tsx}\"",
"test": "vitest",
"test:node": "vitest -c vitest.node.config.ts",
"test:watch": "vitest --watch",
"watch": "parcel watch --port=2345"
},
Expand All @@ -57,7 +58,7 @@
"@vitest/ui": "^3.1.2",
"eslint": "^8.37.0",
"eslint-plugin-react-hooks": "^4.6.0",
"jsdom": "^24.0.0",
"jsdom": "^26.1.0",
"react": "experimental",
"react-dom": "experimental",
"save-dev": "0.0.1-security",
Expand Down
66 changes: 66 additions & 0 deletions packages/react-resizable-panels/src/Panel.node.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
import { renderToStaticMarkup } from "react-dom/server";
import { act } from "react-dom/test-utils";
import { Panel } from "./Panel";
import { PanelGroup } from "./PanelGroup";
import { PanelResizeHandle } from "./PanelResizeHandle";

describe("PanelGroup", () => {
let expectedWarnings: string[] = [];

function expectWarning(expectedMessage: string) {
expectedWarnings.push(expectedMessage);
}

beforeEach(() => {
// @ts-expect-error
global.IS_REACT_ACT_ENVIRONMENT = true;

expectedWarnings = [];

vi.spyOn(console, "warn").mockImplementation((actualMessage: string) => {
const match = expectedWarnings.findIndex((expectedMessage) => {
return actualMessage.includes(expectedMessage);
});

if (match >= 0) {
expectedWarnings.splice(match, 1);
return;
}

throw Error(`Unexpected warning: ${actualMessage}`);
});
});

afterEach(() => {
vi.clearAllMocks();
expect(expectedWarnings).toHaveLength(0);
});

describe("DEV warnings", () => {
test("should warn about server rendered panels with no default size", () => {
act(() => {
// No warning expected if default sizes provided
renderToStaticMarkup(
<PanelGroup direction="horizontal">
<Panel defaultSize={100} />
<PanelResizeHandle />
<Panel defaultSize={1_000} />
</PanelGroup>
);
});

expectWarning(
"Panel defaultSize prop recommended to avoid layout shift after server rendering"
);

act(() => {
renderToStaticMarkup(
<PanelGroup direction="horizontal">
<Panel id="one" />
</PanelGroup>
);
});
});
});
});
40 changes: 1 addition & 39 deletions packages/react-resizable-panels/src/Panel.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,7 @@ describe("PanelGroup", () => {
});
});

test("should throw if default size is less than 0 or greater than 100", () => {
test.skip("should throw if default size is less than 0 or greater than 100", () => {

@Andarist Andarist May 1, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this runs into some infinite loop or smth and makes the test hang - I'm still investigating what's up with this

@Andarist Andarist May 1, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, so this version pass:

    test("should throw if default size is less than 0 or greater than 100", () => {
      expectWarning(
        "Invalid layout total size: -1%. Layout normalization will be applied."
      );
      expectWarning("default size should not be less than 0");

      act(() => {
        root.render(
          <PanelGroup direction="horizontal">
            <Panel defaultSize={-1} />
          </PanelGroup>
        );
      });

      act(() => {
        root.render(
          <PanelGroup direction="horizontal">
            <Panel defaultSize={101} />
          </PanelGroup>
        );
      });
    });

but clearly it doesn't do what the test title says. So something is off here and has to be fixed - I'll leave that to you ;p

@bvaughn bvaughn May 1, 2025

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works for me when I uncommented the skip 🤷🏼

expect(() => {
act(() => {
root.render(
Expand Down Expand Up @@ -1052,44 +1052,6 @@ describe("PanelGroup", () => {
});

describe("DEV warnings", () => {
test("should warn about server rendered panels with no default size", () => {
vi.resetModules();
vi.mock("#is-browser", () => ({ isBrowser: false }));

const { TextEncoder } = require("util");
global.TextEncoder = TextEncoder;

const { renderToStaticMarkup } = require("react-dom/server.browser");
const { act } = require("react-dom/test-utils");
const Panel = require("./Panel").Panel;
const PanelGroup = require("./PanelGroup").PanelGroup;
const PanelResizeHandle =
require("./PanelResizeHandle").PanelResizeHandle;

act(() => {
// No warning expected if default sizes provided
renderToStaticMarkup(
<PanelGroup direction="horizontal">
<Panel defaultSize={100} />
<PanelResizeHandle />
<Panel defaultSize={1_000} />
</PanelGroup>
);
});

expectWarning(
"Panel defaultSize prop recommended to avoid layout shift after server rendering"
);

act(() => {
renderToStaticMarkup(
<PanelGroup direction="horizontal">
<Panel id="one" />
</PanelGroup>
);
});
});

test("should warn if invalid sizes are specified declaratively", () => {
expectWarning("default size should not be less than 0");

Expand Down
6 changes: 3 additions & 3 deletions packages/react-resizable-panels/src/utils/test-utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
import { expect } from "vitest";
import { DATA_ATTRIBUTES } from "../constants";
import { assert } from "./assert";

const util = require("util");
import util from "node:util";

export function dispatchPointerEvent(type: string, target: HTMLElement) {
const rect = target.getBoundingClientRect();
Expand Down Expand Up @@ -162,7 +161,8 @@ export function verifyExpectedWarnings(
const message = util.format(format, ...args);

for (let index = 0; index < expectedMessages.length; index++) {
const expectedMessage = expectedMessages[index];
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
const expectedMessage = expectedMessages[index]!;
if (message.includes(expectedMessage)) {
expectedMessages.splice(index, 1);
return;
Expand Down
10 changes: 6 additions & 4 deletions packages/react-resizable-panels/vitest.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
import { defineConfig } from "vitest/config";
import { defineConfig, defaultExclude } from "vitest/config";

export default defineConfig({
test: {
globals: true,
environment: "jsdom", // Use jsdom for browser-like tests
exclude: [...defaultExclude, "**/*.node.{test,spec}.?(c|m)[jt]s?(x)"],
environment: "jsdom", // Use for browser-like tests
coverage: {
reporter: ["text", "json", "html"], // Optional: Add coverage reports
},
setupFiles: ["./vitest.setup.ts"],
},
resolve: {
conditions: ["development", "browser"],
},
});
13 changes: 13 additions & 0 deletions packages/react-resizable-panels/vitest.node.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import { defineConfig } from "vitest/config";

export default defineConfig({
test: {
include: ["**/*.node.{test,spec}.?(c|m)[jt]s?(x)"],
coverage: {
reporter: ["text", "json", "html"], // Optional: Add coverage reports
},
},
resolve: {
conditions: ["development"],
},
});
7 changes: 0 additions & 7 deletions packages/react-resizable-panels/vitest.setup.ts
View file
Open in desktop

This file was deleted.

Loading