From 67f24481230ddda652388bdacf9358016078a762 Mon Sep 17 00:00:00 2001
From: Maxim Khvatalin <khmm12@gmail.com>
Date: Mon, 24 Jun 2024 22:27:25 +0300
Subject: [PATCH] feat: spin settings button during settings loading

---
 .../hooks/createSettingsDialog.tsx            |  8 +--
 src/components/Footer/Footer.test.tsx         |  8 ++-
 .../SettingsButton/SettingsButton.test.tsx    | 53 ++++++++++++++-
 .../SettingsButton.test.tsx.snap              |  1 +
 src/components/SettingsButton/index.tsx       | 67 ++++++++++++++-----
 src/components/SettingsButton/styles.ts       | 19 +++++-
 src/components/SettingsDialog/index.tsx       |  8 ++-
 7 files changed, 136 insertions(+), 28 deletions(-)

diff --git a/src/components/Application/hooks/createSettingsDialog.tsx b/src/components/Application/hooks/createSettingsDialog.tsx
index 6840969..d0af2cd 100644
--- a/src/components/Application/hooks/createSettingsDialog.tsx
+++ b/src/components/Application/hooks/createSettingsDialog.tsx
@@ -25,11 +25,11 @@ export default function createSettingsDialog(): CreateSettingsDialogReturnValue
 
   return {
     $el: (
-      <ShowWithTransition when={showSettings()}>
-        <Suspense>
+      <Suspense>
+        <ShowWithTransition when={showSettings()}>
           <SettingsDialog onClose={handleSettingsClose} onSaved={handleSettingsSaved} />
-        </Suspense>
-      </ShowWithTransition>
+        </ShowWithTransition>
+      </Suspense>
     ),
     open: handleSettingsRequest,
   }
diff --git a/src/components/Footer/Footer.test.tsx b/src/components/Footer/Footer.test.tsx
index 0d92b29..6505693 100644
--- a/src/components/Footer/Footer.test.tsx
+++ b/src/components/Footer/Footer.test.tsx
@@ -1,4 +1,4 @@
-import { fireEvent, render, screen } from '@test/helpers/solid'
+import { fireEvent, render, screen, waitFor } from '@test/helpers/solid'
 import Footer from '.'
 
 vi.mock('@/components/Credits', () => ({
@@ -6,7 +6,7 @@ vi.mock('@/components/Credits', () => ({
 }))
 
 describe('Footer', () => {
-  it('renders a settings button', () => {
+  it('renders a settings button', async () => {
     const handleSettingsRequest = vi.fn()
     render(() => <Footer onSettingsRequest={handleSettingsRequest} />)
 
@@ -14,7 +14,9 @@ describe('Footer', () => {
 
     fireEvent.click(screen.getByTitle('Open settings'))
 
-    expect(handleSettingsRequest).toBeCalled()
+    await waitFor(() => {
+      expect(handleSettingsRequest).toBeCalled()
+    })
   })
 
   it('renders credits', () => {
diff --git a/src/components/SettingsButton/SettingsButton.test.tsx b/src/components/SettingsButton/SettingsButton.test.tsx
index 6a6146f..464d3ab 100644
--- a/src/components/SettingsButton/SettingsButton.test.tsx
+++ b/src/components/SettingsButton/SettingsButton.test.tsx
@@ -1,8 +1,9 @@
-import { fireEvent, render } from '@test/helpers/solid'
+import { createResource, createSignal, Show, Suspense } from 'solid-js'
+import { fireEvent, render, renderHook, waitFor } from '@test/helpers/solid'
 import SettingsButton from '.'
 
 describe('SettingsButton', () => {
-  it('renders a button', () => {
+  it('renders a button', async () => {
     const handleClick = vi.fn()
     const r = render(() => <SettingsButton onClick={handleClick} />)
 
@@ -10,9 +11,55 @@ describe('SettingsButton', () => {
 
     expect(button).toBeInTheDocument()
     expect(button).toMatchSnapshot()
+    expect(button).toHaveAttribute('aria-disabled', 'false')
+    expect(button).toHaveAccessibleName('Open settings')
 
     fireEvent.click(button)
 
-    expect(handleClick).toBeCalled()
+    await waitFor(() => {
+      expect(handleClick).toBeCalled()
+    })
+  })
+
+  it('handles deferred resources', async () => {
+    const [isShown, setIsShown] = renderHook(() => createSignal(false)).result
+    const [p, resolve] = deferred<null>()
+    const [resource] = renderHook(() => createResource(async () => await p)).result
+
+    const r = render(() => (
+      <>
+        <SettingsButton onClick={() => setIsShown(true)} />
+        <Show when={isShown()}>
+          <Suspense>
+            <div>{resource()}</div>
+          </Suspense>
+        </Show>
+      </>
+    ))
+
+    const button = r.getByRole('button')
+
+    fireEvent.click(button)
+
+    expect(button).toHaveAttribute('aria-disabled', 'true')
+    expect(button).toHaveAccessibleName('Opening settings')
+
+    resolve(null)
+
+    await waitFor(() => {
+      expect(button).toHaveAttribute('aria-disabled', 'false')
+      expect(button).toHaveAccessibleName('Open settings')
+    })
   })
 })
+
+function deferred<T>(): [p: Promise<T>, resolve: (val: T) => void] {
+  let r: (val: T) => void
+
+  const p = new Promise<T>((resolve) => {
+    r = resolve
+  })
+
+  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+  return [p, r!]
+}
diff --git a/src/components/SettingsButton/__snapshots__/SettingsButton.test.tsx.snap b/src/components/SettingsButton/__snapshots__/SettingsButton.test.tsx.snap
index 3b16e2e..76c38cc 100644
--- a/src/components/SettingsButton/__snapshots__/SettingsButton.test.tsx.snap
+++ b/src/components/SettingsButton/__snapshots__/SettingsButton.test.tsx.snap
@@ -2,6 +2,7 @@
 
 exports[`SettingsButton > renders a button 1`] = `
 <button
+  aria-disabled="false"
   class="button_b7837ym"
   title="Open settings"
   type="button"
diff --git a/src/components/SettingsButton/index.tsx b/src/components/SettingsButton/index.tsx
index dc2d646..11c0bf6 100644
--- a/src/components/SettingsButton/index.tsx
+++ b/src/components/SettingsButton/index.tsx
@@ -1,4 +1,13 @@
-import { type JSX, onCleanup } from 'solid-js'
+import {
+  type Accessor,
+  createComputed,
+  createEffect,
+  createSignal,
+  type JSX,
+  onCleanup,
+  startTransition,
+  untrack,
+} from 'solid-js'
 import { SettingsIcon } from '@/components/Icon'
 import * as css from './styles'
 
@@ -8,31 +17,57 @@ interface SettingsButtonProps {
 
 export default function SettingsButton(props: SettingsButtonProps): JSX.Element {
   let $svg: SVGSVGElement | undefined
-  let animation: Animation | undefined
 
-  onCleanup(() => {
-    animation?.cancel()
-  })
+  const [isLoading, setIsLoading] = createSignal(false)
+
+  createIconAnimation(() => $svg, isLoading)
 
   const handleClick = (): void => {
-    if ($svg != null) {
-      animation ??= animate($svg)
-      animation?.play()
-    }
-    props.onClick?.()
+    if (isLoading()) return
+
+    setIsLoading(true)
+    startTransition(() => props.onClick?.())
+      .catch(() => {})
+      .finally(() => setIsLoading(false))
   }
 
   return (
-    <button class={css.button} type="button" title="Open settings" onClick={handleClick}>
+    <button
+      class={css.button}
+      type="button"
+      aria-disabled={isLoading()}
+      title={isLoading() ? 'Opening settings' : 'Open settings'}
+      onClick={handleClick}
+    >
       <SettingsIcon ref={$svg} aria-hidden class={css.svg} />
     </button>
   )
 }
 
-function animate($el: Element): Animation | undefined {
-  if (typeof $el.animate === 'function')
-    return $el.animate([{ transform: 'rotate(180deg)' }], {
-      duration: 300,
-      easing: 'ease-out',
+function createIconAnimation(svg: Accessor<SVGSVGElement | undefined>, when: Accessor<boolean>): void {
+  const [isRunning, setIsRunning] = createSignal(false)
+
+  createComputed(() => {
+    if (when()) setIsRunning(true)
+  })
+
+  // Wait for animation iteration to finish, then stop
+  createEffect(() => {
+    if (typeof AnimationEvent === 'undefined') return
+
+    const $el = untrack(svg)
+    if ($el == null || !isRunning()) return
+
+    const handleAnimationIteration = (): void => {
+      if (!untrack(when)) setIsRunning(false)
+    }
+
+    $el.addEventListener('animationiteration', handleAnimationIteration)
+    $el.classList.add('is-animated')
+
+    onCleanup(() => {
+      $el.classList.remove('is-animated')
+      $el.removeEventListener('animationiteration', handleAnimationIteration)
     })
+  })
 }
diff --git a/src/components/SettingsButton/styles.ts b/src/components/SettingsButton/styles.ts
index 1d4504f..1e98523 100644
--- a/src/components/SettingsButton/styles.ts
+++ b/src/components/SettingsButton/styles.ts
@@ -13,9 +13,12 @@ export const button = css`
   background: none;
   border: none;
   cursor: pointer;
-  transform: rotate(0deg);
   transition: 0.1s color ease-out;
 
+  &[aria-disabled='true'] {
+    cursor: default;
+  }
+
   &:hover {
     color: ${black};
   }
@@ -38,4 +41,18 @@ export const svg = css`
   .${button}:hover > & {
     transform: rotate(22.5deg);
   }
+
+  &.is-animated {
+    animation: spin 0.3s ease-out infinite forwards;
+  }
+
+  @keyframes spin {
+    0% {
+      transform: rotate(0deg);
+    }
+
+    100% {
+      transform: rotate(360deg);
+    }
+  }
 `
diff --git a/src/components/SettingsDialog/index.tsx b/src/components/SettingsDialog/index.tsx
index da98e93..e05f561 100644
--- a/src/components/SettingsDialog/index.tsx
+++ b/src/components/SettingsDialog/index.tsx
@@ -1,4 +1,4 @@
-import { type JSX, Suspense } from 'solid-js'
+import { type Accessor, type JSX, Suspense } from 'solid-js'
 import { SettingsIcon } from '@/components/Icon'
 import Modal from '@/components/Modal'
 import createSettingsStorage, { type Settings } from '@/hooks/createSettingsStorage'
@@ -20,8 +20,14 @@ export default function SettingsDialog(props: SettingsDialogProps): JSX.Element
   return (
     <Modal icon={<SettingsIcon />} title="Settings" onClose={props.onClose}>
       <Suspense fallback={<span aria-busy>Loading</span>}>
+        {/* Trigger suspense */ read(settings)}
         <SettingsForm initialValues={settings()} onSubmit={handleSubmit} />
       </Suspense>
     </Modal>
   )
 }
+
+function read<T>(v: Accessor<T>): null {
+  v()
+  return null
+}