Merge pull request #17079 from overleaf/dp-mongoose-callback-subscription-locator

Promisify SubscriptionLocator and SubscriptionLocatorTests

GitOrigin-RevId: 9956a72d0cd94cb0b89da0fc1ec9c0e06fdcfeea
This commit is contained in:
David 2024-02-28 11:20:20 +00:00 committed by Copybot
parent 0827139e48
commit 6a96e160d9
2 changed files with 112 additions and 152 deletions

View file

@ -1,126 +1,115 @@
const { promisify } = require('util')
const { callbackifyAll } = require('@overleaf/promise-utils')
const { Subscription } = require('../../models/Subscription')
const { DeletedSubscription } = require('../../models/DeletedSubscription')
const logger = require('@overleaf/logger')
require('./GroupPlansData') // make sure dynamic group plans are loaded
const SubscriptionLocator = {
getUsersSubscription(userOrId, callback) {
async getUsersSubscription(userOrId) {
const userId = SubscriptionLocator._getUserId(userOrId)
Subscription.findOne({ admin_id: userId }, function (err, subscription) {
logger.debug({ userId }, 'got users subscription')
callback(err, subscription)
})
const subscription = await Subscription.findOne({ admin_id: userId }).exec()
logger.debug({ userId }, 'got users subscription')
return subscription
},
getUserIndividualSubscription(userOrId, callback) {
async getUserIndividualSubscription(userOrId) {
const userId = SubscriptionLocator._getUserId(userOrId)
Subscription.findOne(
{ admin_id: userId, groupPlan: false },
function (err, subscription) {
logger.debug({ userId }, 'got users individual subscription')
callback(err, subscription)
}
)
const subscription = await Subscription.findOne({
admin_id: userId,
groupPlan: false,
}).exec()
logger.debug({ userId }, 'got users individual subscription')
return subscription
},
getManagedGroupSubscriptions(userOrId, callback) {
Subscription.find({
async getManagedGroupSubscriptions(userOrId) {
return await Subscription.find({
manager_ids: userOrId,
groupPlan: true,
})
.populate('admin_id')
.exec(callback)
.exec()
},
getMemberSubscriptions(userOrId, callback) {
async getMemberSubscriptions(userOrId) {
const userId = SubscriptionLocator._getUserId(userOrId)
Subscription.find({ member_ids: userId })
return await Subscription.find({ member_ids: userId })
.populate('admin_id')
.exec(callback)
.exec()
},
getAdminEmail(subscriptionId, callback) {
Subscription.findById(subscriptionId)
async getAdminEmail(subscriptionId) {
const subscription = await Subscription.findById(subscriptionId)
.populate('admin_id', 'email')
.exec((err, subscription) => {
if (err) {
return callback(err)
}
callback(err, subscription?.admin_id?.email)
})
.exec()
return subscription?.admin_id?.email
},
getAdminEmailAndName(subscriptionId, callback) {
Subscription.findById(subscriptionId)
async getAdminEmailAndName(subscriptionId) {
const subscription = await Subscription.findById(subscriptionId)
.populate('admin_id', ['email', 'first_name', 'last_name'])
.exec((err, subscription) => {
if (err) {
return callback(err)
}
callback(err, subscription?.admin_id)
})
.exec()
return subscription?.admin_id
},
hasRecurlyGroupSubscription(userOrId, callback) {
async hasRecurlyGroupSubscription(userOrId) {
const userId = SubscriptionLocator._getUserId(userOrId)
Subscription.exists(
{
groupPlan: true,
recurlySubscription_id: { $exists: true },
$or: [
{ member_ids: userId },
{ manager_ids: userId },
{ admin_id: userId },
],
},
callback
)
return await Subscription.exists({
groupPlan: true,
recurlySubscription_id: { $exists: true },
$or: [
{ member_ids: userId },
{ manager_ids: userId },
{ admin_id: userId },
],
}).exec()
},
getSubscription(subscriptionId, callback) {
Subscription.findOne({ _id: subscriptionId }, callback)
async getSubscription(subscriptionId) {
return await Subscription.findOne({ _id: subscriptionId }).exec()
},
getSubscriptionByMemberIdAndId(userId, subscriptionId, callback) {
Subscription.findOne(
async getSubscriptionByMemberIdAndId(userId, subscriptionId) {
return await Subscription.findOne(
{ member_ids: userId, _id: subscriptionId },
{ _id: 1 },
callback
{ _id: 1 }
).exec()
},
async getGroupSubscriptionsMemberOf(userId) {
return await Subscription.find(
{ member_ids: userId },
{ _id: 1, planCode: 1 }
)
},
getGroupSubscriptionsMemberOf(userId, callback) {
Subscription.find({ member_ids: userId }, { _id: 1, planCode: 1 }, callback)
async getGroupsWithEmailInvite(email) {
return await Subscription.find({ invited_emails: email }).exec()
},
getGroupsWithEmailInvite(email, callback) {
Subscription.find({ invited_emails: email }, callback)
},
getGroupsWithTeamInvitesEmail(email, callback) {
Subscription.find(
async getGroupsWithTeamInvitesEmail(email) {
return await Subscription.find(
{ teamInvites: { $elemMatch: { email } } },
{ teamInvites: 1 },
callback
)
{ teamInvites: 1 }
).exec()
},
getGroupWithV1Id(v1TeamId, callback) {
Subscription.findOne({ 'overleaf.id': v1TeamId }, callback)
async getGroupWithV1Id(v1TeamId) {
return await Subscription.findOne({ 'overleaf.id': v1TeamId }).exec()
},
getUserDeletedSubscriptions(userId, callback) {
DeletedSubscription.find({ 'subscription.admin_id': userId }, callback)
async getUserDeletedSubscriptions(userId) {
return await DeletedSubscription.find({
'subscription.admin_id': userId,
}).exec()
},
getDeletedSubscription(subscriptionId, callback) {
DeletedSubscription.findOne(
{
'subscription._id': subscriptionId,
},
callback
)
async getDeletedSubscription(subscriptionId) {
return await DeletedSubscription.findOne({
'subscription._id': subscriptionId,
}).exec()
},
_getUserId(userOrId) {
@ -132,37 +121,7 @@ const SubscriptionLocator = {
},
}
SubscriptionLocator.promises = {
getUsersSubscription: promisify(SubscriptionLocator.getUsersSubscription),
getUserIndividualSubscription: promisify(
SubscriptionLocator.getUserIndividualSubscription
),
getManagedGroupSubscriptions: promisify(
SubscriptionLocator.getManagedGroupSubscriptions
),
getMemberSubscriptions: promisify(SubscriptionLocator.getMemberSubscriptions),
getAdminEmail: promisify(SubscriptionLocator.getAdminEmail),
getAdminEmailAndName: promisify(SubscriptionLocator.getAdminEmailAndName),
getSubscription: promisify(SubscriptionLocator.getSubscription),
getSubscriptionByMemberIdAndId: promisify(
SubscriptionLocator.getSubscriptionByMemberIdAndId
),
getGroupSubscriptionsMemberOf: promisify(
SubscriptionLocator.getGroupSubscriptionsMemberOf
),
getGroupsWithEmailInvite: promisify(
SubscriptionLocator.getGroupsWithEmailInvite
),
getGroupsWithTeamInvitesEmail: promisify(
SubscriptionLocator.getGroupsWithTeamInvitesEmail
),
getGroupWithV1Id: promisify(SubscriptionLocator.getGroupWithV1Id),
getUserDeletedSubscriptions: promisify(
SubscriptionLocator.getUserDeletedSubscriptions
),
getDeletedSubscription: promisify(SubscriptionLocator.getDeletedSubscription),
hasRecurlyGroupSubscription: promisify(
SubscriptionLocator.hasRecurlyGroupSubscription
),
module.exports = {
...callbackifyAll(SubscriptionLocator),
promises: SubscriptionLocator,
}
module.exports = SubscriptionLocator

View file

@ -2,22 +2,29 @@ const SandboxedModule = require('sandboxed-module')
const sinon = require('sinon')
const modulePath =
'../../../../app/src/Features/Subscription/SubscriptionLocator'
const { expect } = require('chai')
describe('Subscription Locator Tests', function () {
beforeEach(function () {
this.user = { _id: '5208dd34438842e2db333333' }
this.subscription = { hello: 'world' }
this.Subscription = {
findOne: sinon.stub(),
find: sinon.stub(),
findOne: sinon.stub().returns({
exec: sinon.stub().resolves(),
}),
find: sinon.stub().returns({
exec: sinon.stub().resolves(),
}),
}
this.DeletedSubscription = {
findOne: sinon.stub().yields(),
find: sinon.stub().yields(),
}
this.SSOConfig = {
findById: sinon.stub().yields(),
findOne: sinon.stub().returns({
exec: sinon.stub().resolves(),
}),
find: sinon.stub().returns({
exec: sinon.stub().resolves(),
}),
}
this.SubscriptionLocator = SandboxedModule.require(modulePath, {
requires: {
'./GroupPlansData': {},
@ -35,45 +42,39 @@ describe('Subscription Locator Tests', function () {
})
describe('finding users subscription', function () {
it('should send the users features', function (done) {
this.Subscription.findOne.callsArgWith(1, null, this.subscription)
this.SubscriptionLocator.getUsersSubscription(
this.user,
(err, subscription) => {
if (err) return done(err)
this.Subscription.findOne
.calledWith({ admin_id: this.user._id })
.should.equal(true)
subscription.should.equal(this.subscription)
done()
}
)
it('should send the users features', async function () {
this.Subscription.findOne.returns({
exec: sinon.stub().resolves(this.subscription),
})
const subscription =
await this.SubscriptionLocator.promises.getUsersSubscription(this.user)
this.Subscription.findOne
.calledWith({ admin_id: this.user._id })
.should.equal(true)
subscription.should.equal(this.subscription)
})
it('should error if not found', function (done) {
this.Subscription.findOne.callsArgWith(1, 'not found')
this.SubscriptionLocator.getUsersSubscription(
this.user,
(err, subscription) => {
err.should.exist
done()
}
)
it('should error if not found', async function () {
this.Subscription.findOne.returns({
exec: sinon.stub().rejects('not found'),
})
await expect(
this.SubscriptionLocator.promises.getUsersSubscription(this.user)
).to.be.rejected
})
it('should take a user id rather than the user object', function (done) {
this.Subscription.findOne.callsArgWith(1, null, this.subscription)
this.SubscriptionLocator.getUsersSubscription(
this.user._id,
(err, subscription) => {
if (err) return done(err)
this.Subscription.findOne
.calledWith({ admin_id: this.user._id })
.should.equal(true)
subscription.should.equal(this.subscription)
done()
}
)
it('should take a user id rather than the user object', async function () {
this.Subscription.findOne.returns({
exec: sinon.stub().resolves(this.subscription),
})
const subscription =
await this.SubscriptionLocator.promises.getUsersSubscription(
this.user._id
)
this.Subscription.findOne
.calledWith({ admin_id: this.user._id })
.should.equal(true)
subscription.should.equal(this.subscription)
})
})
})