From bb119d0f8d464d37e440280410f17a16e23e2895 Mon Sep 17 00:00:00 2001
From: userquin <userquin@gmail.com>
Date: Fri, 10 Feb 2023 23:37:09 +0100
Subject: [PATCH] chore: add custom page scroll track

---
 .../notification/NotificationPaginator.vue    | 13 +++++++-
 components/timeline/TimelineMentions.vue      |  2 +-
 components/timeline/TimelineNotifications.vue |  2 +-
 plugins/track-scroll-position.client.ts       | 32 +++++++++++++------
 4 files changed, 36 insertions(+), 13 deletions(-)

diff --git a/components/notification/NotificationPaginator.vue b/components/notification/NotificationPaginator.vue
index 6f7a00e0..e65cd924 100644
--- a/components/notification/NotificationPaginator.vue
+++ b/components/notification/NotificationPaginator.vue
@@ -4,11 +4,14 @@ import { DynamicScrollerItem } from 'vue-virtual-scroller'
 import type { Paginator, WsEvents, mastodon } from 'masto'
 import type { GroupedAccountLike, NotificationSlot } from '~/types'
 
-const { paginator, stream } = defineProps<{
+const { path, paginator, stream } = defineProps<{
+  path: string
   paginator: Paginator<mastodon.v1.Notification[], mastodon.v1.ListNotificationsParams>
   stream?: Promise<WsEvents>
 }>()
 
+const nuxtApp = useNuxtApp()
+
 const virtualScroller = false // TODO: fix flickering issue with virtual scroll
 
 const groupCapacity = Number.MAX_VALUE // No limit
@@ -113,6 +116,10 @@ function groupItems(items: mastodon.v1.Notification[]): NotificationSlot[] {
   // Finalize remaining groups
   processGroup()
 
+  nextTick().then(() => {
+    nuxtApp.$trackScroll.restoreCustomPageScroll()
+  })
+
   return results
 }
 
@@ -146,6 +153,10 @@ function preprocess(items: NotificationSlot[]): NotificationSlot[] {
 
 const { clearNotifications } = useNotifications()
 const { formatNumber } = useHumanReadableNumber()
+
+onMounted(() => {
+  nuxtApp.$trackScroll.registerCustomRoute(path)
+})
 </script>
 
 <template>
diff --git a/components/timeline/TimelineMentions.vue b/components/timeline/TimelineMentions.vue
index f3e4f043..97cf390d 100644
--- a/components/timeline/TimelineMentions.vue
+++ b/components/timeline/TimelineMentions.vue
@@ -8,5 +8,5 @@ onActivated(clearNotifications)
 </script>
 
 <template>
-  <NotificationPaginator v-bind="{ paginator, stream }" />
+  <NotificationPaginator v-bind="{ path: '/notification/mention', paginator, stream }" />
 </template>
diff --git a/components/timeline/TimelineNotifications.vue b/components/timeline/TimelineNotifications.vue
index 480c13b4..98c78be7 100644
--- a/components/timeline/TimelineNotifications.vue
+++ b/components/timeline/TimelineNotifications.vue
@@ -8,5 +8,5 @@ onActivated(clearNotifications)
 </script>
 
 <template>
-  <NotificationPaginator v-bind="{ paginator, stream }" />
+  <NotificationPaginator v-bind="{ path: '/notification', paginator, stream }" />
 </template>
diff --git a/plugins/track-scroll-position.client.ts b/plugins/track-scroll-position.client.ts
index 3bd84a99..6fb00e84 100644
--- a/plugins/track-scroll-position.client.ts
+++ b/plugins/track-scroll-position.client.ts
@@ -4,6 +4,7 @@ export default defineNuxtPlugin((nuxtApp) => {
   const track = ref(false)
   const { y } = useWindowScroll()
   const storage = useLocalStorage<Record<string, number>>('elk-track-scroll', {})
+  const customRoutes = new Set<string>()
 
   router.beforeEach(async () => {
     track.value = false
@@ -17,7 +18,7 @@ export default defineNuxtPlugin((nuxtApp) => {
     window.scrollTo({ top: 0, left: 0, behavior: 'smooth' })
   }
 
-  const restoreScroll = () => {
+  const restoreScrollCallback = (ignoreHook: boolean) => {
     const path = route.fullPath
     return nextTick().then(() => {
       if (route.meta && route.meta?.noScrollTrack) {
@@ -33,6 +34,12 @@ export default defineNuxtPlugin((nuxtApp) => {
           }
 
           if (!route.meta || !route.meta?.noScrollTrack) {
+            const hook = ignoreHook ? undefined : customRoutes.has(route.fullPath)
+            if (hook) {
+              reject(new Error('hook detected'))
+              return
+            }
+
             const scrollPosition = storage.value[route.fullPath]
             if (scrollPosition)
               window.scrollTo(0, scrollPosition)
@@ -47,33 +54,38 @@ export default defineNuxtPlugin((nuxtApp) => {
     })
   }
 
-  nuxtApp.hooks.hook('app:suspense:resolve', () => {
-    if (isHydrated.value) {
-      restoreScroll().then(() => {
-        track.value = true
-      }).catch(noop)
-    }
-  })
+  const restoreScroll = () => restoreScrollCallback(false)
 
-  nuxtApp.hooks.hook('page:finish', () => {
+  const restoreScrollHook = () => {
     if (isHydrated.value) {
       restoreScroll().then(() => {
         track.value = true
       }).catch(noop)
     }
-  })
+  }
+
+  const restoreCustomPageScroll = () => restoreScrollCallback(true)
+
+  nuxtApp.hooks.hook('app:suspense:resolve', restoreScrollHook)
+  nuxtApp.hooks.hook('page:finish', restoreScrollHook)
 
   watch([track, y, () => route], ([trackEnabled, scrollPosition, r]) => {
     if (trackEnabled && (!r.meta || !r.meta?.noScrollTrack))
       storage.value[r.fullPath] = Math.floor(scrollPosition)
   }, { immediate: true, flush: 'pre' })
 
+  const registerCustomRoute = (path: string) => {
+    customRoutes.add(path)
+  }
+
   return {
     provide: {
       trackScroll: reactive({
         forceScroll,
         restoreScroll,
         track,
+        registerCustomRoute,
+        restoreCustomPageScroll,
       }),
     },
   }