-
Notifications
You must be signed in to change notification settings - Fork 2
fix(ui): defer default-open tool details #622
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.
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
Merged
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
726f028
fix(ui): defer default-open tool details
Astro-Han 1a61831
test(ui): cover deferred tool detail mounting
Astro-Han 248b77b
fix(ui): keep animated deferred details through close
Astro-Han a4e6cce
test(app): add heavy bash perf probe
Astro-Han 2dcc23e
test(app): keep perf profile unit out of playwright
Astro-Han File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| import { expect, test } from "bun:test" | ||
| import { shouldRunScenario, type PerfScenarioName } from "./profiles" | ||
|
|
||
| test("default profile runs heavy default-open bash perf coverage", () => { | ||
| const scenario = "tool-default-open-heavy-bash" as PerfScenarioName | ||
|
|
||
| expect(shouldRunScenario("default", scenario)).toBe(true) | ||
| expect(shouldRunScenario("low-end", scenario)).toBe(false) | ||
| }) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| import { afterAll, beforeAll, beforeEach, expect, test } from "bun:test" | ||
| import { GlobalRegistrator } from "@happy-dom/global-registrator" | ||
| import { createRequire } from "module" | ||
| import { createServer, type ViteDevServer } from "vite" | ||
| import solidPlugin from "vite-plugin-solid" | ||
| import { basicToolInitialReady } from "./basic-tool" | ||
|
|
||
| const require = createRequire(import.meta.url) | ||
| const solidWeb = require.resolve("solid-js/web/dist/web.js") | ||
| const solidCore = require.resolve("solid-js/dist/solid.js") | ||
| const solidStore = require.resolve("solid-js/store/dist/store.js") | ||
|
|
||
| let server: ViteDevServer | undefined | ||
| let rafCallbacks: Array<FrameRequestCallback | undefined> = [] | ||
| let registeredDom = false | ||
|
|
||
| const flushAnimationFrames = () => { | ||
| const callbacks = rafCallbacks | ||
| rafCallbacks = [] | ||
| callbacks.forEach((callback) => callback?.(performance.now())) | ||
| } | ||
|
|
||
| beforeAll(async () => { | ||
| if (typeof document === "undefined" || typeof window === "undefined") { | ||
| GlobalRegistrator.register() | ||
| registeredDom = true | ||
| } | ||
| window.requestAnimationFrame = globalThis.requestAnimationFrame = ((callback: FrameRequestCallback) => { | ||
| rafCallbacks.push(callback) | ||
| return rafCallbacks.length | ||
| }) as typeof requestAnimationFrame | ||
| window.cancelAnimationFrame = globalThis.cancelAnimationFrame = ((id: number) => { | ||
| rafCallbacks[id - 1] = undefined | ||
| }) as typeof cancelAnimationFrame | ||
|
|
||
| server = await createServer({ | ||
| root: new URL("../..", import.meta.url).pathname, | ||
| configFile: false, | ||
| plugins: [solidPlugin({ solid: { generate: "dom" } })], | ||
| resolve: { | ||
| alias: { | ||
| "solid-js/web": solidWeb, | ||
| "solid-js/store": solidStore, | ||
| "solid-js": solidCore, | ||
| }, | ||
| }, | ||
| server: { middlewareMode: true }, | ||
| appType: "custom", | ||
| logLevel: "silent", | ||
| ssr: { noExternal: ["@kobalte/core", "solid-js"] }, | ||
| }) | ||
| }) | ||
|
|
||
| beforeEach(() => { | ||
| document.body.textContent = "" | ||
| rafCallbacks = [] | ||
| }) | ||
|
|
||
| afterAll(async () => { | ||
| await server?.close() | ||
| if (registeredDom) GlobalRegistrator.unregister() | ||
| }) | ||
|
|
||
| async function loadFixture(): Promise<typeof import("../../test/fixtures/basic-tool-render.fixture")> { | ||
| if (!server) throw new Error("Vite server not initialized") | ||
| return (await server.ssrLoadModule( | ||
| "/test/fixtures/basic-tool-render.fixture.tsx", | ||
| )) as typeof import("../../test/fixtures/basic-tool-render.fixture") | ||
| } | ||
|
|
||
| test("deferred default-open tools do not mount details immediately", () => { | ||
| expect(basicToolInitialReady({ defaultOpen: true, defer: true })).toBe(false) | ||
| }) | ||
|
|
||
| test("deferred default-open tools do not resolve details until the next frame", async () => { | ||
| const { mountBasicTool } = await loadFixture() | ||
| const tool = mountBasicTool({ defaultOpen: true, defer: true }) | ||
|
|
||
| await Promise.resolve() | ||
|
|
||
| expect(tool.detailsRenderCount()).toBe(0) | ||
| expect(tool.details()).toBeNull() | ||
|
|
||
| flushAnimationFrames() | ||
| await Promise.resolve() | ||
|
|
||
| expect(tool.detailsRenderCount()).toBeGreaterThan(0) | ||
| expect(tool.details()?.textContent).toBe("details") | ||
|
|
||
| tool.dispose() | ||
| }) | ||
|
|
||
| test("non-deferred default-open tools keep rendering details synchronously", async () => { | ||
| const { mountBasicTool } = await loadFixture() | ||
| const tool = mountBasicTool({ defaultOpen: true, defer: false }) | ||
|
|
||
| expect(tool.detailsRenderCount()).toBeGreaterThan(0) | ||
| expect(tool.details()?.textContent).toBe("details") | ||
|
|
||
| tool.dispose() | ||
| }) | ||
|
|
||
| test("deferred tools reset details when closed", async () => { | ||
| const { mountBasicTool } = await loadFixture() | ||
| const tool = mountBasicTool({ defaultOpen: false, defer: true }) | ||
|
|
||
| expect(tool.detailsRenderCount()).toBe(0) | ||
| expect(tool.details()).toBeNull() | ||
|
|
||
| tool.trigger()?.click() | ||
| await Promise.resolve() | ||
| flushAnimationFrames() | ||
| await Promise.resolve() | ||
|
|
||
| expect(tool.detailsRenderCount()).toBeGreaterThan(0) | ||
| expect(tool.details()?.textContent).toBe("details") | ||
|
|
||
| tool.trigger()?.click() | ||
| await Promise.resolve() | ||
|
|
||
| expect(tool.details()).toBeNull() | ||
|
|
||
| tool.dispose() | ||
| }) | ||
|
|
||
| test("non-deferred default-open tools keep the previous immediate details behavior", () => { | ||
| expect(basicToolInitialReady({ defaultOpen: true })).toBe(true) | ||
| expect(basicToolInitialReady({ defaultOpen: true, defer: false })).toBe(true) | ||
| }) | ||
|
|
||
| test("closed tools start without mounted details", () => { | ||
| expect(basicToolInitialReady({ defaultOpen: false, defer: true })).toBe(false) | ||
| expect(basicToolInitialReady({ defaultOpen: false })).toBe(false) | ||
| expect(basicToolInitialReady({ defer: true })).toBe(false) | ||
| expect(basicToolInitialReady({})).toBe(false) | ||
| }) | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.