Merge pull request #14089 from Budibase/fix/separate-sqs-migration-env-var

Separate SQS migration into another environment variable

packages/server/src/appMigrations/migrations.ts

@@ -10,6 +10,6 @@ export const MIGRATIONS: AppMigration[] = [
   {
     id: "20240604153647_initial_sqs",
     func: m20240604153647_initial_sqs,
-    disabled: !env.SQS_SEARCH_ENABLE,
+    disabled: !(env.SQS_MIGRATION_ENABLE || env.SQS_SEARCH_ENABLE),
   },
 ]

packages/server/src/appMigrations/migrations/20240604153647_initial_sqs.ts

@@ -40,7 +40,7 @@ const migration = async () => {
   // only do initial search if environment is using SQS already
   // initial search makes sure that all the indexes have been created
   // and are ready to use, avoiding any initial waits for large tables
-  if (env.SQS_SEARCH_ENABLE) {
+  if (env.SQS_MIGRATION_ENABLE || env.SQS_SEARCH_ENABLE) {
     const tables = await sdk.tables.getAllInternalTables()
     // do these one by one - running in parallel could cause problems
     for (let table of tables) {

packages/server/src/appMigrations/migrations/tests/20240604153647_initial_sqs.spec.ts

@@ -66,16 +66,21 @@ function oldLinkDocument(): Omit<LinkDocument, "tableId"> {
   }
 }
 
-async function sqsDisabled(cb: () => Promise<void>) {
-  await config.withEnv({ SQS_SEARCH_ENABLE: "" }, cb)
+type SQSEnvVar = "SQS_MIGRATION_ENABLE" | "SQS_SEARCH_ENABLE"
+
+async function sqsDisabled(envVar: SQSEnvVar, cb: () => Promise<void>) {
+  await config.withEnv({ [envVar]: "" }, cb)
 }
 
-async function sqsEnabled(cb: () => Promise<void>) {
-  await config.withEnv({ SQS_SEARCH_ENABLE: "1" }, cb)
+async function sqsEnabled(envVar: SQSEnvVar, cb: () => Promise<void>) {
+  await config.withEnv({ [envVar]: "1" }, cb)
 }
 
-beforeAll(async () => {
-  await sqsDisabled(async () => {
+describe.each(["SQS_MIGRATION_ENABLE", "SQS_SEARCH_ENABLE"] as SQSEnvVar[])(
+  "SQS migration with (%s)",
+  envVar => {
+    beforeAll(async () => {
+      await sqsDisabled(envVar, async () => {
         await config.init()
         const table = await config.api.table.save(basicTable())
         tableId = table._id!
@@ -83,13 +88,12 @@ beforeAll(async () => {
         // old link document
         await db.put(oldLinkDocument())
       })
-})
+    })
 
-describe("SQS migration", () => {
     it("test migration runs as expected against an older DB", async () => {
       const db = dbCore.getDB(config.appId!)
       // confirm nothing exists initially
-    await sqsDisabled(async () => {
+      await sqsDisabled(envVar, async () => {
         let error: any | undefined
         try {
           await db.get(SQLITE_DESIGN_DOC_ID)
@@ -99,7 +103,7 @@ describe("SQS migration", () => {
         expect(error).toBeDefined()
         expect(error.status).toBe(404)
       })
-    await sqsEnabled(async () => {
+      await sqsEnabled(envVar, async () => {
         await processMigrations(config.appId!, MIGRATIONS)
         const designDoc = await db.get<SQLiteDefinition>(SQLITE_DESIGN_DOC_ID)
         expect(designDoc.sql.tables).toBeDefined()
@@ -126,4 +130,5 @@ describe("SQS migration", () => {
         expect(linkDoc.doc2.rowId).toEqual(rowId1)
       })
     })
-})
+  }
+)

packages/server/src/environment.ts

@@ -92,6 +92,7 @@ const environment = {
   SQL_LOGGING_ENABLE: process.env.SQL_LOGGING_ENABLE,
   SQL_ALIASING_DISABLE: process.env.SQL_ALIASING_DISABLE,
   SQS_SEARCH_ENABLE: process.env.SQS_SEARCH_ENABLE,
+  SQS_MIGRATION_ENABLE: process.env.SQS_MIGRATION_ENABLE,
   // flags
   ALLOW_DEV_AUTOMATIONS: process.env.ALLOW_DEV_AUTOMATIONS,
   DISABLE_THREADING: process.env.DISABLE_THREADING,