@budibase/cli 0.0.1

package/src/hosting/makeFiles.ts

@@ -0,0 +1,140 @@
+import { number } from "../questions"
+import { success, stringifyToDotEnv } from "../utils"
+import fs from "fs"
+import path from "path"
+import yaml from "yaml"
+import { getAppService } from "./utils"
+const randomString = require("randomstring")
+
+const SINGLE_IMAGE = "budibase/budibase:latest"
+const VOL_NAME = "budibase_data"
+export const COMPOSE_PATH = path.resolve("./docker-compose.yaml")
+export const ENV_PATH = path.resolve("./.env")
+
+function getSecrets(opts = { single: false }) {
+  const secrets = [
+    "API_ENCRYPTION_KEY",
+    "JWT_SECRET",
+    "MINIO_ACCESS_KEY",
+    "MINIO_SECRET_KEY",
+    "REDIS_PASSWORD",
+    "INTERNAL_API_KEY",
+  ]
+  const obj: Record<string, string> = {}
+  secrets.forEach(secret => (obj[secret] = randomString.generate()))
+  // setup couch creds separately
+  if (opts && opts.single) {
+    obj["COUCHDB_USER"] = "admin"
+    obj["COUCHDB_PASSWORD"] = randomString.generate()
+  } else {
+    obj["COUCH_DB_USER"] = "admin"
+    obj["COUCH_DB_PASSWORD"] = randomString.generate()
+  }
+  return obj
+}
+
+function getSingleCompose(port: number) {
+  const singleComposeObj = {
+    version: "3",
+    services: {
+      budibase: {
+        restart: "unless-stopped",
+        image: SINGLE_IMAGE,
+        ports: [`${port}:80`],
+        environment: getSecrets({ single: true }),
+        volumes: [`${VOL_NAME}:/data`],
+      },
+    },
+    volumes: {
+      [VOL_NAME]: {
+        driver: "local",
+      },
+    },
+  }
+  return yaml.stringify(singleComposeObj)
+}
+
+function getEnv(port: number) {
+  const partOne = stringifyToDotEnv({
+    MAIN_PORT: port,
+  })
+  const partTwo = stringifyToDotEnv(getSecrets())
+  const partThree = stringifyToDotEnv({
+    APP_PORT: 4002,
+    WORKER_PORT: 4003,
+    MINIO_PORT: 4004,
+    COUCH_DB_PORT: 4005,
+    REDIS_PORT: 6379,
+    WATCHTOWER_PORT: 6161,
+    BUDIBASE_ENVIRONMENT: "PRODUCTION",
+  })
+  return [
+    "# Use the main port in the builder for your self hosting URL, e.g. localhost:10000",
+    partOne,
+    "# This section contains all secrets pertaining to the system",
+    partTwo,
+    "# This section contains variables that do not need to be altered under normal circumstances",
+    partThree,
+  ].join("\n")
+}
+
+export const ConfigMap = {
+  MAIN_PORT: "port",
+}
+
+export const QUICK_CONFIG = {
+  key: "budibase",
+  port: 10000,
+}
+
+async function make(
+  path: string,
+  contentsFn: Function,
+  inputs: any = {},
+  silent: boolean
+) {
+  const port =
+    inputs.port ||
+    (await number(
+      "Please enter the port on which you want your installation to run: ",
+      10000
+    ))
+  const fileContents = contentsFn(port)
+  fs.writeFileSync(path, fileContents)
+  if (!silent) {
+    console.log(
+      success(
+        `Configuration has been written successfully - please check ${path} for more details.`
+      )
+    )
+  }
+}
+
+export async function makeEnv(inputs: any = {}, silent: boolean) {
+  return make(ENV_PATH, getEnv, inputs, silent)
+}
+
+export async function makeSingleCompose(inputs: any = {}, silent: boolean) {
+  return make(COMPOSE_PATH, getSingleCompose, inputs, silent)
+}
+
+export function getEnvProperty(property: string) {
+  const props = fs.readFileSync(ENV_PATH, "utf8").split(property)
+  if (props[0].charAt(0) === "=") {
+    property = props[0]
+  } else {
+    property = props[1]
+  }
+  return property.split("=")[1].split("\n")[0]
+}
+
+export function getComposeProperty(property: string) {
+  const { service } = getAppService(COMPOSE_PATH)
+  if (property === "port" && Array.isArray(service.ports)) {
+    const port = service.ports[0]
+    return port.split(":")[0]
+  } else if (service.environment) {
+    return service.environment[property]
+  }
+  return null
+}

package/src/hosting/start.ts

@@ -0,0 +1,30 @@
+import { checkDockerConfigured, checkInitComplete, handleError } from "./utils"
+import { info, success } from "../utils"
+import * as makeFiles from "./makeFiles"
+import compose from "docker-compose"
+import fs from "fs"
+
+export async function start() {
+  await checkDockerConfigured()
+  checkInitComplete()
+  console.log(
+    info(
+      "Starting services, this may take a moment - first time this may take a few minutes to download images."
+    )
+  )
+  let port
+  if (fs.existsSync(makeFiles.ENV_PATH)) {
+    port = makeFiles.getEnvProperty("MAIN_PORT")
+  } else {
+    port = makeFiles.getComposeProperty("port")
+  }
+  await handleError(async () => {
+    // need to log as it makes it more clear
+    await compose.upAll({ cwd: "./", log: true })
+  })
+  console.log(
+    success(
+      `Services started, please go to http://localhost:${port} for next steps.`
+    )
+  )
+}

package/src/hosting/status.ts

@@ -0,0 +1,13 @@
+import { checkDockerConfigured, checkInitComplete, handleError } from "./utils"
+import { info } from "../utils"
+import compose from "docker-compose"
+
+export async function status() {
+  await checkDockerConfigured()
+  checkInitComplete()
+  console.log(info("Budibase status"))
+  await handleError(async () => {
+    const response = await compose.ps()
+    console.log(response.out)
+  })
+}

package/src/hosting/stop.ts

@@ -0,0 +1,13 @@
+import { checkDockerConfigured, checkInitComplete, handleError } from "./utils"
+import { info, success } from "../utils"
+import compose from "docker-compose"
+
+export async function stop() {
+  await checkDockerConfigured()
+  checkInitComplete()
+  console.log(info("Stopping services, this may take a moment."))
+  await handleError(async () => {
+    await compose.stop()
+  })
+  console.log(success("Services have been stopped successfully."))
+}

package/src/hosting/types.ts

@@ -0,0 +1,4 @@
+export interface DockerCompose {
+  environment: Record<string, string>
+  volumes: string[]
+}

package/src/hosting/update.ts

@@ -0,0 +1,55 @@
+import {
+  checkDockerConfigured,
+  checkInitComplete,
+  downloadDockerCompose,
+  handleError,
+  getServices,
+  getServiceImage,
+  setServiceImage,
+} from "./utils"
+import { confirmation } from "../questions"
+import compose from "docker-compose"
+import { COMPOSE_PATH } from "./makeFiles"
+import { info, success } from "../utils"
+import { start } from "./start"
+
+const BB_COMPOSE_SERVICES = ["app-service", "worker-service", "proxy-service"]
+const BB_SINGLE_SERVICE = ["budibase"]
+
+export async function update() {
+  const { services } = getServices(COMPOSE_PATH)
+  const isSingle = Object.keys(services).length === 1
+  await checkDockerConfigured()
+  checkInitComplete()
+  if (
+    !isSingle &&
+    (await confirmation("Do you wish to update you docker-compose.yaml?"))
+  ) {
+    // get current MinIO image
+    const image = await getServiceImage("minio")
+    await downloadDockerCompose()
+    // replace MinIO image
+    setServiceImage("minio", image)
+  }
+  await handleError(async () => {
+    const status = await compose.ps()
+    const parts = status.out.split("\n")
+    const isUp = parts[2] && parts[2].indexOf("Up") !== -1
+    if (isUp) {
+      console.log(info("Stopping services, this may take a moment."))
+      await compose.stop()
+    }
+    console.log(info("Beginning update, this may take a few minutes."))
+    let services
+    if (isSingle) {
+      services = BB_SINGLE_SERVICE
+    } else {
+      services = BB_COMPOSE_SERVICES
+    }
+    await compose.pullMany(services, { log: true })
+    if (isUp) {
+      console.log(success("Update complete, restarting services..."))
+      await start()
+    }
+  })
+}

package/src/hosting/utils.ts

@@ -0,0 +1,127 @@
+import { lookpath } from "lookpath"
+import fs from "fs"
+import * as makeFiles from "./makeFiles"
+import { logErrorToFile, downloadFile, error } from "../utils"
+import yaml from "yaml"
+import { DockerCompose } from "./types"
+
+const ERROR_FILE = "docker-error.log"
+const COMPOSE_URL =
+  "https://raw.githubusercontent.com/Budibase/budibase/master/hosting/docker-compose.yaml"
+
+function composeFilename() {
+  return COMPOSE_URL.split("/").slice(-1)[0]
+}
+
+export function getServiceImage(service: string) {
+  const filename = composeFilename()
+  try {
+    const { services } = getServices(filename)
+    const serviceKey = Object.keys(services).find(name =>
+      name.includes(service)
+    )
+    if (serviceKey) {
+      return services[serviceKey].image
+    } else {
+      return null
+    }
+  } catch (err) {
+    return null
+  }
+}
+
+export function setServiceImage(service: string, image: string) {
+  const filename = composeFilename()
+  if (!fs.existsSync(filename)) {
+    throw new Error(
+      `File ${filename} not found, cannot update ${service} image.`
+    )
+  }
+  const current = getServiceImage(service)!
+  let contents = fs.readFileSync(filename, "utf8")
+  contents = contents.replace(`image: ${current}`, `image: ${image}`)
+  fs.writeFileSync(filename, contents)
+}
+
+export async function downloadDockerCompose() {
+  const filename = composeFilename()
+  try {
+    await downloadFile(COMPOSE_URL, `./${filename}`)
+  } catch (err) {
+    console.error(error(`Failed to retrieve compose file - ${err}`))
+  }
+}
+
+export async function checkDockerConfigured() {
+  const error =
+    "docker/docker-compose has not been installed, please follow instructions at: https://docs.budibase.com/docs/docker-compose"
+  const docker = await lookpath("docker")
+  const compose = await lookpath("docker-compose")
+  if (!docker || !compose) {
+    throw error
+  }
+}
+
+export function checkInitComplete() {
+  if (
+    !fs.existsSync(makeFiles.ENV_PATH) &&
+    !fs.existsSync(makeFiles.COMPOSE_PATH)
+  ) {
+    throw "Please run the hosting --init command before any other hosting command."
+  }
+}
+
+export async function handleError(func: Function) {
+  try {
+    await func()
+  } catch (err: any) {
+    if (err && err.err) {
+      logErrorToFile(ERROR_FILE, err.err)
+    }
+    throw `Failed to start - logs written to file: ${ERROR_FILE}`
+  }
+}
+
+export function getServices(path: string) {
+  if (!fs.existsSync(path)) {
+    throw new Error(`No yaml found at path: ${path}`)
+  }
+  const dockerYaml = fs.readFileSync(path, "utf8")
+  const parsedYaml = yaml.parse(dockerYaml)
+  return { yaml: parsedYaml, services: parsedYaml.services }
+}
+
+export function getAppService(path: string) {
+  const { yaml, services } = getServices(path),
+    serviceList = Object.keys(services)
+  let service
+  if (services["app-service"]) {
+    service = services["app-service"]
+  } else if (serviceList.length === 1) {
+    service = services[serviceList[0]]
+  }
+  return { yaml, service }
+}
+
+export function updateDockerComposeService(
+  // eslint-disable-next-line no-unused-vars
+  updateFn: (service: DockerCompose) => void
+) {
+  const opts = ["docker-compose.yaml", "docker-compose.yml"]
+  const dockerFilePath = opts.find(name => fs.existsSync(name))
+  if (!dockerFilePath) {
+    console.log(error("Unable to locate docker-compose YAML."))
+    return
+  }
+  const { yaml: parsedYaml, service } = getAppService(dockerFilePath)
+  if (!service) {
+    console.log(
+      error(
+        "Unable to locate service within compose file, is it a valid Budibase configuration?"
+      )
+    )
+    return
+  }
+  updateFn(service)
+  fs.writeFileSync(dockerFilePath, yaml.stringify(parsedYaml))
+}

package/src/hosting/watch.ts

@@ -0,0 +1,37 @@
+import { resolve } from "path"
+import fs from "fs"
+import { error, success } from "../utils"
+import { updateDockerComposeService } from "./utils"
+import { DockerCompose } from "./types"
+
+export async function watchPlugins(pluginPath: string, silent: boolean) {
+  const PLUGIN_PATH = "/plugins"
+  // get absolute path
+  pluginPath = resolve(pluginPath)
+  if (!fs.existsSync(pluginPath)) {
+    console.log(
+      error(
+        `The directory "${pluginPath}" does not exist, please create and then try again.`
+      )
+    )
+    return
+  }
+  updateDockerComposeService((service: DockerCompose) => {
+    // set environment variable
+    service.environment["PLUGINS_DIR"] = PLUGIN_PATH
+    // add volumes to parsed yaml
+    if (!service.volumes) {
+      service.volumes = []
+    }
+    const found = service.volumes.find(vol => vol.includes(PLUGIN_PATH))
+    if (found) {
+      service.volumes.splice(service.volumes.indexOf(found), 1)
+    }
+    service.volumes.push(`${pluginPath}:${PLUGIN_PATH}`)
+  })
+  if (!silent) {
+    console.log(
+      success(`Docker compose configured to watch directory: ${pluginPath}`)
+    )
+  }
+}

package/src/index.ts

@@ -0,0 +1,27 @@
+#!/usr/bin/env node
+import { logging } from "@budibase/backend-core"
+logging.disableLogger()
+import "./prebuilds"
+import "./environment"
+import { getCommands } from "./options"
+import { Command } from "commander"
+import { getHelpDescription } from "./utils"
+const json = require("../package.json")
+
+// add hosting config
+async function init() {
+  const program = new Command()
+    .addHelpCommand("help", getHelpDescription("Help with Budibase commands."))
+    .helpOption(false)
+    .version(json.version)
+  // add commands
+  for (let command of getCommands()) {
+    command.configure(program)
+  }
+  // this will stop the program if no command found
+  await program.parseAsync(process.argv)
+}
+
+init().catch(err => {
+  console.error(`Unexpected error - `, err)
+})

package/src/options.ts

@@ -0,0 +1,8 @@
+import analytics from "./analytics"
+import hosting from "./hosting"
+import backups from "./backups"
+import plugins from "./plugins"
+
+export function getCommands() {
+  return [hosting, analytics, backups, plugins]
+}

package/src/plugins/index.ts

@@ -0,0 +1,198 @@
+import { Command } from "../structures/Command"
+import { CommandWord, AnalyticsEvent, InitType } from "../constants"
+import { getSkeleton, fleshOutSkeleton } from "./skeleton"
+import * as questions from "../questions"
+import fs from "fs"
+import { PluginType, PLUGIN_TYPE_ARR } from "@budibase/types"
+import { plugins } from "@budibase/backend-core"
+import { runPkgCommand } from "../exec"
+import { join } from "path"
+import { success, error, info, moveDirectory } from "../utils"
+import { captureEvent } from "../events"
+import { GENERATED_USER_EMAIL } from "../constants"
+import { init as hostingInit } from "../hosting/init"
+import { start as hostingStart } from "../hosting/start"
+const fp = require("find-free-port")
+
+type PluginOpts = {
+  init?: PluginType
+}
+
+function checkInPlugin() {
+  if (!fs.existsSync("package.json")) {
+    throw new Error(
+      "Please run in a plugin directory - must contain package.json"
+    )
+  }
+  if (!fs.existsSync("schema.json")) {
+    throw new Error(
+      "Please run in a plugin directory - must contain schema.json"
+    )
+  }
+}
+
+async function askAboutTopLevel(name: string) {
+  const files = fs.readdirSync(process.cwd())
+  // we are in an empty git repo, don't ask
+  if (files.find(file => file === ".git")) {
+    return false
+  } else {
+    console.log(
+      info(`By default the plugin will be created in the directory "${name}"`)
+    )
+    console.log(
+      info(
+        "if you are already in an empty directory, such as a new Git repo, you can disable this functionality."
+      )
+    )
+    return questions.confirmation("Create top level directory?")
+  }
+}
+
+async function init(opts: PluginOpts) {
+  const type = opts["init"] || (opts as PluginType)
+  if (!type || !PLUGIN_TYPE_ARR.includes(type)) {
+    console.log(
+      error(
+        "Please provide a type to init, either 'component', 'datasource' or 'automation'."
+      )
+    )
+    return
+  }
+  console.log(info("Lets get some details about your new plugin:"))
+  const name = await questions.string("Name", `budibase-${type}`)
+  if (fs.existsSync(name)) {
+    console.log(
+      error("Directory by plugin name already exists, pick a new name.")
+    )
+    return
+  }
+  const description = await questions.string(
+    "Description",
+    `An amazing Budibase ${type}!`
+  )
+  const version = await questions.string("Version", "1.0.0")
+  const topLevel = await askAboutTopLevel(name)
+  // get the skeleton
+  console.log(info("Retrieving project..."))
+  await getSkeleton(type, name)
+  await fleshOutSkeleton(type, name, description, version)
+  console.log(info("Installing dependencies..."))
+  await runPkgCommand("install", join(process.cwd(), name))
+  // if no parent directory desired move to cwd
+  if (!topLevel) {
+    moveDirectory(name, process.cwd())
+    console.log(info(`Plugin created in current directory.`))
+  } else {
+    console.log(info(`Plugin created in directory "${name}"`))
+  }
+  captureEvent(AnalyticsEvent.PluginInit, {
+    type,
+    name,
+    description,
+    version,
+  })
+}
+
+async function verify() {
+  // will throw errors if not acceptable
+  checkInPlugin()
+  console.log(info("Verifying plugin..."))
+  const schema = fs.readFileSync("schema.json", "utf8")
+  const pkg = fs.readFileSync("package.json", "utf8")
+  let name, version
+  try {
+    const schemaJson = JSON.parse(schema)
+    const pkgJson = JSON.parse(pkg)
+    if (!pkgJson.name || !pkgJson.version || !pkgJson.description) {
+      throw new Error(
+        "package.json is missing one of 'name', 'version' or 'description'."
+      )
+    }
+    name = pkgJson.name
+    version = pkgJson.version
+    plugins.validate(schemaJson)
+    return { name, version }
+  } catch (err: any) {
+    if (err && err.message && err.message.includes("not valid JSON")) {
+      console.log(error(`schema.json is not valid JSON: ${err.message}`))
+    } else {
+      console.log(error(`Invalid schema/package.json: ${err.message}`))
+    }
+  }
+}
+
+async function build() {
+  const verified = await verify()
+  if (!verified?.name) {
+    return
+  }
+  console.log(success("Verified!"))
+  console.log(info("Building plugin..."))
+  await runPkgCommand("build")
+  const output = join("dist", `${verified.name}-${verified.version}.tar.gz`)
+  console.log(success(`Build complete - output in: ${output}`))
+}
+
+async function watch() {
+  const verified = await verify()
+  if (!verified?.name) {
+    return
+  }
+  const output = join("dist", `${verified.name}-${verified.version}.tar.gz`)
+  console.log(info(`Watching - build in: ${output}`))
+  try {
+    await runPkgCommand("watch")
+  } catch (err) {
+    // always errors when user escapes
+    console.log(success("Watch exited."))
+  }
+}
+
+async function dev() {
+  const pluginDir = await questions.string("Directory to watch", "./")
+  const [port] = await fp(10000)
+  const password = "admin"
+  await hostingInit({
+    init: InitType.QUICK,
+    single: true,
+    watchPluginDir: pluginDir,
+    genUser: password,
+    port,
+    silent: true,
+  })
+  await hostingStart()
+  console.log(success(`Configuration has been written to docker-compose.yaml`))
+  console.log(
+    success("Development environment started successfully - connect at: ") +
+      info(`http://localhost:${port}`)
+  )
+  console.log(success("Use the following credentials to login:"))
+  console.log(success("Email: ") + info(GENERATED_USER_EMAIL))
+  console.log(success("Password: ") + info(password))
+}
+
+export default new Command(`${CommandWord.PLUGIN}`)
+  .addHelp(
+    "Custom plugins for Budibase, init, build and verify your components and datasources with this tool."
+  )
+  .addSubOption(
+    "--init [type]",
+    "Init a new plugin project, with a type of either component or datasource.",
+    init
+  )
+  .addSubOption(
+    "--build",
+    "Build your plugin, this will verify and produce a final tarball for your project.",
+    build
+  )
+  .addSubOption(
+    "--watch",
+    "Automatically build any changes to your plugin.",
+    watch
+  )
+  .addSubOption(
+    "--dev",
+    "Run a development environment which automatically watches the current directory.",
+    dev
+  )