feat: enhance CSV export functionality with proper escaping and improved error handling

Author: SerVitasik

custom/ExportCsv.vue

@@ -4,36 +4,27 @@
 
     <svg v-if="inProgress"
       aria-hidden="true" class="w-4 h-4 text-gray-200 animate-spin dark:text-gray-600 fill-blue-600" viewBox="0 0 100 101" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M100 50.5908C100 78.2051 77.6142 100.591 50 100.591C22.3858 100.591 0 78.2051 0 50.5908C0 22.9766 22.3858 0.59082 50 0.59082C77.6142 0.59082 100 22.9766 100 50.5908ZM9.08144 50.5908C9.08144 73.1895 27.4013 91.5094 50 91.5094C72.5987 91.5094 90.9186 73.1895 90.9186 50.5908C90.9186 27.9921 72.5987 9.67226 50 9.67226C27.4013 9.67226 9.08144 27.9921 9.08144 50.5908Z" fill="currentColor"/><path d="M93.9676 39.0409C96.393 38.4038 97.8624 35.9116 97.0079 33.5539C95.2932 28.8227 92.871 24.3692 89.8167 20.348C85.8452 15.1192 80.8826 10.7238 75.2124 7.41289C69.5422 4.10194 63.2754 1.94025 56.7698 1.05124C51.7666 0.367541 46.6976 0.446843 41.7345 1.27873C39.2613 1.69328 37.813 4.19778 38.4501 6.62326C39.0873 9.04874 41.5694 10.4717 44.0505 10.1071C47.8511 9.54855 51.7191 9.52689 55.5402 10.0491C60.8642 10.7766 65.9928 12.5457 70.6331 15.2552C75.2735 17.9648 79.3347 21.5619 82.5849 25.841C84.9175 28.9121 86.7997 32.2913 88.1811 35.8758C89.083 38.2158 91.5421 39.6781 93.9676 39.0409Z" fill="currentFill"/></svg>
-        
   </div>
 </template>
 
-
 <script setup lang="ts">
-
-import { onMounted, ref } from 'vue';
+import { ref } from 'vue';
 import { useCoreStore } from '@/stores/core';
-import { callAdminForthApi, loadFile } from '@/utils';
+import { callAdminForthApi } from '@/utils';
 import { useFiltersStore } from '@/stores/filters';
 import adminforth from '@/adminforth';
-
+import Papa from 'papaparse';
 
 const filtersStore = useFiltersStore();
+const coreStore = useCoreStore();
+const inProgress = ref(false);
 
 const props = defineProps({
   meta: Object,
   record: Object,
-})
-
-const inProgress = ref(false);
-
-const coreStore = useCoreStore();
-
-
-onMounted(async () => {
 });
 
-function loadFile(data, filename) {
+function downloadFile(data: string, filename: string) {
   const blob = new Blob([data], { type: 'text/csv' });
   const url = window.URL.createObjectURL(blob);
   const a = document.createElement('a');
@@ -44,30 +35,46 @@ function loadFile(data, filename) {
 }
 
 async function exportCsv() {
-
   inProgress.value = true;
-  const resp = await callAdminForthApi({
-    path: `/plugin/${props.meta.pluginInstanceId}/export-csv`,
-    method: 'POST',
-    body: {
-      filters:  props.meta.select === 'all' ? [] : filtersStore.getFilters(),
-      sort: filtersStore.getSort(),
+  try {
+    const resp = await callAdminForthApi({
+      path: `/plugin/${props.meta.pluginInstanceId}/export-csv`,
+      method: 'POST',
+      body: {
+        filters: props.meta.select === 'all' ? [] : filtersStore.getFilters(),
+        sort: filtersStore.getSort(),
+      }
+    });
+
+    if (resp.error) {
+      throw new Error(resp.error);
     }
-  });
-  inProgress.value = false;
-  if (resp.error) {
-    adminforth.alert({
-      message: resp.error,
-    })
-  } else {
-    loadFile(resp.data, `export-${coreStore.resource.resourceId}-${new Date().toISOString()}.csv`);
+
+    // Parse the CSV data to ensure proper formatting
+    const parsedData = Papa.parse(resp.data).data;
+    
+    // Generate properly formatted CSV
+    const csvContent = '\ufeff' + Papa.unparse(parsedData, {
+      quotes: true, // Force quotes around all fields
+      quoteChar: '"',
+      escapeChar: '"',
+    });
+
+    // Download the file
+    const filename = `export-${coreStore.resource.resourceId}-${new Date().toISOString()}.csv`;
+    downloadFile(csvContent, filename);
+
     adminforth.alert({
       message: `Exported ${resp.exportedCount} item${resp.exportedCount > 1 ? 's' : ''} successfully. Check your downloads folder`,
-    })
+    });
+  } catch (error) {
+    adminforth.alert({
+      message: error instanceof Error ? error.message : 'Export failed',
+      variant: 'danger'
+    });
+  } finally {
+    inProgress.value = false;
+    adminforth.list.closeThreeDotsDropdown();
   }
-  adminforth.list.closeThreeDotsDropdown();
 }
-
-
-
 </script>

index.ts

@@ -85,20 +85,26 @@ export default class ImportExport extends AdminForthPlugin {
         });
 
         // csv export
-
         const columns = this.resourceConfig.columns.filter((col) => !col.virtual);
+        
+        const escapeCSV = (value: any) => {
+          if (value === null || value === undefined) return '""';
+          const str = String(value);
+          if (str.includes(',') || str.includes('"') || str.includes('\n')) {
+            return `"${str.replace(/"/g, '""')}"`;
+          }
+          return `"${str}"`;
+        };
+
         let csv = data.data.map((row) => {
-          return columns.map((col) => {
-            return row[col.name];
-          }).join(',');
+          return columns.map((col) => escapeCSV(row[col.name])).join(',');
         }).join('\n');
 
         // add headers
-        const headers = columns.map((col) => col.name).join(',');
+        const headers = columns.map((col) => escapeCSV(col.name)).join(',');
         csv = `${headers}\n${csv}`;
 
         return { data: csv, exportedCount: data.total, ok: true };
-
       }
     });