@budibase/server 0.0.32 → 0.0.999-alpha.30

package/dist/db/views/staticViews.js

@@ -0,0 +1,144 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createAllSearchIndex = exports.createRoutingView = exports.createLinkView = void 0;
+const backend_core_1 = require("@budibase/backend-core");
+const utils_1 = require("../utils");
+const types_1 = require("@budibase/types");
+const SCREEN_PREFIX = utils_1.DocumentType.SCREEN + utils_1.SEPARATOR;
+/**************************************************
+ *                  INFORMATION                   *
+ * This file exists purely to keep views separate *
+ *    from the rest of the codebase, the reason   *
+ *    being that they affect coverage and any     *
+ *  functions written in this file cannot import  *
+ *  or make use of any constants/variables that   *
+ *   aren't defined as part of the map function   *
+ *                   itself.                      *
+ **************************************************/
+/**
+ * Creates the link view for the instance, this will overwrite the existing one, but this should only
+ * be called if it is found that the view does not exist.
+ * @returns {Promise<void>} The view now exists, please note that the next view of this query will actually build it,
+ * so it may be slow.
+ */
+function createLinkView() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const db = backend_core_1.context.getAppDB();
+        const designDoc = yield db.get("_design/database");
+        const view = {
+            map: function (doc) {
+                // everything in this must remain constant as its going to Pouch, no external variables
+                if (doc.type === "link") {
+                    let doc1 = doc.doc1;
+                    let doc2 = doc.doc2;
+                    // eslint-disable-next-line no-undef
+                    // @ts-ignore
+                    emit([doc1.tableId, doc1.rowId], {
+                        id: doc2.rowId,
+                        thisId: doc1.rowId,
+                        fieldName: doc1.fieldName,
+                    });
+                    // if linking to same table can't emit twice
+                    if (doc1.tableId !== doc2.tableId) {
+                        // eslint-disable-next-line no-undef
+                        // @ts-ignore
+                        emit([doc2.tableId, doc2.rowId], {
+                            id: doc1.rowId,
+                            thisId: doc2.rowId,
+                            fieldName: doc2.fieldName,
+                        });
+                    }
+                }
+            }.toString(),
+        };
+        designDoc.views = Object.assign(Object.assign({}, designDoc.views), { [utils_1.ViewName.LINK]: view });
+        yield db.put(designDoc);
+    });
+}
+exports.createLinkView = createLinkView;
+function createRoutingView() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const db = backend_core_1.context.getAppDB();
+        const designDoc = yield db.get("_design/database");
+        const view = {
+            // if using variables in a map function need to inject them before use
+            map: `function(doc) {
+      if (doc._id.startsWith("${SCREEN_PREFIX}")) {
+        emit(doc._id, {
+          id: doc._id,
+          routing: doc.routing,
+        })
+      }
+    }`,
+        };
+        designDoc.views = Object.assign(Object.assign({}, designDoc.views), { [utils_1.ViewName.ROUTING]: view });
+        yield db.put(designDoc);
+    });
+}
+exports.createRoutingView = createRoutingView;
+function searchIndex(indexName, fnString) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const db = backend_core_1.context.getAppDB();
+        const designDoc = yield db.get("_design/database");
+        designDoc.indexes = {
+            [indexName]: {
+                index: fnString,
+                analyzer: "keyword",
+            },
+        };
+        yield db.put(designDoc);
+    });
+}
+function createAllSearchIndex() {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield searchIndex(types_1.SearchIndex.ROWS, function (doc) {
+            function idx(input, prev) {
+                for (let key of Object.keys(input)) {
+                    let idxKey = prev != null ? `${prev}.${key}` : key;
+                    idxKey = idxKey.replace(/ /g, "_");
+                    if (Array.isArray(input[key])) {
+                        for (let val of input[key]) {
+                            if (typeof val !== "object") {
+                                // eslint-disable-next-line no-undef
+                                // @ts-ignore
+                                index(idxKey, val, { store: true });
+                            }
+                        }
+                    }
+                    else if (key === "_id" || key === "_rev" || input[key] == null) {
+                        continue;
+                    }
+                    if (typeof input[key] === "string") {
+                        // eslint-disable-next-line no-undef
+                        // @ts-ignore
+                        index(idxKey, input[key].toLowerCase(), { store: true });
+                    }
+                    else if (typeof input[key] !== "object") {
+                        // eslint-disable-next-line no-undef
+                        // @ts-ignore
+                        index(idxKey, input[key], { store: true });
+                    }
+                    else {
+                        idx(input[key], idxKey);
+                    }
+                }
+            }
+            if (doc._id.startsWith("ro_")) {
+                // eslint-disable-next-line no-undef
+                // @ts-ignore
+                index("default", doc._id);
+                idx(doc);
+            }
+        }.toString());
+    });
+}
+exports.createAllSearchIndex = createAllSearchIndex;

package/dist/ddApm.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const dd_trace_1 = __importDefault(require("dd-trace"));
+// enable APM if configured
+if (process.env.DD_APM_ENABLED) {
+    console.log("Starting dd-trace");
+    dd_trace_1.default.init();
+}

package/dist/definitions/automations.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LoopStepType = void 0;
+var LoopStepType;
+(function (LoopStepType) {
+    LoopStepType["ARRAY"] = "Array";
+    LoopStepType["STRING"] = "String";
+})(LoopStepType = exports.LoopStepType || (exports.LoopStepType = {}));

package/dist/definitions/common.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/definitions/datasource.js

@@ -0,0 +1,7 @@
+"use strict";
+/********************************************
+ * This file contains structures which are  *
+ * internal to the server and don't need to *
+ * be exposed for use by other services.    *
+ ********************************************/
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/definitions/openapi.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/environment.js

@@ -0,0 +1,113 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = require("path");
+function isTest() {
+    return isCypress() || isJest();
+}
+function isJest() {
+    return (process.env.NODE_ENV === "jest" ||
+        (process.env.JEST_WORKER_ID != null &&
+            process.env.JEST_WORKER_ID !== "null"));
+}
+function isDev() {
+    return process.env.NODE_ENV !== "production";
+}
+function isCypress() {
+    return process.env.NODE_ENV === "cypress";
+}
+let LOADED = false;
+if (!LOADED && isDev() && !isTest()) {
+    require("dotenv").config({
+        path: (0, path_1.join)(__dirname, "..", ".env"),
+    });
+    LOADED = true;
+}
+function parseIntSafe(number) {
+    if (number) {
+        return parseInt(number);
+    }
+}
+let inThread = false;
+const environment = {
+    // important - prefer app port to generic port
+    PORT: process.env.APP_PORT || process.env.PORT,
+    COUCH_DB_URL: process.env.COUCH_DB_URL,
+    MINIO_URL: process.env.MINIO_URL,
+    WORKER_URL: process.env.WORKER_URL,
+    AWS_REGION: process.env.AWS_REGION,
+    MINIO_ACCESS_KEY: process.env.MINIO_ACCESS_KEY,
+    MINIO_SECRET_KEY: process.env.MINIO_SECRET_KEY,
+    REDIS_URL: process.env.REDIS_URL,
+    REDIS_PASSWORD: process.env.REDIS_PASSWORD,
+    HTTP_MIGRATIONS: process.env.HTTP_MIGRATIONS,
+    API_REQ_LIMIT_PER_SEC: process.env.API_REQ_LIMIT_PER_SEC,
+    GOOGLE_CLIENT_ID: process.env.GOOGLE_CLIENT_ID,
+    GOOGLE_CLIENT_SECRET: process.env.GOOGLE_CLIENT_SECRET,
+    // environment
+    NODE_ENV: process.env.NODE_ENV,
+    JEST_WORKER_ID: process.env.JEST_WORKER_ID,
+    BUDIBASE_ENVIRONMENT: process.env.BUDIBASE_ENVIRONMENT,
+    DISABLE_ACCOUNT_PORTAL: process.env.DISABLE_ACCOUNT_PORTAL,
+    TEMPLATE_REPOSITORY: process.env.TEMPLATE_REPOSITORY || "app",
+    DISABLE_AUTO_PROD_APP_SYNC: process.env.DISABLE_AUTO_PROD_APP_SYNC,
+    SESSION_UPDATE_PERIOD: process.env.SESSION_UPDATE_PERIOD,
+    // minor
+    SALT_ROUNDS: process.env.SALT_ROUNDS,
+    LOGGER: process.env.LOGGER,
+    ACCOUNT_PORTAL_URL: process.env.ACCOUNT_PORTAL_URL,
+    AUTOMATION_MAX_ITERATIONS: parseIntSafe(process.env.AUTOMATION_MAX_ITERATIONS) || 200,
+    SENDGRID_API_KEY: process.env.SENDGRID_API_KEY,
+    DYNAMO_ENDPOINT: process.env.DYNAMO_ENDPOINT,
+    QUERY_THREAD_TIMEOUT: parseIntSafe(process.env.QUERY_THREAD_TIMEOUT),
+    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,
+    DISABLE_AUTOMATION_LOGS: process.env.DISABLE_AUTOMATION_LOGS,
+    MULTI_TENANCY: process.env.MULTI_TENANCY,
+    ENABLE_ANALYTICS: process.env.ENABLE_ANALYTICS,
+    SELF_HOSTED: process.env.SELF_HOSTED,
+    HTTP_MB_LIMIT: process.env.HTTP_MB_LIMIT,
+    // old
+    CLIENT_ID: process.env.CLIENT_ID,
+    _set(key, value) {
+        process.env[key] = value;
+        // @ts-ignore
+        environment[key] = value;
+    },
+    isTest,
+    isJest,
+    isCypress,
+    isDev,
+    isProd: () => {
+        return !isDev();
+    },
+    // used to check if already in a thread, don't thread further
+    setInThread: () => {
+        inThread = true;
+    },
+    isInThread: () => {
+        return inThread;
+    },
+};
+// threading can cause memory issues with node-ts in development
+if (isDev() && environment.DISABLE_THREADING == null) {
+    environment._set("DISABLE_THREADING", "1");
+}
+// clean up any environment variable edge cases
+for (let [key, value] of Object.entries(environment)) {
+    // handle the edge case of "0" to disable an environment variable
+    if (value === "0") {
+        // @ts-ignore
+        environment[key] = 0;
+    }
+    // handle the edge case of "false" to disable an environment variable
+    if (value === "false") {
+        // @ts-ignore
+        environment[key] = 0;
+    }
+}
+exports.default = environment;

package/dist/events/AutomationEmitter.js

@@ -0,0 +1,53 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("./utils");
+const index_1 = __importDefault(require("./index"));
+const environment_1 = __importDefault(require("../environment"));
+// max number of automations that can chain on top of each other
+// TODO: in future make this configurable at the automation level
+const MAX_AUTOMATION_CHAIN = environment_1.default.SELF_HOSTED ? 5 : 0;
+/**
+ * Special emitter which takes the count of automation runs which have occurred and blocks an
+ * automation from running if it has reached the maximum number of chained automations runs.
+ * This essentially "fakes" the normal emitter to add some functionality in-between to stop automations
+ * from getting stuck endlessly chaining.
+ */
+class AutomationEmitter {
+    constructor(chainCount) {
+        this.chainCount = chainCount;
+        this.metadata = {
+            automationChainCount: chainCount,
+        };
+    }
+    emitRow(eventName, appId, row, table) {
+        // don't emit even if we've reached max automation chain
+        if (this.chainCount >= MAX_AUTOMATION_CHAIN) {
+            return;
+        }
+        (0, utils_1.rowEmission)({
+            emitter: index_1.default,
+            eventName,
+            appId,
+            row,
+            table,
+            metadata: this.metadata,
+        });
+    }
+    emitTable(eventName, appId, table) {
+        // don't emit even if we've reached max automation chain
+        if (this.chainCount > MAX_AUTOMATION_CHAIN) {
+            return;
+        }
+        (0, utils_1.tableEmission)({
+            emitter: index_1.default,
+            eventName,
+            appId,
+            table,
+            metadata: this.metadata,
+        });
+    }
+}
+exports.default = AutomationEmitter;

package/dist/events/BudibaseEmitter.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const events_1 = require("events");
+const utils_1 = require("./utils");
+/**
+ * keeping event emitter in one central location as it might be used for things other than
+ * automations (what it was for originally) - having a central emitter will be useful in the
+ * future.
+ */
+/**
+ * Extending the standard emitter to some syntactic sugar and standardisation to the emitted event.
+ * This is specifically quite important for template strings used in automations.
+ */
+class BudibaseEmitter extends events_1.EventEmitter {
+    emitRow(eventName, appId, row, table) {
+        (0, utils_1.rowEmission)({ emitter: this, eventName, appId, row, table });
+    }
+    emitTable(eventName, appId, table) {
+        (0, utils_1.tableEmission)({ emitter: this, eventName, appId, table });
+    }
+    emitPort(portNumber) {
+        this.emit("internal:port", portNumber);
+    }
+}
+exports.default = BudibaseEmitter;

package/dist/events/docUpdates/index.js

@@ -0,0 +1,17 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./processors"), exports);

package/dist/events/docUpdates/processors.js

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.init = void 0;
+const syncUsers_1 = __importDefault(require("./syncUsers"));
+const backend_core_1 = require("@budibase/backend-core");
+let started = false;
+function init(updateCb) {
+    if (started) {
+        return;
+    }
+    const processors = [(0, syncUsers_1.default)(updateCb)];
+    backend_core_1.docUpdates.init(processors);
+    started = true;
+}
+exports.init = init;

package/dist/events/docUpdates/syncUsers.js

@@ -0,0 +1,49 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const backend_core_1 = require("@budibase/backend-core");
+const pro_1 = require("@budibase/pro");
+const types_1 = require("@budibase/types");
+const sync_1 = require("../../sdk/app/applications/sync");
+function process(updateCb) {
+    const processor = (update) => __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        try {
+            const docId = update.id;
+            const isGroup = docId.startsWith(backend_core_1.constants.DocumentType.GROUP);
+            let userIds;
+            if (isGroup) {
+                const group = yield pro_1.sdk.groups.get(docId);
+                userIds = ((_a = group.users) === null || _a === void 0 ? void 0 : _a.map(user => user._id)) || [];
+            }
+            else {
+                userIds = [docId];
+            }
+            if (userIds.length > 0) {
+                yield (0, sync_1.syncUsersToAllApps)(userIds);
+            }
+            if (updateCb) {
+                updateCb(docId);
+            }
+        }
+        catch (err) {
+            // if something not found - no changes to perform
+            if ((err === null || err === void 0 ? void 0 : err.status) === 404) {
+                return;
+            }
+            else {
+                backend_core_1.logging.logAlert("Failed to perform user/group app sync", err);
+            }
+        }
+    });
+    return { events: types_1.UserGroupSyncEvents, processor };
+}
+exports.default = process;

package/dist/events/index.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.init = void 0;
+const BudibaseEmitter_1 = __importDefault(require("./BudibaseEmitter"));
+const emitter = new BudibaseEmitter_1.default();
+var docUpdates_1 = require("./docUpdates");
+Object.defineProperty(exports, "init", { enumerable: true, get: function () { return docUpdates_1.init; } });
+exports.default = emitter;

package/dist/events/utils.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tableEmission = exports.rowEmission = void 0;
+function rowEmission({ emitter, eventName, appId, row, table, metadata, }) {
+    let event = {
+        row,
+        appId,
+        tableId: row === null || row === void 0 ? void 0 : row.tableId,
+    };
+    if (table) {
+        event.table = table;
+    }
+    event.id = row === null || row === void 0 ? void 0 : row._id;
+    if (row === null || row === void 0 ? void 0 : row._rev) {
+        event.revision = row._rev;
+    }
+    if (metadata) {
+        event.metadata = metadata;
+    }
+    emitter.emit(eventName, event);
+}
+exports.rowEmission = rowEmission;
+function tableEmission({ emitter, eventName, appId, table, metadata, }) {
+    const tableId = table === null || table === void 0 ? void 0 : table._id;
+    const inputTable = table;
+    if (inputTable) {
+        inputTable.tableId = tableId;
+    }
+    let event = {
+        table: inputTable,
+        appId,
+        tableId: tableId,
+    };
+    event.id = tableId;
+    if (table === null || table === void 0 ? void 0 : table._rev) {
+        event.revision = table._rev;
+    }
+    if (metadata) {
+        event.metadata = metadata;
+    }
+    emitter.emit(eventName, event);
+}
+exports.tableEmission = tableEmission;

package/dist/index.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const global_agent_1 = require("global-agent");
+const fixPath = require("fix-path");
+const fileSystem_1 = require("./utilities/fileSystem");
+function runServer() {
+    // this will shutdown the system if development environment not ready
+    // will print an error explaining what to do
+    (0, fileSystem_1.checkDevelopmentEnvironment)();
+    fixPath();
+    // this will setup http and https proxies form env variables
+    process.env.GLOBAL_AGENT_FORCE_GLOBAL_AGENT = "false";
+    (0, global_agent_1.bootstrap)();
+    require("./app");
+}
+runServer();