[jb]: customize remote indicator

akosyakov · roboquat · commit f8257e4a1dc2 · 2022-02-22T13:49:01.000+05:30
diff --git a/components/ide/jetbrains/backend-plugin/gradle.properties b/components/ide/jetbrains/backend-plugin/gradle.properties
@@ -12,7 +12,7 @@ pluginUntilBuild=213.*
 pluginVerifierIdeVersions=2021.3.1
 # IntelliJ Platform Properties -> https://github.com/JetBrains/gradle-intellij-plugin#intellij-platform-properties
 platformType=IU
-platformVersion=213-EAP-SNAPSHOT
+platformVersion=213.6777.52
 platformDownloadSources=true
 # Plugin Dependencies -> https://plugins.jetbrains.com/docs/intellij/plugin-dependencies.html
 # Example: platformPlugins = com.intellij.java, com.jetbrains.php:203.4449.22
diff --git a/components/ide/jetbrains/backend-plugin/launch-dev-server.sh b/components/ide/jetbrains/backend-plugin/launch-dev-server.sh
@@ -3,6 +3,9 @@
 # Licensed under the GNU Affero General Public License (AGPL).
 # See License-AGPL.txt in the project root for license information.
 
+set -e
+set -o pipefail
+
 TEST_BACKEND_DIR=/workspace/ide-backend
 if [ ! -d "$TEST_BACKEND_DIR" ]; then
   mkdir -p $TEST_BACKEND_DIR
diff --git a/components/ide/jetbrains/backend-plugin/src/main/kotlin/io/gitpod/jetbrains/remote/GitpodBranding.kt b/components/ide/jetbrains/backend-plugin/src/main/kotlin/io/gitpod/jetbrains/remote/GitpodBranding.kt
@@ -0,0 +1,41 @@
+// Copyright (c) 2022 Gitpod GmbH. All rights reserved.
+// Licensed under the GNU Affero General Public License (AGPL).
+// See License-AGPL.txt in the project root for license information.
+
+package io.gitpod.jetbrains.remote
+
+import com.intellij.openapi.components.service
+import com.intellij.remoteDev.customization.GatewayBranding
+import io.gitpod.jetbrains.remote.icons.GitpodIcons
+import kotlinx.coroutines.GlobalScope
+import kotlinx.coroutines.future.await
+import kotlinx.coroutines.launch
+import javax.swing.Icon
+
+class GitpodBranding : GatewayBranding {
+
+    val manager = service<GitpodManager>()
+
+    /*
+       TODO(ak) GITPOD_WORSPACE_ID is a subject to change
+        ideally we should not rely on it, but here `getName` is sync
+        alternatively we could precompute another env var based on supervisor info endpoint
+        before starting backend
+    */
+    private var name = System.getenv("GITPOD_WORKSPACE_ID") ?: "Gitpod"
+    init {
+        GlobalScope.launch {
+            val info = manager.pendingInfo.await()
+            name = info.workspaceId
+        }
+    }
+
+    override fun getIcon(): Icon {
+        return GitpodIcons.Logo
+    }
+
+    override fun getName(): String {
+        return name
+    }
+
+}
diff --git a/components/ide/jetbrains/backend-plugin/src/main/kotlin/io/gitpod/jetbrains/remote/GitpodClientProjectSessionTracker.kt b/components/ide/jetbrains/backend-plugin/src/main/kotlin/io/gitpod/jetbrains/remote/GitpodClientProjectSessionTracker.kt
@@ -25,8 +25,8 @@ class GitpodClientProjectSessionTracker(
                 event = "jb_session"
                 properties = mapOf(
                         "sessionId" to session.clientId.value,
-                        "instanceId" to info.infoResponse.instanceId,
-                        "workspaceId" to info.infoResponse.workspaceId,
+                        "instanceId" to info.instanceId,
+                        "workspaceId" to info.workspaceId,
                         "appName" to ApplicationInfo.getInstance().versionName,
                         "appVersion" to ApplicationInfo.getInstance().fullVersion,
                         "timestamp" to System.currentTimeMillis()
diff --git a/components/ide/jetbrains/backend-plugin/src/main/kotlin/io/gitpod/jetbrains/remote/GitpodManager.kt b/components/ide/jetbrains/backend-plugin/src/main/kotlin/io/gitpod/jetbrains/remote/GitpodManager.kt
@@ -18,14 +18,17 @@ import git4idea.config.GitVcsApplicationSettings
 import io.gitpod.gitpodprotocol.api.GitpodClient
 import io.gitpod.gitpodprotocol.api.GitpodServerLauncher
 import io.gitpod.jetbrains.remote.services.HeartbeatService
-import io.gitpod.jetbrains.remote.services.SupervisorInfoService
+import io.gitpod.supervisor.api.*
+import io.gitpod.supervisor.api.Info.WorkspaceInfoResponse
 import io.gitpod.supervisor.api.Notification.*
-import io.gitpod.supervisor.api.NotificationServiceGrpc
+import io.grpc.ManagedChannel
+import io.grpc.ManagedChannelBuilder
 import io.grpc.stub.ClientCallStreamObserver
 import io.grpc.stub.ClientResponseObserver
 import kotlinx.coroutines.GlobalScope
 import kotlinx.coroutines.delay
 import kotlinx.coroutines.future.await
+import kotlinx.coroutines.guava.asDeferred
 import kotlinx.coroutines.isActive
 import kotlinx.coroutines.launch
 import org.jetbrains.ide.BuiltInServerManager
@@ -37,10 +40,16 @@ import java.time.Duration
 import java.util.concurrent.CancellationException
 import java.util.concurrent.CompletableFuture
 import javax.websocket.DeploymentException
+import io.gitpod.jetbrains.remote.utils.Retrier.retry
 
 @Service
 class GitpodManager : Disposable {
 
+    companion object {
+        // there should be only one channel per an application to avoid memory leak
+        val supervisorChannel: ManagedChannel = ManagedChannelBuilder.forTarget("localhost:22999").usePlaintext().build()
+    }
+
     val devMode = System.getenv("JB_DEV").toBoolean()
 
     private val lifetime = Lifetime.Eternal.createNested()
@@ -84,8 +93,8 @@ class GitpodManager : Disposable {
 
     private val notificationGroup = NotificationGroupManager.getInstance().getNotificationGroup("Gitpod Notifications")
     private val notificationsJob = GlobalScope.launch {
-        val notifications = NotificationServiceGrpc.newStub(SupervisorInfoService.channel)
-        val futureNotifications = NotificationServiceGrpc.newFutureStub(SupervisorInfoService.channel)
+        val notifications = NotificationServiceGrpc.newStub(supervisorChannel)
+        val futureNotifications = NotificationServiceGrpc.newFutureStub(supervisorChannel)
         while (isActive) {
             try {
                 val f = CompletableFuture<Void>()
@@ -145,11 +154,18 @@ class GitpodManager : Disposable {
         }
     }
 
-    val pendingInfo = CompletableFuture<SupervisorInfoService.Result>()
+    val pendingInfo = CompletableFuture<WorkspaceInfoResponse>()
     private val infoJob = GlobalScope.launch {
         try {
-            // TOO(ak) inline SupervisorInfoService
-            pendingInfo.complete(SupervisorInfoService.fetch())
+            // TODO(ak) replace retry with proper handling of grpc errors
+            val infoResponse = retry(3) {
+                InfoServiceGrpc
+                        .newFutureStub(supervisorChannel)
+                        .workspaceInfo(Info.WorkspaceInfoRequest.newBuilder().build())
+                        .asDeferred()
+                        .await()
+            }
+            pendingInfo.complete(infoResponse)
         } catch (t: Throwable) {
             pendingInfo.completeExceptionally(t)
         }
@@ -163,6 +179,23 @@ class GitpodManager : Disposable {
     val client = GitpodClient()
     private val serverJob = GlobalScope.launch {
         val info = pendingInfo.await()
+
+        // TODO(ak) replace retry with proper handling of grpc errors
+        val tokenResponse = retry(3) {
+            val request = Token.GetTokenRequest.newBuilder()
+                    .setHost(info.gitpodApi.host)
+                    .addScope("function:sendHeartBeat")
+                    .addScope("function:trackEvent")
+                    .setKind("gitpod")
+                    .build()
+
+            TokenServiceGrpc
+                    .newFutureStub(supervisorChannel)
+                    .getToken(request)
+                    .asDeferred()
+                    .await()
+        }
+
         val launcher = GitpodServerLauncher.create(client)
         val plugin = PluginManagerCore.getPlugin(PluginId.getId("io.gitpod.jetbrains.remote"))!!
         val connect = {
@@ -171,11 +204,11 @@ class GitpodManager : Disposable {
                 // see https://intellij-support.jetbrains.com/hc/en-us/community/posts/360003146180/comments/360000376240
                 Thread.currentThread().contextClassLoader = HeartbeatService::class.java.classLoader
                 launcher.listen(
-                        info.infoResponse.gitpodApi.endpoint,
-                        info.infoResponse.gitpodHost,
+                        info.gitpodApi.endpoint,
+                        info.gitpodHost,
                         plugin.pluginId.idString,
                         plugin.version,
-                        info.tokenResponse.token
+                        tokenResponse.token
                 )
             } finally {
                 Thread.currentThread().contextClassLoader = originalClassLoader;
@@ -186,7 +219,7 @@ class GitpodManager : Disposable {
         val maxReconnectionDelay = 30 * 1000L
         val reconnectionDelayGrowFactor = 1.5;
         var reconnectionDelay = minReconnectionDelay;
-        val gitpodHost = info.infoResponse.gitpodApi.host
+        val gitpodHost = info.gitpodApi.host
         var closeReason: Any = "cancelled"
         try {
             while (kotlin.coroutines.coroutineContext.isActive) {
diff --git a/components/ide/jetbrains/backend-plugin/src/main/kotlin/io/gitpod/jetbrains/remote/icons/GitpodIcons.kt b/components/ide/jetbrains/backend-plugin/src/main/kotlin/io/gitpod/jetbrains/remote/icons/GitpodIcons.kt
@@ -0,0 +1,11 @@
+// Copyright (c) 2022 Gitpod GmbH. All rights reserved.
+// Licensed under the GNU Affero General Public License (AGPL).
+// See License-AGPL.txt in the project root for license information.
+package io.gitpod.jetbrains.remote.icons
+
+import com.intellij.openapi.util.IconLoader
+
+object GitpodIcons {
+    @JvmField
+    val Logo = IconLoader.getIcon("/icons/logo.svg", javaClass)
+}
diff --git a/components/ide/jetbrains/backend-plugin/src/main/kotlin/io/gitpod/jetbrains/remote/services/HeartbeatService.kt b/components/ide/jetbrains/backend-plugin/src/main/kotlin/io/gitpod/jetbrains/remote/services/HeartbeatService.kt
@@ -40,7 +40,7 @@ class HeartbeatService : Disposable {
                 }
 
                 if (wasClosed != null) {
-                    manager.client.server.sendHeartBeat(SendHeartBeatOptions(info.infoResponse.instanceId, wasClosed)).await()
+                    manager.client.server.sendHeartBeat(SendHeartBeatOptions(info.instanceId, wasClosed)).await()
                 }
             } catch (t: Throwable) {
                 thisLogger().error("gitpod: failed to check activity:", t)
diff --git a/components/ide/jetbrains/backend-plugin/src/main/kotlin/io/gitpod/jetbrains/remote/services/SupervisorInfoService.kt b/components/ide/jetbrains/backend-plugin/src/main/kotlin/io/gitpod/jetbrains/remote/services/SupervisorInfoService.kt
diff --git a/components/ide/jetbrains/backend-plugin/src/main/resources/META-INF/plugin.xml b/components/ide/jetbrains/backend-plugin/src/main/resources/META-INF/plugin.xml
@@ -22,6 +22,9 @@
         <notificationGroup id="Gitpod Notifications" displayType="BALLOON" isLogByDefault="false" />
         <httpRequestHandler implementation="io.gitpod.jetbrains.remote.GitpodCLIService"/>
         <projectService serviceImplementation="io.gitpod.jetbrains.remote.GitpodClientProjectSessionTracker" client="guest" preload="true"/>
+        <applicationService serviceImplementation="io.gitpod.jetbrains.remote.GitpodBranding"
+                            serviceInterface="com.intellij.remoteDev.customization.GatewayBranding"
+                            overrides="true" />
     </extensions>
 
 </idea-plugin>
diff --git a/components/ide/jetbrains/backend-plugin/src/main/resources/icons/logo.svg b/components/ide/jetbrains/backend-plugin/src/main/resources/icons/logo.svg
@@ -0,0 +1,9 @@
+<svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path fill-rule="evenodd" clip-rule="evenodd" d="M9.37099 0.796797C9.8037 1.55484 9.54061 2.52051 8.78337 2.95367L4.07518 5.64692C3.95054 5.71822 3.87367 5.85059 3.87367 5.99392V10.223C3.87367 10.3664 3.95054 10.4987 4.07518 10.57L7.80041 12.701C7.92396 12.7717 8.07581 12.7717 8.19936 12.701L11.9246 10.57C12.0492 10.4987 12.1261 10.3664 12.1261 10.223V7.593L8.77589 9.48528C8.01631 9.91432 7.05311 9.6457 6.62454 8.88531C6.19596 8.12492 6.46429 7.1607 7.22388 6.73167L12.0176 4.02406C13.4778 3.19931 15.2844 4.25546 15.2844 5.93383V10.5435C15.2844 11.6232 14.7065 12.6201 13.7701 13.1558L9.49104 15.6036C8.56704 16.1321 7.43273 16.1321 6.50873 15.6036L2.22969 13.1558C1.29325 12.6201 0.715332 11.6232 0.715332 10.5435V5.67341C0.715332 4.59372 1.29325 3.59681 2.22969 3.06113L7.2164 0.208558C7.97364 -0.22461 8.93828 0.038754 9.37099 0.796797Z" fill="url(#paint0_linear_812_300)"/>
+<defs>
+<linearGradient id="paint0_linear_812_300" x1="11.6809" y1="2.41951" x2="4.19161" y2="14.1813" gradientUnits="userSpaceOnUse">
+<stop stop-color="#FFB45B"/>
+<stop offset="1" stop-color="#FF8A00"/>
+</linearGradient>
+</defs>
+</svg>

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ class HeartbeatService : Disposable {`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`if (wasClosed != null) {`
`43`		`- manager.client.server.sendHeartBeat(SendHeartBeatOptions(info.infoResponse.instanceId, wasClosed)).await()`
	`43`	`+ manager.client.server.sendHeartBeat(SendHeartBeatOptions(info.instanceId, wasClosed)).await()`
`44`	`44`	`}`
`45`	`45`	`} catch (t: Throwable) {`
`46`	`46`	`thisLogger().error("gitpod: failed to check activity:", t)`