Atomicfu stabilization plan

[mvicsokolova]

This issue will track the progress of atomicfu stabilization.

✅ - Done
⏳ - Postponed for some reason
🛠️ - In progress
🟨 - Not started yet

Roadmap REVIEWED:

UPD 0.23.0 release:

• Native compiler plugin will be enabled in kotlinx.coroutines: Update atomicfu to 0.23.0 kotlinx.coroutines#3942 ✅
• JVM compiler plugin is also enabled in kotlinx.coroutines. ✅

After update to 1.9.20:

• JVM: compiler plugin is enabled by default and may be turned off with a flag in atomicfu gradle extension, JVM bytecode transformer is deprecated and ready to be removed. ❌
  JVM IR compiler plugin transformations are not enabled by default yet, because not all main atomicfu users migrated to compiler plugin transformations yet (e.g. ktor). There is WIP migrating all the projects to IR transformations.
• Native: compiler plugin may be enabled with a flag ✅.
• JS: compiler plugin may be enabled with a flag, legacy JS transformer is deprecated and ready to be removed. ➖
  JS legacy transformer may be removed, because usage of JS Legacy target is an error since Kotlin 1.9.0. JS IR transformations were not enabled by default due to the remaining unresolved problems in the compiler plugin. ❌

After update to 2.0:

• JVM: JVM bytecode transformer is removed.
• JS: legacy JS transformer is removed, compiler plugin is enabled by default.
• Native: compiler plugin is enabled by default.

---

Update of the plan

I've updated the plan and restructured the focus a little. Here are the main priority tasks critical for stabilisation:

As it was stated previously kotlinx-atomicfu should get rid of bytecode legacy transformation and enable compiler plugin transformations by default. Prior to enabling compiler transformations by default, we should make sure that all major atomicfu users have compiler transformation already enabled, and figure out the reason if they still use legacy transformation. Here is the current status (more projects will be added).

1. Enable compiler plugin transformations:

kotlinx.coroutines (flags):
JVM: ✅
Native: ✅
JS: ❌

• incremental compilation bug (TODO: add a ticket here)

Compose (flags):
JVM: ✅ 🛠️ (with WA)
Native: ✅
JS: ✅

• KT-65645

ktor (flags):
JVM: 🛠️
Native: 🛠️
JS: ❌

Here is the PR that enables JVM and Native compiler plugin transformations in ktor: ktorio/ktor#4018

2. JVM bytecode transformation should be removed.

• Deprecate JVM bytecode transformer #338 ⏳
  Will be done when JVM IR transformations are enabled by default.

3. Plugin application should become easy and documented:

• Publish Gradle plugin to https://plugins.gradle.org #56 🛠️
• Improve atomicfu gradle extension  #341 🟨
• ClassNotFoundException AtomicfuKotlinGradleSubplugin$AtomicfuKotlinGradleExtension #399 ✅
• The problem of 2 atomicfu gradle plugins #370 ✅
  Moving to the kotlin repo is postponed until compiler plugin transformations are not enabled by default. See the full resolution in the last comment of the issue.
  UPD: The current solution was to move the logic of the gradle plugin in kotlin repo to the library. See Move the logic from koltin repo atomicfu gradle plugin to the gradle plugin in the library. #406

4. Documentation:

• Documentation improvements 📃 #368 🟨

---

And here is the backlog that should be steadily fixed as well:

Compiler plugin:
Here is the backlog compiler plugin issues: #kotlinx-atomicfu

Library:

• Consider getting rid of common locks and posix interop #324 🟨
• JS: get rid of atomicfu-runtime package in the compiler plugin: KT-61611 🟨
• Further enhancements of integration testing #362 🛠️
  More integration tests were added for different project configurations.
• Add tests to check compatibility of AGP with lower Kotlin versions  #387 🟨

[mvicsokolova]

This way of tracking the stabilization process was too hard to support, and was replaced by the GH Project.

[mgroth0]

Thanks for the update. Is that new plan page public?