refs #3301 Rewrite TimelineSpace/Contents/Local with composition API

src/renderer/components/TimelineSpace/Contents/Local.vue

@@ -29,239 +29,234 @@
   </div>
 </template>
 
-<script>
+<script lang="ts">
-import { mapState, mapGetters } from 'vuex'
+import { computed, defineComponent, onBeforeUnmount, onBeforeUpdate, onMounted, onUnmounted, ref, watch } from 'vue'
 import moment from 'moment'
-import Toot from '~/src/renderer/components/organisms/Toot'
+import { ElMessage } from 'element-plus'
-import { EventEmitter } from '~/src/renderer/components/event'
+import { Entity } from 'megalodon'
-import { ScrollPosition } from '~/src/renderer/components/utils/scroll'
+import { useI18next } from 'vue3-i18next'
+import { useRoute } from 'vue-router'
+import { useStore } from '@/store'
+import Toot from '@/components/organisms/Toot.vue'
+import { EventEmitter } from '@/components/event'
+import { ScrollPosition } from '@/components/utils/scroll'
+import useReloadable from '@/components/utils/reloadable'
+import { ACTION_TYPES, MUTATION_TYPES } from '@/store/TimelineSpace/Contents/Local'
+import { MUTATION_TYPES as SIDE_MENU_MUTATION } from '@/store/TimelineSpace/SideMenu'
+import { MUTATION_TYPES as TIMELINE_MUTATION, ACTION_TYPES as TIMELINE_ACTION } from '@/store/TimelineSpace'
+import { MUTATION_TYPES as HEADER_MUTATION } from '@/store/TimelineSpace/HeaderMenu'
+import { MUTATION_TYPES as CONTENTS_MUTATION } from '@/store/TimelineSpace/Contents'
 
-export default {
+export default defineComponent({
-  data() {
-    return {
-      focusedId: null,
-      scrollPosition: null,
-      observer: null,
-      scrollTime: null,
-      resizeTime: null
-    }
-  },
   name: 'local',
   components: { Toot },
-  computed: {
+  setup() {
-    ...mapState('TimelineSpace/Contents/Local', {
+    const space = 'TimelineSpace/Contents/Local'
-      timeline: state => state.timeline,
+    const store = useStore()
-      lazyLoading: state => state.lazyLoading,
+    const route = useRoute()
-      heading: state => state.heading,
+    const i18n = useI18next()
-      scrolling: state => state.scrolling
+    const { reloadable } = useReloadable(store, route, i18n)
-    }),
-    ...mapState({
-      openSideBar: state => state.TimelineSpace.Contents.SideBar.openSideBar,
-      backgroundColor: state => state.App.theme.background_color,
-      startReload: state => state.TimelineSpace.HeaderMenu.reload,
-      unreadNotification: state => state.TimelineSpace.timelineSetting.unreadNotification
-    }),
-    ...mapGetters('TimelineSpace/Modals', ['modalOpened']),
-    shortcutEnabled: function () {
-      if (this.modalOpened) {
-        return false
-      }
-      if (!this.focusedId) {
-        return true
-      }
-      // Sometimes toots are deleted, so perhaps focused toot don't exist.
-      const currentIndex = this.timeline.findIndex(toot => this.focusedId === toot.uri + toot.id)
-      return currentIndex === -1
-    }
-  },
-  async mounted() {
-    console.log(this.unreadNotification)
-    this.$store.commit('TimelineSpace/SideMenu/changeUnreadLocalTimeline', false)
-    document.getElementById('scroller').addEventListener('scroll', this.onScroll)
-    if (!this.unreadNotification.local) {
-      this.$store.commit('TimelineSpace/Contents/changeLoading', true)
-      await this.initialize().finally(_ => {
-        this.$store.commit('TimelineSpace/Contents/changeLoading', false)
-      })
-    }
 
-    EventEmitter.on('focus-timeline', () => {
+    const focusedId = ref<string | null>(null)
-      // If focusedId does not change, we have to refresh focusedId because Toot component watch change events.
+    const scrollPosition = ref<ScrollPosition | null>(null)
-      const previousFocusedId = this.focusedId
+    const observer = ref<ResizeObserver | null>(null)
-      this.focusedId = 0
+    const scrollTime = ref<moment.Moment | null>(null)
-      this.$nextTick(function () {
+    const resizeTime = ref<moment.Moment | null>(null)
-        this.focusedId = previousFocusedId
+    const scroller = ref<any>(null)
-      })
-    })
-    const el = document.getElementById('scroller')
-    this.scrollPosition = new ScrollPosition(el)
-    this.scrollPosition.prepare()
 
-    this.observer = new ResizeObserver(() => {
+    const timeline = computed(() => store.state.TimelineSpace.Contents.Local.timeline)
-      if (this.scrollPosition && !this.heading && !this.lazyLoading && !this.scrolling) {
+    const lazyLoading = computed(() => store.state.TimelineSpace.Contents.Local.lazyLoading)
-        this.resizeTime = moment()
+    const heading = computed(() => store.state.TimelineSpace.Contents.Local.heading)
-        this.scrollPosition.restore()
+    const scrolling = computed(() => store.state.TimelineSpace.Contents.Local.scrolling)
-      }
+    const openSideBar = computed(() => store.state.TimelineSpace.Contents.SideBar.openSideBar)
-    })
+    const startReload = computed(() => store.state.TimelineSpace.HeaderMenu.reload)
+    const unreadNotification = computed(() => store.state.TimelineSpace.timelineSetting.unreadNotification)
+    const modalOpened = computed(() => store.getters[`TimelineSpace/Modals/modalOpened`])
+    const currentFocusedIndex = computed(() => timeline.value.findIndex(toot => focusedId.value === toot.uri + toot.id))
 
-    const scrollWrapper = el.getElementsByClassName('vue-recycle-scroller__item-wrapper')[0]
+    onMounted(async () => {
-    this.observer.observe(scrollWrapper)
+      store.commit(`TimelineSpace/SideMenu/${SIDE_MENU_MUTATION.CHANGE_UNREAD_LOCAL_TIMELINE}`, false)
-  },
+      document.getElementById('scroller')?.addEventListener('scroll', onScroll)
-  beforeUpdate() {
+      if (!unreadNotification.value.local) {
-    if (this.$store.state.TimelineSpace.SideMenu.unreadLocalTimeline && this.heading) {
+        store.commit(`TimelineSpace/Contents/${CONTENTS_MUTATION.CHANGE_LOADING}`, true)
-      this.$store.commit('TimelineSpace/SideMenu/changeUnreadLocalTimeline', false)
+        await initialize().finally(() => {
-    }
+          store.commit(`TimelineSpace/Contents/${CONTENTS_MUTATION.CHANGE_LOADING}`, false)
-    if (this.scrollPosition) {
-      this.scrollPosition.prepare()
-    }
-  },
-  beforeUnmount() {
-    if (!this.unreadNotification.local) {
-      this.$store.dispatch('TimelineSpace/stopLocalStreaming')
-      this.$store.dispatch('TimelineSpace/unbindLocalStreaming')
-    }
-    EventEmitter.off('focus-timeline')
-    this.observer.disconnect()
-  },
-  unmounted() {
-    this.$store.commit('TimelineSpace/Contents/Local/changeHeading', true)
-    this.$store.commit('TimelineSpace/Contents/Local/archiveTimeline')
-    if (!this.unreadNotification.local) {
-      this.$store.commit('TimelineSpace/Contents/Local/clearTimeline')
-    }
-    if (document.getElementById('scroller') !== undefined && document.getElementById('scroller') !== null) {
-      document.getElementById('scroller').removeEventListener('scroll', this.onScroll)
-      document.getElementById('scroller').scrollTop = 0
-    }
-  },
-  watch: {
-    startReload: function (newState, oldState) {
-      if (!oldState && newState) {
-        this.reload().finally(() => {
-          this.$store.commit('TimelineSpace/HeaderMenu/changeReload', false)
         })
       }
-    },
+
-    focusedId: function (newState, _oldState) {
+      const el = document.getElementById('scroller')
-      if (newState && this.heading) {
+      if (el) {
-        this.$store.commit('TimelineSpace/Contents/Local/changeHeading', false)
+        scrollPosition.value = new ScrollPosition(el)
-      } else if (newState === null && !this.heading) {
+        scrollPosition.value.prepare()
-        this.$store.commit('TimelineSpace/Contents/Local/changeHeading', true)
+
+        observer.value = new ResizeObserver(() => {
+          if (scrollPosition.value && !heading.value && !lazyLoading.value && !scrolling.value) {
+            resizeTime.value = moment()
+            scrollPosition.value?.restore()
+          }
+        })
+
+        const scrollWrapper = el.getElementsByClassName('vue-recycle-scroller__item-wrapper')[0]
+        observer.value.observe(scrollWrapper)
       }
-    }
+    })
-  },
+    onBeforeUpdate(() => {
-  methods: {
+      if (store.state.TimelineSpace.SideMenu.unreadLocalTimeline && heading.value) {
-    async initialize() {
+        store.commit(`TimelineSpace/SideMenu/${SIDE_MENU_MUTATION.CHANGE_UNREAD_LOCAL_TIMELINE}`, false)
-      await this.$store.dispatch('TimelineSpace/Contents/Local/fetchLocalTimeline').catch(_ => {
+      }
-        this.$message({
+      if (scrollPosition.value) {
-          message: this.$t('message.timeline_fetch_error'),
+        scrollPosition.value.prepare()
+      }
+    })
+    onBeforeUnmount(() => {
+      if (!unreadNotification.value.local) {
+        store.dispatch(`TimelineSpace/${TIMELINE_ACTION.STOP_LOCAL_STREAMING}`)
+        store.dispatch(`TimelineSpace/${TIMELINE_ACTION.UNBIND_LOCAL_STREAMING}`)
+      }
+      EventEmitter.off('focus-timeline')
+      observer.value?.disconnect()
+    })
+    onUnmounted(() => {
+      store.commit(`${space}/${MUTATION_TYPES.CHANGE_HEADING}`, true)
+      store.commit(`${space}/${MUTATION_TYPES.ARCHIVE_TIMELINE}`)
+      if (!unreadNotification.value.local) {
+        store.commit(`${space}/${MUTATION_TYPES.CLEAR_TIMELINE}`)
+      }
+      const el = document.getElementById('scroller')
+      if (el) {
+        el.removeEventListener('scroll', onScroll)
+        el.scrollTop = 0
+      }
+    })
+    watch(startReload, (newVal, oldVal) => {
+      if (!oldVal && newVal) {
+        reload().finally(() => {
+          store.commit(`TimelineSpace/HeaderMenu/${HEADER_MUTATION.CHANGE_RELOAD}`, false)
+        })
+      }
+    })
+
+    const initialize = async () => {
+      await store.dispatch(`${space}/${ACTION_TYPES.FETCH_LOCAL_TIMELINE}`).catch(_ => {
+        ElMessage({
+          message: i18n.t('message.timeline_fetch_error'),
           type: 'error'
         })
       })
-      await this.$store.dispatch('TimelineSpace/bindLocalStreaming')
+      await store.dispatch(`TimelineSpace/${TIMELINE_ACTION.BIND_LOCAL_STREAMING}`)
-      this.$store.dispatch('TimelineSpace/startLocalStreaming')
+      store.dispatch(`TimelineSpace/${TIMELINE_ACTION.START_LOCAL_STREAMING}`)
-    },
+    }
-    updateToot(message) {
+    const onScroll = (event: Event) => {
-      this.$store.commit('TimelineSpace/Contents/Local/updateToot', message)
+      if (moment().diff(resizeTime.value) < 500) {
-    },
-    deleteToot(message) {
-      this.$store.commit('TimelineSpace/Contents/Local/deleteToot', message.id)
-    },
-    onScroll(event) {
-      if (moment().diff(this.resizeTime) < 500) {
         return
       }
-      this.scrollTime = moment()
+      scrollTime.value = moment()
-      if (!this.scrolling) {
+      if (!scrolling.value) {
-        this.$store.commit('TimelineSpace/Contents/Local/changeScrolling', true)
+        store.commit(`${space}/${MUTATION_TYPES.CHANGE_SCROLLING}`, true)
       }
 
       if (
-        event.target.clientHeight + event.target.scrollTop >= document.getElementById('scroller').scrollHeight - 10 &&
+        (event.target as HTMLElement)!.clientHeight + (event.target as HTMLElement)!.scrollTop >=
-        !this.lazyloading
+          document.getElementById('scroller')!.scrollHeight - 10 &&
+        !lazyLoading.value
       ) {
-        this.$store
+        store
-          .dispatch('TimelineSpace/Contents/Local/lazyFetchTimeline', this.timeline[this.timeline.length - 1])
+          .dispatch(`${space}/${ACTION_TYPES.LAZY_FETCH_TIMELINE}`, timeline.value[timeline.value.length - 1])
           .then(statuses => {
             if (statuses === null) {
               return
             }
             if (statuses.length > 0) {
-              this.$store.commit('TimelineSpace/Contents/Local/changeScrolling', true)
+              store.commit(`${space}/${MUTATION_TYPES.CHANGE_SCROLLING}`, true)
               setTimeout(() => {
-                this.$store.commit('TimelineSpace/Contents/Local/changeScrolling', false)
+                store.commit(`${space}/${MUTATION_TYPES.CHANGE_SCROLLING}`, false)
               }, 500)
             }
           })
           .catch(() => {
-            this.$message({
+            ElMessage({
-              message: this.$t('message.timeline_fetch_error'),
+              message: i18n.t('message.timeline_fetch_error'),
               type: 'error'
             })
           })
       }
-      if (event.target.scrollTop > 10 && this.heading) {
+      if ((event.target as HTMLElement)!.scrollTop > 10 && heading.value) {
-        this.$store.commit('TimelineSpace/Contents/Local/changeHeading', false)
+        store.commit(`${space}/${MUTATION_TYPES.CHANGE_HEADING}`, false)
-      } else if (event.target.scrollTop <= 10 && !this.heading) {
+      } else if ((event.target as HTMLElement)!.scrollTop <= 10 && !heading.value) {
-        this.$store.commit('TimelineSpace/Contents/Local/changeHeading', true)
+        store.commit(`${space}/${MUTATION_TYPES.CHANGE_HEADING}`, true)
       }
 
       setTimeout(() => {
         const now = moment()
-        if (now.diff(this.scrollTime) >= 150) {
+        if (now.diff(scrollTime.value) >= 150) {
-          this.scrollTime = null
+          scrollTime.value = null
-          this.$store.commit('TimelineSpace/Contents/Local/changeScrolling', false)
+          store.commit(`${space}/${MUTATION_TYPES.CHANGE_SCROLLING}`, false)
         }
       }, 150)
-    },
+    }
-    async reload() {
+    const reload = async () => {
-      this.$store.commit('TimelineSpace/changeLoading', true)
+      store.commit(`TimelineSpace/${TIMELINE_MUTATION.CHANGE_LOADING}`, true)
       try {
+        await reloadable()
       } finally {
-        this.$store.commit('TimelineSpace/changeLoading', false)
+        store.commit(`TimelineSpace/${TIMELINE_MUTATION.CHANGE_LOADING}`, false)
       }
-    },
+    }
-    upper() {
+    const updateToot = (message: Entity.Status) => {
-      this.$refs.scroller.scrollToItem(0)
+      store.commit(`${space}/${MUTATION_TYPES.UPDATE_TOOT}`, message)
-      this.focusedId = null
+    }
-    },
+    const deleteToot = (message: Entity.Status) => {
-    focusNext() {
+      store.commit(`${space}/${MUTATION_TYPES.DELETE_TOOT}`, message.id)
-      const currentIndex = this.timeline.findIndex(toot => this.focusedId === toot.uri + toot.id)
+    }
-      if (currentIndex === -1) {
+    const upper = () => {
-        this.focusedId = this.timeline[0].uri + this.timeline[0].id
+      scroller.value.scrollToItem(0)
-      } else if (currentIndex < this.timeline.length) {
+      focusedId.value = null
-        this.focusedId = this.timeline[currentIndex + 1].uri + this.timeline[currentIndex + 1].id
+    }
+    const focusNext = () => {
+      if (currentFocusedIndex.value === -1) {
+        focusedId.value = timeline.value[0].uri + timeline.value[0].id
+      } else if (currentFocusedIndex.value < timeline.value.length) {
+        focusedId.value = timeline.value[currentFocusedIndex.value + 1].uri + timeline.value[currentFocusedIndex.value + 1].id
       }
-    },
+    }
-    focusPrev() {
+    const focusPrev = () => {
-      const currentIndex = this.timeline.findIndex(toot => this.focusedId === toot.uri + toot.id)
+      if (currentFocusedIndex.value === 0) {
-      if (currentIndex === 0) {
+        focusedId.value = null
-        this.focusedId = null
+      } else if (currentFocusedIndex.value > 0) {
-      } else if (currentIndex > 0) {
+        focusedId.value = timeline.value[currentFocusedIndex.value - 1].uri + timeline.value[currentFocusedIndex.value - 1].id
-        this.focusedId = this.timeline[currentIndex - 1].uri + this.timeline[currentIndex - 1].id
       }
-    },
+    }
-    focusToot(message) {
+    const focusToot = (message: Entity.Status) => {
-      this.focusedId = message.uri + message.id
+      focusedId.value = message.uri + message.id
-    },
+    }
-    focusSidebar() {
+    const focusSidebar = () => {
       EventEmitter.emit('focus-sidebar')
-    },
+    }
-    handleKey(event) {
+    const sizeChanged = () => {
-      switch (event.srcKey) {
+      store.commit(`${space}/${MUTATION_TYPES.CHANGE_SCROLLING}`, true)
-        case 'next':
-          this.focusedId = this.timeline[0].uri + this.timeline[0].id
-          break
-      }
-    },
-    sizeChanged() {
-      this.$store.commit('TimelineSpace/Contents/Local/changeScrolling', true)
       setTimeout(() => {
-        this.$store.commit('TimelineSpace/Contents/Local/changeScrolling', false)
+        store.commit(`${space}/${MUTATION_TYPES.CHANGE_SCROLLING}`, false)
       }, 500)
     }
+
+    return {
+      scroller,
+      timeline,
+      focusedId,
+      modalOpened,
+      updateToot,
+      deleteToot,
+      focusNext,
+      focusPrev,
+      focusSidebar,
+      focusToot,
+      sizeChanged,
+      openSideBar,
+      heading,
+      upper
+    }
   }
-}
+})
 </script>
 
 <style lang="scss" scoped>

src/renderer/store/TimelineSpace/Contents/Local.ts

@@ -84,8 +84,13 @@ const mutations: MutationTree<LocalState> = {
   }
 }
 
+export const ACTION_TYPES = {
+  FETCH_LOCAL_TIMELINE: 'fetchLocalTimeline',
+  LAZY_FETCH_TIMELINE: 'lazyFetchTimeline'
+}
+
 const actions: ActionTree<LocalState, RootState> = {
-  fetchLocalTimeline: async ({ dispatch, commit, rootState }): Promise<Array<Entity.Status>> => {
+  [ACTION_TYPES.FETCH_LOCAL_TIMELINE]: async ({ dispatch, commit, rootState }): Promise<Array<Entity.Status>> => {
     const client = generator(
       rootState.TimelineSpace.sns,
       rootState.TimelineSpace.account.baseURL,
@@ -103,7 +108,10 @@ const actions: ActionTree<LocalState, RootState> = {
       return []
     }
   },
-  lazyFetchTimeline: async ({ state, commit, rootState }, lastStatus: Entity.Status): Promise<Array<Entity.Status> | null> => {
+  [ACTION_TYPES.LAZY_FETCH_TIMELINE]: async (
+    { state, commit, rootState },
+    lastStatus: Entity.Status
+  ): Promise<Array<Entity.Status> | null> => {
     if (state.lazyLoading) {
       return Promise.resolve(null)
     }