@budibase/worker 3.23.28 → 3.23.29

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/worker",
   "email": "hi@budibase.com",
-  "version": "3.23.28",
+  "version": "3.23.29",
   "description": "Budibase background service",
   "main": "src/index.ts",
   "repository": {
@@ -109,5 +109,5 @@
       }
     }
   },
-  "gitHead": "bf96741b576cc61b4aae9af4ff390dbcf1eb34e4"
+  "gitHead": "e9bb53161a551bda13ab996da6cba563f6be5400"
 }

package/src/api/controllers/system/tenants.ts

@@ -1,4 +1,8 @@
-import { GetTenantInfoResponse, UserCtx } from "@budibase/types"
+import {
+  ActivationRequest,
+  GetTenantInfoResponse,
+  UserCtx,
+} from "@budibase/types"
 import { LockRequest, LockReason } from "@budibase/types"
 import * as tenantSdk from "../../../sdk/tenants"
 
@@ -47,6 +51,27 @@ export async function lock(ctx: UserCtx<LockRequest, void>) {
   }
 }
 
+export async function activation(ctx: UserCtx<ActivationRequest, void>) {
+  if (!ctx.internal) {
+    ctx.throw(403, "Only internal user can set activation for a tenant")
+  }
+
+  const { active } = ctx.request.body
+  if (typeof active !== "boolean") {
+    ctx.throw(403, "Only boolean values allowed for 'active' property")
+  }
+
+  const tenantId = ctx.params.tenantId
+
+  try {
+    await tenantSdk.setActivation(tenantId, active)
+    ctx.status = 204
+  } catch (err) {
+    ctx.log.error(err)
+    throw err
+  }
+}
+
 export async function info(ctx: UserCtx<void, GetTenantInfoResponse>) {
   ctx.body = await tenantSdk.tenantInfo(ctx.params.tenantId)
 }

package/src/api/routes/system/tenants.ts

@@ -3,3 +3,7 @@ import { adminRoutes } from "../endpointGroups"
 
 adminRoutes.delete("/api/system/tenants/:tenantId", controller.destroy)
 adminRoutes.put("/api/system/tenants/:tenantId/lock", controller.lock)
+adminRoutes.put(
+  "/api/system/tenants/:tenantId/activation",
+  controller.activation
+)

package/src/api/routes/system/tests/tenants.spec.ts

@@ -7,6 +7,7 @@ jest.mock("../../../../sdk/tenants", () => ({
   lockTenant: jest.fn(),
   unlockTenant: jest.fn(),
   deleteTenant: jest.fn(),
+  setActivation: jest.fn(),
 }))
 
 describe("/api/global/tenants", () => {
@@ -147,4 +148,82 @@ describe("/api/global/tenants", () => {
       expect(tenantSdk.unlockTenant).not.toHaveBeenCalled()
     })
   })
+
+  describe("PUT /api/system/tenants/:tenantId/activation", () => {
+    it("allows activating tenant", async () => {
+      const user = await config.createTenant()
+
+      await config.api.tenants.activation(
+        user.tenantId,
+        {
+          active: true,
+        },
+        {
+          headers: config.internalAPIHeaders(),
+        }
+      )
+
+      expect(tenantSdk.setActivation).toHaveBeenCalledWith(user.tenantId, true)
+    })
+
+    it("allows deactivating tenant", async () => {
+      const user = await config.createTenant()
+
+      await config.api.tenants.activation(
+        user.tenantId,
+        {
+          active: false,
+        },
+        {
+          headers: config.internalAPIHeaders(),
+        }
+      )
+
+      expect(tenantSdk.setActivation).toHaveBeenCalledWith(user.tenantId, false)
+    })
+
+    it("rejects non-boolean active value", async () => {
+      const user = await config.createTenant()
+
+      const status = 403
+      const res = await config.api.tenants.activation(
+        user.tenantId,
+        {
+          active: "invalid" as any,
+        },
+        {
+          status,
+          headers: config.internalAPIHeaders(),
+        }
+      )
+
+      expect(res.body).toEqual({
+        message: "Only boolean values allowed for 'active' property",
+        status,
+      })
+      expect(tenantSdk.setActivation).not.toHaveBeenCalled()
+    })
+
+    it("rejects non-internal user", async () => {
+      const user = await config.createTenant()
+
+      const status = 403
+      const res = await config.api.tenants.activation(
+        user.tenantId,
+        {
+          active: true,
+        },
+        {
+          status,
+          headers: config.authHeaders(user),
+        }
+      )
+
+      expect(res.body).toEqual({
+        message: "Only internal user can set activation for a tenant",
+        status,
+      })
+      expect(tenantSdk.setActivation).not.toHaveBeenCalled()
+    })
+  })
 })

package/src/sdk/tenants/tenants.ts

@@ -22,6 +22,20 @@ export async function unlockTenant(tenantId: string) {
   return await setLock(tenantId)
 }
 
+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}`
+    )
+  }
+  settingsConfig.config.active = active
+  await db.put(settingsConfig)
+}
+
 async function setLock(tenantId: string, lockReason?: LockReason) {
   const db = tenancy.getTenantDB(tenantId)
   const settingsConfig = await db.tryGet<SettingsConfig>(

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

@@ -1,5 +1,5 @@
 import { structures } from "../../../tests"
-import { lockTenant, unlockTenant } from "../tenants"
+import { lockTenant, unlockTenant, setActivation } from "../tenants"
 import { configs, tenancy } from "@budibase/backend-core"
 import { LockReason, ConfigType, SettingsConfig } from "@budibase/types"
 
@@ -159,4 +159,83 @@ describe("tenants", () => {
       )
     })
   })
+
+  describe("setActivation", () => {
+    it("should activate tenant", async () => {
+      const tenantId = structures.tenant.id()
+
+      const settingsConfig: SettingsConfig = {
+        _id: "config_settings",
+        type: ConfigType.SETTINGS,
+        config: {},
+      }
+
+      mockDb.tryGet.mockResolvedValue(settingsConfig)
+
+      await setActivation(tenantId, true)
+
+      expect(mockDb.tryGet).toHaveBeenCalledWith(
+        configs.generateConfigID(ConfigType.SETTINGS)
+      )
+      expect(mockDb.put).toHaveBeenCalledWith({
+        ...settingsConfig,
+        config: {
+          ...settingsConfig.config,
+          active: true,
+        },
+      })
+    })
+
+    it("should deactivate tenant", async () => {
+      const tenantId = structures.tenant.id()
+
+      const settingsConfig: SettingsConfig = {
+        _id: "config_settings",
+        type: ConfigType.SETTINGS,
+        config: {
+          active: true,
+        },
+      }
+
+      mockDb.tryGet.mockResolvedValue(settingsConfig)
+
+      await setActivation(tenantId, false)
+
+      expect(mockDb.tryGet).toHaveBeenCalledWith(
+        configs.generateConfigID(ConfigType.SETTINGS)
+      )
+      expect(mockDb.put).toHaveBeenCalledWith({
+        ...settingsConfig,
+        config: {
+          ...settingsConfig.config,
+          active: false,
+        },
+      })
+    })
+
+    it("should throw error when settings config not found", async () => {
+      const tenantId = structures.tenant.id()
+
+      mockDb.tryGet.mockResolvedValue(null)
+
+      await expect(setActivation(tenantId, true)).rejects.toThrow(
+        `Cannot set activation. Settings config not found for tenant ${tenantId}`
+      )
+    })
+
+    it("should throw error when settings config has no config property", async () => {
+      const tenantId = structures.tenant.id()
+
+      const settingsConfig = {
+        _id: "config_settings",
+        type: ConfigType.SETTINGS,
+      }
+
+      mockDb.tryGet.mockResolvedValue(settingsConfig)
+
+      await expect(setActivation(tenantId, true)).rejects.toThrow(
+        `Cannot set activation. Settings config not found for tenant ${tenantId}`
+      )
+    })
+  })
 })

package/src/tests/api/tenants.ts

@@ -1,6 +1,6 @@
 import TestConfiguration from "../TestConfiguration"
 import { TestAPI, TestAPIOpts } from "./base"
-import { LockRequest } from "@budibase/types"
+import { LockRequest, ActivationRequest } from "@budibase/types"
 
 export class TenantAPI extends TestAPI {
   config: TestConfiguration
@@ -23,4 +23,16 @@ export class TenantAPI extends TestAPI {
       .set(opts?.headers)
       .expect(opts?.status ? opts.status : 204)
   }
+
+  activation = (
+    tenantId: string,
+    body: ActivationRequest,
+    opts?: TestAPIOpts
+  ) => {
+    return this.request
+      .put(`/api/system/tenants/${tenantId}/activation`)
+      .send(body)
+      .set(opts?.headers)
+      .expect(opts?.status ? opts.status : 204)
+  }
 }