Skip to content

Commit

Permalink
Merge pull request Budibase#14503 from Budibase/BUDI-8564/support-upd…
Browse files Browse the repository at this point in the history 
…ating-names

Support updating names
  • Loading branch information
@adrinr
adrinr authored Sep 3, 2024
2 parents 773b4f1 + 52283e0 commit ff12600
Show file tree
Hide file tree
Showing 3 changed files with 309 additions and 0 deletions.
3 changes: 3 additions & 0 deletions packages/server/src/api/controllers/table/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,9 @@ export async function save(ctx: UserCtx<SaveTableRequest, SaveTableResponse>) {
} else {
await events.table.updated(savedTable)
}
if (renaming) {
await sdk.views.renameLinkedViews(savedTable, renaming)
}
if (isImport) {
await events.table.imported(savedTable)
}
Expand Down
261 changes: 261 additions & 0 deletions packages/server/src/api/routes/tests/viewV2.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ import {
ViewV2,
SearchResponse,
BasicOperator,
RelationshipType,
TableSchema,
ViewFieldMetadata,
RenameColumn,
} from "@budibase/types"
import { generator, mocks } from "@budibase/backend-core/tests"
import { DatabaseName, getDatasource } from "../../../integrations/tests/utils"
Expand Down Expand Up @@ -1177,6 +1181,263 @@ describe.each([
)
})
})

describe("foreign relationship columns", () => {
const createAuxTable = () =>
config.api.table.save(
saveTableRequest({
primaryDisplay: "name",
schema: {
name: { name: "name", type: FieldType.STRING },
age: { name: "age", type: FieldType.NUMBER },
},
})
)

const createMainTable = async (
links: {
name: string
tableId: string
fk: string
}[]
) => {
const table = await config.api.table.save(
saveTableRequest({
schema: {},
})
)
await config.api.table.save({
...table,
schema: {
...table.schema,
...links.reduce<TableSchema>((acc, c) => {
acc[c.name] = {
name: c.name,
relationshipType: RelationshipType.ONE_TO_MANY,
type: FieldType.LINK,
tableId: c.tableId,
fieldName: c.fk,
constraints: { type: "array" },
}
return acc
}, {}),
},
})
return table
}

const createView = async (
tableId: string,
schema: Record<string, ViewFieldMetadata>
) =>
await config.api.viewV2.create({
name: generator.guid(),
tableId,
schema,
})

const renameColumn = async (table: Table, renaming: RenameColumn) => {
const newSchema = { ...table.schema }
newSchema[renaming.updated] = {
...table.schema[renaming.old],
name: renaming.updated,
}
delete newSchema[renaming.old]

await config.api.table.save({
...table,
schema: newSchema,
_rename: renaming,
})
}

it("updating a column will update link columns configuration", async () => {
let auxTable = await createAuxTable()

const table = await createMainTable([
{ name: "aux", tableId: auxTable._id!, fk: "fk_aux" },
])
// Refetch auxTable
auxTable = await config.api.table.get(auxTable._id!)

const view = await createView(table._id!, {
aux: {
visible: true,
columns: {
name: { visible: true, readonly: true },
age: { visible: true, readonly: true },
},
},
})

await renameColumn(auxTable, { old: "age", updated: "dob" })

const updatedView = await config.api.viewV2.get(view.id)
expect(updatedView).toEqual(
expect.objectContaining({
schema: expect.objectContaining({
aux: expect.objectContaining({
columns: {
id: { visible: false, readonly: false },
name: { visible: true, readonly: true },
dob: { visible: true, readonly: true },
},
}),
}),
})
)
})

it("handles multiple fields using the same table", async () => {
let auxTable = await createAuxTable()

const table = await createMainTable([
{ name: "aux", tableId: auxTable._id!, fk: "fk_aux" },
{ name: "aux2", tableId: auxTable._id!, fk: "fk_aux2" },
])
// Refetch auxTable
auxTable = await config.api.table.get(auxTable._id!)

const view = await createView(table._id!, {
aux: {
visible: true,
columns: {
name: { visible: true, readonly: true },
age: { visible: true, readonly: true },
},
},
aux2: {
visible: true,
columns: {
name: { visible: true, readonly: true },
age: { visible: true, readonly: true },
},
},
})

await renameColumn(auxTable, { old: "age", updated: "dob" })

const updatedView = await config.api.viewV2.get(view.id)
expect(updatedView).toEqual(
expect.objectContaining({
schema: expect.objectContaining({
aux: expect.objectContaining({
columns: {
id: { visible: false, readonly: false },
name: { visible: true, readonly: true },
dob: { visible: true, readonly: true },
},
}),
aux2: expect.objectContaining({
columns: {
id: { visible: false, readonly: false },
name: { visible: true, readonly: true },
dob: { visible: true, readonly: true },
},
}),
}),
})
)
})

it("does not rename columns with the same name but from other tables", async () => {
let auxTable = await createAuxTable()
let aux2Table = await createAuxTable()

const table = await createMainTable([
{ name: "aux", tableId: auxTable._id!, fk: "fk_aux" },
{ name: "aux2", tableId: aux2Table._id!, fk: "fk_aux2" },
])

// Refetch auxTable
auxTable = await config.api.table.get(auxTable._id!)

const view = await createView(table._id!, {
aux: {
visible: true,
columns: {
name: { visible: true, readonly: true },
},
},
aux2: {
visible: true,
columns: {
name: { visible: true, readonly: true },
},
},
})

await renameColumn(auxTable, { old: "name", updated: "fullName" })

const updatedView = await config.api.viewV2.get(view.id)
expect(updatedView).toEqual(
expect.objectContaining({
schema: expect.objectContaining({
aux: expect.objectContaining({
columns: {
id: { visible: false, readonly: false },
fullName: { visible: true, readonly: true },
age: { visible: false, readonly: false },
},
}),
aux2: expect.objectContaining({
columns: {
id: { visible: false, readonly: false },
name: { visible: true, readonly: true },
age: { visible: false, readonly: false },
},
}),
}),
})
)
})

it("updates all views references", async () => {
let auxTable = await createAuxTable()

const table1 = await createMainTable([
{ name: "aux", tableId: auxTable._id!, fk: "fk_aux_table1" },
])
const table2 = await createMainTable([
{ name: "aux", tableId: auxTable._id!, fk: "fk_aux_table2" },
])

// Refetch auxTable
auxTable = await config.api.table.get(auxTable._id!)

const viewSchema = {
aux: {
visible: true,
columns: {
name: { visible: true, readonly: true },
age: { visible: true, readonly: true },
},
},
}
const view1 = await createView(table1._id!, viewSchema)
const view2 = await createView(table1._id!, viewSchema)
const view3 = await createView(table2._id!, viewSchema)

await renameColumn(auxTable, { old: "age", updated: "dob" })

for (const view of [view1, view2, view3]) {
const updatedView = await config.api.viewV2.get(view.id)
expect(updatedView).toEqual(
expect.objectContaining({
schema: expect.objectContaining({
aux: expect.objectContaining({
columns: {
id: { visible: false, readonly: false },
name: { visible: true, readonly: true },
dob: { visible: true, readonly: true },
},
}),
}),
})
)
}
})
})
})
})

Expand Down
45 changes: 45 additions & 0 deletions packages/server/src/sdk/app/views/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -252,3 +252,48 @@ export function syncSchema(

return view
}

export async function renameLinkedViews(table: Table, renaming: RenameColumn) {
const relatedTables: Record<string, Table> = {}

for (const field of Object.values(table.schema)) {
if (field.type !== FieldType.LINK) {
continue
}

relatedTables[field.tableId] ??= await sdk.tables.getTable(field.tableId)
}

for (const relatedTable of Object.values(relatedTables)) {
let toSave = false
const viewsV2 = Object.values(relatedTable.views || {}).filter(
sdk.views.isV2
)
if (!viewsV2) {
continue
}

for (const view of viewsV2) {
for (const relField of Object.keys(view.schema || {}).filter(f => {
const tableField = relatedTable.schema[f]
if (!tableField || tableField.type !== FieldType.LINK) {
return false
}

return tableField.tableId === table._id
})) {
const columns = view.schema?.[relField]?.columns

if (columns && columns[renaming.old]) {
columns[renaming.updated] = columns[renaming.old]
delete columns[renaming.old]
toSave = true
}
}
}

if (toSave) {
await sdk.tables.saveTable(relatedTable)
}
}
}

0 comments on commit ff12600

Please sign in to comment.