@budibase/worker 3.37.4 → 3.38.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/worker",
   "email": "hi@budibase.com",
-  "version": "3.37.4",
+  "version": "3.38.0",
   "description": "Budibase background service",
   "main": "src/index.ts",
   "repository": {
@@ -80,5 +80,5 @@
     "supertest": "6.3.3",
     "timekeeper": "2.2.0"
   },
-  "gitHead": "cde1ea48fb34a1f21307a047066170830f41f2f2"
+  "gitHead": "a16eac4b5fd97bb1f8a1e5b04b25ddbd17f1cf44"
 }

package/src/sdk/tenants/tenants.ts

@@ -23,31 +23,30 @@ export async function unlockTenant(tenantId: string) {
 }
 
 export async function setActivation(tenantId: string, active: boolean) {
-  const db = tenancy.getTenantDB(tenantId)
-  const settingsConfig = await db.tryGet<SettingsConfig>(
-    configs.generateConfigID(ConfigType.SETTINGS)
-  )
-  if (!settingsConfig?.config) {
-    throw new Error(
-      `Cannot set activation. Settings config not found for tenant ${tenantId}`
-    )
-  }
+  const { db, settingsConfig } = await getOrCreateSettingsConfig(tenantId)
   settingsConfig.config.active = active
   await db.put(settingsConfig)
 }
 
 async function setLock(tenantId: string, lockReason?: LockReason) {
+  const { db, settingsConfig } = await getOrCreateSettingsConfig(tenantId)
+  settingsConfig.config.lockedBy = lockReason
+  await db.put(settingsConfig)
+}
+
+async function getOrCreateSettingsConfig(tenantId: string) {
   const db = tenancy.getTenantDB(tenantId)
-  const settingsConfig = await db.tryGet<SettingsConfig>(
+  const settingsConfig = (await db.tryGet<SettingsConfig>(
     configs.generateConfigID(ConfigType.SETTINGS)
-  )
-  if (!settingsConfig?.config) {
-    throw new Error(
-      `Cannot lock. Settings config not found for tenant ${tenantId}`
-    )
+  )) || {
+    _id: configs.generateConfigID(ConfigType.SETTINGS),
+    type: ConfigType.SETTINGS,
+    config: {},
   }
-  settingsConfig.config.lockedBy = lockReason
-  await db.put(settingsConfig)
+
+  settingsConfig.config ||= {}
+
+  return { db, settingsConfig }
 }
 
 async function removeGlobalDB(tenantId: string) {

package/src/sdk/tenants/tests/tenants.spec.ts

@@ -93,19 +93,23 @@ describe("tenants", () => {
       })
     })
 
-    it("should throw error when settings config not found", async () => {
-      const tenantId = structures.tenant.id()
+    it("should create settings config when not found", async () => {
       const lockReason = LockReason.FREE_TIER
 
       mockDb.tryGet.mockResolvedValue(null)
 
-      await expect(lockTenant(tenantId, lockReason)).rejects.toThrow(
-        `Cannot lock. Settings config not found for tenant ${tenantId}`
-      )
+      await lockTenant(structures.tenant.id(), lockReason)
+
+      expect(mockDb.put).toHaveBeenCalledWith({
+        _id: "config_settings",
+        type: ConfigType.SETTINGS,
+        config: {
+          lockedBy: lockReason,
+        },
+      })
     })
 
-    it("should throw error when settings config has no config property", async () => {
-      const tenantId = structures.tenant.id()
+    it("should initialise config property when missing", async () => {
       const lockReason = LockReason.FREE_TIER
 
       const settingsConfig = {
@@ -115,9 +119,14 @@ describe("tenants", () => {
 
       mockDb.tryGet.mockResolvedValue(settingsConfig)
 
-      await expect(lockTenant(tenantId, lockReason)).rejects.toThrow(
-        `Cannot lock. Settings config not found for tenant ${tenantId}`
-      )
+      await lockTenant(structures.tenant.id(), lockReason)
+
+      expect(mockDb.put).toHaveBeenCalledWith({
+        ...settingsConfig,
+        config: {
+          lockedBy: lockReason,
+        },
+      })
     })
   })
 
@@ -149,14 +158,18 @@ describe("tenants", () => {
       })
     })
 
-    it("should throw error when settings config not found", async () => {
-      const tenantId = structures.tenant.id()
-
+    it("should create settings config when not found", async () => {
       mockDb.tryGet.mockResolvedValue(null)
 
-      await expect(unlockTenant(tenantId)).rejects.toThrow(
-        `Cannot lock. Settings config not found for tenant ${tenantId}`
-      )
+      await unlockTenant(structures.tenant.id())
+
+      expect(mockDb.put).toHaveBeenCalledWith({
+        _id: "config_settings",
+        type: ConfigType.SETTINGS,
+        config: {
+          lockedBy: undefined,
+        },
+      })
     })
   })
 
@@ -213,19 +226,21 @@ describe("tenants", () => {
       })
     })
 
-    it("should throw error when settings config not found", async () => {
-      const tenantId = structures.tenant.id()
-
+    it("should create settings config when not found", async () => {
       mockDb.tryGet.mockResolvedValue(null)
 
-      await expect(setActivation(tenantId, true)).rejects.toThrow(
-        `Cannot set activation. Settings config not found for tenant ${tenantId}`
-      )
-    })
+      await setActivation(structures.tenant.id(), true)
 
-    it("should throw error when settings config has no config property", async () => {
-      const tenantId = structures.tenant.id()
+      expect(mockDb.put).toHaveBeenCalledWith({
+        _id: "config_settings",
+        type: ConfigType.SETTINGS,
+        config: {
+          active: true,
+        },
+      })
+    })
 
+    it("should initialise config property when missing", async () => {
       const settingsConfig = {
         _id: "config_settings",
         type: ConfigType.SETTINGS,
@@ -233,9 +248,14 @@ describe("tenants", () => {
 
       mockDb.tryGet.mockResolvedValue(settingsConfig)
 
-      await expect(setActivation(tenantId, true)).rejects.toThrow(
-        `Cannot set activation. Settings config not found for tenant ${tenantId}`
-      )
+      await setActivation(structures.tenant.id(), true)
+
+      expect(mockDb.put).toHaveBeenCalledWith({
+        ...settingsConfig,
+        config: {
+          active: true,
+        },
+      })
     })
   })
 })