@budibase/server 1.3.15-alpha.0 → 1.3.16

package/dist/api/controllers/plugin.js

@@ -1,119 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.processPlugin = exports.destroy = exports.fetch = exports.upload = exports.getPlugins = void 0;
-const constants_1 = require("../../constants");
-const fileSystem_1 = require("../../utilities/fileSystem");
-const tenancy_1 = require("@budibase/backend-core/tenancy");
-const utils_1 = require("../../db/utils");
-const objectStore_1 = require("@budibase/backend-core/objectStore");
-const types_1 = require("@budibase/types");
-const environment_1 = __importDefault(require("../../environment"));
-function getPlugins(type) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const db = (0, tenancy_1.getGlobalDB)();
-        const response = yield db.allDocs((0, utils_1.getPluginParams)(null, {
-            include_docs: true,
-        }));
-        const plugins = response.rows.map((row) => row.doc);
-        if (type) {
-            return plugins.filter((plugin) => { var _a; return ((_a = plugin.schema) === null || _a === void 0 ? void 0 : _a.type) === type; });
-        }
-        else {
-            return plugins;
-        }
-    });
-}
-exports.getPlugins = getPlugins;
-function upload(ctx) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const plugins = ctx.request.files.file.length > 1
-            ? Array.from(ctx.request.files.file)
-            : [ctx.request.files.file];
-        try {
-            let docs = [];
-            // can do single or multiple plugins
-            for (let plugin of plugins) {
-                const doc = yield processPlugin(plugin);
-                docs.push(doc);
-            }
-            ctx.body = {
-                message: "Plugin(s) uploaded successfully",
-                plugins: docs,
-            };
-        }
-        catch (err) {
-            const errMsg = (err === null || err === void 0 ? void 0 : err.message) ? err === null || err === void 0 ? void 0 : err.message : err;
-            ctx.throw(400, `Failed to import plugin: ${errMsg}`);
-        }
-    });
-}
-exports.upload = upload;
-function fetch(ctx) {
-    return __awaiter(this, void 0, void 0, function* () {
-        ctx.body = yield getPlugins();
-    });
-}
-exports.fetch = fetch;
-function destroy(ctx) {
-    return __awaiter(this, void 0, void 0, function* () { });
-}
-exports.destroy = destroy;
-function processPlugin(plugin) {
-    return __awaiter(this, void 0, void 0, function* () {
-        if (!environment_1.default.SELF_HOSTED) {
-            throw new Error("Plugins not supported outside of self-host.");
-        }
-        const db = (0, tenancy_1.getGlobalDB)();
-        const { metadata, directory } = yield (0, fileSystem_1.extractPluginTarball)(plugin);
-        const version = metadata.package.version, name = metadata.package.name, description = metadata.package.description;
-        // first open the tarball into tmp directory
-        const bucketPath = `${name}/`;
-        const files = yield (0, objectStore_1.uploadDirectory)(constants_1.ObjectStoreBuckets.PLUGINS, directory, bucketPath);
-        const jsFile = files.find((file) => file.name.endsWith(".js"));
-        if (!jsFile) {
-            throw new Error(`Plugin missing .js file.`);
-        }
-        // validate the JS for a datasource
-        if (metadata.schema.type === types_1.PluginType.DATASOURCE) {
-            const js = (0, fileSystem_1.loadJSFile)(directory, jsFile.name);
-            // TODO: this isn't safe - but we need full node environment
-            // in future we should do this in a thread for safety
-            try {
-                eval(js);
-            }
-            catch (err) {
-                const message = (err === null || err === void 0 ? void 0 : err.message) ? err.message : JSON.stringify(err);
-                throw new Error(`JS invalid: ${message}`);
-            }
-        }
-        const jsFileName = jsFile.name;
-        const pluginId = (0, utils_1.generatePluginID)(name);
-        // overwrite existing docs entirely if they exist
-        let rev;
-        try {
-            const existing = yield db.get(pluginId);
-            rev = existing._rev;
-        }
-        catch (err) {
-            rev = undefined;
-        }
-        const doc = Object.assign(Object.assign({ _id: pluginId, _rev: rev }, metadata), { name,
-            version,
-            description, jsUrl: `${bucketPath}${jsFileName}` });
-        const response = yield db.put(doc);
-        return Object.assign(Object.assign({}, doc), { _rev: response.rev });
-    });
-}
-exports.processPlugin = processPlugin;

package/dist/api/routes/plugin.js

@@ -1,38 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const router_1 = __importDefault(require("@koa/router"));
-const controller = __importStar(require("../controllers/plugin"));
-const authorized_1 = __importDefault(require("../../middleware/authorized"));
-const permissions_1 = require("@budibase/backend-core/permissions");
-const router = new router_1.default();
-router
-    .post("/api/plugin/upload", (0, authorized_1.default)(permissions_1.BUILDER), controller.upload)
-    .get("/api/plugin", (0, authorized_1.default)(permissions_1.BUILDER), controller.fetch)
-    .delete("/api/plugin/:pluginId", (0, authorized_1.default)(permissions_1.BUILDER), controller.destroy);
-exports.default = router;

package/dist/watch.js

@@ -1,77 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.watch = void 0;
-const path_1 = __importDefault(require("path"));
-const env = __importStar(require("./environment"));
-const chokidar_1 = __importDefault(require("chokidar"));
-const fs_1 = __importDefault(require("fs"));
-const backend_core_1 = require("@budibase/backend-core");
-const constants_1 = require("@budibase/backend-core/constants");
-const plugin_1 = require("./api/controllers/plugin");
-function watch() {
-    const watchPath = path_1.default.join(env.PLUGINS_DIR, "./**/*.tar.gz");
-    chokidar_1.default
-        .watch(watchPath, {
-        ignored: "**/node_modules",
-        awaitWriteFinish: {
-            pollInterval: 100,
-            stabilityThreshold: 250,
-        },
-        usePolling: true,
-        interval: 250,
-    })
-        .on("all", (event, path) => __awaiter(this, void 0, void 0, function* () {
-        // Sanity checks
-        if (!(path === null || path === void 0 ? void 0 : path.endsWith(".tar.gz")) || !fs_1.default.existsSync(path)) {
-            return;
-        }
-        yield backend_core_1.tenancy.doInTenant(constants_1.DEFAULT_TENANT_ID, () => __awaiter(this, void 0, void 0, function* () {
-            try {
-                const split = path.split("/");
-                const name = split[split.length - 1];
-                console.log("Importing plugin:", path);
-                yield (0, plugin_1.processPlugin)({ name, path });
-            }
-            catch (err) {
-                const message = (err === null || err === void 0 ? void 0 : err.message) ? err === null || err === void 0 ? void 0 : err.message : err;
-                console.error("Failed to import plugin:", message);
-            }
-        }));
-    }));
-}
-exports.watch = watch;

package/src/api/controllers/plugin.ts

@@ -1,110 +0,0 @@
-import { ObjectStoreBuckets } from "../../constants"
-import { extractPluginTarball, loadJSFile } from "../../utilities/fileSystem"
-import { getGlobalDB } from "@budibase/backend-core/tenancy"
-import { generatePluginID, getPluginParams } from "../../db/utils"
-import { uploadDirectory } from "@budibase/backend-core/objectStore"
-import { PluginType, FileType } from "@budibase/types"
-import env from "../../environment"
-
-export async function getPlugins(type?: PluginType) {
-  const db = getGlobalDB()
-  const response = await db.allDocs(
-    getPluginParams(null, {
-      include_docs: true,
-    })
-  )
-  const plugins = response.rows.map((row: any) => row.doc)
-  if (type) {
-    return plugins.filter((plugin: any) => plugin.schema?.type === type)
-  } else {
-    return plugins
-  }
-}
-
-export async function upload(ctx: any) {
-  const plugins: FileType[] =
-    ctx.request.files.file.length > 1
-      ? Array.from(ctx.request.files.file)
-      : [ctx.request.files.file]
-  try {
-    let docs = []
-    // can do single or multiple plugins
-    for (let plugin of plugins) {
-      const doc = await processPlugin(plugin)
-      docs.push(doc)
-    }
-    ctx.body = {
-      message: "Plugin(s) uploaded successfully",
-      plugins: docs,
-    }
-  } catch (err: any) {
-    const errMsg = err?.message ? err?.message : err
-    ctx.throw(400, `Failed to import plugin: ${errMsg}`)
-  }
-}
-
-export async function fetch(ctx: any) {
-  ctx.body = await getPlugins()
-}
-
-export async function destroy(ctx: any) {}
-
-export async function processPlugin(plugin: FileType) {
-  if (!env.SELF_HOSTED) {
-    throw new Error("Plugins not supported outside of self-host.")
-  }
-  const db = getGlobalDB()
-  const { metadata, directory } = await extractPluginTarball(plugin)
-  const version = metadata.package.version,
-    name = metadata.package.name,
-    description = metadata.package.description
-
-  // first open the tarball into tmp directory
-  const bucketPath = `${name}/`
-  const files = await uploadDirectory(
-    ObjectStoreBuckets.PLUGINS,
-    directory,
-    bucketPath
-  )
-  const jsFile = files.find((file: any) => file.name.endsWith(".js"))
-  if (!jsFile) {
-    throw new Error(`Plugin missing .js file.`)
-  }
-  // validate the JS for a datasource
-  if (metadata.schema.type === PluginType.DATASOURCE) {
-    const js = loadJSFile(directory, jsFile.name)
-    // TODO: this isn't safe - but we need full node environment
-    // in future we should do this in a thread for safety
-    try {
-      eval(js)
-    } catch (err: any) {
-      const message = err?.message ? err.message : JSON.stringify(err)
-      throw new Error(`JS invalid: ${message}`)
-    }
-  }
-  const jsFileName = jsFile.name
-  const pluginId = generatePluginID(name)
-
-  // overwrite existing docs entirely if they exist
-  let rev
-  try {
-    const existing = await db.get(pluginId)
-    rev = existing._rev
-  } catch (err) {
-    rev = undefined
-  }
-  const doc = {
-    _id: pluginId,
-    _rev: rev,
-    ...metadata,
-    name,
-    version,
-    description,
-    jsUrl: `${bucketPath}${jsFileName}`,
-  }
-  const response = await db.put(doc)
-  return {
-    ...doc,
-    _rev: response.rev,
-  }
-}

package/src/api/routes/plugin.ts

@@ -1,13 +0,0 @@
-import Router from "@koa/router"
-import * as controller from "../controllers/plugin"
-import authorized from "../../middleware/authorized"
-import { BUILDER } from "@budibase/backend-core/permissions"
-
-const router = new Router()
-
-router
-  .post("/api/plugin/upload", authorized(BUILDER), controller.upload)
-  .get("/api/plugin", authorized(BUILDER), controller.fetch)
-  .delete("/api/plugin/:pluginId", authorized(BUILDER), controller.destroy)
-
-export default router

package/src/watch.ts

@@ -1,38 +0,0 @@
-import path from "path"
-import * as env from "./environment"
-import chokidar from "chokidar"
-import fs from "fs"
-import { tenancy } from "@budibase/backend-core"
-import { DEFAULT_TENANT_ID } from "@budibase/backend-core/constants"
-import { processPlugin } from "./api/controllers/plugin"
-
-export function watch() {
-  const watchPath = path.join(env.PLUGINS_DIR, "./**/*.tar.gz")
-  chokidar
-    .watch(watchPath, {
-      ignored: "**/node_modules",
-      awaitWriteFinish: {
-        pollInterval: 100,
-        stabilityThreshold: 250,
-      },
-      usePolling: true,
-      interval: 250,
-    })
-    .on("all", async (event: string, path: string) => {
-      // Sanity checks
-      if (!path?.endsWith(".tar.gz") || !fs.existsSync(path)) {
-        return
-      }
-      await tenancy.doInTenant(DEFAULT_TENANT_ID, async () => {
-        try {
-          const split = path.split("/")
-          const name = split[split.length - 1]
-          console.log("Importing plugin:", path)
-          await processPlugin({ name, path })
-        } catch (err: any) {
-          const message = err?.message ? err?.message : err
-          console.error("Failed to import plugin:", message)
-        }
-      })
-    })
-}