@budibase/server 1.3.13 → 1.3.15-alpha.1

package/dist/api/controllers/screen.js

@@ -8,10 +8,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-const { getScreenParams, generateScreenID } = require("../../db/utils");
+const { getScreenParams, generateScreenID, getPluginParams, DocumentType, } = require("../../db/utils");
 const { AccessController } = require("@budibase/backend-core/roles");
 const { getAppDB } = require("@budibase/backend-core/context");
 const { events } = require("@budibase/backend-core");
+const { getGlobalDB } = require("@budibase/backend-core/tenancy");
+const { updateAppPackage } = require("./application");
 exports.fetch = (ctx) => __awaiter(void 0, void 0, void 0, function* () {
     const db = getAppDB();
     const screens = (yield db.allDocs(getScreenParams(null, {
@@ -28,11 +30,44 @@ exports.save = (ctx) => __awaiter(void 0, void 0, void 0, function* () {
         eventFn = events.screen.created;
     }
     const response = yield db.put(screen);
+    // Find any custom components being used
+    let pluginNames = [];
+    let pluginAdded = false;
+    findPlugins(screen.props, pluginNames);
+    if (pluginNames.length) {
+        const globalDB = getGlobalDB();
+        const pluginsResponse = yield globalDB.allDocs(getPluginParams(null, {
+            include_docs: true,
+        }));
+        const requiredPlugins = pluginsResponse.rows
+            .map(row => row.doc)
+            .filter(plugin => {
+            return (plugin.schema.type === "component" &&
+                pluginNames.includes(`plugin/${plugin.name}`));
+        });
+        // Update the app metadata
+        const application = yield db.get(DocumentType.APP_METADATA);
+        let usedPlugins = application.usedPlugins || [];
+        requiredPlugins.forEach(plugin => {
+            if (!usedPlugins.find(x => x._id === plugin._id)) {
+                pluginAdded = true;
+                usedPlugins.push({
+                    _id: plugin._id,
+                    name: plugin.name,
+                    version: plugin.version,
+                    jsUrl: plugin.jsUrl,
+                });
+            }
+        });
+        if (pluginAdded) {
+            yield updateAppPackage({ usedPlugins }, ctx.appId);
+        }
+    }
     if (eventFn) {
         yield eventFn(screen);
     }
     ctx.message = `Screen ${screen.name} saved.`;
-    ctx.body = Object.assign(Object.assign({}, screen), { _id: response.id, _rev: response.rev });
+    ctx.body = Object.assign(Object.assign({}, screen), { _id: response.id, _rev: response.rev, pluginAdded });
 });
 exports.destroy = (ctx) => __awaiter(void 0, void 0, void 0, function* () {
     const db = getAppDB();
@@ -45,3 +80,17 @@ exports.destroy = (ctx) => __awaiter(void 0, void 0, void 0, function* () {
     };
     ctx.status = 200;
 });
+const findPlugins = (component, foundPlugins) => {
+    if (!component) {
+        return;
+    }
+    if (component._component.startsWith("plugin")) {
+        if (!foundPlugins.includes(component._component)) {
+            foundPlugins.push(component._component);
+        }
+    }
+    if (!component._children || !component._children.length) {
+        return;
+    }
+    component._children.forEach(child => findPlugins(child, foundPlugins));
+};

package/dist/api/controllers/static/index.js

@@ -113,6 +113,7 @@ const serveApp = function (ctx) {
                 production: env.isProd(),
                 appId,
                 clientLibPath: clientLibraryPath(appId, appInfo.version, ctx),
+                usedPlugins: appInfo.usedPlugins,
             });
             const appHbs = loadHandlebarsFile(`${__dirname}/templates/app.hbs`);
             ctx.body = yield processString(appHbs, {

package/dist/api/controllers/static/templates/BudibaseApp.svelte

@@ -3,6 +3,7 @@
   export let favicon = ""
 
   export let clientLibPath
+  export let usedPlugins
 </script>
 
 <svelte:head>
@@ -83,6 +84,15 @@
   </script>
   <script type="application/javascript" src={clientLibPath}>
   </script>
+  <!-- Custom components need inserted after the core client library -->
+  <!-- But before loadBudibase is called -->
+  {#if usedPlugins?.length}
+    {#each usedPlugins as plugin}
+      <script
+        type="application/javascript"
+        src={`/plugins/${plugin.jsUrl}`}></script>
+    {/each}
+  {/if}
   <script type="application/javascript">
     if (window.loadBudibase) {
       window.loadBudibase()

package/dist/api/controllers/static/templates/preview.hbs

@@ -66,7 +66,8 @@
         customTheme,
         previewDevice,
         navigation,
-        hiddenComponentIds
+        hiddenComponentIds,
+        usedPlugins
       } = parsed
 
       // Set some flags so the app knows we're in the builder
@@ -81,6 +82,7 @@
       window["##BUDIBASE_PREVIEW_DEVICE##"] = previewDevice
       window["##BUDIBASE_PREVIEW_NAVIGATION##"] = navigation
       window["##BUDIBASE_HIDDEN_COMPONENT_IDS##"] = hiddenComponentIds
+      window["##BUDIBASE_USED_PLUGINS##"] = usedPlugins
 
       // Initialise app
       try {

package/dist/api/routes/index.js

@@ -30,6 +30,7 @@ const metadata_1 = __importDefault(require("./metadata"));
 const dev_1 = __importDefault(require("./dev"));
 const cloud_1 = __importDefault(require("./cloud"));
 const migrations_1 = __importDefault(require("./migrations"));
+const plugin_1 = __importDefault(require("./plugin"));
 var static_1 = require("./static");
 Object.defineProperty(exports, "staticRoutes", { enumerable: true, get: function () { return __importDefault(static_1).default; } });
 var public_1 = require("./public");
@@ -63,4 +64,5 @@ exports.mainRoutes = [
     table_1.default,
     row_1.default,
     migrations_1.default,
+    plugin_1.default,
 ];

package/dist/api/routes/plugin.js

@@ -0,0 +1,39 @@
+"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)
+    .post("/api/plugin", (0, authorized_1.default)(permissions_1.BUILDER), controller.create)
+    .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/app.js

@@ -60,10 +60,12 @@ const bullboard = require("./automations/bullboard");
 const { logAlert } = require("@budibase/backend-core/logging");
 const { pinoSettings } = require("@budibase/backend-core");
 const { Thread } = require("./threads");
+const fs = require("fs");
 const redis_1 = __importDefault(require("./utilities/redis"));
 const migrations = __importStar(require("./migrations"));
 const backend_core_1 = require("@budibase/backend-core");
 const workerRequests_1 = require("./utilities/workerRequests");
+const watch_1 = require("./watch");
 const app = new Koa();
 // set up top level koa middleware
 app.use(koaBody({
@@ -150,6 +152,13 @@ module.exports = server.listen(env.PORT || 0, () => __awaiter(void 0, void 0, vo
             }
         }
     }
+    // monitor plugin directory if required
+    if (env.SELF_HOSTED &&
+        !env.MULTI_TENANCY &&
+        env.PLUGINS_DIR &&
+        fs.existsSync(env.PLUGINS_DIR)) {
+        (0, watch_1.watch)();
+    }
     // check for version updates
     yield backend_core_1.installation.checkInstallVersion();
     // done last - this will never complete

package/dist/automations/index.js

@@ -10,16 +10,21 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 const { processEvent } = require("./utils");
 const { queue, shutdown } = require("./bullboard");
-const { TRIGGER_DEFINITIONS } = require("./triggers");
+const { TRIGGER_DEFINITIONS, rebootTrigger } = require("./triggers");
 const { ACTION_DEFINITIONS } = require("./actions");
 /**
  * This module is built purely to kick off the worker farm and manage the inputs/outputs
  */
 exports.init = function () {
-    // this promise will not complete
-    return queue.process((job) => __awaiter(this, void 0, void 0, function* () {
-        yield processEvent(job);
-    }));
+    return __awaiter(this, void 0, void 0, function* () {
+        // this promise will not complete
+        const promise = queue.process((job) => __awaiter(this, void 0, void 0, function* () {
+            yield processEvent(job);
+        }));
+        // on init we need to trigger any reboot automations
+        yield rebootTrigger();
+        return promise;
+    });
 };
 exports.getQueues = () => {
     return [queue];

package/dist/automations/triggers.js

@@ -19,23 +19,28 @@ const { checkTestFlag } = require("../utilities/redis");
 const utils = require("./utils");
 const env = require("../environment");
 const { doInAppContext, getAppDB } = require("@budibase/backend-core/context");
+const { getAllApps } = require("@budibase/backend-core/db");
 const TRIGGER_DEFINITIONS = definitions;
 const JOB_OPTS = {
     removeOnComplete: true,
     removeOnFail: true,
 };
+function getAllAutomations() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const db = getAppDB();
+        let automations = yield db.allDocs(getAutomationParams(null, { include_docs: true }));
+        return automations.rows.map(row => row.doc);
+    });
+}
 function queueRelevantRowAutomations(event, eventType) {
     return __awaiter(this, void 0, void 0, function* () {
         if (event.appId == null) {
             throw `No appId specified for ${eventType} - check event emitters.`;
         }
         doInAppContext(event.appId, () => __awaiter(this, void 0, void 0, function* () {
-            const db = getAppDB();
-            let automations = yield db.allDocs(getAutomationParams(null, { include_docs: true }));
+            let automations = yield getAllAutomations();
             // filter down to the correct event type
-            automations = automations.rows
-                .map(automation => automation.doc)
-                .filter(automation => {
+            automations = automations.filter(automation => {
                 const trigger = automation.definition.trigger;
                 return trigger && trigger.event === eventType;
             });
@@ -109,4 +114,33 @@ exports.externalTrigger = function (automation, params, { getResponses } = {}) {
         }
     });
 };
+exports.rebootTrigger = () => __awaiter(void 0, void 0, void 0, function* () {
+    // reboot cron option is only available on the main thread at
+    // startup and only usable in self host
+    if (env.isInThread() || !env.SELF_HOSTED) {
+        return;
+    }
+    // iterate through all production apps, find the reboot crons
+    // and trigger events for them
+    const appIds = yield getAllApps({ dev: false, idsOnly: true });
+    for (let prodAppId of appIds) {
+        yield doInAppContext(prodAppId, () => __awaiter(void 0, void 0, void 0, function* () {
+            let automations = yield getAllAutomations();
+            let rebootEvents = [];
+            for (let automation of automations) {
+                if (utils.isRebootTrigger(automation)) {
+                    const job = {
+                        automation,
+                        event: {
+                            appId: prodAppId,
+                            timestamp: Date.now(),
+                        },
+                    };
+                    rebootEvents.push(queue.add(job, JOB_OPTS));
+                }
+            }
+            yield Promise.all(rebootEvents);
+        }));
+    }
+});
 exports.TRIGGER_DEFINITIONS = TRIGGER_DEFINITIONS;

package/dist/automations/utils.js

@@ -35,7 +35,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isErrorInOutput = exports.isRecurring = exports.cleanupAutomations = exports.checkForWebhooks = exports.enableCronTrigger = exports.clearMetadata = exports.disableCron = exports.disableAllCrons = exports.removeDeprecated = exports.updateTestHistory = exports.processEvent = void 0;
+exports.isErrorInOutput = exports.isRecurring = exports.cleanupAutomations = exports.checkForWebhooks = exports.enableCronTrigger = exports.isRebootTrigger = exports.isCronTrigger = exports.clearMetadata = exports.disableCron = exports.disableAllCrons = exports.removeDeprecated = exports.updateTestHistory = exports.processEvent = void 0;
 const threads_1 = require("../threads");
 const triggerInfo_1 = require("./triggerInfo");
 const webhooks = __importStar(require("../api/controllers/webhook"));
@@ -49,6 +49,7 @@ const fp_1 = require("lodash/fp");
 const context_1 = require("@budibase/backend-core/context");
 const backend_core_1 = require("@budibase/backend-core");
 const pro_1 = require("@budibase/pro");
+const REBOOT_CRON = "@reboot";
 const WH_STEP_ID = triggerInfo_1.definitions.WEBHOOK.stepId;
 const CRON_STEP_ID = triggerInfo_1.definitions.CRON.stepId;
 const Runner = new threads_1.Thread(threads_1.ThreadType.AUTOMATION);
@@ -139,6 +140,17 @@ function clearMetadata() {
     });
 }
 exports.clearMetadata = clearMetadata;
+function isCronTrigger(auto) {
+    return (auto &&
+        auto.definition.trigger &&
+        auto.definition.trigger.stepId === CRON_STEP_ID);
+}
+exports.isCronTrigger = isCronTrigger;
+function isRebootTrigger(auto) {
+    const trigger = auto ? auto.definition.trigger : null;
+    return isCronTrigger(auto) && (trigger === null || trigger === void 0 ? void 0 : trigger.inputs.cron) === REBOOT_CRON;
+}
+exports.isRebootTrigger = isRebootTrigger;
 /**
  * This function handles checking of any cron jobs that need to be enabled/updated.
  * @param {string} appId The ID of the app in which we are checking for webhooks
@@ -147,13 +159,10 @@ exports.clearMetadata = clearMetadata;
 function enableCronTrigger(appId, automation) {
     return __awaiter(this, void 0, void 0, function* () {
         const trigger = automation ? automation.definition.trigger : null;
-        function isCronTrigger(auto) {
-            return (auto &&
-                auto.definition.trigger &&
-                auto.definition.trigger.stepId === CRON_STEP_ID);
-        }
         // need to create cron job
-        if (isCronTrigger(automation) && (trigger === null || trigger === void 0 ? void 0 : trigger.inputs.cron)) {
+        if (isCronTrigger(automation) &&
+            !isRebootTrigger(automation) &&
+            (trigger === null || trigger === void 0 ? void 0 : trigger.inputs.cron)) {
             // make a job id rather than letting Bull decide, makes it easier to handle on way out
             const jobId = `${appId}_cron_${(0, newid_1.default)()}`;
             const job = yield bullboard_1.queue.add({

package/dist/db/utils.js

@@ -7,7 +7,7 @@ const AppStatus = {
     ALL: "all",
     DEPLOYED: "published",
 };
-const DocumentType = Object.assign(Object.assign({}, CoreDocTypes), { TABLE: "ta", ROW: "ro", USER: "us", AUTOMATION: "au", LINK: "li", WEBHOOK: "wh", INSTANCE: "inst", LAYOUT: "layout", SCREEN: "screen", DATASOURCE: "datasource", DATASOURCE_PLUS: "datasource_plus", QUERY: "query", DEPLOYMENTS: "deployments", METADATA: "metadata", MEM_VIEW: "view", USER_FLAG: "flag", AUTOMATION_METADATA: "meta_au" });
+const DocumentType = Object.assign(Object.assign({}, CoreDocTypes), { TABLE: "ta", ROW: "ro", USER: "us", AUTOMATION: "au", LINK: "li", WEBHOOK: "wh", INSTANCE: "inst", LAYOUT: "layout", SCREEN: "screen", DATASOURCE: "datasource", DATASOURCE_PLUS: "datasource_plus", QUERY: "query", DEPLOYMENTS: "deployments", METADATA: "metadata", MEM_VIEW: "view", USER_FLAG: "flag", AUTOMATION_METADATA: "meta_au", PLUGIN: "plg" });
 const InternalTables = {
     USER_METADATA: "ta_users",
 };
@@ -274,6 +274,9 @@ exports.generateMemoryViewID = viewName => {
 exports.getMemoryViewParams = (otherProps = {}) => {
     return getDocParams(DocumentType.MEM_VIEW, null, otherProps);
 };
+exports.generatePluginID = name => {
+    return `${DocumentType.PLUGIN}${SEPARATOR}${name}`;
+};
 /**
  * This can be used with the db.allDocs to get a list of IDs
  */
@@ -283,3 +286,9 @@ exports.getMultiIDParams = ids => {
         include_docs: true,
     };
 };
+/**
+ * Gets parameters for retrieving automations, this is a utility function for the getDocParams function.
+ */
+exports.getPluginParams = (pluginId = null, otherProps = {}) => {
+    return getDocParams(DocumentType.PLUGIN, pluginId, otherProps);
+};

package/dist/environment.js

@@ -64,6 +64,7 @@ module.exports = {
     SQL_MAX_ROWS: process.env.SQL_MAX_ROWS,
     BB_ADMIN_USER_EMAIL: process.env.BB_ADMIN_USER_EMAIL,
     BB_ADMIN_USER_PASSWORD: process.env.BB_ADMIN_USER_PASSWORD,
+    PLUGINS_DIR: process.env.PLUGINS_DIR || "/plugins",
     // flags
     ALLOW_DEV_AUTOMATIONS: process.env.ALLOW_DEV_AUTOMATIONS,
     DISABLE_THREADING: process.env.DISABLE_THREADING,