@budibase/worker 2.28.4 → 2.28.5

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/worker",
   "email": "hi@budibase.com",
-  "version": "2.28.4",
+  "version": "2.28.5",
   "description": "Budibase background service",
   "main": "src/index.ts",
   "repository": {
@@ -37,10 +37,10 @@
   "author": "Budibase",
   "license": "GPL-3.0",
   "dependencies": {
-    "@budibase/backend-core": "2.28.4",
-    "@budibase/pro": "2.28.4",
-    "@budibase/string-templates": "2.28.4",
-    "@budibase/types": "2.28.4",
+    "@budibase/backend-core": "2.28.5",
+    "@budibase/pro": "2.28.5",
+    "@budibase/string-templates": "2.28.5",
+    "@budibase/types": "2.28.5",
     "@koa/router": "8.0.8",
     "@techpass/passport-openidconnect": "0.3.2",
     "@types/global-agent": "2.1.1",
@@ -109,5 +109,5 @@
       }
     }
   },
-  "gitHead": "9b48f1ed3b00767916303b4885c0805bb751cee5"
+  "gitHead": "23b51d2ef16719c5106b8ad816ce4890de471f5b"
 }

package/scripts/dev/manage.js

@@ -31,6 +31,7 @@ async function init() {
     HTTP_LOGGING: "0",
     VERSION: "0.0.0+local",
     PASSWORD_MIN_LENGTH: "1",
+    SQS_SEARCH_ENABLE: "1",
   }
 
   config = { ...config, ...existingConfig }

package/src/api/controllers/global/tenant.ts

@@ -0,0 +1,10 @@
+import { tenancy } from "@budibase/backend-core"
+import { TenantInfo, Ctx } from "@budibase/types"
+
+export const save = async (ctx: Ctx<TenantInfo>) => {
+  const response = await tenancy.saveTenantInfo(ctx.request.body)
+  ctx.body = {
+    _id: response.id,
+    _rev: response.rev,
+  }
+}

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

@@ -1,16 +1,24 @@
-import { accounts } from "@budibase/backend-core"
+import { accounts, env as coreEnv } from "@budibase/backend-core"
+import { Ctx, SystemStatusResponse } from "@budibase/types"
 import env from "../../../environment"
-import { BBContext } from "@budibase/types"
 
-export const fetch = async (ctx: BBContext) => {
+export const fetch = async (ctx: Ctx<void, SystemStatusResponse>) => {
+  let status: SystemStatusResponse | undefined
   if (!env.SELF_HOSTED && !env.DISABLE_ACCOUNT_PORTAL) {
-    const status = await accounts.getStatus()
-    ctx.body = status
-  } else {
-    ctx.body = {
+    status = await accounts.getStatus()
+  }
+
+  if (!status) {
+    status = {
       health: {
         passing: true,
       },
     }
   }
+
+  if (coreEnv.VERSION) {
+    status.version = coreEnv.VERSION
+  }
+
+  ctx.body = status
 }

package/src/api/index.ts

@@ -76,6 +76,10 @@ const PUBLIC_ENDPOINTS = [
     route: "/api/global/users/invite",
     method: "GET",
   },
+  {
+    route: "/api/global/tenant",
+    method: "POST",
+  },
 ]
 
 const NO_TENANCY_ENDPOINTS = [
@@ -121,6 +125,10 @@ const NO_TENANCY_ENDPOINTS = [
     route: "/api/global/users/invite/:code",
     method: "GET",
   },
+  {
+    route: "/api/global/tenant",
+    method: "POST",
+  },
 ]
 
 // most public endpoints are gets, but some are posts

package/src/api/routes/global/tenant.ts

@@ -0,0 +1,33 @@
+import Router from "@koa/router"
+import Joi from "joi"
+import { auth } from "@budibase/backend-core"
+import * as controller from "../../controllers/global/tenant"
+import cloudRestricted from "../../../middleware/cloudRestricted"
+
+const router: Router = new Router()
+const OPTIONAL_STRING = Joi.string().optional().allow(null).allow("")
+
+function buildTenantInfoValidation() {
+  return auth.joiValidator.body(
+    Joi.object({
+      owner: Joi.object({
+        email: Joi.string().required(),
+        password: OPTIONAL_STRING,
+        ssoId: OPTIONAL_STRING,
+        givenName: OPTIONAL_STRING,
+        familyName: OPTIONAL_STRING,
+        budibaseUserId: OPTIONAL_STRING,
+      }).required(),
+      tenantId: Joi.string().required(),
+    }).required()
+  )
+}
+
+router.post(
+  "/api/global/tenant",
+  cloudRestricted,
+  buildTenantInfoValidation(),
+  controller.save
+)
+
+export default router

package/src/api/routes/global/tests/tenant.spec.ts

@@ -0,0 +1,47 @@
+import { TenantInfo } from "@budibase/types"
+import { TestConfiguration } from "../../../../tests"
+import { tenancy as _tenancy } from "@budibase/backend-core"
+
+const tenancy = jest.mocked(_tenancy)
+
+describe("/api/global/tenant", () => {
+  const config = new TestConfiguration()
+
+  beforeAll(async () => {
+    await config.beforeAll()
+  })
+
+  afterAll(async () => {
+    await config.afterAll()
+  })
+
+  beforeEach(() => {
+    jest.clearAllMocks()
+  })
+
+  describe("POST /api/global/tenant", () => {
+    it("should save the tenantInfo", async () => {
+      tenancy.saveTenantInfo = jest.fn().mockImplementation(async () => ({
+        id: "DOC_ID",
+        ok: true,
+        rev: "DOC_REV",
+      }))
+      const tenantInfo: TenantInfo = {
+        owner: {
+          email: "test@example.com",
+          password: "PASSWORD",
+          ssoId: "SSO_ID",
+          givenName: "Jane",
+          familyName: "Doe",
+          budibaseUserId: "USER_ID",
+        },
+        tenantId: "tenant123",
+      }
+      const response = await config.api.tenants.saveTenantInfo(tenantInfo)
+
+      expect(_tenancy.saveTenantInfo).toHaveBeenCalledTimes(1)
+      expect(_tenancy.saveTenantInfo).toHaveBeenCalledWith(tenantInfo)
+      expect(response.text).toEqual('{"_id":"DOC_ID","_rev":"DOC_REV"}')
+    })
+  })
+})

package/src/api/routes/global/users.ts

@@ -4,7 +4,6 @@ import { auth } from "@budibase/backend-core"
 import Joi from "joi"
 import cloudRestricted from "../../../middleware/cloudRestricted"
 import { users } from "../validation"
-import * as selfController from "../../controllers/global/self"
 
 const router: Router = new Router()
 const OPTIONAL_STRING = Joi.string().optional().allow(null).allow("")
@@ -140,12 +139,5 @@ router
   .get("/api/global/users/tenant/:id", controller.tenantUserLookup)
   // global endpoint but needs to come at end (blocks other endpoints otherwise)
   .get("/api/global/users/:id", auth.builderOrAdmin, controller.find)
-  // DEPRECATED - use new versions with self API
-  .get("/api/global/users/self", selfController.getSelf)
-  .post(
-    "/api/global/users/self",
-    users.buildUserSaveValidation(),
-    selfController.updateSelf
-  )
 
 export default router

package/src/api/routes/index.ts

@@ -1,6 +1,7 @@
 import Router from "@koa/router"
 import { api as pro } from "@budibase/pro"
 import userRoutes from "./global/users"
+import tenantRoutes from "./global/tenant"
 import configRoutes from "./global/configs"
 import workspaceRoutes from "./global/workspaces"
 import templateRoutes from "./global/templates"
@@ -40,6 +41,7 @@ export const routes: Router[] = [
   accountRoutes,
   restoreRoutes,
   eventRoutes,
+  tenantRoutes,
   pro.scim,
 ]
 

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

@@ -27,6 +27,7 @@ describe("/api/system/status", () => {
         health: {
           passing: true,
         },
+        version: expect.any(String),
       })
       expect(accounts.getStatus).toHaveBeenCalledTimes(0)
       config.cloudHosted()

package/src/environment.ts

@@ -24,6 +24,7 @@ const environment = {
   // auth
   MINIO_ACCESS_KEY: process.env.MINIO_ACCESS_KEY,
   MINIO_SECRET_KEY: process.env.MINIO_SECRET_KEY,
+  AWS_SESSION_TOKEN: process.env.AWS_SESSION_TOKEN,
   SALT_ROUNDS: process.env.SALT_ROUNDS,
   REDIS_PASSWORD: process.env.REDIS_PASSWORD,
   COOKIE_DOMAIN: process.env.COOKIE_DOMAIN,
@@ -46,6 +47,7 @@ const environment = {
   SMTP_FALLBACK_ENABLED: process.env.SMTP_FALLBACK_ENABLED,
   DISABLE_DEVELOPER_LICENSE: process.env.DISABLE_DEVELOPER_LICENSE,
   SQS_SEARCH_ENABLE: process.env.SQS_SEARCH_ENABLE,
+  BUDIBASE_ENVIRONMENT: process.env.BUDIBASE_ENVIRONMENT,
   // smtp
   SMTP_USER: process.env.SMTP_USER,
   SMTP_PASSWORD: process.env.SMTP_PASSWORD,

package/src/index.ts

@@ -88,7 +88,11 @@ const shutdown = () => {
 }
 
 export default server.listen(parseInt(env.PORT || "4002"), async () => {
-  console.log(`Worker running on ${JSON.stringify(server.address())}`)
+  let startupLog = `Worker running on ${JSON.stringify(server.address())}`
+  if (env.BUDIBASE_ENVIRONMENT) {
+    startupLog = `${startupLog} - environment: "${env.BUDIBASE_ENVIRONMENT}"`
+  }
+  console.log(startupLog)
   await initPro()
   await redis.clients.init()
   cache.docWritethrough.init()

package/src/tests/api/tenants.ts

@@ -1,3 +1,4 @@
+import { TenantInfo } from "@budibase/types"
 import TestConfiguration from "../TestConfiguration"
 import { TestAPI, TestAPIOpts } from "./base"
 
@@ -14,4 +15,12 @@ export class TenantAPI extends TestAPI {
       .set(opts?.headers)
       .expect(opts?.status ? opts.status : 204)
   }
+
+  saveTenantInfo = (tenantInfo: TenantInfo) => {
+    return this.request
+      .post("/api/global/tenant")
+      .set(this.config.internalAPIHeaders())
+      .send(tenantInfo)
+      .expect(200)
+  }
 }