Impl: update the workspace panel every 5 seconds

fioan89 · fioan89 · commit e3bd94407703 · 2022-08-12T00:50:45.000+03:00
- poll the workspaces and update the view
- re-select the previous workspace and enable the
  next button if necessary
- added logic to cancel the polling when back or next buttons
  are triggered
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,51 +1,53 @@
-<!-- Keep a Changelog guide -> https://keepachangelog.com -->
-
+<!-- Keep a Changelog guide -> https://keepachangelog.com -->
+
 # coder-gateway Changelog
 
 ## [Unreleased]
+### Changed
+- workspace panel is now updated every 5 seconds
 
 ## [2.0.2]
-### Added
-- support for displaying working and non-working workspaces
-- better support for Light and Dark themes in the "Status" column 
+### Added
+- support for displaying working and non-working workspaces
+- better support for Light and Dark themes in the "Status" column 
 
 
-### Fixed
-- left panel is no longer visible when a new connection is triggered from Coder's "Recent Workspaces" panel.
-  This provides consistency with other plugins compatible with Gateway
-- the "Select IDE and Project" button in the "Coder Workspaces" view is now disabled when no workspace is selected
+### Fixed
+- left panel is no longer visible when a new connection is triggered from Coder's "Recent Workspaces" panel.
+  This provides consistency with other plugins compatible with Gateway
+- the "Select IDE and Project" button in the "Coder Workspaces" view is now disabled when no workspace is selected
 
 
-### Changed
+### Changed
 - the authentication view is now merged with the "Coder Workspaces" view allowing users to quickly change the host
 
 ## [2.0.1]
 ### Fixed
-- `Recent Coder Workspaces` label overlaps with the search bar in the `Connections` view
-- working workspaces are now listed when there are issues with resolving agents
-- list only workspaces owned by the logged user
-
+- `Recent Coder Workspaces` label overlaps with the search bar in the `Connections` view
+- working workspaces are now listed when there are issues with resolving agents
+- list only workspaces owned by the logged user
+
 
 ### Changed
-- links to documentation now point to the latest Coder OSS
-- simplified main action link text from `Connect to Coder Workspaces` to `Connect to Coder`
+- links to documentation now point to the latest Coder OSS
+- simplified main action link text from `Connect to Coder Workspaces` to `Connect to Coder`
 - minimum supported Gateway build is now 222.3739.24
 
 ## [2.0.0]
 ### Added
-- support for Gateway 2022.2
-
+- support for Gateway 2022.2
+
 
 ### Changed
-- Java 17 is now required to run the plugin
+- Java 17 is now required to run the plugin
 - adapted the code to the new SSH API provided by Gateway
 
 ## [1.0.0]
 ### Added
-- initial scaffold for Gateway plugin
-- browser based authentication on Coder environments
-- REST client for Coder V2 public API
-- coder-cli orchestration for setting up the SSH configurations for Coder Workspaces
-- basic panel to display live Coder Workspaces
-- support for multi-agent Workspaces
+- initial scaffold for Gateway plugin
+- browser based authentication on Coder environments
+- REST client for Coder V2 public API
+- coder-cli orchestration for setting up the SSH configurations for Coder Workspaces
+- basic panel to display live Coder Workspaces
+- support for multi-agent Workspaces
 - Gateway SSH connection to a Coder Workspace
diff --git a/src/main/kotlin/com/coder/gateway/views/CoderGatewayConnectorWizardView.kt b/src/main/kotlin/com/coder/gateway/views/CoderGatewayConnectorWizardView.kt
@@ -51,6 +51,8 @@ class CoderGatewayConnectorWizardView : BorderLayoutPanel(), Disposable {
     }
 
     private fun previous() {
+        steps[currentStep].onPrevious()
+
         if (currentStep == 0) {
             GatewayUI.getInstance().reset()
         } else {
diff --git a/src/main/kotlin/com/coder/gateway/views/steps/CoderWorkspacesStepView.kt b/src/main/kotlin/com/coder/gateway/views/steps/CoderWorkspacesStepView.kt
@@ -16,9 +16,7 @@ import com.coder.gateway.sdk.OS
 import com.coder.gateway.sdk.ex.AuthenticationResponseException
 import com.coder.gateway.sdk.getOS
 import com.coder.gateway.sdk.toURL
-import com.coder.gateway.sdk.v2.models.ProvisionerJobStatus
 import com.coder.gateway.sdk.v2.models.Workspace
-import com.coder.gateway.sdk.v2.models.WorkspaceBuildTransition
 import com.coder.gateway.sdk.withPath
 import com.intellij.ide.BrowserUtil
 import com.intellij.ide.IdeBundle
@@ -51,11 +49,13 @@ import com.intellij.util.ui.ListTableModel
 import com.intellij.util.ui.table.IconTableCellRenderer
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.Job
 import kotlinx.coroutines.cancel
+import kotlinx.coroutines.delay
+import kotlinx.coroutines.isActive
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.withContext
 import org.zeroturnaround.exec.ProcessExecutor
-import java.awt.Color
 import java.awt.Component
 import java.awt.Dimension
 import javax.swing.Icon
@@ -88,6 +88,8 @@ class CoderWorkspacesStepView(val enableNextButtonCallback: (Boolean) -> Unit) :
         }
     }
 
+    private var poller: Job? = null
+
     override val component = panel {
         indent {
             row {
@@ -105,10 +107,12 @@ class CoderWorkspacesStepView(val enableNextButtonCallback: (Boolean) -> Unit) :
             row(CoderGatewayBundle.message("gateway.connector.view.login.url.label")) {
                 textField().resizableColumn().horizontalAlign(HorizontalAlign.FILL).gap(RightGap.SMALL).bindText(wizardModel::coderURL).applyToComponent {
                     addActionListener {
+                        poller?.cancel()
                         loginAndLoadWorkspace()
                     }
                 }
                 button(CoderGatewayBundle.message("gateway.connector.view.coder.workspaces.connect.text")) {
+                    poller?.cancel()
                     loginAndLoadWorkspace()
                 }.applyToComponent {
                     background = WelcomeScreenUIManager.getMainAssociatedComponentBackground()
@@ -211,18 +215,30 @@ class CoderWorkspacesStepView(val enableNextButtonCallback: (Boolean) -> Unit) :
     }
 
     private fun loadWorkspaces() {
-        cs.launch {
-            val workspaceList = withContext(Dispatchers.IO) {
-                try {
-                    return@withContext coderClient.workspaces().collectAgents()
-                } catch (e: Exception) {
-                    logger.error("Could not retrieve workspaces for ${coderClient.me.username} on ${coderClient.coderURL}. Reason: $e")
-                    emptyList()
+        poller = cs.launch {
+            while (isActive) {
+                val workspaceList = withContext(Dispatchers.IO) {
+                    try {
+                        return@withContext coderClient.workspaces().collectAgents()
+                    } catch (e: Exception) {
+                        logger.error("Could not retrieve workspaces for ${coderClient.me.username} on ${coderClient.coderURL}. Reason: $e")
+                        emptyList()
+                    }
                 }
-            }
 
-            // if we just run the update on the main dispatcher, the code will block because it cant get some AWT locks
-            ApplicationManager.getApplication().invokeLater { listTableModelOfWorkspaces.updateItems(workspaceList) }
+                val selectedWorkspace = withContext(Dispatchers.Main) {
+                    tableOfWorkspaces.selectedObject
+                }
+
+                // if we just run the update on the main dispatcher, the code will block because it cant get some AWT locks
+                ApplicationManager.getApplication().invokeLater {
+                    listTableModelOfWorkspaces.updateItems(workspaceList)
+                    if (selectedWorkspace != null) {
+                        tableOfWorkspaces.selectItem(selectedWorkspace)
+                    }
+                }
+            }
+            delay(5000)
         }
     }
 
@@ -279,10 +295,16 @@ class CoderWorkspacesStepView(val enableNextButtonCallback: (Boolean) -> Unit) :
         }
     }
 
+    override fun onPrevious() {
+        super.onPrevious()
+        poller?.cancel()
+    }
+
     override fun onNext(wizardModel: CoderWorkspacesWizardModel): Boolean {
         val workspace = tableOfWorkspaces.selectedObject
         if (workspace != null) {
             wizardModel.selectedWorkspace = workspace
+            poller?.cancel()
             return true
         }
         return false
@@ -387,6 +409,13 @@ class CoderWorkspacesStepView(val enableNextButtonCallback: (Boolean) -> Unit) :
         this.addRows(workspaces)
     }
 
+    private fun TableView<WorkspaceAgentModel>.selectItem(workspace: WorkspaceAgentModel) {
+        this.items.forEachIndexed { index, workspaceAgentModel ->
+            if (workspaceAgentModel.name == workspace.name)
+                this.setRowSelectionInterval(index, index)
+        }
+    }
+
     companion object {
         val logger = Logger.getInstance(CoderWorkspacesStepView::class.java.simpleName)
     }
diff --git a/src/main/kotlin/com/coder/gateway/views/steps/CoderWorkspacesWizardStep.kt b/src/main/kotlin/com/coder/gateway/views/steps/CoderWorkspacesWizardStep.kt
@@ -10,5 +10,10 @@ sealed interface CoderWorkspacesWizardStep {
     val previousActionText: String
 
     fun onInit(wizardModel: CoderWorkspacesWizardModel)
+
+    fun onPrevious() {
+
+    }
+
     fun onNext(wizardModel: CoderWorkspacesWizardModel): Boolean
 }

Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,8 @@ class CoderGatewayConnectorWizardView : BorderLayoutPanel(), Disposable {`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`private fun previous() {`
	`54`	`+ steps[currentStep].onPrevious()`
	`55`	`+`
`54`	`56`	`if (currentStep == 0) {`
`55`	`57`	`GatewayUI.getInstance().reset()`
`56`	`58`	`} else {`