Merge pull request #2607 from Budibase/feature/onboarding-backend

Redirects and linking between budibase and account portal

hosting/docker-compose.yaml

@@ -51,6 +51,7 @@ services:
       INTERNAL_API_KEY: ${INTERNAL_API_KEY}
       REDIS_URL: redis-service:6379
       REDIS_PASSWORD: ${REDIS_PASSWORD}
+      ACCOUNT_PORTAL_URL: https://portal.budi.live
     volumes:
       - ./logs:/logs
     depends_on:

hosting/kubernetes/budibase/templates/worker-service-deployment.yaml

@@ -87,6 +87,8 @@ spec:
           {{ end }}
         - name: SELF_HOSTED
           value: {{ .Values.globals.selfHosted | quote }}
+        - name: ACCOUNT_PORTAL_URL
+          value: {{ .Values.globals.accountPortalUrl | quote }}
         image: budibase/worker
         imagePullPolicy: Always
         name: bbworker

hosting/kubernetes/budibase/values.yaml

@@ -89,6 +89,7 @@ globals:
   sentryDSN: "" 
   logLevel: info
   selfHosted: 1
+  accountPortalUrL: ""
   createSecrets: true # creates an internal API key, JWT secrets and redis password for you
 
   # if createSecrets is set to false, you can hard-code your secrets here

package.json

@@ -47,6 +47,8 @@
     "release:helm": "./scripts/release_helm_chart.sh",
     "multi:enable": "lerna run multi:enable",
     "multi:disable": "lerna run multi:disable",
+    "selfhost:enable": "lerna run selfhost:enable",
+    "selfhost:disable": "lerna run selfhost:disable",
     "postinstall": "husky install"
   }
 }

packages/builder/src/pages/builder/app/[application]/_layout.svelte

@@ -92,7 +92,7 @@
         <ActionGroup />
       </div>
       <div class="toprightnav">
-        {#if $admin.sandbox}
+        {#if $admin.cloud}
           <UpgradeModal />
         {/if}
         <VersionModal />

packages/builder/src/pages/builder/auth/_layout.svelte

@@ -1,5 +1,5 @@
 <script>
-  import { auth } from "stores/portal"
+  import { auth, admin } from "stores/portal"
   import { onMount } from "svelte"
   import { redirect } from "@roxi/routify"
 
@@ -10,6 +10,11 @@
     if ($auth.user && !$auth.user.forceResetPassword) {
       $redirect("../")
     }
+
+    // redirect to account portal for authentication in the cloud
+    if ($admin.cloud && $admin.accountPortalUrl) {
+      window.location.href = $admin.accountPortalUrl
+    }
   })
 </script>
 

packages/builder/src/pages/builder/portal/_layout.svelte

@@ -12,6 +12,7 @@
   } from "@budibase/bbui"
   import ConfigChecklist from "components/common/ConfigChecklist.svelte"
   import { organisation, auth } from "stores/portal"
+  import { admin as adminStore } from "stores/portal"
   import { onMount } from "svelte"
   import UpdateUserInfoModal from "components/settings/UpdateUserInfoModal.svelte"
   import ChangePasswordModal from "components/settings/ChangePasswordModal.svelte"
@@ -57,6 +58,16 @@
         },
       ])
     }
+
+    // add link to account portal if the user has access
+    if ($auth?.user?.account) {
+      menu = menu.concat([
+        {
+          title: "Account",
+          href: $adminStore.accountPortalUrl,
+        },
+      ])
+    }
     return menu
   }
 

packages/builder/src/stores/portal/admin.js

@@ -6,7 +6,8 @@ export function createAdminStore() {
   const DEFAULT_CONFIG = {
     loaded: false,
     multiTenancy: false,
-    sandbox: false,
+    cloud: false,
+    accountPortalUrl: "",
     onboardingProgress: 0,
     checklist: {
       apps: { checked: false },
@@ -28,7 +29,7 @@ export function createAdminStore() {
       const totalSteps = Object.keys(json).length
       const completedSteps = Object.values(json).filter(x => x?.checked).length
 
-      await getFlags()
+      await getEnvironment()
       admin.update(store => {
         store.loaded = true
         store.checklist = json
@@ -43,20 +44,23 @@ export function createAdminStore() {
     }
   }
 
-  async function getFlags() {
+  async function getEnvironment() {
     let multiTenancyEnabled = false
-    let sandbox = false
+    let cloud = false
+    let accountPortalUrl = ""
     try {
-      const response = await api.get(`/api/system/flags`)
+      const response = await api.get(`/api/system/environment`)
       const json = await response.json()
       multiTenancyEnabled = json.multiTenancy
-      sandbox = json.sandbox
+      cloud = json.cloud
+      accountPortalUrl = json.accountPortalUrl
     } catch (err) {
       // just let it stay disabled
     }
     admin.update(store => {
       store.multiTenancy = multiTenancyEnabled
-      store.sandbox = sandbox
+      store.cloud = cloud
+      store.accountPortalUrl = accountPortalUrl
       return store
     })
   }

packages/server/package.json

@@ -24,7 +24,9 @@
     "lint": "eslint --fix src/",
     "lint:fix": "yarn run format && yarn run lint",
     "multi:enable": "node scripts/multiTenancy.js enable",
-    "multi:disable": "node scripts/multiTenancy.js disable"
+    "multi:disable": "node scripts/multiTenancy.js disable",
+    "selfhost:enable": "node scripts/selfhost.js enable",
+    "selfhost:disable": "node scripts/selfhost.js disable"
   },
   "jest": {
     "preset": "ts-jest",

packages/server/scripts/selfhost.js

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+const updateDotEnv = require("update-dotenv")
+
+const arg = process.argv.slice(2)[0]
+
+updateDotEnv({
+  SELF_HOSTED: arg === "enable" ? "1" : "0",
+}).then(() => console.log("Updated server!"))

packages/worker/package.json

@@ -18,7 +18,9 @@
     "dev:builder": "npm run dev:stack:init && nodemon src/index.js",
     "test": "jest --runInBand",
     "multi:enable": "node scripts/multiTenancy.js enable",
-    "multi:disable": "node scripts/multiTenancy.js disable"
+    "multi:disable": "node scripts/multiTenancy.js disable",
+    "selfhost:enable": "node scripts/selfhost.js enable",
+    "selfhost:disable": "node scripts/selfhost.js disable"
   },
   "author": "Budibase",
   "license": "AGPL-3.0-or-later",

packages/worker/scripts/dev/manage.js

@@ -21,6 +21,7 @@ async function init() {
       COUCH_DB_PASSWORD: "budibase",
       // empty string is false
       MULTI_TENANCY: "",
+      ACCOUNT_PORTAL_URL: "http://localhost:3001",
     }
     let envFile = ""
     Object.keys(envFileJson).forEach(key => {

packages/worker/scripts/selfhost.js

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+const updateDotEnv = require("update-dotenv")
+
+const arg = process.argv.slice(2)[0]
+
+updateDotEnv({
+  SELF_HOSTED: arg === "enable" ? "1" : "0",
+}).then(() => console.log("Updated worker!"))

packages/worker/src/api/controllers/global/users.js

@@ -196,6 +196,11 @@ exports.getSelf = async ctx => {
   }
   // this will set the body
   await exports.find(ctx)
+
+  // append the account portal session information if present
+  if (ctx.user.account) {
+    ctx.body.account = ctx.user.account
+  }
 }
 
 exports.updateSelf = async ctx => {

packages/worker/src/api/controllers/system/environment.js

@@ -3,6 +3,7 @@ const env = require("../../../environment")
 exports.fetch = async ctx => {
   ctx.body = {
     multiTenancy: !!env.MULTI_TENANCY,
-    sandbox: !!env.SANDBOX,
+    cloud: !(env.SELF_HOSTED === "1"),
+    accountPortalUrl: env.ACCOUNT_PORTAL_URL,
   }
 }

packages/worker/src/api/index.js

@@ -44,7 +44,7 @@ const PUBLIC_ENDPOINTS = [
     method: "POST",
   },
   {
-    route: "api/system/flags",
+    route: "api/system/environment",
     method: "GET",
   },
   {

packages/worker/src/api/routes/index.js

@@ -6,7 +6,7 @@ const emailRoutes = require("./global/email")
 const authRoutes = require("./global/auth")
 const roleRoutes = require("./global/roles")
 const sessionRoutes = require("./global/sessions")
-const flagRoutes = require("./system/flags")
+const environmentRoutes = require("./system/environment")
 const tenantsRoutes = require("./system/tenants")
 const appRoutes = require("./app")
 
@@ -21,5 +21,5 @@ exports.routes = [
   emailRoutes,
   sessionRoutes,
   roleRoutes,
-  flagRoutes,
+  environmentRoutes,
 ]

packages/worker/src/api/routes/system/environment.js

@@ -0,0 +1,8 @@
+const Router = require("@koa/router")
+const controller = require("../../controllers/system/environment")
+
+const router = Router()
+
+router.get("/api/system/environment", controller.fetch)
+
+module.exports = router

packages/worker/src/api/routes/system/flags.js

@@ -1,8 +0,0 @@
-const Router = require("@koa/router")
-const controller = require("../../controllers/system/flags")
-
-const router = Router()
-
-router.get("/api/system/flags", controller.fetch)
-
-module.exports = router

packages/worker/src/environment.js

@@ -32,7 +32,7 @@ module.exports = {
   REDIS_PASSWORD: process.env.REDIS_PASSWORD,
   INTERNAL_API_KEY: process.env.INTERNAL_API_KEY,
   MULTI_TENANCY: process.env.MULTI_TENANCY,
-  SANDBOX: process.env.SANDBOX,
+  ACCOUNT_PORTAL_URL: process.env.ACCOUNT_PORTAL_URL,
   _set(key, value) {
     process.env[key] = value
     module.exports[key] = value