test(query-devtools/Devtools): add tests for initial state from 'initialIsOpen' and 'localStore.open'

packages/query-devtools/src/__tests__/Devtools.test.tsx

@@ -0,0 +1,189 @@
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
+import { QueryClient, onlineManager } from '@tanstack/query-core'
+import { render } from '@solidjs/testing-library'
+import { createLocalStorage } from '@solid-primitives/storage'
+import { Devtools } from '../Devtools'
+import { PiPProvider, QueryDevtoolsContext, ThemeContext } from '../contexts'
+import type { QueryDevtoolsProps } from '../contexts'
+
+// `solid-transition-group` internally imports from
+// `@solid-primitives/transition-group`, whose `exports` field points at
+// `src/index.ts` (not published) under a `@solid-primitives/source` condition
+// that Vite can't fall through, so we stub it with a transparent pass-through.
+vi.mock('solid-transition-group', () => ({
+  TransitionGroup: (props: { children: unknown }) => props.children,
+}))
+
+// `goober` compiles every `css\`...\`` template literal at mount time
+// (template parsing + class hashing + style serialization), which
+// dominates mount cost and produces no value for label/role-based
+// assertions, so we replace it with a no-op factory.
+vi.mock('goober', () => {
+  let counter = 0
+  const css = Object.assign(() => `tsqd-${++counter}`, {
+    bind: () => css,
+  })
+  return { css, glob: () => {}, setup: () => {} }
+})
+
+describe('Devtools', () => {
+  const storage: { [key: string]: string } = {}
+  let queryClient: QueryClient
+  let previousRootFontSize = ''
+
+  beforeEach(() => {
+    previousRootFontSize = document.documentElement.style.fontSize
+    // jsdom doesn't implement `PointerEvent`; the DropdownMenu trigger checks
+    // `e.pointerType !== 'touch'` on pointerdown to decide whether to open,
+    // so we polyfill it as a thin wrapper around `MouseEvent`.
+    if (typeof window.PointerEvent === 'undefined') {
+      class FakePointerEvent extends MouseEvent {
+        pointerType: string
+        constructor(type: string, init: PointerEventInit = {}) {
+          super(type, init)
+          this.pointerType = init.pointerType ?? 'mouse'
+        }
+      }
+      vi.stubGlobal('PointerEvent', FakePointerEvent)
+    }
+    vi.stubGlobal('localStorage', {
+      getItem: (key: string) =>
+        Object.prototype.hasOwnProperty.call(storage, key)
+          ? storage[key]
+          : null,
+      setItem: (key: string, value: string) => {
+        storage[key] = value
+      },
+      removeItem: (key: string) => {
+        delete storage[key]
+      },
+      clear: () => {
+        Object.keys(storage).forEach((key) => delete storage[key])
+      },
+    })
+    vi.stubGlobal(
+      'matchMedia',
+      vi.fn().mockImplementation((query: string) => ({
+        matches: false,
+        media: query,
+        onchange: null,
+        addEventListener: vi.fn(),
+        removeEventListener: vi.fn(),
+        addListener: vi.fn(),
+        removeListener: vi.fn(),
+        dispatchEvent: vi.fn(),
+      })),
+    )
+    vi.stubGlobal(
+      'ResizeObserver',
+      class {
+        callback: ResizeObserverCallback
+        constructor(callback: ResizeObserverCallback) {
+          this.callback = callback
+        }
+        observe = vi.fn((target: Element) => {
+          this.callback(
+            [
+              {
+                target,
+                contentRect: { width: 1000, height: 500 } as DOMRectReadOnly,
+              } as ResizeObserverEntry,
+            ],
+            this as unknown as ResizeObserver,
+          )
+        })
+        unobserve = vi.fn()
+        disconnect = vi.fn()
+      },
+    )
+    queryClient = new QueryClient()
+    document.documentElement.style.fontSize = '16px'
+  })
+
+  afterEach(() => {
+    vi.unstubAllGlobals()
+    Object.keys(storage).forEach((key) => delete storage[key])
+    queryClient.clear()
+    onlineManager.setOnline(true)
+    document.documentElement.style.fontSize = previousRootFontSize
+  })
+
+  function renderDevtools(
+    overrides: Partial<QueryDevtoolsProps> = {},
+    initialStorage: Record<string, string> = {},
+  ) {
+    Object.entries(initialStorage).forEach(([key, value]) => {
+      localStorage.setItem(key, value)
+    })
+    return render(() => {
+      const [localStore, setLocalStore] = createLocalStorage({
+        prefix: 'TanstackQueryDevtools',
+      })
+      return (
+        <QueryDevtoolsContext.Provider
+          value={{
+            client: queryClient,
+            queryFlavor: 'TanStack Query',
+            version: '5',
+            onlineManager,
+            ...overrides,
+          }}
+        >
+          <PiPProvider localStore={localStore} setLocalStore={setLocalStore}>
+            <ThemeContext.Provider value={() => 'dark'}>
+              <Devtools localStore={localStore} setLocalStore={setLocalStore} />
+            </ThemeContext.Provider>
+          </PiPProvider>
+        </QueryDevtoolsContext.Provider>
+      )
+    })
+  }
+
+  describe('initial state', () => {
+    it('should render the open devtools button', () => {
+      const rendered = renderDevtools()
+
+      expect(
+        rendered.getByLabelText('Open Tanstack query devtools'),
+      ).toBeInTheDocument()
+    })
+
+    it('should not render the panel by default', () => {
+      const rendered = renderDevtools()
+
+      expect(
+        rendered.queryByLabelText('Tanstack query devtools'),
+      ).not.toBeInTheDocument()
+    })
+
+    it('should render the panel when "initialIsOpen" is "true"', () => {
+      const rendered = renderDevtools({ initialIsOpen: true })
+
+      expect(
+        rendered.getByLabelText('Tanstack query devtools'),
+      ).toBeInTheDocument()
+    })
+
+    it('should render the panel when "localStore.open" is "true"', () => {
+      const rendered = renderDevtools(
+        {},
+        { 'TanstackQueryDevtools.open': 'true' },
+      )
+
+      expect(
+        rendered.getByLabelText('Tanstack query devtools'),
+      ).toBeInTheDocument()
+    })
+
+    it('should not render the panel when "localStore.open" is "false" even if "initialIsOpen" is "true"', () => {
+      const rendered = renderDevtools(
+        { initialIsOpen: true },
+        { 'TanstackQueryDevtools.open': 'false' },
+      )
+
+      expect(
+        rendered.queryByLabelText('Tanstack query devtools'),
+      ).not.toBeInTheDocument()
+    })
+  })
+})