Refactor TxManager and TxNameGenerator experimental API

Co-authored-by: Alexander Lavrukov <[email protected]>

Author: lavrukov

util/src/main/java/tech/ydb/yoj/util/lang/CallStack.java renamed to repository/src/main/java/tech/ydb/yoj/repository/db/CallStack.java

@@ -1,4 +1,4 @@
-package tech.ydb.yoj.util.lang;
+package tech.ydb.yoj.repository.db;
 
 import java.lang.StackWalker.StackFrame;
 import java.util.ArrayList;
@@ -11,7 +11,7 @@
 
 import static java.lang.StackWalker.Option.RETAIN_CLASS_REFERENCE;
 
-public final class CallStack {
+final class CallStack {
     private final ConcurrentMap<FrameKey, Object> mapperCache = new ConcurrentHashMap<>();
 
     public FrameResult findCallingFrame() {

repository/src/main/java/tech/ydb/yoj/repository/db/StdTxManager.java

@@ -13,20 +13,19 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.slf4j.MDC;
-import tech.ydb.yoj.DeprecationWarnings;
 import tech.ydb.yoj.repository.db.cache.TransactionLog;
+import tech.ydb.yoj.repository.db.exception.QueryInterruptedException;
 import tech.ydb.yoj.repository.db.exception.RetryableException;
-import tech.ydb.yoj.util.lang.CallStack;
 import tech.ydb.yoj.util.lang.Strings;
 
 import javax.annotation.Nullable;
 import java.time.Duration;
-import java.util.Set;
 import java.util.concurrent.atomic.AtomicLong;
 import java.util.function.Supplier;
 
 import static java.lang.String.format;
 import static java.util.Objects.requireNonNull;
+import static java.util.concurrent.TimeUnit.MILLISECONDS;
 import static tech.ydb.yoj.repository.db.IsolationLevel.ONLINE_CONSISTENT_READ_ONLY;
 import static tech.ydb.yoj.repository.db.IsolationLevel.SERIALIZABLE_READ_WRITE;
 
@@ -45,17 +44,8 @@
  */
 @RequiredArgsConstructor(access = AccessLevel.PRIVATE)
 public final class StdTxManager implements TxManager, TxManagerState {
-    /**
-     * @deprecated Please stop using the {@code StdTxManager.useNewTxNameGeneration} field.
-     * Changing this field has no effect as of YOJ 2.6.1, and it will be <strong>removed completely</strong> in YOJ 2.7.0.
-     */
-    @Deprecated(forRemoval = true)
-    public static volatile boolean useNewTxNameGeneration = true;
-
     private static final Logger log = LoggerFactory.getLogger(StdTxManager.class);
 
-    private static final CallStack callStack = new CallStack();
-
     private static final int DEFAULT_MAX_ATTEMPT_COUNT = 100;
     private static final double[] TX_ATTEMPTS_BUCKETS = new double[]
             {1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 14, 16, 18, 20, 25, 35, 40, 45, 50, 60, 70, 80, 90, 100};
@@ -92,19 +82,13 @@ public final class StdTxManager implements TxManager, TxManagerState {
     @With(AccessLevel.PRIVATE)
     private final int maxAttemptCount;
     @With
-    private final String name;
-    @With(AccessLevel.PRIVATE)
-    private final Integer logLine;
-    @With
     @Getter
     private final String logContext;
     @With(AccessLevel.PRIVATE)
     private final TxOptions options;
     @With(AccessLevel.PRIVATE)
     private final SeparatePolicy separatePolicy;
     @With
-    private final Set<String> skipCallerPackages;
-    @With
     private final TxNameGenerator txNameGenerator;
 
     private final long txLogId = txLogIdSeq.incrementAndGet();
@@ -113,25 +97,16 @@ public StdTxManager(@NonNull Repository repository) {
         this(
                 /*         repository */ repository,
                 /*    maxAttemptCount */ DEFAULT_MAX_ATTEMPT_COUNT,
-                /*               name */ null,
-                /*            logLine */ null,
                 /*         logContext */ null,
                 /*            options */ TxOptions.create(SERIALIZABLE_READ_WRITE),
                 /*     separatePolicy */ SeparatePolicy.LOG,
-                /* skipCallerPackages */ Set.of(),
-                /*    txNameGenerator */ TxNameGenerator.SHORT
+                /*    txNameGenerator */ new TxNameGenerator.Default()
         );
     }
 
-    /**
-     * @deprecated Constructor is in YOJ 2.x for backwards compatibility, an will be removed in YOJ 3.0.0. Please construct
-     * {@link #StdTxManager(Repository)} and customize it using the {@code with<...>()} methods instead.
-     */
-    @Deprecated(forRemoval = true)
-    public StdTxManager(Repository repository, int maxAttemptCount, String name, Integer logLine, String logContext, TxOptions options) {
-        this(repository, maxAttemptCount, name, logLine, logContext, options, SeparatePolicy.LOG, Set.of(), TxNameGenerator.SHORT);
-        DeprecationWarnings.warnOnce("StdTxManager(Repository, int, String, Integer, String, TxOptions)",
-                "Please use the recommended StdTxManager(Repository) constructor and customize the TxManager by using with<...>() methods");
+    @Override
+    public StdTxManager withName(String name) {
+        return withTxNameGenerator(new TxNameGenerator.Constant(name));
     }
 
     @Override
@@ -215,25 +190,27 @@ public void tx(Runnable runnable) {
 
     @Override
     public <T> T tx(Supplier<T> supplier) {
-        if (name == null) {
-            return withGeneratedNameAndLine().tx(supplier);
-        }
+        TxName txName = txNameGenerator.generate();
+        String name = txName.name();
 
-        checkSeparatePolicy(separatePolicy, name);
-        return txImpl(supplier);
-    }
+        checkSeparatePolicy(separatePolicy, txName.logName());
 
-    private <T> T txImpl(Supplier<T> supplier) {
         RetryableException lastRetryableException = null;
         TxImpl lastTx = null;
         try (Timer ignored = totalDuration.labels(name).startTimer()) {
             for (int attempt = 1; attempt <= maxAttemptCount; attempt++) {
                 try {
                     attempts.labels(name).observe(attempt);
                     T result;
-                    try (var ignored1 = attemptDuration.labels(name).startTimer()) {
-                        lastTx = new TxImpl(name, repository.startTransaction(options), options);
-                        result = runAttempt(supplier, lastTx);
+                    try (
+                            var ignored1 = attemptDuration.labels(name).startTimer();
+                            var ignored2 = MDC.putCloseable("tx", formatTx(txName));
+                            var ignored3 = MDC.putCloseable("tx-id", formatTxId());
+                            var ignored4 = MDC.putCloseable("tx-name", txName.logName())
+                    ) {
+                        RepositoryTransaction transaction = repository.startTransaction(options);
+                        lastTx = new TxImpl(name, transaction, options);
+                        result = lastTx.run(supplier);
                     }
 
                     if (options.isDryRun()) {
@@ -247,7 +224,12 @@ private <T> T txImpl(Supplier<T> supplier) {
                     retries.labels(name, getExceptionNameForMetric(e)).inc();
                     lastRetryableException = e;
                     if (attempt + 1 <= maxAttemptCount) {
-                        e.sleep(attempt);
+                        try {
+                            MILLISECONDS.sleep(e.getRetryPolicy().calcDuration(attempt).toMillis());
+                        } catch (InterruptedException ex) {
+                            Thread.currentThread().interrupt();
+                            throw new QueryInterruptedException("DB query interrupted", ex);
+                        }
                     }
                 } catch (Exception e) {
                     results.labels(name, "rollback").inc();
@@ -284,49 +266,14 @@ private String getExceptionNameForMetric(RetryableException e) {
         return Strings.removeSuffix(e.getClass().getSimpleName(), "Exception");
     }
 
-    private <T> T runAttempt(Supplier<T> supplier, TxImpl tx) {
-        try (var ignored2 = MDC.putCloseable("tx", formatTx());
-             var ignored3 = MDC.putCloseable("tx-id", formatTxId());
-             var ignored4 = MDC.putCloseable("tx-name", formatTxName(false))) {
-            return tx.run(supplier);
-        }
-    }
-
-    private StdTxManager withGeneratedNameAndLine() {
-        record TxInfo(String name, int lineNumber) {
-        }
-
-        if (!useNewTxNameGeneration) {
-            DeprecationWarnings.warnOnce("StdTxManager.useNewTxNameGeneration",
-                    "Setting StdTxManager.useNewTxNameGeneration has no effect. Please stop setting this field, it will be removed in YOJ 2.7.0");
-        }
-
-        var info = callStack.findCallingFrame()
-                .skipPackage(StdTxManager.class.getPackageName())
-                .skipPackages(skipCallerPackages)
-                .map(
-                        f -> new TxInfo(
-                                txNameGenerator.nameFor(f.getClassName(), f.getMethodName()),
-                                f.getLineNumber()
-                        ),
-                        txNameGenerator
-                );
-
-        return withName(info.name).withLogLine(info.lineNumber);
-    }
-
-    private String formatTx() {
-        return formatTxId() + " {" + formatTxName(true) + "}";
+    private String formatTx(TxName txName) {
+        return formatTxId() + " {" + txName.logName() + (logContext != null ? "/" + logContext : "") + "}";
     }
 
     private String formatTxId() {
         return Strings.leftPad(Long.toUnsignedString(txLogId, 36), 6, '0') + options.getIsolationLevel().getTxIdSuffix();
     }
 
-    private String formatTxName(boolean withContext) {
-        return name + (logLine != null ? ":" + logLine : "") + (withContext && logContext != null ? "/" + logContext : "");
-    }
-
     @Override
     public TxManagerState getState() {
         return this;

repository/src/main/java/tech/ydb/yoj/repository/db/TxName.java

@@ -0,0 +1,7 @@
+package tech.ydb.yoj.repository.db;
+
+public record TxName(
+        String name,
+        String logName
+) {
+}

repository/src/main/java/tech/ydb/yoj/repository/db/TxNameGenerator.java

@@ -1,20 +1,19 @@
 package tech.ydb.yoj.repository.db;
 
-import lombok.NonNull;
+import tech.ydb.yoj.ExperimentalApi;
 
+import java.util.Set;
 import java.util.regex.Pattern;
 
 /**
  * Generates default name for a transaction, depending on the caller class and caller method names.
  */
+@ExperimentalApi(issue = "https://github.com/ydb-platform/yoj-project/issues/188")
 public interface TxNameGenerator {
     /**
-     * @param className  caller class name
-     * @param methodName caller method name
      * @return transaction name
      */
-    @NonNull
-    String nameFor(@NonNull String className, @NonNull String methodName);
+    TxName generate();
 
     /**
      * Generates short tx names of the form {@code ClNam#meNa} (from {@code package.name.ClassName[$InnerClassName]} and {@code methodName}).
@@ -25,76 +24,82 @@ public interface TxNameGenerator {
      * <strong>The disadvantage is that short tx names are not particularly human-readable.</strong>
      *
      * <p>This is the classic YOJ default tx name generator, used since YOJ 1.0.0.
-     *
-     * @see #LONG
-     * @see #NONE
      */
-    TxNameGenerator SHORT = new TxNameGenerator() {
+    final class Default implements TxNameGenerator {
         private static final Pattern PACKAGE_PATTERN = Pattern.compile(".*\\.");
         private static final Pattern INNER_CLASS_PATTERN_CLEAR = Pattern.compile("\\$.*");
         private static final Pattern SHORTEN_NAME_PATTERN = Pattern.compile("([A-Z][a-z]{2})[a-z]+");
+        private static final CallStack callStack = new CallStack();
 
-        @NonNull
-        @Override
-        public String nameFor(@NonNull String className, @NonNull String methodName) {
-            var cn = replaceFirst(className, PACKAGE_PATTERN, "");
-            cn = replaceFirst(cn, INNER_CLASS_PATTERN_CLEAR, "");
-            cn = replaceAll(cn, SHORTEN_NAME_PATTERN, "$1");
-            var mn = replaceAll(methodName, SHORTEN_NAME_PATTERN, "$1");
-            return cn + '#' + mn;
+        private final Set<String> packagesToSkip;
+
+        public Default(String... packagesToSkip) {
+            this.packagesToSkip = Set.of(packagesToSkip);
         }
 
         @Override
-        public String toString() {
-            return "TxNameGenerator.SHORT";
+        public TxName generate() {
+            var stack = getStackResult(callStack, packagesToSkip);
+
+            return stack.map(frame -> {
+                String className = PACKAGE_PATTERN.matcher(frame.getClassName()).replaceFirst("");
+                className = INNER_CLASS_PATTERN_CLEAR.matcher(className).replaceFirst("");
+                className = SHORTEN_NAME_PATTERN.matcher(className).replaceAll("$1");
+                String mn = SHORTEN_NAME_PATTERN.matcher(frame.getMethodName()).replaceAll("$1");
+                String name = className + '#' + mn;
+                return buildDefaultTxInfo(name, frame.getLineNumber());
+            });
         }
-    };
+    }
 
     /**
      * Generates long transaction names of the form {@code ClassName.methodName[$InnerClassName]}
      * (from {@code package.name.ClassName[$InnerClassName]} and {@code methodName}).
      * Inner class names, including anonymous class names, are kept in the {@code Class.getName()} format ({@code $<inner class name>}).
-     *
-     * @see #SHORT
-     * @see #NONE
      */
-    TxNameGenerator LONG = new TxNameGenerator() {
+    final class Long implements TxNameGenerator {
         private static final Pattern PACKAGE_PATTERN = Pattern.compile(".*\\.");
+        private static final CallStack callStack = new CallStack();
 
-        @NonNull
-        @Override
-        public String nameFor(@NonNull String className, @NonNull String methodName) {
-            var cn = replaceFirst(className, PACKAGE_PATTERN, "");
-            return cn + '.' + methodName;
-        }
+        private final Set<String> packagesToSkip;
 
-        @Override
-        public String toString() {
-            return "TxNameGenerator.LONG";
+        public Long(String... packagesToSkip) {
+            this.packagesToSkip = Set.of(packagesToSkip);
         }
-    };
 
-    /**
-     * Prohibits starting transactions without explicitly setting transaction name via {@link TxManager#withName(String)}.
-     */
-    TxNameGenerator NONE = new TxNameGenerator() {
-        @NonNull
         @Override
-        public String nameFor(@NonNull String className, @NonNull String methodName) {
-            throw new IllegalStateException("Transaction name must be explicitly set via TxManager.withName()");
-        }
+        public TxName generate() {
+            var stack = getStackResult(callStack, packagesToSkip);
 
-        @Override
-        public String toString() {
-            return "TxNameGenerator.NONE";
+            return stack.map(frame -> {
+                String className = PACKAGE_PATTERN.matcher(frame.getClassName()).replaceFirst("");
+                String name = className + '.' + frame.getMethodName();
+                return buildDefaultTxInfo(name, frame.getLineNumber());
+            });
         }
-    };
+    }
+
+    private static TxName buildDefaultTxInfo(String name, int lineNumber) {
+        String logName = name + ":" + lineNumber;
+        return new TxName(name, logName);
+    }
 
-    private static String replaceFirst(String input, Pattern regex, String replacement) {
-        return regex.matcher(input).replaceFirst(replacement);
+    private static CallStack.FrameResult getStackResult(CallStack callStack, Set<String> packagesToSkip) {
+        return callStack.findCallingFrame()
+                .skipPackage(StdTxManager.class.getPackageName())
+                .skipPackages(packagesToSkip);
     }
 
-    private static String replaceAll(String input, Pattern regex, String replacement) {
-        return regex.matcher(input).replaceAll(replacement);
+    final class Constant implements TxNameGenerator {
+        private final TxName txName;
+
+        public Constant(String name) {
+            this.txName = new TxName(name, name);
+        }
+
+        @Override
+        public TxName generate() {
+            return txName;
+        }
     }
 }