Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Trim couchdb fields while exporting rows #14289

Merged
merged 5 commits into from
Aug 1, 2024
Merged

Trim couchdb fields while exporting rows #14289

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
62fa05a
Type
adrinr Jul 31, 2024
fe2b2bb
Don't export couchdb fields
adrinr Jul 31, 2024
95b1807
Merge branch 'master' into fix/import-column-issues
adrinr Jul 31, 2024
543d0e1
Add tests
adrinr Jul 31, 2024
3128501
Merge branch 'master' into fix/import-column-issues
adrinr Aug 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 29 additions & 14 deletions packages/server/src/api/routes/tests/row.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1640,23 +1640,38 @@ describe.each([
table = await config.api.table.save(defaultTable())
})

it("should allow exporting all columns", async () => {
const existing = await config.api.row.save(table._id!, {})
const res = await config.api.row.exportRows(table._id!, {
rows: [existing._id!],
isInternal &&
it("should not export internal couchdb fields", async () => {
const existing = await config.api.row.save(table._id!, {
name: generator.guid(),
description: generator.paragraph(),
})
const res = await config.api.row.exportRows(table._id!, {
rows: [existing._id!],
})
const results = JSON.parse(res)
expect(results.length).toEqual(1)
const row = results[0]

expect(Object.keys(row)).toEqual(["_id", "name", "description"])
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does the order matter here? Is Object.keys guaranteed to return the keys in that order? Will the test fail if it changes?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It matters for the test, but this should not change. It exports by the schema order, so changing the implementation might cause some errors.

})
const results = JSON.parse(res)
expect(results.length).toEqual(1)
const row = results[0]

// Ensure all original columns were exported
expect(Object.keys(row).length).toBeGreaterThanOrEqual(
Object.keys(existing).length
)
Object.keys(existing).forEach(key => {
expect(row[key]).toEqual(existing[key])
!isInternal &&
it("should allow exporting all columns", async () => {
const existing = await config.api.row.save(table._id!, {})
const res = await config.api.row.exportRows(table._id!, {
rows: [existing._id!],
})
const results = JSON.parse(res)
expect(results.length).toEqual(1)
const row = results[0]

// Ensure all original columns were exported
expect(Object.keys(row).length).toBe(Object.keys(existing).length)
Object.keys(existing).forEach(key => {
expect(row[key]).toEqual(existing[key])
})
})
})

it("should allow exporting only certain columns", async () => {
const existing = await config.api.row.save(table._id!, {})
Expand Down
14 changes: 14 additions & 0 deletions packages/server/src/sdk/app/rows/search/internal.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import {
SearchResponse,
SortType,
Table,
TableSchema,
User,
} from "@budibase/types"
import { getGlobalUsersFromMetadata } from "../../../../utilities/global"
Expand Down Expand Up @@ -137,6 +138,9 @@ export async function exportRows(
let rows: Row[] = []
let schema = table.schema
let headers

result = trimFields(result, schema)

// Filter data to only specified columns if required
if (columns && columns.length) {
for (let i = 0; i < result.length; i++) {
Expand Down Expand Up @@ -299,3 +303,13 @@ async function getView(db: Database, viewName: string) {
}
return viewInfo
}

function trimFields(rows: Row[], schema: TableSchema) {
const allowedFields = ["_id", ...Object.keys(schema)]
const result = rows.map(row =>
Object.keys(row)
.filter(key => allowedFields.includes(key))
.reduce((acc, key) => ({ ...acc, [key]: row[key] }), {} as Row)
)
return result
}
2 changes: 1 addition & 1 deletion packages/server/src/sdk/app/rows/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ export async function getDatasourceAndQuery(
}

export function cleanExportRows(
rows: any[],
rows: Row[],
schema: TableSchema,
format: string,
columns?: string[],
Expand Down
Loading