@budibase/server 2.3.19 → 2.3.21-alpha.0

package/dist/api/controllers/row/internalSearch.js

@@ -8,465 +8,21 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         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.fullSearch = exports.paginatedSearch = exports.QueryBuilder = void 0;
-const utils_1 = require("../../../db/utils");
-const utils_2 = require("./utils");
-const node_fetch_1 = __importDefault(require("node-fetch"));
+exports.fullSearch = exports.paginatedSearch = void 0;
 const backend_core_1 = require("@budibase/backend-core");
-/**
- * Class to build lucene query URLs.
- * Optionally takes a base lucene query object.
- */
-class QueryBuilder {
-    constructor(base) {
-        this.query = Object.assign({ allOr: false, string: {}, fuzzy: {}, range: {}, equal: {}, notEqual: {}, empty: {}, notEmpty: {}, oneOf: {}, contains: {}, notContains: {}, containsAny: {} }, base);
-        this.limit = 50;
-        this.sortOrder = "ascending";
-        this.sortType = "string";
-        this.includeDocs = true;
-    }
-    setVersion(version) {
-        if (version != null) {
-            this.version = version;
-        }
-        return this;
-    }
-    setTable(tableId) {
-        this.query.equal.tableId = tableId;
-        return this;
-    }
-    setLimit(limit) {
-        if (limit != null) {
-            this.limit = limit;
-        }
-        return this;
-    }
-    setSort(sort) {
-        if (sort != null) {
-            this.sort = sort;
-        }
-        return this;
-    }
-    setSortOrder(sortOrder) {
-        if (sortOrder != null) {
-            this.sortOrder = sortOrder;
-        }
-        return this;
-    }
-    setSortType(sortType) {
-        if (sortType != null) {
-            this.sortType = sortType;
-        }
-        return this;
-    }
-    setBookmark(bookmark) {
-        if (bookmark != null) {
-            this.bookmark = bookmark;
-        }
-        return this;
-    }
-    excludeDocs() {
-        this.includeDocs = false;
-        return this;
-    }
-    addString(key, partial) {
-        this.query.string[key] = partial;
-        return this;
-    }
-    addFuzzy(key, fuzzy) {
-        this.query.fuzzy[key] = fuzzy;
-        return this;
-    }
-    addRange(key, low, high) {
-        this.query.range[key] = {
-            low,
-            high,
-        };
-        return this;
-    }
-    addEqual(key, value) {
-        this.query.equal[key] = value;
-        return this;
-    }
-    addNotEqual(key, value) {
-        this.query.notEqual[key] = value;
-        return this;
-    }
-    addEmpty(key, value) {
-        this.query.empty[key] = value;
-        return this;
-    }
-    addNotEmpty(key, value) {
-        this.query.notEmpty[key] = value;
-        return this;
-    }
-    addOneOf(key, value) {
-        this.query.oneOf[key] = value;
-        return this;
-    }
-    addContains(key, value) {
-        this.query.contains[key] = value;
-        return this;
-    }
-    addNotContains(key, value) {
-        this.query.notContains[key] = value;
-        return this;
-    }
-    addContainsAny(key, value) {
-        this.query.containsAny[key] = value;
-        return this;
-    }
-    /**
-     * Preprocesses a value before going into a lucene search.
-     * Transforms strings to lowercase and wraps strings and bools in quotes.
-     * @param value The value to process
-     * @param options The preprocess options
-     * @returns {string|*}
-     */
-    preprocess(value, { escape, lowercase, wrap, type } = {}) {
-        const hasVersion = !!this.version;
-        // Determine if type needs wrapped
-        const originalType = typeof value;
-        // Convert to lowercase
-        if (value && lowercase) {
-            value = value.toLowerCase ? value.toLowerCase() : value;
-        }
-        // Escape characters
-        if (escape && originalType === "string") {
-            value = `${value}`.replace(/[ #+\-&|!(){}\]^"~*?:\\]/g, "\\$&");
-        }
-        // Wrap in quotes
-        if (originalType === "string" && !isNaN(value) && !type) {
-            value = `"${value}"`;
-        }
-        else if (hasVersion && wrap) {
-            value = originalType === "number" ? value : `"${value}"`;
-        }
-        return value;
-    }
-    buildSearchQuery() {
-        const builder = this;
-        let allOr = this.query && this.query.allOr;
-        let query = allOr ? "" : "*:*";
-        const allPreProcessingOpts = { escape: true, lowercase: true, wrap: true };
-        let tableId;
-        if (this.query.equal.tableId) {
-            tableId = this.query.equal.tableId;
-            delete this.query.equal.tableId;
-        }
-        const equal = (key, value) => {
-            // 0 evaluates to false, which means we would return all rows if we don't check it
-            if (!value && value !== 0) {
-                return null;
-            }
-            return `${key}:${builder.preprocess(value, allPreProcessingOpts)}`;
-        };
-        const contains = (key, value, mode = "AND") => {
-            if (Array.isArray(value) && value.length === 0) {
-                return null;
-            }
-            if (!Array.isArray(value)) {
-                return `${key}:${value}`;
-            }
-            let statement = `${builder.preprocess(value[0], { escape: true })}`;
-            for (let i = 1; i < value.length; i++) {
-                statement += ` ${mode} ${builder.preprocess(value[i], {
-                    escape: true,
-                })}`;
-            }
-            return `${key}:(${statement})`;
-        };
-        const notContains = (key, value) => {
-            // @ts-ignore
-            const allPrefix = allOr === "" ? "*:* AND" : "";
-            return allPrefix + "NOT " + contains(key, value);
-        };
-        const containsAny = (key, value) => {
-            return contains(key, value, "OR");
-        };
-        const oneOf = (key, value) => {
-            if (!Array.isArray(value)) {
-                if (typeof value === "string") {
-                    value = value.split(",");
-                }
-                else {
-                    return "";
-                }
-            }
-            let orStatement = `${builder.preprocess(value[0], allPreProcessingOpts)}`;
-            for (let i = 1; i < value.length; i++) {
-                orStatement += ` OR ${builder.preprocess(value[i], allPreProcessingOpts)}`;
-            }
-            return `${key}:(${orStatement})`;
-        };
-        function build(structure, queryFn) {
-            for (let [key, value] of Object.entries(structure)) {
-                // check for new format - remove numbering if needed
-                key = (0, utils_2.removeKeyNumbering)(key);
-                key = builder.preprocess(key.replace(/ /g, "_"), {
-                    escape: true,
-                });
-                const expression = queryFn(key, value);
-                if (expression == null) {
-                    continue;
-                }
-                if (query.length > 0) {
-                    query += ` ${allOr ? "OR" : "AND"} `;
-                }
-                query += expression;
-            }
-        }
-        // Construct the actual lucene search query string from JSON structure
-        if (this.query.string) {
-            build(this.query.string, (key, value) => {
-                if (!value) {
-                    return null;
-                }
-                value = builder.preprocess(value, {
-                    escape: true,
-                    lowercase: true,
-                    type: "string",
-                });
-                return `${key}:${value}*`;
-            });
-        }
-        if (this.query.range) {
-            build(this.query.range, (key, value) => {
-                if (!value) {
-                    return null;
-                }
-                if (value.low == null || value.low === "") {
-                    return null;
-                }
-                if (value.high == null || value.high === "") {
-                    return null;
-                }
-                const low = builder.preprocess(value.low, allPreProcessingOpts);
-                const high = builder.preprocess(value.high, allPreProcessingOpts);
-                return `${key}:[${low} TO ${high}]`;
-            });
-        }
-        if (this.query.fuzzy) {
-            build(this.query.fuzzy, (key, value) => {
-                if (!value) {
-                    return null;
-                }
-                value = builder.preprocess(value, {
-                    escape: true,
-                    lowercase: true,
-                    type: "fuzzy",
-                });
-                return `${key}:${value}~`;
-            });
-        }
-        if (this.query.equal) {
-            build(this.query.equal, equal);
-        }
-        if (this.query.notEqual) {
-            build(this.query.notEqual, (key, value) => {
-                if (!value) {
-                    return null;
-                }
-                return `!${key}:${builder.preprocess(value, allPreProcessingOpts)}`;
-            });
-        }
-        if (this.query.empty) {
-            build(this.query.empty, (key) => `!${key}:["" TO *]`);
-        }
-        if (this.query.notEmpty) {
-            build(this.query.notEmpty, (key) => `${key}:["" TO *]`);
-        }
-        if (this.query.oneOf) {
-            build(this.query.oneOf, oneOf);
-        }
-        if (this.query.contains) {
-            build(this.query.contains, contains);
-        }
-        if (this.query.notContains) {
-            build(this.query.notContains, notContains);
-        }
-        if (this.query.containsAny) {
-            build(this.query.containsAny, containsAny);
-        }
-        // make sure table ID is always added as an AND
-        if (tableId) {
-            query = `(${query})`;
-            allOr = false;
-            build({ tableId }, equal);
-        }
-        return query;
-    }
-    buildSearchBody() {
-        let body = {
-            q: this.buildSearchQuery(),
-            limit: Math.min(this.limit, 200),
-            include_docs: this.includeDocs,
-        };
-        if (this.bookmark) {
-            body.bookmark = this.bookmark;
-        }
-        if (this.sort) {
-            const order = this.sortOrder === "descending" ? "-" : "";
-            const type = `<${this.sortType}>`;
-            body.sort = `${order}${this.sort.replace(/ /g, "_")}${type}`;
-        }
-        return body;
-    }
-    run() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const appId = backend_core_1.context.getAppId();
-            const { url, cookie } = backend_core_1.db.getCouchInfo();
-            const fullPath = `${url}/${appId}/_design/database/_search/${utils_1.SearchIndexes.ROWS}`;
-            const body = this.buildSearchBody();
-            return yield runQuery(fullPath, body, cookie);
-        });
-    }
-}
-exports.QueryBuilder = QueryBuilder;
-/**
- * Executes a lucene search query.
- * @param url The query URL
- * @param body The request body defining search criteria
- * @param cookie The auth cookie for CouchDB
- * @returns {Promise<{rows: []}>}
- */
-const runQuery = (url, body, cookie) => __awaiter(void 0, void 0, void 0, function* () {
-    const response = yield (0, node_fetch_1.default)(url, {
-        body: JSON.stringify(body),
-        method: "POST",
-        headers: {
-            Authorization: cookie,
-        },
-    });
-    const json = yield response.json();
-    let output = {
-        rows: [],
-    };
-    if (json.rows != null && json.rows.length > 0) {
-        output.rows = json.rows.map((row) => row.doc);
-    }
-    if (json.bookmark) {
-        output.bookmark = json.bookmark;
-    }
-    return output;
-});
-/**
- * Gets round the fixed limit of 200 results from a query by fetching as many
- * pages as required and concatenating the results. This recursively operates
- * until enough results have been found.
- * @param query {object} The JSON query structure
- * @param params {object} The search params including:
- *   tableId {string} The table ID to search
- *   sort {string} The sort column
- *   sortOrder {string} The sort order ("ascending" or "descending")
- *   sortType {string} Whether to treat sortable values as strings or
- *     numbers. ("string" or "number")
- *   limit {number} The number of results to fetch
- *   bookmark {string|null} Current bookmark in the recursive search
- *   rows {array|null} Current results in the recursive search
- * @returns {Promise<*[]|*>}
- */
-function recursiveSearch(query, params) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const bookmark = params.bookmark;
-        const rows = params.rows || [];
-        if (rows.length >= params.limit) {
-            return rows;
-        }
-        let pageSize = 200;
-        if (rows.length > params.limit - 200) {
-            pageSize = params.limit - rows.length;
-        }
-        const page = yield new QueryBuilder(query)
-            .setVersion(params.version)
-            .setTable(params.tableId)
-            .setBookmark(bookmark)
-            .setLimit(pageSize)
-            .setSort(params.sort)
-            .setSortOrder(params.sortOrder)
-            .setSortType(params.sortType)
-            .run();
-        if (!page.rows.length) {
-            return rows;
-        }
-        if (page.rows.length < 200) {
-            return [...rows, ...page.rows];
-        }
-        const newParams = Object.assign(Object.assign({}, params), { bookmark: page.bookmark, rows: [...rows, ...page.rows] });
-        return yield recursiveSearch(query, newParams);
-    });
-}
-/**
- * Performs a paginated search. A bookmark will be returned to allow the next
- * page to be fetched. There is a max limit off 200 results per page in a
- * paginated search.
- * @param query {object} The JSON query structure
- * @param params {object} The search params including:
- *   tableId {string} The table ID to search
- *   sort {string} The sort column
- *   sortOrder {string} The sort order ("ascending" or "descending")
- *   sortType {string} Whether to treat sortable values as strings or
- *     numbers. ("string" or "number")
- *   limit {number} The desired page size
- *   bookmark {string} The bookmark to resume from
- * @returns {Promise<{hasNextPage: boolean, rows: *[]}>}
- */
+const types_1 = require("@budibase/types");
 function paginatedSearch(query, params) {
     return __awaiter(this, void 0, void 0, function* () {
-        let limit = params.limit;
-        if (limit == null || isNaN(limit) || limit < 0) {
-            limit = 50;
-        }
-        limit = Math.min(limit, 200);
-        const search = new QueryBuilder(query)
-            .setVersion(params.version)
-            .setTable(params.tableId)
-            .setSort(params.sort)
-            .setSortOrder(params.sortOrder)
-            .setSortType(params.sortType);
-        const searchResults = yield search
-            .setBookmark(params.bookmark)
-            .setLimit(limit)
-            .run();
-        // Try fetching 1 row in the next page to see if another page of results
-        // exists or not
-        const nextResults = yield search
-            .setTable(params.tableId)
-            .setBookmark(searchResults.bookmark)
-            .setLimit(1)
-            .run();
-        return Object.assign(Object.assign({}, searchResults), { hasNextPage: nextResults.rows && nextResults.rows.length > 0 });
+        const appId = backend_core_1.context.getAppId();
+        return backend_core_1.db.paginatedSearch(appId, types_1.SearchIndex.ROWS, query, params);
     });
 }
 exports.paginatedSearch = paginatedSearch;
-/**
- * Performs a full search, fetching multiple pages if required to return the
- * desired amount of results. There is a limit of 1000 results to avoid
- * heavy performance hits, and to avoid client components breaking from
- * handling too much data.
- * @param query {object} The JSON query structure
- * @param params {object} The search params including:
- *   tableId {string} The table ID to search
- *   sort {string} The sort column
- *   sortOrder {string} The sort order ("ascending" or "descending")
- *   sortType {string} Whether to treat sortable values as strings or
- *     numbers. ("string" or "number")
- *   limit {number} The desired number of results
- * @returns {Promise<{rows: *}>}
- */
 function fullSearch(query, params) {
     return __awaiter(this, void 0, void 0, function* () {
-        let limit = params.limit;
-        if (limit == null || isNaN(limit) || limit < 0) {
-            limit = 1000;
-        }
-        params.limit = Math.min(limit, 1000);
-        const rows = yield recursiveSearch(query, params);
-        return { rows };
+        const appId = backend_core_1.context.getAppId();
+        return backend_core_1.db.fullSearch(appId, types_1.SearchIndex.ROWS, query, params);
     });
 }
 exports.fullSearch = fullSearch;

package/dist/api/controllers/row/utils.js

@@ -35,14 +35,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.cleanExportRows = exports.validate = exports.findRow = exports.getDatasourceAndQuery = exports.removeKeyNumbering = void 0;
+exports.cleanExportRows = exports.validate = exports.findRow = exports.getDatasourceAndQuery = void 0;
 const utils_1 = require("../../../db/utils");
 const userController = __importStar(require("../user"));
 const constants_1 = require("../../../constants");
 const backend_core_1 = require("@budibase/backend-core");
 const query_1 = require("../../../integrations/base/query");
-var utils_2 = require("../../../integrations/base/utils");
-Object.defineProperty(exports, "removeKeyNumbering", { enumerable: true, get: function () { return utils_2.removeKeyNumbering; } });
 const validateJs = require("validate.js");
 const { cloneDeep } = require("lodash/fp");
 const exporters_1 = require("../view/exporters");

package/dist/api/controllers/table/external.js

@@ -75,12 +75,12 @@ function getDatasourceId(table) {
     return (0, utils_1.breakExternalTableId)(table._id).datasourceId;
 }
 function otherRelationshipType(type) {
-    if (type === constants_1.RelationshipTypes.MANY_TO_MANY) {
-        return constants_1.RelationshipTypes.MANY_TO_MANY;
+    if (type === types_1.RelationshipTypes.MANY_TO_MANY) {
+        return types_1.RelationshipTypes.MANY_TO_MANY;
     }
-    return type === constants_1.RelationshipTypes.ONE_TO_MANY
-        ? constants_1.RelationshipTypes.MANY_TO_ONE
-        : constants_1.RelationshipTypes.ONE_TO_MANY;
+    return type === types_1.RelationshipTypes.ONE_TO_MANY
+        ? types_1.RelationshipTypes.MANY_TO_ONE
+        : types_1.RelationshipTypes.ONE_TO_MANY;
 }
 function generateManyLinkSchema(datasource, column, table, relatedTable) {
     if (!table.primary || !relatedTable.primary) {
@@ -116,7 +116,7 @@ function generateLinkSchema(column, table, relatedTable, type) {
     if (!table.primary || !relatedTable.primary) {
         throw new Error("Unable to generate link schema, no primary keys");
     }
-    const isOneSide = type === constants_1.RelationshipTypes.ONE_TO_MANY;
+    const isOneSide = type === types_1.RelationshipTypes.ONE_TO_MANY;
     const primary = isOneSide ? relatedTable.primary[0] : table.primary[0];
     // generate a foreign key
     const foreignKey = (0, utils_2.generateForeignKey)(column, relatedTable);
@@ -186,7 +186,7 @@ function save(ctx) {
             }
             const relatedColumnName = schema.fieldName;
             const relationType = schema.relationshipType;
-            if (relationType === constants_1.RelationshipTypes.MANY_TO_MANY) {
+            if (relationType === types_1.RelationshipTypes.MANY_TO_MANY) {
                 const junctionTable = generateManyLinkSchema(datasource, schema, table, relatedTable);
                 if (tables[junctionTable.name]) {
                     throw "Junction table already exists, cannot create another relationship.";
@@ -195,7 +195,7 @@ function save(ctx) {
                 extraTablesToUpdate.push(junctionTable);
             }
             else {
-                const fkTable = relationType === constants_1.RelationshipTypes.ONE_TO_MANY ? table : relatedTable;
+                const fkTable = relationType === types_1.RelationshipTypes.ONE_TO_MANY ? table : relatedTable;
                 const foreignKey = generateLinkSchema(schema, table, relatedTable, relationType);
                 fkTable.schema[foreignKey] = (0, utils_2.foreignKeyStructure)(foreignKey);
                 if (fkTable.constrained == null) {

package/dist/api/index.js

@@ -27,6 +27,7 @@ const compress = require("koa-compress");
 exports.router = new router_1.default();
 exports.router.get("/health", ctx => (ctx.status = 200));
 exports.router.get("/version", ctx => (ctx.body = package_json_1.default.version));
+exports.router.use(backend_core_1.middleware.errorHandling);
 exports.router
     .use(compress({
     threshold: 2048,
@@ -60,27 +61,6 @@ exports.router
     // @ts-ignore
     .use(currentapp_1.default)
     .use(backend_core_1.auth.auditLog);
-// error handling middleware
-exports.router.use((ctx, next) => __awaiter(void 0, void 0, void 0, function* () {
-    try {
-        yield next();
-    }
-    catch (err) {
-        ctx.status = err.status || err.statusCode || 500;
-        const error = backend_core_1.errors.getPublicError(err);
-        ctx.body = {
-            message: err.message,
-            status: ctx.status,
-            validationErrors: err.validation,
-            error,
-        };
-        ctx.log.error(err);
-        // unauthorised errors don't provide a useful trace
-        if (!environment_1.default.isTest()) {
-            console.trace(err);
-        }
-    }
-}));
 // authenticated routes
 for (let route of routes_1.mainRoutes) {
     exports.router.use(route.routes());

package/dist/api/routes/automation.js

@@ -40,7 +40,7 @@ router
     .get("/api/automations/definitions/list", (0, authorized_1.default)(backend_core_1.permissions.BUILDER), controller.getDefinitionList)
     .get("/api/automations", (0, authorized_1.default)(backend_core_1.permissions.BUILDER), controller.fetch)
     .get("/api/automations/:id", (0, resourceId_1.paramResource)("id"), (0, authorized_1.default)(backend_core_1.permissions.BUILDER), controller.find)
-    .put("/api/automations", (0, resourceId_1.bodyResource)("_id"), (0, authorized_1.default)(backend_core_1.permissions.BUILDER), (0, validators_1.automationValidator)(true), controller.update)
+    .put("/api/automations", (0, resourceId_1.bodyResource)("_id"), (0, authorized_1.default)(backend_core_1.permissions.BUILDER), (0, validators_1.automationValidator)(false), controller.update)
     .post("/api/automations", (0, authorized_1.default)(backend_core_1.permissions.BUILDER), (0, validators_1.automationValidator)(false), controller.create)
     .post("/api/automations/logs/search", (0, authorized_1.default)(backend_core_1.permissions.BUILDER), controller.logSearch)
     .delete("/api/automations/logs", (0, authorized_1.default)(backend_core_1.permissions.BUILDER), controller.clearLogError)

package/dist/api/routes/public/applications.js

@@ -11,7 +11,7 @@ const read = [], write = [];
  * @openapi
  * /applications:
  *   post:
- *     operationId: create
+ *     operationId: appCreate
  *     summary: Create an application
  *     tags:
  *       - applications
@@ -39,7 +39,7 @@ write.push(new Endpoint_1.default("post", "/applications", applications_1.defaul
  * @openapi
  * /applications/{appId}:
  *   put:
- *     operationId: update
+ *     operationId: appUpdate
  *     summary: Update an application
  *     tags:
  *       - applications
@@ -67,7 +67,7 @@ write.push(new Endpoint_1.default("put", "/applications/:appId", applications_1.
  * @openapi
  * /applications/{appId}:
  *   delete:
- *     operationId: destroy
+ *     operationId: appDestroy
  *     summary: Delete an application
  *     tags:
  *       - applications
@@ -89,7 +89,7 @@ write.push(new Endpoint_1.default("delete", "/applications/:appId", applications
  * @openapi
  * /applications/{appId}/unpublish:
  *   post:
- *     operationId: unpublish
+ *     operationId: appUnpublish
  *     summary: Unpublish an application
  *     tags:
  *       - applications
@@ -104,7 +104,7 @@ write.push(new Endpoint_1.default("post", "/applications/:appId/unpublish", appl
  * @openapi
  * /applications/{appId}/publish:
  *   post:
- *     operationId: publish
+ *     operationId: appPublish
  *     summary: Unpublish an application
  *     tags:
  *       - applications
@@ -126,7 +126,7 @@ write.push(new Endpoint_1.default("post", "/applications/:appId/publish", applic
  * @openapi
  * /applications/{appId}:
  *   get:
- *     operationId: getById
+ *     operationId: appGetById
  *     summary: Retrieve an application
  *     tags:
  *       - applications
@@ -148,7 +148,7 @@ read.push(new Endpoint_1.default("get", "/applications/:appId", applications_1.d
  * @openapi
  * /applications/search:
  *   post:
- *     operationId: search
+ *     operationId: appSearch
  *     summary: Search for applications
  *     description: Based on application properties (currently only name) search for applications.
  *     tags:

package/dist/api/routes/public/queries.js

@@ -11,7 +11,7 @@ const read = [], write = [];
  * @openapi
  * /queries/{queryId}:
  *   post:
- *     operationId: execute
+ *     operationId: queryExecute
  *     summary: Execute a query
  *     description: Queries which have been created within a Budibase app can be executed using this,
  *     tags:
@@ -44,7 +44,7 @@ write.push(new Endpoint_1.default("post", "/queries/:queryId", queries_1.default
  * @openapi
  * /queries/search:
  *   post:
- *     operationId: search
+ *     operationId: querySearch
  *     summary: Search for queries
  *     description: Based on query properties (currently only name) search for queries.
  *     tags: