Moving some stuff around to make more testable.

This commit is contained in:
mike12345567 2023-01-06 12:47:12 +00:00
parent 7084989896
commit 6595e1c122
4 changed files with 98 additions and 65 deletions

View File

@ -4,22 +4,18 @@ import { getAutomationParams, TABLE_ROW_PREFIX } from "../../../db/utils"
import { budibaseTempDir } from "../../../utilities/budibaseDir" import { budibaseTempDir } from "../../../utilities/budibaseDir"
import { DB_EXPORT_FILE, GLOBAL_DB_EXPORT_FILE } from "./constants" import { DB_EXPORT_FILE, GLOBAL_DB_EXPORT_FILE } from "./constants"
import { downloadTemplate } from "../../../utilities/fileSystem" import { downloadTemplate } from "../../../utilities/fileSystem"
import { FieldTypes, ObjectStoreBuckets } from "../../../constants" import { ObjectStoreBuckets } from "../../../constants"
import { join } from "path" import { join } from "path"
import fs from "fs" import fs from "fs"
import sdk from "../../" import sdk from "../../"
import { import {
Automation, Automation,
AutomationTriggerStepId, AutomationTriggerStepId,
CouchFindOptions,
RowAttachment, RowAttachment,
} from "@budibase/types" } from "@budibase/types"
const uuid = require("uuid/v4") const uuid = require("uuid/v4")
const tar = require("tar") const tar = require("tar")
// default limit - seems to work well for performance
const FIND_LIMIT = 25
type TemplateType = { type TemplateType = {
file?: { file?: {
type: string type: string
@ -28,55 +24,7 @@ type TemplateType = {
key?: string key?: string
} }
function generateAttachmentFindParams( function rewriteAttachmentUrl(appId: string, attachment: RowAttachment) {
attachmentCols: string[],
bookmark: null | string
) {
const params: CouchFindOptions = {
selector: {
_id: {
$regex: `^${TABLE_ROW_PREFIX}`,
},
},
limit: FIND_LIMIT,
}
attachmentCols.forEach(col => (params.selector[col] = { $exists: true }))
if (bookmark) {
params.bookmark = bookmark
}
return params
}
async function updateAttachmentColumns(prodAppId: string, db: Database) {
// iterate through attachment documents and update them
const tables = await sdk.tables.getAllInternalTables(db)
let updatedRows: Row[] = []
for (let table of tables) {
const attachmentCols: string[] = []
for (let [key, column] of Object.entries(table.schema)) {
if (column.type === FieldTypes.ATTACHMENT) {
attachmentCols.push(key)
}
}
// no attachment columns, nothing to do
if (attachmentCols.length === 0) {
continue
}
let bookmark: null | string = null,
rowsLength = 0
do {
const params = generateAttachmentFindParams(attachmentCols, bookmark)
// use the CouchDB Mango query API to lookup rows that have attachments
const resp = await dbCore.directCouchFind(db.name, params)
bookmark = resp.bookmark
rowsLength = resp.rows.length
const rows = resp.rows
for (let row of rows) {
for (let column of attachmentCols) {
if (!Array.isArray(row[column])) {
continue
}
row[column] = row[column].map((attachment: RowAttachment) => {
// URL looks like: /prod-budi-app-assets/appId/attachments/file.csv // URL looks like: /prod-budi-app-assets/appId/attachments/file.csv
const urlParts = attachment.url.split("/") const urlParts = attachment.url.split("/")
// drop the first empty element // drop the first empty element
@ -86,18 +34,36 @@ async function updateAttachmentColumns(prodAppId: string, db: Database) {
// remove the app ID // remove the app ID
urlParts.shift() urlParts.shift()
// add new app ID // add new app ID
urlParts.unshift(prodAppId) urlParts.unshift(appId)
const key = urlParts.join("/") const key = urlParts.join("/")
return { return {
...attachment, ...attachment,
key, key,
url: `/${prefix}/${key}`, url: `/${prefix}/${key}`,
} }
}
async function updateAttachmentColumns(prodAppId: string, db: Database) {
// iterate through attachment documents and update them
const tables = await sdk.tables.getAllInternalTables(db)
let updatedRows: Row[] = []
for (let table of tables) {
const { rows, columns } = await sdk.rows.getRowsWithAttachments(
db.name,
table
)
updatedRows = updatedRows.concat(
rows.map(row => {
for (let column of columns) {
if (Array.isArray(row[column])) {
row[column] = row[column].map((attachment: RowAttachment) =>
rewriteAttachmentUrl(prodAppId, attachment)
)
}
}
return row
}) })
} )
}
updatedRows = updatedRows.concat(rows)
} while (rowsLength === FIND_LIMIT)
} }
// write back the updated attachments // write back the updated attachments
await db.bulkDocs(updatedRows) await db.bulkDocs(updatedRows)

View File

@ -0,0 +1,60 @@
import { CouchFindOptions, Table, Row } from "@budibase/types"
import { db as dbCore } from "@budibase/backend-core"
import { DocumentType, SEPARATOR } from "../../../db/utils"
import { FieldTypes } from "../../../constants"
// default limit - seems to work well for performance
export const FIND_LIMIT = 25
function generateAttachmentFindParams(
tableId: string,
attachmentCols: string[],
bookmark: null | string
) {
const params: CouchFindOptions = {
selector: {
_id: {
$regex: `^${DocumentType.ROW}${SEPARATOR}${tableId}`,
},
},
limit: FIND_LIMIT,
}
attachmentCols.forEach(col => (params.selector[col] = { $exists: true }))
if (bookmark) {
params.bookmark = bookmark
}
return params
}
export async function getRowsWithAttachments(appId: string, table: Table) {
// iterate through attachment documents and update them
const db = dbCore.getDB(appId)
const attachmentCols: string[] = []
for (let [key, column] of Object.entries(table.schema)) {
if (column.type === FieldTypes.ATTACHMENT) {
attachmentCols.push(key)
}
}
// no attachment columns, nothing to do
if (attachmentCols.length === 0) {
return { rows: [], columns: [] }
}
let bookmark: null | string = null,
rowsLength = 0,
rowList: Row[] = []
do {
const params = generateAttachmentFindParams(
table._id!,
attachmentCols,
bookmark
)
// use the CouchDB Mango query API to lookup rows that have attachments
const resp = await dbCore.directCouchFind(db.name, params)
bookmark = resp.bookmark
rowsLength = resp.rows.length
const rows = resp.rows
rowList = rowList.concat(rows)
} while (rowsLength === FIND_LIMIT)
// write back the updated attachments
return { rows: rowList, columns: attachmentCols }
}

View File

@ -0,0 +1,5 @@
import * as attachments from "./attachments"
export default {
...attachments,
}

View File

@ -2,6 +2,7 @@ import { default as backups } from "./app/backups"
import { default as tables } from "./app/tables" import { default as tables } from "./app/tables"
import { default as automations } from "./app/automations" import { default as automations } from "./app/automations"
import { default as applications } from "./app/applications" import { default as applications } from "./app/applications"
import { default as rows } from "./app/rows"
import { default as users } from "./users" import { default as users } from "./users"
const sdk = { const sdk = {
@ -9,6 +10,7 @@ const sdk = {
tables, tables,
automations, automations,
applications, applications,
rows,
users, users,
} }