Merge branch 'master' into refactor-for-otel

Author: mhdirkse

.github/workflows/test-with-ff.js.yml

@@ -184,10 +184,10 @@ jobs:
       - name: Copy cypress.config_cicd.ts to cypress.config.ts to listen to correct port
         working-directory: ladybug/ladybug-ff-cypress-test
         run: cp cypress.config_cicd.ts cypress.config.ts
-      - name: Use Node.js 20.x
+      - name: Use Node.js 24.x
         uses: actions/setup-node@v4
         with:
-          node-version: 20.x
+          node-version: 24.x
           cache: "yarn"
           cache-dependency-path: "**/yarn.lock"
       - name: Update yarn

.gitignore

@@ -20,3 +20,4 @@ wip
 skip-replace-inject.txt
 .flattened-pom.xml
 FrankConfig.xsd
+CLAUDE_CONTEXT.md

ladybug-common/src/main/java/org/wearefrank/ladybug/Config.java

@@ -1,5 +1,5 @@
 /*
-   Copyright 2022-2025 WeAreFrank!
+   Copyright 2022-2026 WeAreFrank!
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -234,6 +234,16 @@ List<String> metadataNames() {
 		metadataNames.add("numberOfCheckpoints");
 		metadataNames.add("estimatedMemoryUsage");
 		metadataNames.add("storageSize");
+		// Metadata name "host" is known but it should not be shown by default.
+		// Class TestTool fills it with the IP address by which the device running
+		// Ladybug is accessed. Instrumented applications can also assign a different
+		// value to metadata item "host".
+		//
+		// Metadata name "application" is special because it is decided
+		// dynamically whether it is shown in the table of the debug tab in
+		// the Angular UI. See class View for the logic that will omit
+		// "application" as metadata name from a view when not relevant.
+		metadataNames.add("application");
 		return metadataNames;
 	}
 
@@ -257,6 +267,8 @@ ReportXmlTransformer reportXmlTransformer() {
 	@DefaultBean
 	@Bean
 	@Scope("singleton")
+	// ladybug-test-webapp and the Frank!Framework have their own implementation
+	// that supersede this default.
 	String xsltResource() {
 		return "ladybug/default.xslt";
 	}

ladybug-common/src/main/java/org/wearefrank/ladybug/MetadataExtractor.java

@@ -1,5 +1,5 @@
 /*
-   Copyright 2020, 2022-2025 WeAreFrank!, 2018-2019 Nationale-Nederlanden
+   Copyright 2020, 2022-2026 WeAreFrank!, 2018-2019 Nationale-Nederlanden
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -112,6 +112,12 @@ public String getLabel(String metadataName) {
 			if (metadataName.equals("duration")) {
 				return "Duration";
 			}
+			if (metadataName.equals("host")) {
+				return "Host";
+			}
+			if (metadataName.equals("application")) {
+				return "Application";
+			}
 			for (MetadataFieldExtractor metadataFieldExtractor : metadataFieldExtractors) {
 				if (metadataFieldExtractor.getName().equals(metadataName)) {
 					label = metadataFieldExtractor.getLabel();
@@ -167,6 +173,12 @@ public String getShortLabel(String metadataName) {
 			if (metadataName.equals("duration")) {
 				return "Duration";
 			}
+			if (metadataName.equals("host")) {
+				return "Host";
+			}
+			if (metadataName.equals("application")) {
+				return "Application";
+			}
 			for (MetadataFieldExtractor metadataFieldExtractor : metadataFieldExtractors) {
 				if (metadataFieldExtractor.getName().equals(metadataName)) {
 					shortLabel = metadataFieldExtractor.getShortLabel();
@@ -225,6 +237,12 @@ private Object getMetadataAsObject(Report report, String metadataName) {
 		if (metadataName.equals("duration")) {
 			return Long.valueOf(report.getEndTime() - report.getStartTime());
 		}
+		if (metadataName.equals("host")) {
+			return report.getHost();
+		}
+		if (metadataName.equals("application")) {
+			return report.getApplication();
+		}
 		if (metadataName.equals("variables")) {
 			return report.getVariables();
 		}

ladybug-common/src/main/java/org/wearefrank/ladybug/Report.java

@@ -83,7 +83,10 @@ public class Report implements Serializable {
 	private List<Checkpoint> checkpoints = new ArrayList<Checkpoint>();
 	private @Setter @Getter String transformation;
 	private Map<String, String> variables;
-	private @Setter @Getter boolean rerunnable = true;
+
+	private @Getter @Setter String host;
+	private @Getter @Setter String application;
+
 	// Please note that the get and set methods need @Transient annotation for XmlEncoder to not store the property.
 	// This is in contrast to serialization / ObjectOutputStream that is using variables (and doesn't look at get and
 	// set methods) and needs a variable to be declared transient to not store the field.
@@ -903,6 +906,8 @@ public Report clone() throws CloneNotSupportedException {
 			variables.putAll(getVariables());
 			report.setVariables(variables);
 		}
+		report.setHost(host);
+		report.setApplication(application);
 		List<Checkpoint> checkpoints = new ArrayList<Checkpoint>();
 		for (Checkpoint checkpoint : this.checkpoints) {
 			checkpoint = checkpoint.clone();
@@ -936,6 +941,12 @@ public String toXml(ReportRunner reportRunner) {
 			builder.append(" EndTime=\"" + endTime + "\"");
 			builder.append(" NumberOfCheckpoints=\"" + getNumberOfCheckpoints() + "\"");
 			builder.append(" EstimatedMemoryUsage=\"" + getEstimatedMemoryUsage() + "\"");
+			if (getHost() != null) {
+				builder.append(" Host=\"" + getHost() + "\"");
+			}
+			if (getApplication() != null) {
+				builder.append(" Application=\"" + getApplication() + "\"");
+			}
 			builder.append(">");
 			for (Checkpoint checkpoint : checkpoints) {
 				String message;

ladybug-common/src/main/java/org/wearefrank/ladybug/TestTool.java

@@ -16,6 +16,8 @@
 package org.wearefrank.ladybug;
 
 import java.lang.invoke.MethodHandles;
+import java.net.InetAddress;
+import java.net.UnknownHostException;
 import java.rmi.server.UID;
 import java.util.ArrayList;
 import java.util.HashMap;
@@ -106,15 +108,37 @@ public class TestTool {
     private @Setter String openTelemetryEndpoint;
 	private Tracer tracer;
 
+	private @Getter @Setter String host = null;
+	private @Getter @Setter String application = null;
+
 	private AtomicInteger inProgressStorageNameSeq = new AtomicInteger(0);
 
+	public TestTool() {
+		initializeHostAstIpAddress();
+	}
+
 	@PostConstruct
 	public void init() {
+		for (View view: views) {
+			view.setTestTool(this);
+		}
 		if (openTelemetryEndpoint != null) {
 			tracer = OpenTelemetryUtil.getOpenTelemetryTracer(openTelemetryEndpoint);
 		}
 	}
 
+	private void initializeHostAstIpAddress() {
+		try {
+			InetAddress localMachine = InetAddress.getLocalHost();
+			String ipAddress = localMachine.getHostAddress();
+			// It would be nice to log this IP address, but that requires quite a big change of
+			// the test code. The test code would have to ignore the log statement.
+			this.host = ipAddress;
+		} catch(UnknownHostException uhe) {
+			log.error("Cannot initialize host because of UnknownHostException", uhe);
+		}
+	}
+
 	public void reset() {
 		regexFilter = defaultRegexFilter;
 		reportGeneratorEnabled = defaultReportGeneratorEnabled;
@@ -414,6 +438,8 @@ private Report createReport(String correlationId, String name, int checkpointTyp
 		if (checkpointType == CheckpointType.STARTPOINT.toInt()) {
 			log.debug("Create new report for '" + correlationId + "'");
 			report = new Report();
+			report.setHost(host);
+			report.setApplication(application);
 			report.setStartTime(System.currentTimeMillis());
 			report.setTestTool(this);
 			report.setCorrelationId(correlationId);
@@ -1282,4 +1308,4 @@ public static String getSpecificationVersion() {
 	public static String getImplementationVersion() {
 		return Package.getPackage("org.wearefrank.ladybug").getImplementationVersion();
 	}
-}
+}

ladybug-common/src/main/java/org/wearefrank/ladybug/filter/View.java

@@ -16,8 +16,11 @@
 package org.wearefrank.ladybug.filter;
 
 import java.util.ArrayList;
+import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
+import java.util.stream.Collectors;
 
 import org.springframework.beans.factory.annotation.Autowired;
 
@@ -29,6 +32,7 @@
 import org.wearefrank.ladybug.Checkpoint;
 import org.wearefrank.ladybug.MetadataExtractor;
 import org.wearefrank.ladybug.Report;
+import org.wearefrank.ladybug.TestTool;
 import org.wearefrank.ladybug.echo2.BeanParent;
 import org.wearefrank.ladybug.echo2.Echo2Application;
 import org.wearefrank.ladybug.echo2.reports.ReportsComponent;
@@ -42,7 +46,10 @@ public class View implements BeanParent {
 	protected String name;
 	protected String nodeLinkStrategy;
 	private @Setter @Getter @Inject @Autowired Storage debugStorage;
-	private @Setter @Getter @Inject @Resource(name="metadataNames") List<String> metadataNames;
+	private @Setter @Inject @Resource(name="metadataNames") List<String> metadataNames;
+	// No autowired annotation here, otherwise we would have a circular dependency.
+	// This member variable is instantiated by class TestTool.
+	private @Setter TestTool testTool;
 	private Map<String, String> metadataFilter;
 	private List<CheckpointMatcher> checkpointMatchers;
 	private BeanParent beanParent;
@@ -74,6 +81,20 @@ public String getNodeLinkStrategy() {
 		return nodeLinkStrategy;
 	}
 
+	// Metadata name "application" is special because it is determined dynamically whether it is returned
+	// by a View. When a database storage is used and when the database stores reports from different
+	// applications, showing column "application" in the metadata table of the debug tab makes sense.
+	// If the storage only holds reports of a single application, then metadata name "application"
+	// should be omitted. We want that these two situations do not require different Spring configurations
+	// for Ladybug. This is the reason we have this method to filter the metadata names.
+	public List<String> getMetadataNames() {
+		Set<String> omit = new HashSet<>();
+		if(testTool.getApplication() == null) {
+			omit.add("application");
+		}
+		return metadataNames.stream().filter(n -> !omit.contains(n)).collect(Collectors.toList());
+	}
+
 	public void setMetadataFilter(Map<String, String> metadataFilter) {
 		this.metadataFilter = metadataFilter;
 	}

ladybug-common/src/main/java/org/wearefrank/ladybug/storage/database/DatabaseStorage.java

@@ -177,6 +177,7 @@ public long getMaxStorageDays() {
 
 	@PostConstruct
 	public void init() throws StorageException {
+		log.debug("DatabaseStorage uses metadata names {}", metadataNames);
 		if (!(getMetadataNames() != null && getMetadataNames().contains(getStorageIdColumn()))) {
 			throw new StorageException("List metadataNames " + metadataNames
 					+ " should at least contain storageId column name '" + getStorageIdColumn() + "'");

ladybug-common/src/main/java/org/wearefrank/ladybug/storage/proofofmigration/ProofOfMigrationErrorsView.java

@@ -1,5 +1,5 @@
 /*
-   Copyright 2022, 2024, 2025 WeAreFrank!
+   Copyright 2022, 2024, 2025, 2026 WeAreFrank!
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

ladybug-common/src/main/java/org/wearefrank/ladybug/storage/proofofmigration/ProofOfMigrationStorage.java

@@ -1,5 +1,5 @@
 /*
-   Copyright 2022-2025 WeAreFrank!
+   Copyright 2022-2026 WeAreFrank!
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -216,6 +216,8 @@ public Report getReport(Integer storageId) throws StorageException {
 					return list;
 				});
 		Report report = new Report();
+		// Host and application are not set. This is not a report originating from
+		// a Java application that is tested with Ladybug.
 		report.setTestTool(testTool);
 		report.setStorage(this);
 		report.setStorageId(storageId);