Replaced EAM dependency with a custom download intent (#149)

Author: grossm04

gateway-network-function/README.md

@@ -7,13 +7,9 @@ This module provides examples for the following functionality:
 ## How to Use This Module
 ### Requirements
 The following are required:
-1. Two Gateway instances connected via the Gateway Area Network. 
+1. Two Gateway instances connected via the Gateway Network. 
 2. This module must be installed on both Gateways.
 
-> [!NOTE]
-> `getRemoteLogEntries()` will work once the above requirements are met.  
-> `getRemoteLogFile()` and `pushRemoteLogFile()` require an additional step: a Controller/Agent EAM configuration between the two Gateways must be created with the Controller being the issue of the script call and the Agent being the target of the script call.  
-
 ### Example Scripts
 #### Retrieve Logs as Dataset
 This retrieves log entries and places them in a dataset. The dataset is sorted in reverse chronological order, with the most recent entry being first in the dataset.
@@ -47,7 +43,7 @@ bytes = system.example.gn.getRemoteLogFile(remote_gateway)
 
 now=datetime.datetime.now().strftime("%m%d%Y_%H%M%S")
 save_file="/tmp/%s_%s-system_logs.idb" % (remote_gateway, now)
-print("Successfully downloaded system_logs.idb, saving to '%s'" % save_file)
+print("Successfully downloaded system_logs.idb, copying to local machine at '%s'" % save_file)
 system.file.writeFile(save_file, bytes)
 ```
 

gateway-network-function/gateway-network-function-build/pom.xml

@@ -7,7 +7,7 @@
     <parent>
         <artifactId>gateway-network-function</artifactId>
         <groupId>com.inductiveautomation.examples</groupId>
-        <version>2.0.0-SNAPSHOT</version>
+        <version>2.0.1-SNAPSHOT</version>
     </parent>
 
     <artifactId>gateway-network-function-build</artifactId>
@@ -84,13 +84,6 @@
                     <moduleVersion>${project.version}</moduleVersion>
                     <requiredIgnitionVersion>${ignition-platform-version}</requiredIgnitionVersion>
 
-                    <depends>
-                        <depend>
-                            <scope>G</scope>
-                            <moduleId>com.inductiveautomation.eam</moduleId>
-                        </depend>
-                    </depends>
-
                     <hooks>
                         <hook>
                             <scope>C</scope>

gateway-network-function/gateway-network-function-client/pom.xml

@@ -7,7 +7,7 @@
     <parent>
         <artifactId>gateway-network-function</artifactId>
         <groupId>com.inductiveautomation.examples</groupId>
-        <version>2.0.0-SNAPSHOT</version>
+        <version>2.0.1-SNAPSHOT</version>
     </parent>
 
     <artifactId>gateway-network-function-client</artifactId>

gateway-network-function/gateway-network-function-common/pom.xml

@@ -7,7 +7,7 @@
     <parent>
         <artifactId>gateway-network-function</artifactId>
         <groupId>com.inductiveautomation.examples</groupId>
-        <version>2.0.0-SNAPSHOT</version>
+        <version>2.0.1-SNAPSHOT</version>
     </parent>
 
     <artifactId>gateway-network-function-common</artifactId>

gateway-network-function/gateway-network-function-designer/pom.xml

@@ -7,7 +7,7 @@
     <parent>
         <artifactId>gateway-network-function</artifactId>
         <groupId>com.inductiveautomation.examples</groupId>
-        <version>2.0.0-SNAPSHOT</version>
+        <version>2.0.1-SNAPSHOT</version>
     </parent>
 
     <artifactId>gateway-network-function-designer</artifactId>

gateway-network-function/gateway-network-function-gateway/pom.xml

@@ -7,7 +7,7 @@
     <parent>
         <artifactId>gateway-network-function</artifactId>
         <groupId>com.inductiveautomation.examples</groupId>
-        <version>2.0.0-SNAPSHOT</version>
+        <version>2.0.1-SNAPSHOT</version>
     </parent>
 
     <artifactId>gateway-network-function-gateway</artifactId>
@@ -29,14 +29,6 @@
             <scope>provided</scope>
         </dependency>
 
-        <dependency>
-            <groupId>com.inductiveautomation.eam</groupId>
-            <artifactId>eam-gateway</artifactId>
-            <version>5.3.0-SNAPSHOT</version>
-            <type>jar</type>
-            <scope>provided</scope>
-        </dependency>
-
         <dependency>
             <artifactId>gateway-network-function-common</artifactId>
             <groupId>com.inductiveautomation.examples</groupId>

gateway-network-function/gateway-network-function-gateway/src/main/java/com/inductiveautomation/ignition/examples/gn/GatewayHook.java

@@ -5,15 +5,18 @@
 import java.nio.file.Files;
 import java.util.Optional;
 import java.util.UUID;
+import java.util.concurrent.atomic.AtomicInteger;
 
 import com.inductiveautomation.ignition.common.BundleUtil;
 import com.inductiveautomation.ignition.common.licensing.LicenseState;
 import com.inductiveautomation.ignition.common.logging.LogEvent;
 import com.inductiveautomation.ignition.common.script.ScriptManager;
 import com.inductiveautomation.ignition.common.script.hints.PropertiesFileDocProvider;
+import com.inductiveautomation.ignition.examples.gn.intent.HandleLogFileIntent;
 import com.inductiveautomation.ignition.examples.gn.protoserializers.LogEventSerializer;
 import com.inductiveautomation.ignition.examples.gn.service.GetLogsService;
 import com.inductiveautomation.ignition.examples.gn.service.GetLogsServiceImpl;
+import com.inductiveautomation.ignition.gateway.gan.GatewayNetworkManager;
 import com.inductiveautomation.ignition.gateway.model.AbstractGatewayModuleHook;
 import com.inductiveautomation.ignition.gateway.model.GatewayContext;
 import com.inductiveautomation.ignition.gateway.rpc.GatewayRpcImplementation;
@@ -31,6 +34,7 @@ public class GatewayHook extends AbstractGatewayModuleHook {
     private GetLogsGatewayFunctions gatewayFunctions;
     private GatewayRpcImplementation rpc;
     private GetLogsService getLogsService;
+    private final AtomicInteger taskIdAcc = new AtomicInteger();
 
     @Override
     public void setup(GatewayContext gatewayContext) {
@@ -51,6 +55,10 @@ public void setup(GatewayContext gatewayContext) {
         ServiceManager sm = context.getGatewayNetworkManager().getServiceManager();
         getLogsService = new GetLogsServiceImpl(context, this);
         sm.registerService(GetLogsService.class, getLogsService);
+
+        // Intent setup
+        GatewayNetworkManager gm = context.getGatewayNetworkManager();
+        gm.registerIntent(new HandleLogFileIntent());
     }
 
     @Override
@@ -64,6 +72,10 @@ public void shutdown() {
         ServiceManager sm = context.getGatewayNetworkManager().getServiceManager();
         sm.unregisterService(GetLogsService.class);
 
+        // Remove intents
+        GatewayNetworkManager gm = context.getGatewayNetworkManager();
+        gm.unregisterIntent(HandleLogFileIntent.NAME);
+
         // Remove properties files
         BundleUtil.get().removeBundle(getClass());
     }
@@ -109,4 +121,12 @@ public File getTempLogFile() throws IOException {
 
         return tempLog;
     }
+
+    /**
+     * A central incrementer that can be used to register temporary intents
+     *
+     */
+    public Integer getNextIntentId() {
+        return taskIdAcc.getAndIncrement();
+    }
 }

gateway-network-function/gateway-network-function-gateway/src/main/java/com/inductiveautomation/ignition/examples/gn/GetLogsGatewayFunctions.java

@@ -11,10 +11,9 @@
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.TimeUnit;
 
-import com.inductiveautomation.eam.gateway.intents.ReceiveDownloadIntent;
-import com.inductiveautomation.eam.gateway.module.EAMGatewayHook;
 import com.inductiveautomation.ignition.common.logging.LogEvent;
 import com.inductiveautomation.ignition.common.script.hints.NoHint;
+import com.inductiveautomation.ignition.examples.gn.intent.HandleLogFileIntent;
 import com.inductiveautomation.ignition.examples.gn.service.GetLogsService;
 import com.inductiveautomation.ignition.gateway.gan.GatewayNetworkManager;
 import com.inductiveautomation.ignition.gateway.model.GatewayContext;
@@ -103,28 +102,26 @@ public byte[] getLogFileInternal(String remoteServer) throws IOException {
         else {
             /* Getting a file as a service call result is a bit tricky with the gateway network. The file must be
             streamed between gateways, and service call results can't be streamed directly. To get around this,
-            we have to use the built-in ReceiveDownloadIntent and a CompletableFuture. We register a new
-            CompletableFuture with the ReceiveDownloadIntent using a unique download id. Then we pass that id to the
-            service call. The other gateway will retrieve the file and then make a ReceiveDownloadIntent gateway
-            network call. It passes the file stream and download id as part of the call. On this gateway, the
-            ReceiveDownloadIntent fires and locates our waiting CompletableFuture using the download id. It completes
-            our CompletableFuture and passes over the full path of the downloaded log file (the file is stored in a
-            temporary location, but can be moved as needed).
-
-            NB. The gateways must have EAM configured, and be setup in a Controller/Agent configuration. If EAM
-            hasn't been configured on the instance yet, the ReceiveDownloadIntent will not be available.
+            we have to use the HandleLogFileIntent and a CompletableFuture. The intent's receive() function on this
+            gateway fires when it receives the streamed log file, and it will complete the CompletableFuture
+            created here.
+
+            We register a new CompletableFuture with the HandleLogFileIntent using a unique download id. Then we pass
+            that id to the service call. The other gateway will retrieve the file and then make a HandleLogFileIntent
+            gateway network call. It passes the file stream and download id as part of the call. On this gateway,
+            HandleLogFileIntent#receive() fires and internally retrieves our waiting CompletableFuture using the
+            download id. It completes our CompletableFuture and passes over the full path of the downloaded log file
+             (the file is stored in a temporary location, but can be moved as needed).
              */
-            ReceiveDownloadIntent downloadIntent = (ReceiveDownloadIntent)
-                gm.retrieveIntent(ReceiveDownloadIntent.NAME)
-                    .orElseThrow(() -> new IllegalStateException(
-                        "ReceiveDownloadIntent not registered; EAM has not been configured."
-                    ));
+            HandleLogFileIntent logFileIntent = (HandleLogFileIntent) gm.retrieveIntent(HandleLogFileIntent.NAME)
+                .orElseThrow(() ->
+                    new IllegalStateException("HandleLogFileIntent not registered in gateway network manager"));
 
             String localGwbkPath = null;
             CompletableFuture<String> downloadFuture = new CompletableFuture<>();
 
-            int nextId = EAMGatewayHook.getInstance().getNextIntentId();
-            downloadIntent.addPendingFuture(nextId, downloadFuture);
+            int nextId = this.gatewayHook.getNextIntentId();
+            logFileIntent.addPendingFuture(nextId, downloadFuture);
 
             String response = null;
             try {
@@ -141,7 +138,7 @@ our CompletableFuture and passes over the full path of the downloaded log file (
             } catch (Exception e) {
                 // Clean up the CompletableFuture since it will never be completed normally.
                 downloadFuture.cancel(true);
-                downloadIntent.removePendingFuture(nextId);
+                logFileIntent.removePendingFuture(nextId);
                 throw new IOException(e.getMessage());
             }
         }

gateway-network-function/gateway-network-function-gateway/src/main/java/com/inductiveautomation/ignition/examples/gn/intent/HandleLogFileIntent.java

@@ -0,0 +1,54 @@
+package com.inductiveautomation.ignition.examples.gn.intent;
+
+import java.util.Map;
+import java.util.concurrent.CompletableFuture;
+
+import com.google.common.collect.Maps;
+import com.inductiveautomation.metro.api.DiagnosticIdentifier;
+import com.inductiveautomation.metro.api.Intent;
+import com.inductiveautomation.metro.api.IntentInfo;
+import com.inductiveautomation.metro.api.ServerId;
+import com.inductiveautomation.metro.impl.codecs.SimpleStreamAwareObject;
+import org.apache.log4j.Logger;
+
+@IntentInfo(system = "GatewayNetworkExample", task = "handleLogFile",
+    description = "Handles a log file streamed over the Gateway Network")
+public class HandleLogFileIntent implements Intent<SimpleStreamAwareObject, Void> {
+    public static final String NAME = "handle_log_file";
+    private final Map<Integer, CompletableFuture<String>> futuresMap = Maps.newConcurrentMap();
+    private final Logger logger = Logger.getLogger("HandleLogFileIntent");
+
+    @Override
+    public String getName() {
+        return NAME;
+    }
+
+    @Override
+    public Void receive(ServerId sourceServerAddr, SimpleStreamAwareObject sso) throws Exception {
+        String localFilePath = sso.getFilePath();
+        String localFileName = sso.getFileName();
+        int downloadId = sso.getDownloadId();
+
+        // Grab the future from the map and return the local file path of the streamed file
+        CompletableFuture<String> future = futuresMap.remove(downloadId);
+
+        if (future == null) {
+            logger.error(String.format("No future found for download for file '%s' downloaded to '%s' from server '%s'",
+                localFileName,
+                localFilePath,
+                sourceServerAddr.toDescriptiveString()));
+        } else {
+            future.complete(localFilePath);
+        }
+
+        return null;
+    }
+
+    public void addPendingFuture(Integer downloadId, CompletableFuture<String> future) {
+        futuresMap.put(downloadId, future);
+    }
+
+    public void removePendingFuture(Integer downloadId) {
+        futuresMap.remove(downloadId);
+    }
+}

gateway-network-function/gateway-network-function-gateway/src/main/java/com/inductiveautomation/ignition/examples/gn/service/GetLogsServiceImpl.java

@@ -7,12 +7,12 @@
 import java.util.Date;
 import java.util.List;
 
-import com.inductiveautomation.eam.gateway.intents.ReceiveDownloadIntent;
 import com.inductiveautomation.ignition.common.logging.LogEvent;
 import com.inductiveautomation.ignition.common.logging.LogQueryConfig;
 import com.inductiveautomation.ignition.common.logging.LogQueryConfig.LogQueryConfigBuilder;
 import com.inductiveautomation.ignition.common.logging.LogResults;
 import com.inductiveautomation.ignition.examples.gn.GatewayHook;
+import com.inductiveautomation.ignition.examples.gn.intent.HandleLogFileIntent;
 import com.inductiveautomation.ignition.gateway.model.GatewayContext;
 import com.inductiveautomation.metro.api.Message;
 import com.inductiveautomation.metro.api.MessageQueue;
@@ -85,7 +85,7 @@ public String requestLogFile(ServerId requestingServer, int downloadId) {
             MessageQueue queue = server.getQueue(ServerInterface.DIAGNOSTIC_INFO_QUEUE_ID).orElse(server);
 
             // This is already a response, so we use a post operation, which itself does not check for a response.
-            queue.post(Message.buildWithDiagnosticMsg(ReceiveDownloadIntent.NAME, ReceiveDownloadIntent.class, sso));
+            queue.post(Message.buildWithDiagnosticMsg(HandleLogFileIntent.NAME, HandleLogFileIntent.class, sso));
             return SUCCESS_MSG;
         }
     }