@budibase/cli 1.3.19-alpha.1 → 1.3.19

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@budibase/cli",
-  "version": "1.3.19-alpha.1",
+  "version": "1.3.19",
   "description": "Budibase CLI, for developers, self hosting and migrations.",
   "main": "src/index.js",
   "bin": {
@@ -26,18 +26,14 @@
     "outputPath": "build"
   },
   "dependencies": {
-    "@budibase/backend-core": "1.3.19-alpha.1",
-    "@budibase/string-templates": "1.3.19-alpha.1",
-    "@budibase/types": "1.3.19-alpha.1",
+    "@budibase/backend-core": "^1.3.19",
     "axios": "0.21.2",
     "chalk": "4.1.0",
     "cli-progress": "3.11.2",
     "commander": "7.1.0",
     "docker-compose": "0.23.6",
     "dotenv": "16.0.1",
-    "download": "8.0.0",
     "inquirer": "8.0.0",
-    "joi": "17.6.0",
     "lookpath": "1.1.0",
     "node-fetch": "2",
     "pkg": "5.7.0",
@@ -52,5 +48,5 @@
     "eslint": "^7.20.0",
     "renamer": "^4.0.0"
   },
-  "gitHead": "9eb4995976ec00b40ba52df7d0bc357e8df6edce"
+  "gitHead": "1e621da16bad75ae6a2dfcd732e676cf0b56a2a4"
 }

package/src/constants.js

@@ -1,11 +1,8 @@
-const { Event } = require("@budibase/types")
-
 exports.CommandWords = {
   BACKUPS: "backups",
   HOSTING: "hosting",
   ANALYTICS: "analytics",
   HELP: "help",
-  PLUGIN: "plugins",
 }
 
 exports.InitTypes = {
@@ -17,7 +14,6 @@ exports.AnalyticsEvents = {
   OptOut: "analytics:opt:out",
   OptIn: "analytics:opt:in",
   SelfHostInit: "hosting:init",
-  PluginInit: Event.PLUGIN_INIT,
 }
 
 exports.POSTHOG_TOKEN = "phc_yGOn4i7jWKaCTapdGR6lfA4AvmuEQ2ijn5zAVSFYPlS"

package/src/hosting/index.js

@@ -13,7 +13,7 @@ const fs = require("fs")
 const compose = require("docker-compose")
 const makeEnv = require("./makeEnv")
 const axios = require("axios")
-const { captureEvent } = require("../events")
+const AnalyticsClient = require("../analytics/Client")
 
 const BUDIBASE_SERVICES = ["app-service", "worker-service", "proxy-service"]
 const ERROR_FILE = "docker-error.log"
@@ -22,6 +22,8 @@ const FILE_URLS = [
 ]
 const DO_USER_DATA_URL = "http://169.254.169.254/metadata/v1/user-data"
 
+const client = new AnalyticsClient()
+
 async function downloadFiles() {
   const promises = []
   for (let url of FILE_URLS) {
@@ -70,8 +72,12 @@ async function init(type) {
       return
     }
   }
-  captureEvent(AnalyticsEvents.SelfHostInit, {
-    type,
+  client.capture({
+    distinctId: "cli",
+    event: AnalyticsEvents.SelfHostInit,
+    properties: {
+      type,
+    },
   })
   await downloadFiles()
   const config = isQuick ? makeEnv.QUICK_CONFIG : {}

package/src/index.js

@@ -1,6 +1,5 @@
 #!/usr/bin/env node
 require("./prebuilds")
-require("./environment")
 const { getCommands } = require("./options")
 const { Command } = require("commander")
 const { getHelpDescription } = require("./utils")

package/src/options.js

@@ -1,8 +1,7 @@
 const analytics = require("./analytics")
 const hosting = require("./hosting")
 const backups = require("./backups")
-const plugins = require("./plugins")
 
 exports.getCommands = () => {
-  return [hosting.command, analytics.command, backups.command, plugins.command]
+  return [hosting.command, analytics.command, backups.command]
 }

package/src/prebuilds.js

@@ -1,15 +1,11 @@
 const os = require("os")
 const { join } = require("path")
 const fs = require("fs")
-const { error } = require("./utils")
 const PREBUILDS = "prebuilds"
 const ARCH = `${os.platform()}-${os.arch()}`
 const PREBUILD_DIR = join(process.execPath, "..", PREBUILDS, ARCH)
 
-// running as built CLI pkg bundle
-if (!process.argv[0].includes("node")) {
-  checkForBinaries()
-}
+checkForBinaries()
 
 function checkForBinaries() {
   const readDir = join(__filename, "..", "..", PREBUILDS, ARCH)
@@ -26,18 +22,7 @@ function checkForBinaries() {
   }
 }
 
-function cleanup(evt) {
-  if (!isNaN(evt)) {
-    return
-  }
-  if (evt) {
-    console.error(
-      error(
-        "Failed to run CLI command - please report with the following message:"
-      )
-    )
-    console.error(error(evt))
-  }
+function cleanup() {
   if (fs.existsSync(PREBUILD_DIR)) {
     fs.rmSync(PREBUILD_DIR, { recursive: true })
   }

package/src/utils.js

@@ -3,7 +3,6 @@ const fs = require("fs")
 const axios = require("axios")
 const path = require("path")
 const progress = require("cli-progress")
-const { join } = require("path")
 
 exports.downloadFile = async (url, filePath) => {
   filePath = path.resolve(filePath)
@@ -68,19 +67,3 @@ exports.progressBar = total => {
 exports.checkSlashesInUrl = url => {
   return url.replace(/(https?:\/\/)|(\/)+/g, "$1$2")
 }
-
-exports.moveDirectory = (oldPath, newPath) => {
-  const files = fs.readdirSync(oldPath)
-  // check any file exists already
-  for (let file of files) {
-    if (fs.existsSync(join(newPath, file))) {
-      throw new Error(
-        "Unable to remove top level directory - some skeleton files already exist."
-      )
-    }
-  }
-  for (let file of files) {
-    fs.renameSync(join(oldPath, file), join(newPath, file))
-  }
-  fs.rmdirSync(oldPath)
-}

package/src/environment.js

@@ -1,2 +0,0 @@
-process.env.NO_JS = "1"
-process.env.JS_BCRYPT = "1"

package/src/events.js

@@ -1,11 +0,0 @@
-const AnalyticsClient = require("./analytics/Client")
-
-const client = new AnalyticsClient()
-
-exports.captureEvent = (event, properties) => {
-  client.capture({
-    distinctId: "cli",
-    event,
-    properties,
-  })
-}

package/src/exec.js

@@ -1,27 +0,0 @@
-const util = require("util")
-const exec = util.promisify(require("child_process").exec)
-
-exports.exec = async (command, dir = "./") => {
-  const { stdout } = await exec(command, { cwd: dir })
-  return stdout
-}
-
-exports.utilityInstalled = async utilName => {
-  try {
-    await exports.exec(`${utilName} --version`)
-    return true
-  } catch (err) {
-    return false
-  }
-}
-
-exports.runPkgCommand = async (command, dir = "./") => {
-  const yarn = await exports.utilityInstalled("yarn")
-  const npm = await exports.utilityInstalled("npm")
-  if (!yarn && !npm) {
-    throw new Error("Must have yarn or npm installed to run build.")
-  }
-  const npmCmd = command === "install" ? `npm ${command}` : `npm run ${command}`
-  const cmd = yarn ? `yarn ${command}` : npmCmd
-  await exports.exec(cmd, dir)
-}

package/src/plugins/index.js

@@ -1,164 +0,0 @@
-const Command = require("../structures/Command")
-const { CommandWords, AnalyticsEvents } = require("../constants")
-const { getSkeleton, fleshOutSkeleton } = require("./skeleton")
-const questions = require("../questions")
-const fs = require("fs")
-const { PLUGIN_TYPE_ARR } = require("@budibase/types")
-const { validate } = require("@budibase/backend-core/plugins")
-const { runPkgCommand } = require("../exec")
-const { join } = require("path")
-const { success, error, info, moveDirectory } = require("../utils")
-const { captureEvent } = require("../events")
-
-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) {
-  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) {
-  const type = opts["init"] || opts
-  if (!type || !PLUGIN_TYPE_ARR.includes(type)) {
-    console.log(
-      error(
-        "Please provide a type to init, either 'component' or 'datasource'."
-      )
-    )
-    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(AnalyticsEvents.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
-    validate(schemaJson)
-    return { name, version }
-  } catch (err) {
-    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."))
-  }
-}
-
-const command = new Command(`${CommandWords.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
-  )
-
-exports.command = command

package/src/plugins/skeleton.js

@@ -1,60 +0,0 @@
-const fetch = require("node-fetch")
-const download = require("download")
-const fs = require("fs")
-const os = require("os")
-const { join } = require("path")
-const tar = require("tar")
-const { processStringSync } = require("@budibase/string-templates")
-
-const HBS_FILES = ["package.json.hbs", "schema.json.hbs", "README.md.hbs"]
-
-async function getSkeletonUrl(type) {
-  const resp = await fetch(
-    "https://api.github.com/repos/budibase/budibase-skeleton/releases/latest"
-  )
-  if (resp.status >= 300) {
-    throw new Error("Failed to retrieve skeleton metadata")
-  }
-  const json = await resp.json()
-  for (let asset of json["assets"]) {
-    if (asset.name && asset.name.includes(type)) {
-      return asset["browser_download_url"]
-    }
-  }
-  throw new Error("No skeleton found in latest release.")
-}
-
-exports.getSkeleton = async (type, name) => {
-  const url = await getSkeletonUrl(type)
-  const tarballFile = join(os.tmpdir(), "skeleton.tar.gz")
-
-  // download the full skeleton tarball
-  fs.writeFileSync(tarballFile, await download(url))
-  fs.mkdirSync(name)
-  // extract it and get what we need
-  await tar.extract({
-    file: tarballFile,
-    C: name,
-  })
-  // clear up
-  fs.rmSync(tarballFile)
-}
-
-exports.fleshOutSkeleton = async (type, name, description, version) => {
-  for (let file of HBS_FILES) {
-    const oldFile = join(name, file),
-      newFile = join(name, file.substring(0, file.length - 4))
-    const hbsContents = fs.readFileSync(oldFile, "utf8")
-    if (!hbsContents) {
-      continue
-    }
-    const output = processStringSync(hbsContents, {
-      name,
-      description,
-      version,
-    })
-    // write the updated file and remove the HBS file
-    fs.writeFileSync(newFile, output)
-    fs.rmSync(oldFile)
-  }
-}