feat(before): adds support for rejecting promises from the before met…

…hod along with supporting unit tests
pulsardev · Jul 29, 2019 · bfee650 · bfee650
1 parent 784f75f
commit bfee650
Show file tree

Hide file tree

Showing 2 changed files with 87 additions and 4 deletions.
diff --git a/src/components/VTour.vue b/src/components/VTour.vue
@@ -117,7 +117,13 @@ export default {
         }, this.customOptions.startTimeout)
       })
 
-      if (typeof step.before !== 'undefined') await step.before('start')
+      if (typeof step.before !== 'undefined') {
+        try {
+          await step.before('start')
+        } catch (e) {
+          return Promise.reject(e)
+        }
+      }
       await process()
 
       return Promise.resolve()
@@ -133,7 +139,13 @@ export default {
 
       if (futureStep > -1) {
         let step = this.steps[futureStep]
-        if (typeof step.before !== 'undefined') await step.before('previous')
+        if (typeof step.before !== 'undefined') {
+          try {
+            await step.before('previous')
+          } catch (e) {
+            return Promise.reject(e)
+          }
+        }
         await process()
       }
 
@@ -150,7 +162,13 @@ export default {
 
       if (futureStep < this.numberOfSteps && this.currentStep !== -1) {
         let step = this.steps[futureStep]
-        if (typeof step.before !== 'undefined') await step.before('next')
+        if (typeof step.before !== 'undefined') {
+          try {
+            await step.before('next')
+          } catch (e) {
+            return Promise.reject(e)
+          }
+        }
         await process()
       }
 

diff --git a/test/unit/VTour.spec.js b/test/unit/VTour.spec.js
@@ -94,7 +94,17 @@ describe('VTour.vue', () => {
       },
       {
         target: '#v-step-2',
-        content: 'An awesome plugin made with Vue.js!'
+        content: 'An awesome plugin made with Vue.js!',
+        before: () => {
+          return Promise.reject(new Error('testing'))
+        }
+      },
+      {
+        target: '#v-step-3',
+        content: 'An awesome plugin made with Vue.js!',
+        before: () => {
+          return Promise.resolve()
+        }
       }
     ]
 
@@ -132,5 +142,60 @@ describe('VTour.vue', () => {
       step0 = false
       step1 = false
     })
+
+    it('handles before() promise rejection on start', async () => {
+      const wrapper = mount(VTour, {
+        propsData: {
+          name: 'myTestTour',
+          steps: beforeSteps
+        }
+      })
+
+      try {
+        await wrapper.vm.start(2)
+        expect(true).to.equal(false) // dead code
+      } catch (e) {
+        expect(e.message).to.equal('testing')
+        expect(wrapper.vm.currentStep).to.equal(-1)
+      }
+    })
+
+    it('handles before() promise rejection on nextStep()', async () => {
+      const wrapper = mount(VTour, {
+        propsData: {
+          name: 'myTestTour',
+          steps: beforeSteps
+        }
+      })
+
+      await wrapper.vm.start(1)
+
+      try {
+        await wrapper.vm.nextStep()
+        expect(true).to.equal(false) // dead code
+      } catch (e) {
+        expect(e.message).to.equal('testing')
+        expect(wrapper.vm.currentStep).to.equal(1)
+      }
+    })
+
+    it('handles before() promise rejection on previousStep()', async () => {
+      const wrapper = mount(VTour, {
+        propsData: {
+          name: 'myTestTour',
+          steps: beforeSteps
+        }
+      })
+
+      await wrapper.vm.start(3)
+
+      try {
+        await wrapper.vm.previousStep()
+        expect(true).to.equal(false) // dead code
+      } catch (e) {
+        expect(e.message).to.equal('testing')
+        expect(wrapper.vm.currentStep).to.equal(3)
+      }
+    })
   })
 })