Add first line of commit messages to each pushlog entry

Each pushlog entry now also contains the first line of the corresponding changeset.
The first line is additionally limited to 100 characters.

Author: zT-1337

docs/de/usage/assets/csv-export.png

@@ -9,3 +9,9 @@ Dabei wird diese Information nicht inhaltlich aus dem Commit ermittelt, sondern
 Diese Information findet sich dann in der Detail-Ansicht eines Commits als der `Mitwirkende` in der Kategorie `Pushed by`.
 
 ![Pushed by](assets/pushed-by.png)
+
+Zusätzlich ist es möglich alle Pushlog Einträge eines Repositories als CSV-Datei zu exportieren.
+Dieses CSV enthält die ID des Pushlogs, die Commit Id, den Benutzernamen vom User der den Commit zu erst gepushed hat, den Zeitstempel wann der Commit beim Server eingegangen ist und die erste Zeile der Commit-Nachricht.
+Der Downloadlink für den CSV-Export befindet sich in der Informationsseite eines Repositories.
+
+![Downloadlink für den CSV-Export](./assets/csv-export.png)

docs/de/usage/index.md

@@ -9,3 +9,9 @@ This information is not determined from the content of the commit, but the user
 You can find the stored `pusher` in the detail view of a commit as the `contributor` in the `Pushed by` category.
 
 ![Pushed by](assets/pushed-by.png)
+
+It is also possible to export all push log entries of a repository as a CSV file.
+This CSV contains the ID of the push log, the commit ID, the username of the user who first pushed the commit, the timestamp when the server received the commit and the first line of the commit message.
+The download link for the CSV export can be found on the information page of a repository.
+
+![Download link of the CSV export](./assets/csv-export.png)

docs/en/usage/assets/csv-export.png

@@ -0,0 +1,2 @@
+- type: added
+  description: The first line of each commit message is now added to the pushlog csv export

docs/en/usage/index.md

@@ -31,13 +31,17 @@
 public class PushlogEntry {
 
   private long pushlogId;
-
   private String username;
-
   private Instant contributionTime;
+  private String description;
 
   public PushlogEntry(String username, Instant contributionTime) {
+    this(username, contributionTime, null);
+  }
+
+  public PushlogEntry(String username, Instant contributionTime, String description) {
     this.username = username;
     this.contributionTime = contributionTime;
+    this.description = description;
   }
 }

gradle/changelog/commit-message.yaml

@@ -32,14 +32,15 @@
 import sonia.scm.security.Role;
 
 import java.time.Instant;
-import java.util.ArrayList;
-import java.util.Collection;
+import java.util.HashMap;
+import java.util.Map;
 
 @Slf4j
 @Extension
 @EagerSingleton
 public class PushlogHook {
 
+  private static final int MAXIMUM_DESCRIPTION_LENGTH = 100;
   private final PushlogManager pushlogManager;
 
   @Inject
@@ -82,10 +83,38 @@ private void handlePushEvent(String username, RepositoryHookEvent event) {
 
   private void handlePush(String username, Repository repository,
                           Instant creationDate, Iterable<Changeset> changesets) {
-    Collection<String> revisions = new ArrayList<>();
+    Map<String, PushlogEntry> revisionWithPushlogs = new HashMap<>();
     for (Changeset c : changesets) {
-      revisions.add(c.getId());
+      revisionWithPushlogs.put(
+        c.getId(),
+        new PushlogEntry(username, creationDate, limitChangesetDescription(c.getDescription()))
+      );
     }
-    pushlogManager.store(new PushlogEntry(username, creationDate), repository, revisions);
+    pushlogManager.storeRevisionEntryMap(revisionWithPushlogs, repository);
+  }
+
+  //Take the first line of the description and limit it to the maximum description length
+  private String limitChangesetDescription(String description) {
+    if (description == null) {
+      return null;
+    }
+
+    int lineLimit = 0;
+    while (lineLimit < description.length()) {
+      if (isNewline(description.charAt(lineLimit))) {
+        break;
+      }
+      ++lineLimit;
+    }
+
+    if (lineLimit > MAXIMUM_DESCRIPTION_LENGTH) {
+      return description.substring(0, MAXIMUM_DESCRIPTION_LENGTH) + "...";
+    }
+
+    return description.substring(0, lineLimit);
+  }
+
+  private boolean isNewline(char c) {
+    return c == '\n' || c == '\r';
   }
 }

src/main/java/sonia/scm/pushlog/PushlogEntry.java

@@ -25,7 +25,7 @@
 import sonia.scm.store.StoreException;
 
 import java.util.Collection;
-
+import java.util.Map;
 import java.util.Optional;
 import java.util.function.Consumer;
 
@@ -49,8 +49,7 @@ public void store(PushlogEntry entry, Repository repository, Collection<String>
     log.debug("store pushlog for repository {}", repository);
     try (QueryableMutableStore<PushlogEntry> store = storeFactory.getMutable(repository.getId())) {
       store.transactional(() -> {
-          Long maxId = store.query(PushlogEntryQueryFields.REPOSITORY_ID.eq(repository.getId()))
-            .max(PushlogEntryQueryFields.PUSHLOGID);
+          Long maxId = getMaxId(store, repository);
           entry.setPushlogId(maxId == null ? 1 : maxId + 1);
           revisions.forEach(
             revision -> {
@@ -66,6 +65,29 @@ public void store(PushlogEntry entry, Repository repository, Collection<String>
     log.debug("stored {} pushlogs for repository {}", revisions.size(), repository);
   }
 
+  public void storeRevisionEntryMap(Map<String, PushlogEntry> revisionsWithPushlogs, Repository repository) {
+    log.debug("store pushlog for repository {}", repository);
+    try (QueryableMutableStore<PushlogEntry> store = storeFactory.getMutable(repository.getId())) {
+      store.transactional(() -> {
+          Long maxId = getMaxId(store, repository);
+          revisionsWithPushlogs.forEach((revision, entry) -> {
+            entry.setPushlogId(maxId == null ? 1 : maxId + 1);
+            if (store.getOptional(revision).isEmpty()) {
+              store.put(revision, entry);
+            }
+          });
+          return true;
+        }
+      );
+    }
+    log.debug("stored {} pushlogs for repository {}", revisionsWithPushlogs.size(), repository);
+  }
+
+  private Long getMaxId(QueryableStore<PushlogEntry> store, Repository repository) {
+    return store.query(PushlogEntryQueryFields.REPOSITORY_ID.eq(repository.getId()))
+      .max(PushlogEntryQueryFields.PUSHLOGID);
+  }
+
   public Optional<PushlogEntry> get(Repository repository, String id) {
     try (QueryableMutableStore<PushlogEntry> store = storeFactory.getMutable(repository.getId())) {
       return store.getOptional(id);
@@ -76,9 +98,9 @@ public Optional<PushlogEntry> get(Repository repository, String id) {
    * Returns a map of all pushlogs from a {@link Repository} with the revision as its key and {@link PushlogEntry} entries.
    *
    * @param repository Repository from where the entries are fetched from.
-   * @param consumer Consumer function receiving {@link QueryableStore.Result} objects. Each of them contains
-   *                                 a {@link String} key representing the revision and the {@link PushlogEntry} value.
-   * @param order Whether the result is ordered in a descending or ascending fashion.
+   * @param consumer   Consumer function receiving {@link QueryableStore.Result} objects. Each of them contains
+   *                   a {@link String} key representing the revision and the {@link PushlogEntry} value.
+   * @param order      Whether the result is ordered in a descending or ascending fashion.
    */
   public void doExport(Repository repository, Consumer<QueryableStore.Result<PushlogEntry>> consumer, QueryableStore.Order order) {
     log.debug("start export for repository {} with order {}", repository, order);
@@ -88,7 +110,7 @@ public void doExport(Repository repository, Consumer<QueryableStore.Result<Pushl
         .withIds()
         .orderBy(PushlogEntryQueryFields.PUSHLOGID, order)
         .forEach(consumer);
-    } catch(Exception e) {
+    } catch (Exception e) {
       throw new StoreException(
         format("An exception occurred while trying to export pushlog entries from repository %s", repository), e);
     }

src/main/java/sonia/scm/pushlog/PushlogHook.java

@@ -28,13 +28,15 @@
  * @param revision  {@link String}
  * @param username  {@link String}
  * @param timestamp {@link ZonedDateTime}
+ * @param description {@link String}
  */
 @JsonPropertyOrder({"pushlogId", "revision", "username", "timestamp"})
 public record CsvPushlogEntry(
   long pushlogId,
   String revision,
   String username,
-  @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss.SSS 'UTC'Z") ZonedDateTime timestamp) {
+  @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss.SSS 'UTC'Z") ZonedDateTime timestamp,
+  String description) {
 
-  public static final String HEADER = "PushlogId,Revision,Username,Timestamp";
+  public static final String HEADER = "PushlogId,Revision,Username,Timestamp,Description";
 }

src/main/java/sonia/scm/pushlog/PushlogManager.java

@@ -124,8 +124,9 @@ private CsvPushlogEntry from(QueryableStore.Result<PushlogEntry> result) {
       result.getEntity().getPushlogId(),
       result.getId(),
       result.getEntity().getUsername(),
-      result.getEntity().getContributionTime() != null ?
-        result.getEntity().getContributionTime().atZone(ZONE_ID) : null);
+      result.getEntity().getContributionTime() != null ? result.getEntity().getContributionTime().atZone(ZONE_ID) : null,
+      result.getEntity().getDescription()
+    );
   }
 
   @GET

src/main/java/sonia/scm/pushlog/export/api/csv/CsvPushlogEntry.java

@@ -73,7 +73,7 @@ public void doUpdate(RepositoryUpdateContext repositoryUpdateContext) {
               .map(changeset -> new QueryableMaintenanceStore.Row<>(
                 new String[]{repositoryUpdateContext.getRepositoryId()},
                 String.valueOf(changeset),
-                new PushlogEntry(entry.getId(), entry.getUsername(), contributionTime)
+                new PushlogEntry(entry.getId(), entry.getUsername(), contributionTime, null)
               ));
           })
         ));

src/main/java/sonia/scm/pushlog/export/api/csv/CsvResource.java

@@ -65,7 +65,7 @@ class PushlogDetailsDtoEmbeddedEnricherTest {
   void shouldAppendEmbeddedPushlogDetailsDtoWithTimestampAndDisplayUser() {
     when(context.oneRequireByType(Repository.class)).thenReturn(repository);
     when(context.oneRequireByType(Changeset.class)).thenReturn(changeset);
-    PushlogEntry pushlogEntry = new PushlogEntry(1, "username", Instant.now());
+    PushlogEntry pushlogEntry = new PushlogEntry(1, "username", Instant.now(), null);
     when(pushlogManager.get(repository, "42")).thenReturn(of(pushlogEntry));
     when(userDisplayManager.get(pushlogEntry.getUsername())).thenReturn(of(displayUser));
 

src/main/java/sonia/scm/pushlog/update/MoveToQueryableUpdateStep.java

@@ -33,9 +33,8 @@
 
 import java.time.Instant;
 import java.util.Arrays;
+import java.util.Map;
 
-import static org.mockito.ArgumentMatchers.argThat;
-import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.Mockito.mockStatic;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.verifyNoInteractions;
@@ -62,6 +61,7 @@ class PushlogHookTest {
   private Changeset changeset2;
 
   private PushlogHook pushlogHook;
+  private final Instant creationDate = Instant.now();
 
   @BeforeEach
   public void setUp() {
@@ -127,11 +127,73 @@ void testOnEventWithoutChangesets() {
   }
 
   @Test
-  void testOnEventSuccessfulPush() {
+  void testOnEventSuccessfulPushWithOneLineCommitMessage() {
+    when(changeset1.getDescription()).thenReturn("Commit Message");
+    when(changeset2.getDescription()).thenReturn("Second commit message");
+    executeSuccessfulPushTestCases(() -> {
+      pushlogHook.onEvent(event);
+      verify(pushlogManager).storeRevisionEntryMap(
+        Map.of(
+          "rev1", new PushlogEntry("testUser", creationDate, "Commit Message"),
+          "rev2", new PushlogEntry("testUser", creationDate, "Second commit message")
+        ),
+        repository
+      );
+    });
+  }
+
+  @Test
+  void testOnEventSuccessfulPushWithLimitedOneLineCommitMessage() {
+    when(changeset1.getDescription()).thenReturn("a".repeat(100));
+    when(changeset2.getDescription()).thenReturn("b".repeat(101));
+    executeSuccessfulPushTestCases(() -> {
+      pushlogHook.onEvent(event);
+      verify(pushlogManager).storeRevisionEntryMap(
+        Map.of(
+          "rev1", new PushlogEntry("testUser", creationDate, "a".repeat(100)),
+          "rev2", new PushlogEntry("testUser", creationDate, "b".repeat(100) + "...")
+        ),
+        repository
+      );
+    });
+  }
+
+  @Test
+  void testOnEventSuccessfulPushWithMultiLineCommitMessage() {
+    when(changeset1.getDescription()).thenReturn("First Line\nSecond Line");
+    when(changeset2.getDescription()).thenReturn("1. Line\n2. Line\n3. Line");
+    executeSuccessfulPushTestCases(() -> {
+      pushlogHook.onEvent(event);
+      verify(pushlogManager).storeRevisionEntryMap(
+        Map.of(
+          "rev1", new PushlogEntry("testUser", creationDate, "First Line"),
+          "rev2", new PushlogEntry("testUser", creationDate, "1. Line")
+        ),
+        repository
+      );
+    });
+  }
+
+  @Test
+  void testOnEventSuccessfulPushWithLimitedMultiLineCommitMessage() {
+    when(changeset1.getDescription()).thenReturn("First Line\n" + "a".repeat(100));
+    when(changeset2.getDescription()).thenReturn("b".repeat(101) + "\nSecond Line");
+    executeSuccessfulPushTestCases(() -> {
+      pushlogHook.onEvent(event);
+      verify(pushlogManager).storeRevisionEntryMap(
+        Map.of(
+          "rev1", new PushlogEntry("testUser", creationDate, "First Line"),
+          "rev2", new PushlogEntry("testUser", creationDate, "b".repeat(100) + "...")
+        ),
+        repository
+      );
+    });
+  }
+
+  private void executeSuccessfulPushTestCases(Runnable testCase) {
     when(subject.hasRole(Role.USER)).thenReturn(true);
     when(subject.getPrincipal()).thenReturn("testUser");
     when(event.getRepository()).thenReturn(repository);
-    Instant creationDate = Instant.now();
     when(event.getCreationDate()).thenReturn(creationDate);
     when(event.getContext()).thenReturn(context);
     when(context.getChangesetProvider()).thenReturn(changesetBuilder);
@@ -142,18 +204,7 @@ void testOnEventSuccessfulPush() {
 
     try (MockedStatic<SecurityUtils> securityUtilsMock = mockStatic(SecurityUtils.class)) {
       securityUtilsMock.when(SecurityUtils::getSubject).thenReturn(subject);
-
-      pushlogHook.onEvent(event);
-      verify(pushlogManager).store(
-        argThat(entry ->
-          entry.getUsername().equals("testUser") &&
-            entry.getContributionTime().equals(creationDate)
-        ),
-        eq(repository),
-        argThat(revisions ->
-          revisions.containsAll(Arrays.asList("rev1", "rev2"))
-        )
-      );
+      testCase.run();
     }
   }
 }

src/test/java/sonia/scm/pushlog/PushlogDetailsDtoEmbeddedEnricherTest.java

@@ -82,6 +82,50 @@ void shouldNotReplaceExistingEntries(PushlogEntryStoreFactory storeFactory) {
     assertThat(all.get("r2")).isEqualTo(newEntry);
   }
 
+  @Test
+  void shouldStoreNewEntriesWithRevisionMap(PushlogEntryStoreFactory storeFactory) {
+    PushlogEntry firstEntry = new PushlogEntry("trillian", Instant.now(), "Commit Message");
+    PushlogEntry secondEntry = new PushlogEntry("trillian", Instant.now(), "Second Message");
+    manager.storeRevisionEntryMap(Map.of("r1", firstEntry, "r2", secondEntry), repository);
+
+    Map<String, PushlogEntry> all = storeFactory.getMutable(repository).getAll();
+    assertThat(all).hasSize(2);
+    assertThat(all.get("r1")).isEqualTo(firstEntry);
+    assertThat(all.get("r2")).isEqualTo(secondEntry);
+    assertThat(all.get("r1").getPushlogId()).isEqualTo(1);
+    assertThat(all.get("r2").getPushlogId()).isEqualTo(1);
+  }
+
+  @Test
+  void shouldIncrementPushlogIdWithRevisionMap(PushlogEntryStoreFactory storeFactory) {
+    manager.storeRevisionEntryMap(
+      Map.of("r1", new PushlogEntry("trillian", Instant.now(), "Commit Message")),
+      repository
+    );
+    manager.storeRevisionEntryMap(
+      Map.of("r2", new PushlogEntry("trillian", Instant.now(), "Commit Message")),
+      repository
+    );
+
+    Map<String, PushlogEntry> all = storeFactory.getMutable(repository).getAll();
+    assertThat(all.get("r1").getPushlogId()).isEqualTo(1);
+    assertThat(all.get("r2").getPushlogId()).isEqualTo(2);
+  }
+
+  @Test
+  void shouldNotReplaceExistingEntriesWithRevisionMap(PushlogEntryStoreFactory storeFactory) {
+    PushlogEntry existingEntry = new PushlogEntry("trillian", Instant.now(), "Commit Message");
+    manager.storeRevisionEntryMap(Map.of("r1", existingEntry), repository);
+
+    PushlogEntry newEntry = new PushlogEntry("arthur", Instant.now(), "New Message");
+    manager.storeRevisionEntryMap(Map.of("r1", newEntry, "r2", newEntry), repository);
+
+    Map<String, PushlogEntry> all = storeFactory.getMutable(repository).getAll();
+    assertThat(all).hasSize(2);
+    assertThat(all.get("r1")).isEqualTo(existingEntry);
+    assertThat(all.get("r2")).isEqualTo(newEntry);
+  }
+
   @Test
   void shouldSortContributionsById(PushlogEntryStoreFactory storeFactory) {
     int entries = 5;