-
-
Notifications
You must be signed in to change notification settings - Fork 700
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Avoid retaining outdated LocalKoinApplication/LocalKoinScope #1586
Closed
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
64 changes: 64 additions & 0 deletions
64
compose/koin-androidx-compose/src/main/java/org/koin/androidx/compose/KoinApplication.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| /* | ||
| * Copyright 2017-2023 the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| @file:OptIn(KoinInternalApi::class) | ||
|
|
||
| package org.koin.androidx.compose | ||
|
|
||
| import android.app.Application | ||
| import android.content.ComponentCallbacks | ||
| import android.content.Context | ||
| import android.content.ContextWrapper | ||
| import androidx.compose.runtime.Composable | ||
| import androidx.compose.runtime.CompositionLocalProvider | ||
| import androidx.compose.runtime.remember | ||
| import androidx.compose.ui.platform.LocalContext | ||
| import org.koin.android.ext.android.getKoin | ||
| import org.koin.compose.LocalKoinApplication | ||
| import org.koin.compose.LocalKoinScope | ||
| import org.koin.core.annotation.KoinInternalApi | ||
| import org.koin.core.component.KoinComponent | ||
|
|
||
| /** | ||
| * Provide active Koin application from Android [Context] to Compose | ||
| * | ||
| * @param content - following compose function | ||
| * | ||
| * @author Jan-Jelle Kester | ||
| */ | ||
| @Composable | ||
| fun KoinApplication(content: @Composable () -> Unit) { | ||
| val context = LocalContext.current | ||
| val koinApplication = remember(context) { | ||
| context.findContextForKoin().getKoin() | ||
| } | ||
| CompositionLocalProvider( | ||
| LocalKoinApplication provides koinApplication, | ||
| LocalKoinScope provides koinApplication.scopeRegistry.rootScope, | ||
| content = content | ||
| ) | ||
| } | ||
|
|
||
| /** | ||
| * Find the [KoinComponent] in the Context tree | ||
| */ | ||
| private fun Context.findContextForKoin(): ComponentCallbacks { | ||
| var context = this | ||
| while (context is ContextWrapper) { | ||
| if (context is KoinComponent && context is ComponentCallbacks) return context | ||
| context = context.baseContext | ||
| } | ||
| return applicationContext as Application | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
koin-composemodule has already aKoinApplicationfunction. Do we need a "special" one here?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For this specific use-case, yes.
The
KoinApplicationfunction that already exists creates a new application and starts it. For this one, the assumption is that externally (likely in the AndroidApplicationclass) an application was already created. This is an Android specific implementation because it uses the AndroidContextto find the relevant Koin application/scope. This is all not implemented for multiplatform Compose (as it works differently), so this code cannot live inkoin-compose.In short, this is needed to work around the issue that the composition local defaults are never changing between test runs, ensuring that we have a way of setting them to the correct value.
Personally I don't like this workaround, since we are introducing production code purely for test purposes, but with the way composition locals in Compose are built and the way Koin uses them (for composition-based scopes) I could not think of a good alternative.