[STORE] [MODEL] Address performance of HashWrapper in Response objects (elastic#825)

* [STORE] Lazily wrap response in HashWrapper and provide #raw_response access

* [MODEL] Lazily wrap response in HashWrapper and provide #raw_response access

* [MODEL] Opimitize response changes

* [STORE] Opimitize response changes

Author: estolfo

elasticsearch-model/lib/elasticsearch/model/response.rb

@@ -10,8 +10,7 @@ module Response
       # Implements Enumerable and forwards its methods to the {#results} object.
       #
       class Response
-        attr_reader :klass, :search, :response,
-                    :took, :timed_out, :shards
+        attr_reader :klass, :search
 
         include Enumerable
 
@@ -27,9 +26,7 @@ def initialize(klass, search, options={})
         # @return [Hash]
         #
         def response
-          @response ||= begin
-            HashWrapper.new(search.execute!)
-          end
+          @response ||= HashWrapper.new(search.execute!)
         end
 
         # Returns the collection of "hits" from Elasticsearch
@@ -51,31 +48,35 @@ def records(options = {})
         # Returns the "took" time
         #
         def took
-          response['took']
+          raw_response['took']
         end
 
         # Returns whether the response timed out
         #
         def timed_out
-          response['timed_out']
+          raw_response['timed_out']
         end
 
         # Returns the statistics on shards
         #
         def shards
-          HashWrapper.new(response['_shards'])
+          @shards ||= HashWrapper.new(raw_response['_shards'])
         end
 
         # Returns a Hashie::Mash of the aggregations
         #
         def aggregations
-          Aggregations.new(response['aggregations'])
+          @aggregations ||= Aggregations.new(raw_response['aggregations'])
         end
 
         # Returns a Hashie::Mash of the suggestions
         #
         def suggestions
-          Suggestions.new(response['suggest'])
+          @suggestions ||= Suggestions.new(raw_response['suggest'])
+        end
+
+        def raw_response
+          @raw_response ||= search.execute!
         end
       end
     end

elasticsearch-model/lib/elasticsearch/model/response/base.rb

@@ -4,15 +4,16 @@ module Response
       # Common funtionality for classes in the {Elasticsearch::Model::Response} module
       #
       module Base
-        attr_reader :klass, :response
+        attr_reader :klass, :response, :raw_response
 
         # @param klass    [Class] The name of the model class
         # @param response [Hash]  The full response returned from Elasticsearch client
         # @param options  [Hash]  Optional parameters
         #
         def initialize(klass, response, options={})
           @klass     = klass
-          @response  = response
+          @raw_response = response
+          @response = response
         end
 
         # @abstract Implement this method in specific class

elasticsearch-model/test/unit/response_results_test.rb

@@ -27,5 +27,8 @@ def self.document_type; 'bar'; end
       assert_equal 'bar', @results.first.foo
     end
 
+    should "provide access to the raw response" do
+      assert_equal RESPONSE, @response.raw_response
+    end
   end
 end

elasticsearch-persistence/lib/elasticsearch/persistence/repository/response/results.rb

@@ -11,6 +11,7 @@ class Results
           include Enumerable
 
           attr_reader :repository
+          attr_reader :raw_response
 
           # The key for accessing the results in an Elasticsearch query response.
           #
@@ -30,8 +31,8 @@ class Results
           #
           def initialize(repository, response, options={})
             @repository = repository
-            @response   = Elasticsearch::Model::HashWrapper.new(response)
-            @options    = options
+            @raw_response = response
+            @options = options
           end
 
           def method_missing(method_name, *arguments, &block)
@@ -45,25 +46,25 @@ def respond_to?(method_name, include_private = false)
           # The number of total hits for a query
           #
           def total
-            response[HITS][TOTAL]
+            raw_response[HITS][TOTAL]
           end
 
           # The maximum score for a query
           #
           def max_score
-            response[HITS][MAX_SCORE]
+            raw_response[HITS][MAX_SCORE]
           end
 
           # Yields [object, hit] pairs to the block
           #
           def each_with_hit(&block)
-            results.zip(response[HITS][HITS]).each(&block)
+            results.zip(raw_response[HITS][HITS]).each(&block)
           end
 
           # Yields [object, hit] pairs and returns the result
           #
           def map_with_hit(&block)
-            results.zip(response[HITS][HITS]).map(&block)
+            results.zip(raw_response[HITS][HITS]).map(&block)
           end
 
           # Return the collection of domain objects
@@ -76,7 +77,7 @@ def map_with_hit(&block)
           # @return [Array]
           #
           def results
-            @results ||= response[HITS][HITS].map do |document|
+            @results ||= raw_response[HITS][HITS].map do |document|
               repository.deserialize(document.to_hash)
             end
           end
@@ -93,7 +94,7 @@ def results
           # @return [Elasticsearch::Model::HashWrapper]
           #
           def response
-            @response
+            @response ||= Elasticsearch::Model::HashWrapper.new(raw_response)
           end
         end
       end

elasticsearch-persistence/spec/repository/response/results_spec.rb

@@ -66,6 +66,22 @@ def deserialize(document)
     it 'wraps the response in a HashWrapper' do
       expect(results.response._shards.total).to eq(5)
     end
+
+    context 'when the response method is not called' do
+
+      it 'does not create an instance of HashWrapper' do
+        expect(Elasticsearch::Model::HashWrapper).not_to receive(:new)
+        results
+      end
+    end
+
+    context 'when the response method is called' do
+
+      it 'does create an instance of HashWrapper' do
+        expect(Elasticsearch::Model::HashWrapper).to receive(:new)
+        results.response
+      end
+    end
   end
 
   describe '#total' do
@@ -102,4 +118,11 @@ def deserialize(document)
       expect(results.map_with_hit { |pair| pair[0] }).to eq(['Object', 'Object'])
     end
   end
+
+  describe '#raw_response' do
+
+    it 'returns the raw response from Elasticsearch' do
+      expect(results.raw_response).to eq(response)
+    end
+  end
 end