refactoring Events for better journal

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

.gitea/workflows/docker.yaml

@@ -41,6 +41,11 @@ jobs:
           docker push ${{ secrets.REGISTRY_PATH }}/umbrella:${{ gitea.ref_name }}
           docker push ${{ secrets.REGISTRY_PATH }}/umbrella:$TAG
 
+      - name: Restart vj.srsoftware.de
+        if: github.ref == 'refs/heads/main'
+        run: |
+          curl -X POST -H "Authorization: Bearer ${{ secrets.MAKE_BEARER }}" -d vj_start https://make.srsoftware.de/launch
+
   Clean-Registry:
     runs-on: ubuntu-latest
     steps:

backend/build.gradle.kts

@@ -18,6 +18,7 @@ dependencies{
     implementation(project(":core"))
     implementation(project(":documents"))
     implementation(project(":files"))
+    implementation(project(":journal"))
     implementation(project(":legacy"))
     implementation(project(":markdown"))
     implementation(project(":messages"))
@@ -52,6 +53,7 @@ tasks.jar {
         ":core:jar",
         ":documents:jar",
         ":files:jar",
+        ":journal:jar",
         ":legacy:jar",
         ":markdown:jar",
         ":messages:jar",

backend/src/main/java/de/srsoftware/umbrella/backend/Application.java

@@ -16,6 +16,7 @@ import de.srsoftware.umbrella.core.Util;
 import de.srsoftware.umbrella.core.exceptions.UmbrellaException;
 import de.srsoftware.umbrella.documents.DocumentApi;
 import de.srsoftware.umbrella.files.FileModule;
+import de.srsoftware.umbrella.journal.JournalModule;
 import de.srsoftware.umbrella.legacy.*;
 import de.srsoftware.umbrella.markdown.MarkdownApi;
 import de.srsoftware.umbrella.message.MessageSystem;
@@ -64,6 +65,7 @@ public class Application {
 		var server            = HttpServer.create(new InetSocketAddress(port), 0);
 		try {
 			new Translations().bindPath("/api/translations").on(server);
+			new JournalModule(config).bindPath("/api/journal").on(server);
 			new MessageApi().bindPath("/api/bus").on(server);
 			new MessageSystem(config);
 			new UserModule(config).bindPath("/api/user").on(server);

bookmark/src/main/java/de/srsoftware/umbrella/bookmarks/BookmarkApi.java

@@ -34,7 +34,7 @@ public class BookmarkApi extends BaseHandler implements BookmarkService {
 		super();
 		var dbFile = config.get(CONFIG_DATABASE).orElseThrow(() -> missingFieldException(CONFIG_DATABASE));
 		db = new SqliteDb(connect(dbFile));
-	        ModuleRegistry.add(this);
+		ModuleRegistry.add(this);
 	}
 
 	@Override

bus/src/main/java/de/srsoftware/umbrella/messagebus/EventListener.java

@@ -4,5 +4,5 @@ package de.srsoftware.umbrella.messagebus;
 import de.srsoftware.umbrella.messagebus.events.Event;
 
 public interface EventListener {
-	void onEvent(Event event);
+	void onEvent(Event<?> event);
 }

bus/src/main/java/de/srsoftware/umbrella/messagebus/EventQueue.java

@@ -7,7 +7,7 @@ import de.srsoftware.umbrella.messagebus.events.Event;
 import java.net.InetSocketAddress;
 import java.util.LinkedList;
 
-public class EventQueue extends LinkedList<Event> implements AutoCloseable, EventListener {
+public class EventQueue extends LinkedList<Event<?>> implements AutoCloseable, EventListener {
 
 	private final InetSocketAddress addr;
 
@@ -29,7 +29,7 @@ public class EventQueue extends LinkedList<Event> implements AutoCloseable, Even
 	}
 
 	@Override
-	public void onEvent(Event event) {
+	public void onEvent(Event<?> event) {
 		System.getLogger(addr.toString()).log(System.Logger.Level.INFO,"adding event to queue of {1}: {0}",event.eventType(),addr);
 		add(event);
 	}

bus/src/main/java/de/srsoftware/umbrella/messagebus/MessageBus.java

@@ -6,8 +6,8 @@ import java.util.HashSet;
 import java.util.Set;
 
 public class MessageBus {
-	private static MessageBus SINGLETON = new MessageBus();
-	private Set<EventListener> listeners = new HashSet<>();
+	private static final MessageBus SINGLETON = new MessageBus();
+	private final Set<EventListener> listeners = new HashSet<>();
 
 	private MessageBus(){}
 

bus/src/main/java/de/srsoftware/umbrella/messagebus/events/Event.java

@@ -1,39 +1,80 @@
 /* © SRSoftware 2025 */
 package de.srsoftware.umbrella.messagebus.events;
 
-import static de.srsoftware.umbrella.core.Constants.USER;
+import static de.srsoftware.umbrella.core.Constants.*;
+import static java.text.MessageFormat.format;
+import static java.util.Optional.*;
 
 import de.srsoftware.tools.Mappable;
 import de.srsoftware.umbrella.core.model.UmbrellaUser;
+import java.util.HashMap;
 import java.util.Map;
+import java.util.Optional;
 import org.json.JSONObject;
 
+
 public abstract class Event<Payload extends Mappable> {
 
 	public enum EventType {
 		CREATE,
 		UPDATE,
 		DELETE;
-
 	}
-	private UmbrellaUser initiator;
 
-	private String realm;
-	private Payload payload;
-	private EventType eventType;
-	public Event(UmbrellaUser initiator, String realm, Payload payload, EventType type){
+	private final UmbrellaUser initiator;
+	private final String module;
+	private final Payload payload;
+	private final EventType eventType;
+	private final Map<String, Object> oldData;
+
+	public Event(UmbrellaUser initiator, String module, Payload payload, EventType type){
 		this.initiator = initiator;
-		this.realm     = realm;
+		this.module    = module;
 		this.payload   = payload;
 		this.eventType = type;
+		this.oldData   = null;
 	}
 
+	public Event(UmbrellaUser initiator, String module, Payload payload, Map<String, Object> oldData){
+		this.initiator = initiator;
+		this.module    = module;
+		this.payload   = payload;
+		this.eventType = EventType.UPDATE;
+		this.oldData   = oldData;
+	}
+
+	public abstract String describe();
+
+	private String diff(Map<String, Object> a, Map<String, Object> b){
+		// TODO: replace by better implementation
+		return format("{0}\n→\n{1}",dropMarkdown(a),dropMarkdown(b));
+	}
+
+	private Map<String, Object> dropMarkdown(Map<String, Object> map) {
+		var result = new HashMap<String, Object>();
+		for (var entry : map.entrySet()){
+			var v = entry.getValue();
+			if (v instanceof Map<?,?> m && m.containsKey(RENDERED) && m.get(SOURCE) instanceof String s) v=s;
+			result.put(entry.getKey(),v);
+		}
+		return result;
+	}
+
+	public Optional<String> diff(){
+		return oldData == null ? empty() : of(diff(oldData,payload.toMap()));
+	}
+
+
 	public String eventType(){
 		return eventType.toString();
 	}
 
 	public abstract boolean isIntendedFor(UmbrellaUser user);
 
+	public UmbrellaUser initiator(){
+		return initiator;
+	}
+
 	public String json(){
 		Class<?> clazz = payload.getClass();
 		{ // get the highest superclass that is not object
@@ -48,6 +89,10 @@ public abstract class Event<Payload extends Mappable> {
 		return new JSONObject(map).toString();
 	}
 
+	public String module(){
+		return module;
+	}
+
 	public Payload payload(){
 		return payload;
 	}

bus/src/main/java/de/srsoftware/umbrella/messagebus/events/ProjectEvent.java

@@ -5,6 +5,7 @@ import static de.srsoftware.umbrella.core.Constants.PROJECT;
 
 import de.srsoftware.umbrella.core.model.Project;
 import de.srsoftware.umbrella.core.model.UmbrellaUser;
+import java.util.Map;
 
 
 public class ProjectEvent extends Event<Project>{
@@ -12,6 +13,15 @@ public class ProjectEvent extends Event<Project>{
 		super(initiator, PROJECT, project, type);
 	}
 
+	public ProjectEvent(UmbrellaUser initiator, Project project, Map<String, Object> oldData){
+		super(initiator, PROJECT, project, oldData);
+	}
+
+	@Override
+	public String describe() {
+		return diff().orElse("[TODO: ProjectEvent.describe]");
+	}
+
 	@Override
 	public boolean isIntendedFor(UmbrellaUser user) {
 		for (var member : payload().members().values()){

bus/src/main/java/de/srsoftware/umbrella/messagebus/events/TaskEvent.java

@@ -5,6 +5,7 @@ import static de.srsoftware.umbrella.core.Constants.TASK;
 
 import de.srsoftware.umbrella.core.model.Task;
 import de.srsoftware.umbrella.core.model.UmbrellaUser;
+import java.util.Map;
 
 
 public class TaskEvent extends Event<Task>{
@@ -12,6 +13,15 @@ public class TaskEvent extends Event<Task>{
 		super(initiator, TASK, task, type);
 	}
 
+	public TaskEvent(UmbrellaUser initiator, Task task, Map<String, Object> oldData){
+		super(initiator, TASK, task, oldData);
+	}
+
+	@Override
+	public String describe() {
+		return diff().orElse("[TODO: TaskEvent.describe()]");
+	}
+
 	@Override
 	public boolean isIntendedFor(UmbrellaUser user) {
 		for (var member : payload().members().values()){

core/src/main/java/de/srsoftware/umbrella/core/BaseDb.java

@@ -75,5 +75,4 @@ CREATE TABLE IF NOT EXISTS {0} ( {1} VARCHAR(255) PRIMARY KEY, {2} VARCHAR(255)
 			throw new RuntimeException(e);
 		}
 	}
-
 }

core/src/main/java/de/srsoftware/umbrella/core/Constants.java

@@ -8,10 +8,7 @@ public class Constants {
 
 	private Constants(){}
 
-
-
-
-
+	public static final String ACTION         = "action";
 	public static final String ADDRESS        = "address";
 	public static final String ALLOWED_STATES = "allowed_states";
 	public static final String ATTACHMENTS    = "attachments";

core/src/main/java/de/srsoftware/umbrella/core/exceptions/UmbrellaException.java

@@ -8,6 +8,7 @@ import static java.lang.System.Logger.Level.ERROR;
 import static java.lang.System.Logger.Level.WARNING;
 import static java.net.HttpURLConnection.HTTP_FORBIDDEN;
 import static java.net.HttpURLConnection.HTTP_NOT_FOUND;
+import static java.text.MessageFormat.format;
 
 
 public class UmbrellaException extends RuntimeException{
@@ -43,7 +44,12 @@ public class UmbrellaException extends RuntimeException{
 		return new UmbrellaException(HTTP_FORBIDDEN,message,fills);
 	}
 
-	public static UmbrellaException invalidFieldException(String field,String expected){
+	@Override
+	public String getMessage() {
+		return format(super.getMessage(),fills);
+	}
+
+	public static UmbrellaException invalidFieldException(String field, String expected){
 		return new UmbrellaException(HTTP_UNPROCESSABLE, ERROR_INVALID_FIELD, field, expected);
 	}
 

core/src/main/java/de/srsoftware/umbrella/core/model/Task.java

@@ -27,7 +27,7 @@ public class Task implements Mappable {
 	private boolean noIndex, showClosed;
 	private final Map<Long, Member> members;
 	private final Set<String> dirtyFields = new HashSet<>();
-
+	private final Set<String> tags = new HashSet<>();
 
 	public Task (long id, long projectId, Long parentTaskId, String name, String description, int status, Double estimatedTime, LocalDate start, LocalDate dueDate, boolean showClosed, boolean noIndex, Map<Long,Member> members, int priority){
 		this.id = id;
@@ -218,6 +218,16 @@ public class Task implements Mappable {
 		return status;
 	}
 
+	public Task tags(Collection<String> newValue){
+		tags.clear();
+		tags.addAll(newValue);
+		return this;
+	}
+
+	public Set<String> tags(){
+		return tags;
+	}
+
 	@Override
 	public Map<String, Object> toMap() {
 		var map = new HashMap<String,Object>();
@@ -240,7 +250,7 @@ public class Task implements Mappable {
 		map.put(REQUIRED_TASKS_IDS,requiredTasksIds);
 		map.put(SHOW_CLOSED,showClosed);
 		map.put(TOTAL_PRIO,totalPrio());
-
+		map.put(TAGS,tags);
 		return map;
 	}
 

journal/build.gradle.kts

@@ -0,0 +1,7 @@
+description = "Umbrella : Journal"
+
+dependencies{
+    implementation(project(":bus"))
+    implementation(project(":core"))
+}
+

journal/src/main/java/de/srsoftware/umbrella/journal/Constants.java

@@ -0,0 +1,9 @@
+/* © SRSoftware 2025 */
+package de.srsoftware.umbrella.journal;
+
+public class Constants {
+	public static final String CONFIG_DATABASE = "umbrella.modules.journal.database";
+
+	public static final String ERROR_WRITE_EVENT = "Failed to write {0} event of {1} to journal!";
+	public static final String TABLE_JOURNAL = "journal";
+}

journal/src/main/java/de/srsoftware/umbrella/journal/JournalDb.java

@@ -0,0 +1,8 @@
+/* © SRSoftware 2025 */
+package de.srsoftware.umbrella.journal;
+
+import de.srsoftware.umbrella.messagebus.events.Event;
+
+public interface JournalDb {
+	void logEvent(Event<?> event);
+}

journal/src/main/java/de/srsoftware/umbrella/journal/JournalModule.java

@@ -0,0 +1,34 @@
+/* © SRSoftware 2025 */
+package de.srsoftware.umbrella.journal;
+
+import static de.srsoftware.umbrella.core.ConnectionProvider.connect;
+import static de.srsoftware.umbrella.core.exceptions.UmbrellaException.missingFieldException;
+import static de.srsoftware.umbrella.journal.Constants.CONFIG_DATABASE;
+import static de.srsoftware.umbrella.messagebus.MessageBus.messageBus;
+import static java.lang.System.Logger.Level.DEBUG;
+
+import de.srsoftware.configuration.Configuration;
+import de.srsoftware.umbrella.core.BaseHandler;
+import de.srsoftware.umbrella.core.ModuleRegistry;
+import de.srsoftware.umbrella.messagebus.EventListener;
+import de.srsoftware.umbrella.messagebus.events.Event;
+
+
+public class JournalModule extends BaseHandler implements EventListener {
+
+	private final JournalDb journalDb;
+
+	public JournalModule(Configuration config){
+		super();
+		var dbFile = config.get(CONFIG_DATABASE).orElseThrow(() -> missingFieldException(CONFIG_DATABASE));
+		journalDb = new SqliteDb(connect(dbFile));
+		ModuleRegistry.add(this);
+		messageBus().register(this);
+	}
+
+	@Override
+	public void onEvent(Event<?> event) {
+		LOG.log(DEBUG,"{0} @ {1} (by {2})",event.eventType(),event.module(),event.initiator().name());
+		journalDb.logEvent(event);
+	}
+}

journal/src/main/java/de/srsoftware/umbrella/journal/SqliteDb.java

@@ -0,0 +1,59 @@
+/* © SRSoftware 2025 */
+package de.srsoftware.umbrella.journal;
+
+import static de.srsoftware.tools.jdbc.Query.insertInto;
+import static de.srsoftware.umbrella.core.Constants.*;
+import static de.srsoftware.umbrella.core.exceptions.UmbrellaException.databaseException;
+import static de.srsoftware.umbrella.journal.Constants.ERROR_WRITE_EVENT;
+import static de.srsoftware.umbrella.journal.Constants.TABLE_JOURNAL;
+import static java.text.MessageFormat.format;
+
+import de.srsoftware.umbrella.core.BaseDb;
+import de.srsoftware.umbrella.messagebus.events.Event;
+import java.sql.Connection;
+import java.sql.SQLException;
+
+public class SqliteDb extends BaseDb implements JournalDb{
+	public SqliteDb(Connection connection) {
+		super(connection);
+	}
+
+	protected int createTables() {
+		int currentVersion = createSettingsTable();
+		switch (currentVersion){
+			case 0:
+				createJournalTable();
+		}
+
+		return setCurrentVersion(1);
+	}
+
+	private void createJournalTable() {
+		var sql = """
+				CREATE TABLE IF NOT EXISTS {0} (
+					{1} INTEGER PRIMARY KEY,
+					{2} INTEGER,
+					{3} VARCHAR(255) NOT NULL,
+					{4} VARCHAR(16) NOT NULL,
+					{5} TEXT
+				);
+				""";
+		sql = format(sql,TABLE_JOURNAL,ID,USER_ID,MODULE,ACTION,DESCRIPTION);
+		try {
+			db.prepareStatement(sql).execute();
+		} catch (SQLException e) {
+			throw databaseException(ERROR_FAILED_CREATE_TABLE,TABLE_JOURNAL);
+		}
+	}
+
+	@Override
+	public void logEvent(Event<?> event) {
+		try {
+			insertInto(TABLE_JOURNAL,USER_ID,MODULE,ACTION,DESCRIPTION)
+					.values(event.initiator().id(), event.module(), event.eventType(), event.describe())
+					.execute(db).close();
+		} catch (SQLException e) {
+			throw databaseException(ERROR_WRITE_EVENT,event.eventType(),event.initiator().name());
+		}
+	}
+}

project/src/main/java/de/srsoftware/umbrella/project/ProjectModule.java

@@ -14,7 +14,6 @@ import static de.srsoftware.umbrella.core.model.Status.OPEN;
 import static de.srsoftware.umbrella.core.model.Status.PREDEFINED;
 import static de.srsoftware.umbrella.messagebus.MessageBus.messageBus;
 import static de.srsoftware.umbrella.messagebus.events.Event.EventType.CREATE;
-import static de.srsoftware.umbrella.messagebus.events.Event.EventType.UPDATE;
 import static de.srsoftware.umbrella.project.Constants.CONFIG_DATABASE;
 import static java.lang.Boolean.TRUE;
 import static java.net.HttpURLConnection.HTTP_BAD_REQUEST;
@@ -210,13 +209,14 @@ public class ProjectModule extends BaseHandler implements ProjectService {
 	private boolean patchProject(HttpExchange ex, long projectId, UmbrellaUser user) throws IOException, UmbrellaException {
 		var project = loadMembers(projectDb.load(projectId));
 		if (!project.hasMember(user)) throw forbidden("You are not a member of {0}",project.name());
+		var old = project.toMap();
 		var json = json(ex);
 		if (json.has(DROP_MEMBER) && json.get(DROP_MEMBER) instanceof Number id) dropMember(project,id.longValue());
 		if (json.has(MEMBERS) && json.get(MEMBERS) instanceof JSONObject memberJson) patchMembers(project,memberJson);
 		if (json.has(NEW_MEMBER) && json.get(NEW_MEMBER) instanceof Number num) addMember(project,num.longValue());
 
 		project = projectDb.save(project.patch(json), user);
-		messageBus().dispatch(new ProjectEvent(user,project, UPDATE));
+		messageBus().dispatch(new ProjectEvent(user,project, old));
 		return sendContent(ex,project.toMap());
 	}
 

settings.gradle.kts

@@ -21,3 +21,5 @@ include("translations")
 include("user")
 include("web")
 include("wiki")
+
+include("journal")

task/src/main/java/de/srsoftware/umbrella/task/TaskModule.java

@@ -13,7 +13,6 @@ import static de.srsoftware.umbrella.core.model.Permission.*;
 import static de.srsoftware.umbrella.core.model.Permission.OWNER;
 import static de.srsoftware.umbrella.messagebus.MessageBus.messageBus;
 import static de.srsoftware.umbrella.messagebus.events.Event.EventType.CREATE;
-import static de.srsoftware.umbrella.messagebus.events.Event.EventType.UPDATE;
 import static de.srsoftware.umbrella.project.Constants.PERMISSIONS;
 import static de.srsoftware.umbrella.task.Constants.*;
 import static java.lang.System.Logger.Level.WARNING;
@@ -42,22 +41,6 @@ import org.json.JSONObject;
 
 public class TaskModule extends BaseHandler implements TaskService {
 
-	private static class TaggedTask extends Task{
-		private final Collection<String> tags;
-
-		public TaggedTask(Task task, Collection<String> tags) {
-			super(task.id(), task.projectId(), task.parentTaskId(), task.name(), task.description(), task.status(), task.estimatedTime(), task.start(), task.dueDate(), task.showClosed(), task.noIndex(), task.members(), task.priority());
-			this.tags = tags;
-		}
-
-		@Override
-		public Map<String, Object> toMap() {
-			var map = super.toMap();
-			map.put(TAGS,tags);
-			return map;
-		}
-	}
-
 	private final TaskDb taskDb;
 
 	public TaskModule(Configuration config) throws UmbrellaException {
@@ -335,6 +318,7 @@ public class TaskModule extends BaseHandler implements TaskService {
 
 	private boolean patchTask(HttpExchange ex, long taskId, UmbrellaUser user) throws IOException {
 		var task = loadMembers(taskDb.load(taskId));
+		var old = task.toMap();
 		var member = task.members().get(user.id());
 		if (member == null || member.permission() == READ_ONLY) throw forbidden("You are not a allowed to edit {0}!", task.name());
 		var json = json(ex);
@@ -342,9 +326,8 @@ public class TaskModule extends BaseHandler implements TaskService {
 		if (json.has(MEMBERS) && json.get(MEMBERS) instanceof JSONObject memberJson) patchMembers(task, memberJson);
 		if (json.has(NEW_MEMBER) && json.get(NEW_MEMBER) instanceof Number num) addMember(task, num.longValue());
 		if (json.has(PARENT_TASK_ID) && json.get(PARENT_TASK_ID) instanceof Number ptid && newParentIsSubtask(task, ptid.longValue())) throw forbidden("Task must not be sub-task of itself.");
-		taskDb.save(task.patch(json));
-		var tagList = tagService().getTags(TASK, taskId, user);
-		messageBus().dispatch(new TaskEvent(user,new TaggedTask(task,tagList), UPDATE));
+		task = taskDb.save(task.patch(json)).tags(tagService().getTags(TASK, taskId, user));
+		messageBus().dispatch(new TaskEvent(user, task, old));
 		return sendContent(ex, task);
 	}
 
@@ -405,8 +388,8 @@ public class TaskModule extends BaseHandler implements TaskService {
 		if ((tagList == null || tagList.isEmpty())) tagList = tagService().getTags(PROJECT, projectId, user);
 		if (tagList != null && !tagList.isEmpty()) tagService().save(TASK, task.id(), null, tagList);
 		task = loadMembers(task);
-
-		messageBus().dispatch(new TaskEvent(user,new TaggedTask(task,tagList), CREATE));
+		task.tags(tagList);
+		messageBus().dispatch(new TaskEvent(user, task, CREATE));
 		return sendContent(ex, task);
 	}
 
@@ -447,6 +430,6 @@ public class TaskModule extends BaseHandler implements TaskService {
 	}
 
 	private Map<Long, Task> addTags(Map<Long, Task> taskList, Map<Long, ? extends Collection<String>> tags) {
-		return taskList.values().stream().map(task -> new TaggedTask(task, tags.get(task.id()))).collect(Collectors.toMap(Task::id, t -> t));
+		return taskList.values().stream().map(task -> task.tags(tags.get(task.id()))).collect(Collectors.toMap(Task::id, t -> t));
 	}
 }