Merge pull request #129 from kfitzgerald/search-using-post

Search Solr using POST instead of GET (configurable auto-switch on request size, disabled by default)
lbdremy · Sep 7, 2015 · 5992eb5 · 5992eb5
2 parents 92470e1 + 85b502b
commit 5992eb5
Show file tree

Hide file tree

Showing 2 changed files with 115 additions and 6 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,4 @@ docs/out
 coverage.html
 lib-cov
 report
+.idea
diff --git a/lib/solr.js b/lib/solr.js
@@ -83,7 +83,8 @@ function Client(options){
       path : options.path || '/solr',
       agent : options.agent,
       secure : options.secure || false,
-      bigint : options.bigint || false
+      bigint : options.bigint || false,
+      get_max_request_entity_size: options.get_max_request_entity_size || false
    };
 
    // Default paths of all request handlers
@@ -571,21 +572,72 @@ Client.prototype.get = function(handler,query,callback){
    }
 
    var fullPath = [this.options.path,this.options.core,handler + '?' + parameters + '&wt=json']
-                              .filter(function(element){
-                                 return element;
-                              })
-                              .join('/');
+         .filter(function(element){
+            return element;
+         })
+         .join('/'),
+       approxUrlLength = 10 + Buffer.byteLength(this.options.host) + (this.options.port+"").length + Buffer.byteLength(fullPath); // Buffer (10) accounts for protocol and special characters like ://, port colon, and initial slash etc
+
+   if (this.options.get_max_request_entity_size === false || approxUrlLength <= this.options.get_max_request_entity_size) {
+      var params = {
+         host: this.options.host,
+         port: this.options.port,
+         fullPath: fullPath,
+         secure: this.options.secure,
+         bigint: this.options.bigint,
+         authorization: this.options.authorization,
+         agent: this.options.agent
+      };
+      return getJSON(params, callback);
+   } else {
+
+      // Funnel this through a POST because it's too large
+      return this.post(handler, query, callback);
+   }
+}
+
+/**
+ * Send an arbitrary HTTP POST request to Solr on the specified `handler` (as Solr like to call it i.e path)
+ *
+ * @param {String} handler
+ * @param {Query|Object|String} [query]
+ * @param {Function} callback(err,obj) - a function executed when the Solr server responds or an error occurs
+ * @param {Error} callback().err
+ * @param {Object} callback().obj - JSON response sent by the Solr server deserialized
+ *
+ * @return {http.ClientRequest}
+ * @api public
+ */
+Client.prototype.post = function(handler,query,callback){
+
+   var parameters = '';
+   if(typeof query === 'function'){
+      callback = query;
+   }else if(query instanceof Query){
+      parameters += query.build();
+   }else if(typeof query === 'object'){
+      parameters += querystring.stringify(query);
+   }else if(typeof query === 'string'){
+      parameters += query;
+   }
+
+   var fullPath = [this.options.path,this.options.core, handler + '?wt=json']
+       .filter(function(element){
+          return element;
+       })
+       .join('/');
 
    var params = {
       host : this.options.host,
       port : this.options.port,
       fullPath : fullPath,
+      params : parameters,
       secure : this.options.secure,
       bigint : this.options.bigint,
       authorization : this.options.authorization,
       agent : this.options.agent
    };
-   return getJSON(params,callback);
+   return postForm(params,callback);
 }
 
 /**
@@ -700,6 +752,62 @@ function postJSON(params,callback){
    return request;
 };
 
+/**
+ * HTTP POST request. Send update commands to the Solr server using form encoding (e.g. search)
+ *
+ * @param {Object} params
+ * @param {String} params.host - IP address or host address of the Solr server
+ * @param {Number|String} params.port - port of the Solr server
+ * @param {String} params.core - name of the Solr core requested
+ * @param {String} params.authorization - value of the authorization header
+ * @param {String} params.fullPath - full path of the request
+ * @param {String} params.params - form params
+ * @param {Boolean} params.secure -
+ * @param {Boolean} params.bigint -
+ * @param {http.Agent} [params.agent] -
+ * @param {Function} callback(err,obj) - a function executed when the Solr server responds or an error occurs
+ * @param {Error} callback().err
+ * @param {Object} callback().obj - JSON response sent by the Solr server deserialized
+ *
+ * @return {http.ClientRequest}
+ * @api private
+ */
+
+function postForm(params,callback){
+   var headers = {
+      'content-type' : 'application/x-www-form-urlencoded; charset=utf-8',
+      'content-length':  Buffer.byteLength(params.params),
+      'accept' : 'application/json; charset=utf-8'
+   };
+   if(params.authorization){
+      headers['authorization'] = params.authorization;
+   }
+   var options = {
+      host : params.host,
+      port : params.port,
+      method : 'POST',
+      headers : headers,
+      path : params.fullPath
+   };
+
+   if(params.agent !== undefined){
+      options.agent = params.agent;
+   }
+
+   var request = pickProtocol(params.secure).request(options);
+
+   request.on('response', handleJSONResponse(request, params.bigint, callback));
+
+   request.on('error',function onError(err){
+      if (callback) callback(err,null);
+   });
+
+   request.write(params.params);
+   request.end();
+
+   return request;
+};
+
 /**
  * HTTP GET request.  Send a query command to the Solr server (query)
  *