Support Spring framework integration by zhelenskiy · Pull Request #970 · JetBrains/lincheck

zhelenskiy · 2026-03-01T17:41:44Z

Support the Spring framework by initiating recording from the program's startup and ending with its shutdown.
Additionally, address and resolve several minor bugs.

…hing with its shutdown. Also, fix several negligible bugs.

zhelenskiy · 2026-03-01T18:54:00Z

The problem is that such a prefix is added to every trace, so it is necessary to regenerate it in the tests.

eupp · 2026-03-04T14:11:10Z

common/src/main/org/jetbrains/lincheck/trace/TraceContext.kt

    val methodPool = DescriptorPool<MethodDescriptor>()
    val fieldPool = DescriptorPool<FieldDescriptor>()
    val variablePool = DescriptorPool<VariableDescriptor>()
+    private val anonymousThreadCounter = AtomicInteger(0)


Why do you need a separate counter for anonymous threads?
Why not just print "anonymous-thread-$id"?

Also, consider changing the thread name to "unknown-thread-$id".

To create unique names for displaying.

Is it ok for us?

eupp · 2026-03-04T14:11:52Z

common/src/main/org/jetbrains/lincheck/util/Libs.kt

+    className.startsWith("sun.rmi.") -> true
+    className.startsWith("javax.") -> true
+


These 2 are not spring-related.

Generally, Spring classes are still shown, so none of the logic makes sense.

eupp · 2026-03-04T14:12:57Z

common/src/main/org/jetbrains/lincheck/util/Libs.kt

+
+    className.startsWith("org.apache.logging.") -> true
+    className.startsWith("org.apache.logging.log4j.") -> true
+    className.startsWith("org.apache.juli.logging.") -> true


Let's move these to isRecognizedLoggingLibraryClass

eupp · 2026-03-04T14:21:39Z

jvm-agent/src/main/org/jetbrains/lincheck/jvm/agent/LincheckClassFileTransformer.kt

-                       )
+                    (a.startsWith("set") && b.startsWith("get"))
+                            || (a.startsWith("get") && b.startsWith("set"))
+                    )


Please rollback

It's unnecessary indentation change.
The original indentation keeps the same indentation for all disjuncts.

But it contradicts the official formatting guidelines.

eupp · 2026-03-04T14:21:48Z

jvm-agent/src/main/org/jetbrains/lincheck/jvm/agent/LincheckClassFileTransformer.kt


        // Special case: on-line setter and getter for same name can share this line
-        for (i in 0 ..< allMethods.size - 1) {
+        for (i in 0..<allMethods.size - 1) {


Please rollback

IMO 0<..N is harder to read, and it is a weird exception from other binary operators that are surrounded by spaces (e.g., you don't write 0<N, but 0 < N).

I know it's recommended formatting by Kotlin styleguide, but I found it inconvenient and inconsistent.

BTW, it can be converted to

Suggested change

for (i in 0..<allMethods.size - 1) {

for (i in allMethods.indices) {

eupp · 2026-03-04T14:23:41Z

jvm-agent/src/main/org/jetbrains/lincheck/jvm/agent/TransformationProfile.kt


    if (isRecognizedUninstrumentedThirdPartyLibraryClass(className)) return true

+    if (isSpringRelatedClass(className)) return true


Let's exclude spring classes only for Trace Recorder for now.

eupp · 2026-03-04T14:23:46Z

jvm-agent/src/main/org/jetbrains/lincheck/jvm/agent/TransformationProfile.kt

    if (isIntellijRuntimeAgentClass(className))
        return true

+    if (isSpringRelatedClass(className))


Let's exclude spring classes only for Trace Recorder for now.

eupp · 2026-03-04T14:28:08Z

trace-recorder/src/main/org/jetbrains/lincheck/trace/recorder/ProgramScopedTraceRecorder.kt

+ * Manages program-scoped trace recording for trace recorder mode.
+ * Recording starts at program startup and stops at shutdown via a shutdown hook.
+ */
+internal object ProgramScopedTraceRecorder {


Let's just port this logic to Tracer.kt instead of adding a new class here.

I believe this logic is now shared and uniform for both Trace Recorder and Live Debugger, so it makes sense to move it there.

Can you also comment here?

I think the answer is in this comment: #970 (comment)

Let's not start tracing for premain in case if class and method agent arguments were passed, let's keep the old behavior for this case (at least temporarily).

So, should I exclude passing the class and method from the Idea plugin side?

eupp · 2026-03-04T14:29:44Z

trace-recorder/src/main/org/jetbrains/lincheck/trace/recorder/ProgramScopedTraceRecorder.kt

+            // BinaryFileStream has a race condition where multiple threads can write descriptors
+            // in the wrong order due to shared ContextSavingState across threads.
+            val effectiveMode = when (mode) {
+                is TraceOutputMode.BinaryFileStream -> TraceOutputMode.BinaryFileDump()


Let's don't change mode silently. Moreover, binary file dump would not scale as it keeps whole trace in-memory.

If there is a but, then please create a YT issue describing the bug and a reproducer.

eupp · 2026-03-04T14:33:05Z

trace-recorder/src/main/org/jetbrains/lincheck/trace/recorder/TraceRecorderAgent.kt

-        override val tracingEntryPointMethodVisitorProvider: TracingEntryPointMethodVisitorProvider
-            get() = ::TraceRecorderMethodTransformer
+        override val tracingEntryPointMethodVisitorProvider: TracingEntryPointMethodVisitorProvider?
+            get() = null


Please rollback.

I believe, at least for backward compatibility reasons, we want to preserve the old behavior for test-like configurations in IDEA plugin. For these configurations, the trace will be started from the test function. If you switch it to static tracing from main right now, it will bloat the trace. We need to fix this problem separately, only after that we can migrate to always starting tracing from main.

For transition period, you can add an option to javaagent arguments. Or check if class and method options were passed, and if not, start tracing from main.

zhelenskiy added 2 commits March 1, 2026 04:09

Support Spring by starting recording from the program start and finis…

f5f9675

…hing with its shutdown. Also, fix several negligible bugs.

Filter out Spring (in progress)

068ea32

zhelenskiy requested a review from eupp March 1, 2026 17:41

zhelenskiy self-assigned this Mar 1, 2026

eupp requested changes Mar 4, 2026

View reviewed changes

		className.startsWith("sun.rmi.") -> true
		className.startsWith("javax.") -> true

	for (i in 0..<allMethods.size - 1) {
	for (i in allMethods.indices) {


		if (isRecognizedUninstrumentedThirdPartyLibraryClass(className)) return true

		if (isSpringRelatedClass(className)) return true

Conversation

zhelenskiy commented Mar 1, 2026

Uh oh!

zhelenskiy commented Mar 1, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zhelenskiy Mar 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

zhelenskiy Mar 5, 2026 •

edited

Loading