CodeMirror/budibase
1
0
Fork 0
mirror of synced 2024-08-09 07:08:01 +12:00
Code Issues Projects Releases Wiki Activity

Merge pull request #5806 from Budibase/crud-quotas

Browse source 
Add query quota increment to rows CRUD
This commit is contained in:
Rory Powell 2022-05-11 12:05:54 +01:00 committed by GitHub
commit e47130ef19
6 changed files with 126 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
packages/server/package.json
View file

@ -71,7 +71,7 @@
"@apidevtools/swagger-parser": "^10.0.3",
"@budibase/backend-core": "^1.0.151",
"@budibase/client": "^1.0.151",
"@budibase/pro": "1.0.151",
"@budibase/pro": "1.0.150",
"@budibase/string-templates": "^1.0.151",
"@bull-board/api": "^3.7.0",
"@bull-board/koa": "^3.7.0",

34
packages/server/src/api/controllers/row/index.ts
View file

@ -31,7 +31,9 @@ export async function patch(ctx: any): Promise<any> {
return save(ctx)
}
try {
const { row, table } = await pickApi(tableId).patch(ctx)
const { row, table } = await quotas.addQuery(() =>
pickApi(tableId).patch(ctx)
)
ctx.status = 200
ctx.eventEmitter &&
ctx.eventEmitter.emitRow(`row:update`, appId, row, table)
@ -42,7 +44,7 @@ export async function patch(ctx: any): Promise<any> {
}
}
const saveRow = async (ctx: any) => {
export const save = async (ctx: any) => {
const appId = ctx.appId
const tableId = getTableId(ctx)
const body = ctx.request.body
@ -51,7 +53,9 @@ const saveRow = async (ctx: any) => {
return patch(ctx)
}
try {
const { row, table } = await pickApi(tableId).save(ctx)
const { row, table } = await quotas.addRow(() =>
quotas.addQuery(() => pickApi(tableId).save(ctx))
)
ctx.status = 200
ctx.eventEmitter && ctx.eventEmitter.emitRow(`row:save`, appId, row, table)
ctx.message = `${table.name} saved successfully`
@ -61,14 +65,10 @@ const saveRow = async (ctx: any) => {
}
}
export async function save(ctx: any) {
await quotas.addRow(() => saveRow(ctx))
}
export async function fetchView(ctx: any) {
const tableId = getTableId(ctx)
try {
ctx.body = await pickApi(tableId).fetchView(ctx)
ctx.body = await quotas.addQuery(() => pickApi(tableId).fetchView(ctx))
} catch (err) {
ctx.throw(400, err)
}
@ -77,7 +77,7 @@ export async function fetchView(ctx: any) {
export async function fetch(ctx: any) {
const tableId = getTableId(ctx)
try {
ctx.body = await pickApi(tableId).fetch(ctx)
ctx.body = await quotas.addQuery(() => pickApi(tableId).fetch(ctx))
} catch (err) {
ctx.throw(400, err)
}
@ -86,7 +86,7 @@ export async function fetch(ctx: any) {
export async function find(ctx: any) {
const tableId = getTableId(ctx)
try {
ctx.body = await pickApi(tableId).find(ctx)
ctx.body = await quotas.addQuery(() => pickApi(tableId).find(ctx))
} catch (err) {
ctx.throw(400, err)
}
@ -98,14 +98,16 @@ export async function destroy(ctx: any) {
const tableId = getTableId(ctx)
let response, row
if (inputs.rows) {
let { rows } = await pickApi(tableId).bulkDestroy(ctx)
let { rows } = await quotas.addQuery(() =>
pickApi(tableId).bulkDestroy(ctx)
)
await quotas.removeRows(rows.length)
response = rows
for (let row of rows) {
ctx.eventEmitter && ctx.eventEmitter.emitRow(`row:delete`, appId, row)
}
} else {
let resp = await pickApi(tableId).destroy(ctx)
let resp = await quotas.addQuery(() => pickApi(tableId).destroy(ctx))
await quotas.removeRow()
response = resp.response
row = resp.row
@ -121,7 +123,7 @@ export async function search(ctx: any) {
const tableId = getTableId(ctx)
try {
ctx.status = 200
ctx.body = await pickApi(tableId).search(ctx)
ctx.body = await quotas.addQuery(() => pickApi(tableId).search(ctx))
} catch (err) {
ctx.throw(400, err)
}
@ -139,7 +141,9 @@ export async function validate(ctx: any) {
export async function fetchEnrichedRow(ctx: any) {
const tableId = getTableId(ctx)
try {
ctx.body = await pickApi(tableId).fetchEnrichedRow(ctx)
ctx.body = await quotas.addQuery(() =>
pickApi(tableId).fetchEnrichedRow(ctx)
)
} catch (err) {
ctx.throw(400, err)
}
@ -148,7 +152,7 @@ export async function fetchEnrichedRow(ctx: any) {
export const exportRows = async (ctx: any) => {
const tableId = getTableId(ctx)
try {
ctx.body = await pickApi(tableId).exportRows(ctx)
ctx.body = await quotas.addQuery(() => pickApi(tableId).exportRows(ctx))
} catch (err) {
ctx.throw(400, err)
}

92
packages/server/src/api/routes/tests/row.spec.js
View file

@ -3,6 +3,7 @@ const setup = require("./utilities")
const { basicRow } = setup.structures
const { doInAppContext } = require("@budibase/backend-core/context")
const { doInTenant } = require("@budibase/backend-core/tenancy")
const { quotas, QuotaUsageType, StaticQuotaName, MonthlyQuotaName } = require("@budibase/pro")
// mock the fetch for the search system
jest.mock("node-fetch")
@ -28,9 +29,29 @@ describe("/rows", () => {
.expect('Content-Type', /json/)
.expect(status)
const getRowUsage = async () => {
return config.doInContext(null, () => quotas.getCurrentUsageValue(QuotaUsageType.STATIC, StaticQuotaName.ROWS))
}
const getQueryUsage = async () => {
return config.doInContext(null, () => quotas.getCurrentUsageValue(QuotaUsageType.MONTHLY, MonthlyQuotaName.QUERIES))
}
const assertRowUsage = async (expected) => {
const usage = await getRowUsage()
expect(usage).toBe(expected)
}
const assertQueryUsage = async (expected) => {
const usage = await getQueryUsage()
expect(usage).toBe(expected)
}
describe("save, load, update", () => {
it("returns a success message when the row is created", async () => {
const rowUsage = await getRowUsage()
const queryUsage = await getQueryUsage()
const res = await request
.post(`/api/${row.tableId}/rows`)
.send(row)
@ -40,10 +61,14 @@ describe("/rows", () => {
expect(res.res.statusMessage).toEqual(`${table.name} saved successfully`)
expect(res.body.name).toEqual("Test Contact")
expect(res.body._rev).toBeDefined()
await assertRowUsage(rowUsage + 1)
await assertQueryUsage(queryUsage + 1)
})
it("updates a row successfully", async () => {
const existing = await config.createRow()
const rowUsage = await getRowUsage()
const queryUsage = await getQueryUsage()
const res = await request
.post(`/api/${table._id}/rows`)
@ -59,10 +84,13 @@ describe("/rows", () => {
expect(res.res.statusMessage).toEqual(`${table.name} updated successfully.`)
expect(res.body.name).toEqual("Updated Name")
await assertRowUsage(rowUsage)
await assertQueryUsage(queryUsage + 1)
})
it("should load a row", async () => {
const existing = await config.createRow()
const queryUsage = await getQueryUsage()
const res = await request
.get(`/api/${table._id}/rows/${existing._id}`)
@ -76,6 +104,7 @@ describe("/rows", () => {
_rev: existing._rev,
type: "row",
})
await assertQueryUsage(queryUsage + 1)
})
it("should list all rows for given tableId", async () => {
@ -86,6 +115,7 @@ describe("/rows", () => {
}
await config.createRow()
await config.createRow(newRow)
const queryUsage = await getQueryUsage()
const res = await request
.get(`/api/${table._id}/rows`)
@ -96,15 +126,19 @@ describe("/rows", () => {
expect(res.body.length).toBe(2)
expect(res.body.find(r => r.name === newRow.name)).toBeDefined()
expect(res.body.find(r => r.name === row.name)).toBeDefined()
await assertQueryUsage(queryUsage + 1)
})
it("load should return 404 when row does not exist", async () => {
await config.createRow()
const queryUsage = await getQueryUsage()
await request
.get(`/api/${table._id}/rows/not-a-valid-id`)
.set(config.defaultHeaders())
.expect('Content-Type', /json/)
.expect(404)
await assertQueryUsage(queryUsage) // no change
})
it("row values are coerced", async () => {
@ -202,6 +236,9 @@ describe("/rows", () => {
it("should update only the fields that are supplied", async () => {
const existing = await config.createRow()
const rowUsage = await getRowUsage()
const queryUsage = await getQueryUsage()
const res = await request
.patch(`/api/${table._id}/rows`)
.send({
@ -222,10 +259,15 @@ describe("/rows", () => {
expect(savedRow.body.description).toEqual(existing.description)
expect(savedRow.body.name).toEqual("Updated Name")
await assertRowUsage(rowUsage)
await assertQueryUsage(queryUsage + 2) // account for the second load
})
it("should throw an error when given improper types", async () => {
const existing = await config.createRow()
const rowUsage = await getRowUsage()
const queryUsage = await getQueryUsage()
await request
.patch(`/api/${table._id}/rows`)
.send({
@ -236,12 +278,18 @@ describe("/rows", () => {
})
.set(config.defaultHeaders())
.expect(400)
await assertRowUsage(rowUsage)
await assertQueryUsage(queryUsage)
})
})
describe("destroy", () => {
it("should be able to delete a row", async () => {
const createdRow = await config.createRow(row)
const rowUsage = await getRowUsage()
const queryUsage = await getQueryUsage()
const res = await request
.delete(`/api/${table._id}/rows`)
.send({
@ -253,11 +301,16 @@ describe("/rows", () => {
.expect('Content-Type', /json/)
.expect(200)
expect(res.body[0]._id).toEqual(createdRow._id)
await assertRowUsage(rowUsage -1)
await assertQueryUsage(queryUsage +1)
})
})
describe("validate", () => {
it("should return no errors on valid row", async () => {
const rowUsage = await getRowUsage()
const queryUsage = await getQueryUsage()
const res = await request
.post(`/api/${table._id}/rows/validate`)
.send({ name: "ivan" })
@ -267,9 +320,14 @@ describe("/rows", () => {
expect(res.body.valid).toBe(true)
expect(Object.keys(res.body.errors)).toEqual([])
await assertRowUsage(rowUsage)
await assertQueryUsage(queryUsage)
})
it("should errors on invalid row", async () => {
const rowUsage = await getRowUsage()
const queryUsage = await getQueryUsage()
const res = await request
.post(`/api/${table._id}/rows/validate`)
.send({ name: 1 })
@ -279,7 +337,8 @@ describe("/rows", () => {
expect(res.body.valid).toBe(false)
expect(Object.keys(res.body.errors)).toEqual(["name"])
await assertRowUsage(rowUsage)
await assertQueryUsage(queryUsage)
})
})
@ -287,6 +346,9 @@ describe("/rows", () => {
it("should be able to delete a bulk set of rows", async () => {
const row1 = await config.createRow()
const row2 = await config.createRow()
const rowUsage = await getRowUsage()
const queryUsage = await getQueryUsage()
const res = await request
.delete(`/api/${table._id}/rows`)
.send({
@ -298,14 +360,20 @@ describe("/rows", () => {
.set(config.defaultHeaders())
.expect('Content-Type', /json/)
.expect(200)
expect(res.body.length).toEqual(2)
await loadRow(row1._id, 404)
await assertRowUsage(rowUsage - 2)
await assertQueryUsage(queryUsage +1)
})
})
describe("fetchView", () => {
it("should be able to fetch tables contents via 'view'", async () => {
const row = await config.createRow()
const rowUsage = await getRowUsage()
const queryUsage = await getQueryUsage()
const res = await request
.get(`/api/views/${table._id}`)
.set(config.defaultHeaders())
@ -313,18 +381,29 @@ describe("/rows", () => {
.expect(200)
expect(res.body.length).toEqual(1)
expect(res.body[0]._id).toEqual(row._id)
await assertRowUsage(rowUsage)
await assertQueryUsage(queryUsage +1)
})
it("should throw an error if view doesn't exist", async () => {
const rowUsage = await getRowUsage()
const queryUsage = await getQueryUsage()
await request
.get(`/api/views/derp`)
.set(config.defaultHeaders())
.expect(404)
await assertRowUsage(rowUsage)
await assertQueryUsage(queryUsage)
})
it("should be able to run on a view", async () => {
const view = await config.createView()
const row = await config.createRow()
const rowUsage = await getRowUsage()
const queryUsage = await getQueryUsage()
const res = await request
.get(`/api/views/${view.name}`)
.set(config.defaultHeaders())
@ -332,13 +411,12 @@ describe("/rows", () => {
.expect(200)
expect(res.body.length).toEqual(1)
expect(res.body[0]._id).toEqual(row._id)
await assertRowUsage(rowUsage)
await assertQueryUsage(queryUsage + 1)
})
})
describe("user testing", () => {
})
describe("fetchEnrichedRows", () => {
it("should allow enriching some linked rows", async () => {
const { table, firstRow, secondRow } = await doInTenant(setup.structures.TENANT_ID, async () => {
@ -356,6 +434,8 @@ describe("/rows", () => {
})
return { table, firstRow, secondRow }
})
const rowUsage = await getRowUsage()
const queryUsage = await getQueryUsage()
// test basic enrichment
const resBasic = await request
@ -376,6 +456,8 @@ describe("/rows", () => {
expect(resEnriched.body.link[0]._id).toBe(firstRow._id)
expect(resEnriched.body.link[0].name).toBe("Test Contact")
expect(resEnriched.body.link[0].description).toBe("original description")
await assertRowUsage(rowUsage)
await assertQueryUsage(queryUsage +2)
})
})

18
packages/server/yarn.lock
View file

@ -1014,10 +1014,10 @@
resolved "https://registry.yarnpkg.com/@bcoe/v8-coverage/-/v8-coverage-0.2.3.tgz#75a2e8b51cb758a7553d6804a5932d7aace75c39"
integrity sha512-0hYQ8SB4Db5zvZB4axdMHGwEaQjkZzFjQiN9LVYvIFB2nSUHW9tYpxWriPrWDASIxiaXax83REcLxuSdnGPZtw==
"@budibase/backend-core@1.0.147":
version "1.0.147"
resolved "https://registry.yarnpkg.com/@budibase/backend-core/-/backend-core-1.0.147.tgz#fc93a803e97e304170b33bd28b4f5deda32bec18"
integrity sha512-0GcF9G/tTAsko9g352MB8K3EtMTVb7v7Av6RdsYyKBdVtOD42HKFzSOD0n/RQUL4v70YByiu99zJAB6z1m1Pcg==
"@budibase/backend-core@1.0.150":
version "1.0.150"
resolved "https://registry.yarnpkg.com/@budibase/backend-core/-/backend-core-1.0.150.tgz#a48beb1e38f5e3e09473235fd2b7f35a05a15342"
integrity sha512-ceQVPnypKFurQMJgghky+MxtiF3x4b7rIzYhXv6Y+QfIb7IdY6wvv9o+dD3GPwNZJCRFSFizPR4YLBXdL+2+yw==
dependencies:
"@techpass/passport-openidconnect" "^0.3.0"
aws-sdk "^2.901.0"
@ -1091,12 +1091,12 @@
svelte-flatpickr "^3.2.3"
svelte-portal "^1.0.0"
"@budibase/pro@1.0.147":
version "1.0.147"
resolved "https://registry.yarnpkg.com/@budibase/pro/-/pro-1.0.147.tgz#c1ec9d92ffaa40285a83c57ddbec1f32802cd9a1"
integrity sha512-e4im6Byqeeit/QFHkVhVdRmgIlJJY/W06cQrOuiG/1ngO4PGnXeJqtjQjHVfvchD5Xi3y1MgQ4AtH2Bzb5LEhw==
"@budibase/pro@1.0.150":
version "1.0.150"
resolved "https://registry.yarnpkg.com/@budibase/pro/-/pro-1.0.150.tgz#06384561b67130bb2a93f0119921bd35d2be245c"
integrity sha512-Wlam8b5nhSeuNEj5Bb3ro1DKGX81mxxsjKMmxT4rbTqZrzuHSlTkxJ59IvUQqKuyp+cqfP6Rq/i4UXrhK0cg9Q==
dependencies:
"@budibase/backend-core" "1.0.147"
"@budibase/backend-core" "1.0.150"
node-fetch "^2.6.1"
"@budibase/standard-components@^0.9.139":

2
packages/worker/package.json
View file

@ -32,7 +32,7 @@
"license": "GPL-3.0",
"dependencies": {
"@budibase/backend-core": "^1.0.151",
"@budibase/pro": "1.0.151",
"@budibase/pro": "1.0.150",
"@budibase/string-templates": "^1.0.151",
"@koa/router": "^8.0.0",
"@sentry/node": "6.17.7",

18
packages/worker/yarn.lock
View file

@ -293,10 +293,10 @@
resolved "https://registry.yarnpkg.com/@bcoe/v8-coverage/-/v8-coverage-0.2.3.tgz#75a2e8b51cb758a7553d6804a5932d7aace75c39"
integrity sha512-0hYQ8SB4Db5zvZB4axdMHGwEaQjkZzFjQiN9LVYvIFB2nSUHW9tYpxWriPrWDASIxiaXax83REcLxuSdnGPZtw==
"@budibase/backend-core@1.0.147":
version "1.0.147"
resolved "https://registry.yarnpkg.com/@budibase/backend-core/-/backend-core-1.0.147.tgz#fc93a803e97e304170b33bd28b4f5deda32bec18"
integrity sha512-0GcF9G/tTAsko9g352MB8K3EtMTVb7v7Av6RdsYyKBdVtOD42HKFzSOD0n/RQUL4v70YByiu99zJAB6z1m1Pcg==
"@budibase/backend-core@1.0.150":
version "1.0.150"
resolved "https://registry.yarnpkg.com/@budibase/backend-core/-/backend-core-1.0.150.tgz#a48beb1e38f5e3e09473235fd2b7f35a05a15342"
integrity sha512-ceQVPnypKFurQMJgghky+MxtiF3x4b7rIzYhXv6Y+QfIb7IdY6wvv9o+dD3GPwNZJCRFSFizPR4YLBXdL+2+yw==
dependencies:
"@techpass/passport-openidconnect" "^0.3.0"
aws-sdk "^2.901.0"
@ -321,12 +321,12 @@
uuid "^8.3.2"
zlib "^1.0.5"
"@budibase/pro@1.0.147":
version "1.0.147"
resolved "https://registry.yarnpkg.com/@budibase/pro/-/pro-1.0.147.tgz#c1ec9d92ffaa40285a83c57ddbec1f32802cd9a1"
integrity sha512-e4im6Byqeeit/QFHkVhVdRmgIlJJY/W06cQrOuiG/1ngO4PGnXeJqtjQjHVfvchD5Xi3y1MgQ4AtH2Bzb5LEhw==
"@budibase/pro@1.0.150":
version "1.0.150"
resolved "https://registry.yarnpkg.com/@budibase/pro/-/pro-1.0.150.tgz#06384561b67130bb2a93f0119921bd35d2be245c"
integrity sha512-Wlam8b5nhSeuNEj5Bb3ro1DKGX81mxxsjKMmxT4rbTqZrzuHSlTkxJ59IvUQqKuyp+cqfP6Rq/i4UXrhK0cg9Q==
dependencies:
"@budibase/backend-core" "1.0.147"
"@budibase/backend-core" "1.0.150"
node-fetch "^2.6.1"
"@cspotcode/source-map-consumer@0.8.0":