overleaf/services/web/app/src/infrastructure/mongodb.js

const Metrics = require('@overleaf/metrics')
const { ObjectId } = require('mongodb')
const OError = require('@overleaf/o-error')
const {
  addOptionalCleanupHandlerAfterDrainingConnections,
} = require('./GracefulShutdown')
const { getNativeDb } = require('./Mongoose')

if (
  typeof global.beforeEach === 'function' &&
  process.argv.join(' ').match(/unit/)
) {
  throw new Error(
    'It looks like unit tests are running, but you are connecting to Mongo. Missing a stub?'
  )
}

let setupDbPromise
async function waitForDb() {
  if (!setupDbPromise) {
    setupDbPromise = setupDb()
  }
  await setupDbPromise
}

const db = {}
async function setupDb() {
  const internalDb = await getNativeDb()
  collectStatsForDb(internalDb, 'shared')

  db.contacts = internalDb.collection('contacts')
  db.deletedFiles = internalDb.collection('deletedFiles')
  db.deletedProjects = internalDb.collection('deletedProjects')
  db.deletedSubscriptions = internalDb.collection('deletedSubscriptions')
  db.deletedUsers = internalDb.collection('deletedUsers')
  db.dropboxEntities = internalDb.collection('dropboxEntities')
  db.dropboxProjects = internalDb.collection('dropboxProjects')
  db.docHistory = internalDb.collection('docHistory')
  db.docHistoryIndex = internalDb.collection('docHistoryIndex')
  db.docOps = internalDb.collection('docOps')
  db.docSnapshots = internalDb.collection('docSnapshots')
  db.docs = internalDb.collection('docs')
  db.feedbacks = internalDb.collection('feedbacks')
  db.githubSyncEntityVersions = internalDb.collection(
    'githubSyncEntityVersions'
  )
  db.githubSyncProjectStates = internalDb.collection('githubSyncProjectStates')
  db.githubSyncUserCredentials = internalDb.collection(
    'githubSyncUserCredentials'
  )
  db.institutions = internalDb.collection('institutions')
  db.messages = internalDb.collection('messages')
  db.migrations = internalDb.collection('migrations')
  db.notifications = internalDb.collection('notifications')
  db.oauthAccessTokens = internalDb.collection('oauthAccessTokens')
  db.oauthApplications = internalDb.collection('oauthApplications')
  db.oauthAuthorizationCodes = internalDb.collection('oauthAuthorizationCodes')
  db.projectAuditLogEntries = internalDb.collection('projectAuditLogEntries')
  db.projectHistoryChunks = internalDb.collection('projectHistoryChunks')
  db.projectHistoryFailures = internalDb.collection('projectHistoryFailures')
  db.projectHistoryLabels = internalDb.collection('projectHistoryLabels')
  db.projectHistoryMetaData = internalDb.collection('projectHistoryMetaData')
  db.projectHistorySyncState = internalDb.collection('projectHistorySyncState')
  db.projectInvites = internalDb.collection('projectInvites')
  db.projects = internalDb.collection('projects')
  db.publishers = internalDb.collection('publishers')
  db.rooms = internalDb.collection('rooms')
  db.samlCache = internalDb.collection('samlCache')
  db.samlLogs = internalDb.collection('samlLogs')
  db.spellingPreferences = internalDb.collection('spellingPreferences')
  db.splittests = internalDb.collection('splittests')
  db.subscriptions = internalDb.collection('subscriptions')
  db.surveys = internalDb.collection('surveys')
  db.systemmessages = internalDb.collection('systemmessages')
  db.tags = internalDb.collection('tags')
  db.teamInvites = internalDb.collection('teamInvites')
  db.templates = internalDb.collection('templates')
  db.tokens = internalDb.collection('tokens')
  db.userAuditLogEntries = internalDb.collection('userAuditLogEntries')
  db.users = internalDb.collection('users')
  db.userstubs = internalDb.collection('userstubs')
}

async function getCollectionNames() {
  const internalDb = await getNativeDb()

  const collections = await internalDb.collections()
  return collections.map(collection => collection.collectionName)
}

async function dropTestDatabase() {
  const internalDb = await getNativeDb()
  const dbName = internalDb.databaseName
  const env = process.env.NODE_ENV

  if (dbName !== 'test-sharelatex' || env !== 'test') {
    throw new OError(
      `Refusing to clear database '${dbName}' in environment '${env}'`
    )
  }

  await internalDb.dropDatabase()
}

/**
 * WARNING: Consider using a pre-populated collection from `db` to avoid typos!
 */
async function getCollectionInternal(name) {
  const internalDb = await getNativeDb()
  return internalDb.collection(name)
}

function collectStatsForDb(internalDb, label) {
  const collectOnce = () => {
    for (const [name, server] of internalDb.s.topology.s.servers.entries()) {
      const { availableConnectionCount, waitQueueSize } = server.s.pool
      const { maxPoolSize } = server.s.pool.options
      const opts = { status: `${label}:${name}` }
      Metrics.gauge('mongo_connection_pool_max', maxPoolSize, 1, opts)
      Metrics.gauge(
        'mongo_connection_pool_available',
        availableConnectionCount,
        1,
        opts
      )
      Metrics.gauge('mongo_connection_pool_waiting', waitQueueSize, 1, opts)
    }
  }
  collectOnce() // init metrics
  const intervalHandle = setInterval(collectOnce, 60_000)
  addOptionalCleanupHandlerAfterDrainingConnections(
    `collect mongo connection pool metrics (${label})`,
    () => {
      clearInterval(intervalHandle)
      // collect one more time.
      collectOnce()
    }
  )
}

module.exports = {
  db,
  ObjectId,
  getCollectionNames,
  getCollectionInternal,
  dropTestDatabase,
  waitForDb,
  collectStatsForDb,
}