feat: add get start and end date method

Author: stfsy

lib/index.js

@@ -3,6 +3,7 @@
 const resource = require('./firestore/nested-firestore-resource')
 const htmlEncode = require('./html-encoder')
 const flattenObject = require('./firestore/flatten')
+const PLACEHOLDER_DESCRIPTION = 'pre-checkout-placeholder'
 
 const SUBSCRIPTION_ACTIVE_STATUS = [
     "active",
@@ -99,7 +100,7 @@ class Subscriptions {
      */
     async addSubscriptionPlaceholder(ids) {
         const statusModel = {
-            description: 'pre-checkout-placeholder',
+            description: PLACEHOLDER_DESCRIPTION
         }
 
         const subscriptionModel = {
@@ -232,6 +233,32 @@ class Subscriptions {
         return this._isOneOfSubscriptionsActive([subscription], atDate)
     }
 
+    /**
+     * 
+     * @param {Object} subscription 
+     * @returns {Object} containing the start and end date
+     */
+    async getStartAndEndDates(subscription) {
+        const status = subscription.status
+            .sort((a, b) => new Date(a.start_at).getTime() - new Date(b.start_at).getTime())
+
+        const first = status.find((s) => s.description !== PLACEHOLDER_DESCRIPTION)
+        let last = status.at(-1)
+
+        if (first.alert_id === last.alert_id) {
+            last == null
+        }
+
+        const start = first.start_at
+        let end = null
+
+        if (last && !this._isSubscriptionStatusCurrentlyActive(status.at(-1))) {
+            end = status.at(-1).start_at
+        }
+
+        return { start, end }
+    }
+
     /**
      * 
      * @param {Array} subscriptions

test/spec/index.spec.js

@@ -364,4 +364,50 @@ describe('PaddleIntegration', () => {
             expect(isActive).to.be.false
         })
     })
+
+    describe('.getStartAndEndDates', () => {
+        it('returns only start date if theres no end date', async () => {
+            const subscriptionId = uuid()
+            const startTimeString = new Date().toISOString()
+            const createPayload = Object.assign({}, subscriptionCreated,
+                {
+                    subscription_id: subscriptionId, passthrough: JSON.stringify({ ids }),
+                    event_time: startTimeString
+                }
+            )
+            await paddleIntegration.addSubscriptionCreatedStatus(createPayload)
+
+            const { subscription: sub } = await storage.get(ids)
+            const { start, end } = await paddleIntegration.getStartAndEndDates(sub)
+            expect(start).to.equal(startTimeString)
+            expect(end).to.be.null
+        })
+        it('returns start and end date', async () => {
+            const subscriptionId = uuid()
+            const startTimeString = new Date().toISOString()
+            const endTimeString = new Date(new Date().getTime() + 1000 * 3600 * 24 * 33).toISOString()
+
+            const createPayload = Object.assign({}, subscriptionCreated,
+                {
+                    subscription_id: subscriptionId, passthrough: JSON.stringify({ ids }),
+                    event_time: startTimeString
+                }
+            )
+            await paddleIntegration.addSubscriptionCreatedStatus(createPayload)
+
+            const payload = Object.assign({}, subscriptionCancelled,
+                {
+                    subscription_id: subscriptionId,
+                    passthrough: JSON.stringify({ ids }),
+                    cancellation_effective_date: endTimeString
+                }
+            )
+            await paddleIntegration.addSubscriptionCancelledStatus(payload)
+
+            const { subscription: sub } = await storage.get(ids)
+            const { start, end } = await paddleIntegration.getStartAndEndDates(sub)
+            expect(start).to.equal(startTimeString)
+            expect(end).to.equal(endTimeString)
+        })
+    })
 })