AdmStorm 2.0: @admstorm-marker (#171)

Author: Danil42Russia

CHANGELOG.md

@@ -1,5 +1,15 @@
 # AdmStorm Changelog
 
+## [Unreleased]
+
+## 2.0.0 — 11.05.2023
+
+Second stable version
+
+### Added
+
+- `@admstorm-marker` - allowing you to see the values directly in the IDE
+
 ## 1.3.5 — 07.03.2023
 
 ### Fixed

build.gradle.kts

@@ -13,7 +13,7 @@ plugins {
     // gradle-changelog-plugin - read more: https://github.com/JetBrains/gradle-changelog-plugin
     id("org.jetbrains.changelog") version "2.0.0"
     // kotlinx serialization - read more: https://github.com/Kotlin/kotlinx.serialization
-    kotlin("plugin.serialization") version "1.5.31"
+    kotlin("plugin.serialization") version "1.6.21"
     // detekt linter - read more: https://github.com/detekt/detekt
     id("io.gitlab.arturbosch.detekt") version "1.22.0"
     // diktat linter - read more: https://github.com/saveourtool/diktat

gradle.properties

@@ -5,7 +5,7 @@ pluginName=admstorm
 pluginRepositoryUrl = https://github.com/VKCOM/admstorm
 
 # SemVer format -> https://semver.org
-pluginVersion=1.3.5
+pluginVersion=2.0.0
 
 # Supported build number ranges and IntelliJ Platform versions -> https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html
 pluginSinceBuild=223

src/main/kotlin/com/vk/admstorm/AdmService.kt

@@ -10,6 +10,7 @@ import com.intellij.openapi.project.Project
 import com.intellij.psi.PsiManager
 import com.vk.admstorm.utils.MyPathUtils
 import com.vk.admstorm.utils.MyUtils
+import com.vk.admstorm.utils.extensions.unquote
 
 @Service
 class AdmService(private var myProject: Project) {
@@ -55,7 +56,7 @@ class AdmService(private var myProject: Project) {
         var containsGlobal = false
         composerPsiFile.accept(object : JsonRecursiveElementVisitor() {
             override fun visitStringLiteral(lit: JsonStringLiteral) {
-                containsGlobal = containsGlobal || lit.text.contains("vk/global")
+                containsGlobal = containsGlobal || lit.text.unquote() == "vk/global"
             }
         })
 

src/main/kotlin/com/vk/admstorm/AdmStormStartupActivity.kt

@@ -232,7 +232,10 @@ class AdmStormStartupActivity : StartupActivity {
 
     override fun runActivity(project: Project) {
         setupLogger(project)
+        initPlugin(project)
+    }
 
+    private fun initPlugin(project: Project) {
         if (!project.pluginEnabled()) {
             // We don't connect if this is not a vkcom project
             return

src/main/kotlin/com/vk/admstorm/admscript/AdmScript.kt

@@ -0,0 +1,79 @@
+package com.vk.admstorm.admscript
+
+import com.google.common.cache.Cache
+import com.google.common.cache.CacheBuilder
+import com.intellij.openapi.diagnostic.logger
+import com.intellij.openapi.project.Project
+import com.vk.admstorm.CommandRunner
+import com.vk.admstorm.admscript.utils.DataResponse
+import com.vk.admstorm.admscript.utils.DataResponseSerializer
+import com.vk.admstorm.env.Env
+import kotlinx.serialization.KSerializer
+import kotlinx.serialization.json.Json
+import java.util.concurrent.TimeUnit
+
+abstract class AdmScript<TModel>(private val project: Project) : IService<TModel> {
+    companion object {
+        private val LOG = logger<AdmScript<Any>>()
+
+        private val resultCache: Cache<String, String> = CacheBuilder.newBuilder()
+            .weakKeys()
+            .expireAfterWrite(1, TimeUnit.MINUTES)
+            .build()
+
+    }
+
+    abstract val methodName: String
+
+    protected fun <TModel : Any> execCommand(keyName: String, serializer: KSerializer<TModel>): DataResponse<TModel> {
+        val workingDir = "${Env.data.projectRoot}/${Env.data.phpSourceFolder}"
+        val admScriptName = Env.data.admScriptName
+
+        val baseCommand = "php ${workingDir}/${admScriptName}"
+        val command = "$baseCommand --method $methodName --key $keyName"
+
+        var isFromCache = true
+        val cacheValue = resultCache.getIfPresent(keyName)
+        val stdout = if (cacheValue == null) {
+            val output = CommandRunner.runRemotely(
+                project,
+                command,
+                command,
+                workingDir,
+                5_000,
+            )
+
+            if (output.exitCode == CommandRunner.FAILED_CODE) {
+                return DataResponse(errorMessage = "An error occurred while sending data")
+            }
+
+            if (output.exitCode == CommandRunner.TIMEOUT_CODE) {
+                return DataResponse(errorMessage = "Timeout occurred. Try again.")
+            }
+
+            val stdout = output.stdout
+            if (output.exitCode != 0) {
+                return DataResponse(errorMessage = stdout)
+            }
+
+            isFromCache = false
+            stdout
+        } else {
+            cacheValue
+        }
+
+        return try {
+            val response = Json.decodeFromString(DataResponseSerializer(serializer), stdout)
+            if (response.errorMessage == null && !isFromCache) {
+                resultCache.put(keyName, stdout)
+            }
+
+            response
+        } catch (e: Exception) {
+            LOG.warn("Error when decode the response:", e)
+            return DataResponse(errorMessage = "Error when decode the response")
+        }
+    }
+
+    abstract override fun execCommand(keyName: String): DataResponse<TModel>
+}

src/main/kotlin/com/vk/admstorm/admscript/IService.kt

@@ -0,0 +1,7 @@
+package com.vk.admstorm.admscript
+
+import com.vk.admstorm.admscript.utils.DataResponse
+
+interface IService<TModel> {
+    fun execCommand(keyName: String): DataResponse<TModel>?
+}

src/main/kotlin/com/vk/admstorm/admscript/utils/DataResponse.kt

@@ -0,0 +1,6 @@
+package com.vk.admstorm.admscript.utils
+
+data class DataResponse<out TModel>(
+    val value: TModel? = null,
+    val errorMessage: String? = null,
+)

src/main/kotlin/com/vk/admstorm/admscript/utils/DataResponseSerializer.kt

@@ -0,0 +1,46 @@
+package com.vk.admstorm.admscript.utils
+
+import kotlinx.serialization.KSerializer
+import kotlinx.serialization.SerializationException
+import kotlinx.serialization.Serializer
+import kotlinx.serialization.builtins.nullable
+import kotlinx.serialization.descriptors.SerialDescriptor
+import kotlinx.serialization.descriptors.buildClassSerialDescriptor
+import kotlinx.serialization.descriptors.nullable
+import kotlinx.serialization.encoding.CompositeDecoder
+import kotlinx.serialization.encoding.Decoder
+import kotlinx.serialization.encoding.Encoder
+import kotlinx.serialization.serializer
+
+@Serializer(forClass = DataResponse::class)
+class DataResponseSerializer<TModel : Any>(private val dataSerializer: KSerializer<TModel>) : KSerializer<DataResponse<TModel>> {
+    override val descriptor: SerialDescriptor = buildClassSerialDescriptor("DataResponseSerializer") {
+        val dataDescriptor = dataSerializer.descriptor.nullable
+        element("value", dataDescriptor)
+        element("error_message", dataSerializer.descriptor.nullable)
+    }
+
+    override fun deserialize(decoder: Decoder): DataResponse<TModel> {
+        val inp = decoder.beginStructure(descriptor)
+        var value: TModel? = null
+        var error: String? = null
+        loop@ while (true) {
+            when (val i = inp.decodeElementIndex(descriptor)) {
+                CompositeDecoder.DECODE_DONE -> break@loop
+                0 -> value = inp.decodeNullableSerializableElement(descriptor, i, dataSerializer.nullable)
+                1 -> error = inp.decodeNullableSerializableElement(descriptor, i, serializer())
+                else -> throw SerializationException("Unknown index $i")
+            }
+        }
+        inp.endStructure(descriptor)
+        return DataResponse(value, error)
+    }
+
+    override fun serialize(encoder: Encoder, value: DataResponse<TModel>) {
+        encoder.beginStructure(descriptor).apply {
+            encodeNullableSerializableElement(descriptor, 0, dataSerializer, value.value)
+            encodeNullableSerializableElement(descriptor, 1, serializer<String?>(), value.errorMessage)
+            endStructure(descriptor)
+        }
+    }
+}

src/main/kotlin/com/vk/admstorm/env/Env.kt

@@ -2,7 +2,6 @@ package com.vk.admstorm.env
 
 import com.intellij.openapi.diagnostic.logger
 import com.intellij.openapi.project.Project
-import com.intellij.util.application
 import com.vk.admstorm.CommandRunner
 import com.vk.admstorm.configuration.kphp.KphpRunType
 import com.vk.admstorm.configuration.phplinter.PhpLinterCheckers
@@ -33,6 +32,7 @@ data class KphpCommand(
 @Serializable
 data class Service(
     val name: String,
+    val key: String,
     val url: String,
 )
 
@@ -63,6 +63,7 @@ data class EnvConfig(
     var testDomainSite: String = "",
     var serviceDomain: String = "",
     var kphpCommands: List<KphpCommand> = listOf(),
+    var admScriptName: String = "",
     var services: List<Service> = listOf(),
 )
 
@@ -164,7 +165,7 @@ object Env {
         }
 
         myIsResolved = true
-        application.messageBus.syncPublisher(EnvListener.TOPIC).onResolve()
+        project.messageBus.syncPublisher(EnvListener.TOPIC).onResolve()
     }
 
     private fun setPhpLinterCheckers(project: Project) {