Merge pull request #23457 from overleaf/ar-recurly-account-mapping-initial

[web] setup Recurly -> Mongo account mapping

GitOrigin-RevId: ee08cad60ee04e62100f3d5a4f76fdbcf5543917

services/web/test/unit/src/Analytics/AccountMappingHelperTests.js

@@ -0,0 +1,276 @@
+const SandboxedModule = require('sandboxed-module')
+const { expect } = require('chai')
+const { ObjectId } = require('mongodb-legacy')
+const path = require('node:path')
+
+const MODULE_PATH = path.join(
+  __dirname,
+  '../../../../app/src/Features/Analytics/AccountMappingHelper'
+)
+
+describe('AccountMappingHelper', function () {
+  beforeEach(function () {
+    this.AccountMappingHelper = SandboxedModule.require(MODULE_PATH)
+  })
+
+  describe('extractAccountMappingsFromSubscription', function () {
+    describe('when the v1 id is the same in the updated subscription and the subscription', function () {
+      describe('when the salesforce id is the same in the updated subscription and the subscription', function () {
+        beforeEach(function () {
+          this.subscription = {
+            id: new ObjectId('abc123abc123abc123abc123'),
+            salesforce_id: 'def456def456def456',
+          }
+          this.updatedSubscription = { salesforce_id: 'def456def456def456' }
+          this.result =
+            this.AccountMappingHelper.extractAccountMappingsFromSubscription(
+              this.subscription,
+              this.updatedSubscription
+            )
+        })
+
+        it('returns an empty array', function () {
+          expect(this.result).to.be.an('array')
+          expect(this.result).to.have.length(0)
+        })
+      })
+      describe('when the salesforce id has changed between the subscription and the updated subscription', function () {
+        beforeEach(function () {
+          this.subscription = {
+            id: new ObjectId('abc123abc123abc123abc123'),
+            salesforce_id: 'def456def456def456',
+          }
+          this.updatedSubscription = { salesforce_id: 'ghi789ghi789ghi789' }
+          this.result =
+            this.AccountMappingHelper.extractAccountMappingsFromSubscription(
+              this.subscription,
+              this.updatedSubscription
+            )
+        })
+
+        it('returns an array with a single item', function () {
+          expect(this.result).to.be.an('array')
+          expect(this.result).to.have.length(1)
+        })
+
+        it('uses "account" as sourceEntity', function () {
+          expect(this.result[0]).to.haveOwnProperty('sourceEntity', 'account')
+        })
+
+        it('uses the salesforceId from the updated subscription as sourceEntityId', function () {
+          expect(this.result[0]).to.haveOwnProperty(
+            'sourceEntityId',
+            this.updatedSubscription.salesforce_id
+          )
+        })
+
+        it('uses "subscription" as targetEntity', function () {
+          expect(this.result[0]).to.haveOwnProperty(
+            'targetEntity',
+            'subscription'
+          )
+        })
+
+        it('uses the subscriptionId as targetEntityId', function () {
+          expect(this.result[0]).to.haveOwnProperty(
+            'targetEntityId',
+            this.subscription.id
+          )
+        })
+      })
+      describe('when the update subscription has a salesforce id and the subscription has no salesforce_id', function () {
+        beforeEach(function () {
+          this.subscription = { id: new ObjectId('abc123abc123abc123abc123') }
+          this.updatedSubscription = { salesforce_id: 'def456def456def456' }
+          this.result =
+            this.AccountMappingHelper.extractAccountMappingsFromSubscription(
+              this.subscription,
+              this.updatedSubscription
+            )
+        })
+
+        it('returns an array with a single item', function () {
+          expect(this.result).to.be.an('array')
+          expect(this.result).to.have.length(1)
+        })
+
+        it('uses "account" as sourceEntity', function () {
+          expect(this.result[0]).to.haveOwnProperty('sourceEntity', 'account')
+        })
+
+        it('uses the salesforceId from the updated subscription as sourceEntityId', function () {
+          expect(this.result[0]).to.haveOwnProperty(
+            'sourceEntityId',
+            this.updatedSubscription.salesforce_id
+          )
+        })
+
+        it('uses "subscription" as targetEntity', function () {
+          expect(this.result[0]).to.haveOwnProperty(
+            'targetEntity',
+            'subscription'
+          )
+        })
+
+        it('uses the subscriptionId as targetEntityId', function () {
+          expect(this.result[0]).to.haveOwnProperty(
+            'targetEntityId',
+            this.subscription.id
+          )
+        })
+      })
+    })
+
+    describe('when the v1 id has changed between the subscription and the updated subscription', function () {
+      describe('when the salesforce id has not changed between the subscription and the updated subscription', function () {
+        beforeEach(function () {
+          this.subscription = {
+            id: new ObjectId('abc123abc123abc123abc123'),
+            v1_id: '1',
+            salesforce_id: '',
+          }
+          this.updatedSubscription = { v1_id: '2', salesforce_id: '' }
+          this.result =
+            this.AccountMappingHelper.extractAccountMappingsFromSubscription(
+              this.subscription,
+              this.updatedSubscription
+            )
+        })
+
+        it('returns an array with a single item', function () {
+          expect(this.result).to.be.an('array')
+          expect(this.result).to.have.length(1)
+        })
+
+        it('uses "university" as the sourceEntity', function () {
+          expect(this.result[0]).to.haveOwnProperty(
+            'sourceEntity',
+            'university'
+          )
+        })
+
+        it('uses the v1_id from the updated subscription as the sourceEntityId', function () {
+          expect(this.result[0]).to.haveOwnProperty(
+            'sourceEntityId',
+            this.updatedSubscription.v1_id
+          )
+        })
+
+        it('uses "subscription" as the targetEntity', function () {
+          expect(this.result[0]).to.haveOwnProperty(
+            'targetEntity',
+            'subscription'
+          )
+        })
+
+        it('uses the subscription id as the targetEntityId', function () {
+          expect(this.result[0]).to.haveOwnProperty(
+            'targetEntityId',
+            this.subscription.id
+          )
+        })
+      })
+      describe('when the salesforce id has changed between the subscription and the updated subscription', function () {
+        beforeEach(function () {
+          this.subscription = {
+            id: new ObjectId('abc123abc123abc123abc123'),
+            v1_id: '',
+            salesforce_id: 'def456def456def456',
+          }
+          this.updatedSubscription = {
+            v1_id: '2',
+            salesforce_id: '',
+          }
+          this.result =
+            this.AccountMappingHelper.extractAccountMappingsFromSubscription(
+              this.subscription,
+              this.updatedSubscription
+            )
+        })
+
+        it('returns an array with two items', function () {
+          expect(this.result).to.be.an('array')
+          expect(this.result).to.have.length(2)
+        })
+
+        it('uses the salesforce_id from the updated subscription as the sourceEntityId for the first item', function () {
+          expect(this.result[0]).to.haveOwnProperty(
+            'sourceEntityId',
+            this.updatedSubscription.salesforce_id
+          )
+        })
+
+        it('uses the subscription id as the targetEntityId for the first item', function () {
+          expect(this.result[0]).to.haveOwnProperty(
+            'targetEntityId',
+            this.subscription.id
+          )
+        })
+
+        it('uses the v1_id from the updated subscription as the sourceEntityId for the second item', function () {
+          expect(this.result[1]).to.haveOwnProperty(
+            'sourceEntityId',
+            this.updatedSubscription.v1_id
+          )
+        })
+
+        it('uses the subscription id as the targetEntityId for the second item', function () {
+          expect(this.result[1]).to.haveOwnProperty(
+            'targetEntityId',
+            this.subscription.id
+          )
+        })
+      })
+    })
+  })
+  describe('when the recurlySubscription_id has changed between the subscription and the updated subscription', function () {
+    beforeEach(function () {
+      this.subscription = {
+        id: new ObjectId('abc123abc123abc123abc123'),
+        recurlySubscription_id: '',
+      }
+      this.updatedSubscription = {
+        recurlySubscription_id: '1234a5678b90123cd4567e8f901a2b34',
+      }
+      this.result =
+        this.AccountMappingHelper.extractAccountMappingsFromSubscription(
+          this.subscription,
+          this.updatedSubscription
+        )
+    })
+    it('returns an array with one item', function () {
+      expect(this.result).to.be.an('array')
+      expect(this.result).to.have.length(1)
+    })
+
+    it('uses "recurly" as the source', function () {
+      expect(this.result[0]).to.haveOwnProperty('source', 'recurly')
+    })
+
+    it('uses "subscription" as the sourceEntity', function () {
+      expect(this.result[0]).to.haveOwnProperty('sourceEntity', 'subscription')
+    })
+
+    it('uses the recurlySubscription_id as the sourceEntityId', function () {
+      expect(this.result[0]).to.haveOwnProperty(
+        'sourceEntityId',
+        this.updatedSubscription.recurlySubscription_id
+      )
+    })
+
+    it('uses "v2" as the target', function () {
+      expect(this.result[0]).to.haveOwnProperty('target', 'v2')
+    })
+
+    it('uses "subscription" as the targetEntity', function () {
+      expect(this.result[0]).to.haveOwnProperty('targetEntity', 'subscription')
+    })
+
+    it('uses the subscription id as the targetEntityId', function () {
+      expect(this.result[0]).to.haveOwnProperty(
+        'targetEntityId',
+        this.subscription.id
+      )
+    })
+  })
+})

services/web/test/unit/src/Analytics/AccountMappingHelperTests.mjs

@@ -1,228 +0,0 @@
-import path from 'node:path'
-import esmock from 'esmock'
-import { expect } from 'chai'
-import mongodb from 'mongodb-legacy'
-import { fileURLToPath } from 'node:url'
-
-const { ObjectId } = mongodb
-
-const __dirname = fileURLToPath(new URL('.', import.meta.url))
-
-const MODULE_PATH = path.join(
-  __dirname,
-  '../../../../app/src/Features/Analytics/AccountMappingHelper'
-)
-
-describe('AccountMappingHelper', function () {
-  beforeEach(async function () {
-    this.AccountMappingHelper = await esmock.strict(MODULE_PATH)
-  })
-
-  describe('extractAccountMappingsFromSubscription', function () {
-    describe('when the v1 id is the same in the updated subscription and the subscription', function () {
-      describe('when the salesforce id is the same in the updated subscription and the subscription', function () {
-        beforeEach(function () {
-          this.subscription = {
-            id: new ObjectId('abc123abc123abc123abc123'),
-            salesforce_id: 'def456def456def456',
-          }
-          this.updatedSubscription = { salesforce_id: 'def456def456def456' }
-          this.result =
-            this.AccountMappingHelper.extractAccountMappingsFromSubscription(
-              this.subscription,
-              this.updatedSubscription
-            )
-        })
-
-        it('returns an empty array', function () {
-          expect(this.result).to.be.an('array')
-          expect(this.result).to.have.length(0)
-        })
-      })
-      describe('when the salesforce id has changed between the subscription and the updated subscription', function () {
-        beforeEach(function () {
-          this.subscription = {
-            id: new ObjectId('abc123abc123abc123abc123'),
-            salesforce_id: 'def456def456def456',
-          }
-          this.updatedSubscription = { salesforce_id: 'ghi789ghi789ghi789' }
-          this.result =
-            this.AccountMappingHelper.extractAccountMappingsFromSubscription(
-              this.subscription,
-              this.updatedSubscription
-            )
-        })
-
-        it('returns an array with a single item', function () {
-          expect(this.result).to.be.an('array')
-          expect(this.result).to.have.length(1)
-        })
-
-        it('uses "account" as sourceEntity', function () {
-          expect(this.result[0]).to.haveOwnProperty('sourceEntity', 'account')
-        })
-
-        it('uses the salesforceId from the updated subscription as sourceEntityId', function () {
-          expect(this.result[0]).to.haveOwnProperty(
-            'sourceEntityId',
-            this.updatedSubscription.salesforce_id
-          )
-        })
-
-        it('uses "subscription" as targetEntity', function () {
-          expect(this.result[0]).to.haveOwnProperty(
-            'targetEntity',
-            'subscription'
-          )
-        })
-
-        it('uses the subscriptionId as targetEntityId', function () {
-          expect(this.result[0]).to.haveOwnProperty(
-            'targetEntityId',
-            this.subscription.id
-          )
-        })
-      })
-      describe('when the update subscription has a salesforce id and the subscription has no salesforce_id', function () {
-        beforeEach(function () {
-          this.subscription = { id: new ObjectId('abc123abc123abc123abc123') }
-          this.updatedSubscription = { salesforce_id: 'def456def456def456' }
-          this.result =
-            this.AccountMappingHelper.extractAccountMappingsFromSubscription(
-              this.subscription,
-              this.updatedSubscription
-            )
-        })
-
-        it('returns an array with a single item', function () {
-          expect(this.result).to.be.an('array')
-          expect(this.result).to.have.length(1)
-        })
-
-        it('uses "account" as sourceEntity', function () {
-          expect(this.result[0]).to.haveOwnProperty('sourceEntity', 'account')
-        })
-
-        it('uses the salesforceId from the updated subscription as sourceEntityId', function () {
-          expect(this.result[0]).to.haveOwnProperty(
-            'sourceEntityId',
-            this.updatedSubscription.salesforce_id
-          )
-        })
-
-        it('uses "subscription" as targetEntity', function () {
-          expect(this.result[0]).to.haveOwnProperty(
-            'targetEntity',
-            'subscription'
-          )
-        })
-
-        it('uses the subscriptionId as targetEntityId', function () {
-          expect(this.result[0]).to.haveOwnProperty(
-            'targetEntityId',
-            this.subscription.id
-          )
-        })
-      })
-    })
-  })
-
-  describe('when the v1 id has changed between the subscription and the updated subscription', function () {
-    describe('when the salesforce id has not changed between the subscription and the updated subscription', function () {
-      beforeEach(function () {
-        this.subscription = {
-          id: new ObjectId('abc123abc123abc123abc123'),
-          v1_id: '1',
-          salesforce_id: '',
-        }
-        this.updatedSubscription = { v1_id: '2', salesforce_id: '' }
-        this.result =
-          this.AccountMappingHelper.extractAccountMappingsFromSubscription(
-            this.subscription,
-            this.updatedSubscription
-          )
-      })
-
-      it('returns an array with a single item', function () {
-        expect(this.result).to.be.an('array')
-        expect(this.result).to.have.length(1)
-      })
-
-      it('uses "university" as the sourceEntity', function () {
-        expect(this.result[0]).to.haveOwnProperty('sourceEntity', 'university')
-      })
-
-      it('uses the v1_id from the updated subscription as the sourceEntityId', function () {
-        expect(this.result[0]).to.haveOwnProperty(
-          'sourceEntityId',
-          this.updatedSubscription.v1_id
-        )
-      })
-
-      it('uses "subscription" as the targetEntity', function () {
-        expect(this.result[0]).to.haveOwnProperty(
-          'targetEntity',
-          'subscription'
-        )
-      })
-
-      it('uses the subscription id as the targetEntityId', function () {
-        expect(this.result[0]).to.haveOwnProperty(
-          'targetEntityId',
-          this.subscription.id
-        )
-      })
-    })
-    describe('when the salesforce id has changed between the subscription and the updated subscription', function () {
-      beforeEach(function () {
-        this.subscription = {
-          id: new ObjectId('abc123abc123abc123abc123'),
-          v1_id: '',
-          salesforce_id: 'def456def456def456',
-        }
-        this.updatedSubscription = {
-          v1_id: '2',
-          salesforce_id: '',
-        }
-        this.result =
-          this.AccountMappingHelper.extractAccountMappingsFromSubscription(
-            this.subscription,
-            this.updatedSubscription
-          )
-      })
-
-      it('returns an array with two items', function () {
-        expect(this.result).to.be.an('array')
-        expect(this.result).to.have.length(2)
-      })
-
-      it('uses the salesforce_id from the updated subscription as the sourceEntityId for the first item', function () {
-        expect(this.result[0]).to.haveOwnProperty(
-          'sourceEntityId',
-          this.updatedSubscription.salesforce_id
-        )
-      })
-
-      it('uses the subscription id as the targetEntityId for the first item', function () {
-        expect(this.result[0]).to.haveOwnProperty(
-          'targetEntityId',
-          this.subscription.id
-        )
-      })
-
-      it('uses the v1_id from the updated subscription as the sourceEntityId for the second item', function () {
-        expect(this.result[1]).to.haveOwnProperty(
-          'sourceEntityId',
-          this.updatedSubscription.v1_id
-        )
-      })
-
-      it('uses the subscription id as the targetEntityId for the second item', function () {
-        expect(this.result[1]).to.haveOwnProperty(
-          'targetEntityId',
-          this.subscription.id
-        )
-      })
-    })
-  })
-})

services/web/test/unit/src/Subscription/SubscriptionUpdaterTests.js

@@ -148,6 +148,7 @@ describe('SubscriptionUpdater', function () {
     this.AnalyticsManager = {
       recordEventForUserInBackground: sinon.stub().resolves(),
       setUserPropertyForUserInBackground: sinon.stub(),
+      registerAccountMapping: sinon.stub(),
     }
 
     this.Features = {
@@ -175,6 +176,9 @@ describe('SubscriptionUpdater', function () {
           DeletedSubscription: this.DeletedSubscription,
         },
         '../Analytics/AnalyticsManager': this.AnalyticsManager,
+        '../Analytics/AccountMappingHelper': (this.AccountMappingHelper = {
+          generateSubscriptionToRecurlyMapping: sinon.stub(),
+        }),
         '../../infrastructure/Features': this.Features,
         '../User/UserAuditLogHandler': this.UserAuditLogHandler,
       },
@@ -280,6 +284,41 @@ describe('SubscriptionUpdater', function () {
       ).to.have.been.calledWith(this.adminUser._id)
     })
 
+    it('should send a recurly account mapping event', async function () {
+      const createdAt = new Date().toISOString()
+      this.AccountMappingHelper.generateSubscriptionToRecurlyMapping.returns({
+        source: 'recurly',
+        sourceEntity: 'subscription',
+        sourceEntityId: this.recurlySubscription.uuid,
+        target: 'v2',
+        targetEntity: 'subscription',
+        targetEntityId: this.subscription._id,
+        createdAt,
+      })
+      await this.SubscriptionUpdater.promises.updateSubscriptionFromRecurly(
+        this.recurlySubscription,
+        this.subscription,
+        {}
+      )
+      expect(
+        this.AccountMappingHelper.generateSubscriptionToRecurlyMapping
+      ).to.have.been.calledWith(
+        this.subscription._id,
+        this.recurlySubscription.uuid
+      )
+      expect(
+        this.AnalyticsManager.registerAccountMapping
+      ).to.have.been.calledWith({
+        source: 'recurly',
+        sourceEntity: 'subscription',
+        sourceEntityId: this.recurlySubscription.uuid,
+        target: 'v2',
+        targetEntity: 'subscription',
+        targetEntityId: this.subscription._id,
+        createdAt,
+      })
+    })
+
     it('should remove the subscription when expired', async function () {
       this.recurlySubscription.state = 'expired'
       await this.SubscriptionUpdater.promises.updateSubscriptionFromRecurly(