feat(subscription-info): add update subscription plan method

Author: stfsy

lib/subscription-info.js

@@ -102,6 +102,28 @@ class SubscriptionInfo {
         return false
     }
 
+    /**
+     * Will update the subscription plan of the given subscription. The actual subscription id
+     * will be looked at at runtime by peaking at all subscription events. The current plan will
+     * be cancelled in favor of the new one.
+     * 
+     * @param {Object} subscription 
+     * @param {String} currentSubscriptionPlanId the current plan id to be terminated
+     * @param {String} newSubscriptionPlanId the new plan id
+     * @returns 
+     */
+    async updateSubscription(subscription, currentSubscriptionPlanId, newSubscriptionPlanId) {
+        const subscriptionId = await this._findActiveSubscriptionIdByPlanId(subscription, currentSubscriptionPlanId)
+
+        try {
+            const response = await this._api.updateSubscriptionPlan({ subscription_id: subscriptionId }, newSubscriptionPlanId)
+            return response.subscription_id !== undefined
+        } catch (e) {
+            console.error(`Failed to update subscription because of: ${e}`)
+        }
+        return false
+    }
+
     /**
      * Finds the id of an active subscription by peaking at the status events.
      * 

test-e2e/spec/subscription.spec.js

@@ -203,6 +203,40 @@ test('test cancel via api', async ({ page }) => {
     expect(sub['33590']).toBeFalsy()
 })
 
+test('test update via subscription info', async ({ page }) => {
+    // create new subscription and ...
+    await createNewSubscription(page)
+
+    // .. check it was stored and payment status was received ..
+    let { subscription } = await storage.get(['4815162342'])
+    expect(subscription).not.toBeFalsy()
+    expect(subscription.status).toHaveLength(2)
+    expect(subscription.payments).toHaveLength(1)
+
+    validateStatus(subscription.status[1])
+
+    // .. and check it is active
+    let sub = await subscriptionInfo.getAllSubscriptionsStatus(subscription)
+    expect(sub['33590']).toBeTruthy()
+
+    // update subscription plan via api ...
+    const updated = await subscriptionInfo.updateSubscription(subscription, '33590', '35141')
+    expect(updated).toBeTruthy()
+    await page.waitForTimeout(30000);
+
+    // .. check  new status and payments added ...
+    ({ subscription } = await storage.get(['4815162342']))
+    expect(subscription).not.toBeFalsy()
+    expect(subscription.status).toHaveLength(4)
+    expect(subscription.payments).toHaveLength(2)
+
+    // .. and still active
+    sub = await subscriptionInfo.getAllSubscriptionsStatus(subscription)
+    console.log('active subs', { sub })
+    expect(sub['35141']).toBeTruthy()
+    expect(sub['33590']).toBeFalsy()
+})
+
 test('test update via api', async ({ page }) => {
     // create new subscription and ...
     await createNewSubscription(page)

test/spec/subscription-info.spec.js

@@ -220,6 +220,51 @@ describe('SubscriptionInfo', () => {
             }
         })
     })
+    
+    describe('.updateSubscription', () => {
+        beforeEach(async () => {
+            const subscriptionId = uuid()
+            const createPayload = Object.assign({}, subscriptionCreated,
+                {
+                    subscription_id: subscriptionId,
+                    passthrough: JSON.stringify({ ids }),
+                    event_time: new Date().toISOString()
+                }
+            )
+            await subscriptions.addSubscriptionCreatedStatus(createPayload)
+        })
+        it('throws if no subscription with plan was found', async () => {
+            const { subscription: sub } = await storage.get(ids)
+
+            try {
+                await subscriptionInfo.updateSubscription(sub, '99', '123')
+                throw new Error('Method must throw not found')
+            } catch (e) {
+                const message = e.message
+                expect(message).to.equal(SubscriptionInfo.ERROR_MESSAGE_NOT_FOUND)
+            }
+        })
+        it('throws if subscription was already cancelled', async () => {
+            const payload = Object.assign({}, subscriptionCancelled,
+                {
+                    subscription_id: 'subscriptionId',
+                    passthrough: JSON.stringify({ ids }),
+                    cancellation_effective_date: new Date(new Date().getTime()).toISOString()
+                }
+            )
+
+            await subscriptions.addSubscriptionCancelledStatus(payload)
+            const { subscription: sub } = await storage.get(ids)
+
+            try {
+                await subscriptionInfo.updateSubscription(sub, '8', '123')
+                throw new Error('Method must throw "SubscriptionInfo.ERROR_SUBSCRIPTION_ALREADY_CANCELLED"')
+            } catch (e) {
+                const message = e.message
+                expect(message).to.equal(SubscriptionInfo.ERROR_SUBSCRIPTION_ALREADY_CANCELLED)
+            }
+        })
+    })
 
     describe('.getAllSubscriptionsStatus', () => {
         it('takes the most recent status into account', async () => {