Merge pull request #161 from jt-nti/187-message-size-2.2

[FABCJ-187] Add max inbound msg size configuration

Author: mbwhite

fabric-chaincode-integration-test/src/contracts/fabric-chaincode-example-sacc/src/main/java/org/hyperledger/fabric/example/AllAPI.java

@@ -6,8 +6,8 @@
 import org.hyperledger.fabric.contract.Context;
 import org.hyperledger.fabric.contract.ContractInterface;
 import org.hyperledger.fabric.contract.annotation.*;
-
-
+import org.hyperledger.fabric.metrics.Metrics;
+import org.hyperledger.fabric.metrics.MetricsProvider;
 import org.hyperledger.fabric.shim.ledger.*;
 import org.hyperledger.fabric.shim.*;
 import java.util.*;
@@ -95,5 +95,12 @@ public String getByRangePaged(Context ctx, String start, String end, int pageSiz
         System.out.println("getByRangePaged<<");
         return newbookmark;
     }
+    
+    @Transaction()
+    public String getMetricsProviderName(Context ctx){
+        final MetricsProvider provider = Metrics.getProvider();
+        final String name = provider.getClass().getName();
+        return name;
+    }
 
 }

fabric-chaincode-integration-test/src/contracts/fabric-chaincode-example-sacc/src/main/resources/config.props

@@ -0,0 +1,6 @@
+MAX_INBOUND_MESSAGE_SIZE=4000
+CHAINCODE_METRICS_ENABLED=true
+TP_CORE_POOL_SIZE=4
+TP_MAX_POOL_SIZE=4
+TP_QUEUE_SIZE=4000
+ 

fabric-chaincode-integration-test/src/test/java/org/hyperleder/fabric/shim/integration/SACCIntegrationTest.java

@@ -75,6 +75,9 @@ public void TestQuery(){
         System.out.println(text);
         assertThat(text, containsString("key130"));
 
+        text = invoke(new String[]{"getMetricsProviderName"});
+        System.out.println(text);
+        assertThat(text, containsString("org.hyperledger.fabric.metrics.impl.DefaultProvider"));
     }
 
 }

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/contract/ContractRouter.java

@@ -55,11 +55,11 @@ public ContractRouter(final String[] args) {
         super.initializeLogging();
         super.processEnvironmentOptions();
         super.processCommandLineOptions(args);
+        super.validateOptions();
 
         final Properties props = super.getChaincodeConfig();
         Metrics.initialize(props);
 
-        super.validateOptions();
         logger.fine("ContractRouter<init>");
         registry = new RoutingRegistryImpl();
         typeRegistry = TypeRegistry.getRegistry();

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/metrics/package-info.java

@@ -11,33 +11,15 @@
  * The main metrics that are available are the statistics around the number of
  * tasks that are running, and how the thread pool is handling these.
  *
+ * <p>
  * Note a 'task' is a message from the Peer to the Chaincode - this message is
  * either a new transaction, or a response from a stub API, eg getState(). Query
  * apis may return more than one response.
  *
- * To enable metrics ensure that there is a standard format Java properties file
- * called `config.props` in the root of your contract code. For example this
- * path
- *
- * <pre>
- * myjava - contract - project / java / src / main / resources / config.props
- * </pre>
- *
- * This should contain the following
- *
- * <pre>
- * CHAINCODE_METRICS_ENABLED=true
- * TP_CORE_POOL_SIZE=5
- * TP_MAX_POOL_SIZE=5
- * TP_QUEUE_SIZE=5000
- * </pre>
- *
- * The metrics enabled flag will turn on default metrics logging. (it's off by
- * default) The TP values establish the core thread pool size, max thread
- * poolsize, and the number of of tasks that will wait. (5, 5, 5000 are the
- * default values, so don't need to be explicitly specified).
- *
- * If no file is supplied metrics are not enabled, the values shown for the
- * thread pool are used.
+ * <p>
+ * To enable metrics, add a <code>CHAINCODE_METRICS_ENABLED=true</code> setting
+ * to the <code>config.props</code> chaincode configuration file.
+ * See the <a href="../../../../index.html">Overview</a> for details of how to
+ * configure chaincode.
  */
 package org.hyperledger.fabric.metrics;

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/overview.html

@@ -7,5 +7,29 @@
     <p>The Fabric programming model is described in the <a href="https://hyperledger-fabric.readthedocs.io/en/release-2.2/developapps/developing_applications.html">Developing Applications</a> chapter of the Hyperledger Fabric documentation.</p>
 
     <p>All Contracts should implement {@link org.hyperledger.fabric.contract.ContractInterface} interface, in addition to the {@link org.hyperledger.fabric.contract.annotation.Contract} annotation.</p>
+
+    <h2>Configuration</h2>
+
+    <p>
+      Some Java chaincode settings are configurable on a per chaincode basis, including the maximum gRPC inbound message size, thread pool settings, and whether to enable chaincode metrics.
+      The default settings are as follows:
+    </p>
+
+    <pre>
+      MAX_INBOUND_MESSAGE_SIZE=104857600
+      CHAINCODE_METRICS_ENABLED=false
+      TP_CORE_POOL_SIZE=5
+      TP_MAX_POOL_SIZE=5
+      TP_QUEUE_SIZE=5000
+    </pre>
+
+    <p>
+      To override the defaults, a <code>config.props</code> Java properties file must be included in the default, unnamed, package on your contract code's classpath, which will then be loaded when the chaincode starts.
+      Setting the metrics enabled flag to <code>true</code> will turn on default metrics logging. The <code>TP_</code> values establish the core thread pool size, max thread poolsize, and the number of of tasks that will wait.
+    </p>
+
+    <p>
+      If you are building your chaincode using Gradle or Maven, create a <code>config.props</code> file in the <code>src/main/resources</code> directory and include the settings you want to override.
+    </p>
   </body>
 </html>

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/shim/ChaincodeBase.java

@@ -23,9 +23,6 @@
 import java.util.logging.Logger;
 import java.util.logging.SimpleFormatter;
 
-import com.google.protobuf.InvalidProtocolBufferException;
-import com.google.protobuf.util.JsonFormat;
-
 import org.apache.commons.cli.CommandLine;
 import org.apache.commons.cli.DefaultParser;
 import org.apache.commons.cli.Options;
@@ -38,6 +35,9 @@
 import org.hyperledger.fabric.shim.impl.ChaincodeSupportClient;
 import org.hyperledger.fabric.shim.impl.InvocationTaskManager;
 
+import com.google.protobuf.InvalidProtocolBufferException;
+import com.google.protobuf.util.JsonFormat;
+
 import io.grpc.ManagedChannelBuilder;
 import io.grpc.netty.shaded.io.grpc.netty.GrpcSslContexts;
 import io.grpc.netty.shaded.io.grpc.netty.NegotiationType;
@@ -83,6 +83,11 @@ public abstract class ChaincodeBase implements Chaincode {
      */
     public static final int DEFAULT_PORT = 7051;
 
+    /**
+     * Default to 100MB for maximum inbound grpc message size.
+     */
+    public static final String DEFAULT_MAX_INBOUND_MESSAGE_SIZE = "104857600";
+
     private String host = DEFAULT_HOST;
     private int port = DEFAULT_PORT;
     private boolean tlsEnabled = false;
@@ -100,13 +105,24 @@ public abstract class ChaincodeBase implements Chaincode {
     private static final String ENV_TLS_CLIENT_KEY_PATH = "CORE_TLS_CLIENT_KEY_PATH";
     private static final String ENV_TLS_CLIENT_CERT_PATH = "CORE_TLS_CLIENT_CERT_PATH";
     private static final String CORE_PEER_LOCALMSPID = "CORE_PEER_LOCALMSPID";
+    private static final String MAX_INBOUND_MESSAGE_SIZE = "MAX_INBOUND_MESSAGE_SIZE";
     private Properties props;
     private Level logLevel;
 
     static {
         Security.addProvider(new BouncyCastleProvider());
     }
 
+    private int getMaxInboundMessageSize() {
+        if (this.props == null) {
+            throw new IllegalStateException("Chaincode config not available");
+        }
+        final int maxMsgSize = Integer.parseInt(this.props.getProperty(MAX_INBOUND_MESSAGE_SIZE, DEFAULT_MAX_INBOUND_MESSAGE_SIZE));
+        final String msgSizeInfo = String.format("Maximum Inbound Message Size [%s] = %d", MAX_INBOUND_MESSAGE_SIZE, maxMsgSize);
+        LOGGER.info(msgSizeInfo);
+        return maxMsgSize;
+    }
+
     /**
      * Start chaincode.
      *
@@ -115,13 +131,13 @@ public abstract class ChaincodeBase implements Chaincode {
 
     public void start(final String[] args) {
         try {
+            initializeLogging();
             processEnvironmentOptions();
             processCommandLineOptions(args);
-            initializeLogging();
+            validateOptions();
 
             final Properties props = getChaincodeConfig();
             Metrics.initialize(props);
-            validateOptions();
             connectToPeer();
         } catch (final Exception e) {
             LOGGER.severe(() -> "Chaincode could not start" + Logging.formatError(e));
@@ -356,6 +372,8 @@ final ManagedChannelBuilder<?> newChannelBuilder() throws IOException {
         final NettyChannelBuilder builder = NettyChannelBuilder.forAddress(host, port);
         LOGGER.info("Configuring channel connection to peer.");
 
+        builder.maxInboundMessageSize(getMaxInboundMessageSize());
+
         if (tlsEnabled) {
             builder.negotiationType(NegotiationType.TLS);
             builder.sslContext(createSSLContext());

fabric-chaincode-shim/src/test/java/org/hyperledger/fabric/contract/ContractRouterTest.java

@@ -10,6 +10,7 @@
 import static org.hamcrest.Matchers.is;
 import static org.hamcrest.Matchers.notNullValue;
 import static org.hamcrest.Matchers.nullValue;
+import static org.hamcrest.core.StringContains.containsString;
 import static org.junit.Assert.assertThat;
 
 import java.util.ArrayList;
@@ -30,6 +31,16 @@ public class ContractRouterTest {
     @Rule
     public ExpectedException thrown = ExpectedException.none();
 
+    @Test
+    public void testCreateFailsWithoutValidOptions() {
+        thrown.expect(IllegalArgumentException.class);
+        thrown.expectMessage(containsString(
+            "The chaincode id must be specified using either the -i or --i command line options or the CORE_CHAINCODE_ID_NAME environment variable."));
+
+        @SuppressWarnings("unused")
+        final ContractRouter r = new ContractRouter(new String[] {});
+    }
+
     @Test
     public void testCreateAndScan() {
         final ContractRouter r = new ContractRouter(new String[] {"-a", "127.0.0.1:7052", "-i", "testId"});

fabric-chaincode-shim/src/test/java/org/hyperledger/fabric/shim/ChaincodeBaseTest.java

@@ -6,15 +6,20 @@
 
 package org.hyperledger.fabric.shim;
 
+import static org.hamcrest.Matchers.not;
+import static org.hamcrest.core.StringContains.containsString;
 import static org.junit.Assert.assertArrayEquals;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertNull;
+import static org.junit.Assert.assertThat;
 import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.fail;
 
 import java.nio.charset.Charset;
+import java.util.logging.Handler;
 import java.util.logging.Level;
+import java.util.logging.LogRecord;
 import java.util.logging.Logger;
 
 import org.hamcrest.Matchers;
@@ -24,6 +29,8 @@
 import org.junit.Test;
 import org.junit.contrib.java.lang.system.EnvironmentVariables;
 import org.junit.rules.ExpectedException;
+import org.mockito.ArgumentCaptor;
+import org.mockito.Mockito;
 
 import io.grpc.ManagedChannelBuilder;
 
@@ -245,6 +252,27 @@ public void testInitializeLogging() {
                 Logger.getLogger(cb.getClass().getPackage().getName()).getLevel());
     }
 
+    @Test
+    public void testStartFailsWithoutValidOptions() {
+        final String[] args = new String[0];
+        final ChaincodeBase cb = new EmptyChaincode();
+
+        Handler mockHandler = Mockito.mock(Handler.class);
+        ArgumentCaptor<LogRecord> argumentCaptor = ArgumentCaptor.forClass(LogRecord.class);
+        Logger logger = Logger.getLogger("org.hyperledger.fabric.shim.ChaincodeBase");
+        logger.addHandler(mockHandler);
+
+        cb.start(args);
+
+        Mockito.verify(mockHandler, Mockito.atLeast(1)).publish(argumentCaptor.capture());
+        LogRecord lr = argumentCaptor.getValue();
+        String msg = lr.getMessage();
+
+        assertThat(msg, not(containsString("java.lang.NullPointerException")));
+        assertThat(msg, containsString(
+            "The chaincode id must be specified using either the -i or --i command line options or the CORE_CHAINCODE_ID_NAME environment variable."));
+    }
+
     public static void setLogLevelForChaincode(final EnvironmentVariables environmentVariables, final ChaincodeBase cb, final String shimLevel,
             final String chaincodeLevel) {
         environmentVariables.set(ChaincodeBase.CORE_CHAINCODE_LOGGING_SHIM, shimLevel);