use records for internals

Author: baev

allure-cucumber7-jvm/src/main/java/io/qameta/allure/cucumber7jvm/testsourcemodel/TestSourcesModel.java

@@ -165,6 +165,9 @@ private AstNode createAstNode(final Object node, final AstNode astNode) {
         return new AstNode(node, astNode);
     }
 
+    /**
+     * A node of the parsed Gherkin document tree, linked to its parent for upward traversal.
+     */
     private static class AstNode {
         private final Object node;
         private final AstNode parent;

allure-grpc/src/main/java/io/qameta/allure/grpc/AllureGrpc.java

@@ -443,6 +443,10 @@ private static void copyAsciiResponseMetadata(
         }
     }
 
+    /**
+     * Per-call mutable state of a reported gRPC call: the Allure step identity, the call metadata, and the
+     * client/server messages accumulated while the call is in flight.
+     */
     private static final class StepContext<T, R> {
         private final AllureExternalKey stepKey;
         private final MethodDescriptor<T, R> methodDescriptor;

allure-java-commons/src/main/java/io/qameta/allure/AllureLifecycle.java

@@ -132,6 +132,9 @@ private static String getErrorMessage(final String entityName) {
         return "Could not write Allure " + entityName;
     }
 
+    /**
+     * Writer callback over the open file channel of a result file being written atomically.
+     */
     private interface ChannelConsumer {
 
         void accept(FileChannel channel) throws IOException;

allure-java-commons/src/main/java/io/qameta/allure/FileSystemResultsWriter.java

@@ -266,12 +266,18 @@ private static int utf8Length(final int codePoint) {
         return 4;
     }
 
+    /**
+     * The kind of name-value pair being processed, selecting the matching redaction and formatting rules.
+     */
     private enum NameValueKind {
         HEADER,
         QUERY,
         FORM
     }
 
+    /**
+     * A possibly truncated body value: the retained text, the original size, and whether truncation happened.
+     */
     private record TruncatedValue(String value, Long size, boolean truncated) {
     }
 }

allure-java-commons/src/main/java/io/qameta/allure/http/HttpExchangeProcessor.java

@@ -905,6 +905,9 @@ private String getOrCreateTest(final TestIdentifier testIdentifier) {
         return tests.get().getOrCreate(testIdentifier);
     }
 
+    /**
+     * Thread-safe registry of the Allure uuids assigned to JUnit Platform test identifiers within one launch.
+     */
     private static final class Uuids {
 
         private final Map<TestIdentifier, String> storage = new ConcurrentHashMap<>();

allure-junit-platform/src/main/java/io/qameta/allure/junitplatform/AllureJunitPlatform.java

@@ -111,6 +111,10 @@ static void clear() {
         STATE.remove();
     }
 
+    /**
+     * Per-test mutable registry state: the pages, contexts, and trace sessions observed for the current test, and
+     * the artifact bookkeeping flags used when the test finishes.
+     */
     private static final class State {
         private final Set<Page> pages = identitySet();
         private final Set<BrowserContext> contexts = identitySet();

allure-playwright/src/main/java/io/qameta/allure/playwright/AllurePlaywrightRegistry.java

@@ -64,6 +64,9 @@ private WebDriver toBiDiDriver(final WebDriver driver) {
         return augmented instanceof HasBiDi ? augmented : null;
     }
 
+    /**
+     * Recording session over Selenium BiDi inspectors; closing it closes every registered inspector.
+     */
     private static final class SeleniumRecordingSession implements RecordingSession {
 
         private final List<AutoCloseable> inspectors;

allure-selenium-bidi/src/main/java/io/qameta/allure/seleniumbidi/SeleniumBiDiSessionFactory.java

@@ -447,7 +447,7 @@ public void onTestSuccess(final ITestResult testResult) {
             return;
         }
 
-        final AllureExternalKey testCaseKey = testKey(currentTest.get().getUuid());
+        final AllureExternalKey testCaseKey = testKey(currentTest.get().uuid());
         getLifecycle().updateTest(testCaseKey, setStatus(Status.PASSED));
         getLifecycle().stopTest(testCaseKey);
         getLifecycle().writeTest(testCaseKey);
@@ -490,10 +490,10 @@ public void onTestSkipped(final ITestResult result) {
      */
     private String ensureTestStarted(final ITestResult result) {
         final CurrentTest running = currentTest.get();
-        if (Objects.isNull(running) || running.getSource() != result) {
+        if (Objects.isNull(running) || running.source() != result) {
             onTestStart(result);
         }
-        return currentTest.get().getUuid();
+        return currentTest.get().uuid();
     }
 
     @Override
@@ -570,7 +570,7 @@ private void ifMethodFixtureStarted(final ITestNGMethod testMethod) {
             // linked by its known uuid
             final CurrentTest running = currentTest.get();
             if (nonNull(running)) {
-                getLifecycle().addChildToScope(scopeKey, running.getUuid());
+                getLifecycle().addChildToScope(scopeKey, running.uuid());
             }
             currentAfterMethodScope.set(scopeKey);
         }
@@ -966,22 +966,7 @@ private static boolean isClassAvailableOnClasspath(final String clazz) {
      * The test currently running on a thread: the testng result it belongs to (its invocation identity) and the allure
      * uuid assigned to it.
      */
-    private static final class CurrentTest {
-        private final ITestResult source;
-        private final String uuid;
-
-        private CurrentTest(final ITestResult source, final String uuid) {
-            this.source = source;
-            this.uuid = uuid;
-        }
-
-        private ITestResult getSource() {
-            return source;
-        }
-
-        private String getUuid() {
-            return uuid;
-        }
+    private record CurrentTest(ITestResult source, String uuid) {
     }
 
 }