alois/Verso
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Don't leave dangling users in mailchimp when change-address fails (#2165)

Browse Source 
* Don't leave dangling users in mailchimp when change-address fails

Also prevents upserting of users when unsubscribing

bug: overleaf/issues#2220
bug: overleaf/issues#2301
bug: overleaf/issues#2302

* Tidy up NewsletterManager. Enable deletion of contacts on account delete.

GitOrigin-RevId: ab7cde7a7b7018b37dea54ffa154e02c5aea0244
This commit is contained in:
Simon Detheridge
2019-09-25 14:47:57 +00:00
committed by sharelatex
parent 13a53b8fbc
commit 111d22d260
6 changed files with 187 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files
services/web/test/unit/src/Newsletter/NewsletterManagerTests.js
+89 -38
View File
@@ -13,15 +13,24 @@ describe('NewsletterManager', function() {
}
}
this.mailchimp = {
put: sinon.stub()
put: sinon.stub(),
patch: sinon.stub(),
delete: sinon.stub()
}
this.Mailchimp = sinon.stub().returns(this.mailchimp)
this.mergeFields = {
FNAME: 'Overleaf',
LNAME: 'Duck',
MONGO_ID: 'user_id'
}
this.NewsletterManager = SandboxedModule.require(MODULE_PATH, {
requires: {
'mailchimp-api-v3': this.Mailchimp,
'settings-sharelatex': this.Settings
}
},
globals: { console: console }
}).promises
this.user = {
@@ -43,65 +52,107 @@ describe('NewsletterManager', function() {
email_address: this.user.email,
status: 'subscribed',
status_if_new: 'subscribed',
merge_fields: {
FNAME: 'Overleaf',
LNAME: 'Duck',
MONGO_ID: 'user_id'
}
merge_fields: this.mergeFields
}
)
})
})
describe('unsubscribe', function() {
it('calls Mailchimp to unsubscribe the user', async function() {
await this.NewsletterManager.unsubscribe(this.user)
expect(this.mailchimp.put).to.have.been.calledWith(
`/lists/list_id/members/${this.emailHash}`,
{
email_address: this.user.email,
status: 'unsubscribed',
status_if_new: 'unsubscribed',
merge_fields: {
FNAME: 'Overleaf',
LNAME: 'Duck',
MONGO_ID: 'user_id'
describe('when unsubscribing normally', function() {
it('calls Mailchimp to unsubscribe the user', async function() {
await this.NewsletterManager.unsubscribe(this.user)
expect(this.mailchimp.patch).to.have.been.calledWith(
`/lists/list_id/members/${this.emailHash}`,
{
status: 'unsubscribed',
merge_fields: this.mergeFields
}
}
)
})
it('ignores a Mailchimp error about fake emails', async function() {
this.mailchimp.put.rejects(
new Error(
'overleaf.duck@example.com looks fake or invalid, please enter a real email address'
)
)
await expect(this.NewsletterManager.unsubscribe(this.user)).to.be
.fulfilled
})
it('ignores a Mailchimp error about fake emails', async function() {
this.mailchimp.patch.rejects(
new Error(
'overleaf.duck@example.com looks fake or invalid, please enter a real email address'
)
)
await expect(this.NewsletterManager.unsubscribe(this.user)).to.be
.fulfilled
})
it('rejects on other errors', async function() {
this.mailchimp.patch.rejects(
new Error('something really wrong is happening')
)
await expect(this.NewsletterManager.unsubscribe(this.user)).to.be
.rejected
})
})
it('rejects on other errors', async function() {
this.mailchimp.put.rejects(
new Error('something really wrong is happening')
)
await expect(this.NewsletterManager.unsubscribe(this.user)).to.be.rejected
describe('when deleting', function() {
it('calls Mailchimp to delete the user', async function() {
await this.NewsletterManager.unsubscribe(this.user, { delete: true })
expect(this.mailchimp.delete).to.have.been.calledWith(
`/lists/list_id/members/${this.emailHash}`
)
})
it('ignores a Mailchimp error about fake emails', async function() {
this.mailchimp.delete.rejects(
new Error(
'overleaf.duck@example.com looks fake or invalid, please enter a real email address'
)
)
await expect(
this.NewsletterManager.unsubscribe(this.user, { delete: true })
).to.be.fulfilled
})
it('rejects on other errors', async function() {
this.mailchimp.delete.rejects(
new Error('something really wrong is happening')
)
await expect(
this.NewsletterManager.unsubscribe(this.user, { delete: true })
).to.be.rejected
})
})
})
describe('changeEmail', function() {
it('calls Mailchimp to change the subscriber email', async function() {
await this.NewsletterManager.changeEmail(
this.user.email,
this.user,
'overleaf.squirrel@example.com'
)
expect(this.mailchimp.put).to.have.been.calledWith(
expect(this.mailchimp.patch).to.have.been.calledWith(
`/lists/list_id/members/${this.emailHash}`,
{
email_address: 'overleaf.squirrel@example.com',
status_if_new: 'unsubscribed'
merge_fields: this.mergeFields
}
)
})
it('deletes the old email if changing the address fails', async function() {
this.mailchimp.patch
.withArgs(`/lists/list_id/members/${this.emailHash}`, {
email_address: 'overleaf.squirrel@example.com',
merge_fields: this.mergeFields
})
.rejects(new Error('that did not work'))
await expect(
this.NewsletterManager.changeEmail(
this.user,
'overleaf.squirrel@example.com'
)
).to.be.rejected
expect(this.mailchimp.delete).to.have.been.calledWith(
`/lists/list_id/members/${this.emailHash}`
)
})
})
})
services/web/test/unit/src/User/UserDeleterTests.js
+2 -2
View File
@@ -159,11 +159,11 @@ describe('UserDeleter', function() {
this.UserMock.verify()
})
it('should unsubscribe the user from the news letter', async function() {
it('should delete the user from mailchimp', async function() {
await this.UserDeleter.promises.deleteUser(this.userId)
expect(
this.NewsletterManager.promises.unsubscribe
).to.have.been.calledWith(this.user)
).to.have.been.calledWith(this.user, { delete: true })
})
it('should delete all the projects of a user', async function() {
services/web/test/unit/src/User/UserUpdaterTests.js
+1 -1
View File
@@ -366,7 +366,7 @@ describe('UserUpdater', function() {
err => {
should.not.exist(err)
this.NewsletterManager.changeEmail
.calledWith(this.stubbedUser.email, this.newEmail)
.calledWith(this.stubbedUser, this.newEmail)
.should.equal(true)
done()
}