@budibase/server/src/workspaceMigrations/tests/migrations.integrity.spec.ts

Budibase Web Server

import { context, DesignDocuments } from "@budibase/backend-core"
import { Database } from "@budibase/types"
import {
  getWorkspaceMigrationVerions,
  updateWorkspaceMigrationMetadata,
} from ".."
import * as setup from "../../api/routes/tests/utilities"
import * as migrations from "../migrations"
import { processMigrations } from "../migrationsProcessor"

describe("migration integrity", () => {
  // These test is checking that each migration is "idempotent".
  // We should be able to rerun any migration, with any rerun not modifiying anything. The code should be aware that the migration already ran
  it("each migration can rerun safely", async () => {
    const config = setup.getConfig()
    await config.init()

    async function setCurrentVersion(currentMigrationId: string) {
      for (const workspaceId of [
        config.getDevWorkspaceId(),
        config.getProdWorkspaceId(),
      ]) {
        await config.doInContext(workspaceId, async () => {
          await updateWorkspaceMigrationMetadata({
            workspaceId,
            version: currentMigrationId,
          })
        })
      }
    }

    async function getDocs(db: Database) {
      const allDocs = await db.allDocs({ include_docs: true })
      const documentsToIgnore: string[] = [DesignDocuments.MIGRATIONS]
      return {
        ...allDocs,
        rows: allDocs.rows.filter(r => !documentsToIgnore.includes(r.id)),
      }
    }

    const workspaceId = config.getDevWorkspaceId()
    await config.doInContext(workspaceId, async () => {
      await setCurrentVersion("")
      const devDb = context.getWorkspaceDB()
      const prodDb = context.getProdWorkspaceDB()
      for (let i = 0; i < migrations.MIGRATIONS.length; i++) {
        const migrationsToApply = migrations.MIGRATIONS.slice(0, i + 1)
        const latestMigration =
          migrationsToApply[migrationsToApply.length - 1].id

        const currentVersion = await getWorkspaceMigrationVerions(workspaceId)

        await processMigrations(workspaceId, migrationsToApply)
        expect(await getWorkspaceMigrationVerions(workspaceId)).toBe(
          latestMigration
        )

        const afterMigrationDevDocs = await getDocs(devDb)
        const afterMigrationProdDocs = await getDocs(prodDb)

        await setCurrentVersion(currentVersion)
        expect(await getWorkspaceMigrationVerions(workspaceId)).not.toBe(
          latestMigration
        )

        await processMigrations(workspaceId, migrationsToApply)
        expect(await getWorkspaceMigrationVerions(workspaceId)).toBe(
          latestMigration
        )

        const afterRerunDevDocs = await getDocs(devDb)
        const afterRerunProdDocs = await getDocs(prodDb)

        expect(afterRerunDevDocs).toEqual(afterMigrationDevDocs)
        expect(afterRerunProdDocs).toEqual(afterMigrationProdDocs)
      }
    })
  })
})