@budibase/worker 1.0.171 → 1.0.173

package/Dockerfile

@@ -10,6 +10,7 @@ WORKDIR /app
 # copy files and install dependencies
 COPY . ./
 RUN yarn
+RUN yarn global add pm2
 
 EXPOSE 4001
 
@@ -17,4 +18,5 @@ EXPOSE 4001
 # due to this causing yarn to stop installing dev dependencies
 # which are actually needed to get this environment up and running
 ENV NODE_ENV=production
-CMD ["yarn", "run:docker"]
+ENV CLUSTER_MODE=${CLUSTER_MODE}
+CMD ["./docker_run.sh"]

package/docker_run.sh

@@ -0,0 +1,5 @@
+if [[ -z $CLUSTER_MODE ]]; then
+  yarn run:docker
+else
+  yarn run:docker:cluster
+fi

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/worker",
   "email": "hi@budibase.com",
-  "version": "1.0.171",
+  "version": "1.0.173",
   "description": "Budibase background service",
   "main": "src/index.ts",
   "repository": {
@@ -15,6 +15,7 @@
     "build": "rimraf dist/ && tsc",
     "postbuild": "copyfiles -u 1 src/**/*.hbs dist/",
     "run:docker": "node dist/index.js",
+    "run:docker:cluster": "pm2-runtime start pm2.js",
     "build:docker": "docker build . -t worker-service --label version=$BUDIBASE_RELEASE_VERSION",
     "dev:stack:init": "node ./scripts/dev/manage.js init",
     "dev:builder": "npm run dev:stack:init && nodemon",
@@ -31,9 +32,9 @@
   "author": "Budibase",
   "license": "GPL-3.0",
   "dependencies": {
-    "@budibase/backend-core": "^1.0.171",
-    "@budibase/pro": "1.0.170",
-    "@budibase/string-templates": "^1.0.171",
+    "@budibase/backend-core": "^1.0.173",
+    "@budibase/pro": "1.0.172",
+    "@budibase/string-templates": "^1.0.173",
     "@koa/router": "^8.0.0",
     "@sentry/node": "6.17.7",
     "@techpass/passport-openidconnect": "^0.3.0",
@@ -89,5 +90,5 @@
       "./scripts/jestSetup.js"
     ]
   },
-  "gitHead": "be3f4676fd4d319b4969955aa65a71e313bb8774"
+  "gitHead": "b408b4079f35eb1eb8a388c4b27acf8f77b2815e"
 }

package/pm2.js

@@ -0,0 +1,9 @@
+module.exports = {
+  apps: [
+    {
+      script: "dist/index.js",
+      instances: "max",
+      exec_mode: "cluster",
+    },
+  ],
+}

package/src/api/controllers/global/configs.js

@@ -14,7 +14,11 @@ const {
 const { getGlobalDB, getTenantId } = require("@budibase/backend-core/tenancy")
 const env = require("../../../environment")
 const { googleCallbackUrl, oidcCallbackUrl } = require("./auth")
-const { withCache } = require("../../../utilities/redis")
+const {
+  withCache,
+  CacheKeys,
+  bustCache,
+} = require("@budibase/backend-core/cache")
 
 const BB_TENANT_CDN = "https://tenants.cdn.budi.live"
 
@@ -44,6 +48,7 @@ exports.save = async function (ctx) {
 
   try {
     const response = await db.put(ctx.request.body)
+    await bustCache(CacheKeys.CHECKLIST)
     ctx.body = {
       type,
       _id: response.id,
@@ -250,11 +255,9 @@ exports.configChecklist = async function (ctx) {
   const tenantId = getTenantId()
 
   try {
-    const ONE_MINUTE = 600
-
     ctx.body = await withCache(
-      `checklist:${tenantId}`,
-      ONE_MINUTE,
+      CacheKeys.CHECKLIST,
+      env.CHECKLIST_CACHE_TTL,
       async () => {
         let apps = []
         if (!env.MULTI_TENANCY || tenantId) {

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

@@ -3,9 +3,6 @@ const {
   StaticDatabases,
 } = require("@budibase/backend-core/db")
 const { getGlobalUserByEmail } = require("@budibase/backend-core/utils")
-import { EmailTemplatePurpose } from "../../../constants"
-import { checkInviteCode } from "../../../utilities/redis"
-import { sendEmail } from "../../../utilities/email"
 const { user: userCache } = require("@budibase/backend-core/cache")
 const { invalidateSessions } = require("@budibase/backend-core/sessions")
 const accounts = require("@budibase/backend-core/accounts")
@@ -17,11 +14,15 @@ const {
   doesTenantExist,
 } = require("@budibase/backend-core/tenancy")
 const { removeUserFromInfoDB } = require("@budibase/backend-core/deprovision")
+const { errors } = require("@budibase/backend-core")
+const { CacheKeys, bustCache } = require("@budibase/backend-core/cache")
 import env from "../../../environment"
 import { syncUserInApps } from "../../../utilities/appService"
 import { quotas, users } from "@budibase/pro"
-const { errors } = require("@budibase/backend-core")
 import { allUsers, getUser } from "../../utilities"
+import { EmailTemplatePurpose } from "../../../constants"
+import { checkInviteCode } from "../../../utilities/redis"
+import { sendEmail } from "../../../utilities/email"
 
 export const save = async (ctx: any) => {
   try {
@@ -93,7 +94,14 @@ export const adminUser = async (ctx: any) => {
     tenantId,
   }
   try {
-    ctx.body = await users.save(user, tenantId, hashPassword, requirePassword)
+    const finalUser = await users.save(
+      user,
+      tenantId,
+      hashPassword,
+      requirePassword
+    )
+    await bustCache(CacheKeys.CHECKLIST)
+    ctx.body = finalUser
   } catch (err: any) {
     ctx.throw(err.status || 400, err)
   }

package/src/environment.js

@@ -20,6 +20,12 @@ if (!LOADED && isDev() && !isTest()) {
   LOADED = true
 }
 
+function parseIntSafe(number) {
+  if (number) {
+    return parseInt(number)
+  }
+}
+
 module.exports = {
   NODE_ENV: process.env.NODE_ENV,
   SELF_HOSTED: !!parseInt(process.env.SELF_HOSTED),
@@ -46,6 +52,7 @@ module.exports = {
   SMTP_FROM_ADDRESS: process.env.SMTP_FROM_ADDRESS,
   PLATFORM_URL: process.env.PLATFORM_URL,
   COOKIE_DOMAIN: process.env.COOKIE_DOMAIN,
+  CHECKLIST_CACHE_TTL: parseIntSafe(process.env.CHECKLIST_CACHE_TTL) || 3600,
   APPS_URL: process.env.APPS_URL,
   _set(key, value) {
     process.env[key] = value

package/src/utilities/redis.js

@@ -1,6 +1,5 @@
 const { Client, utils } = require("@budibase/backend-core/redis")
 const { newid } = require("@budibase/backend-core/utils")
-const env = require("../environment")
 
 function getExpirySecondsForDB(db) {
   switch (db) {
@@ -13,7 +12,7 @@ function getExpirySecondsForDB(db) {
   }
 }
 
-let pwResetClient, invitationClient, cachingClient
+let pwResetClient, invitationClient
 
 function getClient(db) {
   switch (db) {
@@ -21,8 +20,6 @@ function getClient(db) {
       return pwResetClient
     case utils.Databases.INVITATIONS:
       return invitationClient
-    case utils.Databases.DATA_CACHE:
-      return cachingClient
   }
 }
 
@@ -48,10 +45,8 @@ async function getACode(db, code, deleteCode = true) {
 exports.init = async () => {
   pwResetClient = new Client(utils.Databases.PW_RESETS)
   invitationClient = new Client(utils.Databases.INVITATIONS)
-  cachingClient = new Client(utils.Databases.DATA_CACHE)
   await pwResetClient.init()
   await invitationClient.init()
-  await cachingClient.init()
 }
 
 /**
@@ -66,6 +61,7 @@ exports.shutdown = async () => {
  * Given a user ID this will store a code (that is returned) for an hour in redis.
  * The user can then return this code for resetting their password (through their reset link).
  * @param {string} userId the ID of the user which is to be reset.
+ * @param {object} info Info about the user/the reset process.
  * @return {Promise<string>} returns the code that was stored to redis.
  */
 exports.getResetPasswordCode = async (userId, info) => {
@@ -109,23 +105,3 @@ exports.checkInviteCode = async (inviteCode, deleteCode = true) => {
     throw "Invitation is not valid or has expired, please request a new one."
   }
 }
-
-// TODO: move into backend-core
-exports.withCache = async (key, ttl, fetchFn) => {
-  const cachedValue = await cachingClient.get(key)
-  if (cachedValue) {
-    return cachedValue
-  }
-
-  try {
-    const fetchedValue = await fetchFn()
-
-    if (!env.isTest()) {
-      await cachingClient.store(key, fetchedValue, ttl)
-    }
-    return fetchedValue
-  } catch (err) {
-    console.error("Error calling fetch function", err)
-    throw err
-  }
-}