From 6a6fdbb8ffe7dac14f6c2bfc73ea185845be04d5 Mon Sep 17 00:00:00 2001 From: mike12345567 Date: Mon, 24 Jan 2022 17:06:45 +0000 Subject: [PATCH] Refactoring bulk table formula work a bit. --- .../src/api/controllers/table/bulkFormula.js | 89 +++++++++++++++++++ .../src/api/controllers/table/internal.js | 82 +---------------- 2 files changed, 93 insertions(+), 78 deletions(-) create mode 100644 packages/server/src/api/controllers/table/bulkFormula.js diff --git a/packages/server/src/api/controllers/table/bulkFormula.js b/packages/server/src/api/controllers/table/bulkFormula.js new file mode 100644 index 0000000000..c1dcaf532b --- /dev/null +++ b/packages/server/src/api/controllers/table/bulkFormula.js @@ -0,0 +1,89 @@ +const { FieldTypes, FormulaTypes } = require("../../../constants") +const { getAllInternalTables } = require("./utils") +const { doesContainString } = require("@budibase/string-templates") +const { cloneDeep } = require("lodash/fp") +const { isEqual } = require("lodash") + +/** + * This retrieves the formula columns from a table schema that use a specified column name + * in the formula. + */ +function getFormulaThatUseColumn(table, columnName) { + let formula = [] + for (let column of Object.values(table.schema)) { + // not a static formula, or doesn't contain a relationship + if ( + column.type !== FieldTypes.FORMULA || + column.formulaType !== FormulaTypes.STATIC + ) { + continue + } + if (!doesContainString(column.formula, columnName)) { + continue + } + formula.push(column.name) + } + return formula +} + +/** + * This function adds a note to related tables that they are + * used in a static formula - so that the link controller + * can manage hydrating related rows formula fields. This is + * specifically only for static formula. + */ +exports.updateRelatedFormulaLinksOnTables = async ( + db, + table, + { deletion } = { deletion: false } +) => { + // start by retrieving all tables, remove the current table from the list + const tables = (await getAllInternalTables({ db })).filter( + tbl => tbl._id !== table._id + ) + // clone the tables, so we can compare at end + const initialTables = cloneDeep(tables) + // first find the related column names + const relatedColumns = Object.values(table.schema).filter( + col => col.type === FieldTypes.LINK + ) + // we start by removing the formula field from all tables + for (let otherTable of tables) { + if (!otherTable.relatedFormula) { + continue + } + const index = otherTable.relatedFormula.indexOf(table._id) + if (index !== -1) { + otherTable.relatedFormula.splice(index, 1) + } + } + // if deleting, just remove the table IDs, don't try add + if (!deletion) { + for (let relatedCol of relatedColumns) { + let columns = getFormulaThatUseColumn(table, relatedCol.name) + if (!columns || columns.length === 0) { + continue + } + const relatedTable = tables.find( + related => related._id === relatedCol.tableId + ) + // check if the table is already in the list of related formula, if it isn't, then add it + if ( + relatedTable && + (!relatedTable.relatedFormula || + relatedTable.relatedFormula.includes(table._id)) + ) { + relatedTable.relatedFormula = relatedTable.relatedFormula + ? [...relatedTable.relatedFormula, table._id] + : [table._id] + } + } + } + // now we just need to compare all the tables and see if any need saved + for (let initial of initialTables) { + const found = tables.find(tbl => initial._id === tbl._id) + if (found && !isEqual(initial, found)) { + await db.put(found) + } + } +} diff --git a/packages/server/src/api/controllers/table/internal.js b/packages/server/src/api/controllers/table/internal.js index e56555e151..88a0a5f442 100644 --- a/packages/server/src/api/controllers/table/internal.js +++ b/packages/server/src/api/controllers/table/internal.js @@ -1,90 +1,16 @@ const CouchDB = require("../../../db") const linkRows = require("../../../db/linkedRows") const { getRowParams, generateTableID } = require("../../../db/utils") -const { FieldTypes, FormulaTypes } = require("../../../constants") +const { FieldTypes } = require("../../../constants") const { TableSaveFunctions, hasTypeChanged, getTable, handleDataImport, - getAllInternalTables, } = require("./utils") const usageQuota = require("../../../utilities/usageQuota") -const { doesContainString } = require("@budibase/string-templates") -const { cloneDeep } = require("lodash/fp") -const { isEqual } = require("lodash") const { cleanupAttachments } = require("../../../utilities/rowProcessor") - -/** - * This function adds a note to related tables that they are - * used in a static formula - so that the link controller - * can manage hydrating related rows formula fields. This is - * specifically only for static formula. - */ -async function updateRelatedTablesForFormula( - db, - table, - { deletion } = { deletion: false } -) { - // start by retrieving all tables, remove the current table from the list - const tables = (await getAllInternalTables({ db })).filter( - tbl => tbl._id !== table._id - ) - // clone the tables, so we can compare at end - const initialTables = cloneDeep(tables) - // first find the related column names - const relatedColumns = Object.values(table.schema).filter( - col => col.type === FieldTypes.LINK - ) - // we start by removing the formula field from all tables - for (let otherTable of tables) { - if (!otherTable.relatedFormula) { - continue - } - const index = otherTable.relatedFormula.indexOf(table._id) - if (index !== -1) { - otherTable.relatedFormula.splice(index, 1) - } - } - // if deleting, just remove the table IDs, don't try add - if (!deletion) { - for (let column of Object.values(table.schema)) { - // not a static formula, or doesn't contain a relationship - if ( - column.type !== FieldTypes.FORMULA || - column.formulaType !== FormulaTypes.STATIC - ) { - continue - } - // check to see if any relationship columns are used in formula - for (let relatedCol of relatedColumns) { - if (!doesContainString(column.formula, relatedCol.name)) { - continue - } - const relatedTable = tables.find( - related => related._id === relatedCol.tableId - ) - // check if the table is already in the list of related formula, if it isn't, then add it - if ( - relatedTable && - (!relatedTable.relatedFormula || - relatedTable.relatedFormula.includes(table._id)) - ) { - relatedTable.relatedFormula = relatedTable.relatedFormula - ? [...relatedTable.relatedFormula, table._id] - : [table._id] - } - } - } - } - // now we just need to compare all the tables and see if any need saved - for (let initial of initialTables) { - const found = tables.find(tbl => initial._id === tbl._id) - if (found && !isEqual(initial, found)) { - await db.put(found) - } - } -} +const { updateRelatedFormulaLinksOnTables } = require("./bulkFormula") exports.save = async function (ctx) { const appId = ctx.appId @@ -181,7 +107,7 @@ exports.save = async function (ctx) { tableToSave = await tableSaveFunctions.after(tableToSave) // has to run after, make sure it has _id - await updateRelatedTablesForFormula(db, tableToSave) + await updateRelatedFormulaLinksOnTables(db, tableToSave) return tableToSave } @@ -220,7 +146,7 @@ exports.destroy = async function (ctx) { } // has to run after, make sure it has _id - await updateRelatedTablesForFormula(db, tableToDelete, { deletion: true }) + await updateRelatedFormulaLinksOnTables(db, tableToDelete, { deletion: true }) await cleanupAttachments(appId, tableToDelete, { rows }) return tableToDelete }