test: unit tests for useSideBar

owncloud · Aug 31, 2022 · 9c106b3 · 9c106b3
1 parent 8a3d049
commit 9c106b3
Show file tree

Hide file tree

Showing 21 changed files with 181 additions and 40 deletions.
diff --git a/packages/web-app-files/src/components/AppBar/SidebarToggle.vue b/packages/web-app-files/src/components/AppBar/SidebarToggle.vue
@@ -13,6 +13,7 @@
 
 <script>
 import { bus } from 'web-pkg/src/instance'
+import { SideBarEventTopics } from '../../composables/sidebar'
 
 export default {
   props: {
@@ -33,7 +34,7 @@ export default {
   },
   methods: {
     toggleSideBar() {
-      bus.publish('app.files.sidebar.toggle')
+      bus.publish(SideBarEventTopics.toggle)
     }
   }
 }

diff --git a/packages/web-app-files/src/components/FilesList/ResourceTable.vue b/packages/web-app-files/src/components/FilesList/ResourceTable.vue
@@ -190,6 +190,7 @@ import { ClipboardActions } from '../../helpers/clipboardActions'
 import { ShareTypes } from 'web-client/src/helpers/share'
 import { createLocationSpaces } from '../../router'
 import { formatDateFromJSDate, formatRelativeDateFromJSDate } from 'web-pkg/src/helpers'
+import { SideBarEventTopics } from '../../composables/sidebar'
 
 const mapResourceFields = (resource: Resource, mapping = {}) => {
   return Object.keys(mapping).reduce((result, resourceKey) => {
@@ -583,10 +584,10 @@ export default defineComponent({
     },
     openSharingSidebar(file) {
       if (file.share?.shareType === ShareTypes.link.value) {
-        bus.publish('app.files.sidebar.openWithPanel', 'sharing-item#linkShares')
+        bus.publish(SideBarEventTopics.openWithPanel, 'sharing-item#linkShares')
         return
       }
-      bus.publish('app.files.sidebar.openWithPanel', 'sharing-item#peopleShares')
+      bus.publish(SideBarEventTopics.openWithPanel, 'sharing-item#peopleShares')
     },
     folderLink(file) {
       return this.createFolderLink(file.path, file)

diff --git a/packages/web-app-files/src/components/SideBar/Details/FileDetails.vue b/packages/web-app-files/src/components/SideBar/Details/FileDetails.vue
@@ -166,6 +166,7 @@ import copyToClipboard from 'copy-to-clipboard'
 import { encodePath } from 'web-pkg/src/utils'
 import { formatDateFromHTTP, formatFileSize } from 'web-pkg/src/helpers'
 import { bus } from 'web-pkg/src/instance'
+import { SideBarEventTopics } from '../../../composables/sidebar'
 
 export default defineComponent({
   name: 'FileDetails',
@@ -429,7 +430,7 @@ export default defineComponent({
       return null
     },
     expandVersionsPanel() {
-      bus.publish('app.files.sidebar.setActivePanel', 'versions-item')
+      bus.publish(SideBarEventTopics.setActivePanel, 'versions-item')
     },
     async loadData() {
       const calls = []

diff --git a/packages/web-app-files/src/components/SideBar/Details/SpaceDetails.vue b/packages/web-app-files/src/components/SideBar/Details/SpaceDetails.vue
@@ -77,6 +77,7 @@ import SpaceQuota from '../../SpaceQuota.vue'
 import { formatDateFromISO } from 'web-pkg/src/helpers'
 import { configurationManager } from 'web-pkg/src/configuration'
 import { bus } from 'web-pkg/src/instance'
+import { SideBarEventTopics } from '../../../composables/sidebar'
 
 export default defineComponent({
   name: 'SpaceDetails',
@@ -249,7 +250,7 @@ export default defineComponent({
   },
   methods: {
     expandSharesPanel() {
-      bus.publish('app.files.sidebar.setActivePanel', 'space-share-item')
+      bus.publish(SideBarEventTopics.setActivePanel, 'space-share-item')
     }
   }
 })

diff --git a/packages/web-app-files/src/components/SideBar/SideBar.vue b/packages/web-app-files/src/components/SideBar/SideBar.vue
@@ -52,6 +52,7 @@ import {
   useStore
 } from 'web-pkg/src/composables'
 import { bus } from 'web-pkg/src/instance'
+import { SideBarEventTopics } from '../../composables/sidebar'
 
 export default defineComponent({
   components: { FileInfo, SpaceInfo, SideBar },
@@ -78,10 +79,10 @@ export default defineComponent({
     const store = useStore()
 
     const closeSideBar = () => {
-      bus.publish('app.files.sidebar.close')
+      bus.publish(SideBarEventTopics.close)
     }
     const setActiveSideBarPanel = (panelName) => {
-      bus.publish('app.files.sidebar.setActivePanel', panelName)
+      bus.publish(SideBarEventTopics.setActivePanel, panelName)
     }
 
     const focusSideBar = (component, event) => {
@@ -94,7 +95,7 @@ export default defineComponent({
 
     const destroySideBar = (component, event) => {
       focusSideBar(component, event)
-      bus.publish('app.files.sidebar.close')
+      bus.publish(SideBarEventTopics.close)
     }
 
     return {

diff --git a/packages/web-app-files/src/composables/sidebar/eventTopics.ts b/packages/web-app-files/src/composables/sidebar/eventTopics.ts
@@ -0,0 +1,7 @@
+export abstract class SideBarEventTopics {
+  public static readonly open = 'app.files.sidebar.open'
+  public static readonly close = 'app.files.sidebar.close'
+  public static readonly toggle = 'app.files.sidebar.toggle'
+  public static readonly openWithPanel = 'app.files.sidebar.openWithPanel'
+  public static readonly setActivePanel = 'app.files.sidebar.setActivePanel'
+}
diff --git a/packages/web-app-files/src/composables/sidebar/index.ts b/packages/web-app-files/src/composables/sidebar/index.ts
@@ -1 +1,2 @@
+export * from './eventTopics'
 export * from './useSideBar'
diff --git a/packages/web-app-files/src/composables/sidebar/useSideBar.ts b/packages/web-app-files/src/composables/sidebar/useSideBar.ts
@@ -1,44 +1,51 @@
 import { onBeforeUnmount, ref, Ref, unref } from '@vue/composition-api'
 import { bus } from 'web-pkg/src/instance'
+import { EventBus } from 'web-pkg/src/event'
+import { SideBarEventTopics } from './eventTopics'
 
 interface SideBarResult {
   sideBarOpen: Ref<boolean>
   sideBarActivePanel: Ref<string>
 }
 
-export const useSideBar = (): SideBarResult => {
+interface SideBarOptions {
+  bus?: EventBus
+}
+
+export const useSideBar = (options?: SideBarOptions): SideBarResult => {
+  const eventBus = options?.bus || bus
   const sideBarOpen = ref(false)
   const sideBarActivePanel = ref(null)
-  const toggleSideBarToken = bus.subscribe('app.files.sidebar.toggle', () => {
+  const toggleSideBarToken = eventBus.subscribe(SideBarEventTopics.toggle, () => {
     sideBarOpen.value = !unref(sideBarOpen)
   })
-  const closeSideBarToken = bus.subscribe('app.files.sidebar.close', () => {
+  const closeSideBarToken = eventBus.subscribe(SideBarEventTopics.close, () => {
     sideBarOpen.value = false
     sideBarActivePanel.value = null
   })
-  const openSideBarToken = bus.subscribe('app.files.sidebar.open', () => {
+  const openSideBarToken = eventBus.subscribe(SideBarEventTopics.open, () => {
     sideBarOpen.value = true
     sideBarActivePanel.value = null
   })
-  const openSideBarWithPanelToken = bus.subscribe(
-    'app.files.sidebar.openWithPanel',
+  const openSideBarWithPanelToken = eventBus.subscribe(
+    SideBarEventTopics.openWithPanel,
     (panelName) => {
       sideBarOpen.value = true
       sideBarActivePanel.value = panelName
     }
   )
-  const setActiveSideBarPanelToken = bus.subscribe(
-    'app.files.sidebar.setActivePanel',
+  const setActiveSideBarPanelToken = eventBus.subscribe(
+    SideBarEventTopics.setActivePanel,
     (panelName) => {
       sideBarActivePanel.value = panelName
     }
   )
   onBeforeUnmount(() => {
-    bus.unsubscribe('app.files.sidebar.toggle', toggleSideBarToken)
-    bus.unsubscribe('app.files.sidebar.close', closeSideBarToken)
-    bus.unsubscribe('app.files.sidebar.open', openSideBarToken)
-    bus.unsubscribe('app.files.sidebar.openWithPanel', openSideBarWithPanelToken)
-    bus.unsubscribe('app.files.sidebar.setActivePanel', setActiveSideBarPanelToken)
+    eventBus.unsubscribe(SideBarEventTopics.toggle, toggleSideBarToken)
+    eventBus.unsubscribe(SideBarEventTopics.close, closeSideBarToken)
+    eventBus.unsubscribe(SideBarEventTopics.open, openSideBarToken)
+    eventBus.unsubscribe(SideBarEventTopics.openWithPanel, openSideBarWithPanelToken)
+    eventBus.unsubscribe(SideBarEventTopics.setActivePanel, setActiveSideBarPanelToken)
   })
 
   return {

diff --git a/packages/web-app-files/src/helpers/statusIndicators.js b/packages/web-app-files/src/helpers/statusIndicators.js
@@ -2,6 +2,7 @@ import { getParentPaths } from './path'
 import { $gettext } from '../gettext'
 import { ShareTypes } from 'web-client/src/helpers/share'
 import { bus } from 'web-pkg/src/instance'
+import { SideBarEventTopics } from '../composables/sidebar'
 
 const $shareTypes = (resource) => {
   if (typeof resource.shareTypes !== 'undefined') {
@@ -100,7 +101,7 @@ export const getIndicators = (resource, sharesTree, hasShareJail = false) => {
       target: 'sharing-item',
       type: isDirectUserShare(resource) ? 'user-direct' : 'user-indirect',
       handler: (resource, panel) => {
-        bus.publish('app.files.sidebar.openWithPanel', `${panel}#peopleShares`)
+        bus.publish(SideBarEventTopics.openWithPanel, `${panel}#peopleShares`)
       }
     },
     {
@@ -112,7 +113,7 @@ export const getIndicators = (resource, sharesTree, hasShareJail = false) => {
       target: 'sharing-item',
       type: isDirectLinkShare(resource) ? 'link-direct' : 'link-indirect',
       handler: (resource, panel) => {
-        bus.publish('app.files.sidebar.openWithPanel', `${panel}#linkShares`)
+        bus.publish(SideBarEventTopics.openWithPanel, `${panel}#linkShares`)
       }
     }
   ]

diff --git a/packages/web-app-files/src/mixins/actions/createQuicklink.ts b/packages/web-app-files/src/mixins/actions/createQuicklink.ts
@@ -4,6 +4,7 @@ import { ShareStatus } from 'web-client/src/helpers/share'
 
 import { isLocationSharesActive } from '../../router'
 import { bus } from 'web-pkg/src/instance'
+import { SideBarEventTopics } from '../../composables/sidebar'
 
 export default {
   computed: {
@@ -42,7 +43,7 @@ export default {
         store
       })
 
-      bus.publish('app.files.sidebar.openWithPanel', 'sharing-item#linkShares')
+      bus.publish(SideBarEventTopics.openWithPanel, 'sharing-item#linkShares')
     }
   }
 }
diff --git a/packages/web-app-files/src/mixins/actions/showActions.js b/packages/web-app-files/src/mixins/actions/showActions.js
@@ -1,6 +1,7 @@
 import { isLocationTrashActive } from '../../router'
 import isFilesAppActive from './helpers/isFilesAppActive'
 import { bus } from 'web-pkg/src/instance'
+import { SideBarEventTopics } from '../../composables/sidebar'
 
 export default {
   mixins: [isFilesAppActive],
@@ -39,7 +40,7 @@ export default {
         isLocationTrashActive(this.$router, 'files-trash-spaces-project')
           ? null
           : 'actions-item'
-      bus.publish('app.files.sidebar.openWithPanel', panelName)
+      bus.publish(SideBarEventTopics.openWithPanel, panelName)
     }
   }
 }
diff --git a/packages/web-app-files/src/mixins/actions/showDetails.js b/packages/web-app-files/src/mixins/actions/showDetails.js
@@ -2,6 +2,7 @@ import { mapMutations } from 'vuex'
 import { isLocationTrashActive } from '../../router'
 import isFilesAppActive from './helpers/isFilesAppActive'
 import { bus } from 'web-pkg/src/instance'
+import { SideBarEventTopics } from '../../composables/sidebar'
 
 export default {
   mixins: [isFilesAppActive],
@@ -40,7 +41,7 @@ export default {
 
     $_showDetails_trigger({ resources }) {
       this.SET_FILE_SELECTION(resources)
-      bus.publish('app.files.sidebar.open')
+      bus.publish(SideBarEventTopics.open)
     }
   }
 }
diff --git a/packages/web-app-files/src/mixins/actions/showShares.ts b/packages/web-app-files/src/mixins/actions/showShares.ts
@@ -4,6 +4,7 @@ import { ShareStatus } from 'web-client/src/helpers/share'
 import isFilesAppActive from './helpers/isFilesAppActive'
 import { mapMutations } from 'vuex'
 import { bus } from 'web-pkg/src/instance'
+import { SideBarEventTopics } from '../../composables/sidebar'
 
 export default {
   mixins: [isFilesAppActive],
@@ -49,7 +50,7 @@ export default {
 
     $_showShares_trigger({ resources }) {
       this.SET_FILE_SELECTION(resources)
-      bus.publish('app.files.sidebar.openWithPanel', 'sharing-item#peopleShares')
+      bus.publish(SideBarEventTopics.openWithPanel, 'sharing-item#peopleShares')
     }
   }
 }
diff --git a/packages/web-app-files/src/mixins/spaces/actions/showDetails.js b/packages/web-app-files/src/mixins/spaces/actions/showDetails.js
@@ -1,5 +1,6 @@
 import { mapMutations } from 'vuex'
 import { bus } from 'web-pkg/src/instance'
+import { SideBarEventTopics } from '../../../composables/sidebar'
 
 export default {
   computed: {
@@ -30,7 +31,7 @@ export default {
     },
 
     $_showDetails_openSideBar() {
-      bus.publish('app.files.sidebar.open')
+      bus.publish(SideBarEventTopics.open)
     }
   }
 }
diff --git a/packages/web-app-files/src/mixins/spaces/actions/showMembers.js b/packages/web-app-files/src/mixins/spaces/actions/showMembers.js
@@ -1,5 +1,6 @@
 import { mapMutations } from 'vuex'
 import { bus } from 'web-pkg/src/instance'
+import { SideBarEventTopics } from '../../../composables/sidebar'
 
 export default {
   computed: {
@@ -22,7 +23,7 @@ export default {
 
     $_showMembers_trigger({ resources }) {
       this.SET_FILE_SELECTION(resources)
-      bus.publish('app.files.sidebar.openWithPanel', 'space-share-item')
+      bus.publish(SideBarEventTopics.openWithPanel, 'space-share-item')
     }
   }
 }
diff --git a/packages/web-app-files/src/quickActions.js b/packages/web-app-files/src/quickActions.js
@@ -1,6 +1,7 @@
 import { $gettext } from './gettext'
 import { createQuicklink } from './helpers/share'
 import { bus } from 'web-pkg/src/instance'
+import { SideBarEventTopics } from './composables/sidebar'
 
 export function canShare(item, store) {
   const { capabilities } = store.state.user
@@ -51,7 +52,7 @@ export default {
     id: 'collaborators',
     label: ($gettext) => $gettext('Add people'),
     icon: 'user-add',
-    handler: () => bus.publish('app.files.sidebar.openWithPanel', 'sharing-item#peopleShares'),
+    handler: () => bus.publish(SideBarEventTopics.openWithPanel, 'sharing-item#peopleShares'),
     displayed: canShare
   },
   quicklink: {
@@ -66,12 +67,12 @@ export default {
       if (passwordEnforced) {
         return showQuickLinkPasswordModal(ctx, async (password) => {
           await createQuicklink({ ...ctx, resource: ctx.item, password })
-          bus.publish('app.files.sidebar.openWithPanel', 'sharing-item#linkShares')
+          bus.publish(SideBarEventTopics.openWithPanel, 'sharing-item#linkShares')
         })
       }
 
       await createQuicklink({ ...ctx, resource: ctx.item })
-      bus.publish('app.files.sidebar.openWithPanel', 'sharing-item#linkShares')
+      bus.publish(SideBarEventTopics.openWithPanel, 'sharing-item#linkShares')
     },
     displayed: canShare
   }

diff --git a/packages/web-app-files/src/views/spaces/Project.vue b/packages/web-app-files/src/views/spaces/Project.vue
@@ -167,6 +167,7 @@ import { configurationManager } from 'web-pkg/src/configuration'
 import { buildWebDavSpacesPath } from 'web-client/src/helpers'
 import SideBar from '../../components/SideBar/SideBar.vue'
 import FilesViewWrapper from '../../components/FilesViewWrapper.vue'
+import { SideBarEventTopics } from '../../composables/sidebar'
 
 const visibilityObserver = new VisibilityObserver()
 
@@ -453,7 +454,7 @@ export default defineComponent({
     },
     openSidebarSharePanel() {
       this.selectedResources = [this.space]
-      bus.publish('app.files.sidebar.openWithPanel', 'space-share-item')
+      bus.publish(SideBarEventTopics.openWithPanel, 'space-share-item')
     }
   }
 })

diff --git a/packages/web-app-files/src/views/spaces/Projects.vue b/packages/web-app-files/src/views/spaces/Projects.vue
@@ -158,7 +158,7 @@ import { buildSpace, buildWebDavSpacesPath } from 'web-client/src/helpers'
 import SideBar from '../../components/SideBar/SideBar.vue'
 import FilesViewWrapper from '../../components/FilesViewWrapper.vue'
 import { bus } from 'web-pkg/src/instance'
-import { useSideBar } from '../../composables/sidebar'
+import { SideBarEventTopics, useSideBar } from '../../composables/sidebar'
 
 export default defineComponent({
   components: {
@@ -296,7 +296,7 @@ export default defineComponent({
 
     openSidebarSharePanel(space) {
       this.SET_FILE_SELECTION([space])
-      bus.publish('app.files.sidebar.openWithPanel', 'space-share-item')
+      bus.publish(SideBarEventTopics.openWithPanel, 'space-share-item')
     },
 
     getSpaceLinkProps(space) {

diff --git a/...unit/composables/pagination/spec/index.ts → ...sts/unit/composables/composables.setup.ts b/...unit/composables/pagination/spec/index.ts → ...sts/unit/composables/composables.setup.ts
@@ -7,7 +7,7 @@ const localVue = createLocalVue()
 localVue.use(VueCompositionAPI)
 localVue.use(Vuex)
 
-export const createWrapper = (setup: SetupFunction<Data, Data>): Wrapper<Vue> =>
+export const createComposableWrapper = (setup: SetupFunction<Data, Data>): Wrapper<Vue> =>
   mount(
     defineComponent({
       template: `<div></div>`,