You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streampipes.apache.org by ho...@apache.org on 2026/10/29 10:19:09 UTC

(streampipes) branch dev updated: fix: Re-add audit log download button after merge (#5148)

This is an automated email from the ASF dual-hosted git repository.

JHoelli pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/streampipes.git


The following commit(s) were added to refs/heads/dev by this push:
     new 599db87874 fix: Re-add audit log download button after merge (#5148)
599db87874 is described below

commit 599db878749f317c43f4bbadd98f32a4b3fb9b19
Author: Dominik Riemer <do...@gmail.com>
AuthorDate: Thu Oct 29 11:19:02 2026 +0100

    fix: Re-add audit log download button after merge (#5148)
    
    Co-authored-by: Jacqueline Höllig <78...@users.noreply.github.com>
    Co-authored-by: Jacqueline Höllig <j....@gmx.net>
---
 .../streampipes/audit/api/AuditExportColumn.java   | 15 ++++++
 .../management/export/AuditCsvOutputWriter.java    | 10 +++-
 .../management/export/AuditExcelOutputWriter.java  |  5 +-
 .../management/export/AuditExportService.java      | 12 ++++-
 ...tWriter.java => AuditExportValueFormatter.java} | 22 ++++----
 .../management/export/AuditJsonOutputWriter.java   | 13 ++++-
 .../audit/management/export/AuditOutputWriter.java |  3 +-
 .../management/export/AuditExportServiceTest.java  | 60 ++++++++++++++++++++--
 streampipes-data-explorer-export/pom.xml           |  4 --
 .../audit-log/audit-log-download.spec.ts           |  8 +++
 .../audit-log/audit-log.component.html             | 13 +++--
 .../audit-log/audit-log.component.spec.ts          |  7 +++
 .../configuration/audit-log/audit-log.component.ts |  9 ++--
 .../model/audit-download-dialog.model.ts           |  4 +-
 14 files changed, 151 insertions(+), 34 deletions(-)

diff --git a/streampipes-audit-api/src/main/java/org/apache/streampipes/audit/api/AuditExportColumn.java b/streampipes-audit-api/src/main/java/org/apache/streampipes/audit/api/AuditExportColumn.java
index 7db3930d98..fb7a3d30f1 100644
--- a/streampipes-audit-api/src/main/java/org/apache/streampipes/audit/api/AuditExportColumn.java
+++ b/streampipes-audit-api/src/main/java/org/apache/streampipes/audit/api/AuditExportColumn.java
@@ -68,6 +68,17 @@ public enum AuditExportColumn {
     public String value(AuditEntry entry) {
       return entry.locator();
     }
+  },
+  DETAILS("details") {
+    @Override
+    public String value(AuditEntry entry) {
+      return null;
+    }
+
+    @Override
+    public boolean requiresDetails() {
+      return true;
+    }
   };
 
   private final String id;
@@ -87,5 +98,9 @@ public enum AuditExportColumn {
     return id;
   }
 
+  public boolean requiresDetails() {
+    return false;
+  }
+
   public abstract String value(AuditEntry entry);
 }
diff --git a/streampipes-audit-management/src/main/java/org/apache/streampipes/audit/management/export/AuditCsvOutputWriter.java b/streampipes-audit-management/src/main/java/org/apache/streampipes/audit/management/export/AuditCsvOutputWriter.java
index f38ac2eb10..d9f5b305ed 100644
--- a/streampipes-audit-management/src/main/java/org/apache/streampipes/audit/management/export/AuditCsvOutputWriter.java
+++ b/streampipes-audit-management/src/main/java/org/apache/streampipes/audit/management/export/AuditCsvOutputWriter.java
@@ -19,6 +19,7 @@
 package org.apache.streampipes.audit.management.export;
 
 import org.apache.streampipes.audit.api.AuditEntry;
+import org.apache.streampipes.audit.api.AuditEntryDetails;
 import org.apache.streampipes.audit.api.AuditExportConfiguration;
 
 import java.io.BufferedWriter;
@@ -26,6 +27,7 @@ import java.io.IOException;
 import java.io.OutputStream;
 import java.io.OutputStreamWriter;
 import java.nio.charset.StandardCharsets;
+import java.util.ArrayList;
 import java.util.List;
 
 final class AuditCsvOutputWriter implements AuditOutputWriter {
@@ -43,8 +45,12 @@ final class AuditCsvOutputWriter implements AuditOutputWriter {
   }
 
   @Override
-  public void writeItem(AuditEntry entry) throws IOException {
-    writeRow(configuration.columns().stream().map(column -> column.value(entry)).toList());
+  public void writeItem(AuditEntry entry, AuditEntryDetails details) throws IOException {
+    var values = new ArrayList<String>();
+    for (var column : configuration.columns()) {
+      values.add(AuditExportValueFormatter.format(column, entry, details));
+    }
+    writeRow(values);
   }
 
   @Override
diff --git a/streampipes-audit-management/src/main/java/org/apache/streampipes/audit/management/export/AuditExcelOutputWriter.java b/streampipes-audit-management/src/main/java/org/apache/streampipes/audit/management/export/AuditExcelOutputWriter.java
index d2149da67b..4c1db13f4e 100644
--- a/streampipes-audit-management/src/main/java/org/apache/streampipes/audit/management/export/AuditExcelOutputWriter.java
+++ b/streampipes-audit-management/src/main/java/org/apache/streampipes/audit/management/export/AuditExcelOutputWriter.java
@@ -19,6 +19,7 @@
 package org.apache.streampipes.audit.management.export;
 
 import org.apache.streampipes.audit.api.AuditEntry;
+import org.apache.streampipes.audit.api.AuditEntryDetails;
 import org.apache.streampipes.audit.api.AuditExportConfiguration;
 
 import org.apache.poi.ss.usermodel.Sheet;
@@ -49,10 +50,10 @@ final class AuditExcelOutputWriter implements AuditOutputWriter {
   }
 
   @Override
-  public void writeItem(AuditEntry entry) {
+  public void writeItem(AuditEntry entry, AuditEntryDetails details) throws IOException {
     var row = sheet.createRow(rowIndex++);
     for (var index = 0; index < configuration.columns().size(); index++) {
-      String value = configuration.columns().get(index).value(entry);
+      String value = AuditExportValueFormatter.format(configuration.columns().get(index), entry, details);
       row.createCell(index).setCellValue(value == null ? "" : value);
     }
   }
diff --git a/streampipes-audit-management/src/main/java/org/apache/streampipes/audit/management/export/AuditExportService.java b/streampipes-audit-management/src/main/java/org/apache/streampipes/audit/management/export/AuditExportService.java
index 86b5585020..9c6df0d900 100644
--- a/streampipes-audit-management/src/main/java/org/apache/streampipes/audit/management/export/AuditExportService.java
+++ b/streampipes-audit-management/src/main/java/org/apache/streampipes/audit/management/export/AuditExportService.java
@@ -18,6 +18,8 @@
 
 package org.apache.streampipes.audit.management.export;
 
+import org.apache.streampipes.audit.api.AuditEntry;
+import org.apache.streampipes.audit.api.AuditEntryDetails;
 import org.apache.streampipes.audit.api.AuditEventReader;
 import org.apache.streampipes.audit.api.AuditExportConfiguration;
 import org.apache.streampipes.audit.api.AuditPage;
@@ -25,6 +27,7 @@ import org.apache.streampipes.audit.api.AuditQuery;
 
 import java.io.IOException;
 import java.io.OutputStream;
+import java.util.UUID;
 
 public final class AuditExportService {
   private final AuditEventReader reader;
@@ -48,7 +51,7 @@ public final class AuditExportService {
       do {
         AuditPage page = reader.query(pageQuery);
         for (var entry : page.items()) {
-          writer.writeItem(entry);
+          writer.writeItem(entry, detailsFor(entry, configuration));
         }
         pageQuery = nextPageQuery(query, page);
       } while (pageQuery != null);
@@ -57,6 +60,13 @@ public final class AuditExportService {
     }
   }
 
+  private AuditEntryDetails detailsFor(AuditEntry entry, AuditExportConfiguration configuration) {
+    if (configuration.columns().stream().noneMatch(column -> column.requiresDetails())) {
+      return null;
+    }
+    return reader.find(UUID.fromString(entry.eventId()), entry.locator()).orElse(null);
+  }
+
   private AuditQuery nextPageQuery(AuditQuery query, AuditPage page) {
     return page.nextCursor() == null
         ? null
diff --git a/streampipes-audit-management/src/main/java/org/apache/streampipes/audit/management/export/AuditOutputWriter.java b/streampipes-audit-management/src/main/java/org/apache/streampipes/audit/management/export/AuditExportValueFormatter.java
similarity index 62%
copy from streampipes-audit-management/src/main/java/org/apache/streampipes/audit/management/export/AuditOutputWriter.java
copy to streampipes-audit-management/src/main/java/org/apache/streampipes/audit/management/export/AuditExportValueFormatter.java
index e0ddde5bd3..bca7c82b45 100644
--- a/streampipes-audit-management/src/main/java/org/apache/streampipes/audit/management/export/AuditOutputWriter.java
+++ b/streampipes-audit-management/src/main/java/org/apache/streampipes/audit/management/export/AuditExportValueFormatter.java
@@ -19,20 +19,22 @@
 package org.apache.streampipes.audit.management.export;
 
 import org.apache.streampipes.audit.api.AuditEntry;
+import org.apache.streampipes.audit.api.AuditEntryDetails;
+import org.apache.streampipes.audit.api.AuditExportColumn;
 
-import java.io.IOException;
-import java.io.OutputStream;
-
-interface AuditOutputWriter extends AutoCloseable {
+import com.fasterxml.jackson.databind.ObjectMapper;
 
-  void beforeFirstItem(OutputStream outputStream) throws IOException;
+import java.io.IOException;
 
-  void writeItem(AuditEntry entry) throws IOException;
+final class AuditExportValueFormatter {
+  private static final ObjectMapper MAPPER = new ObjectMapper();
 
-  void afterLastItem(OutputStream outputStream) throws IOException;
+  private AuditExportValueFormatter() {
+  }
 
-  @Override
-  default void close() throws IOException {
-    // Most output writers do not hold resources beyond the response stream.
+  static String format(AuditExportColumn column, AuditEntry entry, AuditEntryDetails details) throws IOException {
+    return column.requiresDetails()
+        ? details == null ? null : MAPPER.writeValueAsString(details.details())
+        : column.value(entry);
   }
 }
diff --git a/streampipes-audit-management/src/main/java/org/apache/streampipes/audit/management/export/AuditJsonOutputWriter.java b/streampipes-audit-management/src/main/java/org/apache/streampipes/audit/management/export/AuditJsonOutputWriter.java
index 6f51482cd0..2ed9b7d810 100644
--- a/streampipes-audit-management/src/main/java/org/apache/streampipes/audit/management/export/AuditJsonOutputWriter.java
+++ b/streampipes-audit-management/src/main/java/org/apache/streampipes/audit/management/export/AuditJsonOutputWriter.java
@@ -19,15 +19,19 @@
 package org.apache.streampipes.audit.management.export;
 
 import org.apache.streampipes.audit.api.AuditEntry;
+import org.apache.streampipes.audit.api.AuditEntryDetails;
 import org.apache.streampipes.audit.api.AuditExportConfiguration;
 
 import com.fasterxml.jackson.core.JsonFactory;
 import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.databind.ObjectMapper;
 
 import java.io.IOException;
 import java.io.OutputStream;
 
 final class AuditJsonOutputWriter implements AuditOutputWriter {
+  private static final ObjectMapper MAPPER = new ObjectMapper();
+
   private final AuditExportConfiguration configuration;
   private JsonGenerator generator;
 
@@ -42,10 +46,15 @@ final class AuditJsonOutputWriter implements AuditOutputWriter {
   }
 
   @Override
-  public void writeItem(AuditEntry entry) throws IOException {
+  public void writeItem(AuditEntry entry, AuditEntryDetails details) throws IOException {
     generator.writeStartObject();
     for (var column : configuration.columns()) {
-      generator.writeStringField(column.id(), column.value(entry));
+      if (column.requiresDetails()) {
+        generator.writeFieldName(column.id());
+        MAPPER.writeValue(generator, details == null ? null : details.details());
+      } else {
+        generator.writeStringField(column.id(), column.value(entry));
+      }
     }
     generator.writeEndObject();
   }
diff --git a/streampipes-audit-management/src/main/java/org/apache/streampipes/audit/management/export/AuditOutputWriter.java b/streampipes-audit-management/src/main/java/org/apache/streampipes/audit/management/export/AuditOutputWriter.java
index e0ddde5bd3..e8360eacb0 100644
--- a/streampipes-audit-management/src/main/java/org/apache/streampipes/audit/management/export/AuditOutputWriter.java
+++ b/streampipes-audit-management/src/main/java/org/apache/streampipes/audit/management/export/AuditOutputWriter.java
@@ -19,6 +19,7 @@
 package org.apache.streampipes.audit.management.export;
 
 import org.apache.streampipes.audit.api.AuditEntry;
+import org.apache.streampipes.audit.api.AuditEntryDetails;
 
 import java.io.IOException;
 import java.io.OutputStream;
@@ -27,7 +28,7 @@ interface AuditOutputWriter extends AutoCloseable {
 
   void beforeFirstItem(OutputStream outputStream) throws IOException;
 
-  void writeItem(AuditEntry entry) throws IOException;
+  void writeItem(AuditEntry entry, AuditEntryDetails details) throws IOException;
 
   void afterLastItem(OutputStream outputStream) throws IOException;
 
diff --git a/streampipes-audit-management/src/test/java/org/apache/streampipes/audit/management/export/AuditExportServiceTest.java b/streampipes-audit-management/src/test/java/org/apache/streampipes/audit/management/export/AuditExportServiceTest.java
index bca21e7b18..d4da4a3246 100644
--- a/streampipes-audit-management/src/test/java/org/apache/streampipes/audit/management/export/AuditExportServiceTest.java
+++ b/streampipes-audit-management/src/test/java/org/apache/streampipes/audit/management/export/AuditExportServiceTest.java
@@ -35,6 +35,7 @@ import java.io.ByteArrayOutputStream;
 import java.nio.charset.StandardCharsets;
 import java.time.Instant;
 import java.util.List;
+import java.util.Map;
 import java.util.Optional;
 import java.util.UUID;
 
@@ -51,7 +52,7 @@ class AuditExportServiceTest {
         List.of("Event ID", "Actor"), ',');
     var output = new ByteArrayOutputStream();
 
-    new AuditExportService(reader(entry)).export(query(), configuration, output);
+    new AuditExportService(reader(entry, null)).export(query(), configuration, output);
 
     try (var workbook = WorkbookFactory.create(new ByteArrayInputStream(output.toByteArray()))) {
       var sheet = workbook.getSheetAt(0);
@@ -71,7 +72,7 @@ class AuditExportServiceTest {
         List.of("Event ID", "Actor"), ';');
     var output = new ByteArrayOutputStream();
 
-    new AuditExportService(reader(entry)).export(query(), configuration, output);
+    new AuditExportService(reader(entry, null)).export(query(), configuration, output);
 
     assertEquals("\"Event ID\";\"Actor\"\r\n\"'=event-1\";\"ad\"\"min\"\r\n",
         output.toString(StandardCharsets.UTF_8));
@@ -86,13 +87,53 @@ class AuditExportServiceTest {
         List.of("Ignored", "Ignored"), ',');
     var output = new ByteArrayOutputStream();
 
-    new AuditExportService(reader(entry)).export(query(), configuration, output);
+    new AuditExportService(reader(entry, null)).export(query(), configuration, output);
 
     assertEquals("[{\"eventId\":\"event-1\",\"actor\":\"admin\"}]",
         output.toString(StandardCharsets.UTF_8));
   }
 
-  private AuditEventReader reader(AuditEntry entry) {
+  @Test
+  void exportsDetailsAsStringToExcel() throws Exception {
+    var entry = entry();
+    var configuration = new AuditExportConfiguration(
+        AuditExportFormat.XLSX, List.of(AuditExportColumn.DETAILS), List.of("Details"), ',');
+    var output = new ByteArrayOutputStream();
+
+    new AuditExportService(reader(entry, details(entry))).export(query(), configuration, output);
+
+    try (var workbook = WorkbookFactory.create(new ByteArrayInputStream(output.toByteArray()))) {
+      var sheet = workbook.getSheetAt(0);
+      assertEquals("{\"reason\":\"manual review\"}", sheet.getRow(1).getCell(0).getStringCellValue());
+    }
+  }
+
+  @Test
+  void exportsDetailsAsStringToCsv() throws Exception {
+    var entry = entry();
+    var configuration = new AuditExportConfiguration(
+        AuditExportFormat.CSV, List.of(AuditExportColumn.DETAILS), List.of("Details"), ';');
+    var output = new ByteArrayOutputStream();
+
+    new AuditExportService(reader(entry, details(entry))).export(query(), configuration, output);
+
+    assertEquals("\"Details\"\r\n\"{\"\"reason\"\":\"\"manual review\"\"}\"\r\n",
+        output.toString(StandardCharsets.UTF_8));
+  }
+
+  @Test
+  void exportsDetailsAsStructuredJson() throws Exception {
+    var entry = entry();
+    var configuration = new AuditExportConfiguration(
+        AuditExportFormat.JSON, List.of(AuditExportColumn.DETAILS), List.of("Ignored"), ',');
+    var output = new ByteArrayOutputStream();
+
+    new AuditExportService(reader(entry, details(entry))).export(query(), configuration, output);
+
+    assertEquals("[{\"details\":{\"reason\":\"manual review\"}}]", output.toString(StandardCharsets.UTF_8));
+  }
+
+  private AuditEventReader reader(AuditEntry entry, AuditEntryDetails details) {
     return new AuditEventReader() {
       @Override
       public AuditPage query(AuditQuery query) {
@@ -101,11 +142,20 @@ class AuditExportServiceTest {
 
       @Override
       public Optional<AuditEntryDetails> find(UUID eventId, String locator) {
-        return Optional.empty();
+        return Optional.ofNullable(details);
       }
     };
   }
 
+  private AuditEntryDetails details(AuditEntry entry) {
+    return new AuditEntryDetails(entry, "2026-10-16T10:00:00Z", Map.of("reason", "manual review"));
+  }
+
+  private AuditEntry entry() {
+    return new AuditEntry("2f415744-e193-4541-9b29-73dd584fb7a3", "2026-10-16T10:00:00Z", "user.login",
+        "succeeded", "admin", null, null, "locator-1");
+  }
+
   private AuditQuery query() {
     return new AuditQuery(Instant.parse("2026-10-16T00:00:00Z"), Instant.parse("2026-10-17T00:00:00Z"),
         null, null, null, 200, null);
diff --git a/streampipes-data-explorer-export/pom.xml b/streampipes-data-explorer-export/pom.xml
index 23d62f94f7..b3d0f4fb18 100644
--- a/streampipes-data-explorer-export/pom.xml
+++ b/streampipes-data-explorer-export/pom.xml
@@ -29,10 +29,6 @@
         This module contains all components and functionalities related to exporting data from the data explorer storage.
     </description>
 
-    <properties>
-        <apache-poi.version>5.4.0</apache-poi.version>
-    </properties>
-
     <dependencies>
         <!-- StreamPipes dependencies -->
         <dependency>
diff --git a/ui/cypress/tests/configuration/audit-log/audit-log-download.spec.ts b/ui/cypress/tests/configuration/audit-log/audit-log-download.spec.ts
index 3692ad740d..15af86fa52 100644
--- a/ui/cypress/tests/configuration/audit-log/audit-log-download.spec.ts
+++ b/ui/cypress/tests/configuration/audit-log/audit-log-download.spec.ts
@@ -40,6 +40,13 @@ describe('Download audit log', () => {
             items: [auditEntry],
             nextCursor: null,
         }).as('getAuditEvents');
+        // The glob above does not cross the slash in `events/download`, and the
+        // CI stack runs with auditing disabled, so the export must be stubbed too.
+        cy.intercept('GET', '**/admin/audit/events/download*', {
+            statusCode: 200,
+            headers: { 'content-type': 'application/octet-stream' },
+            body: JSON.stringify([auditEntry]),
+        }).as('downloadAuditEvents');
 
         ConfigurationUtils.goToAuditLogConfiguration();
         cy.wait('@getAuditEvents');
@@ -58,6 +65,7 @@ describe('Download audit log', () => {
             ConfigurationBtns.auditDownloadDelimiter(delimiter).click();
         }
         ConfigurationBtns.auditDownloadBtn().click();
+        cy.wait('@downloadAuditEvents');
 
         ConfigurationBtns.auditDownloadDialog().should(
             'contain.text',
diff --git a/ui/src/app/configuration/audit-log/audit-log.component.html b/ui/src/app/configuration/audit-log/audit-log.component.html
index 079c663690..b80300a993 100644
--- a/ui/src/app/configuration/audit-log/audit-log.component.html
+++ b/ui/src/app/configuration/audit-log/audit-log.component.html
@@ -33,9 +33,16 @@
             [class.audit-retention-unconfigured]="!retention"
             >history</mat-icon
         >
-        data-cy="audit-log-download-button" [attr.aria-label]="'Download audit
-        log' | translate" [matTooltip]="'Download audit log' | translate"
-        (click)="openDownloadDialog()" [disabled]="!status?.enabled" >
+    </button>
+    <button
+        section-actions
+        mat-icon-button
+        data-cy="audit-log-download-button"
+        [attr.aria-label]="'Download audit log' | translate"
+        [matTooltip]="'Download audit log' | translate"
+        (click)="openDownloadDialog()"
+        [disabled]="!status?.enabled"
+    >
         <mat-icon>download</mat-icon>
     </button>
     <button
diff --git a/ui/src/app/configuration/audit-log/audit-log.component.spec.ts b/ui/src/app/configuration/audit-log/audit-log.component.spec.ts
index a868501231..504851e957 100644
--- a/ui/src/app/configuration/audit-log/audit-log.component.spec.ts
+++ b/ui/src/app/configuration/audit-log/audit-log.component.spec.ts
@@ -159,6 +159,13 @@ describe('AuditLogComponent', () => {
         );
     });
 
+    it('offers event details as an export column', () => {
+        expect(component.exportColumns).toContainEqual({
+            id: 'details',
+            label: 'Details',
+        });
+    });
+
     it('keeps time bounds stable across pages and resets cursors when filters change', () => {
         component.ngOnInit();
         const first = api.getEvents.mock.calls[0][0];
diff --git a/ui/src/app/configuration/audit-log/audit-log.component.ts b/ui/src/app/configuration/audit-log/audit-log.component.ts
index 1ab48befb0..27e1c4f644 100644
--- a/ui/src/app/configuration/audit-log/audit-log.component.ts
+++ b/ui/src/app/configuration/audit-log/audit-log.component.ts
@@ -193,9 +193,12 @@ export class AuditLogComponent implements OnInit {
     private query?: AuditQuery;
 
     get exportColumns(): AuditExportColumn[] {
-        return this.columns.flatMap(
-            column => this.exportColumnByTableColumn[column] ?? [],
-        );
+        return [
+            ...this.columns.flatMap(
+                column => this.exportColumnByTableColumn[column] ?? [],
+            ),
+            { id: 'details', label: 'Details' },
+        ];
     }
 
     ngOnInit(): void {
diff --git a/ui/src/app/configuration/dialog/audit-log-download/model/audit-download-dialog.model.ts b/ui/src/app/configuration/dialog/audit-log-download/model/audit-download-dialog.model.ts
index 4fd5b7fc5f..5f0a87db92 100644
--- a/ui/src/app/configuration/dialog/audit-log-download/model/audit-download-dialog.model.ts
+++ b/ui/src/app/configuration/dialog/audit-log-download/model/audit-download-dialog.model.ts
@@ -24,8 +24,10 @@ export interface AuditActorOption {
     username?: string;
 }
 
+export type AuditExportColumnId = keyof AuditEntry | 'details';
+
 export interface AuditExportColumn {
-    id: keyof AuditEntry;
+    id: AuditExportColumnId;
     label: string;
 }