feat: implement cookie persistence in ApiDashboardPanel (#1198)

Author: tangcent

common-api/src/main/kotlin/com/itangcent/http/HttpCookieStore.kt

@@ -62,14 +62,18 @@ class BasicCookie : MutableCookie {
      * Compatible only.Obsolete.
      * @return comment
      */
+    @Deprecated("Obsolete")
     override fun getComment(): String? = comment
 
+    @Deprecated("Obsolete")
     override fun setComment(comment: String?) {
         this.comment = comment
     }
 
     private var commentURL: String? = null
+    @Deprecated("Obsolete")
     override fun getCommentURL(): String? = commentURL
+    @Deprecated("Obsolete")
     override fun setCommentURL(commentURL: String?) {
         this.commentURL = commentURL
     }
@@ -112,7 +116,9 @@ class BasicCookie : MutableCookie {
      *
      * @return the version of the cookie.
      */
+    @Deprecated("Obsolete")
     override fun getVersion(): Int? = version
+    @Deprecated("Obsolete")
     override fun setVersion(version: Int?) {
         this.version = version
     }
@@ -131,7 +137,9 @@ class BasicCookie : MutableCookie {
     }
 
     private var ports: IntArray? = null
+    @Deprecated("Obsolete")
     override fun getPorts(): IntArray? = ports
+    @Deprecated("Obsolete")
     override fun setPorts(ports: IntArray?) {
         this.ports = ports
     }

idea-plugin/src/main/kotlin/com/itangcent/idea/plugin/api/dashboard/ApiDashboardService.kt

@@ -20,6 +20,7 @@ import com.itangcent.common.logger.traceError
 import com.itangcent.common.model.*
 import com.itangcent.common.spi.Setup
 import com.itangcent.common.utils.safe
+import com.itangcent.http.CookieStore
 import com.itangcent.http.HttpResponse
 import com.itangcent.http.RequestUtils
 import com.itangcent.http.contentType
@@ -58,6 +59,7 @@ import com.itangcent.intellij.jvm.PsiClassHelper
 import com.itangcent.intellij.logger.Logger
 import com.itangcent.intellij.psi.PsiClassUtils
 import com.itangcent.intellij.util.FileType
+import com.itangcent.suv.http.CookiePersistenceHelper
 import com.itangcent.suv.http.HttpClientProvider
 import org.apache.http.entity.ContentType
 import java.util.*
@@ -97,9 +99,15 @@ class ApiDashboardService(private val project: Project) {
     @Inject
     private lateinit var httpContextCacheHelper: HttpContextCacheHelper
 
+    @Inject
+    private lateinit var cookiePersistenceHelper: CookiePersistenceHelper
+
     lateinit var actionContext: ActionContext
         private set
 
+    private val cookieStore: CookieStore
+        get() = httpClientProvider.getHttpClient().cookieStore()
+
     private val requestRawInfoBinderFactory: DbBeanBinderFactory<RequestRawInfo> by lazy {
         DbBeanBinderFactory(projectCacheRepository.getOrCreateFile(".api.dashboard.v1.0.db").path) { RequestRawInfo() }
     }
@@ -143,7 +151,7 @@ class ApiDashboardService(private val project: Project) {
     init {
         Setup.load(ApiDashboardService::class.java.classLoader)
         createNewActionContext()
-        
+
         // Add project dispose listener
         project.messageBus.connect().subscribe(ProjectManager.TOPIC, object : ProjectManagerListener {
             override fun projectClosing(project: Project) {
@@ -167,6 +175,9 @@ class ApiDashboardService(private val project: Project) {
 
         actionContext = builder.build()
         actionContext.init(this)
+        actionContext.runAsync {
+            cookiePersistenceHelper.loadCookiesInto(cookieStore)
+        }
     }
 
     fun ensureActionContextActive() {
@@ -441,6 +452,9 @@ class ApiDashboardService(private val project: Project) {
             }
             .call()
         logger.info("response status code: ${httpResponse.code()}")
+        actionContext.runAsync {
+            cookiePersistenceHelper.storeCookiesFrom(cookieStore)
+        }
         return httpResponse
     }
 

idea-plugin/src/main/kotlin/com/itangcent/suv/http/CookiePersistenceHelper.kt

@@ -0,0 +1,65 @@
+package com.itangcent.suv.http
+
+import com.google.inject.Inject
+import com.google.inject.Singleton
+import com.itangcent.common.logger.Log
+import com.itangcent.common.logger.traceError
+import com.itangcent.common.utils.GsonUtils
+import com.itangcent.http.BasicCookie
+import com.itangcent.http.CookieStore
+import com.itangcent.http.json
+import com.itangcent.idea.plugin.api.cache.ProjectCacheRepository
+
+/**
+ * A utility class that helps persist cookies to file and load them back.
+ * This class provides methods to save and load cookies from a CookieStore to persistent storage.
+ *
+ * @author tangcent
+ */
+@Singleton
+class CookiePersistenceHelper {
+
+    @Inject
+    private lateinit var projectCacheRepository: ProjectCacheRepository
+
+    companion object : Log() {
+        private const val CACHE_FILE = ".cookies.v1.0.json"
+    }
+
+    /**
+     * Reads cookies from persistent storage and loads them into the provided CookieStore.
+     * Any expired cookies in storage will be skipped.
+     *
+     * @param cookieStore the CookieStore to load cookies into
+     */
+    fun loadCookiesInto(cookieStore: CookieStore) {
+        try {
+            val cookieFile = projectCacheRepository.getOrCreateFile(CACHE_FILE)
+            val cookiesJson = cookieFile.readText()
+            if (cookiesJson.isBlank()) return
+
+            val cookiesList = GsonUtils.fromJson<List<String>>(cookiesJson)
+            cookiesList?.forEach { cookieJson ->
+                val cookie = BasicCookie.fromJson(cookieJson)
+                cookieStore.addCookie(cookie)
+            }
+        } catch (e: Exception) {
+            // If file doesn't exist or there's an error reading it, just log and return
+            LOG.traceError("cookies is invalid", e)
+            return
+        }
+    }
+
+    /**
+     * Stores all cookies from the provided CookieStore into persistent storage.
+     * Only non-expired cookies will be saved.
+     *
+     * @param cookieStore the CookieStore to save cookies from
+     */
+    fun storeCookiesFrom(cookieStore: CookieStore) {
+        val cookieFile = projectCacheRepository.getOrCreateFile(CACHE_FILE)
+        val cookies = cookieStore.cookies()
+        val cookiesJson = cookies.map { it.json() }
+        cookieFile.writeText(GsonUtils.toJson(cookiesJson))
+    }
+}

idea-plugin/src/test/kotlin/com/itangcent/suv/http/CookiePersistenceHelperTest.kt

@@ -0,0 +1,63 @@
+package com.itangcent.suv.http
+
+import com.google.inject.Inject
+import com.itangcent.http.ApacheHttpClient
+import com.itangcent.http.BasicCookie
+import com.itangcent.intellij.context.ActionContext
+import com.itangcent.mock.AdvancedContextTest
+import org.junit.jupiter.api.Assertions.assertEquals
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.assertDoesNotThrow
+
+/**
+ * Test case of [CookiePersistenceHelper]
+ */
+class CookiePersistenceHelperTest : AdvancedContextTest() {
+
+    @Inject
+    private lateinit var cookiePersistenceHelper: CookiePersistenceHelper
+
+    private val apacheHttpClient = ApacheHttpClient()
+
+    override fun afterBind(actionContext: ActionContext) {
+        actionContext.cache("project_path", tempDir.toString())
+    }
+
+    @Test
+    fun persistenceCookies() {
+        val cookieStore = apacheHttpClient.cookieStore()
+
+        assertDoesNotThrow {
+            cookiePersistenceHelper.loadCookiesInto(cookieStore)
+        }
+
+        assertDoesNotThrow {
+            cookiePersistenceHelper.storeCookiesFrom(cookieStore)
+        }
+
+        // add a cookie
+        val cookie = BasicCookie().apply {
+            setName("testCookie")
+            setValue("testValue")
+            setDomain("test.com")
+            setPath("/")
+            setExpiryDate(System.currentTimeMillis() + 86400000) // expires in 1 day
+        }
+        cookieStore.addCookie(cookie)
+
+        // store cookies
+        cookiePersistenceHelper.storeCookiesFrom(cookieStore)
+
+        // clear cookies then load cookies
+        cookieStore.clear()
+        cookiePersistenceHelper.loadCookiesInto(cookieStore)
+
+        // check if cookie is loaded
+        val readCookie = cookieStore.cookies().first { it.getName() == "testCookie" }
+        assertEquals(cookie.getName(), readCookie.getName())
+        assertEquals(cookie.getValue(), readCookie.getValue())
+        assertEquals(cookie.getDomain(), readCookie.getDomain())
+        assertEquals(cookie.getPath(), readCookie.getPath())
+        assertEquals(cookie.getExpiryDate(), readCookie.getExpiryDate())
+    }
+}