Skip to content

Fix: logic in package name handling is sensitive to trailing semicolon #101

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
merged 1 commit into from
Jul 2, 2025
Merged

Fix: logic in package name handling is sensitive to trailing semicolon #101

Show file tree
Hide file tree
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
5 changes: 4 additions & 1 deletion semanticdb-kotlinc/src/main/kotlin/com/sourcegraph/semanticdb_kotlinc/AnalyzerCheckers.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ open class AnalyzerCheckers(session: FirSession) : FirAdditionalCheckersExtensio

var ancestor = fqName
var depth = 0

while (ancestor != FqName.ROOT) {
val nameNode = nameList[nameList.lastIndex - depth]
val nameSource = nameNode.toKtLightSourceElement(tree)
Expand All @@ -126,7 +127,9 @@ open class AnalyzerCheckers(session: FirSession) : FirAdditionalCheckersExtensio
val fqName = packageDirective.packageFqName
val source = packageDirective.source
if (source != null) {
val names = source.treeStructure.findLastDescendant(source.lighterASTNode) { true }
val names = source.treeStructure.findChildByType(source.lighterASTNode, KtNodeTypes.DOT_QUALIFIED_EXPRESSION) ?:
source.treeStructure.findChildByType(source.lighterASTNode, KtNodeTypes.REFERENCE_EXPRESSION)

if (names != null) {
eachFqNameElement(fqName, source.treeStructure, names) { fqName, name ->
visitor?.visitPackage(fqName, name, context)
Expand Down
194 changes: 183 additions & 11 deletions semanticdb-kotlinc/src/test/kotlin/com/sourcegraph/semanticdb_kotlinc/test/AnalyzerTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import kotlin.test.assertEquals
import org.intellij.lang.annotations.Language
import org.jetbrains.kotlin.compiler.plugin.ExperimentalCompilerApi
import org.junit.jupiter.api.io.TempDir
import java.nio.file.Paths

@OptIn(ExperimentalCompilerApi::class)
@ExperimentalContracts
Expand All @@ -39,7 +40,8 @@ class AnalyzerTest {
pluginOptions =
listOf(
PluginOption("semanticdb-kotlinc", "sourceroot", path.toString()),
PluginOption("semanticdb-kotlinc", "targetroot", buildPath.toString()))
PluginOption("semanticdb-kotlinc", "targetroot", buildPath.toString())
)
commandLineProcessors = listOf(AnalyzerCommandLineProcessor())
workingDir = path.toFile()
}
Expand All @@ -59,7 +61,8 @@ class AnalyzerTest {
package sample
class Banana {
fun foo() { }
}""")
}"""
)

val occurrences =
arrayOf(
Expand Down Expand Up @@ -132,7 +135,8 @@ class AnalyzerTest {

import kotlin.Boolean
import kotlin.Int as KInt
""")
"""
)

val occurrences =
arrayOf(
Expand Down Expand Up @@ -205,7 +209,8 @@ class AnalyzerTest {
fun localClassMethod() {}
}
}
""")
"""
)

val occurrences =
arrayOf(
Expand Down Expand Up @@ -314,7 +319,8 @@ class AnalyzerTest {
class Class : Interface {
override fun foo() {}
}
""")
"""
)

val occurrences =
arrayOf(
Expand Down Expand Up @@ -447,7 +453,8 @@ class AnalyzerTest {
override fun foo() {}
}
}
""")
"""
)

val occurrences =
arrayOf(
Expand Down Expand Up @@ -630,7 +637,8 @@ class AnalyzerTest {
package sample

fun foo(arg: Int): Boolean = true
""")
"""
)

val occurrences =
arrayOf(
Expand Down Expand Up @@ -693,7 +701,8 @@ class AnalyzerTest {
pluginOptions =
listOf(
PluginOption("semanticdb-kotlinc", "sourceroot", path.toString()),
PluginOption("semanticdb-kotlinc", "targetroot", buildPath.toString()))
PluginOption("semanticdb-kotlinc", "targetroot", buildPath.toString())
)
commandLineProcessors = listOf(AnalyzerCommandLineProcessor())
workingDir = path.toFile()
}
Expand Down Expand Up @@ -1119,7 +1128,8 @@ class AnalyzerTest {
counter1() // => The value of the counter is 36
println(-counter2) // => Counter(value=-5)
}
""")
"""
)

val result =
KotlinCompilation()
Expand All @@ -1130,7 +1140,8 @@ class AnalyzerTest {
pluginOptions =
listOf(
PluginOption("semanticdb-kotlinc", "sourceroot", path.toString()),
PluginOption("semanticdb-kotlinc", "targetroot", buildPath.toString()))
PluginOption("semanticdb-kotlinc", "targetroot", buildPath.toString())
)
commandLineProcessors = listOf(AnalyzerCommandLineProcessor())
workingDir = path.toFile()
}
Expand All @@ -1139,6 +1150,166 @@ class AnalyzerTest {
result.exitCode shouldBe KotlinCompilation.ExitCode.OK
}


@Test
fun `compound package name semicolon test`(@TempDir path: Path) {
val document =
compileSemanticdb(
path, """
package hello.sample;
class Apple
""".trimIndent()
)

val occurrences =
arrayOf(
SymbolOccurrence {
role = Role.REFERENCE
symbol = "hello/"
range {
startLine = 0
startCharacter = 8
endLine = 0
endCharacter = 13
}
},
SymbolOccurrence {
role = Role.REFERENCE
symbol = "hello/sample/"
range {
startLine = 0
startCharacter = 14
endLine = 0
endCharacter = 20
}
},
SymbolOccurrence {
role = Role.DEFINITION
symbol = "hello/sample/Apple#"
range {
startLine = 1
startCharacter = 6
endLine = 1
endCharacter = 11
}
},
SymbolOccurrence {
role = Role.DEFINITION
symbol = "hello/sample/Apple#`<init>`()."
range {
startLine = 1
startCharacter = 6
endLine = 1
endCharacter = 11
}
},
)

assertSoftly(document.occurrencesList) {
withClue(document.occurrencesList) { occurrences.forEach(::shouldContain) }
}

val symbols =
arrayOf(
SymbolInformation {
symbol = "hello/sample/Apple#"
language = KOTLIN
displayName = "Apple"
documentation =
Documentation {
format = Semanticdb.Documentation.Format.MARKDOWN
message = "```kotlin\npublic final class Apple : Any\n```"
}
})

assertSoftly(document.symbolsList) { withClue(this) { symbols.forEach(::shouldContain) } }
}


@Test
fun `simple package name semicolon test`(@TempDir path: Path) {
val document =
compileSemanticdb(
path,
"""
package sample;
class Banana {
fun foo() { }
}"""
)

val occurrences =
arrayOf(
SymbolOccurrence {
role = Role.REFERENCE
symbol = "sample/"
range {
startLine = 0
startCharacter = 8
endLine = 0
endCharacter = 14
}
},
SymbolOccurrence {
role = Role.DEFINITION
symbol = "sample/Banana#"
range {
startLine = 1
startCharacter = 6
endLine = 1
endCharacter = 12
}
},
SymbolOccurrence {
role = Role.DEFINITION
symbol = "sample/Banana#foo()."
range {
startLine = 2
startCharacter = 8
endLine = 2
endCharacter = 11
}
},
SymbolOccurrence {
role = Role.DEFINITION
symbol = "sample/Banana#"
range {
startLine = 1
startCharacter = 6
endLine = 1
endCharacter = 12
}
},
)
assertSoftly(document.occurrencesList) {
withClue(this) { occurrences.forEach(::shouldContain) }
}

val symbols =
arrayOf(
SymbolInformation {
symbol = "sample/Banana#"
language = KOTLIN
displayName = "Banana"
documentation =
Documentation {
format = Semanticdb.Documentation.Format.MARKDOWN
message = "```kotlin\npublic final class Banana : Any\n```"
}
},
SymbolInformation {
symbol = "sample/Banana#foo()."
language = KOTLIN
displayName = "foo"
documentation =
Documentation {
format = Semanticdb.Documentation.Format.MARKDOWN
message = "```kotlin\npublic final fun foo(): Unit\n```"
}
})
assertSoftly(document.symbolsList) { withClue(this) { symbols.forEach(::shouldContain) } }
}

@Test
fun documentation(@TempDir path: Path) {
val document =
Expand All @@ -1157,7 +1328,8 @@ class AnalyzerTest {
*
**/
inline fun docstrings(msg: String): Int { return msg.length }
""".trimIndent())
""".trimIndent()
)
document.assertDocumentation("sample/Docstrings#", "Example class docstring")
document.assertDocumentation("sample/docstrings().", "Example method docstring")
}
Expand Down
1 change: 1 addition & 0 deletions ...-kotlinc/src/test/kotlin/com/sourcegraph/semanticdb_kotlinc/test/SemanticdbSymbolsTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@ class SemanticdbSymbolsTest {
)
.mapCheckExpectedSymbols()


@TestFactory
fun `check package symbols`() =
listOf(
Expand Down