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

Merge pull request #11615 from Budibase/BUDI-7189/views_on_plus_ds

Browse source 
Support views on plus datasources
This commit is contained in:
Adria Navarro 2023-08-30 00:51:45 +02:00 committed by GitHub
parent 8269dc98cd 8e4138f50d
commit f47a2c3016
5 changed files with 242 additions and 102 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
packages/server/src/api/controllers/datasource.ts
View file

@ -17,7 +17,6 @@ import {
FetchDatasourceInfoRequest,
FetchDatasourceInfoResponse,
IntegrationBase,
RestConfig,
SourceName,
UpdateDatasourceResponse,
UserCtx,
@ -27,7 +26,6 @@ import {
import sdk from "../../sdk"
import { builderSocket } from "../../websockets"
import { setupCreationAuth as googleSetupCreationAuth } from "../../integrations/googlesheets"
import { areRESTVariablesValid } from "../../sdk/app/datasources/datasources"
function getErrorTables(errors: any, errorType: string) {
return Object.entries(errors)

108
packages/server/src/api/routes/tests/viewV2.spec.ts
View file

@ -10,6 +10,7 @@ import {
ViewV2,
} from "@budibase/types"
import { generator } from "@budibase/backend-core/tests"
import { generateDatasourceID } from "../../../db/utils"
function priceTable(): Table {
return {
@ -32,27 +33,52 @@ function priceTable(): Table {
}
}
describe("/v2/views", () => {
const config = setup.getConfig()
const config = setup.getConfig()
afterAll(setup.afterAll)
beforeAll(async () => {
await config.init()
})
describe.each([
["internal ds", () => config.createTable(priceTable())],
[
"external ds",
async () => {
const datasource = await config.createDatasource({
datasource: {
...setup.structures.basicDatasource().datasource,
plus: true,
_id: generateDatasourceID({ plus: true }),
},
})
return config.createTable({
...priceTable(),
sourceId: datasource._id,
type: "external",
})
},
],
])("/v2/views (%s)", (_, tableBuilder) => {
let table: Table
beforeAll(async () => {
await config.init()
await config.createTable(priceTable())
table = await tableBuilder()
})
afterAll(setup.afterAll)
describe("create", () => {
it("persist the view when the view is successfully created", async () => {
const newView: CreateViewRequest = {
name: generator.name(),
tableId: config.table!._id!,
tableId: table._id!,
}
const res = await config.api.viewV2.create(newView)
expect(res).toEqual({
...newView,
id: expect.stringMatching(new RegExp(`${config.table?._id!}_`)),
id: expect.stringMatching(new RegExp(`${table._id!}_`)),
version: 2,
})
})
@ -60,7 +86,7 @@ describe("/v2/views", () => {
it("can persist views with all fields", async () => {
const newView: Required<CreateViewRequest> = {
name: generator.name(),
tableId: config.table!._id!,
tableId: table._id!,
primaryDisplay: generator.word(),
query: [{ operator: "equal", field: "field", value: "value" }],
sort: {
@ -87,7 +113,7 @@ describe("/v2/views", () => {
it("persist only UI schema overrides", async () => {
const newView: CreateViewRequest = {
name: generator.name(),
tableId: config.table!._id!,
tableId: table._id!,
schema: {
Price: {
name: "Price",
@ -124,7 +150,7 @@ describe("/v2/views", () => {
it("will not throw an exception if the schema is 'deleting' non UI fields", async () => {
const newView: CreateViewRequest = {
name: generator.name(),
tableId: config.table!._id!,
tableId: table._id!,
schema: {
Price: {
name: "Price",
@ -148,35 +174,29 @@ describe("/v2/views", () => {
let view: ViewV2
beforeEach(async () => {
await config.createTable(priceTable())
table = await tableBuilder()
view = await config.api.viewV2.create({ name: "View A" })
})
it("can update an existing view data", async () => {
const tableId = config.table!._id!
const tableId = table._id!
await config.api.viewV2.update({
...view,
query: [{ operator: "equal", field: "newField", value: "thatValue" }],
})
expect(await config.api.table.get(tableId)).toEqual({
...config.table,
views: {
[view.name]: {
...view,
query: [
{ operator: "equal", field: "newField", value: "thatValue" },
],
schema: expect.anything(),
},
expect((await config.api.table.get(tableId)).views).toEqual({
[view.name]: {
...view,
query: [{ operator: "equal", field: "newField", value: "thatValue" }],
schema: expect.anything(),
},
_rev: expect.any(String),
updatedAt: expect.any(String),
})
})
it("can update all fields", async () => {
const tableId = config.table!._id!
const tableId = table._id!
const updatedData: Required<UpdateViewRequest> = {
version: view.version,
@ -204,29 +224,24 @@ describe("/v2/views", () => {
}
await config.api.viewV2.update(updatedData)
expect(await config.api.table.get(tableId)).toEqual({
...config.table,
views: {
[view.name]: {
...updatedData,
schema: {
...config.table!.schema,
Category: expect.objectContaining({
visible: false,
}),
Price: expect.objectContaining({
visible: false,
}),
},
expect((await config.api.table.get(tableId)).views).toEqual({
[view.name]: {
...updatedData,
schema: {
...table.schema,
Category: expect.objectContaining({
visible: false,
}),
Price: expect.objectContaining({
visible: false,
}),
},
},
_rev: expect.any(String),
updatedAt: expect.any(String),
})
})
it("can update an existing view name", async () => {
const tableId = config.table!._id!
const tableId = table._id!
await config.api.viewV2.update({ ...view, name: "View B" })
expect(await config.api.table.get(tableId)).toEqual(
@ -239,7 +254,7 @@ describe("/v2/views", () => {
})
it("cannot update an unexisting views nor edit ids", async () => {
const tableId = config.table!._id!
const tableId = table._id!
await config.api.viewV2.update(
{ ...view, id: generator.guid() },
{ expectStatus: 404 }
@ -258,7 +273,7 @@ describe("/v2/views", () => {
})
it("cannot update views with the wrong tableId", async () => {
const tableId = config.table!._id!
const tableId = table._id!
await config.api.viewV2.update(
{
...view,
@ -374,12 +389,11 @@ describe("/v2/views", () => {
let view: ViewV2
beforeAll(async () => {
await config.createTable(priceTable())
view = await config.api.viewV2.create()
})
it("can delete an existing view", async () => {
const tableId = config.table!._id!
const tableId = table._id!
const getPersistedView = async () =>
(await config.api.table.get(tableId)).views![view.name]
@ -393,8 +407,6 @@ describe("/v2/views", () => {
describe("fetch view (through table)", () => {
it("should be able to fetch a view V2", async () => {
const table = await config.createTable(priceTable())
const newView: CreateViewRequest = {
name: generator.name(),
tableId: table._id!,

88
packages/server/src/sdk/app/views/external.ts Normal file
View file

@ -0,0 +1,88 @@
import { ViewV2 } from "@budibase/types"
import { context, HTTPError } from "@budibase/backend-core"
import sdk from "../../../sdk"
import * as utils from "../../../db/utils"
import { enrichSchema, isV2 } from "."
import { breakExternalTableId } from "../../../integrations/utils"
export async function get(
viewId: string,
opts?: { enriched: boolean }
): Promise<ViewV2> {
const { tableId } = utils.extractViewInfoFromID(viewId)
const { datasourceId, tableName } = breakExternalTableId(tableId)
const ds = await sdk.datasources.get(datasourceId!)
const table = ds.entities![tableName!]
const views = Object.values(table.views!)
const found = views.find(v => isV2(v) && v.id === viewId)
if (!found) {
throw new Error("No view found")
}
if (opts?.enriched) {
return enrichSchema(found, table.schema) as ViewV2
} else {
return found as ViewV2
}
}
export async function create(
tableId: string,
viewRequest: Omit<ViewV2, "id" | "version">
): Promise<ViewV2> {
const view: ViewV2 = {
...viewRequest,
id: utils.generateViewID(tableId),
version: 2,
}
const db = context.getAppDB()
const { datasourceId, tableName } = breakExternalTableId(tableId)
const ds = await sdk.datasources.get(datasourceId!)
ds.entities![tableName!].views ??= {}
ds.entities![tableName!].views![view.name] = view
await db.put(ds)
return view
}
export async function update(tableId: string, view: ViewV2): Promise<ViewV2> {
const db = context.getAppDB()
const { datasourceId, tableName } = breakExternalTableId(tableId)
const ds = await sdk.datasources.get(datasourceId!)
ds.entities![tableName!].views ??= {}
const views = ds.entities![tableName!].views!
const existingView = Object.values(views).find(
v => isV2(v) && v.id === view.id
)
if (!existingView) {
throw new HTTPError(`View ${view.id} not found in table ${tableId}`, 404)
}
console.log("set to", view)
delete views[existingView.name]
views[view.name] = view
await db.put(ds)
return view
}
export async function remove(viewId: string): Promise<ViewV2> {
const db = context.getAppDB()
const view = await get(viewId)
if (!view) {
throw new HTTPError(`View ${viewId} not found`, 404)
}
const { datasourceId, tableName } = breakExternalTableId(view.tableId)
const ds = await sdk.datasources.get(datasourceId!)
delete ds.entities![tableName!].views![view?.name]
await db.put(ds)
return view
}

69
packages/server/src/sdk/app/views/index.ts
View file

@ -1,64 +1,38 @@
import { RenameColumn, TableSchema, View, ViewV2 } from "@budibase/types"
import { context, db as dbCore, HTTPError } from "@budibase/backend-core"
import { db as dbCore } from "@budibase/backend-core"
import { cloneDeep } from "lodash"
import sdk from "../../../sdk"
import * as utils from "../../../db/utils"
import { isExternalTable } from "../../../integrations/utils"
import * as internal from "./internal"
import * as external from "./external"
function pickApi(tableId: any) {
if (isExternalTable(tableId)) {
return external
}
return internal
}
export async function get(
viewId: string,
opts?: { enriched: boolean }
): Promise<ViewV2> {
const { tableId } = utils.extractViewInfoFromID(viewId)
const table = await sdk.tables.getTable(tableId)
const views = Object.values(table.views!)
const found = views.find(v => isV2(v) && v.id === viewId)
if (!found) {
throw new Error("No view found")
}
if (opts?.enriched) {
return enrichSchema(found, table.schema) as ViewV2
} else {
return found as ViewV2
}
return pickApi(tableId).get(viewId, opts)
}
export async function create(
tableId: string,
viewRequest: Omit<ViewV2, "id" | "version">
): Promise<ViewV2> {
const view: ViewV2 = {
...viewRequest,
id: utils.generateViewID(tableId),
version: 2,
}
const db = context.getAppDB()
const table = await sdk.tables.getTable(tableId)
table.views ??= {}
table.views[view.name] = view
await db.put(table)
return view
return pickApi(tableId).create(tableId, viewRequest)
}
export async function update(tableId: string, view: ViewV2): Promise<ViewV2> {
const db = context.getAppDB()
const table = await sdk.tables.getTable(tableId)
table.views ??= {}
const existingView = Object.values(table.views).find(
v => isV2(v) && v.id === view.id
)
if (!existingView) {
throw new HTTPError(`View ${view.id} not found in table ${tableId}`, 404)
}
console.log("set to", view)
delete table.views[existingView.name]
table.views[view.name] = view
await db.put(table)
return view
return pickApi(tableId).update(tableId, view)
}
export function isV2(view: View | ViewV2): view is ViewV2 {
@ -66,17 +40,8 @@ export function isV2(view: View | ViewV2): view is ViewV2 {
}
export async function remove(viewId: string): Promise<ViewV2> {
const db = context.getAppDB()
const view = await get(viewId)
const table = await sdk.tables.getTable(view?.tableId)
if (!view) {
throw new HTTPError(`View ${viewId} not found`, 404)
}
delete table.views![view?.name]
await db.put(table)
return view
const { tableId } = utils.extractViewInfoFromID(viewId)
return pickApi(tableId).remove(viewId)
}
export function allowedFields(view: View | ViewV2) {

77
packages/server/src/sdk/app/views/internal.ts Normal file
View file

@ -0,0 +1,77 @@
import { ViewV2 } from "@budibase/types"
import { context, HTTPError } from "@budibase/backend-core"
import sdk from "../../../sdk"
import * as utils from "../../../db/utils"
import { enrichSchema, isV2 } from "."
export async function get(
viewId: string,
opts?: { enriched: boolean }
): Promise<ViewV2> {
const { tableId } = utils.extractViewInfoFromID(viewId)
const table = await sdk.tables.getTable(tableId)
const views = Object.values(table.views!)
const found = views.find(v => isV2(v) && v.id === viewId)
if (!found) {
throw new Error("No view found")
}
if (opts?.enriched) {
return enrichSchema(found, table.schema) as ViewV2
} else {
return found as ViewV2
}
}
export async function create(
tableId: string,
viewRequest: Omit<ViewV2, "id" | "version">
): Promise<ViewV2> {
const view: ViewV2 = {
...viewRequest,
id: utils.generateViewID(tableId),
version: 2,
}
const db = context.getAppDB()
const table = await sdk.tables.getTable(tableId)
table.views ??= {}
table.views[view.name] = view
await db.put(table)
return view
}
export async function update(tableId: string, view: ViewV2): Promise<ViewV2> {
const db = context.getAppDB()
const table = await sdk.tables.getTable(tableId)
table.views ??= {}
const existingView = Object.values(table.views).find(
v => isV2(v) && v.id === view.id
)
if (!existingView) {
throw new HTTPError(`View ${view.id} not found in table ${tableId}`, 404)
}
console.log("set to", view)
delete table.views[existingView.name]
table.views[view.name] = view
await db.put(table)
return view
}
export async function remove(viewId: string): Promise<ViewV2> {
const db = context.getAppDB()
const view = await get(viewId)
const table = await sdk.tables.getTable(view?.tableId)
if (!view) {
throw new HTTPError(`View ${viewId} not found`, 404)
}
delete table.views![view?.name]
await db.put(table)
return view
}