Merge pull request #1608 from telefonicaid/task/add_express_limit_body

allow change default express limit

CHANGES_NEXT_RELEASE

@@ -0,0 +1 @@
+- Fix: default express limit to 1Mb instead default 100Kb and allow change it throught a conf env var 'IOTA_EXPRESS_LIMIT' (telefonicaid/iotagent-json#827)

config.js

@@ -76,7 +76,8 @@ var config = {
     subservice: '/gardens',
     providerUrl: 'http://192.168.56.1:4041',
     deviceRegistrationDuration: 'P1M',
-    defaultType: 'Thing'
+    defaultType: 'Thing',
+    expressLimit: '1Mb'
 };
 
 module.exports = config;

doc/admin.md

@@ -260,13 +260,13 @@ the `mongob` section (as described bellow). E.g.:
 
 It configures the MongoDB driver for those repositories with 'mongodb' type. If the `host` parameter is a list of
 comma-separated IPs, they will be considered to be part of a Replica Set. In that case, the optional property
-`replicaSet` should contain the Replica Set name. If the database requires authentication, username (`user`),
-password (`password`) and authSource (`authSource`) can be set. If the database requires TLS/SSL connection but any
-validation of the certificate chain is not mandatory, all you need is to set the ssl (`ssl`) option as `true` to connect
-the database. If you need to add more complex option(s) such as `retryWrites=true` or `w=majority` when connection
-database, extraArgs (`extraArgs`) can be used to perform it. For The MongoBD driver will retry the connection at startup
-time `retries` times, waiting `retryTime` seconds between attempts, if those attributes are present (default values are
-5 and 5 respectively). E.g.:
+`replicaSet` should contain the Replica Set name. If the database requires authentication, username (`user`), password
+(`password`) and authSource (`authSource`) can be set. If the database requires TLS/SSL connection but any validation of
+the certificate chain is not mandatory, all you need is to set the ssl (`ssl`) option as `true` to connect the database.
+If you need to add more complex option(s) such as `retryWrites=true` or `w=majority` when connection database, extraArgs
+(`extraArgs`) can be used to perform it. For The MongoBD driver will retry the connection at startup time `retries`
+times, waiting `retryTime` seconds between attempts, if those attributes are present (default values are 5 and 5
+respectively). E.g.:
 
 ```javascript
 {
@@ -421,6 +421,14 @@ characters (such as semi-colons) which are
 specification. When provisioning devices, it is necessary that the developer provides valid `objectId`-`name` mappings
 whenever relaxed mode is used, to prevent the consumption of forbidden characters.
 
+#### `expressLimit`
+
+IotAgents, as all Express applications that use the body-parser middleware, have a default limit to the request body
+size that the application will handle. This default limit for ioiotagnets are 1Mb. So, if your IotAgent receives a
+request with a body that exceeds this limit, the application will throw a “Error: Request entity too large”.
+
+The 1Mb default can be changed setting the `expressLimit` configuration parameter (or equivalente `IOTA_EXPRESS_LIMIT` environment variable).
+
 ### Configuration using environment variables
 
 Some of the configuration parameters can be overriden with environment variables, to ease the use of those parameters
@@ -482,6 +490,7 @@ overrides.
 | IOTA_EXPLICIT_ATTRS                  | `explicitAttrs`                 |
 | IOTA_DEFAULT_ENTITY_NAME_CONJUNCTION | `defaultEntityNameConjunction`  |
 | IOTA_RELAX_TEMPLATE_VALIDATION       | `relaxTemplateValidation`       |
+| IOTA_EXPRESS_LIMIT                   | `expressLimit`                  |
 
 Note:
 

lib/commonConfig.js

@@ -156,7 +156,8 @@ function processEnvironmentVariables() {
         'IOTA_FALLBACK_TENANT',
         'IOTA_FALLBACK_PATH',
         'IOTA_LD_SUPPORT_NULL',
-        'IOTA_LD_SUPPORT_DATASET_ID'
+        'IOTA_LD_SUPPORT_DATASET_ID',
+        'IOTA_EXPRESS_LIMIT'
     ];
     const iotamVariables = [
         'IOTA_IOTAM_URL',
@@ -468,6 +469,11 @@ function processEnvironmentVariables() {
             ? config.defaultEntityNameConjunction
             : ':';
     }
+    if (process.env.IOTA_EXPRESS_LIMIT) {
+        config.expressLimit = process.env.IOTA_EXPRESS_LIMIT;
+    } else {
+        config.expressLimit = config.expressLimit ? config.expressLimit : '1mb';
+    }
 }
 
 function setConfig(newConfig) {

lib/services/northBound/northboundServer.js

@@ -56,8 +56,8 @@ function start(config, callback) {
     northboundServer.app.set('port', config.server.port);
     northboundServer.app.set('host', config.server.host || '0.0.0.0');
     northboundServer.app.use(domainUtils.requestDomain);
-    northboundServer.app.use(bodyParser.json());
-    northboundServer.app.use(bodyParser.json({ type: 'application/*+json' }));
+    northboundServer.app.use(bodyParser.json({ limit: config.expressLimit }));
+    northboundServer.app.use(bodyParser.json({ type: 'application/*+json', limit: config.expressLimit }));
 
     if (config.logLevel && config.logLevel === 'DEBUG') {
         northboundServer.app.use(middlewares.traceRequest);