Support remote Json Serialization in runOnInstance (#424)

xh · Nov 29, 2024 · a4a64f9 · a4a64f9
1 parent 8d4a14b
commit a4a64f9
Show file tree

Hide file tree

Showing 17 changed files with 157 additions and 64 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,13 @@
 
 ## 26.0-SNAPSHOT - unreleased
 
+### 💥 Breaking Changes (upgrade difficulty: 🟢 TRIVIAL - change to runOnInstance signature.)
+
+### 🎁 New Features
+* `BaseController.runOnInstance` now performs the json serialization on the target instance.  This
+allows lighter-weight remote endpoint executions, that do not require object serialization.
+Applications must now provide a `ClusterJsonRequest` to this method rather than a `ClusterRequest`
+
 ### ⚙️ Technical
 * Align all-built in log names to have form "App-Cluster-xxx.log"
 

diff --git a/grails-app/controllers/io/xh/hoist/BaseController.groovy b/grails-app/controllers/io/xh/hoist/BaseController.groovy
@@ -9,6 +9,8 @@ package io.xh.hoist
 
 import grails.async.Promise
 import groovy.transform.CompileStatic
+import io.xh.hoist.cluster.ClusterJsonRequest
+import io.xh.hoist.cluster.ClusterJsonResponse
 import io.xh.hoist.cluster.ClusterRequest
 import io.xh.hoist.cluster.ClusterService
 import io.xh.hoist.exception.ExceptionHandler
@@ -88,18 +90,15 @@ abstract class BaseController implements LogSupport, IdentitySupport {
      * Note:  Any exception that occurs is assumed to be logged on the target instance
      * and will not be logged on the instance running this action.
      */
-    protected void runOnInstance(ClusterRequest task, String instance) {
-        def ret = clusterService.submitToInstance(task, instance)
-        if (ret.exception) {
-            // Just render exception, was already logged on target instance
-            xhExceptionHandler.handleException(exception: ret.exception, renderTo: response)
-            return
-        }
-        renderJSON(ret.value)
+    protected void runOnInstance(ClusterJsonRequest task, String instance) {
+        ClusterJsonResponse ret = clusterService.submitToInstance(task, instance)
+        response.setStatus(ret.httpStatus)
+        response.setContentType('application/json; charset=UTF-8')
+        render(ret.json)
     }
 
     /** Run a task on the primary cluster instance. */
-    protected void runOnPrimary(ClusterRequest task) {
+    protected void runOnPrimary(ClusterJsonRequest task) {
         runOnInstance(task, clusterService.primaryName)
     }
 

diff --git a/grails-app/controllers/io/xh/hoist/admin/MonitorResultsAdminController.groovy b/grails-app/controllers/io/xh/hoist/admin/MonitorResultsAdminController.groovy
@@ -8,7 +8,7 @@
 package io.xh.hoist.admin
 
 import io.xh.hoist.BaseController
-import io.xh.hoist.cluster.ClusterRequest
+import io.xh.hoist.cluster.ClusterJsonRequest
 import io.xh.hoist.security.Access
 import static io.xh.hoist.util.Utils.getAppContext
 
@@ -25,9 +25,10 @@ class MonitorResultsAdminController extends BaseController {
     def forceRunAllMonitors() {
         runOnPrimary(new ForceRunAllMonitors())
     }
-    static class ForceRunAllMonitors extends ClusterRequest {
+    static class ForceRunAllMonitors extends ClusterJsonRequest {
         def doCall() {
             appContext.monitorService.forceRun()
+            [success: true]
         }
     }
 }
diff --git a/grails-app/controllers/io/xh/hoist/admin/cluster/ClusterAdminController.groovy b/grails-app/controllers/io/xh/hoist/admin/cluster/ClusterAdminController.groovy
@@ -8,7 +8,7 @@
 package io.xh.hoist.admin.cluster
 
 import io.xh.hoist.BaseController
-import io.xh.hoist.cluster.ClusterRequest
+import io.xh.hoist.cluster.ClusterJsonRequest
 import io.xh.hoist.security.Access
 import io.xh.hoist.util.Utils
 
@@ -42,7 +42,7 @@ class ClusterAdminController extends BaseController {
         // Wait enough to let async call below complete
         sleep(5 * SECONDS)
     }
-    static class ShutdownInstance extends ClusterRequest {
+    static class ShutdownInstance extends ClusterJsonRequest {
         def doCall() {
             // Run async to allow this call to successfully return.
             task {

diff --git a/grails-app/controllers/io/xh/hoist/admin/cluster/ConnectionPoolMonitorAdminController.groovy b/grails-app/controllers/io/xh/hoist/admin/cluster/ConnectionPoolMonitorAdminController.groovy
@@ -7,7 +7,7 @@
 package io.xh.hoist.admin.cluster
 
 import io.xh.hoist.BaseController
-import io.xh.hoist.cluster.ClusterRequest
+import io.xh.hoist.cluster.ClusterJsonRequest
 import io.xh.hoist.security.Access
 
 import static io.xh.hoist.util.Utils.appContext
@@ -18,7 +18,7 @@ class ConnectionPoolMonitorAdminController extends BaseController {
     def snapshots(String instance) {
         runOnInstance(new Snapshots(), instance)
     }
-    static class Snapshots extends ClusterRequest {
+    static class Snapshots extends ClusterJsonRequest {
         def doCall() {
             def svc = appContext.connectionPoolMonitoringService
             return [
@@ -34,7 +34,7 @@ class ConnectionPoolMonitorAdminController extends BaseController {
     def takeSnapshot(String instance) {
         runOnInstance(new TakeSnapshot(), instance)
     }
-    static class TakeSnapshot extends ClusterRequest {
+    static class TakeSnapshot extends ClusterJsonRequest {
         def doCall() {
             appContext.connectionPoolMonitoringService.takeSnapshot()
         }
@@ -44,7 +44,7 @@ class ConnectionPoolMonitorAdminController extends BaseController {
     def resetStats() {
         runOnInstance(new ResetStats())
     }
-    static class ResetStats extends ClusterRequest {
+    static class ResetStats extends ClusterJsonRequest {
         def doCall() {
             appContext.connectionPoolMonitoringService.resetStats()
         }

diff --git a/grails-app/controllers/io/xh/hoist/admin/cluster/EnvAdminController.groovy b/grails-app/controllers/io/xh/hoist/admin/cluster/EnvAdminController.groovy
@@ -7,7 +7,7 @@
 package io.xh.hoist.admin.cluster
 
 import io.xh.hoist.BaseController
-import io.xh.hoist.cluster.ClusterRequest
+import io.xh.hoist.cluster.ClusterJsonRequest
 import io.xh.hoist.security.Access
 
 import static io.xh.hoist.util.Utils.isSensitiveParamName
@@ -19,7 +19,7 @@ class EnvAdminController extends BaseController {
     def index(String instance) {
         runOnInstance(new Index(), instance)
     }
-    static class Index extends ClusterRequest {
+    static class Index extends ClusterJsonRequest {
         def doCall() {
             [
                 environment: System.getenv().collectEntries {

diff --git a/grails-app/controllers/io/xh/hoist/admin/cluster/HzObjectAdminController.groovy b/grails-app/controllers/io/xh/hoist/admin/cluster/HzObjectAdminController.groovy
@@ -7,7 +7,7 @@
 package io.xh.hoist.admin.cluster
 
 import io.xh.hoist.BaseController
-import io.xh.hoist.cluster.ClusterRequest
+import io.xh.hoist.cluster.ClusterJsonRequest
 import io.xh.hoist.security.Access
 
 import static io.xh.hoist.util.Utils.appContext
@@ -20,7 +20,7 @@ class HzObjectAdminController extends BaseController {
         runOnInstance(new ListObjects(), instance)
     }
 
-    static class ListObjects extends ClusterRequest {
+    static class ListObjects extends ClusterJsonRequest {
         def doCall() {
             appContext.clusterAdminService.listObjects()
         }
@@ -31,7 +31,7 @@ class HzObjectAdminController extends BaseController {
         runOnInstance(new ClearObjects(names: params.list('names')), instance)
     }
 
-    static class ClearObjects extends ClusterRequest {
+    static class ClearObjects extends ClusterJsonRequest {
         List<String> names
 
         def doCall() {
@@ -45,7 +45,7 @@ class HzObjectAdminController extends BaseController {
         runOnInstance(new ClearHibernateCaches(), instance)
     }
 
-    static class ClearHibernateCaches extends ClusterRequest {
+    static class ClearHibernateCaches extends ClusterJsonRequest {
         def doCall() {
             appContext.clusterAdminService.clearHibernateCaches()
             return [success: true]

diff --git a/grails-app/controllers/io/xh/hoist/admin/cluster/LogViewerAdminController.groovy b/grails-app/controllers/io/xh/hoist/admin/cluster/LogViewerAdminController.groovy
@@ -10,6 +10,7 @@ package io.xh.hoist.admin.cluster
 import groovy.io.FileType
 import io.xh.hoist.BaseController
 import io.xh.hoist.cluster.ClusterRequest
+import io.xh.hoist.cluster.ClusterJsonRequest
 import io.xh.hoist.configuration.LogbackConfig
 import io.xh.hoist.security.Access
 import io.xh.hoist.exception.RoutineRuntimeException
@@ -23,7 +24,7 @@ class LogViewerAdminController extends BaseController {
         runOnInstance(new ListFiles(), instance)
     }
 
-    static class ListFiles extends ClusterRequest {
+    static class ListFiles extends ClusterJsonRequest {
         def doCall() {
             def logRootPath = appContext.logReaderService.logDir.absolutePath,
                 files = availableFiles.collect {
@@ -58,7 +59,7 @@ class LogViewerAdminController extends BaseController {
         )
     }
 
-    static class GetFile extends ClusterRequest {
+    static class GetFile extends ClusterJsonRequest {
         String filename
         Integer startLine
         Integer maxLines
@@ -86,19 +87,19 @@ class LogViewerAdminController extends BaseController {
             return
         }
 
-        render(
-            file: ret.value,
-            fileName: filename,
-            contentType: 'application/octet-stream'
-        )
+        render(ret)
     }
 
-    static class Download extends ClusterRequest<File> {
+    static class Download extends ClusterRequest<Map> {
         String filename
-
-        File doCall() {
+        Map doCall() {
             if (!availableFiles[filename]) throwUnavailable(filename)
-            return appContext.logReaderService.get(filename)
+            def file = appContext.logReaderService.get(filename)
+            [
+                file: file.bytes,
+                fileName: filename,
+                contentType: 'application/octet-stream'
+            ]
         }
     }
 
@@ -112,7 +113,7 @@ class LogViewerAdminController extends BaseController {
         runOnInstance(new DeleteFiles(filenames: params.list('filenames')), instance)
     }
 
-    static class DeleteFiles extends ClusterRequest {
+    static class DeleteFiles extends ClusterJsonRequest {
         List<String> filenames
 
         def doCall() {
@@ -138,7 +139,7 @@ class LogViewerAdminController extends BaseController {
         runOnInstance(new ArchiveLogs(daysThreshold: daysThreshold), instance)
     }
 
-    static class ArchiveLogs extends ClusterRequest {
+    static class ArchiveLogs extends ClusterJsonRequest {
         Integer daysThreshold
 
         def doCall() {

diff --git a/grails-app/controllers/io/xh/hoist/admin/cluster/MemoryMonitorAdminController.groovy b/grails-app/controllers/io/xh/hoist/admin/cluster/MemoryMonitorAdminController.groovy
@@ -8,7 +8,7 @@
 package io.xh.hoist.admin.cluster
 
 import io.xh.hoist.BaseController
-import io.xh.hoist.cluster.ClusterRequest
+import io.xh.hoist.cluster.ClusterJsonRequest
 import io.xh.hoist.security.Access
 
 import static io.xh.hoist.util.Utils.appContext
@@ -21,7 +21,7 @@ class MemoryMonitorAdminController extends BaseController {
     def snapshots(String instance) {
         runOnInstance(new Snapshots(), instance)
     }
-    static class Snapshots extends ClusterRequest {
+    static class Snapshots extends ClusterJsonRequest {
         def doCall() {
             appContext.memoryMonitoringService.snapshots
         }
@@ -31,7 +31,7 @@ class MemoryMonitorAdminController extends BaseController {
     def takeSnapshot(String instance) {
         runOnInstance(new TakeSnapshot(), instance)
     }
-    static class TakeSnapshot extends ClusterRequest {
+    static class TakeSnapshot extends ClusterJsonRequest {
         def doCall() {
             appContext.memoryMonitoringService.takeSnapshot()
         }
@@ -42,7 +42,7 @@ class MemoryMonitorAdminController extends BaseController {
     def requestGc(String instance) {
         runOnInstance(new RequestGc(), instance)
     }
-    static class RequestGc extends ClusterRequest {
+    static class RequestGc extends ClusterJsonRequest {
         def doCall() {
             appContext.memoryMonitoringService.requestGc()
         }
@@ -52,7 +52,7 @@ class MemoryMonitorAdminController extends BaseController {
     def dumpHeap(String filename, String instance) {
         runOnInstance(new DumpHeap(filename: filename), instance)
     }
-    static class DumpHeap extends ClusterRequest {
+    static class DumpHeap extends ClusterJsonRequest {
         String filename
 
         def doCall() {

diff --git a/grails-app/controllers/io/xh/hoist/admin/cluster/ServiceManagerAdminController.groovy b/grails-app/controllers/io/xh/hoist/admin/cluster/ServiceManagerAdminController.groovy
@@ -7,7 +7,7 @@
 package io.xh.hoist.admin.cluster
 
 import io.xh.hoist.BaseController
-import io.xh.hoist.cluster.ClusterRequest
+import io.xh.hoist.cluster.ClusterJsonRequest
 import io.xh.hoist.security.Access
 
 import static io.xh.hoist.util.Utils.appContext
@@ -18,7 +18,7 @@ class ServiceManagerAdminController extends BaseController {
     def listServices(String instance) {
         runOnInstance(new ListServices(), instance)
     }
-    static class ListServices extends ClusterRequest {
+    static class ListServices extends ClusterJsonRequest {
         def doCall() {
             appContext.serviceManagerService.listServices()
         }
@@ -28,7 +28,7 @@ class ServiceManagerAdminController extends BaseController {
         def task = new GetStats(name: name)
         runOnInstance(task, instance)
     }
-    static class GetStats extends ClusterRequest {
+    static class GetStats extends ClusterJsonRequest {
         String name
         def doCall() {
             appContext.serviceManagerService.getStats(name)
@@ -40,7 +40,7 @@ class ServiceManagerAdminController extends BaseController {
         def task = new ClearCaches(names: params.list('names'))
         instance ? runOnInstance(task, instance) : runOnAllInstances(task)
     }
-    static class ClearCaches extends ClusterRequest {
+    static class ClearCaches extends ClusterJsonRequest {
         List<String> names
 
         def doCall() {

diff --git a/grails-app/controllers/io/xh/hoist/admin/cluster/WebSocketAdminController.groovy b/grails-app/controllers/io/xh/hoist/admin/cluster/WebSocketAdminController.groovy
@@ -8,7 +8,7 @@
 package io.xh.hoist.admin.cluster
 
 import io.xh.hoist.BaseController
-import io.xh.hoist.cluster.ClusterRequest
+import io.xh.hoist.cluster.ClusterJsonRequest
 import io.xh.hoist.security.Access
 
 import static io.xh.hoist.util.Utils.getAppContext
@@ -19,17 +19,17 @@ class WebSocketAdminController extends BaseController {
     def allChannels(String instance) {
         runOnInstance(new AllChannels(), instance)
     }
-    static class AllChannels extends ClusterRequest {
+    static class AllChannels extends ClusterJsonRequest {
         def doCall() {
-            appContext.webSocketService.allChannels*.formatForJSON()
+            appContext.webSocketService.allChannels
         }
     }
 
     @Access(['HOIST_ADMIN'])
     def pushToChannel(String channelKey, String topic, String message, String instance) {
         runOnInstance(new PushToChannel(channelKey: channelKey, topic: topic, message: message), instance)
     }
-    static class PushToChannel extends ClusterRequest {
+    static class PushToChannel extends ClusterJsonRequest {
         String channelKey
         String topic
         String message

diff --git a/grails-app/services/io/xh/hoist/cluster/ClusterService.groovy b/grails-app/services/io/xh/hoist/cluster/ClusterService.groovy
@@ -16,6 +16,8 @@ import io.xh.hoist.util.Utils
 import org.springframework.boot.context.event.ApplicationReadyEvent
 import org.springframework.context.ApplicationListener
 
+import java.util.concurrent.Callable
+
 class ClusterService extends BaseService implements ApplicationListener<ApplicationReadyEvent> {
 
     /**
@@ -143,11 +145,11 @@ class ClusterService extends BaseService implements ApplicationListener<Applicat
         return hzInstance.getExecutorService('default')
     }
 
-    <T> ClusterResponse<T> submitToInstance(ClusterRequest<T> c, String instance) {
-            executorService.submitToMember(c, getMember(instance)).get()
+    <T> T submitToInstance(Callable<T> c, String instance) {
+        executorService.submitToMember(c, getMember(instance)).get()
     }
 
-    <T> Map<String, ClusterResponse<T>> submitToAllInstances(ClusterRequest<T> c) {
+    <T> Map<String, T> submitToAllInstances(Callable<T> c) {
         executorService
             .submitToAllMembers(c)
             .collectEntries { member, f -> [member.getAttribute('instanceName'), f.get()] }