@budibase/server 0.0.32 → 0.0.999-alpha.30

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

@@ -0,0 +1,502 @@
+"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 __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchEnrichedRow = exports.exportRows = exports.search = exports.bulkDestroy = exports.destroy = exports.find = exports.fetch = exports.fetchView = exports.save = exports.patch = void 0;
+const linkRows = __importStar(require("../../../db/linkedRows"));
+const utils_1 = require("../../../db/utils");
+const userController = __importStar(require("../user"));
+const rowProcessor_1 = require("../../../utilities/rowProcessor");
+const constants_1 = require("../../../constants");
+const utils = __importStar(require("./utils"));
+const internalSearch_1 = require("./internalSearch");
+const global_1 = require("../../../utilities/global");
+const inMemoryViews = __importStar(require("../../../db/inMemoryView"));
+const environment_1 = __importDefault(require("../../../environment"));
+const utils_2 = require("../view/utils");
+const fp_1 = require("lodash/fp");
+const backend_core_1 = require("@budibase/backend-core");
+const staticFormula_1 = require("./staticFormula");
+const exporters_1 = require("../view/exporters");
+const fileSystem_1 = require("../../../utilities/fileSystem");
+const { cleanExportRows } = require("./utils");
+const CALCULATION_TYPES = {
+    SUM: "sum",
+    COUNT: "count",
+    STATS: "stats",
+};
+function getView(db, viewName) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let mainGetter = environment_1.default.SELF_HOSTED ? utils_2.getFromDesignDoc : utils_2.getFromMemoryDoc;
+        let secondaryGetter = environment_1.default.SELF_HOSTED ? utils_2.getFromMemoryDoc : utils_2.getFromDesignDoc;
+        let migration = environment_1.default.SELF_HOSTED ? utils_2.migrateToDesignView : utils_2.migrateToInMemoryView;
+        let viewInfo, migrate = false;
+        try {
+            viewInfo = yield mainGetter(db, viewName);
+        }
+        catch (err) {
+            // check if it can be retrieved from design doc (needs migrated)
+            if (err.status !== 404) {
+                viewInfo = null;
+            }
+            else {
+                viewInfo = yield secondaryGetter(db, viewName);
+                migrate = !!viewInfo;
+            }
+        }
+        if (migrate) {
+            yield migration(db, viewName);
+        }
+        if (!viewInfo) {
+            throw "View does not exist.";
+        }
+        return viewInfo;
+    });
+}
+function getRawTableData(ctx, db, tableId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let rows;
+        if (tableId === utils_1.InternalTables.USER_METADATA) {
+            yield userController.fetchMetadata(ctx);
+            rows = ctx.body;
+        }
+        else {
+            const response = yield db.allDocs((0, utils_1.getRowParams)(tableId, null, {
+                include_docs: true,
+            }));
+            rows = response.rows.map(row => row.doc);
+        }
+        return rows;
+    });
+}
+function patch(ctx) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const db = backend_core_1.context.getAppDB();
+        const inputs = ctx.request.body;
+        const tableId = inputs.tableId;
+        const isUserTable = tableId === utils_1.InternalTables.USER_METADATA;
+        let oldRow;
+        try {
+            let dbTable = yield db.get(tableId);
+            oldRow = yield (0, rowProcessor_1.outputProcessing)(dbTable, yield utils.findRow(ctx, tableId, inputs._id));
+        }
+        catch (err) {
+            if (isUserTable) {
+                // don't include the rev, it'll be the global rev
+                // this time
+                oldRow = {
+                    _id: inputs._id,
+                };
+            }
+            else {
+                throw "Row does not exist";
+            }
+        }
+        let dbTable = yield db.get(tableId);
+        // need to build up full patch fields before coerce
+        let combinedRow = (0, fp_1.cloneDeep)(oldRow);
+        for (let key of Object.keys(inputs)) {
+            if (!dbTable.schema[key])
+                continue;
+            combinedRow[key] = inputs[key];
+        }
+        // this returns the table and row incase they have been updated
+        let { table, row } = (0, rowProcessor_1.inputProcessing)(ctx.user, dbTable, combinedRow);
+        const validateResult = yield utils.validate({
+            row,
+            table,
+        });
+        if (!validateResult.valid) {
+            ctx.throw(400, { validation: validateResult.errors });
+        }
+        // returned row is cleaned and prepared for writing to DB
+        row = (yield linkRows.updateLinks({
+            eventType: linkRows.EventType.ROW_UPDATE,
+            row,
+            tableId: row.tableId,
+            table,
+        }));
+        // check if any attachments removed
+        yield (0, rowProcessor_1.cleanupAttachments)(table, { oldRow, row });
+        if (isUserTable) {
+            // the row has been updated, need to put it into the ctx
+            ctx.request.body = row;
+            yield userController.updateMetadata(ctx);
+            return { row: ctx.body, table };
+        }
+        return (0, staticFormula_1.finaliseRow)(table, row, {
+            oldTable: dbTable,
+            updateFormula: true,
+        });
+    });
+}
+exports.patch = patch;
+function save(ctx) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const db = backend_core_1.context.getAppDB();
+        let inputs = ctx.request.body;
+        inputs.tableId = ctx.params.tableId;
+        if (!inputs._rev && !inputs._id) {
+            inputs._id = (0, utils_1.generateRowID)(inputs.tableId);
+        }
+        // this returns the table and row incase they have been updated
+        const dbTable = yield db.get(inputs.tableId);
+        let { table, row } = (0, rowProcessor_1.inputProcessing)(ctx.user, dbTable, inputs);
+        const validateResult = yield utils.validate({
+            row,
+            table,
+        });
+        if (!validateResult.valid) {
+            throw { validation: validateResult.errors };
+        }
+        // make sure link rows are up to date
+        row = (yield linkRows.updateLinks({
+            eventType: linkRows.EventType.ROW_SAVE,
+            row,
+            tableId: row.tableId,
+            table,
+        }));
+        return (0, staticFormula_1.finaliseRow)(table, row, {
+            oldTable: dbTable,
+            updateFormula: true,
+        });
+    });
+}
+exports.save = save;
+function fetchView(ctx) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const viewName = decodeURIComponent(ctx.params.viewName);
+        // if this is a table view being looked for just transfer to that
+        if (viewName.startsWith(utils_1.DocumentType.TABLE)) {
+            ctx.params.tableId = viewName;
+            return fetch(ctx);
+        }
+        const db = backend_core_1.context.getAppDB();
+        const { calculation, group, field } = ctx.query;
+        const viewInfo = yield getView(db, viewName);
+        let response;
+        if (environment_1.default.SELF_HOSTED) {
+            response = yield db.query(`database/${viewName}`, {
+                include_docs: !calculation,
+                group: !!group,
+            });
+        }
+        else {
+            const tableId = viewInfo.meta.tableId;
+            const data = yield getRawTableData(ctx, db, tableId);
+            response = yield inMemoryViews.runView(viewInfo, calculation, !!group, data);
+        }
+        let rows;
+        if (!calculation) {
+            response.rows = response.rows.map(row => row.doc);
+            let table;
+            try {
+                table = yield db.get(viewInfo.meta.tableId);
+            }
+            catch (err) {
+                /* istanbul ignore next */
+                table = {
+                    schema: {},
+                };
+            }
+            rows = yield (0, rowProcessor_1.outputProcessing)(table, response.rows);
+        }
+        if (calculation === CALCULATION_TYPES.STATS) {
+            response.rows = response.rows.map(row => (Object.assign(Object.assign({ group: row.key, field }, row.value), { avg: row.value.sum / row.value.count })));
+            rows = response.rows;
+        }
+        if (calculation === CALCULATION_TYPES.COUNT ||
+            calculation === CALCULATION_TYPES.SUM) {
+            rows = response.rows.map(row => ({
+                group: row.key,
+                field,
+                value: row.value,
+            }));
+        }
+        return rows;
+    });
+}
+exports.fetchView = fetchView;
+function fetch(ctx) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const db = backend_core_1.context.getAppDB();
+        const tableId = ctx.params.tableId;
+        let table = yield db.get(tableId);
+        let rows = yield getRawTableData(ctx, db, tableId);
+        return (0, rowProcessor_1.outputProcessing)(table, rows);
+    });
+}
+exports.fetch = fetch;
+function find(ctx) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const db = backend_core_1.db.getDB(ctx.appId);
+        const table = yield db.get(ctx.params.tableId);
+        let row = yield utils.findRow(ctx, ctx.params.tableId, ctx.params.rowId);
+        row = yield (0, rowProcessor_1.outputProcessing)(table, row);
+        return row;
+    });
+}
+exports.find = find;
+function destroy(ctx) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const db = backend_core_1.context.getAppDB();
+        const { _id } = ctx.request.body;
+        let row = yield db.get(_id);
+        let _rev = ctx.request.body._rev || row._rev;
+        if (row.tableId !== ctx.params.tableId) {
+            throw "Supplied tableId doesn't match the row's tableId";
+        }
+        const table = yield db.get(row.tableId);
+        // update the row to include full relationships before deleting them
+        row = yield (0, rowProcessor_1.outputProcessing)(table, row, { squash: false });
+        // now remove the relationships
+        yield linkRows.updateLinks({
+            eventType: linkRows.EventType.ROW_DELETE,
+            row,
+            tableId: row.tableId,
+        });
+        // remove any attachments that were on the row from object storage
+        yield (0, rowProcessor_1.cleanupAttachments)(table, { row });
+        // remove any static formula
+        yield (0, staticFormula_1.updateRelatedFormula)(table, row);
+        let response;
+        if (ctx.params.tableId === utils_1.InternalTables.USER_METADATA) {
+            ctx.params = {
+                id: _id,
+            };
+            yield userController.destroyMetadata(ctx);
+            response = ctx.body;
+        }
+        else {
+            response = yield db.remove(_id, _rev);
+        }
+        return { response, row };
+    });
+}
+exports.destroy = destroy;
+function bulkDestroy(ctx) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const db = backend_core_1.context.getAppDB();
+        const tableId = ctx.params.tableId;
+        const table = yield db.get(tableId);
+        let { rows } = ctx.request.body;
+        // before carrying out any updates, make sure the rows are ready to be returned
+        // they need to be the full rows (including previous relationships) for automations
+        const processedRows = (yield (0, rowProcessor_1.outputProcessing)(table, rows, {
+            squash: false,
+        }));
+        // remove the relationships first
+        let updates = processedRows.map(row => linkRows.updateLinks({
+            eventType: linkRows.EventType.ROW_DELETE,
+            row,
+            tableId: row.tableId,
+        }));
+        if (tableId === utils_1.InternalTables.USER_METADATA) {
+            updates = updates.concat(processedRows.map(row => {
+                ctx.params = {
+                    id: row._id,
+                };
+                return userController.destroyMetadata(ctx);
+            }));
+        }
+        else {
+            yield db.bulkDocs(processedRows.map(row => (Object.assign(Object.assign({}, row), { _deleted: true }))));
+        }
+        // remove any attachments that were on the rows from object storage
+        yield (0, rowProcessor_1.cleanupAttachments)(table, { rows: processedRows });
+        yield (0, staticFormula_1.updateRelatedFormula)(table, processedRows);
+        yield Promise.all(updates);
+        return { response: { ok: true }, rows: processedRows };
+    });
+}
+exports.bulkDestroy = bulkDestroy;
+function search(ctx) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // Fetch the whole table when running in cypress, as search doesn't work
+        if (!environment_1.default.COUCH_DB_URL && environment_1.default.isCypress()) {
+            return { rows: yield fetch(ctx) };
+        }
+        const { tableId } = ctx.params;
+        const db = backend_core_1.context.getAppDB();
+        const _a = ctx.request.body, { paginate, query } = _a, params = __rest(_a, ["paginate", "query"]);
+        params.version = ctx.version;
+        params.tableId = tableId;
+        let table;
+        if (params.sort && !params.sortType) {
+            table = yield db.get(tableId);
+            const schema = table.schema;
+            const sortField = schema[params.sort];
+            params.sortType = sortField.type == "number" ? "number" : "string";
+        }
+        let response;
+        if (paginate) {
+            response = yield (0, internalSearch_1.paginatedSearch)(query, params);
+        }
+        else {
+            response = yield (0, internalSearch_1.fullSearch)(query, params);
+        }
+        // Enrich search results with relationships
+        if (response.rows && response.rows.length) {
+            // enrich with global users if from users table
+            if (tableId === utils_1.InternalTables.USER_METADATA) {
+                response.rows = yield (0, global_1.getGlobalUsersFromMetadata)(response.rows);
+            }
+            table = table || (yield db.get(tableId));
+            response.rows = yield (0, rowProcessor_1.outputProcessing)(table, response.rows);
+        }
+        return response;
+    });
+}
+exports.search = search;
+function exportRows(ctx) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const db = backend_core_1.context.getAppDB();
+        const table = yield db.get(ctx.params.tableId);
+        const rowIds = ctx.request.body.rows;
+        let format = ctx.query.format;
+        const { columns, query } = ctx.request.body;
+        let result;
+        if (rowIds) {
+            let response = (yield db.allDocs({
+                include_docs: true,
+                keys: rowIds,
+            })).rows.map(row => row.doc);
+            result = yield (0, rowProcessor_1.outputProcessing)(table, response);
+        }
+        else if (query) {
+            let searchResponse = yield exports.search(ctx);
+            result = searchResponse.rows;
+        }
+        let rows = [];
+        let schema = table.schema;
+        // Filter data to only specified columns if required
+        if (columns && columns.length) {
+            for (let i = 0; i < result.length; i++) {
+                rows[i] = {};
+                for (let column of columns) {
+                    rows[i][column] = result[i][column];
+                }
+            }
+        }
+        else {
+            rows = result;
+        }
+        let exportRows = cleanExportRows(rows, schema, format, columns);
+        if (format === exporters_1.Format.CSV) {
+            ctx.attachment("export.csv");
+            return (0, fileSystem_1.apiFileReturn)((0, exporters_1.csv)(Object.keys(rows[0]), exportRows));
+        }
+        else if (format === exporters_1.Format.JSON) {
+            ctx.attachment("export.json");
+            return (0, fileSystem_1.apiFileReturn)((0, exporters_1.json)(exportRows));
+        }
+        else if (format === exporters_1.Format.JSON_WITH_SCHEMA) {
+            ctx.attachment("export.json");
+            return (0, fileSystem_1.apiFileReturn)((0, exporters_1.jsonWithSchema)(schema, exportRows));
+        }
+        else {
+            throw "Format not recognised";
+        }
+    });
+}
+exports.exportRows = exportRows;
+function fetchEnrichedRow(ctx) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const db = backend_core_1.context.getAppDB();
+        const tableId = ctx.params.tableId;
+        const rowId = ctx.params.rowId;
+        // need table to work out where links go in row
+        let [table, row] = yield Promise.all([
+            db.get(tableId),
+            utils.findRow(ctx, tableId, rowId),
+        ]);
+        // get the link docs
+        const linkVals = (yield linkRows.getLinkDocuments({
+            tableId,
+            rowId,
+        }));
+        // look up the actual rows based on the ids
+        let response = (yield db.allDocs({
+            include_docs: true,
+            keys: linkVals.map(linkVal => linkVal.id),
+        })).rows.map(row => row.doc);
+        // group responses by table
+        let groups = {}, tables = {};
+        for (let row of response) {
+            if (!row.tableId) {
+                row.tableId = (0, utils_1.getTableIDFromRowID)(row._id);
+            }
+            const linkedTableId = row.tableId;
+            if (groups[linkedTableId] == null) {
+                groups[linkedTableId] = [row];
+                tables[linkedTableId] = yield db.get(linkedTableId);
+            }
+            else {
+                groups[linkedTableId].push(row);
+            }
+        }
+        let linkedRows = [];
+        for (let [tableId, rows] of Object.entries(groups)) {
+            // need to include the IDs in these rows for any links they may have
+            linkedRows = linkedRows.concat(yield (0, rowProcessor_1.outputProcessing)(tables[tableId], rows));
+        }
+        // insert the link rows in the correct place throughout the main row
+        for (let fieldName of Object.keys(table.schema)) {
+            let field = table.schema[fieldName];
+            if (field.type === constants_1.FieldTypes.LINK) {
+                // find the links that pertain to this field, get their indexes
+                const linkIndexes = linkVals
+                    .filter(link => link.fieldName === fieldName)
+                    .map(link => linkVals.indexOf(link));
+                // find the rows that the links state are linked to this field
+                row[fieldName] = linkedRows.filter((linkRow, index) => linkIndexes.includes(index));
+            }
+        }
+        return row;
+    });
+}
+exports.fetchEnrichedRow = fetchEnrichedRow;

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

@@ -0,0 +1,28 @@
+"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.fullSearch = exports.paginatedSearch = void 0;
+const backend_core_1 = require("@budibase/backend-core");
+const types_1 = require("@budibase/types");
+function paginatedSearch(query, params) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const appId = backend_core_1.context.getAppId();
+        return backend_core_1.db.paginatedSearch(appId, types_1.SearchIndex.ROWS, query, params);
+    });
+}
+exports.paginatedSearch = paginatedSearch;
+function fullSearch(query, params) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const appId = backend_core_1.context.getAppId();
+        return backend_core_1.db.fullSearch(appId, types_1.SearchIndex.ROWS, query, params);
+    });
+}
+exports.fullSearch = fullSearch;