CodeMirror/budibase
1
0
Fork 0
mirror of synced 2024-07-03 05:20:32 +12:00
Code Issues Projects Releases Wiki Activity

Merge pull request #1452 from Budibase/first-time-setup

Browse source 
First time setup and Configuration Checklist
This commit is contained in:
Martin McKeaveney 2021-05-06 12:37:15 +01:00 committed by GitHub
parent f823b73a47 361db5e96f
commit e8774eebab
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
14 changed files with 336 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
packages/auth/src/db/utils.js
View file

@ -157,7 +157,7 @@ const getScopedFullConfig = async function (db, { type, user, group }) {
(a, b) => determineScore(a) - determineScore(b)
)[0]
return scopedConfig.doc
return scopedConfig && scopedConfig.doc
}
async function getScopedConfig(db, params) {

54
packages/builder/src/components/common/ConfigChecklist.svelte Normal file
View file

@ -0,0 +1,54 @@
<script>
import { isActive, url, goto } from "@roxi/routify"
import { onMount } from "svelte"
import {
ActionMenu,
Checkbox,
Body,
MenuItem,
Icon,
Heading,
Avatar,
Search,
Layout,
ProgressCircle,
SideNavigation as Navigation,
SideNavigationItem as Item,
} from "@budibase/bbui"
import api from "builderStore/api"
import { organisation, admin } from "stores/portal"
const MESSAGES = {
apps: "Create your first app",
smtp: "Set up email",
adminUser: "Create your first user",
}
</script>
<ActionMenu>
<div slot="control" class="icon">
<ProgressCircle size="S" value={$admin.onboardingProgress} />
</div>
<MenuItem disabled>
<header class="item">
<Heading size="XXS">Get Started Checklist</Heading>
<ProgressCircle size="S" value={$admin.onboardingProgress} />
</header>
</MenuItem>
{#each Object.keys($admin.checklist) as checklistItem, idx}
<MenuItem>
<div class="item">
<span>{idx + 1}. {MESSAGES[checklistItem]}</span>
<Checkbox value={!!$admin.checklist[checklistItem]} />
</div>
</MenuItem>
{/each}
</ActionMenu>
<style>
.item {
display: grid;
align-items: center;
grid-template-columns: 200px 20px;
}
</style>

29
packages/builder/src/pages/_layout.svelte Normal file
View file

@ -0,0 +1,29 @@
<script>
import { onMount } from "svelte"
import { goto } from "@roxi/routify"
import {
SideNavigation as Navigation,
SideNavigationItem as Item,
} from "@budibase/bbui"
import { admin } from "stores/portal"
import LoginForm from "components/login/LoginForm.svelte"
import BuilderSettingsButton from "components/start/BuilderSettingsButton.svelte"
import LogoutButton from "components/start/LogoutButton.svelte"
import Logo from "/assets/budibase-logo.svg"
import api from "builderStore/api"
let checklist
onMount(async () => {
await admin.init()
if (!$admin?.checklist?.adminUser) {
$goto("./admin")
} else {
$goto("./portal")
}
})
</script>
{#if $admin.checklist}
<slot />
{/if}

69
packages/builder/src/pages/admin/index.svelte Normal file
View file

@ -0,0 +1,69 @@
<script>
import {
Button,
Heading,
Label,
notifications,
Layout,
Input,
Body,
} from "@budibase/bbui"
import { goto } from "@roxi/routify"
import { onMount } from "svelte"
import api from "builderStore/api"
let adminUser = {}
async function save() {
try {
// Save the admin user
const response = await api.post(`/api/admin/users/init`, adminUser)
const json = await response.json()
if (response.status !== 200) throw new Error(json.message)
notifications.success(`Admin user created.`)
$goto("../portal")
} catch (err) {
notifications.error(`Failed to create admin user.`)
}
}
</script>
<section>
<div class="container">
<header>
<Heading size="M">Create an admin user</Heading>
<Body size="S">The admin user has access to everything in budibase.</Body>
</header>
<div class="config-form">
<Layout gap="S">
<Input label="email" bind:value={adminUser.email} />
<Input
label="password"
type="password"
bind:value={adminUser.password}
/>
<Button cta on:click={save}>Create super admin user</Button>
</Layout>
</div>
</div>
</section>
<style>
section {
display: flex;
align-items: center;
justify-content: center;
height: 100%;
}
header {
text-align: center;
width: 80%;
margin: 0 auto;
}
.config-form {
margin-bottom: 42px;
}
</style>

1
packages/builder/src/pages/builder/_layout.svelte
View file

@ -23,7 +23,6 @@
<div class="nav-top">
<Navigation>
<Item href="/builder/" icon="Apps" selected>Apps</Item>
<Item href="/builder/oauth/" icon="OAuth" selected>OAuth</Item>
<Item external href="https://portal.budi.live/" icon="Servers">
Hosting
</Item>

26
packages/builder/src/pages/portal/_layout.svelte
View file

@ -1,8 +1,12 @@
<script>
import { isActive, url } from "@roxi/routify"
import { isActive, url, goto } from "@roxi/routify"
import { onMount } from "svelte"
import {
ActionMenu,
Checkbox,
MenuItem,
Icon,
Heading,
Avatar,
Search,
Layout,
@ -10,13 +14,21 @@
SideNavigation as Navigation,
SideNavigationItem as Item,
} from "@budibase/bbui"
import { organisation } from "stores/portal"
import api from "builderStore/api"
import ConfigChecklist from "components/common/ConfigChecklist.svelte"
import { organisation, admin } from "stores/portal"
organisation.init()
let onBoardingProgress, user
let orgName
let orgLogo
let user
async function getInfo() {
onBoardingProgress = 20
// fetch orgInfo
orgName = "ACME Inc."
orgLogo = "https://via.placeholder.com/150"
user = { name: "John Doe" }
}
@ -47,15 +59,13 @@
<span>{$organisation?.company || "Budibase"}</span>
</div>
<div class="onboarding">
<ProgressCircle size="S" value={onBoardingProgress} />
<ConfigChecklist />
</div>
</div>
<div class="menu">
<Navigation>
{#each menu as { title, href, heading }}
<Item selected={$isActive(href)} href={$url(href)} {heading}>
{title}
</Item>
<Item selected={$isActive(href)} {href} {heading}>{title}</Item>
{/each}
</Navigation>
</div>

35
packages/builder/src/stores/portal/admin.js
View file

@ -1,7 +1,36 @@
import { writable } from "svelte/store"
import api from "builderStore/api"
const INITIAL_ADMIN_STATE = {
oauth: [],
export function createAdminStore() {
const { subscribe, set } = writable({})
async function init() {
try {
const response = await api.get("/api/admin/configs/checklist")
const json = await response.json()
const onboardingSteps = Object.keys(json)
const stepsComplete = onboardingSteps.reduce(
(score, step) => score + Number(!!json[step]),
0
)
set({
checklist: json,
onboardingProgress: (stepsComplete / onboardingSteps.length) * 100,
})
} catch (err) {
set({
checklist: null,
})
}
}
return {
subscribe,
init,
}
}
export const admin = writable({ ...INITIAL_ADMIN_STATE })
export const admin = createAdminStore()

43
packages/worker/src/api/controllers/admin/configs.js
View file

@ -3,10 +3,15 @@ const {
generateConfigID,
StaticDatabases,
getConfigParams,
getGlobalUserParams,
getScopedFullConfig,
} = require("@budibase/auth").db
const fetch = require("node-fetch")
const { Configs } = require("../../../constants")
const email = require("../../../utilities/email")
const env = require("../../../environment")
const APP_PREFIX = "app_"
const GLOBAL_DB = StaticDatabases.GLOBAL.name
@ -100,3 +105,41 @@ exports.destroy = async function (ctx) {
ctx.throw(err.status, err)
}
}
exports.configChecklist = async function (ctx) {
const db = new CouchDB(GLOBAL_DB)
try {
// TODO: Watch get started video
// Apps exist
let allDbs
if (env.COUCH_DB_URL) {
allDbs = await (await fetch(`${env.COUCH_DB_URL}/_all_dbs`)).json()
} else {
allDbs = await CouchDB.allDbs()
}
const appDbNames = allDbs.filter(dbName => dbName.startsWith(APP_PREFIX))
// They have set up SMTP
const smtpConfig = await getScopedFullConfig(db, {
type: Configs.SMTP,
})
// They have set up an admin user
const users = await db.allDocs(
getGlobalUserParams(null, {
include_docs: true,
})
)
const adminUser = users.rows.some(row => row.doc.admin)
ctx.body = {
apps: appDbNames.length,
smtp: !!smtpConfig,
adminUser,
}
} catch (err) {
ctx.throw(err.status, err)
}
}

28
packages/worker/src/api/controllers/admin/users.js
View file

@ -9,8 +9,6 @@ const { UserStatus, EmailTemplatePurpose } = require("../../../constants")
const { checkInviteCode } = require("../../../utilities/redis")
const { sendEmail } = require("../../../utilities/email")
const FIRST_USER_EMAIL = "test@test.com"
const FIRST_USER_PASSWORD = "test"
const GLOBAL_DB = StaticDatabases.GLOBAL.name
exports.save = async ctx => {
@ -62,21 +60,29 @@ exports.save = async ctx => {
}
}
exports.firstUser = async ctx => {
const existing = await getGlobalUserByEmail(FIRST_USER_EMAIL)
const params = {}
if (existing) {
params._id = existing._id
params._rev = existing._rev
exports.adminUser = async ctx => {
const db = new CouchDB(GLOBAL_DB)
const response = await db.allDocs(
getGlobalUserParams(null, {
include_docs: true,
})
)
if (response.rows.some(row => row.doc.admin)) {
ctx.throw(403, "You cannot initialise once an admin user has been created.")
}
const { email, password } = ctx.request.body
ctx.request.body = {
...params,
email: FIRST_USER_EMAIL,
password: FIRST_USER_PASSWORD,
email: email,
password: password,
roles: {},
builder: {
global: true,
},
admin: {
global: true,
},
}
await exports.save(ctx)
}

6
packages/worker/src/api/index.js
View file

@ -6,7 +6,7 @@ const { buildAuthMiddleware } = require("@budibase/auth").auth
const PUBLIC_ENDPOINTS = [
{
route: "/api/admin/users/first",
route: "/api/admin/users/init",
method: "POST",
},
{
@ -29,6 +29,10 @@ const PUBLIC_ENDPOINTS = [
route: "/api/admin/auth/reset",
method: "POST",
},
{
route: "/api/admin/configs/checklist",
method: "GET",
},
]
const router = new Router()

2
packages/worker/src/api/routes/admin/configs.js
View file

@ -71,6 +71,8 @@ function buildConfigGetValidation() {
router
.post("/api/admin/configs", buildConfigSaveValidation(), controller.save)
.delete("/api/admin/configs/:id", controller.destroy)
.get("/api/admin/configs", controller.fetch)
.get("/api/admin/configs/checklist", controller.configChecklist)
.get(
"/api/admin/configs/all/:type",
buildConfigGetValidation(),

2
packages/worker/src/api/routes/admin/users.js
View file

@ -42,7 +42,7 @@ function buildInviteAcceptValidation() {
router
.post("/api/admin/users", buildUserSaveValidation(), controller.save)
.get("/api/admin/users", controller.fetch)
.post("/api/admin/users/first", controller.firstUser)
.post("/api/admin/users/init", controller.adminUser)
.delete("/api/admin/users/:id", controller.destroy)
.get("/api/admin/users/:id", controller.find)
.post("/api/admin/users/invite", buildInviteValidation(), controller.invite)

38
packages/worker/src/api/routes/tests/configs.spec.js Normal file
View file

@ -0,0 +1,38 @@
const setup = require("./utilities")
// mock the email system
const sendMailMock = jest.fn()
jest.mock("nodemailer")
const nodemailer = require("nodemailer")
nodemailer.createTransport.mockReturnValue({
verify: jest.fn()
})
describe("/api/admin/configs/checklist", () => {
let request = setup.getRequest()
let config = setup.getConfig()
beforeAll(async () => {
await config.init()
})
afterAll(setup.afterAll)
it("should return the correct checklist status based on the state of the budibase installation", async () => {
// initially configure settings
await config.saveAdminUser()
await config.saveSmtpConfig()
const res = await request
.get(`/api/admin/configs/checklist`)
.set(config.defaultHeaders())
.expect("Content-Type", /json/)
.expect(200)
const checklist = res.body
expect(checklist.apps).toBe(0)
expect(checklist.smtp).toBe(true)
expect(checklist.adminUser).toBe(true)
})
})

27
packages/worker/src/api/routes/tests/utilities/TestConfiguration.js
View file

@ -131,6 +131,22 @@ class TestConfiguration {
)
}
async saveOAuthConfig() {
await this.deleteConfig(Configs.GOOGLE)
await this._req(
{
type: Configs.GOOGLE,
config: {
callbackURL: "http://somecallbackurl",
clientID: "clientId",
clientSecret: "clientSecret",
},
},
null,
controllers.config.save
)
}
async saveSmtpConfig() {
await this.deleteConfig(Configs.SMTP)
await this._req(
@ -167,6 +183,17 @@ class TestConfiguration {
controllers.config.save
)
}
async saveAdminUser() {
await this._req(
{
email: "testuser@test.com",
password: "test@test.com",
},
null,
controllers.users.adminUser
)
}
}
module.exports = TestConfiguration