fix: export error when table name contain special character

teableio · May 11, 2024 · 18af4ae · 18af4ae
1 parent 54ec068
commit 18af4ae
Show file tree

Hide file tree

Showing 2 changed files with 127 additions and 5 deletions.
diff --git a/apps/nestjs-backend/src/features/export/open-api/export-open-api.service.ts b/apps/nestjs-backend/src/features/export/open-api/export-open-api.service.ts
@@ -33,11 +33,10 @@ export class ExportOpenApiService {
         throw new BadRequestException('table is not found');
       });
 
+    const fileName = tableRaw?.name ? encodeURIComponent(tableRaw?.name) : 'export';
+
     response.setHeader('Content-Type', 'text/csv');
-    response.setHeader(
-      'Content-Disposition',
-      `attachment; filename=${tableRaw?.name || 'export'}.csv`
-    );
+    response.setHeader('Content-Disposition', `attachment; filename=${fileName}.csv`);
 
     csvStream.pipe(response);
 

diff --git a/apps/nestjs-backend/test/table-export.e2e-spec.ts b/apps/nestjs-backend/test/table-export.e2e-spec.ts
@@ -242,7 +242,130 @@ describe('/export/${tableId} OpenAPI ExportController (e2e) Get csv stream from
     await apiDeleteTable(baseId, mainTable.data.id);
     await apiDeleteTable(baseId, subTable.data.id);
 
-    expect(disposition).toBe(`attachment; filename=${mainTable.data.name}.csv`);
+    expect(disposition).toBe(`attachment; filename=${encodeURIComponent(mainTable.data.name)}.csv`);
+    expect(contentType).toBe('text/csv');
+    expect(csvData).toBe(
+      `Text field,Number field,Checkbox field,Select field,Date field,Attachment field,User Field,Link field,Link field from lookups sub_Name,Link field from lookups sub_Number,Link field from lookups sub_Checkbox,Link field from lookups sub_SingleSelect\r\ntxt1,1,true,x,2022-11-28T16:00:00.000Z,test.txt ${txtFileData.presignedUrl},,Name1,Name1,1,true,sub_y\r\ntxt2,,,y,2022-11-28T16:00:00.000Z,,test,,,,,\r\n,,true,z,,,,,,,,`
+    );
+  });
+
+  it(`should return a csv stream from table with special character table name`, async () => {
+    const mainTable = await apiCreateTable(baseId, {
+      name: '测试😄',
+      fields: [
+        {
+          type: FieldType.SingleLineText,
+          name: 'Text field',
+        },
+      ],
+      records: [],
+    });
+
+    for (let i = 0; i < mainFields.length; i++) {
+      await apiCreateField(mainTable.data.id, mainFields[i]);
+    }
+
+    const subTable = await apiCreateTable(baseId, {
+      name: 'subTable',
+      fields: subFields,
+      records: [
+        {
+          fields: {
+            ['sub_Name']: 'Name1',
+            ['sub_Number']: 1,
+            ['sub_Checkbox']: true,
+            ['sub_SingleSelect']: 'sub_y',
+          },
+        },
+        {
+          fields: {
+            ['sub_Name']: 'Name2',
+            ['sub_Number']: 2,
+            ['sub_Checkbox']: true,
+            ['sub_SingleSelect']: 'sub_x',
+          },
+        },
+        {
+          fields: {
+            ['sub_Name']: 'Name3',
+            ['sub_Number']: 3,
+          },
+        },
+      ],
+    });
+
+    const {
+      data: { id: linkFieldId },
+    } = await apiCreateField(mainTable.data.id, {
+      type: FieldType.Link,
+      name: 'Link field',
+      options: {
+        relationship: Relationship.ManyMany,
+        foreignTableId: subTable.data.id,
+        isOneWay: false,
+      },
+    });
+
+    for (let i = 0; i < subFields.length; i++) {
+      const { name, type } = subFields[i];
+      await apiCreateField(mainTable.data.id, {
+        name: `Link field from lookups ${name}`,
+        type: type,
+        isLookup: true,
+        lookupOptions: {
+          foreignTableId: subTable.data.id,
+          lookupFieldId: subTable.data.fields[i].id,
+          linkFieldId: linkFieldId,
+        },
+      });
+    }
+
+    await apiCreateRecords(mainTable.data.id, {
+      records: [
+        {
+          fields: {
+            ['Attachment field']: [{ ...txtFileData, id: 'actxxxxxx', name: 'test.txt' }],
+            ['Date field']: '2022-11-28T16:00:00.000Z',
+            ['Text field']: 'txt1',
+            ['Number field']: 1,
+            ['Checkbox field']: true,
+            ['Select field']: 'x',
+            ['Link field']: [
+              {
+                id: subTable.data.records[0].id,
+              },
+            ],
+          },
+        },
+        {
+          fields: {
+            ['Date field']: '2022-11-28T16:00:00.000Z',
+            ['Text field']: 'txt2',
+            ['Select field']: 'y',
+            ['User Field']: {
+              title: 'test',
+              id: userId,
+            },
+          },
+        },
+        {
+          fields: {
+            ['Select field']: 'z',
+            ['Checkbox field']: true,
+          },
+        },
+      ],
+    });
+
+    const exportRes = await apiExportCsvFromTable(mainTable.data.id);
+    const disposition = exportRes?.headers['content-disposition'];
+    const contentType = exportRes?.headers['content-type'];
+    const { data: csvData } = exportRes;
+
+    await apiDeleteTable(baseId, mainTable.data.id);
+    await apiDeleteTable(baseId, subTable.data.id);
+
+    expect(disposition).toBe(`attachment; filename=${encodeURIComponent(mainTable.data.name)}.csv`);
     expect(contentType).toBe('text/csv');
     expect(csvData).toBe(
       `Text field,Number field,Checkbox field,Select field,Date field,Attachment field,User Field,Link field,Link field from lookups sub_Name,Link field from lookups sub_Number,Link field from lookups sub_Checkbox,Link field from lookups sub_SingleSelect\r\ntxt1,1,true,x,2022-11-28T16:00:00.000Z,test.txt ${txtFileData.presignedUrl},,Name1,Name1,1,true,sub_y\r\ntxt2,,,y,2022-11-28T16:00:00.000Z,,test,,,,,\r\n,,true,z,,,,,,,,`