fluffle 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5873bf894f32f349386f18661620aabd487dabb9
-  data.tar.gz: 6f832fa861f56d4186a7e260bbed46b0233c7428
+  metadata.gz: e481e4031ed4755adaf94debc3e95cf390669412
+  data.tar.gz: 3df471df73388ccc1dbf7b0bc5e355de381a3e17
 SHA512:
-  metadata.gz: 59bedfeb61ff2766100e3515dbcd75f4f240cb58febb9ceb904e9a696d305e52e894fb6aef61124a852554c09ef0fee202735cb06a85e5548b2c4888ec661446
-  data.tar.gz: 6a9bfdbc4940b1ff64a2536c9c65ed61fd36dde610a0a4cf1b9390a4bf7709f31a626179028df42ce0f3cd82f6111bf2ea7a368067cca6988df313f84a69168e
+  metadata.gz: b46141c7c5f0170e117db9e5bccebe3c92208ecf8c000d2dc393c01cb8c30414e0811e1dcf2c4c75971e91ec1296874d4f34eb6b415c064d190afde2cc7a51c1
+  data.tar.gz: fe1b05b29c37d871006aa9fce70a9367d39cbde3a76f8870b7a01a95d5a64085440d9dfafe558118549857a12918a49f61dccce194ac453be77a7faececb4e87

data/README.md

@@ -22,6 +22,10 @@ Both the client and server implementations should be thread-safe, as their behav
 
 [concurrent-ruby]: https://github.com/ruby-concurrency/concurrent-ruby
 
+**Note**: Fluffle uses JSON-RPC as a transfer format to structure requests and responses. However, due to some of the limitations imposed by AMQP, it cannot implement the complete set of behaviors in the JSON-RPC protocol. The most substantial of these limitations is that [batch requests][] are not supported.
+
+[batch requests]: http://www.jsonrpc.org/specification#batch
+
 ## Examples
 
 See the [`examples`](examples/) directory.
@@ -64,6 +68,28 @@ client.call 'upcase', ['Hello world!']
 # => "HELLO WORLD!"
 ```
 
+## Response meta-data
+
+The server adds an additional `meta` field to the response object with meta-data about how the request was handled. Currently the only entry in the `meta` object is the float `handler_duration` which is duration in seconds that was spent exclusively processing the handler.
+
+```javascript
+// Example successful response with meta-data (6ms spent in handler)
+{
+  "jsonrpc": "2.0",
+  "id": "123",
+  "result": "baz",
+  "meta": {"handler_duration": 0.006}
+}
+
+// Example error response with meta-data
+{
+  "jsonrpc": "2.0",
+  "id": "123",
+  "error": {"code": -32601, "message": "Method not found"},
+  "meta": {"handler_duration": 0.007}
+}
+```
+
 ## License
 
 Released under the MIT license, see [LICENSE](LICENSE) for details.

data/lib/fluffle/server.rb

@@ -79,47 +79,33 @@ module Fluffle
     def handle_request(handler:, properties:, payload:)
       reply_to = properties[:reply_to]
 
-      responses = []
+      id       = nil
+      response = nil
 
       begin
-        decoded = self.decode payload
-
-        requests =
-          if decoded.is_a? Hash
-            [ decoded ] # Single request
-          elsif decoded.is_a? Array
-            decoded # Batch request
-          else
-            raise Errors::InvalidRequestError.new('Payload was neither an Array nor an Object')
-          end
-
-        requests.each do |request|
-          response = self.call_handler handler: handler,
-                                       request: request
+        request = self.decode payload
+        id      = request['id']
 
-          responses << response
-        end
+        response = self.call_handler handler: handler, request: request
       rescue => err
-        responses << {
+        response = {
           'jsonrpc' => '2.0',
-          'id'      => nil,
+          'id'      => id,
           'error'   => self.build_error_response(err)
         }
       end
 
-      responses.each do |response|
-        @exchange.publish Oj.dump(response), routing_key: reply_to,
-                                             correlation_id: response['id']
-      end
+      @exchange.publish Oj.dump(response), routing_key: reply_to,
+                                           correlation_id: response['id']
     end
 
     # handler - Instance of a `Handler` that may receive `#call`
     # request - `Hash` representing a decoded Request
     def call_handler(handler:, request:)
+      t0 = Time.now
+
       begin
-        # We don't yet know if it's valid, so we have to be as cautious as
-        # possible about getting the ID
-        id = begin request['id']; rescue; nil end
+        id = request['id']
 
         self.validate_request request
 
@@ -133,7 +119,13 @@ module Fluffle
         error = self.build_error_response err
       end
 
-      response = { 'jsonrpc' => '2.0', 'id' => id }
+      response = {
+        'jsonrpc' => '2.0',
+        'id'      => id,
+        'meta'    => {
+          'handler_duration' => (Time.now - t0)
+        }
+      }
 
       if error
         response['error'] = error

data/lib/fluffle/version.rb

@@ -1,3 +1,3 @@
 module Fluffle
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 end

data/spec/server_spec.rb

@@ -49,7 +49,7 @@ describe Fluffle::Server do
       payload['id']      ||= id
 
       expect(@exchange_spy).to have_received(:publish) do |payload_json, opts|
-        expect(Oj.load(payload_json)).to eq payload
+        expect(Oj.load(payload_json)).to include payload
 
         expect(opts).to eq routing_key: routing_key,
                            correlation_id: correlation_id
@@ -78,37 +78,6 @@ describe Fluffle::Server do
       expect_response payload: { 'result' => result }
     end
 
-    it 'responds with the correct individual results for a batch request' do
-      payload = [
-        { 'jsonrpc' => '2.0', 'id' => 'first',  'method' => 'multiply', 'params' => [1] },
-        { 'jsonrpc' => '2.0', 'id' => 'second', 'method' => 'multiply', 'params' => [2] }
-      ]
-
-      handler = double 'Handler'
-      expect(handler).to receive(:call).twice do |args|
-        expect(args).to include({
-          id: anything,
-          method: 'multiply'
-        })
-
-        args[:params].first * 2
-      end
-
-      responses = []
-
-      allow(@exchange_spy).to receive(:publish).ordered do |payload_json, _opts|
-        responses << Oj.load(payload_json)
-      end
-
-      subject.handle_request handler: handler,
-                             properties: { reply_to: reply_to },
-                             payload: Oj.dump(payload)
-
-      expect(responses.length).to eq 2
-      expect(responses[0]).to include('id' => 'first',  'result' => 2)
-      expect(responses[1]).to include('id' => 'second', 'result' => 4)
-    end
-
     it 'responds with the appropriate code and message when method not found' do
       @method = 'notfound'
 
@@ -141,5 +110,23 @@ describe Fluffle::Server do
                         }
                       }
     end
+
+    it 'includes appropriate meta-data in the response' do
+      handler = double 'Handler'
+      expect(handler).to receive(:call) do |args|
+        sleep 0.01
+
+        'Hello world!'
+      end
+
+      make_request handler: handler
+
+      expect(@exchange_spy).to have_received(:publish) do |payload_json, opts|
+        payload = Oj.load payload_json
+        meta    = payload['meta']
+
+        expect(meta['handler_duration']).to be >= 0.01
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluffle
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Dirk Gadsden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-17 00:00:00.000000000 Z
+date: 2016-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny