optics-agent 0.1.3 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjIwMWU1NjYxNGYzNzhhMzk1Y2IwODMxZTE1NjZkYjUwNTY1NTQ5YQ==
+    OTY4ZDA5OTJkNWJjMmE3NWIwOTAyNTJlNGJjNWQzM2RlNWViNDA3MA==
   data.tar.gz: !binary |-
-    MTNkMjcxMjAyNWJlY2E1OTc4NTVkY2NmMTZjMGZiODdkNDg4ZTFkMA==
+    OGI1YmVmMzE3ZDY1MDUzMjNmOWZmZTg2YTA5MzlmOWMzNDZkMzFiNw==
 SHA512:
   metadata.gz: !binary |-
-    OTRkYTZlZDlhMDNmMjQ5OGU5MTliNDVkNWRhYzUzMjIzMDMwNTNjYjQ4NTg2
-    OTNkOWRmOWM1YmE2YWViNzE2MGExZDliNzQwZjcxZjFkYmNmNjA2MGM5OWMz
-    ZjhmOGFmODM2MWFjMDM5Njc3OTU2YzFmMDgyN2FiYmUwMmVmYWI=
+    YjA0ODUzYjA2ZjJkZWI5ZDc4MDJlMDk5NDA3ZmU5NWRjMDQ5YTA4ZjAzY2Y4
+    NzgwNTU4M2YzMjk2MzM5YTk1M2M4NzM2YjIyZjI2NzE5ZDBkM2YyYTc5OWY3
+    YjIyNWFhOWRhNzI5ZGJjMjdkN2I3Yjc2NDVlZThlZDBiZGQ4YTY=
   data.tar.gz: !binary |-
-    NWM4ZDQwOGU5MTZjYTVhY2MwZjg4NWQ4MjA5Zjc2OGZjZWUyZTlkMTc2YTI1
-    MTk4YzQzZWEyNGY1YmUwMDUzZTg2Mjg3NTk4MTIyNGNiMjA4ZGNhNjQwYWE1
-    ZGE0ZjEyMTdiNmJlZTM3NDFlN2E3YTEyOTNhZmUyZTJkYzQ4NTM=
+    MWQxMDVjZWZkMjM2YjIyNGI0MzhhNGI0NWE4NmFlYzc0ZmRhMzNhZDVjYWZk
+    Y2U2ODA1NjlkMmIxNDU4MmE5NzM0ZGE0NTNhZWIyNDc4NzQ3MTFlNDhiOGZj
+    M2I0NzhiZmZjNmE0NjQ5OWRjYjEyNmQyYzFlOGUyZGM3ZjQ1Mjg=

data/README.md

@@ -48,11 +48,16 @@ Add something like this to your route:
 ```ruby
 post '/graphql' do
   request.body.rewind
-  document = JSON.parse request.body.read
-  result = Schema.execute(document["query"],
-    variables: document["variables"],
+  params = JSON.parse request.body.read
+  document = params['query']
+  variables = params['variables']
+
+  result = Schema.execute(
+    document,
+    variables: variables,
     context: { optics_agent: env[:optics_agent].with_document(document) }
   )
+
   JSON.generate(result)
 end
 ```
@@ -87,12 +92,15 @@ Register Optics Agent on the GraphQL context within your `graphql` action as bel
 def create
   query_string = params[:query]
   query_variables = ensure_hash(params[:variables])
-  result = YourSchema.execute(query_string,
+
+  result = YourSchema.execute(
+    query_string,
     variables: query_variables,
     context: {
-      optics_agent: env[:optics_agent].with_document(params)
+      optics_agent: env[:optics_agent].with_document(query_string)
     }
   )
+
   render json: result
 end
 ```

data/lib/optics-agent/rack-middleware.rb

@@ -8,36 +8,31 @@ module OpticsAgent
     end
 
     def call(env)
-      begin
-        start_time = Time.now
+      start_time = Time.now
 
-        # XXX: figure out a way to pass this in here
-        agent = OpticsAgent::Agent.instance
-        query = OpticsAgent::Reporting::Query.new
+      # XXX: figure out a way to pass this in here
+      agent = OpticsAgent::Agent.instance
+      query = OpticsAgent::Reporting::Query.new
 
-        # Attach so resolver middleware can access
-        env[:optics_agent] = {
-          agent: agent,
-          query: query
-        }
-        env[:optics_agent].define_singleton_method(:with_document) do |document|
-          self[:query].document = document
-          self
-        end
-
-        result = @app.call(env)
+      # Attach so resolver middleware can access
+      env[:optics_agent] = {
+        agent: agent,
+        query: query
+      }
+      env[:optics_agent].define_singleton_method(:with_document) do |document|
+        self[:query].document = document
+        self
+      end
 
-        # XXX: this approach means if the user forgets to call with_document
-        # we just never log queries. Can we detect if the request is a graphql one?
-        if (query.document)
-          agent.add_query(query, env, start_time, Time.now)
-        end
+      result = @app.call(env)
 
-        result
-      rescue Exception => e
-        puts "Rack Middleware Error: #{e}"
-        puts e.backtrace
+      # XXX: this approach means if the user forgets to call with_document
+      # we just never log queries. Can we detect if the request is a graphql one?
+      if (query.document)
+        agent.add_query(query, env, start_time, Time.now)
       end
+
+      result
     end
   end
 end

data/lib/optics-agent/reporting/query.rb

@@ -28,7 +28,7 @@ module OpticsAgent::Reporting
         throw "You must call .with_document on the optics context"
       end
 
-      @signature ||= normalize(document["query"].to_s)
+      @signature ||= normalize(document.to_s)
     end
 
     # we do nothing when reporting to minimize impact

data/spec/query_trace_spec.rb

@@ -6,24 +6,13 @@ require 'graphql'
 include Apollo::Optics::Proto
 include OpticsAgent::Reporting
 
-class DocumentMock
-  def initialize(key)
-    @key = key
-  end
-
-  def [](name) # used for [:query]
-    @key
-  end
-end
-
-
 describe QueryTrace do
   it "can represent a simple query" do
     query = Query.new
     query.report_field 'Person', 'firstName', 1, 1.1
     query.report_field 'Person', 'lastName', 1, 1.1
     query.report_field 'Query', 'person', 1, 1.22
-    query.document = DocumentMock.new('{field}')
+    query.document = '{field}'
 
     trace = QueryTrace.new(query, {}, 1, 1.25)
 

data/spec/report_spec.rb

@@ -6,24 +6,13 @@ require 'graphql'
 include OpticsAgent::Reporting
 include Apollo::Optics::Proto
 
-class DocumentMock
-  def initialize(key)
-    @key = key
-  end
-
-  def [](name) # used for [:query]
-    @key
-  end
-end
-
-
 describe Report do
   it "can represent a simple query" do
     query = Query.new
     query.report_field 'Person', 'firstName', 1, 1.1
     query.report_field 'Person', 'lastName', 1, 1.1
     query.report_field 'Query', 'person', 1, 1.22
-    query.document = DocumentMock.new('{field}')
+    query.document = '{field}'
 
     report = Report.new
     report.add_query query, {}, 1, 1.25
@@ -52,13 +41,13 @@ describe Report do
     queryOne.report_field 'Person', 'firstName', 1, 1.1
     queryOne.report_field 'Person', 'lastName', 1, 1.1
     queryOne.report_field 'Query', 'person', 1, 1.22
-    queryOne.document = DocumentMock.new('{field}')
+    queryOne.document = '{field}'
 
     queryTwo = Query.new
     queryTwo.report_field 'Person', 'firstName', 1, 1.05
     queryTwo.report_field 'Person', 'lastName', 1, 1.05
     queryTwo.report_field 'Query', 'person', 1, 1.2
-    queryTwo.document = DocumentMock.new('{field}')
+    queryTwo.document = '{field}'
 
     report = Report.new
     report.add_query queryOne, {}, 1, 1.1
@@ -88,13 +77,13 @@ describe Report do
     queryOne.report_field 'Person', 'firstName', 1, 1.1
     queryOne.report_field 'Person', 'lastName', 1, 1.1
     queryOne.report_field 'Query', 'person', 1, 1.22
-    queryOne.document = DocumentMock.new('{fieldOne}')
+    queryOne.document = '{fieldOne}'
 
     queryTwo = Query.new
     queryTwo.report_field 'Person', 'firstName', 1, 1.05
     queryTwo.report_field 'Person', 'lastName', 1, 1.05
     queryTwo.report_field 'Query', 'person', 1, 1.02
-    queryTwo.document = DocumentMock.new('{fieldTwo}')
+    queryTwo.document = '{fieldTwo}'
 
     report = Report.new
     report.add_query queryOne, {}, 1, 1.1
@@ -123,7 +112,7 @@ describe Report do
     query = Query.new
     query.report_field 'Person', 'firstName', 1, 1.1
     query.report_field 'Person', 'age', 1, 1.1
-    query.document = DocumentMock.new('{field}')
+    query.document = '{field}'
 
     report = Report.new
     report.add_query query, {}, 1, 1.25
@@ -161,7 +150,7 @@ describe Report do
     query.report_field 'Query', '__schema', 1, 1.1
     query.report_field 'Query', '__typename', 1, 1.1
     query.report_field 'Query', '__type', 1, 1.1
-    query.document = DocumentMock.new('{field}')
+    query.document = '{field}'
 
     report = Report.new
     report.add_query query, {}, 1, 1.25

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: optics-agent
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - ! 'Tom Coleman '