mongodb.js 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117
  1. const Metrics = require('@overleaf/metrics')
  2. const { ObjectId } = require('mongodb')
  3. const OError = require('@overleaf/o-error')
  4. const { getNativeDb } = require('./Mongoose')
  5. if (
  6. typeof global.beforeEach === 'function' &&
  7. process.argv.join(' ').match(/unit/)
  8. ) {
  9. throw new Error(
  10. 'It looks like unit tests are running, but you are connecting to Mongo. Missing a stub?'
  11. )
  12. }
  13. let setupDbPromise
  14. async function waitForDb() {
  15. if (!setupDbPromise) {
  16. setupDbPromise = setupDb()
  17. }
  18. await setupDbPromise
  19. }
  20. const db = {}
  21. async function setupDb() {
  22. const internalDb = await getNativeDb()
  23. Metrics.mongodb.monitor(internalDb)
  24. db.contacts = internalDb.collection('contacts')
  25. db.deletedFiles = internalDb.collection('deletedFiles')
  26. db.deletedProjects = internalDb.collection('deletedProjects')
  27. db.deletedSubscriptions = internalDb.collection('deletedSubscriptions')
  28. db.deletedUsers = internalDb.collection('deletedUsers')
  29. db.dropboxEntities = internalDb.collection('dropboxEntities')
  30. db.dropboxProjects = internalDb.collection('dropboxProjects')
  31. db.docHistory = internalDb.collection('docHistory')
  32. db.docHistoryIndex = internalDb.collection('docHistoryIndex')
  33. db.docOps = internalDb.collection('docOps')
  34. db.docSnapshots = internalDb.collection('docSnapshots')
  35. db.docs = internalDb.collection('docs')
  36. db.feedbacks = internalDb.collection('feedbacks')
  37. db.githubSyncEntityVersions = internalDb.collection(
  38. 'githubSyncEntityVersions'
  39. )
  40. db.githubSyncProjectStates = internalDb.collection('githubSyncProjectStates')
  41. db.githubSyncUserCredentials = internalDb.collection(
  42. 'githubSyncUserCredentials'
  43. )
  44. db.institutions = internalDb.collection('institutions')
  45. db.messages = internalDb.collection('messages')
  46. db.migrations = internalDb.collection('migrations')
  47. db.notifications = internalDb.collection('notifications')
  48. db.oauthAccessTokens = internalDb.collection('oauthAccessTokens')
  49. db.oauthApplications = internalDb.collection('oauthApplications')
  50. db.oauthAuthorizationCodes = internalDb.collection('oauthAuthorizationCodes')
  51. db.projectAuditLogEntries = internalDb.collection('projectAuditLogEntries')
  52. db.projectHistoryChunks = internalDb.collection('projectHistoryChunks')
  53. db.projectHistoryFailures = internalDb.collection('projectHistoryFailures')
  54. db.projectHistoryLabels = internalDb.collection('projectHistoryLabels')
  55. db.projectHistoryMetaData = internalDb.collection('projectHistoryMetaData')
  56. db.projectHistorySyncState = internalDb.collection('projectHistorySyncState')
  57. db.projectInvites = internalDb.collection('projectInvites')
  58. db.projects = internalDb.collection('projects')
  59. db.publishers = internalDb.collection('publishers')
  60. db.rooms = internalDb.collection('rooms')
  61. db.samlCache = internalDb.collection('samlCache')
  62. db.samlLogs = internalDb.collection('samlLogs')
  63. db.spellingPreferences = internalDb.collection('spellingPreferences')
  64. db.splittests = internalDb.collection('splittests')
  65. db.subscriptions = internalDb.collection('subscriptions')
  66. db.surveys = internalDb.collection('surveys')
  67. db.systemmessages = internalDb.collection('systemmessages')
  68. db.tags = internalDb.collection('tags')
  69. db.teamInvites = internalDb.collection('teamInvites')
  70. db.templates = internalDb.collection('templates')
  71. db.tokens = internalDb.collection('tokens')
  72. db.userAuditLogEntries = internalDb.collection('userAuditLogEntries')
  73. db.users = internalDb.collection('users')
  74. db.userstubs = internalDb.collection('userstubs')
  75. }
  76. async function getCollectionNames() {
  77. const internalDb = await getNativeDb()
  78. const collections = await internalDb.collections()
  79. return collections.map(collection => collection.collectionName)
  80. }
  81. async function dropTestDatabase() {
  82. const internalDb = await getNativeDb()
  83. const dbName = internalDb.databaseName
  84. const env = process.env.NODE_ENV
  85. if (dbName !== 'test-sharelatex' || env !== 'test') {
  86. throw new OError(
  87. `Refusing to clear database '${dbName}' in environment '${env}'`
  88. )
  89. }
  90. await internalDb.dropDatabase()
  91. }
  92. /**
  93. * WARNING: Consider using a pre-populated collection from `db` to avoid typos!
  94. */
  95. async function getCollectionInternal(name) {
  96. const internalDb = await getNativeDb()
  97. return internalDb.collection(name)
  98. }
  99. module.exports = {
  100. db,
  101. ObjectId,
  102. getCollectionNames,
  103. getCollectionInternal,
  104. dropTestDatabase,
  105. waitForDb,
  106. }