@budibase/worker 1.0.167-alpha.8 → 1.0.169

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/worker",
   "email": "hi@budibase.com",
-  "version": "1.0.167-alpha.8",
+  "version": "1.0.169",
   "description": "Budibase background service",
   "main": "src/index.ts",
   "repository": {
@@ -31,9 +31,9 @@
   "author": "Budibase",
   "license": "GPL-3.0",
   "dependencies": {
-    "@budibase/backend-core": "^1.0.167-alpha.8",
-    "@budibase/pro": "1.0.167-alpha.7",
-    "@budibase/string-templates": "^1.0.167-alpha.8",
+    "@budibase/backend-core": "^1.0.169",
+    "@budibase/pro": "1.0.168",
+    "@budibase/string-templates": "^1.0.169",
     "@koa/router": "^8.0.0",
     "@sentry/node": "6.17.7",
     "@techpass/passport-openidconnect": "^0.3.0",
@@ -89,5 +89,5 @@
       "./scripts/jestSetup.js"
     ]
   },
-  "gitHead": "87da5df156c621854592273cc601b1b7a072aadb"
+  "gitHead": "ed0256eff3911443b5df6d9426027702dc0810db"
 }

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

@@ -14,6 +14,7 @@ const {
 const { getGlobalDB, getTenantId } = require("@budibase/backend-core/tenancy")
 const env = require("../../../environment")
 const { googleCallbackUrl, oidcCallbackUrl } = require("./auth")
+const { withCache } = require("../../../utilities/redis")
 
 const BB_TENANT_CDN = "https://tenants.cdn.budi.live"
 
@@ -249,58 +250,64 @@ exports.configChecklist = async function (ctx) {
   const tenantId = getTenantId()
 
   try {
-    // TODO: Watch get started video
-
-    let apps = []
-    if (!env.MULTI_TENANCY || tenantId) {
-      // Apps exist
-      apps = await getAllApps({ idsOnly: true, efficient: true })
-    }
-
-    // They have set up SMTP
-    const smtpConfig = await getScopedFullConfig(db, {
-      type: Configs.SMTP,
-    })
-
-    // They have set up Google Auth
-    const googleConfig = await getScopedFullConfig(db, {
-      type: Configs.GOOGLE,
-    })
-
-    // They have set up OIDC
-    const oidcConfig = await getScopedFullConfig(db, {
-      type: Configs.OIDC,
-    })
-    // They have set up an global user
-    const users = await db.allDocs(
-      getGlobalUserParams(null, {
-        include_docs: true,
-      })
+    const ONE_MINUTE = 600
+
+    ctx.body = await withCache(
+      `checklist:${tenantId}`,
+      ONE_MINUTE,
+      async () => {
+        let apps = []
+        if (!env.MULTI_TENANCY || tenantId) {
+          // Apps exist
+          apps = await getAllApps({ idsOnly: true, efficient: true })
+        }
+
+        // They have set up SMTP
+        const smtpConfig = await getScopedFullConfig(db, {
+          type: Configs.SMTP,
+        })
+
+        // They have set up Google Auth
+        const googleConfig = await getScopedFullConfig(db, {
+          type: Configs.GOOGLE,
+        })
+
+        // They have set up OIDC
+        const oidcConfig = await getScopedFullConfig(db, {
+          type: Configs.OIDC,
+        })
+
+        // They have set up an global user
+        const users = await db.allDocs(
+          getGlobalUserParams(null, {
+            include_docs: true,
+            limit: 1,
+          })
+        )
+        return {
+          apps: {
+            checked: apps.length > 0,
+            label: "Create your first app",
+            link: "/builder/portal/apps",
+          },
+          smtp: {
+            checked: !!smtpConfig,
+            label: "Set up email",
+            link: "/builder/portal/manage/email",
+          },
+          adminUser: {
+            checked: users && users.rows.length >= 1,
+            label: "Create your first user",
+            link: "/builder/portal/manage/users",
+          },
+          sso: {
+            checked: !!googleConfig || !!oidcConfig,
+            label: "Set up single sign-on",
+            link: "/builder/portal/manage/auth",
+          },
+        }
+      }
     )
-    const adminUser = users.rows.some(row => row.doc.admin)
-
-    ctx.body = {
-      apps: {
-        checked: apps.length > 0,
-        label: "Create your first app",
-        link: "/builder/portal/apps",
-      },
-      smtp: {
-        checked: !!smtpConfig,
-        label: "Set up email",
-        link: "/builder/portal/manage/email",
-      },
-      adminUser: {
-        checked: adminUser,
-        label: "Create your first user",
-        link: "/builder/portal/manage/users",
-      },
-      sso: {
-        checked: !!googleConfig || !!oidcConfig,
-        label: "Set up single sign-on",
-        link: "/builder/portal/manage/auth",
-      },
-    }
   } catch (err) {
     ctx.throw(err.status, err)
   }

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

@@ -25,5 +25,6 @@ export const getInfo = async (ctx: any) => {
 }
 
 export const getQuotaUsage = async (ctx: any) => {
-  ctx.body = await quotas.getQuotaUsage()
+  const usage = await quotas.getQuotaUsage()
+  ctx.body = usage
 }

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

@@ -75,8 +75,8 @@ const checkCurrentApp = ctx => {
 const addSessionAttributesToUser = ctx => {
   ctx.body.account = ctx.user.account
   ctx.body.license = ctx.user.license
-  ctx.body.budibaseAccess = !!ctx.user.budibaseAccess
-  ctx.body.accountPortalAccess = !!ctx.user.accountPortalAccess
+  ctx.body.budibaseAccess = ctx.user.budibaseAccess
+  ctx.body.accountPortalAccess = ctx.user.accountPortalAccess
   ctx.body.csrfToken = ctx.user.csrfToken
 }
 

package/src/environment.js

@@ -1,3 +1,5 @@
+const { join } = require("path")
+
 function isDev() {
   return process.env.NODE_ENV !== "production"
 }
@@ -12,43 +14,39 @@ function isTest() {
 
 let LOADED = false
 if (!LOADED && isDev() && !isTest()) {
-  require("dotenv").config()
+  require("dotenv").config({
+    path: join(__dirname, "..", ".env"),
+  })
   LOADED = true
 }
 
 module.exports = {
-  // auth
+  NODE_ENV: process.env.NODE_ENV,
+  SELF_HOSTED: !!parseInt(process.env.SELF_HOSTED),
+  PORT: process.env.PORT || process.env.WORKER_PORT,
+  CLUSTER_PORT: process.env.CLUSTER_PORT,
   MINIO_ACCESS_KEY: process.env.MINIO_ACCESS_KEY,
   MINIO_SECRET_KEY: process.env.MINIO_SECRET_KEY,
+  MINIO_URL: process.env.MINIO_URL,
+  COUCH_DB_URL: process.env.COUCH_DB_URL,
+  LOG_LEVEL: process.env.LOG_LEVEL,
   JWT_SECRET: process.env.JWT_SECRET,
   SALT_ROUNDS: process.env.SALT_ROUNDS,
+  REDIS_URL: process.env.REDIS_URL,
   REDIS_PASSWORD: process.env.REDIS_PASSWORD,
   INTERNAL_API_KEY: process.env.INTERNAL_API_KEY,
-  COOKIE_DOMAIN: process.env.COOKIE_DOMAIN,
-  // urls
-  MINIO_URL: process.env.MINIO_URL,
-  COUCH_DB_URL: process.env.COUCH_DB_URL,
-  REDIS_URL: process.env.REDIS_URL,
-  ACCOUNT_PORTAL_URL: process.env.ACCOUNT_PORTAL_URL,
-  PLATFORM_URL: process.env.PLATFORM_URL,
-  APPS_URL: process.env.APPS_URL,
-  // ports
-  PORT: process.env.PORT || process.env.WORKER_PORT,
-  CLUSTER_PORT: process.env.CLUSTER_PORT,
-  // flags
-  NODE_ENV: process.env.NODE_ENV,
-  SELF_HOSTED: !!parseInt(process.env.SELF_HOSTED),
-  LOG_LEVEL: process.env.LOG_LEVEL,
   MULTI_TENANCY: process.env.MULTI_TENANCY,
   DISABLE_ACCOUNT_PORTAL: process.env.DISABLE_ACCOUNT_PORTAL,
+  ACCOUNT_PORTAL_URL: process.env.ACCOUNT_PORTAL_URL,
   SMTP_FALLBACK_ENABLED: process.env.SMTP_FALLBACK_ENABLED,
-  DISABLE_DEVELOPER_LICENSE: process.env.DISABLE_DEVELOPER_LICENSE,
-  // smtp
   SMTP_USER: process.env.SMTP_USER,
   SMTP_PASSWORD: process.env.SMTP_PASSWORD,
   SMTP_HOST: process.env.SMTP_HOST,
   SMTP_PORT: process.env.SMTP_PORT,
   SMTP_FROM_ADDRESS: process.env.SMTP_FROM_ADDRESS,
+  PLATFORM_URL: process.env.PLATFORM_URL,
+  COOKIE_DOMAIN: process.env.COOKIE_DOMAIN,
+  APPS_URL: process.env.APPS_URL,
   _set(key, value) {
     process.env[key] = value
     module.exports[key] = value

package/src/utilities/redis.js

@@ -1,5 +1,6 @@
 const { Client, utils } = require("@budibase/backend-core/redis")
 const { newid } = require("@budibase/backend-core/utils")
+const env = require("../environment")
 
 function getExpirySecondsForDB(db) {
   switch (db) {
@@ -12,7 +13,7 @@ function getExpirySecondsForDB(db) {
   }
 }
 
-let pwResetClient, invitationClient
+let pwResetClient, invitationClient, cachingClient
 
 function getClient(db) {
   switch (db) {
@@ -20,6 +21,8 @@ function getClient(db) {
       return pwResetClient
     case utils.Databases.INVITATIONS:
       return invitationClient
+    case utils.Databases.DATA_CACHE:
+      return cachingClient
   }
 }
 
@@ -45,8 +48,10 @@ 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()
 }
 
 /**
@@ -104,3 +109,23 @@ 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
+  }
+}