Skip to content

Commit

Permalink
Fix flaky export test.
Browse files Browse the repository at this point in the history
  • Loading branch information
samwho committed Oct 31, 2024
1 parent df8ec41 commit 78554bd
Show file tree
Hide file tree
Showing 4 changed files with 56 additions and 15 deletions.
1 change: 1 addition & 0 deletions packages/server/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@
"content-disposition": "^0.5.4",
"cookies": "0.8.0",
"csvtojson": "2.0.10",
"csv": "6.3.10",
"curlconverter": "3.21.0",
"dd-trace": "5.2.0",
"dotenv": "8.2.0",
Expand Down
30 changes: 17 additions & 13 deletions packages/server/src/api/controllers/view/exporters.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,29 +9,33 @@ function getHeaders(
return headers.map(header => `"${customHeaders[header] || header}"`)
}

function escapeCsvString(str: string) {
return str.replace(/"/g, '""')
}

export function csv(
headers: string[],
rows: Row[],
delimiter: string = ",",
customHeaders: { [key: string]: string } = {}
) {
let csv = getHeaders(headers, customHeaders).join(delimiter)
let csvRows = [getHeaders(headers, customHeaders)]

for (let row of rows) {
csv = `${csv}\n${headers
.map(header => {
let val = row[header]
val =
typeof val === "object" && !(val instanceof Date)
? `"${JSON.stringify(val).replace(/"/g, "'")}"`
: val !== undefined
? `"${val}"`
: ""
return val.trim()
csvRows.push(
headers.map(header => {
const val = row[header]
if (typeof val === "object" && !(val instanceof Date)) {
return `"${JSON.stringify(val).replace(/"/g, "'")}"`
}
if (val !== undefined) {
return `"${escapeCsvString(val.toString())}"`
}
return ""
})
.join(delimiter)}`
)
}
return csv
return csvRows.map(row => row.join(delimiter)).join("\n")
}

export function json(rows: Row[]) {
Expand Down
34 changes: 34 additions & 0 deletions packages/server/src/api/routes/tests/row.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2597,6 +2597,40 @@ describe.each([
})
})

it("can handle csv-special characters in strings", async () => {
const badString = 'test":, wow", "test": "wow"'
const table = await config.api.table.save(
saveTableRequest({
schema: {
string: {
type: FieldType.STRING,
name: "string",
},
},
})
)

await config.api.row.save(table._id!, { string: badString })

const exportedValue = await config.api.row.exportRows(
table._id!,
{ query: {} },
RowExportFormat.CSV
)

const json = await config.api.table.csvToJson(
{
csvString: exportedValue,
},
{
status: 200,
}
)

expect(json).toHaveLength(1)
expect(json[0].string).toEqual(badString)
})

it("exported data can be re-imported", async () => {
// export all
const exportedValue = await config.api.row.exportRows(
Expand Down
6 changes: 4 additions & 2 deletions packages/server/src/utilities/csv.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@ export async function jsonFromCsvString(csvString: string) {
csvString
)

// By default the csvtojson library casts empty values as empty strings. This is causing issues on conversion.
// ignoreEmpty will remove the key completly if empty, so creating this empty object will ensure we return the values with the keys but empty values
// By default the csvtojson library casts empty values as empty strings. This
// is causing issues on conversion. ignoreEmpty will remove the key completly
// if empty, so creating this empty object will ensure we return the values
// with the keys but empty values
const result = await csv({ ignoreEmpty: false }).fromString(csvString)
result.forEach((r, i) => {
for (const [key] of Object.entries(r).filter(([, value]) => value === "")) {
Expand Down

0 comments on commit 78554bd

Please sign in to comment.