Skip to content

Update Config Inversion Linter to Handle V2 supported-configurations.json Format #10061

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.

Sign up for GitHub

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

Merged
mhlidd merged 1 commit into from
Dec 2, 2025
Merged

Update Config Inversion Linter to Handle V2 supported-configurations.json Format #10061

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
85 changes: 54 additions & 31 deletions buildSrc/src/main/kotlin/datadog/gradle/plugin/config/ConfigInversionLinter.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,40 @@ class ConfigInversionLinter : Plugin<Project> {
}
}

// Data class for fields from generated class
private data class LoadedConfigFields(
val supported: Set<String>,
val aliasMapping: Map<String, String> = emptyMap()
)

// Cache for fields from generated class
private var cachedConfigFields: LoadedConfigFields? = null

// Helper function to load fields from the generated class
private fun loadConfigFields(
mainSourceSetOutput: org.gradle.api.file.FileCollection,
generatedClassName: String
): LoadedConfigFields {
return cachedConfigFields ?: run {
val urls = mainSourceSetOutput.files.map { it.toURI().toURL() }.toTypedArray()
URLClassLoader(urls, LoadedConfigFields::class.java.classLoader).use { cl ->
val clazz = Class.forName(generatedClassName, true, cl)

val supportedField = clazz.getField("SUPPORTED").get(null)
@Suppress("UNCHECKED_CAST")
val supportedSet = when (supportedField) {
is Set<*> -> supportedField as Set<String>
is Map<*, *> -> supportedField.keys as Set<String>
else -> throw IllegalStateException("SUPPORTED field must be either Set<String> or Map<String, Any>, but was ${supportedField?.javaClass}")
}

@Suppress("UNCHECKED_CAST")
val aliasMappingMap = clazz.getField("ALIAS_MAPPING").get(null) as Map<String, String>
LoadedConfigFields(supportedSet, aliasMappingMap)
}.also { cachedConfigFields = it }
}
}

/** Registers `logEnvVarUsages` (scan for DD_/OTEL_ tokens and fail if unsupported). */
private fun registerLogEnvVarUsages(target: Project, extension: SupportedTracerConfigurations) {
val ownerPath = extension.configOwnerPath
Expand All @@ -52,16 +86,11 @@ private fun registerLogEnvVarUsages(target: Project, extension: SupportedTracerC
inputs.files(javaFiles)
outputs.upToDateWhen { true }
doLast {
// 1) Build classloader from the owner project’s runtime classpath
val urls = mainSourceSetOutput.get().get().files.map { it.toURI().toURL() }.toTypedArray()
val supported: Set<String> = URLClassLoader(urls, javaClass.classLoader).use { cl ->
// 2) Load the generated class + read static field
val clazz = Class.forName(generatedFile.get(), true, cl)
@Suppress("UNCHECKED_CAST")
clazz.getField("SUPPORTED").get(null) as Set<String>
}
// 1) Load configuration fields from the generated class
val configFields = loadConfigFields(mainSourceSetOutput.get().get(), generatedFile.get())
val supported = configFields.supported

// 3) Scan our sources and compare
// 2) Scan our sources and compare
val repoRoot = target.projectDir.toPath()
val tokenRegex = Regex("\"(?:DD_|OTEL_)[A-Za-z0-9_]+\"")

Expand All @@ -79,7 +108,7 @@ private fun registerLogEnvVarUsages(target: Project, extension: SupportedTracerC
}
tokenRegex.findAll(raw).forEach { m ->
val token = m.value.trim('"')
if (token !in supported) add("$rel:${i + 1} -> Unsupported token'$token'")
if (token !in supported) add("$rel:${i + 1} -> Unsupported token '$token'")
}
}
}
Expand Down Expand Up @@ -167,15 +196,9 @@ private fun registerCheckConfigStringsTask(project: Project, extension: Supporte
throw GradleException("Config directory not found: ${configDir.absolutePath}")
}

val urls = mainSourceSetOutput.get().get().files.map { it.toURI().toURL() }.toTypedArray()
val (supported, aliasMapping) = URLClassLoader(urls, javaClass.classLoader).use { cl ->
val clazz = Class.forName(generatedFile.get(), true, cl)
@Suppress("UNCHECKED_CAST")
val supportedSet = clazz.getField("SUPPORTED").get(null) as Set<String>
@Suppress("UNCHECKED_CAST")
val aliasMappingMap = clazz.getField("ALIAS_MAPPING").get(null) as Map<String, String>
Pair(supportedSet, aliasMappingMap)
}
val configFields = loadConfigFields(mainSourceSetOutput.get().get(), generatedFile.get())
val supported = configFields.supported
val aliasMapping = configFields.aliasMapping

var parserConfig = ParserConfiguration()
parserConfig.setLanguageLevel(ParserConfiguration.LanguageLevel.JAVA_8)
Expand All @@ -192,23 +215,23 @@ private fun registerCheckConfigStringsTask(project: Project, extension: Supporte
.map { it as? FieldDeclaration }
.ifPresent { field ->
if (field.hasModifiers(Modifier.Keyword.PUBLIC, Modifier.Keyword.STATIC, Modifier.Keyword.FINAL) &&
varDecl.typeAsString == "String") {
varDecl.typeAsString == "String") {

val fieldName = varDecl.nameAsString
if (fieldName.endsWith("_DEFAULT")) return@ifPresent
val init = varDecl.initializer.orElse(null) ?: return@ifPresent
val fieldName = varDecl.nameAsString
if (fieldName.endsWith("_DEFAULT")) return@ifPresent
val init = varDecl.initializer.orElse(null) ?: return@ifPresent

if (init !is StringLiteralExpr) return@ifPresent
val rawValue = init.value
if (init !is StringLiteralExpr) return@ifPresent
val rawValue = init.value

val normalized = normalize(rawValue)
if (normalized !in supported && normalized !in aliasMapping) {
val line = varDecl.range.map { it.begin.line }.orElse(1)
add("$fileName:$line -> Config '$rawValue' normalizes to '$normalized' " +
"which is missing from '${extension.jsonFile.get()}'")
val normalized = normalize(rawValue)
if (normalized !in supported && normalized !in aliasMapping) {
val line = varDecl.range.map { it.begin.line }.orElse(1)
add("$fileName:$line -> Config '$rawValue' normalizes to '$normalized' " +
"which is missing from '${extension.jsonFile.get()}'")
}
}
}
}
}
}
}
Expand Down