refactor and add logging

* move header preparation (export) and file name checks (import) to service layer
* calculate and log the duration of imports and exports

Author: goekay

src/main/java/de/rwth/idsg/steve/service/DataImportExportService.java

@@ -18,14 +18,18 @@
  */
 package de.rwth.idsg.steve.service;
 
+import de.rwth.idsg.steve.SteveException;
 import de.rwth.idsg.steve.repository.DataImportExportRepository;
 import de.rwth.idsg.steve.web.dto.DataExportForm.ExportType;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.lang3.StringUtils;
 import org.jooq.Named;
 import org.jooq.Table;
 import org.springframework.stereotype.Service;
+import org.springframework.web.multipart.MultipartFile;
 
+import jakarta.servlet.http.HttpServletResponse;
 import java.io.FilterInputStream;
 import java.io.IOException;
 import java.io.InputStream;
@@ -34,6 +38,7 @@
 import java.nio.charset.StandardCharsets;
 import java.util.Collection;
 import java.util.List;
+import java.util.concurrent.TimeUnit;
 import java.util.stream.Stream;
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipInputStream;
@@ -115,7 +120,37 @@ public List<String> getMasterDataTableNames() {
         return MASTER_DATA_TABLES.stream().map(Named::getName).toList();
     }
 
-    public void exportZip(OutputStream out, ExportType exportType) throws IOException {
+    public void exportZip(HttpServletResponse response, ExportType exportType) throws IOException {
+        String fileName = "data-export_" + System.currentTimeMillis() + ".zip";
+        String headerKey = "Content-Disposition";
+        String headerValue = "attachment; filename=\"%s\"".formatted(fileName);
+        response.setHeader(headerKey, headerValue);
+        response.setContentType("application/zip");
+
+        exportZip(response.getOutputStream(), exportType);
+    }
+
+    public void importZip(MultipartFile file) throws IOException {
+        if (file.isEmpty()) {
+            throw new SteveException.BadRequest("File is empty");
+        }
+
+        String fileName = file.getOriginalFilename();
+
+        if (StringUtils.isEmpty(fileName)) {
+            throw new SteveException.BadRequest("File name is empty");
+        }
+
+        if (!fileName.endsWith(".zip")) {
+            throw new SteveException.BadRequest("File must be a ZIP archive");
+        }
+
+        importZip(file.getInputStream());
+    }
+
+    private void exportZip(OutputStream out, ExportType exportType) throws IOException {
+        long start = System.currentTimeMillis();
+
         try (ZipOutputStream zipOut = new ZipOutputStream(out);
              OutputStreamWriter writer = new OutputStreamWriter(zipOut, StandardCharsets.UTF_8)) {
 
@@ -136,10 +171,17 @@ public void exportZip(OutputStream out, ExportType exportType) throws IOExceptio
                 }
             }
             zipOut.finish();
+
+        } finally {
+            long stop = System.currentTimeMillis();
+            long durationSeconds = TimeUnit.MILLISECONDS.toSeconds(stop - start);
+            log.info("Data export finished in {} seconds.", durationSeconds);
         }
     }
 
-    public void importZip(InputStream in) throws IOException {
+    private void importZip(InputStream in) throws IOException {
+        long start = System.currentTimeMillis();
+
         dataImportExportRepository.beforeImport();
 
         try (ZipInputStream zipIn = new ZipInputStream(in)) {
@@ -170,6 +212,10 @@ public void close() throws IOException {
             }
         } finally {
             dataImportExportRepository.afterImport();
+
+            long stop = System.currentTimeMillis();
+            long durationSeconds = TimeUnit.MILLISECONDS.toSeconds(stop - start);
+            log.info("Data import finished in {} seconds.", durationSeconds);
         }
     }
 

src/main/java/de/rwth/idsg/steve/web/controller/AboutSettingsController.java

@@ -19,7 +19,6 @@
 package de.rwth.idsg.steve.web.controller;
 
 import de.rwth.idsg.steve.NotificationFeature;
-import de.rwth.idsg.steve.SteveException;
 import de.rwth.idsg.steve.config.SteveProperties;
 import de.rwth.idsg.steve.repository.GenericRepository;
 import de.rwth.idsg.steve.repository.SettingsRepository;
@@ -30,7 +29,6 @@
 import de.rwth.idsg.steve.web.dto.EndpointInfo;
 import de.rwth.idsg.steve.web.dto.SettingsForm;
 import lombok.RequiredArgsConstructor;
-import org.apache.commons.lang3.StringUtils;
 import org.joda.time.DateTime;
 import org.joda.time.DateTimeZone;
 import org.springframework.http.HttpHeaders;
@@ -134,32 +132,12 @@ public String testMail(@Valid @ModelAttribute("settingsForm") SettingsForm setti
     @GetMapping(value = ABOUT_PATH + "/export")
     public void exportZip(@ModelAttribute("exportForm") DataExportForm exportForm,
                           HttpServletResponse response) throws IOException {
-        String fileName = "data-export_" + System.currentTimeMillis() + ".zip";
-        String headerKey = "Content-Disposition";
-        String headerValue = "attachment; filename=\"%s\"".formatted(fileName);
-        response.setHeader(headerKey, headerValue);
-        response.setContentType("application/zip");
-
-        dataImportExportService.exportZip(response.getOutputStream(), exportForm.getExportType());
+        dataImportExportService.exportZip(response, exportForm.getExportType());
     }
 
     @PostMapping(value = ABOUT_PATH + "/import")
     public String importZip(@RequestParam("file") MultipartFile file, Model model) throws IOException {
-        if (file.isEmpty()) {
-            throw new SteveException.BadRequest("File is empty");
-        }
-
-        String fileName = file.getOriginalFilename();
-
-        if (StringUtils.isEmpty(fileName)) {
-            throw new SteveException.BadRequest("File name is empty");
-        }
-
-        if (!fileName.endsWith(".zip")) {
-            throw new SteveException.BadRequest("File must be a ZIP archive");
-        }
-
-        dataImportExportService.importZip(file.getInputStream());
+        dataImportExportService.importZip(file);
         return "redirect:/manager/home";
     }
 }