Modularization of the project #744

dmitrii-artuhov · 2025-07-04T22:51:53Z

TODOs:

fix publication and lincheck artifact contents (it misses bootstrap.jar, classes from the modules that :core depends on, etc.)
refactor plugins to account for different task names and fat-jars -- PR https://jetbrains.team/p/concurrency-tools/reviews/65/timeline, cc @ivandev0
fix idea plugin integration
try friend modules

build.gradle.kts

buildSrc/src/main/kotlin/TraceAgentTasks.kt

buildSrc/src/main/kotlin/TraceAgentIntegrationTestsTasks.kt

settings.gradle.kts

trace-recorder/src/main/org/jetbrains/kotlinx/lincheck/traceagent/TraceAgent.kt

docs/topics/constraints.md

common/src/main/org/jetbrains/kotlinx/lincheck/util/TraceModes.kt

core/build.gradle.kts

trace/build.gradle.kts

common/build.gradle.kts

dmitrii-artuhov · 2025-07-07T12:49:33Z

Try using friend-paths/associate-source-sets in order to handle the visibility of the classes inside :common (some, like LogLevel, must be available to users, while others, like isInTraceDebugger flag, should not).
Research that. If it does not work, try searching for :private-common/:public-common separation, if it is a thing in gradle world

common/src/main/org/jetbrains/kotlinx/lincheck/trace/CodeLocations.kt

common/src/main/org/jetbrains/kotlinx/lincheck/util/AnalysisSections.kt

common/src/main/org/jetbrains/kotlinx/lincheck/strategy/managed/ShadowStack.kt

common/build.gradle.kts

jvm-agent/build.gradle.kts

common/src/main/org/jetbrains/kotlinx/lincheck/util/AnalysisSections.kt

trace/src/main/org/jetbrains/lincheck/trace/TraceRecorderTracePoints.kt

trace/src/main/org/jetbrains/lincheck/trace/Serialization.kt

trace-debugger/src/main/org/jetbrains/kotlinx/lincheck/trace/debugger/TraceDebuggerAgent.kt

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

dmitrii-artuhov · 2025-07-09T17:32:33Z

build.gradle.kts

@@ -96,7 +136,9 @@ sourceSets {
        val atomicfuVersion: String by project

        compileOnly(project(":bootstrap"))
-        api(project(":trace"))
+        api(project(":common")) // TODO: contains some classes from public lincheck API, refactor so that it does not expose essentially internal classes


Right now :common subproject has one class that should be available to the users of lincheck, which is enum class LogLevel. However, the rest of the symbols in it, are implementation-only. There are 2 options how to deal with that:

[Currently used] make all symbols in :common internal (except for LogLevel) and include in the root project the subproject via api(project(":common")). The problem here is that it is done via friend paths, which lack support in intellij idea, which then marks all usages on internal classes from :common reads and does not provide completion and auto-importing

Create separate "common" modules, one called :api, which will contain LogLevel (and probably other classes in the future, the second one :common with all classes marked as public. Now, the root project will include them as follows: api(project(":api")); implementation(":common"), which allows users to access LogLevel enum and disallows all classes from :common. It also supports proper highlighting and auto-imports as regular.

For now, let's just make public everything that need to be public to work properly both in gradle and IDEA.
Please create a YT issue to set-up internal isolation visibility properly. It is not critical right now, but would be good to fix before next Lincheck release.

For now, let's just make public everything that need to be public to work properly both in gradle and IDEA.

Or use any other solution that would make code work (both in gradle and IDEA) right now, without further design/implementation.

…rchive

…rate subprojects and dependencies)

…cts, because these functions are called from root project for all subprojects

…jvm-agent subproject

… subprojects

… as 'internal'

…ng and completion

…in favor of `implementation(...)`

eupp requested changes Jul 7, 2025

View reviewed changes

dmitrii-artuhov force-pushed the separate-subproject-for-trace-agent branch from e215518 to d3e0b1e Compare July 8, 2025 12:34

dmitrii-artuhov marked this pull request as ready for review July 8, 2025 13:09

dmitrii-artuhov requested a review from eupp July 8, 2025 17:17

eupp requested changes Jul 9, 2025

View reviewed changes

dmitrii-artuhov commented Jul 9, 2025

View reviewed changes

dmitrii-artuhov added 23 commits July 9, 2025 23:44

Move all files to commong module

59bb475

Fix integration tests and hanging lincheck unit tests

0055db6

Fix publishing, make 'common' module to generate 'lincheck' library a…

6824b8e

…rchive

Fix archive naming for 'common' subproject

9347da8

Extract trace agent into separate module

c3ea7df

Add a separate module which will be the only dependency of trace agent

2a7a4d3

Fix comment typo

9e7b001

Renamed modules and prepared module for jvm-agent and transformers

0c3ebc4

Separate project in :core, :common, :jvm-agent subprojects

3d5e0b3

Forgot to append a build script to prev commit

aee599e

Set up different subprojects for trace-debugger and trace-recorder

5f60b73

Remove obsolete code

b1961a1

Set up proper agents for trace debugger and trace recorder (with sepa…

c5cd298

…rate subprojects and dependencies)

Move core files back to the root of the project

a5906df

Set up working publishing for lincheck tool

8d6be2e

Remove useless println's

d942fb3

Remove includes of ':core' subproject

7e8030f

Remove 'configureKotlin' and 'configureJava' invocation from subproje…

52d05cb

…cts, because these functions are called from root project for all subprojects

Simplify builds and tests for trace-debugger/recorder

4c6a7de

Fix paths in documentation

4956769

Extract common flags into a single file

0566726

Move shared classes from :trace to :common subproject

ffe44fb

Change trace agents file names

8677e9c

dmitrii-artuhov added 18 commits July 9, 2025 23:48

Change 'native_call' package name to 'nativecalls'

1e68af7

Rename 'trace_debugger' packages to 'trace.debugger'

e7ef152

Rename 'trace_recorder'/'tracerecorder' packages to 'trace.recorder'

1c40b1a

Refactor trace-debugger/recorder package names

00dac1f

Rename 'traceagent' package to 'trace.agent'

3595990

Add clarifying comments to the trace-recorder transformers stored in …

87a42fd

…jvm-agent subproject

Spare :jvm-agent subproject from dependency to :trace subproject

96d3519

Set up proper visibility (api/implementation) between dependencies of…

45d5c04

… subprojects

Add fixes

13268d3

Add code cleanups

b0035e4

Set up friend paths and mark implementation-only classes in ':common'…

4a43c76

… as 'internal'

Refactor Logger visibility and reorder code in Utils.kt

c55f45f

Add minor fixes from PR

a9cb6dc

Remove 'kotlinx' from trace-recorder/debugger packages

98f0004

Fix the rest of the PR comments

fc257a9

Remove todos and fix some code-style issues

48d7165

Remove useless comments

ebe108b

Make all symbols from ':common' public to have proper IDEA highlighti…

057d8bd

…ng and completion

dmitrii-artuhov force-pushed the separate-subproject-for-trace-agent branch from 377a794 to 057d8bd Compare July 9, 2025 22:46

dmitrii-artuhov added 2 commits July 10, 2025 00:58

Decrease file-diff size

e3f9a0b

Add TODO for removing api(project(":common")) from lincheck "core" …

cd85c3e

…in favor of `implementation(...)`

eupp approved these changes Jul 10, 2025

View reviewed changes

eupp merged commit e9552a0 into develop Jul 10, 2025
25 checks passed

eupp deleted the separate-subproject-for-trace-agent branch July 10, 2025 09:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Modularization of the project #744

Modularization of the project #744

Uh oh!

dmitrii-artuhov commented Jul 4, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dmitrii-artuhov commented Jul 7, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dmitrii-artuhov Jul 9, 2025

Uh oh!

eupp Jul 9, 2025

Uh oh!

eupp Jul 9, 2025

Uh oh!

Uh oh!

Uh oh!

Modularization of the project #744

Modularization of the project #744

Uh oh!

Conversation

dmitrii-artuhov commented Jul 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dmitrii-artuhov commented Jul 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dmitrii-artuhov Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

eupp Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

eupp Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

dmitrii-artuhov commented Jul 4, 2025 •

edited

Loading

dmitrii-artuhov commented Jul 7, 2025 •

edited

Loading