allow pass customized filename for exporting csv

kuzzleio · Oct 27, 2024 · 3920f6b · 3920f6b
1 parent be8cfc4
commit 3920f6b
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 1 deletion.
diff --git a/lib/modules/device/DevicesController.ts b/lib/modules/device/DevicesController.ts
@@ -514,14 +514,15 @@ export class DevicesController {
         const exportId = request.getString("exportId");
 
         const { id } = await this.measureExporter.getExport(engineId, exportId);
+        const filename = request.getString("filename") || `device-${id}.csv`;
         const stream = await this.measureExporter.sendExport(
           engineId,
           exportId,
         );
 
         request.response.configure({
           headers: {
-            "Content-Disposition": `attachment; filename="device-${id}.csv"`,
+            "Content-Disposition": `attachment; filename="${filename}"`,
             "Content-Type": "text/csv",
           },
         });

diff --git a/lib/modules/device/types/DeviceApi.ts b/lib/modules/device/types/DeviceApi.ts
@@ -245,6 +245,8 @@ export interface ApiDeviceExportMeasuresRequest
     query?: JSONObject;
     sort?: JSONObject;
   };
+
+  filename?: string;
 }
 export type ApiDeviceExportMeasuresResult = {
   link: string;

diff --git a/tests/scenario/modules/devices/action-export-measures.test.ts b/tests/scenario/modules/devices/action-export-measures.test.ts
@@ -209,4 +209,51 @@ describe("DevicesController:exportMeasures", () => {
       "Measure Id,Measured At,Measured At ISO,Measure Type,Device Id,Device Model,Asset Id,Asset Model,temperature.temperature,accelerationSensor.acceleration.x,accelerationSensor.acceleration.y,accelerationSensor.acceleration.z,accelerationSensor.accuracy,battery.battery\n",
     );
   });
+
+  it("should export a file with a customized filename", async () => {
+    const filename = "my-customized-filename.csv";
+    await sendPayloads(sdk, "dummy-temp", [
+      { deviceEUI: "linked1", temperature: 37 },
+    ]);
+    await sdk.collection.refresh("engine-ayse", "measures");
+
+    const { result } = await sdk.query<ApiDeviceExportMeasuresRequest>({
+      controller: "device-manager/devices",
+      action: "exportMeasures",
+      engineId: "engine-ayse",
+      _id: "DummyTemp-linked1",
+      lang: "koncorde",
+      filename,
+    });
+
+    const response = await axios.get("http://localhost:7512" + result.link, {
+      responseType: "stream",
+    });
+
+    expect(response.headers).toHaveProperty(
+      "Content-Disposition",
+      `attachment; filename="${filename}"`,
+    );
+  });
+
+  it("should export a file with a default filename", async () => {
+    await sendPayloads(sdk, "dummy-temp", [
+      { deviceEUI: "linked1", temperature: 37 },
+    ]);
+    await sdk.collection.refresh("engine-ayse", "measures");
+
+    const { result } = await sdk.query<ApiDeviceExportMeasuresRequest>({
+      controller: "device-manager/devices",
+      action: "exportMeasures",
+      engineId: "engine-ayse",
+      _id: "DummyTemp-linked1",
+      lang: "koncorde",
+    });
+
+    const response = await axios.get("http://localhost:7512" + result.link, {
+      responseType: "stream",
+    });
+
+    expect(response.headers).toHaveProperty("Content-Disposition");
+  });
 });