Subscription.mjs 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204
  1. import { db, ObjectId } from '../../../../app/src/infrastructure/mongodb.js'
  2. import { expect } from 'chai'
  3. import { callbackifyClass } from '@overleaf/promise-utils'
  4. import SubscriptionUpdater from '../../../../app/src/Features/Subscription/SubscriptionUpdater.js'
  5. import PermissionsManager from '../../../../app/src/Features/Authorization/PermissionsManager.js'
  6. import SSOConfigManager from '../../../../modules/group-settings/app/src/sso/SSOConfigManager.mjs'
  7. import { Subscription as SubscriptionModel } from '../../../../app/src/models/Subscription.js'
  8. import { DeletedSubscription as DeletedSubscriptionModel } from '../../../../app/src/models/DeletedSubscription.js'
  9. import Modules from '../../../../app/src/infrastructure/Modules.js'
  10. class PromisifiedSubscription {
  11. constructor(options = {}) {
  12. this.admin_id = options.adminId || new ObjectId()
  13. this.overleaf = options.overleaf || {}
  14. this.groupPlan = options.groupPlan
  15. this.manager_ids = options.managerIds || [this.admin_id]
  16. this.member_ids = options.memberIds || []
  17. this.membersLimit = options.membersLimit || 0
  18. this.invited_emails = options.invitedEmails || []
  19. this.teamName = options.teamName
  20. this.teamInvites = options.teamInvites || []
  21. this.planCode = options.planCode
  22. this.recurlySubscription_id = options.recurlySubscription_id
  23. this.features = options.features
  24. this.ssoConfig = options.ssoConfig
  25. this.groupPolicy = options.groupPolicy
  26. this.addOns = options.addOns
  27. this.paymentProvider = options.paymentProvider
  28. }
  29. async ensureExists() {
  30. if (this._id) {
  31. return null
  32. }
  33. const options = { upsert: true, new: true, setDefaultsOnInsert: true }
  34. const subscription = await SubscriptionModel.findOneAndUpdate(
  35. { admin_id: this.admin_id },
  36. this,
  37. options
  38. ).exec()
  39. this._id = subscription._id
  40. }
  41. async get() {
  42. return await db.subscriptions.findOne({ _id: new ObjectId(this._id) })
  43. }
  44. async getSSOConfig() {
  45. const subscription = await this.get()
  46. if (!subscription.ssoConfig) {
  47. return
  48. }
  49. return await db.ssoConfigs.findOne({
  50. _id: new ObjectId(subscription.ssoConfig),
  51. })
  52. }
  53. async getWithGroupPolicy() {
  54. // eslint-disable-next-line no-restricted-syntax
  55. return await SubscriptionModel.findById(this._id)
  56. .populate('groupPolicy')
  57. .exec()
  58. }
  59. async setManagerIds(managerIds) {
  60. return await SubscriptionModel.findOneAndUpdate(
  61. { _id: new ObjectId(this._id) },
  62. { manager_ids: managerIds }
  63. )
  64. }
  65. async setSSOConfig(ssoConfig) {
  66. const subscription = await this.get()
  67. return await SSOConfigManager.promises.updateSubscriptionSSOConfig(
  68. subscription,
  69. ssoConfig
  70. )
  71. }
  72. async refreshUsersFeatures() {
  73. return await SubscriptionUpdater.promises.refreshUsersFeatures(this)
  74. }
  75. async enableManagedUsers() {
  76. await Modules.promises.hooks.fire('enableManagedUsers', this._id, {
  77. initiatorId: this.admin_id,
  78. ipAddress: '123.456.789.0',
  79. })
  80. }
  81. async disableManagedUsers() {
  82. await Modules.promises.hooks.fire('disableManagedUsers', this._id)
  83. }
  84. async enableFeatureSSO() {
  85. await SubscriptionModel.findOneAndUpdate(
  86. { _id: new ObjectId(this._id) },
  87. { 'features.groupSSO': true }
  88. ).exec()
  89. }
  90. async setValidatedSSO() {
  91. const doc = await db.subscriptions.findOne({ _id: new ObjectId(this._id) })
  92. const ssoConfigId = doc.ssoConfig
  93. return await db.ssoConfigs.findOneAndUpdate(
  94. { _id: ssoConfigId },
  95. { $set: { validated: true } }
  96. )
  97. }
  98. async setValidatedAndEnabledSSO() {
  99. const doc = await db.subscriptions.findOne({ _id: new ObjectId(this._id) })
  100. const ssoConfigId = doc.ssoConfig
  101. return await db.ssoConfigs.findOneAndUpdate(
  102. { _id: ssoConfigId },
  103. { $set: { enabled: true, validated: true } }
  104. )
  105. }
  106. async getEnrollmentForUser(user) {
  107. const [enrollment] = await Modules.promises.hooks.fire(
  108. 'getManagedUsersEnrollmentForUser',
  109. user
  110. )
  111. return enrollment
  112. }
  113. getCapabilities(groupPolicy) {
  114. return PermissionsManager.getUserCapabilities(groupPolicy)
  115. }
  116. async getUserValidationStatus(params) {
  117. return await PermissionsManager.promises.getUserValidationStatus(params)
  118. }
  119. async enrollManagedUser(user) {
  120. const subscription = await SubscriptionModel.findById(this._id).exec()
  121. return await Modules.promises.hooks.fire(
  122. 'enrollInManagedSubscription',
  123. user._id,
  124. subscription,
  125. {
  126. initiatorId: user._id,
  127. ipAddress: '0:0:0:0',
  128. }
  129. )
  130. }
  131. async expectDeleted(deleterData) {
  132. const deletedSubscriptions = await DeletedSubscriptionModel.find({
  133. 'subscription._id': this._id,
  134. }).exec()
  135. expect(deletedSubscriptions.length).to.equal(1)
  136. const deletedSubscription = deletedSubscriptions[0]
  137. expect(deletedSubscription.subscription.teamInvites).to.be.empty
  138. expect(deletedSubscription.subscription.invited_emails).to.be.empty
  139. expect(deletedSubscription.deleterData.deleterIpAddress).to.equal(
  140. deleterData.ip
  141. )
  142. if (deleterData.id) {
  143. expect(deletedSubscription.deleterData.deleterId.toString()).to.equal(
  144. deleterData.id.toString()
  145. )
  146. } else {
  147. expect(deletedSubscription.deleterData.deleterId).to.be.undefined
  148. }
  149. const subscription = await SubscriptionModel.findById(this._id).exec()
  150. expect(subscription).to.be.null
  151. }
  152. async addMember(userId) {
  153. return await SubscriptionModel.findOneAndUpdate(
  154. { _id: new ObjectId(this._id) },
  155. { $push: { member_ids: userId } }
  156. ).exec()
  157. }
  158. async inviteUser(adminUser, email) {
  159. await adminUser.login()
  160. return await adminUser.doRequest('POST', {
  161. url: `/manage/groups/${this._id}/invites`,
  162. json: {
  163. email,
  164. },
  165. })
  166. }
  167. }
  168. const Subscription = callbackifyClass(PromisifiedSubscription, {
  169. without: ['getCapabilities'],
  170. })
  171. Subscription.promises = class extends PromisifiedSubscription {}
  172. export default Subscription