overleaf/services/docstore/app/js/MongoManager.js

/* eslint-disable
    camelcase,
*/
// TODO: This file was created by bulk-decaffeinate.
// Fix any style issues and re-enable lint.
/*
 * decaffeinate suggestions:
 * DS102: Remove unnecessary code created because of implicit returns
 * DS207: Consider shorter variations of null checks
 * Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
 */
let MongoManager
const { db, ObjectId } = require('./mongodb')
const logger = require('logger-sharelatex')
const metrics = require('@overleaf/metrics')
const Settings = require('@overleaf/settings')
const Errors = require('./Errors')
const { promisify } = require('util')

module.exports = MongoManager = {
  findDoc(project_id, doc_id, filter, callback) {
    if (callback == null) {
      callback = function () {}
    }
    db.docs.findOne(
      {
        _id: ObjectId(doc_id.toString()),
        project_id: ObjectId(project_id.toString()),
      },
      {
        projection: filter,
      },
      callback
    )
  },

  getProjectsDeletedDocs(project_id, filter, callback) {
    db.docs
      .find(
        {
          project_id: ObjectId(project_id.toString()),
          deleted: true,
        },
        {
          projection: filter,
          sort: { deletedAt: -1 },
          limit: Settings.max_deleted_docs,
        }
      )
      .toArray(callback)
  },

  getProjectsDocs(project_id, options, filter, callback) {
    const query = { project_id: ObjectId(project_id.toString()) }
    if (!options.include_deleted) {
      query.deleted = { $ne: true }
    }
    const queryOptions = {
      projection: filter,
    }
    if (options.limit) {
      queryOptions.limit = options.limit
    }
    db.docs.find(query, queryOptions).toArray(callback)
  },

  getArchivedProjectDocs(project_id, maxResults, callback) {
    const query = {
      project_id: ObjectId(project_id.toString()),
      inS3: true,
    }
    db.docs
      .find(query, { projection: { _id: 1 }, limit: maxResults })
      .toArray(callback)
  },

  getNonArchivedProjectDocs(project_id, maxResults, callback) {
    const query = {
      project_id: ObjectId(project_id.toString()),
      inS3: { $ne: true },
    }
    db.docs.find(query, { limit: maxResults }).toArray(callback)
  },

  getNonDeletedArchivedProjectDocs(project_id, maxResults, callback) {
    const query = {
      project_id: ObjectId(project_id.toString()),
      deleted: { $ne: true },
      inS3: true,
    }
    db.docs
      .find(query, { projection: { _id: 1 }, limit: maxResults })
      .toArray(callback)
  },

  upsertIntoDocCollection(project_id, doc_id, updates, callback) {
    const update = {
      $set: updates,
      $inc: {
        rev: 1,
      },
      $unset: {
        inS3: true,
      },
    }
    update.$set.project_id = ObjectId(project_id)
    db.docs.updateOne(
      { _id: ObjectId(doc_id) },
      update,
      { upsert: true },
      callback
    )
  },

  patchDoc(project_id, doc_id, meta, callback) {
    db.docs.updateOne(
      {
        _id: ObjectId(doc_id),
        project_id: ObjectId(project_id),
      },
      { $set: meta },
      callback
    )
  },

  markDocAsArchived(doc_id, rev, callback) {
    const update = {
      $set: {},
      $unset: {},
    }
    update.$set.inS3 = true
    update.$unset.lines = true
    update.$unset.ranges = true
    const query = {
      _id: doc_id,
      rev,
    }
    db.docs.updateOne(query, update, callback)
  },

  getDocVersion(doc_id, callback) {
    if (callback == null) {
      callback = function () {}
    }
    db.docOps.findOne(
      {
        doc_id: ObjectId(doc_id),
      },
      {
        projection: {
          version: 1,
        },
      },
      function (error, doc) {
        if (error != null) {
          return callback(error)
        }
        callback(null, (doc && doc.version) || 0)
      }
    )
  },

  setDocVersion(doc_id, version, callback) {
    if (callback == null) {
      callback = function () {}
    }
    db.docOps.updateOne(
      {
        doc_id: ObjectId(doc_id),
      },
      {
        $set: { version },
      },
      {
        upsert: true,
      },
      callback
    )
  },

  getDocRev(doc_id, callback) {
    db.docs.findOne(
      {
        _id: ObjectId(doc_id.toString()),
      },
      {
        projection: { rev: 1 },
      },
      function (err, doc) {
        if (err != null) {
          return callback(err)
        }
        callback(null, doc && doc.rev)
      }
    )
  },

  // Helper method  to support optimistic locking. Call the provided method for
  // an existing doc and return the result if the rev in mongo is unchanged when
  // checked afterwards. If the rev has changed, return a DocModifiedError.
  withRevCheck(doc, method, callback) {
    method(doc._id, function (err, result) {
      if (err) return callback(err)
      MongoManager.getDocRev(doc._id, function (err, currentRev) {
        if (err) return callback(err)
        if (isNaN(currentRev) || isNaN(doc.rev)) {
          return callback(
            new Errors.DocRevValueError('doc rev is NaN', {
              doc_id: doc._id,
              rev: doc.rev,
              currentRev,
            })
          )
        }
        if (doc.rev !== currentRev) {
          return callback(
            new Errors.DocModifiedError('doc rev has changed', {
              doc_id: doc._id,
              rev: doc.rev,
              currentRev,
            })
          )
        }
        return callback(null, result)
      })
    })
  },

  destroyDoc(doc_id, callback) {
    db.docs.deleteOne(
      {
        _id: ObjectId(doc_id),
      },
      function (err) {
        if (err != null) {
          return callback(err)
        }
        db.docOps.deleteOne(
          {
            doc_id: ObjectId(doc_id),
          },
          callback
        )
      }
    )
  },
}

const methods = Object.getOwnPropertyNames(MongoManager)

module.exports.promises = {}
for (const method of methods) {
  metrics.timeAsyncMethod(MongoManager, method, 'mongo.MongoManager', logger)
  module.exports.promises[method] = promisify(module.exports[method])
}