Merge tag '4.0.1'

.github/workflows/build.yml

@@ -25,7 +25,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Validate Gradle Wrapper
-        uses: gradle/wrapper-validation-action@v1
+        uses: gradle/wrapper-validation-action@v3
 
       - name: Set up JDK
         uses: actions/setup-java@v3

.github/workflows/codeql.yml

@@ -21,42 +21,37 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        language: [ 'java' ]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
-        # Use only 'java' to analyze code written in Java, Kotlin or both
-        # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
-        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
-
+        language: [ 'java-kotlin' ]
     steps:
-    - name: Set up JDK 17
-      uses: actions/setup-java@v3
-      with:
-        distribution: 'zulu'
-        java-version: 17
-  
-    - name: Setup Gradle
-      uses: gradle/gradle-build-action@v2
-
-    - name: Checkout repository
-      uses: actions/checkout@v3
-
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-
-        # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
-        # queries: security-extended,security-and-quality
-
-    - name: Build and install all
-      # working-directory: core
-      run: cd projects && ./install.sh
-
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
-      with:
-        category: "/language:${{matrix.language}}"
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'zulu'
+          java-version: 17
+
+      - name: Setup Gradle
+        uses: gradle/gradle-build-action@v2
+
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+
+          # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+          # queries: security-extended,security-and-quality
+
+      - name: Build and install all
+        # working-directory: core
+        run: cd projects && ./install.sh
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2
+        with:
+          category: "/language:${{matrix.language}}"

.github/workflows/release.yml

@@ -22,7 +22,7 @@ jobs:
         uses: actions/checkout@v3   
 
       - name: Validate Gradle Wrapper
-        uses: gradle/wrapper-validation-action@v1
+        uses: gradle/wrapper-validation-action@v3
 
       - name: Set up JDK
         uses: actions/setup-java@v3

.github/workflows/test.yml

@@ -25,7 +25,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Validate Gradle Wrapper
-        uses: gradle/wrapper-validation-action@v1
+        uses: gradle/wrapper-validation-action@v3
 
       - name: Set up JDK
         uses: actions/setup-java@v3

.github/workflows/weekly.yml

@@ -15,7 +15,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Validate Gradle Wrapper
-        uses: gradle/wrapper-validation-action@v1
+        uses: gradle/wrapper-validation-action@v3
 
       - name: Set up JDK
         uses: actions/setup-java@v3
@@ -29,7 +29,7 @@ jobs:
       - name: Install
         run: cd projects && ./install.sh
 
-      - name: Test Examples
-        run: cd examples/jvm-perfs && ./benchmark.sh
+      - name: Benchmark
+        run: cd projects && ./benchmark.sh
 
 

docs/quickstart/android-annotations.md

@@ -88,7 +88,7 @@ class AppModule
 ```
 
 * We use the `@Module` to declare our class as Koin module
-* The `@ComponentScan("org.koin.sample")` allow to scann any Koin definition in `"org.koin.sample"`package
+* The `@ComponentScan("org.koin.sample")` allow to scan any Koin definition in `"org.koin.sample"`package
 
 Let's simply add `@Single` on `UserRepositoryImpl` class to declare it as singleton:
 

docs/reference/koin-android/start.md

@@ -72,19 +72,16 @@ startKoin {
 }
 ```
 
-## Start Koin with Androidx Startup (4.0)
+## Start Koin with Androidx Startup (4.0.1)
 
-By using Gradle packge `koin-androidx-startup`, we can use `onKoinStartup` function durectly in `init` block of your Application class:
+By using Gradle packge `koin-androidx-startup`, we can use `KoinStartup` interface to declare your Koin configuration your Application class:
 
 ```kotlin
-class MainApplication : Application() {
+class MainApplication : Application(),KoinStartup {
 
-    init {
-        // Use AndroidX Startup for Koin
-        onKoinStartup {
-            androidContext(this@MainApplication)
-            modules(allModules)
-        }
+     override fun onKoinStartup(): KoinAppDeclaration = {
+        androidContext(this@MainApplication)
+        modules(appModule)
     }
 
     override fun onCreate() {
@@ -96,5 +93,25 @@ class MainApplication : Application() {
 This replaces the `startKoin` function that is usally used in `onCreate`. 
 
 :::info
-Gain over from `onKoinStartup` to regular `startKoin` can go over 30% of time gained, for startup time.
+`KoinStartup` avoid blocking main thread at for startup time, and offers better performances.
 :::
+
+## Startup Dependency with Koin
+
+You can make your `Initializer` depend on `KoinInitializer` if you need Koin to be setup, and allow to inject dependencies:
+
+```kotlin
+class CrashTrackerInitializer : Initializer<Unit>, KoinComponent {
+
+    private val crashTrackerService: CrashTrackerService by inject()
+
+    override fun create(context: Context) {
+        crashTrackerService.configure(context)
+    }
+
+    override fun dependencies(): List<Class<out Initializer<*>>> {
+        return listOf(KoinInitializer::class.java)
+    }
+
+}
+```

docs/reference/koin-compose/compose.md

@@ -25,14 +25,11 @@ for an Android/Multiplatform app, use the following packages:
 The function `KoinApplication` helps to create Koin application instance, as a Composable:
 
 ```kotlin
-fun koinConfiguration() = koinApplication {
-    // your configuration & modules here
-    modules(...)
-}
-
 @Composable
 fun App() {
-    KoinApplication(::koinConfiguration) {
+    KoinApplication(application = {
+        modules(...)
+    }) {
 
         // your screens here ...
         MyScreen()
@@ -160,11 +157,44 @@ fun App(vm : MyViewModel = koinViewModel()) {
 }
 ```
 
-:::warning
+:::note
 Lazy API are not supported with updates of jetpack Compose
 :::
 
+### ViewModel and SavedStateHandle for @Composable
+
+You can have a `SavedStateHandle` constructor parameter, it will be injected regarding the Compose environment (Navigation BackStack or ViewModel).
+Either it's injected via ViewModel `CreationExtras` either via Navigation `BackStackEntry`:
+
+```kotlin
+// Setting objectId argument in Navhost
+NavHost(
+    navController,
+    startDestination = "list"
+) {
+    composable("list") { backStackEntry ->
+        //...
+    }
+    composable("detail/{objectId}") { backStackEntry ->
+        val objectId = backStackEntry.arguments?.getString("objectId")?.toInt()
+        DetailScreen(navController, objectId!!)
+    }
+}
+
+// Injected Argument in ViewModel
+class DetailViewModel(
+    private val savedStateHandle: SavedStateHandle
+) : ViewModel() {
 
+    init {
+        println("$this - objectId: ${savedStateHandle.get<String>("objectId")}")
+    }
+}
+```
+
+:::note
+More details about SavedStateHandle injection difference: https://github.com/InsertKoinIO/koin/issues/1935#issuecomment-2362335705
+:::
 
 ## Module loading & unloading tied to Composable
 

docs/reference/koin-core/definitions.md

@@ -221,6 +221,17 @@ val presenter : Presenter by inject { parametersOf(view) }
 
 Further reading in the [Injection Parameters Section](/docs/reference/koin-core/injection-parameters)
 
+## Definition Termination - OnClose
+
+You can use the `onClose` function, to add on a definition, the callback once definition closing is called:
+
+```kotlin
+class Presenter(val view : View)
+
+val myModule = module {
+    factory { (view : View) -> Presenter(view) } onClose { // closing callback - it is Presenter }
+}
+```
 
 ## Using definition flags
 

docs/reference/koin-core/lazy-modules.md

@@ -63,4 +63,21 @@ koin.runOnKoinStarted { koin ->
 
 :::info
     Default dispatcher for coroutines engine is `Dispatchers.Default`
+:::
+
+### Limitation - Mixing Modules/Lazy Modules
+
+For now we advise to avoid mixing modules & lazy modules, in the startup. Avoid having `mainModule` requiring dependency in `lazyReporter`.
+
+```kotlin
+startKoin {
+    androidLogger()
+    androidContext(this@TestApp)
+    modules(mainModule)
+    lazyModules(lazyReporter)
+}
+```
+
+:::warning
+For now Koin doesn't check if your module depends on a lazy modules
 :::

docs/reference/koin-core/scopes.md

@@ -48,6 +48,9 @@ From a `Koin` instance, you can access:
 - `getScope(id : ScopeID)` - retrieve a previously created scope with given id
 - `getOrCreateScope(id : ScopeID, scopeName : Qualifier)` - create or retrieve if already created, the closed scope instance with given id and scopeName
 
+:::note
+By default calling `createScope` on an object, doesn't pass the "source" of the scope. You need to pass it as parameters: `T.createScope(<source>)`
+:::
 
 ### Scope Component: Associate a scope to a component [2.2.0]
 

docs/reference/koin-ktor/ktor.md

@@ -39,7 +39,7 @@ fun Application.main() {
 
 ### Resolve from Ktor Request Scope (since 3.5.0)
 
-You can declare components to live within Ktor request scope timeline. For this, you just need to declare your component inside a `scope<ScopeRequest>` section. Given a `ScopeComponent` class to instantiate on RequestScope, let's declare it:
+You can declare components to live within Ktor request scope timeline. For this, you just need to declare your component inside a `scope<RequestScope>` section. Given a `ScopeComponent` class to instantiate on `RequestScope`, let's declare it:
 
 ```kotlin
 scope<RequestScope>{