github/overleaf
1
0
Fork 0
mirror of https://github.com/overleaf/overleaf.git synced 2024-11-14 20:40:17 -05:00
Code Issues Projects Releases Packages Wiki Activity

Revert "Send subscription -> salesforce/v1 links to analytics"

Browse source 
This reverts commit 52c02138f9ef8141850e2f8ce16f2bab1e7463b0.

GitOrigin-RevId: 022e828a8e41cc73c4087b94d51fa75dbe6cfdb5
This commit is contained in:
Andrew Rumble 2024-10-22 17:14:51 +01:00 committed by Copybot
parent 6f3c371435
commit e75e9c4818
5 changed files with 0 additions and 360 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
services/web/app/src/Features/Analytics/AccountMappingHelper.mjs
View file

@ -1,48 +0,0 @@
export function extractAccountMappingsFromSubscription(
subscription,
updatedSubscription
) {
const accountMappings = []
if (
updatedSubscription.salesforce_id ||
updatedSubscription.salesforce_id === ''
) {
if (subscription.salesforce_id !== updatedSubscription.salesforce_id) {
accountMappings.push(
generateSubscriptionToSalesforceMapping(
subscription.id,
updatedSubscription.salesforce_id
)
)
}
}
if (updatedSubscription.v1_id || updatedSubscription.v1_id === '') {
if (subscription.v1_id !== updatedSubscription.v1_id) {
accountMappings.push(
generateSubscriptionToV1Mapping(
subscription.id,
updatedSubscription.v1_id
)
)
}
}
return accountMappings
}
}
function generateSubscriptionToSalesforceMapping(subscriptionId, salesforceId) {
return {
source: 'salesforce',
sourceEntity: 'account',
sourceEntityId: salesforceId,
target: 'v2',
targetEntity: 'subscription',
targetEntityId: subscriptionId,
createdAt: new Date().toISOString(),
}
}
export default {
extractAccountMappingsFromSubscription,
}

53
services/web/app/src/Features/Analytics/AnalyticsManager.js
View file

@ -15,9 +15,6 @@ const analyticsEditingSessionsQueue = Queues.getQueue(
const analyticsUserPropertiesQueue = Queues.getQueue( const analyticsUserPropertiesQueue = Queues.getQueue(
'analytics-user-properties' 'analytics-user-properties'
) )
const analyticsAccountMappingQueue = Queues.getQueue(
'analytics-account-mapping'
)
const ONE_MINUTE_MS = 60 * 1000 const ONE_MINUTE_MS = 60 * 1000
@ -146,55 +143,6 @@ function setUserPropertyForSessionInBackground(session, property, value) {
}) })
} }
/**
* Register mapping between two accounts.
*
* @param {object} payload - The event payload to send to Analytics
* @param {string} payload.source - The type of account linked from
* @param {string} payload.sourceId - The ID of the account linked from
* @param {string} payload.target - The type of account linked to
* @param {string} payload.targetId - The ID of the account linked to
* @param {Date} payload.createdAt - The date the mapping was created
* @property
*/
function registerAccountMapping({
source,
sourceEntity,
sourceEntityId,
target,
targetEntity,
targetEntityId,
createdAt,
}) {
Metrics.analyticsQueue.inc({
status: 'adding',
event_type: 'account-mapping',
})
analyticsAccountMappingQueue
.add('account-mapping', {
source,
sourceEntity,
sourceEntityId,
target,
targetEntity,
targetEntityId,
createdAt: createdAt ?? new Date(),
})
.then(() => {
Metrics.analyticsQueue.inc({
status: 'added',
event_type: 'account-mapping',
})
})
.catch(() => {
Metrics.analyticsQueue.inc({
status: 'error',
event_type: 'account-mapping',
})
})
}
function updateEditingSession(userId, projectId, countryCode, segmentation) { function updateEditingSession(userId, projectId, countryCode, segmentation) {
if (!userId) { if (!userId) {
return return
@ -401,6 +349,5 @@ module.exports = {
setUserPropertyForAnalyticsId, setUserPropertyForAnalyticsId,
updateEditingSession, updateEditingSession,
getIdsFromSession, getIdsFromSession,
registerAccountMapping,
analyticsIdMiddleware: expressify(analyticsIdMiddleware), analyticsIdMiddleware: expressify(analyticsIdMiddleware),
} }

5
services/web/app/src/infrastructure/Queues.js
View file

@ -17,9 +17,6 @@ const QUEUES_JOB_OPTIONS = {
'analytics-editing-sessions': { 'analytics-editing-sessions': {
removeOnFail: MAX_FAILED_JOBS_RETAINED_ANALYTICS, removeOnFail: MAX_FAILED_JOBS_RETAINED_ANALYTICS,
}, },
'analytics-account-mapping': {
removeOnFail: MAX_FAILED_JOBS_RETAINED_ANALYTICS,
},
'analytics-user-properties': { 'analytics-user-properties': {
removeOnFail: MAX_FAILED_JOBS_RETAINED_ANALYTICS, removeOnFail: MAX_FAILED_JOBS_RETAINED_ANALYTICS,
}, },
@ -41,7 +38,6 @@ const QUEUES_JOB_OPTIONS = {
removeOnFail: MAX_FAILED_JOBS_RETAINED, removeOnFail: MAX_FAILED_JOBS_RETAINED,
attempts: 3, attempts: 3,
}, },
'group-sso-reminder': { 'group-sso-reminder': {
removeOnFail: MAX_FAILED_JOBS_RETAINED, removeOnFail: MAX_FAILED_JOBS_RETAINED,
attempts: 3, attempts: 3,
@ -58,7 +54,6 @@ const QUEUE_OPTIONS = {
} }
const ANALYTICS_QUEUES = [ const ANALYTICS_QUEUES = [
'analytics-account-mapping',
'analytics-events', 'analytics-events',
'analytics-editing-sessions', 'analytics-editing-sessions',
'analytics-user-properties', 'analytics-user-properties',

228
services/web/test/unit/src/Analytics/AccountMappingHelperTests.mjs
View file

@ -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
)
})
})
})
})

26
services/web/test/unit/src/Analytics/AnalyticsManagerTests.js
View file

@ -34,10 +34,6 @@ describe('AnalyticsManager', function () {
add: sinon.stub().resolves(), add: sinon.stub().resolves(),
process: sinon.stub().resolves(), process: sinon.stub().resolves(),
} }
this.analyticsAccountMappingQueue = {
add: sinon.stub().resolves(),
process: sinon.stub().resolves(),
}
const self = this const self = this
this.Queues = { this.Queues = {
getQueue: queueName => { getQueue: queueName => {
@ -50,8 +46,6 @@ describe('AnalyticsManager', function () {
return self.onboardingEmailsQueue return self.onboardingEmailsQueue
case 'analytics-user-properties': case 'analytics-user-properties':
return self.analyticsUserPropertiesQueue return self.analyticsUserPropertiesQueue
case 'analytics-account-mapping':
return self.analyticsAccountMappingQueue
default: default:
throw new Error('Unexpected queue name') throw new Error('Unexpected queue name')
} }
@ -284,24 +278,6 @@ describe('AnalyticsManager', function () {
isLoggedIn: true, isLoggedIn: true,
}) })
}) })
it('account mapping', async function () {
const message = {
source: 'salesforce',
sourceEntity: 'account',
sourceEntityId: 'abc123abc123abc123',
target: 'v1',
targetEntity: 'university',
targetEntityId: 1,
createdAt: '2021-01-01T00:00:00Z',
}
await this.AnalyticsManager.registerAccountMapping(message)
sinon.assert.calledWithMatch(
this.analyticsAccountMappingQueue.add,
'account-mapping',
message
)
})
}) })
describe('AnalyticsIdMiddleware', function () { describe('AnalyticsIdMiddleware', function () {
@ -323,8 +299,6 @@ describe('AnalyticsManager', function () {
return self.onboardingEmailsQueue return self.onboardingEmailsQueue
case 'analytics-user-properties': case 'analytics-user-properties':
return self.analyticsUserPropertiesQueue return self.analyticsUserPropertiesQueue
case 'analytics-account-mapping':
return self.analyticsAccountMappingQueue
default: default:
throw new Error('Unexpected queue name') throw new Error('Unexpected queue name')
} }