1# Change log for kotlinx.coroutines 2 3## Version 1.8.1 4 5* Remove the `@ExperimentalTime` annotation from usages of `TimeSource` (#4046). Thanks, @hfhbd! 6* Introduce a workaround for an Android bug that caused an occasional `NullPointerException` when setting the `StateFlow` value on old Android devices (#3820). 7* No longer use `kotlin.random.Random` as part of `Dispatchers.Default` and `Dispatchers.IO` initialization (#4051). 8* `Flow.timeout` throws the exception with which the channel was closed (#4071). 9* Small tweaks and documentation fixes. 10 11### Changelog relative to version 1.8.1-Beta 12 13* `Flow.timeout` throws the exception with which the channel was closed (#4071). 14* Small documentation fixes. 15 16## Version 1.8.1-Beta 17 18* Remove the `@ExperimentalTime` annotation from usages of `TimeSource` (#4046). Thanks, @hfhbd! 19* Attempt a workaround for an Android bug that caused an occasional `NullPointerException` when setting the `StateFlow` value on old Android devices (#3820). 20* No longer use `kotlin.random.Random` as part of `Dispatchers.Default` and `Dispatchers.IO` initialization (#4051). 21* Small tweaks. 22 23## Version 1.8.0 24 25* Implement the library for the Web Assembly (Wasm) for JavaScript (#3713). Thanks @igoriakovlev! 26* Major Kotlin version update: was 1.8.20, became 1.9.21. 27* On Android, ensure that `Dispatchers.Main != Dispatchers.Main.immediate` (#3545, #3963). 28* Fixed a bug that caused `Flow` operators that limit cancel the upstream flow to forget that they were already finished if there is another such operator upstream (#4035, #4038) 29* `kotlinx-coroutines-debug` is published with the correct Java 9 module info (#3944). 30* `kotlinx-coroutines-debug` no longer requires manually setting `DebugProbes.enableCoroutineCreationStackTraces` to `false`, it's the default (#3783). 31* `kotlinx-coroutines-test`: set the default timeout of `runTest` to 60 seconds, added the ability to configure it on the JVM with the `kotlinx.coroutines.test.default_timeout=10s` (#3800). 32* `kotlinx-coroutines-test`: fixed a bug that could lead to not all uncaught exceptions being reported after some tests failed (#3800). 33* `delay(Duration)` rounds nanoseconds up to whole milliseconds and not down (#3920). Thanks @kevincianfarini! 34* `Dispatchers.Default` and the default thread for background work are guaranteed to use the same context classloader as the object containing it them (#3832). 35* It is guaranteed that by the time `SharedFlow.collect` suspends for the first time, it's registered as a subscriber for that `SharedFlow` (#3885). Before, it was also true, but not documented. 36* Atomicfu version is updated to 0.23.1, and Kotlin/Native atomic transformations are enabled, reducing the footprint of coroutine-heavy code (#3954). 37* Added a workaround for miscompilation of `withLock` on JS (#3881). Thanks @CLOVIS-AI! 38* Small tweaks and documentation fixes. 39 40### Changelog relative to version 1.8.0-RC2 41 42* `kotlinx-coroutines-debug` no longer requires manually setting `DebugProbes.enableCoroutineCreationStackTraces` to `false`, it's the default (#3783). 43* Fixed a bug that caused `Flow` operators that limit cancel the upstream flow to forget that they were already finished if there is another such operator upstream (#4035, #4038) 44* Small documentation fixes. 45 46## Version 1.8.0-RC2 47 48* Fixed a bug introduced in 1.8.0-RC where `Mutex.onLock` would not unlock if a non-local return was performed (#3985). 49* Fixed a bug introduced in 1.8.0-RC where depending on kotlinx-coroutines in Native code failed with a compilation error `Could not find "org.jetbrains.kotlinx:atomicfu-cinterop-interop"` (#3968). 50* Small documentation fixes. 51 52## Version 1.8.0-RC 53 54* Implement the library for the Web Assembly (Wasm) for JavaScript (#3713). Thanks @igoriakovlev! 55* On Android, ensure that `Dispatchers.Main != Dispatchers.Main.immediate` (#3545, #3963). 56* `kotlinx-coroutines-debug` is published with the correct Java 9 module info (#3944). 57* Major Kotlin version update: was 1.8.20, became 1.9.21. 58* `kotlinx-coroutines-test`: set the default timeout of `runTest` to 60 seconds, added the ability to configure it on the JVM with the `kotlinx.coroutines.test.default_timeout=10s` (#3800). 59* `kotlinx-coroutines-test`: fixed a bug that could lead to not all uncaught exceptions being reported after some tests failed (#3800). 60* `delay(Duration)` rounds nanoseconds up to whole milliseconds and not down (#3920). Thanks @kevincianfarini! 61* `Dispatchers.Default` and the default thread for background work are guaranteed to use the same context classloader as the object containing it them (#3832). 62* It is guaranteed that by the time `SharedFlow.collect` suspends for the first time, it's registered as a subscriber for that `SharedFlow` (#3885). Before, it was also true, but not documented. 63* Atomicfu version is updated to 0.23.1, and Kotlin/Native atomic transformations are enabled, reducing the footprint of coroutine-heavy code (#3954). 64* Added a workaround for miscompilation of `withLock` on JS (#3881). Thanks @CLOVIS-AI! 65* Small tweaks and documentation fixes. 66 67## Version 1.7.3 68 69* Disabled the publication of the multiplatform library metadata for the old (1.6 and earlier) KMP Gradle plugin (#3809). 70* Fixed a bug introduced in 1.7.2 that disabled the coroutine debugger in IDEA (#3822). 71 72## Version 1.7.2 73 74### Bug fixes and improvements 75 76* Coroutines debugger no longer keeps track of coroutines with empty coroutine context (#3782). 77* `CopyableThreadContextElement` now properly copies an element when crossing the coroutine boundary in `flowOn` (#3787). Thanks @wanyingd1996! 78* Coroutine timeouts no longer prevent K/N `newSingleThreadContext` from closing (#3768). 79* A non-linearizability in `Mutex` during `tryLock`/`unlock` sequence with owners is fixed (#3745). 80* Atomicfu version is updated to 0.21.0. 81 82## Version 1.7.1 83 84### Bug fixes and improvements 85 86* Special characters in coroutine names in JSON dumps are supported (#3747) 87* The binary compatibility of the experimental overload of `runTest` is restored (#3673) 88* Channels that don't use `onUndeliveredElement` now allocate less memory (#3646) 89 90## Version 1.7.0 91 92### Core API significant improvements 93 94* New `Channel` implementation with significant performance improvements across the API (#3621). 95* New `select` operator implementation: faster, more lightweight, and more robust (#3020). 96* `Mutex` and `Semaphore` now share the same underlying data structure (#3020). 97* `Dispatchers.IO` is added to K/N (#3205) 98 * `newFixedThreadPool` and `Dispatchers.Default` implementations on K/N were wholly rewritten to support graceful growth under load (#3595). 99* `kotlinx-coroutines-test` rework: 100 - Add the `timeout` parameter to `runTest` for the whole-test timeout, 10 seconds by default (#3270). This replaces the configuration of quiescence timeouts, which is now deprecated (#3603). 101 - The `withTimeout` exception messages indicate if the timeout used the virtual time (#3588). 102 - `TestCoroutineScheduler`, `runTest`, and `TestScope` API are promoted to stable (#3622). 103 - `runTest` now also fails if there were uncaught exceptions in coroutines not inherited from the test coroutine (#1205). 104 105### Breaking changes 106 107* Old K/N memory model is no longer supported (#3375). 108* New generic upper bounds were added to reactive integration API where the language since 1.8.0 dictates (#3393). 109* `kotlinx-coroutines-core` and `kotlinx-coroutines-jdk8` artifacts were merged into a single artifact (#3268). 110* Artificial stackframes in stacktrace recovery no longer contain the `\b` symbol and are now navigable in IDE and supplied with proper documentation (#2291). 111* `CoroutineContext.isActive` returns `true` for contexts without any job in them (#3300). 112 113### Bug fixes and improvements 114 115* Kotlin version is updated to 1.8.20 116* Atomicfu version is updated to 0.20.2. 117* `JavaFx` version is updated to 17.0.2 in `kotlinx-coroutines-javafx` (#3671).. 118* JPMS is supported (#2237). Thanks @lion7! 119* `BroadcastChannel` and all the corresponding API are deprecated (#2680). 120* Added all supported K/N targets (#3601, #812, #855). 121* K/N `Dispatchers.Default` is backed by the number of threads equal to the number of available cores (#3366). 122* Fixed an issue where some coroutines' internal exceptions were not properly serializable (#3328). 123* Introduced `Job.parent` API (#3201). 124* Fixed a bug when `TestScheduler` leaked cancelled jobs (#3398). 125* `TestScope.timeSource` now provides comparable time marks (#3617). Thanks @hfhbd! 126* Fixed an issue when cancelled `withTimeout` handles were preserved in JS runtime (#3440). 127* Ensure `awaitFrame` only awaits a single frame when used from the main looper (#3432). Thanks @pablobaxter! 128* Obsolete `Class-Path` attribute was removed from `kotlinx-coroutines-debug.jar` manifest (#3361). 129* Fixed a bug when `updateThreadContext` operated on the parent context (#3411). 130* Added new `Flow.filterIsInstance` extension (#3240). 131* `Dispatchers.Default` thread name prefixes are now configurable with system property (#3231). 132* Added `Flow.timeout` operator as `@FlowPreview` (#2624). Thanks @pablobaxter! 133* Improved the performance of the `future` builder in case of exceptions (#3475). Thanks @He-Pin! 134* `Mono.awaitSingleOrNull` now waits for the `onComplete` signal (#3487). 135* `Channel.isClosedForSend` and `Channel.isClosedForReceive` are promoted from experimental to delicate (#3448). 136* Fixed a data race in native `EventLoop` (#3547). 137* `Dispatchers.IO.limitedParallelism(valueLargerThanIOSize)` no longer creates an additional wrapper (#3442). Thanks @dovchinnikov! 138* Various `@FlowPreview` and `@ExperimentalCoroutinesApi` are promoted to experimental and stable respectively (#3542, #3097, #3548). 139* Performance improvements in `Dispatchers.Default` and `Dispatchers.IO` (#3416, #3418). 140* Fixed a bug when internal `suspendCancellableCoroutineReusable` might have hanged (#3613). 141* Introduced internal API to process events in the current system dispatcher (#3439). 142* Global `CoroutineExceptionHandler` is no longer invoked in case of unprocessed `future` failure (#3452). 143* Performance improvements and reduced thread-local pressure for the `withContext` operator (#3592). 144* Improved performance of `DebugProbes` (#3527). 145* Fixed a bug when the coroutine debugger might have detected the state of a coroutine incorrectly (#3193). 146* `CoroutineDispatcher.asExecutor()` runs tasks without dispatching if the dispatcher is unconfined (#3683). Thanks @odedniv! 147* `SharedFlow.toMutableList` and `SharedFlow.toSet` lints are introduced (#3706). 148* `Channel.invokeOnClose` is promoted to stable API (#3358). 149* Improved lock contention in `Dispatchers.Default` and `Dispatchers.IO` during the startup phase (#3652). 150* Fixed a bug that led to threads oversubscription in `Dispatchers.Default` (#3642). 151* Fixed a bug that allowed `limitedParallelism` to perform dispatches even after the underlying dispatcher was closed (#3672). 152* Fixed a bug that prevented stacktrace recovery when the exception's constructor from `cause` was selected (#3714). 153* Improved sanitizing of stracktrace-recovered traces (#3714). 154* Introduced an internal flag to disable uncaught exceptions reporting in tests as a temporary migration mechanism (#3736). 155* Various documentation improvements and fixes. 156 157Changelog for previous versions may be found in [CHANGES_UP_TO_1.7.md](CHANGES_UP_TO_1.7.md) 158