From b64dca110e21958ba64e1ac340e6a8e95747c83d Mon Sep 17 00:00:00 2001
From: tbitw2549 <yonshi29@gmail.com>
Date: Tue, 13 Aug 2024 19:18:03 +0300
Subject: [PATCH] refactor: use vue native hydration strategies

---
 docs/3.api/3.utils/create-idle-loader.md      |  6 +-
 packages/nuxt/src/app/composables/hydrate.ts  |  4 +-
 .../runtime/client-delayed-component.ts       | 98 ++++---------------
 3 files changed, 24 insertions(+), 84 deletions(-)

diff --git a/docs/3.api/3.utils/create-idle-loader.md b/docs/3.api/3.utils/create-idle-loader.md
index ca17db26f..5c7a269a9 100644
--- a/docs/3.api/3.utils/create-idle-loader.md
+++ b/docs/3.api/3.utils/create-idle-loader.md
@@ -12,7 +12,7 @@ You can use this utility to customize the timeout of delayed hydration component
 
 ## Parameters
 
-- `options`: `{ timeout }`
+- `timeout` : `number`
 
 ## Example
 
@@ -21,7 +21,7 @@ If you would like to give a timeout of 5 seconds for the components:
 ```vue [pages/index.vue]
 <template>
   <div>
-    <LazyIdleMyComponent :hydrate="createIdleLoader({timeout: 3000})"/>
+    <LazyIdleMyComponent :hydrate="createIdleLoader(5000)"/>
   </div>
 <template>
 ```
@@ -29,5 +29,5 @@ If you would like to give a timeout of 5 seconds for the components:
 ::
 
 ::read-more{to="https://developer.mozilla.org/en-US/docs/Web/API/Window/requestIdleCallback"}
-This is based on the `requestIdleCallback` web API, and therefore only accepts the timeout prop, which should be a number.
+This is based on the `requestIdleCallback` web API, and therefore only accepts the time in milliseconds for the max idle callback duration, which should be a number.
 ::
diff --git a/packages/nuxt/src/app/composables/hydrate.ts b/packages/nuxt/src/app/composables/hydrate.ts
index 5c789fe3e..fc4712b84 100644
--- a/packages/nuxt/src/app/composables/hydrate.ts
+++ b/packages/nuxt/src/app/composables/hydrate.ts
@@ -26,9 +26,9 @@ export const useHydration = <K extends keyof NuxtPayload, T = NuxtPayload[K]> (k
 
 /**
  * A `requestIdleCallback` options utility, used to determine custom timeout for idle-callback based delayed hydration.
- * @param opts the options object, containing the wanted timeout
+ * @param timeout the max timeout for the idle callback, in milliseconds
  */
-export const createIdleLoader = (opts: IdleRequestOptions) => opts
+export const createIdleLoader = (timeout: number) => timeout
 
 /**
  * An `IntersectionObserver` options utility, used to determine custom viewport-based delayed hydration behavior.
diff --git a/packages/nuxt/src/components/runtime/client-delayed-component.ts b/packages/nuxt/src/components/runtime/client-delayed-component.ts
index b670f5972..10dcf23aa 100644
--- a/packages/nuxt/src/components/runtime/client-delayed-component.ts
+++ b/packages/nuxt/src/components/runtime/client-delayed-component.ts
@@ -1,11 +1,7 @@
-import { createStaticVNode, defineComponent, getCurrentInstance, h, onBeforeUnmount, onMounted, ref } from 'vue'
-import type { Component, ComponentInternalInstance, Ref } from 'vue'
+import { defineAsyncComponent, defineComponent, getCurrentInstance, h, hydrateOnIdle, hydrateOnInteraction, hydrateOnVisible } from 'vue'
+import type { AsyncComponentLoader } from 'vue'
 // import ClientOnly from '#app/components/client-only'
-import { getFragmentHTML } from '#app/components/utils'
 import { useNuxtApp } from '#app/nuxt'
-import { cancelIdleCallback, requestIdleCallback } from '#app/compat/idle-callback'
-import { onNuxtReady } from '#app'
-import { useIntersectionObserver } from '#app/utils'
 
 function elementIsVisibleInViewport (el: Element) {
   const { top, left, bottom, right } = el.getBoundingClientRect()
@@ -16,7 +12,7 @@ function elementIsVisibleInViewport (el: Element) {
 }
 
 /* @__NO_SIDE_EFFECTS__ */
-export const createLazyIOComponent = (componentLoader: Component) => {
+export const createLazyIOComponent = (componentLoader: AsyncComponentLoader) => {
   return defineComponent({
     inheritAttrs: false,
     setup (_, { attrs }) {
@@ -26,104 +22,48 @@ export const createLazyIOComponent = (componentLoader: Component) => {
 
       const nuxt = useNuxtApp()
       const instance = getCurrentInstance()!
-      const hasIntersected = ref(false)
-      const el: Ref<Element | null> = ref(null)
-      let unobserve: (() => void) | null = null
 
-      // todo can be refactored
-      if (instance.vnode.el && nuxt.isHydrating) {
-        hasIntersected.value = elementIsVisibleInViewport(instance.vnode.el as Element)
+      if (instance.vnode.el && nuxt.isHydrating && elementIsVisibleInViewport(instance.vnode.el as Element)) {
+        return h(componentLoader, attrs)
       }
 
-      if (!hasIntersected.value) {
-        onMounted(() => {
-          const observer = useIntersectionObserver(attrs.hydrate as Partial<IntersectionObserverInit> | undefined)
-          unobserve = observer!.observe(el.value as Element, () => {
-            hasIntersected.value = true
-            unobserve?.()
-            unobserve = null
-          })
-        })
-      }
-      onBeforeUnmount(() => {
-        unobserve?.()
-        unobserve = null
-      })
-      return () => {
-        return h('div', { ref: el }, [
-          hasIntersected.value ? h(componentLoader, attrs) : (instance.vnode.el && nuxt.isHydrating) ? createStaticVNode(getFragmentHTML(instance.vnode.el ?? null, true)?.join('') || '', 1) : null,
-        ])
-      }
+      return () => h(defineAsyncComponent({
+        loader: componentLoader,
+        hydrate: hydrateOnVisible(attrs.hydrate as IntersectionObserverInit | undefined),
+      }))
     },
   })
 }
 
 /* @__NO_SIDE_EFFECTS__ */
-export const createLazyNetworkComponent = (componentLoader: Component) => {
+export const createLazyNetworkComponent = (componentLoader: AsyncComponentLoader) => {
   return defineComponent({
     inheritAttrs: false,
     setup (_, { attrs }) {
       if (import.meta.server) {
         return () => h(componentLoader, attrs)
       }
-      const nuxt = useNuxtApp()
-      const instance = getCurrentInstance()!
-      const isIdle = ref(false)
-      let idleHandle: number | null = null
-      onMounted(() => {
-        onNuxtReady(() => {
-          idleHandle = requestIdleCallback(() => {
-            isIdle.value = true
-            cancelIdleCallback(idleHandle as unknown as number)
-            idleHandle = null
-          }, attrs.hydrate ?? { timeout: 10000 })
-        })
+      return () => defineAsyncComponent({
+        loader: componentLoader,
+        hydrate: hydrateOnIdle(attrs.hydrate as number | undefined),
       })
-      onBeforeUnmount(() => {
-        if (idleHandle) {
-          cancelIdleCallback(idleHandle as unknown as number)
-          idleHandle = null
-        }
-      })
-      return () => isIdle.value ? h(componentLoader, attrs) : (instance.vnode.el && nuxt.isHydrating) ? createStaticVNode(getFragmentHTML(instance.vnode.el ?? null, true)?.join('') || '', 1) : null
     },
   })
 }
 
-const eventsMapper = new WeakMap<ComponentInternalInstance, (() => void)[]>()
 /* @__NO_SIDE_EFFECTS__ */
-export const createLazyEventComponent = (componentLoader: Component) => {
+export const createLazyEventComponent = (componentLoader: AsyncComponentLoader) => {
   return defineComponent({
     inheritAttrs: false,
     setup (_, { attrs }) {
       if (import.meta.server) {
         return () => h(componentLoader, attrs)
       }
-      const nuxt = useNuxtApp()
-      const instance = getCurrentInstance()!
-      const isTriggered = ref(false)
-      const events: string[] = attrs.hydrate as string[] ?? ['mouseover']
-
-      const registeredEvents: (() => void)[] = []
-      if (!eventsMapper.has(instance)) {
-        onMounted(() => {
-          events.forEach((event) => {
-            const handler = () => {
-              isTriggered.value = true
-              registeredEvents.forEach(remove => remove())
-              eventsMapper.delete(instance)
-            }
-            instance.vnode.el?.addEventListener(event, handler)
-            registeredEvents.push(() => instance.vnode.el?.removeEventListener(event, handler))
-          })
-          eventsMapper.set(instance, registeredEvents)
-        })
-      }
-      onBeforeUnmount(() => {
-        registeredEvents?.forEach(remove => remove())
-        eventsMapper.delete(instance)
-      })
-      return () => isTriggered.value ? h(componentLoader, attrs) : (instance.vnode.el && nuxt.isHydrating) ? createStaticVNode(getFragmentHTML(instance.vnode.el ?? null, true)?.join('') || '', 1) : null
+      const events: Array<keyof HTMLElementEventMap> = attrs.hydrate as Array<keyof HTMLElementEventMap> ?? ['mouseover']
+      return () => h(defineAsyncComponent({
+        loader: componentLoader,
+        hydrate: hydrateOnInteraction(events),
+      }))
     },
   })
 }