Add initial ServiceRuntime for Dynamic Services [ECR-3404] (#1065)

Adds initial implementation of ServiceRuntime operations for dynamic services.

The code in dependent on core modules has not been migrated as the ServiceRuntime interface is not finalized yet, neither are the user-facing interfaces (like Service, Transaction, etc.).

Author: dmitry-timofeev

exonum-java-binding/core/checkstyle-suppressions.xml

@@ -24,4 +24,7 @@
 
     <!-- Suppress indentation as there is a bug with lambdas -->
     <suppress files="UserServiceAdapter.java" checks="Indentation"/>
+
+    <!-- Allow constant names in inner classes (they can't have static final members) -->
+    <suppress files="ServiceRuntimeIntegrationTest\.java" checks="(AbbreviationAsWordInName)|(MemberName)"/>
 </suppressions>

exonum-java-binding/core/findbugs-exclude.xml

@@ -12,6 +12,14 @@
     <Bug pattern="NP_PARAMETER_MUST_BE_NONNULL_BUT_MARKED_AS_NULLABLE"/>
   </Match>
 
+  <!-- Use \n in the message that might be recorded in the blockchain instead of %n, which
+       is resolved to a platform-dependent value. -->
+  <Match>
+    <Class name="~.*ServiceWrapper"/>
+    <Method name="executeTransaction"/>
+    <Bug pattern="VA_FORMAT_STRING_USES_NEWLINE"/>
+  </Match>
+
   <!-- Exclude the auto-generated files.
        Remove the rules below once https://github.com/spotbugs/spotbugs/issues/694 is resolved. -->
 
@@ -27,7 +35,11 @@
     <Bug pattern="RV_RETURN_VALUE_IGNORED"/>
   </Match>
 
+  <!--  Auto-generated Protobuf-messages -->
   <Match>
     <Source name="~.*CoreProtos\.java"/>
   </Match>
+  <Match>
+    <Source name="~.*ServiceRuntimeProtos\.java"/>
+  </Match>
 </FindBugsFilter>

exonum-java-binding/core/rust/src/utils/jni_cache.rs

@@ -37,6 +37,7 @@ static mut OBJECT_GET_CLASS: Option<JMethodID> = None;
 static mut CLASS_GET_NAME: Option<JMethodID> = None;
 static mut THROWABLE_GET_MESSAGE: Option<JMethodID> = None;
 
+// todo: Remove transaction and service adapter items when native JavaServiceRuntime is implemented
 static mut TRANSACTION_ADAPTER_EXECUTE: Option<JMethodID> = None;
 static mut TRANSACTION_ADAPTER_INFO: Option<JMethodID> = None;
 
@@ -76,30 +77,6 @@ unsafe fn cache_methods(env: &JNIEnv) {
         "getMessage",
         "()Ljava/lang/String;",
     );
-    TRANSACTION_ADAPTER_EXECUTE = get_method_id(
-        &env,
-        "com/exonum/binding/core/service/adapters/UserTransactionAdapter",
-        "execute",
-        "(J[B[B)V",
-    );
-    TRANSACTION_ADAPTER_INFO = get_method_id(
-        &env,
-        "com/exonum/binding/core/service/adapters/UserTransactionAdapter",
-        "info",
-        "()Ljava/lang/String;",
-    );
-    SERVICE_ADAPTER_STATE_HASHES = get_method_id(
-        &env,
-        "com/exonum/binding/core/service/adapters/UserServiceAdapter",
-        "getStateHashes",
-        "(J)[[B",
-    );
-    SERVICE_ADAPTER_CONVERT_TRANSACTION = get_method_id(
-        &env,
-        "com/exonum/binding/core/service/adapters/UserServiceAdapter",
-        "convertTransaction",
-        "(S[B)Lcom/exonum/binding/core/service/adapters/UserTransactionAdapter;",
-    );
     JAVA_LANG_ERROR = env
         .new_global_ref(env.find_class("java/lang/Error").unwrap().into())
         .ok();
@@ -118,10 +95,6 @@ unsafe fn cache_methods(env: &JNIEnv) {
         OBJECT_GET_CLASS.is_some()
             && JAVA_LANG_ERROR.is_some()
             && THROWABLE_GET_MESSAGE.is_some()
-            && TRANSACTION_ADAPTER_EXECUTE.is_some()
-            && TRANSACTION_ADAPTER_INFO.is_some()
-            && SERVICE_ADAPTER_STATE_HASHES.is_some()
-            && SERVICE_ADAPTER_CONVERT_TRANSACTION.is_some()
             && JAVA_LANG_ERROR.is_some()
             && JAVA_LANG_RUNTIME_EXCEPTION.is_some()
             && TRANSACTION_EXECUTION_EXCEPTION.is_some(),

exonum-java-binding/core/src/main/java/com/exonum/binding/core/runtime/FrameworkModule.java

@@ -18,8 +18,6 @@
 
 import static com.google.inject.name.Names.named;
 
-import com.exonum.binding.core.service.adapters.ViewFactory;
-import com.exonum.binding.core.service.adapters.ViewProxyFactory;
 import com.exonum.binding.core.transport.Server;
 import com.google.common.collect.ImmutableMap;
 import com.google.inject.AbstractModule;

exonum-java-binding/core/src/main/java/com/exonum/binding/core/runtime/GuiceServicesFactory.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright 2019 The Exonum Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.exonum.binding.core.runtime;
+
+import com.exonum.binding.core.service.ServiceModule;
+import com.google.inject.Inject;
+import com.google.inject.Injector;
+import com.google.inject.Module;
+import java.util.function.Supplier;
+
+/**
+ * The default service factory. Although the naming choice might imply non-Guice factories
+ * are possible, it is not true — see the {@link ServicesFactory} javadoc.
+ */
+final class GuiceServicesFactory implements ServicesFactory {
+
+  private final Injector frameworkInjector;
+
+  /**
+   * Creates a new factory of services with the given framework injector.
+   *
+   * @param frameworkInjector the framework injector providing system-wide bindings to services
+   */
+  @Inject
+  GuiceServicesFactory(Injector frameworkInjector) {
+    this.frameworkInjector = frameworkInjector;
+  }
+
+  @Override
+  public ServiceWrapper createService(LoadedServiceDefinition definition,
+      ServiceInstanceSpec instanceSpec) {
+    // Take the user-supplied module configuring service bindings
+    Supplier<ServiceModule> serviceModuleSupplier = definition.getModuleSupplier();
+    Module serviceModule = serviceModuleSupplier.get();
+    // Create a framework-supplied module with per-service bindings
+    Module serviceFrameworkModule = new ServiceFrameworkModule(instanceSpec);
+    // Create a new service
+    // todo: [ECR-3433] Reconsider the relationships between the framework injector and the child.
+    //   Currently the child injector sees everything from the parent, but it does not
+    //   seem to need that, the service needs only a well-defined subset of dependencies.
+    Injector serviceInjector = frameworkInjector.createChildInjector(serviceModule,
+        serviceFrameworkModule);
+    return serviceInjector.getInstance(ServiceWrapper.class);
+  }
+}

exonum-java-binding/core/src/main/java/com/exonum/binding/core/runtime/LoadedServiceDefinition.java

@@ -29,9 +29,9 @@
 abstract class LoadedServiceDefinition {
 
   /**
-   * Returns the unique identifier of the service.
+   * Returns the unique identifier of the service artifact.
    */
-  public abstract ServiceId getId();
+  public abstract ServiceArtifactId getId();
 
   /**
    * Returns a supplier of {@linkplain ServiceModule service modules} configuring their bindings.
@@ -40,8 +40,8 @@ abstract class LoadedServiceDefinition {
    */
   public abstract Supplier<ServiceModule> getModuleSupplier();
 
-  static LoadedServiceDefinition newInstance(ServiceId serviceId,
+  static LoadedServiceDefinition newInstance(ServiceArtifactId artifactId,
       Supplier<ServiceModule> serviceModuleSupplier) {
-    return new AutoValue_LoadedServiceDefinition(serviceId, serviceModuleSupplier);
+    return new AutoValue_LoadedServiceDefinition(artifactId, serviceModuleSupplier);
   }
 }

exonum-java-binding/core/src/main/java/com/exonum/binding/core/runtime/Pf4jServiceLoader.java

@@ -43,14 +43,14 @@
  */
 final class Pf4jServiceLoader implements ServiceLoader {
 
-  private static final Comparator<ServiceId> SERVICE_ID_COMPARATOR =
-      Comparator.comparing(ServiceId::getGroupId)
-          .thenComparing(ServiceId::getArtifactId)
-          .thenComparing(ServiceId::getVersion);
+  private static final Comparator<ServiceArtifactId> SERVICE_ID_COMPARATOR =
+      Comparator.comparing(ServiceArtifactId::getGroupId)
+          .thenComparing(ServiceArtifactId::getArtifactId)
+          .thenComparing(ServiceArtifactId::getVersion);
 
   private final PluginManager pluginManager;
   private final ClassLoadingScopeChecker classLoadingChecker;
-  private final SortedMap<ServiceId, LoadedServiceDefinition> loadedServices;
+  private final SortedMap<ServiceArtifactId, LoadedServiceDefinition> loadedServices;
 
   @Inject
   Pf4jServiceLoader(PluginManager pluginManager, ClassLoadingScopeChecker classLoadingChecker) {
@@ -116,19 +116,20 @@ private void startPlugin(String pluginId) throws ServiceLoadingException {
 
   /** Loads the service definition from the already loaded plugin with the given id. */
   private LoadedServiceDefinition loadDefinition(String pluginId) throws ServiceLoadingException {
-    ServiceId serviceId = extractServiceId(pluginId);
+    ServiceArtifactId artifactId = extractServiceId(pluginId);
     Supplier<ServiceModule> serviceModuleSupplier = findServiceModuleSupplier(pluginId);
     LoadedServiceDefinition serviceDefinition =
-        LoadedServiceDefinition.newInstance(serviceId, serviceModuleSupplier);
+        LoadedServiceDefinition.newInstance(artifactId, serviceModuleSupplier);
 
-    assert !loadedServices.containsKey(serviceId);
-    loadedServices.put(serviceId, serviceDefinition);
+    assert !loadedServices.containsKey(artifactId);
+    loadedServices.put(artifactId, serviceDefinition);
     return serviceDefinition;
   }
 
-  private static ServiceId extractServiceId(String pluginId) throws ServiceLoadingException {
+  private static ServiceArtifactId extractServiceId(String pluginId)
+      throws ServiceLoadingException {
     try {
-      return ServiceId.parseFrom(pluginId);
+      return ServiceArtifactId.parseFrom(pluginId);
     } catch (IllegalArgumentException e) {
       throw new ServiceLoadingException(
           String.format("Invalid plugin id (%s) is specified in service artifact metadata, "
@@ -178,22 +179,22 @@ private void unloadPlugin(String pluginId) {
   }
 
   @Override
-  public Optional<LoadedServiceDefinition> findService(ServiceId serviceId) {
-    return Optional.ofNullable(loadedServices.get(serviceId));
+  public Optional<LoadedServiceDefinition> findService(ServiceArtifactId artifactId) {
+    return Optional.ofNullable(loadedServices.get(artifactId));
   }
 
   @Override
-  public void unloadService(ServiceId serviceId) {
-    checkArgument(loadedServices.containsKey(serviceId), "No such serviceId: %s", serviceId);
+  public void unloadService(ServiceArtifactId artifactId) {
+    checkArgument(loadedServices.containsKey(artifactId), "No such artifactId: %s", artifactId);
 
-    String pluginId = serviceId.toString();
+    String pluginId = artifactId.toString();
     try {
       boolean stopped = pluginManager.unloadPlugin(pluginId);
       // The docs don't say why it may fail to stop the plugin.
       // Follow: https://github.com/pf4j/pf4j/issues/291
       checkState(stopped, "Unknown error whilst unloading the plugin (%s)", pluginId);
     } finally {
-      loadedServices.remove(serviceId);
+      loadedServices.remove(artifactId);
     }
   }
 

exonum-java-binding/core/src/main/java/com/exonum/binding/core/runtime/ServiceId.java renamed to exonum-java-binding/core/src/main/java/com/exonum/binding/core/runtime/ServiceArtifactId.java

@@ -29,7 +29,7 @@
  * <p>The extensions of this class must be immutable and hence thread-safe.
  */
 @AutoValue
-public abstract class ServiceId {
+public abstract class ServiceArtifactId {
 
   private static final String DELIMITER = ":";
   private static final Pattern FORBIDDEN_CHARS_PATTERN = Pattern.compile("[\\s:]");
@@ -53,15 +53,16 @@ public abstract class ServiceId {
   /**
    * Parses a service id in format "groupId:artifactId:version" as {@link #toString()} produces.
    *
-   * @param serviceId a string in format "groupId:artifactId:version". Whitespace characters,
-   *     including preceding and trailing, are not allowed
-   * @return a ServiceId with the given coordinates
+   * @param serviceArtifactId a string in format "groupId:artifactId:version". Whitespace
+   *     characters, including preceding and trailing, are not allowed
+   * @return a ServiceArtifactId with the given coordinates
    * @throws IllegalArgumentException if the format is not correct
    */
-  public static ServiceId parseFrom(String serviceId) {
-    String[] coordinates = serviceId.split(DELIMITER, KEEP_EMPTY);
+  public static ServiceArtifactId parseFrom(String serviceArtifactId) {
+    String[] coordinates = serviceArtifactId.split(DELIMITER, KEEP_EMPTY);
     checkArgument(coordinates.length == 3,
-        "Invalid serviceId (%s), must have 'groupId:artifactId:version' format", serviceId);
+        "Invalid serviceArtifactId (%s), must have 'groupId:artifactId:version' format",
+        serviceArtifactId);
     String groupId = coordinates[0];
     String artifactId = coordinates[1];
     String version = coordinates[2];
@@ -74,8 +75,8 @@ public static ServiceId parseFrom(String serviceId) {
    * @throws IllegalArgumentException if any coordinate contains forbidden characters: whitespace,
    *     colon
    */
-  public static ServiceId of(String groupId, String artifactId, String version) {
-    return new AutoValue_ServiceId(checkNoForbiddenChars(groupId),
+  public static ServiceArtifactId of(String groupId, String artifactId, String version) {
+    return new AutoValue_ServiceArtifactId(checkNoForbiddenChars(groupId),
         checkNoForbiddenChars(artifactId),
         checkNoForbiddenChars(version));
   }

exonum-java-binding/core/src/main/java/com/exonum/binding/core/runtime/ServiceFrameworkModule.java

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2019 The Exonum Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.exonum.binding.core.runtime;
+
+import com.google.inject.AbstractModule;
+
+/**
+ * A framework module providing per-service bindings. These bindings are supplied
+ * by the framework.
+ */
+class ServiceFrameworkModule extends AbstractModule {
+
+  private final ServiceInstanceSpec instanceSpec;
+
+  ServiceFrameworkModule(ServiceInstanceSpec instanceSpec) {
+    this.instanceSpec = instanceSpec;
+  }
+
+  @Override
+  protected void configure() {
+    // todo: consider named bindings for the name and id — they will require publicly
+    //   accessible key names.
+    bind(ServiceInstanceSpec.class).toInstance(instanceSpec);
+  }
+}

exonum-java-binding/core/src/main/java/com/exonum/binding/core/runtime/ServiceInstanceSpec.java

@@ -0,0 +1,51 @@
+/*
+ * Copyright 2019 The Exonum Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.exonum.binding.core.runtime;
+
+import com.exonum.binding.common.message.TransactionMessage;
+import com.google.auto.value.AutoValue;
+
+/**
+ * A specification of a service instance.
+ */
+@AutoValue
+public abstract class ServiceInstanceSpec {
+
+  /**
+   * Returns the name of the service instance. It serves as the primary identifier of this service
+   * in most operations. It is assigned by the network administrators.
+   */
+  public abstract String getName();
+
+  /**
+   * Returns the numeric id of the service instance. Exonum assigns it to the service
+   * on instantiation. It is mainly used to route the transaction messages belonging
+   * to this instance.
+   *
+   * @see TransactionMessage#getServiceId()
+   */
+  public abstract int getId();
+
+  /**
+   * Returns the service artifact id.
+   */
+  public abstract ServiceArtifactId getArtifactId();
+
+  public static ServiceInstanceSpec newInstance(String name, int id, ServiceArtifactId artifactId) {
+    return new AutoValue_ServiceInstanceSpec(name, id, artifactId);
+  }
+}