Merge pull request #4087 from Budibase/fix/migrate-row-quotas

Fixes for rows quotas
This commit is contained in:
Rory Powell 2022-01-21 10:23:33 +00:00 committed by GitHub
commit 95ca886cc0
23 changed files with 462 additions and 103 deletions

View File

@ -99,7 +99,9 @@ spec:
- name: PLATFORM_URL - name: PLATFORM_URL
value: {{ .Values.globals.platformUrl | quote }} value: {{ .Values.globals.platformUrl | quote }}
- name: USE_QUOTAS - name: USE_QUOTAS
value: "1" value: {{ .Values.globals.useQuotas | quote }}
- name: EXCLUDE_QUOTAS_TENANTS
value: {{ .Values.globals.excludeQuotasTenants | quote }}
- name: ACCOUNT_PORTAL_URL - name: ACCOUNT_PORTAL_URL
value: {{ .Values.globals.accountPortalUrl | quote }} value: {{ .Values.globals.accountPortalUrl | quote }}
- name: ACCOUNT_PORTAL_API_KEY - name: ACCOUNT_PORTAL_API_KEY

View File

@ -93,6 +93,8 @@ globals:
logLevel: info logLevel: info
selfHosted: "1" # set to 0 for budibase cloud environment, set to 1 for self-hosted setup selfHosted: "1" # set to 0 for budibase cloud environment, set to 1 for self-hosted setup
multiTenancy: "0" # set to 0 to disable multiple orgs, set to 1 to enable multiple orgs multiTenancy: "0" # set to 0 to disable multiple orgs, set to 1 to enable multiple orgs
useQuotas: "0"
excludeQuotasTenants: "" # comma seperated list of tenants to exclude from quotas
accountPortalUrl: "" accountPortalUrl: ""
accountPortalApiKey: "" accountPortalApiKey: ""
cookieDomain: "" cookieDomain: ""
@ -239,7 +241,8 @@ couchdb:
hosts: hosts:
- chart-example.local - chart-example.local
path: / path: /
annotations: [] annotations:
[]
# kubernetes.io/ingress.class: nginx # kubernetes.io/ingress.class: nginx
# kubernetes.io/tls-acme: "true" # kubernetes.io/tls-acme: "true"
tls: tls:

View File

@ -1,5 +1,5 @@
const { DocumentTypes } = require("../db/constants") const { DocumentTypes } = require("../db/constants")
const { getGlobalDB } = require("../tenancy") const { getGlobalDB, getTenantId } = require("../tenancy")
exports.MIGRATION_DBS = { exports.MIGRATION_DBS = {
GLOBAL_DB: "GLOBAL_DB", GLOBAL_DB: "GLOBAL_DB",
@ -7,13 +7,13 @@ exports.MIGRATION_DBS = {
exports.MIGRATIONS = { exports.MIGRATIONS = {
USER_EMAIL_VIEW_CASING: "user_email_view_casing", USER_EMAIL_VIEW_CASING: "user_email_view_casing",
SYNC_APP_AND_RESET_ROWS_QUOTAS: "sync_app_and_reset_rows_quotas", QUOTAS_1: "quotas_1",
} }
const DB_LOOKUP = { const DB_LOOKUP = {
[exports.MIGRATION_DBS.GLOBAL_DB]: [ [exports.MIGRATION_DBS.GLOBAL_DB]: [
exports.MIGRATIONS.USER_EMAIL_VIEW_CASING, exports.MIGRATIONS.USER_EMAIL_VIEW_CASING,
exports.MIGRATIONS.SYNC_APP_AND_RESET_ROWS_QUOTAS, exports.MIGRATIONS.QUOTAS_1,
], ],
} }
@ -29,6 +29,7 @@ exports.getMigrationsDoc = async db => {
} }
exports.migrateIfRequired = async (migrationDb, migrationName, migrateFn) => { exports.migrateIfRequired = async (migrationDb, migrationName, migrateFn) => {
const tenantId = getTenantId()
try { try {
let db let db
if (migrationDb === exports.MIGRATION_DBS.GLOBAL_DB) { if (migrationDb === exports.MIGRATION_DBS.GLOBAL_DB) {
@ -49,15 +50,18 @@ exports.migrateIfRequired = async (migrationDb, migrationName, migrateFn) => {
return return
} }
console.log(`Performing migration: ${migrationName}`) console.log(`[Tenant: ${tenantId}] Performing migration: ${migrationName}`)
await migrateFn() await migrateFn()
console.log(`Migration complete: ${migrationName}`) console.log(`[Tenant: ${tenantId}] Migration complete: ${migrationName}`)
// mark as complete // mark as complete
doc[migrationName] = Date.now() doc[migrationName] = Date.now()
await db.put(doc) await db.put(doc)
} catch (err) { } catch (err) {
console.error(`Error performing migration: ${migrationName}: `, err) console.error(
`[Tenant: ${tenantId}] Error performing migration: ${migrationName}: `,
err
)
throw err throw err
} }
} }

View File

@ -53,16 +53,23 @@
} }
// Create table // Create table
const table = await tables.save(newTable) let table
notifications.success(`Table ${name} created successfully.`) try {
analytics.captureEvent(Events.TABLE.CREATED, { name }) table = await tables.save(newTable)
notifications.success(`Table ${name} created successfully.`)
analytics.captureEvent(Events.TABLE.CREATED, { name })
// Navigate to new table // Navigate to new table
const currentUrl = $url() const currentUrl = $url()
const path = currentUrl.endsWith("data") const path = currentUrl.endsWith("data")
? `./table/${table._id}` ? `./table/${table._id}`
: `../../table/${table._id}` : `../../table/${table._id}`
$goto(path) $goto(path)
} catch (e) {
notifications.error(e)
// reload in case the table was created
await tables.fetch()
}
} }
</script> </script>

View File

@ -8,6 +8,7 @@ const {
getTable, getTable,
handleDataImport, handleDataImport,
} = require("./utils") } = require("./utils")
const usageQuota = require("../../../utilities/usageQuota")
exports.save = async function (ctx) { exports.save = async function (ctx) {
const appId = ctx.appId const appId = ctx.appId
@ -119,6 +120,7 @@ exports.destroy = async function (ctx) {
}) })
) )
await db.bulkDocs(rows.rows.map(row => ({ ...row.doc, _deleted: true }))) await db.bulkDocs(rows.rows.map(row => ({ ...row.doc, _deleted: true })))
await usageQuota.update(usageQuota.Properties.ROW, -rows.rows.length)
// update linked rows // update linked rows
await linkRows.updateLinks({ await linkRows.updateLinks({

View File

@ -15,6 +15,7 @@ const {
} = require("../../../integrations/utils") } = require("../../../integrations/utils")
const { getViews, saveView } = require("../view/utils") const { getViews, saveView } = require("../view/utils")
const viewTemplate = require("../view/viewBuilder") const viewTemplate = require("../view/viewBuilder")
const usageQuota = require("../../../utilities/usageQuota")
exports.checkForColumnUpdates = async (db, oldTable, updatedTable) => { exports.checkForColumnUpdates = async (db, oldTable, updatedTable) => {
let updatedRows = [] let updatedRows = []
@ -111,7 +112,11 @@ exports.handleDataImport = async (appId, user, table, dataImport) => {
finalData.push(row) finalData.push(row)
} }
await usageQuota.update(usageQuota.Properties.ROW, finalData.length, {
dryRun: true,
})
await db.bulkDocs(finalData) await db.bulkDocs(finalData)
await usageQuota.update(usageQuota.Properties.ROW, finalData.length)
let response = await db.put(table) let response = await db.put(table)
table._rev = response._rev table._rev = response._rev
return table return table

View File

@ -1,6 +1,5 @@
const rowController = require("../../api/controllers/row") const rowController = require("../../api/controllers/row")
const automationUtils = require("../automationUtils") const automationUtils = require("../automationUtils")
const env = require("../../environment")
const usage = require("../../utilities/usageQuota") const usage = require("../../utilities/usageQuota")
const { buildCtx } = require("./utils") const { buildCtx } = require("./utils")
@ -83,10 +82,9 @@ exports.run = async function ({ inputs, appId, emitter }) {
inputs.row.tableId, inputs.row.tableId,
inputs.row inputs.row
) )
if (env.USE_QUOTAS) { await usage.update(usage.Properties.ROW, 1, { dryRun: true })
await usage.update(usage.Properties.ROW, 1)
}
await rowController.save(ctx) await rowController.save(ctx)
await usage.update(usage.Properties.ROW, 1)
return { return {
row: inputs.row, row: inputs.row,
response: ctx.body, response: ctx.body,

View File

@ -1,5 +1,4 @@
const rowController = require("../../api/controllers/row") const rowController = require("../../api/controllers/row")
const env = require("../../environment")
const usage = require("../../utilities/usageQuota") const usage = require("../../utilities/usageQuota")
const { buildCtx } = require("./utils") const { buildCtx } = require("./utils")
const automationUtils = require("../automationUtils") const automationUtils = require("../automationUtils")
@ -74,9 +73,7 @@ exports.run = async function ({ inputs, appId, emitter }) {
}) })
try { try {
if (env.isProd()) { await usage.update(usage.Properties.ROW, -1)
await usage.update(usage.Properties.ROW, -1)
}
await rowController.destroy(ctx) await rowController.destroy(ctx)
return { return {
response: ctx.body, response: ctx.body,

View File

@ -38,6 +38,7 @@ module.exports = {
MINIO_ACCESS_KEY: process.env.MINIO_ACCESS_KEY, MINIO_ACCESS_KEY: process.env.MINIO_ACCESS_KEY,
MINIO_SECRET_KEY: process.env.MINIO_SECRET_KEY, MINIO_SECRET_KEY: process.env.MINIO_SECRET_KEY,
USE_QUOTAS: process.env.USE_QUOTAS, USE_QUOTAS: process.env.USE_QUOTAS,
EXCLUDE_QUOTAS_TENANTS: process.env.EXCLUDE_QUOTAS_TENANTS,
REDIS_URL: process.env.REDIS_URL, REDIS_URL: process.env.REDIS_URL,
REDIS_PASSWORD: process.env.REDIS_PASSWORD, REDIS_PASSWORD: process.env.REDIS_PASSWORD,
INTERNAL_API_KEY: process.env.INTERNAL_API_KEY, INTERNAL_API_KEY: process.env.INTERNAL_API_KEY,

View File

@ -38,7 +38,7 @@ module S3Module {
signatureVersion: { signatureVersion: {
type: "string", type: "string",
required: false, required: false,
default: "v4" default: "v4",
}, },
}, },
query: { query: {

View File

@ -1,11 +1,5 @@
jest.mock("../../db") jest.mock("../../db")
jest.mock("../../utilities/usageQuota") jest.mock("../../utilities/usageQuota")
jest.mock("../../environment", () => ({
isTest: () => true,
isProd: () => false,
isDev: () => true,
_set: () => {},
}))
jest.mock("@budibase/backend-core/tenancy", () => ({ jest.mock("@budibase/backend-core/tenancy", () => ({
getTenantId: () => "testing123" getTenantId: () => "testing123"
})) }))
@ -32,6 +26,7 @@ class TestConfiguration {
url: "/applications" url: "/applications"
} }
} }
usageQuota.useQuotas = () => true
} }
executeMiddleware() { executeMiddleware() {
@ -113,12 +108,10 @@ describe("usageQuota middleware", () => {
it("calculates and persists the correct usage quota for the relevant action", async () => { it("calculates and persists the correct usage quota for the relevant action", async () => {
config.setUrl("/rows") config.setUrl("/rows")
config.setProd(true)
await config.executeMiddleware() await config.executeMiddleware()
// expect(usageQuota.update).toHaveBeenCalledWith("rows", 1) expect(usageQuota.update).toHaveBeenCalledWith("rows", 1)
expect(usageQuota.update).not.toHaveBeenCalledWith("rows", 1)
expect(config.next).toHaveBeenCalled() expect(config.next).toHaveBeenCalled()
}) })

View File

@ -1,17 +1,11 @@
const CouchDB = require("../db") const CouchDB = require("../db")
const usageQuota = require("../utilities/usageQuota") const usageQuota = require("../utilities/usageQuota")
const env = require("../environment") const { getUniqueRows } = require("../utilities/usageQuota/rows")
const { getTenantId } = require("@budibase/backend-core/tenancy")
const { const {
isExternalTable, isExternalTable,
isRowId: isExternalRowId, isRowId: isExternalRowId,
} = require("../integrations/utils") } = require("../integrations/utils")
const quotaMigration = require("../migrations/sync_app_and_reset_rows_quotas") const migration = require("../migrations/usageQuotas")
const testing = false
// tenants without limits
const EXCLUDED_TENANTS = ["bb", "default", "bbtest", "bbstaging"]
// currently only counting new writes and deletes // currently only counting new writes and deletes
const METHOD_MAP = { const METHOD_MAP = {
@ -20,7 +14,7 @@ const METHOD_MAP = {
} }
const DOMAIN_MAP = { const DOMAIN_MAP = {
// rows: usageQuota.Properties.ROW, // works - disabled rows: usageQuota.Properties.ROW,
// upload: usageQuota.Properties.UPLOAD, // doesn't work yet // upload: usageQuota.Properties.UPLOAD, // doesn't work yet
// views: usageQuota.Properties.VIEW, // doesn't work yet // views: usageQuota.Properties.VIEW, // doesn't work yet
// users: usageQuota.Properties.USER, // doesn't work yet // users: usageQuota.Properties.USER, // doesn't work yet
@ -39,13 +33,7 @@ function getProperty(url) {
} }
module.exports = async (ctx, next) => { module.exports = async (ctx, next) => {
const tenantId = getTenantId() if (!usageQuota.useQuotas()) {
// if in development or a self hosted cloud usage quotas should not be executed
if (
(env.isDev() || env.SELF_HOSTED || EXCLUDED_TENANTS.includes(tenantId)) &&
!testing
) {
return next() return next()
} }
@ -86,10 +74,93 @@ module.exports = async (ctx, next) => {
usage = files.map(file => file.size).reduce((total, size) => total + size) usage = files.map(file => file.size).reduce((total, size) => total + size)
} }
try { try {
await quotaMigration.runIfRequired() await migration.run()
await usageQuota.update(property, usage) await performRequest(ctx, next, property, usage)
return next()
} catch (err) { } catch (err) {
ctx.throw(400, err) ctx.throw(400, err)
} }
} }
const performRequest = async (ctx, next, property, usage) => {
const usageContext = {
skipNext: false,
skipUsage: false,
[usageQuota.Properties.APPS]: {},
}
if (usage === -1) {
if (PRE_DELETE[property]) {
await PRE_DELETE[property](ctx, usageContext)
}
} else {
if (PRE_CREATE[property]) {
await PRE_CREATE[property](ctx, usageContext)
}
}
// run the request
if (!usageContext.skipNext) {
await usageQuota.update(property, usage, { dryRun: true })
await next()
}
if (usage === -1) {
if (POST_DELETE[property]) {
await POST_DELETE[property](ctx, usageContext)
}
} else {
if (POST_CREATE[property]) {
await POST_CREATE[property](ctx, usageContext)
}
}
// update the usage
if (!usageContext.skipUsage) {
await usageQuota.update(property, usage)
}
}
const appPreDelete = async (ctx, usageContext) => {
if (ctx.query.unpublish) {
// don't run usage decrement for unpublish
usageContext.skipUsage = true
return
}
// store the row count to delete
const rows = await getUniqueRows([ctx.appId])
if (rows.length) {
usageContext[usageQuota.Properties.APPS] = { rowCount: rows.length }
}
}
const appPostDelete = async (ctx, usageContext) => {
// delete the app rows from usage
const rowCount = usageContext[usageQuota.Properties.APPS].rowCount
if (rowCount) {
await usageQuota.update(usageQuota.Properties.ROW, -rowCount)
}
}
const appPostCreate = async ctx => {
// app import & template creation
if (ctx.request.body.useTemplate === "true") {
const rows = await getUniqueRows([ctx.response.body.appId])
const rowCount = rows ? rows.length : 0
await usageQuota.update(usageQuota.Properties.ROW, rowCount)
}
}
const PRE_DELETE = {
[usageQuota.Properties.APPS]: appPreDelete,
}
const POST_DELETE = {
[usageQuota.Properties.APPS]: appPostDelete,
}
const PRE_CREATE = {}
const POST_CREATE = {
[usageQuota.Properties.APPS]: appPostCreate,
}

View File

@ -1,30 +0,0 @@
const {
MIGRATIONS,
MIGRATION_DBS,
migrateIfRequired,
} = require("@budibase/backend-core/migrations")
const { getGlobalDB } = require("@budibase/backend-core/tenancy")
const { getAllApps } = require("@budibase/backend-core/db")
const CouchDB = require("../db")
const { getUsageQuotaDoc } = require("../utilities/usageQuota")
exports.runIfRequired = async () => {
await migrateIfRequired(
MIGRATION_DBS.GLOBAL_DB,
MIGRATIONS.SYNC_APP_AND_RESET_ROWS_QUOTAS,
async () => {
const db = getGlobalDB()
const usageDoc = await getUsageQuotaDoc(db)
// reset the rows
usageDoc.usageQuota.rows = 0
// sync the apps
const apps = await getAllApps(CouchDB, { dev: true })
const appCount = apps ? apps.length : 0
usageDoc.usageQuota.apps = appCount
await db.put(usageDoc)
}
)
}

View File

@ -0,0 +1,27 @@
const env = require("../../../environment")
const TestConfig = require("../../../tests/utilities/TestConfiguration")
const syncApps = jest.fn()
const syncRows = jest.fn()
jest.mock("../../usageQuotas/syncApps", () => ({ run: syncApps }) )
jest.mock("../../usageQuotas/syncRows", () => ({ run: syncRows }) )
const migrations = require("../../usageQuotas")
describe("run", () => {
let config = new TestConfig(false)
beforeEach(async () => {
await config.init()
env._set("USE_QUOTAS", 1)
})
afterAll(config.end)
it("runs the required migrations", async () => {
await migrations.run()
expect(syncApps).toHaveBeenCalledTimes(1)
expect(syncRows).toHaveBeenCalledTimes(1)
})
})

View File

@ -1,10 +1,10 @@
const { getGlobalDB } = require("@budibase/backend-core/tenancy") const { getGlobalDB } = require("@budibase/backend-core/tenancy")
const TestConfig = require("../../tests/utilities/TestConfiguration") const TestConfig = require("../../../tests/utilities/TestConfiguration")
const { getUsageQuotaDoc, update, Properties } = require("../../utilities/usageQuota") const { getUsageQuotaDoc, update, Properties } = require("../../../utilities/usageQuota")
const { runIfRequired } = require("../sync_app_and_reset_rows_quotas") const syncApps = require("../../usageQuotas/syncApps")
const env = require("../../environment") const env = require("../../../environment")
describe("Sync App And Reset Rows Quotas Migration", () => { describe("syncApps", () => {
let config = new TestConfig(false) let config = new TestConfig(false)
beforeEach(async () => { beforeEach(async () => {
@ -14,26 +14,24 @@ describe("Sync App And Reset Rows Quotas Migration", () => {
afterAll(config.end) afterAll(config.end)
it("migrates successfully", async () => { it("runs successfully", async () => {
// create the usage quota doc and mock usages // create the usage quota doc and mock usages
const db = getGlobalDB() const db = getGlobalDB()
await getUsageQuotaDoc(db) await getUsageQuotaDoc(db)
await update(Properties.APPS, 3) await update(Properties.APPS, 3)
await update(Properties.ROW, 300)
let usageDoc = await getUsageQuotaDoc(db) let usageDoc = await getUsageQuotaDoc(db)
expect(usageDoc.usageQuota.apps).toEqual(3) expect(usageDoc.usageQuota.apps).toEqual(3)
expect(usageDoc.usageQuota.rows).toEqual(300)
// create an extra app to test the migration // create an extra app to test the migration
await config.createApp("quota-test") await config.createApp("quota-test")
// migrate // migrate
await runIfRequired() await syncApps.run()
// assert the migration worked // assert the migration worked
usageDoc = await getUsageQuotaDoc(db) usageDoc = await getUsageQuotaDoc(db)
expect(usageDoc.usageQuota.apps).toEqual(2) expect(usageDoc.usageQuota.apps).toEqual(2)
expect(usageDoc.usageQuota.rows).toEqual(0)
}) })
}) })

View File

@ -0,0 +1,43 @@
const { getGlobalDB } = require("@budibase/backend-core/tenancy")
const TestConfig = require("../../../tests/utilities/TestConfiguration")
const { getUsageQuotaDoc, update, Properties } = require("../../../utilities/usageQuota")
const syncRows = require("../../usageQuotas/syncRows")
const env = require("../../../environment")
describe("syncRows", () => {
let config = new TestConfig(false)
beforeEach(async () => {
await config.init()
env._set("USE_QUOTAS", 1)
})
afterAll(config.end)
it("runs successfully", async () => {
// create the usage quota doc and mock usages
const db = getGlobalDB()
await getUsageQuotaDoc(db)
await update(Properties.ROW, 300)
let usageDoc = await getUsageQuotaDoc(db)
expect(usageDoc.usageQuota.rows).toEqual(300)
// app 1
await config.createTable()
await config.createRow()
// app 2
await config.createApp()
await config.createTable()
await config.createRow()
await config.createRow()
// migrate
await syncRows.run()
// assert the migration worked
usageDoc = await getUsageQuotaDoc(db)
expect(usageDoc.usageQuota.rows).toEqual(3)
})
})

View File

@ -0,0 +1,24 @@
const {
MIGRATIONS,
MIGRATION_DBS,
migrateIfRequired,
} = require("@budibase/backend-core/migrations")
const { useQuotas } = require("../../utilities/usageQuota")
const syncApps = require("./syncApps")
const syncRows = require("./syncRows")
exports.run = async () => {
if (!useQuotas()) {
return
}
// Jan 2022
await migrateIfRequired(
MIGRATION_DBS.GLOBAL_DB,
MIGRATIONS.QUOTAS_1,
async () => {
await syncApps.run()
await syncRows.run()
}
)
}

View File

@ -0,0 +1,18 @@
const { getGlobalDB, getTenantId } = require("@budibase/backend-core/tenancy")
const { getAllApps } = require("@budibase/backend-core/db")
const CouchDB = require("../../db")
const { getUsageQuotaDoc } = require("../../utilities/usageQuota")
exports.run = async () => {
const db = getGlobalDB()
// get app count
const devApps = await getAllApps(CouchDB, { dev: true })
const appCount = devApps ? devApps.length : 0
// sync app count
const tenantId = getTenantId()
console.log(`[Tenant: ${tenantId}] Syncing app count: ${appCount}`)
const usageDoc = await getUsageQuotaDoc(db)
usageDoc.usageQuota.apps = appCount
await db.put(usageDoc)
}

View File

@ -0,0 +1,21 @@
const { getGlobalDB, getTenantId } = require("@budibase/backend-core/tenancy")
const { getAllApps } = require("@budibase/backend-core/db")
const CouchDB = require("../../db")
const { getUsageQuotaDoc } = require("../../utilities/usageQuota")
const { getUniqueRows } = require("../../utilities/usageQuota/rows")
exports.run = async () => {
const db = getGlobalDB()
// get all rows in all apps
const allApps = await getAllApps(CouchDB, { all: true })
const appIds = allApps ? allApps.map(app => app.appId) : []
const rows = await getUniqueRows(appIds)
const rowCount = rows ? rows.length : 0
// sync row count
const tenantId = getTenantId()
console.log(`[Tenant: ${tenantId}] Syncing row count: ${rowCount}`)
const usageDoc = await getUsageQuotaDoc(db)
usageDoc.usageQuota.rows = rowCount
await db.put(usageDoc)
}

View File

@ -0,0 +1,72 @@
const getTenantId = jest.fn()
jest.mock("@budibase/backend-core/tenancy", () => ({
getTenantId
}))
const usageQuota = require("../../usageQuota")
const env = require("../../../environment")
class TestConfiguration {
constructor() {
this.enableQuotas()
}
enableQuotas = () => {
env.USE_QUOTAS = 1
}
disableQuotas = () => {
env.USE_QUOTAS = null
}
setTenantId = (tenantId) => {
getTenantId.mockReturnValue(tenantId)
}
setExcludedTenants = (tenants) => {
env.EXCLUDE_QUOTAS_TENANTS = tenants
}
reset = () => {
this.disableQuotas()
this.setExcludedTenants(null)
}
}
describe("usageQuota", () => {
let config
beforeEach(() => {
config = new TestConfiguration()
})
afterEach(() => {
config.reset()
})
describe("useQuotas", () => {
it("works when no settings have been provided", () => {
config.reset()
expect(usageQuota.useQuotas()).toBe(false)
})
it("honours USE_QUOTAS setting", () => {
config.disableQuotas()
expect(usageQuota.useQuotas()).toBe(false)
config.enableQuotas()
expect(usageQuota.useQuotas()).toBe(true)
})
it("honours EXCLUDE_QUOTAS_TENANTS setting", () => {
config.setTenantId("test")
// tenantId is in the list
config.setExcludedTenants("test, test2, test2")
expect(usageQuota.useQuotas()).toBe(false)
config.setExcludedTenants("test,test2,test2")
expect(usageQuota.useQuotas()).toBe(false)
// tenantId is not in the list
config.setTenantId("other")
expect(usageQuota.useQuotas()).toBe(true)
})
})
})

View File

@ -1,17 +1,36 @@
const env = require("../environment") const env = require("../../environment")
const { getGlobalDB } = require("@budibase/backend-core/tenancy") const { getGlobalDB, getTenantId } = require("@budibase/backend-core/tenancy")
const { const {
StaticDatabases, StaticDatabases,
generateNewUsageQuotaDoc, generateNewUsageQuotaDoc,
} = require("@budibase/backend-core/db") } = require("@budibase/backend-core/db")
exports.useQuotas = () => {
// check if quotas are enabled
if (env.USE_QUOTAS) {
// check if there are any tenants without limits
if (env.EXCLUDE_QUOTAS_TENANTS) {
const excludedTenants = env.EXCLUDE_QUOTAS_TENANTS.replace(
/\s/g,
""
).split(",")
const tenantId = getTenantId()
if (excludedTenants.includes(tenantId)) {
return false
}
}
return true
}
return false
}
exports.Properties = { exports.Properties = {
ROW: "rows", // mostly works - disabled - app / table deletion not yet accounted for ROW: "rows",
UPLOAD: "storage", // doesn't work yet UPLOAD: "storage", // doesn't work yet
VIEW: "views", // doesn't work yet VIEW: "views", // doesn't work yet
USER: "users", // doesn't work yet USER: "users", // doesn't work yet
AUTOMATION: "automationRuns", // doesn't work yet AUTOMATION: "automationRuns", // doesn't work yet
APPS: "apps", // works APPS: "apps",
EMAILS: "emails", // doesn't work yet EMAILS: "emails", // doesn't work yet
} }
@ -36,8 +55,8 @@ exports.getUsageQuotaDoc = async db => {
* @returns {Promise<void>} When this completes the API key will now be up to date - the quota period may have * @returns {Promise<void>} When this completes the API key will now be up to date - the quota period may have
* also been reset after this call. * also been reset after this call.
*/ */
exports.update = async (property, usage) => { exports.update = async (property, usage, opts = { dryRun: false }) => {
if (!env.USE_QUOTAS) { if (!exports.useQuotas()) {
return return
} }
@ -48,14 +67,24 @@ exports.update = async (property, usage) => {
// increment the quota // increment the quota
quota.usageQuota[property] += usage quota.usageQuota[property] += usage
if (quota.usageQuota[property] > quota.usageLimits[property]) { if (
quota.usageQuota[property] > quota.usageLimits[property] &&
usage > 0 // allow for decrementing usage when the quota is already exceeded
) {
throw new Error( throw new Error(
`You have exceeded your usage quota of ${quota.usageLimits[property]} ${property}.` `You have exceeded your usage quota of ${quota.usageLimits[property]} ${property}.`
) )
} }
if (quota.usageQuota[property] < 0) {
// never go negative if the quota has previously been exceeded
quota.usageQuota[property] = 0
}
// update the usage quotas // update the usage quotas
await db.put(quota) if (!opts.dryRun) {
await db.put(quota)
}
} catch (err) { } catch (err) {
console.error(`Error updating usage quotas for ${property}`, err) console.error(`Error updating usage quotas for ${property}`, err)
throw err throw err

View File

@ -0,0 +1,74 @@
const { getRowParams, USER_METDATA_PREFIX } = require("../../db/utils")
const CouchDB = require("../../db")
const { isDevAppID, getDevelopmentAppID } = require("@budibase/backend-core/db")
const ROW_EXCLUSIONS = [USER_METDATA_PREFIX]
const getAppPairs = appIds => {
// collect the app ids into dev / prod pairs
// keyed by the dev app id
const pairs = {}
for (let appId of appIds) {
const devId = getDevelopmentAppID(appId)
if (!pairs[devId]) {
pairs[devId] = {}
}
if (isDevAppID(appId)) {
pairs[devId].devId = appId
} else {
pairs[devId].prodId = appId
}
}
return pairs
}
const getAppRows = async appId => {
const appDb = new CouchDB(appId)
const response = await appDb.allDocs(
getRowParams(null, null, {
include_docs: false,
})
)
return response.rows
.map(r => r.id)
.filter(id => {
for (let exclusion of ROW_EXCLUSIONS) {
if (id.startsWith(exclusion)) {
return false
}
}
return true
})
}
/**
* Return a set of all rows in the given app ids.
* The returned rows will be unique on a per dev/prod app basis.
* Rows duplicates may exist across apps due to data import so they are not filtered out.
*/
exports.getUniqueRows = async appIds => {
let uniqueRows = []
const pairs = getAppPairs(appIds)
for (let pair of Object.values(pairs)) {
let appRows = []
for (let appId of [pair.devId, pair.prodId]) {
if (!appId) {
continue
}
try {
appRows.push(await getAppRows(appId))
} catch (e) {
console.error(e)
// don't error out if we can't count the app rows, just continue
}
}
// ensure uniqueness on a per app pair basis
// this can't be done on all rows because app import results in
// duplicate row ids across apps
uniqueRows = uniqueRows.concat(...new Set(appRows))
}
return uniqueRows
}