overleaf/services/web/migrations/lib/helpers.js
Eric Mc Sween 65f20a4d56 Merge pull request #18186 from overleaf/em-migration-dependencies
Add a migration helper checking dependent migrations

GitOrigin-RevId: 96aa6238b20115206554faaa4c2aefc537bbe7e8
2024-05-03 08:04:36 +00:00

68 lines
1.7 KiB
JavaScript

// @ts-check
const {
db,
getCollectionNames,
getCollectionInternal,
waitForDb,
} = require('../../app/src/infrastructure/mongodb')
async function addIndexesToCollection(collection, indexes) {
return Promise.all(
indexes.map(index => {
index.background = true
return collection.createIndex(index.key, index)
})
)
}
async function dropIndexesFromCollection(collection, indexes) {
return Promise.all(
indexes.map(async index => {
try {
await collection.dropIndex(index.name)
} catch (err) {
if (err.code === 27 /* IndexNotFound */) {
console.log(`Index ${index.name} not found; drop was a no-op.`)
} else {
throw err
}
}
})
)
}
async function dropCollection(collectionName) {
await waitForDb()
if (db[collectionName]) {
throw new Error(`blocking drop of an active collection: ${collectionName}`)
}
const allCollections = await getCollectionNames()
if (!allCollections.includes(collectionName)) return
const collection = await getCollectionInternal(collectionName)
await collection.drop()
}
/**
* Asserts that a dependent migration has run. Throws an error otherwise.
*
* @param {string} migrationName
*/
async function assertDependency(migrationName) {
await waitForDb()
const migrations = await getCollectionInternal('migrations')
const migration = await migrations.findOne({ name: migrationName })
if (migration == null) {
throw new Error(
`Bad migration order: ${migrationName} should run before this migration`
)
}
}
module.exports = {
addIndexesToCollection,
dropIndexesFromCollection,
dropCollection,
assertDependency,
}