ID: FPCO-3436; DONE: 100; HOURS: 20; extension billing library webhook support by gauravks13 · Pull Request #3 · gofynd/fdk-extension-utils-javascript

gauravks13 · 2022-07-15T05:45:42Z

extension billing library webhook support

brijeshgajjarfynd · 2022-07-22T08:29:36Z

.vscode/launch.json

@@ -0,0 +1,25 @@
+{


remove this file.

brijeshgajjarfynd · 2022-07-22T08:31:59Z

handlers/webhook-handler.js

 }

-const webhookHandler = () => new WebhookHandler(SubscriptionModel);
+const webhookHandler = (model) => new WebhookHandler(model);


move constructor to setupBilling function itself. We don't want to create singleton instance on memory directly. Export class itself instead.

brijeshgajjarfynd · 2022-07-22T08:32:55Z

index.js


    const models = require("./models")(config.db_connection, config.collection_name, config.orm_type);
    const { getActivePlans, subscribePlan, getActiveSubscription, updateSubscriptionStatus } = require("./controllers/subscription.helper")(config, models);
+    const { webhookHandler } = require("./handlers/webhook-handler");


import webhook handler class here and create instance here only.

brijeshgajjarfynd · 2022-07-22T08:34:29Z

index.js

        getActiveSubscription, 
-        updateSubscriptionStatus
+        updateSubscriptionStatus,
+        webhookHandler: webhookHandler(models.subscriptionModel)


pass all models here instead of subscription model alone. In future multiple db models update will be handled on webhook handlers. Change accordingly on each handler as well.

brijeshgajjarfynd · 2022-07-22T08:35:24Z

spec/fixtures/payload.js

@@ -0,0 +1,32 @@
+module.exports = { 


name fixture file to whichever model fixture is here. Payload is too generic to understanding which db collection fixture it is written here.

brijeshgajjarfynd · 2022-07-22T08:37:34Z

handlers/webhook-handler.js

+            success = true;
+            message = "Subscription is cancelled by user";
+        }
+        return {


webhook handler will not return anything. remove return from here.

brijeshgajjarfynd · 2022-07-22T08:38:42Z

spec/tests/handlers/webhook-handler.spec.js

+
+        payloadFixture.status = "declined";
+
+        const data = await this.fdk_billing_instance.webhookHandler.handleExtensionSubscriptionUpdate("extension/extension-subscription", payloadFixture, subscriptionFixture.company_id);


verification data should be fetched from database post webhook handler is executed. Since webhook handler will update db records. Fetch data from db instead of this. Update for the same on all test cases.

brijeshgajjarfynd · 2022-07-22T08:40:54Z

spec/tests/handlers/webhook-handler.spec.js

+
+        const data = await this.fdk_billing_instance.webhookHandler.handleExtensionSubscriptionUpdate("extension/extension-subscription", payloadFixture, subscriptionFixture.company_id);
+
+        expect(data.success).toBeFalse()


Add status check on each test cases. even for success false check status is unchanged.

brijeshgajjarfynd · 2022-07-22T08:42:04Z

handlers/webhook-handler.js

+        const sellerSubscription = await this.model.getSubscriptionByPlatformId(payload._id, companyId);
+        const existingSubscription = await this.model.getActiveSubscription(companyId);
+        if (!sellerSubscription) {
+            return {


throw exception here if subscription is not found. there will be no return value on webhook handlers.

brijeshgajjarfynd · 2022-07-22T08:42:32Z

spec/tests/handlers/webhook-handler.spec.js

+const { clearData } = require("../../helpers/setup_db");
+const subscriptionFixture = require("../../fixtures/subscription");
+const ObjectId = require("mongoose").Types.ObjectId;
+const payloadFixture = require("../../fixtures/payload");


rename fixture variable name here also

brijeshgajjarfynd · 2022-07-31T17:04:38Z

handlers/webhook-handler.js

+'use strict';
+class WebhookHandler {
+    constructor(models) {
+        this.model = models.subscriptionModel;


assign models object itself here. and use this.models.subscriptionModel every place in this file.

brijeshgajjarfynd · 2022-07-31T17:05:37Z

handlers/webhook-handler.js

+            if (existingSubscription) {
+                await this.model.cancelSubscription(existingSubscription.id);
+            }
+            success = true;


lose these variables if not using it anymore later.

brijeshgajjarfynd · 2022-07-31T17:07:29Z

index.js

    const models = require("./models")(config.db_connection, config.collection_name, config.orm_type);
    const { getActivePlans, subscribePlan, getActiveSubscription, updateSubscriptionStatus } = require("./controllers/subscription.helper")(config, models);
+    const { WebhookHandler } = require("./handlers/webhook-handler");
+    const webhookHandler = (models) => new WebhookHandler(models);


why we need function here? why can't we just create new instance directly? Think properly before adding extra unnecessary steps.

… invoked with instance

gauravks13 added 4 commits July 14, 2022 16:36

extension subscription handler added

5e916a3

handler fix

0aab5ea

install handler removed

424f033

webhook handler test cases added

a0b0a02

brijeshgajjarfynd requested changes Jul 22, 2022

View reviewed changes

webhook handler changes

b1a45af

brijeshgajjarfynd requested changes Jul 31, 2022

View reviewed changes

gauravks13 and others added 8 commits August 1, 2022 09:28

minor webhook handler changes

da335a0

update test cases

661e847

remove unnecessary data

9b06656

Update webhook handler to be singleton since webhook handler can't be…

4ce5fc4

… invoked with instance

fix get by id sending string value

4f424c8

read payload from request body individually

9b0b996

fix active subscription hook was cancelling same subscription

351843f

check if current subscirption is already active then don't cancel it

1525093


		payloadFixture.status = "declined";

		const data = await this.fdk_billing_instance.webhookHandler.handleExtensionSubscriptionUpdate("extension/extension-subscription", payloadFixture, subscriptionFixture.company_id);


		const data = await this.fdk_billing_instance.webhookHandler.handleExtensionSubscriptionUpdate("extension/extension-subscription", payloadFixture, subscriptionFixture.company_id);

		expect(data.success).toBeFalse()

Comments

Conversation

gauravks13 commented Jul 15, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants