kotlintree on CPG demo (#2056)

---------

Co-authored-by: Andrey Shcheglov <[email protected]>

Author: nulls

save-cloud-common/src/commonMain/kotlin/com/saveourtool/save/demo/cpg/CpgAdditionalParams.kt

@@ -6,9 +6,11 @@ import kotlinx.serialization.Serializable
 /**
  * Data class that represents all additional params required to run CpgDemo
  *
+ * @property engine CPG engine
  * @property language language that the code for demo was written in
  */
 @Serializable
 data class CpgAdditionalParams(
+    val engine: CpgEngine,
     val language: Languages = Languages.KOTLIN,
 )

save-cloud-common/src/commonMain/kotlin/com/saveourtool/save/demo/cpg/CpgEngine.kt

@@ -0,0 +1,19 @@
+package com.saveourtool.save.demo.cpg
+
+/**
+ * Engines for CPG demo
+ *
+ * @property prettyName
+ */
+enum class CpgEngine(val prettyName: String) {
+    /**
+     * A default engine using [Fraunhofer-AISEC/cpg](https://github.com/Fraunhofer-AISEC/cpg)
+     */
+    CPG("cpg (Fraunhofer-AISEC)"),
+
+    /**
+     * A tree-sitter engine using [kotlintree](https://github.com/oxisto/kotlintree) as a binding
+     */
+    TREE_SITTER("tree-sitter (kotlintree)"),
+    ;
+}

save-cloud-common/src/commonMain/kotlin/com/saveourtool/save/demo/cpg/CpgResult.kt

@@ -5,14 +5,14 @@ import kotlinx.serialization.Serializable
 
 /**
  * @property cpgGraph graph obtained from Cpg tool run
+ * @property query query id SQL request to a NEO4
  * @property logs execution logs
- * @property applicationName query id SQL request to a NEO4
  */
 @Serializable
 @OptIn(ExperimentalSerializationApi::class)
 data class CpgResult(
     val cpgGraph: CpgGraph,
-    val applicationName: String,
+    val query: String,
     val logs: List<String>,
 ) {
     companion object {

save-demo-cpg/build.gradle.kts

@@ -20,6 +20,16 @@ repositories {
         }
     }
     mavenCentral()
+    maven {
+        name = "0x6675636b796f75676974687562/kotlintree"
+        url = uri("https://maven.pkg.github.com/0x6675636b796f75676974687562/kotlintree")
+        credentials {
+            username = project.findProperty("gprUser") as String?
+                ?: System.getenv("GITHUB_ACTOR")
+            password = project.findProperty("gprKey") as String?
+                ?: System.getenv("GITHUB_TOKEN")
+        }
+    }
 }
 val jepArchive by configurations.creating
 
@@ -51,6 +61,7 @@ dependencies {
     runtimeOnly(fileTree("$buildDir/distros/jep-distro").apply {
         builtBy(resolveJep)
     })
+    implementation("io.github.oxisto:kotlin-tree-jna:0.0.1")
 }
 
 // This is a special hack for macOS and JEP, see: https://github.com/Fraunhofer-AISEC/cpg/pull/995/files

save-demo-cpg/src/main/kotlin/com/saveourtool/save/demo/cpg/controller/CpgController.kt

@@ -5,6 +5,7 @@ import com.saveourtool.save.demo.cpg.*
 import com.saveourtool.save.demo.cpg.config.ConfigProperties
 import com.saveourtool.save.demo.cpg.repository.CpgRepository
 import com.saveourtool.save.demo.cpg.service.CpgService
+import com.saveourtool.save.demo.cpg.service.TreeSitterService
 import com.saveourtool.save.demo.cpg.utils.*
 import com.saveourtool.save.utils.blockingToMono
 import com.saveourtool.save.utils.getLogger
@@ -32,6 +33,7 @@ const val FILE_NAME_SEPARATOR = "==="
  * @property configProperties
  * @property cpgService
  * @property cpgRepository
+ * @property treeSitterService
  */
 @ApiSwaggerSupport
 @Tags(
@@ -44,31 +46,56 @@ class CpgController(
     val configProperties: ConfigProperties,
     val cpgService: CpgService,
     val cpgRepository: CpgRepository,
+    val treeSitterService: TreeSitterService,
 ) {
     /**
      * @param request
      * @return result of uploading, it contains ID to request the result further
      */
     @PostMapping("/upload-code")
-    @Suppress("TooGenericExceptionCaught", "DoubleMutabilityForCollection")
     fun uploadCode(
         @RequestBody request: CpgRunRequest,
     ): Mono<CpgResult> = blockingToMono {
+        when (request.params.engine) {
+            CpgEngine.CPG -> doUploadCode(
+                request,
+                cpgService::translate,
+                cpgRepository::save
+            ) {
+                cpgRepository.getGraph(it)
+            }
+            CpgEngine.TREE_SITTER -> doUploadCode(
+                request,
+                treeSitterService::translate,
+                cpgRepository::save
+            ) {
+                cpgRepository.getGraphForTreeSitter(it)
+            }
+        }
+    }
+
+    @Suppress("TooGenericExceptionCaught")
+    private fun <T> doUploadCode(
+        @RequestBody request: CpgRunRequest,
+        translateFunction: (Path) -> ResultWithLogs<T>,
+        saveFunction: (T) -> Long,
+        graphFunction: (Long) -> CpgGraph,
+    ): CpgResult {
         val tmpFolder = createTempDirectory(request.params.language.modeName)
-        var logs: MutableList<String> = mutableListOf()
-        try {
+        val logs: MutableList<String> = mutableListOf()
+        return try {
             createFiles(request, tmpFolder)
-            val (result, logsFromLogback) = cpgService.translate(tmpFolder)
-            logs = logsFromLogback.toMutableList()
+            val (result, logsFromLogback) = translateFunction(tmpFolder)
+            logs.addAll(logsFromLogback)
 
             result
                 .map {
-                    cpgRepository.save(it)
+                    saveFunction(it)
                 }
-                .map {
+                .map { queryId ->
                     CpgResult(
-                        cpgRepository.getGraph(it),
-                        "match (e: Component where e.name = \"${tmpFolder.fileName.name}\") return e;",
+                        graphFunction(queryId),
+                        CpgRepository.getQueryForNodes(queryId),
                         logs,
                     )
                 }

save-demo-cpg/src/main/kotlin/com/saveourtool/save/demo/cpg/entity/TreeSitterLocation.kt

@@ -0,0 +1,54 @@
+package com.saveourtool.save.demo.cpg.entity
+
+import org.neo4j.ogm.typeconversion.CompositeAttributeConverter
+
+/**
+ * Location of node in tree-sitter
+ */
+class TreeSitterLocation {
+    /**
+     * file name of location
+     */
+    var fileName: String = "N/A"
+
+    /**
+     * start in bytes of location
+     */
+    var startBytes: Int = 0
+
+    /**
+     * end in bytes of location
+     */
+    var endBytes: Int = 0
+
+    override fun toString(): String = "TreeSitterLocation(fileName='$fileName', startBytes=$startBytes, endBytes=$endBytes)"
+
+    companion object {
+        /**
+         * A converter for [TreeSitterLocation]
+         */
+        class Converter : CompositeAttributeConverter<TreeSitterLocation> {
+            override fun toGraphProperties(value: TreeSitterLocation?): Map<String, Any> = value?.let {
+                mapOf(
+                    FILE_NAME to value.fileName,
+                    START_BYTES to value.startBytes,
+                    END_BYTES to value.endBytes,
+                    LOCATION to value.toString(),
+                )
+            }.orEmpty()
+
+            override fun toEntityAttribute(value: Map<String?, *>): TreeSitterLocation? = TreeSitterLocation().apply {
+                fileName = value[FILE_NAME]?.toString() ?: return null
+                startBytes = value[START_BYTES]?.toString()?.toInt() ?: return null
+                endBytes = value[END_BYTES]?.toString()?.toInt() ?: return null
+            }
+
+            companion object {
+                const val END_BYTES = "endBytes"
+                const val FILE_NAME = "file"
+                const val LOCATION = "location"
+                const val START_BYTES = "startBytes"
+            }
+        }
+    }
+}

save-demo-cpg/src/main/kotlin/com/saveourtool/save/demo/cpg/entity/TreeSitterNode.kt

@@ -0,0 +1,73 @@
+package com.saveourtool.save.demo.cpg.entity
+
+import com.fasterxml.jackson.annotation.JsonBackReference
+import org.neo4j.ogm.annotation.GeneratedValue
+import org.neo4j.ogm.annotation.Id
+import org.neo4j.ogm.annotation.NodeEntity
+import org.neo4j.ogm.annotation.Relationship
+import org.neo4j.ogm.annotation.typeconversion.Convert
+
+/**
+ * Entity to store [io.github.oxisto.kotlintree.jvm.Node]
+ */
+@NodeEntity
+class TreeSitterNode {
+    /**
+     * ID which NEO4j generates
+     */
+    @Id @GeneratedValue
+    var id: Long? = null
+
+    /**
+     * Previous node on one level horizontally
+     */
+    @Relationship(value = "SIBLING", direction = Relationship.Direction.INCOMING)
+    @JsonBackReference
+    var prev: TreeSitterNode? = null
+
+    /**
+     * Next node on one level horizontally
+     */
+    @Relationship(value = "SIBLING", direction = Relationship.Direction.OUTGOING)
+    @JsonBackReference
+    var next: TreeSitterNode? = null
+
+    /**
+     * Node on one level up
+     */
+    @Relationship(value = "PARENT", direction = Relationship.Direction.INCOMING)
+    @JsonBackReference
+    var parent: TreeSitterNode? = null
+
+    /**
+     * All node on one level down
+     */
+    @Relationship(value = "PARENT", direction = Relationship.Direction.OUTGOING)
+    @JsonBackReference
+    @Suppress("DoubleMutabilityForCollection")
+    var child: MutableList<TreeSitterNode> = mutableListOf()
+
+    /**
+     * Location of this node
+     */
+    @Convert(TreeSitterLocation.Companion.Converter::class)
+    var location: TreeSitterLocation = TreeSitterLocation()
+
+    /**
+     * Local name -- probably type of node
+     */
+    var localName: String = "N/A"
+
+    /**
+     * A code of this node in parsed AST tree
+     */
+    var code: String = "N/A"
+
+    /**
+     * @return [id] as not null with validating
+     * @throws IllegalArgumentException when [id] is not set that means entity is not saved yet
+     */
+    fun requiredId(): Long = requireNotNull(id) {
+        "Entity is not saved yet: $this"
+    }
+}