Skip to content
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

Generate tag files only when config check is active. #224

Open
wants to merge 2 commits into
base: 2.0.0
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ import org.koin.compiler.metadata.KoinTagWriter
import org.koin.compiler.scanner.KoinMetaDataScanner
import org.koin.compiler.scanner.KoinTagMetaDataScanner
import org.koin.compiler.verify.KoinConfigChecker
import kotlin.time.TimeSource
import kotlin.time.TimeSource.Monotonic.markNow
import kotlin.time.measureTime

class BuilderProcessor(
private val codeGenerator: CodeGenerator,
Expand Down Expand Up @@ -66,22 +66,26 @@ class BuilderProcessor(
logger.logging("Generate code ...")
koinCodeGenerator.generateModules(moduleList, defaultModule, isDefaultModuleActive())

val isConfigCheckActive = isConfigCheckActive()

// Tags are used to verify generated content (KMP)
KoinTagWriter(codeGenerator, logger, resolver, isConfigCheckActive)
.writeAllTags(moduleList, defaultModule)

if (doLogTimes && mainTime != null) {
mainTime.elapsedNow()
logger.warn("Koin Configuration Generated in ${mainTime.elapsedNow()}")
}

val isAlreadyGenerated = codeGenerator.generatedFile.isEmpty()
if (isConfigCheckActive && isAlreadyGenerated) {
val isConfigCheckActive = isConfigCheckActive()
if (isConfigCheckActive) {
logger.warn("Koin Configuration Check ...")
val checkTime = if (doLogTimes) markNow() else null

// Tags are used to verify generated content (KMP)
KoinTagWriter(codeGenerator, logger, resolver)
.writeAllTags(moduleList, defaultModule)

val isAlreadyGenerated = codeGenerator.generatedFile.isEmpty()
if (!isAlreadyGenerated) {
warnConfigCheckDone(doLogTimes, checkTime)
return emptyList()
}

val metaTagScanner = KoinTagMetaDataScanner(logger, resolver)
val invalidsMetaSymbols = metaTagScanner.findInvalidSymbols()
if (invalidsMetaSymbols.isNotEmpty()) {
Expand All @@ -93,10 +97,7 @@ class BuilderProcessor(
checker.verifyMetaModules(metaTagScanner.findMetaModules())
checker.verifyMetaDefinitions(metaTagScanner.findMetaDefinitions())

if (doLogTimes && checkTime != null) {
checkTime.elapsedNow()
logger.warn("Koin Configuration Check done in ${checkTime.elapsedNow()}")
}
warnConfigCheckDone(doLogTimes, checkTime)
}
return emptyList()
}
Expand All @@ -123,6 +124,16 @@ class BuilderProcessor(
private fun doLogTimes(): Boolean {
return options.getOrDefault(KOIN_LOG_TIMES.name, "false") == true.toString()
}

private fun warnConfigCheckDone(
doLogTimes: Boolean,
checkTime: TimeSource.Monotonic.ValueTimeMark?
) {
if (doLogTimes && checkTime != null) {
checkTime.elapsedNow()
logger.warn("Koin Configuration Check done in ${checkTime.elapsedNow()}")
}
}
}

class BuilderProcessorProvider : SymbolProcessorProvider {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
package org.koin.compiler.metadata

import org.koin.compiler.generator.ext.appendText
import com.google.devtools.ksp.processing.CodeGenerator
import com.google.devtools.ksp.processing.KSPLogger
import com.google.devtools.ksp.processing.Resolver
import com.google.devtools.ksp.symbol.KSDeclaration
import org.koin.compiler.generator.ext.appendText
import org.koin.compiler.generator.ext.getNewFile
import org.koin.compiler.resolver.isAlreadyExisting
import org.koin.compiler.type.typeWhiteList
Expand All @@ -21,10 +21,9 @@ const val TAG_PREFIX = "KoinMeta_"
private const val TAG_FILE_HASH_LIMIT = 8

class KoinTagWriter(
val codeGenerator: CodeGenerator,
val logger: KSPLogger,
val resolver: Resolver,
val isConfigCheckActive : Boolean
private val codeGenerator: CodeGenerator,
private val logger: KSPLogger,
private val resolver: Resolver,
) {
private val alreadyDeclaredTags: ArrayList<String> = arrayListOf()
private var _tagFileStream : OutputStream? = null
Expand Down Expand Up @@ -56,12 +55,10 @@ class KoinTagWriter(
) {
val allDefinitions = (moduleList + default).flatMap { it.definitions }
val tempFile = createTempFile("KoinMeta", ".kt")
val sha256 = MessageDigest.getInstance("SHA-256");
val sha256 = MessageDigest.getInstance("SHA-256")
DigestOutputStream(tempFile.outputStream(), sha256).buffered().use {
_tagFileStream = it
if (isConfigCheckActive){
writeImports()
}
writeImports()
writeModuleTags(moduleList)
writeDefinitionsTags(allDefinitions)
}
Expand Down Expand Up @@ -98,10 +95,8 @@ class KoinTagWriter(
if (module.alreadyGenerated == false){
val tag = TagFactory.getTagClass(module)
if (tag !in alreadyDeclaredTags) {
if (isConfigCheckActive){
val metaLine = MetaAnnotationFactory.generate(module)
writeMeta(metaLine)
}
val metaLine = MetaAnnotationFactory.generate(module)
writeMeta(metaLine)
writeTag(tag)
}
}
Expand Down Expand Up @@ -140,10 +135,8 @@ class KoinTagWriter(
if (!definition.isExpect && definition.alreadyGenerated == false){
val tag = TagFactory.getTagClass(definition)
if (tag !in alreadyDeclaredTags) {
if (isConfigCheckActive){
val metaLine = MetaAnnotationFactory.generate(definition)
writeMeta(metaLine)
}
val metaLine = MetaAnnotationFactory.generate(definition)
writeMeta(metaLine)
writeTag(tag)
}
}
Expand Down