Use random port in JS views for the internal service

Author: miguelalba

de.bund.bfr.knime.fsklab.nodes/js-lib/bfr/fskutil_1.0.0.js

@@ -48,19 +48,19 @@ fskeditorjs = function () {
     }
 
     switch (_metadata.modelType) {
-      case "genericModel": handler = new fskutil.GenericModel(_metadata); break;
-      case "dataModel": handler = new fskutil.DataModel(_metadata); break;
-      case "predictiveModel": handler = new fskutil.PredictiveModel(_metadata); break;
-      case "otherModel": handler = new fskutil.OtherModel(_metadata); break;
-      case "toxicologicalModel": handler = new fskutil.ToxicologicalModel(_metadata); break;
-      case "doseResponseModel": handler = new fskutil.DoseResponseModel(_metadata); break;
-      case "exposureModel": handler = new fskutil.ExposureModel(_metadata); break;
-      case "processModel": handler = new fskutil.ProcessModel(_metadata); break;
-      case "consumptionModel": handler = new fskutil.ConsumptionModel(_metadata); break;
-      case "healthModel": handler = new fskutil.HealthModel(_metadata); break;
-      case "riskModel": handler = new fskutil.RiskModel(_metadata); break;
-      case "qraModel": handler = new fskutil.QraModel(_metadata); break;
-      default: handler = new fskutil.GenericModel(_metadata); break;
+      case "genericModel": handler = new fskutil.GenericModel(_metadata, _rep.servicePort); break;
+      case "dataModel": handler = new fskutil.DataModel(_metadata, _rep.servicePort); break;
+      case "predictiveModel": handler = new fskutil.PredictiveModel(_metadata, _rep.servicePort); break;
+      case "otherModel": handler = new fskutil.OtherModel(_metadata, _rep.servicePort); break;
+      case "toxicologicalModel": handler = new fskutil.ToxicologicalModel(_metadata, _rep.servicePort); break;
+      case "doseResponseModel": handler = new fskutil.DoseResponseModel(_metadata, _rep.servicePort); break;
+      case "exposureModel": handler = new fskutil.ExposureModel(_metadata, _rep.servicePort); break;
+      case "processModel": handler = new fskutil.ProcessModel(_metadata, _rep.servicePort); break;
+      case "consumptionModel": handler = new fskutil.ConsumptionModel(_metadata, _rep.servicePort); break;
+      case "healthModel": handler = new fskutil.HealthModel(_metadata, _rep.servicePort); break;
+      case "riskModel": handler = new fskutil.RiskModel(_metadata, _rep.servicePort); break;
+      case "qraModel": handler = new fskutil.QraModel(_metadata, _rep.servicePort); break;
+      default: handler = new fskutil.GenericModel(_metadata, _rep.servicePort); break;
     }
 
     createUI();

de.bund.bfr.knime.fsklab.nodes/js-src/de/bund/bfr/knime/fsklab/nodes/neweditor/editor.js

@@ -35,7 +35,7 @@
 public class FskPlugin extends AbstractUIPlugin {
 
   private static FskPlugin plugin;
-
+  
   /**
    * Object mapper for 1.0.4 classes generated with Swagger at de.bund.bfr.metadata.swagger
    */
@@ -49,6 +49,8 @@ public class FskPlugin extends AbstractUIPlugin {
   public ObjectMapper OLD_OBJECT_MAPPER;
 
   private Thread service;
+  
+  public FskService fskService;
 
   public FskPlugin() {
     plugin = this;
@@ -75,7 +77,9 @@ public void start(BundleContext context) throws Exception {
 
     OLD_OBJECT_MAPPER = new ObjectMapper().registerModule(new RakipModule());
 
-    service = new Thread(new FskService());
+    fskService = new FskService();
+    
+    service = new Thread(fskService);
     service.setName("FSK-Service");
     service.start();
   }

de.bund.bfr.knime.fsklab.nodes/src/de/bund/bfr/knime/fsklab/FskPlugin.java

@@ -77,7 +77,9 @@ public FSKEditorJSNodeModel() {
 
   @Override
   public FSKEditorJSViewRepresentation createEmptyViewRepresentation() {
-    return new FSKEditorJSViewRepresentation();
+    FSKEditorJSViewRepresentation representation = new FSKEditorJSViewRepresentation();
+    representation.setServicePort(FskPlugin.getDefault().fskService.getPort());
+    return representation;
   }
 
   @Override

de.bund.bfr.knime.fsklab.nodes/src/de/bund/bfr/knime/fsklab/nodes/FSKEditorJSNodeModel.java

@@ -32,17 +32,37 @@ final class FSKEditorJSViewRepresentation extends JSONViewContent {
 
   public final int pseudoIdentifier = (new Random()).nextInt();
 
-  @Override
-  public void saveToNodeSettings(NodeSettingsWO settings) {
+  /**
+   * Port number where FSK-Service is running.
+   * 
+   * <p>
+   * The service port number is to not be saved to settings as it depends on the computer. The same
+   * port cannot be available in the future. So it is assigned during runtime by the node model.
+   * </p>
+   */
+  private int servicePort;
+
+  public FSKEditorJSViewRepresentation() {
+    servicePort = 0;
+  }
+  
+  public int getServicePort() {
+    return servicePort;
+  }
+  
+  public void setServicePort(int servicePort) {
+    this.servicePort = servicePort;
   }
 
   @Override
-  public void loadFromNodeSettings(NodeSettingsRO settings) throws InvalidSettingsException {
-  }
+  public void saveToNodeSettings(NodeSettingsWO settings) {}
+
+  @Override
+  public void loadFromNodeSettings(NodeSettingsRO settings) throws InvalidSettingsException {}
 
   @Override
   public int hashCode() {
-    return pseudoIdentifier;
+    return servicePort;
   }
 
   @Override
@@ -56,6 +76,6 @@ public boolean equals(final Object obj) {
     if (obj.getClass() != getClass()) {
       return false;
     }
-    return true;
+    return servicePort == ((FSKEditorJSViewRepresentation)obj).servicePort;
   }
 }

de.bund.bfr.knime.fsklab.nodes/src/de/bund/bfr/knime/fsklab/nodes/FSKEditorJSViewRepresentation.java

@@ -1,10 +1,10 @@
 package de.bund.bfr.knime.fsklab.service;
 
+import static spark.Spark.awaitInitialization;
 import static spark.Spark.before;
 import static spark.Spark.get;
 import static spark.Spark.options;
 import static spark.Spark.port;
-
 import java.io.File;
 import java.io.IOException;
 import java.net.URI;
@@ -17,17 +17,13 @@
 import java.util.Arrays;
 import java.util.List;
 import java.util.Properties;
-
 import org.apache.commons.io.FileUtils;
 import org.eclipse.core.runtime.FileLocator;
 import org.eclipse.core.runtime.Platform;
-import org.eclipse.jetty.server.Server;
 import org.h2.tools.DeleteDbFiles;
 import org.knime.core.node.NodeLogger;
 import org.osgi.framework.Bundle;
-
 import com.google.gson.Gson;
-
 import de.bund.bfr.rakip.vocabularies.data.AccreditationProcedureRepository;
 import de.bund.bfr.rakip.vocabularies.data.AvailabilityRepository;
 import de.bund.bfr.rakip.vocabularies.data.BasicProcessRepository;
@@ -76,15 +72,11 @@ public class FskService implements Runnable {
   private static final NodeLogger LOGGER = NodeLogger.getLogger(FskService.class);
 
   private static final JsonTransformer jsonTransformer = new JsonTransformer();
-
-  private Server server;
-
-  public FskService() {
-    server = new Server(0);
-  }
+  
+  private int port;
 
   public int getPort() {
-    return server.getURI() != null ? server.getURI().getPort() : -1;
+    return port;
   }
 
   @Override
@@ -111,7 +103,7 @@ public void run() {
       if (accessControlRequestMethod != null) {
         response.header("Access-Control-Allow-Methods", accessControlRequestMethod);
       }
-
+      
       return "OK";
     });
 
@@ -160,6 +152,10 @@ public void run() {
     //
     // return mgr.getFilenames();
     // }, jsonTransformer);
+    
+    // After initializing the service, get the randomly picked port by Spark.
+    awaitInitialization();
+    port = port();
   }
 
   private static class JsonTransformer implements ResponseTransformer {