optics-agent 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b416f4296566bd8ee9c925ebf368420da59875f9
-  data.tar.gz: 8a7915bbf4b4aeea8020e6d2e7e848696f567bcd
+  metadata.gz: e66f0b58d77d29c4999ab86a26b9881eec66b75d
+  data.tar.gz: 2cbac6e78c27f4636cc40c94e8cf613e764946a7
 SHA512:
-  metadata.gz: 4a74329dd8338234ab390071767c7212c5a6d7fcab76d137be9d579c1a2e53a6a171af28f663e99bdd133e1e6f3c7a88c73479558a150635b5ac1b2335b21869
-  data.tar.gz: d634b06b48fc8e2439997eec02313f45b4fa61cc6087932048c02653b2ca9da9c4ae5b46420a890c81acdd94091a73ea670dbbff07db1da68fe7def4a8198f9c
+  metadata.gz: 1eec3c92af1dfad4da0a0c22bba4eb0d458100e4947a3c4392867884e1f1caff11550d973aca07c4147becd0eef51bb712e5e72ab4955c03a53c3b9f011509b9
+  data.tar.gz: 56466763944928e04c81a8467a774fd978064ce8d144be2445058add1179af57fb0bc523125c91e56be948f6566474124044d27943fbc5e39a4c928e7cd12974

data/README.md

@@ -63,7 +63,7 @@ You must:
 
 ### Configuration
 
-After creating an agent, you can configure it with:
+After creating an agent, you can configure it with (the values listed are the defaults):
 
 ```rb
 # defaults are show below
@@ -102,6 +102,30 @@ agent.configure do
 end
 ```
 
+## Troubleshooting
+
+The Optics agent is designed to allow your application to continue working, even if the agent is not configured properly.
+
+### No data in Optics
+
+If there is no data being sent to Optics, ensure you've followed the steps above, then check your application logs to look for the following messages:
+
+### Message: No api_key set.
+
+Solution: Get a valid API key from Optics and use the `OPTICS_API_KEY` environment variable, or [configuration](#configuration) to pass it to the agent.
+
+### Message: No schema instrumented
+
+Solution: Ensure you are passing your schema to the agent [configuration](#configuration).
+
+### Message: No agent passed in graphql context
+
+Solution: Ensure you are passing `context: { optics_agent: env[:optics_agent].with_document(query_string) }` where `env` is the Rack request environment, and `query_string` is the string representing your query. See the [setup instructions](#rails-setup) for more details.
+
+### Debugging
+
+You can also use the `debug` [configuration](#configuration) setting to get more detailed debugging information, which may give hints as to what the issue is.
+
 ## Development
 
 ### Running tests

data/lib/optics-agent/agent.rb

@@ -5,6 +5,7 @@ require 'optics-agent/reporting/schema_job'
 require 'optics-agent/reporting/query-trace'
 require 'net/http'
 require 'faraday'
+require 'logger'
 
 module OpticsAgent
   class Agent

data/lib/optics-agent/instrumenters/field.rb

@@ -13,9 +13,15 @@ module OpticsAgent
           end
         }
 
-        field.redefine do
+        new_field = field.redefine do
           resolve(new_resolve_proc)
         end
+
+        if old_resolve_proc.instance_of? GraphQL::Relay::ConnectionResolve
+          new_field.arguments = field.arguments
+        end
+
+        new_field
       end
 
       def middleware(agent, parent_type, parent_object, field_definition, field_args, query_context, next_middleware)

data/spec/field_connection_instrumenter_spec.rb

@@ -0,0 +1,59 @@
+require 'ostruct'
+require 'optics-agent/instrumenters/field'
+require 'graphql'
+
+include OpticsAgent
+
+describe "connection" do
+  it 'collects the correct query stats' do
+    person_type = GraphQL::ObjectType.define do
+      name "Person"
+      field :firstName do
+        type types.String
+        resolve -> (obj, args, ctx) { sleep(0.100); return 'Tom' }
+      end
+      field :lastName do
+        type types.String
+        resolve -> (obj, args, ctx) { sleep(0.100); return 'Coleman' }
+      end
+    end
+    query_type = GraphQL::ObjectType.define do
+      name 'Query'
+      field :person do
+        type person_type
+        resolve -> (obj, args, ctx) { sleep(0.050); return {} }
+      end
+      connection :people do
+        type person_type.connection_type
+        resolve -> (obj, args, ctx) { ["a", "b", "c"] }
+      end
+    end
+
+    instrumenter = Instrumenters::Field.new
+    instrumenter.agent = true
+    schema = GraphQL::Schema.define do
+      query query_type
+      instrument :field, instrumenter
+    end
+
+    query = spy("query")
+    allow(query).to receive(:duration_so_far).and_return(1.0)
+
+    result = schema.execute('{ people(first: 2) { edges { node { firstName lastName } } } }', {
+      context: { optics_agent: OpenStruct.new(query: query) }
+    })
+
+    expect(result).not_to have_key("errors")
+    expect(result).to have_key("data")
+
+    expect(query).to have_received(:report_field).exactly(1 + 1 + 2 * 1 + 2 * 2).times
+    expect(query).to have_received(:report_field)
+      .with('Query', 'people', be_instance_of(Float), be_instance_of(Float))
+    expect(query).to have_received(:report_field)
+      .exactly(2).times
+      .with('Person', 'firstName', be_instance_of(Float), be_instance_of(Float))
+    expect(query).to have_received(:report_field)
+      .exactly(2).times
+      .with('Person', 'lastName', be_instance_of(Float), be_instance_of(Float))
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: optics-agent
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - 'Tom Coleman '
@@ -153,6 +153,7 @@ files:
 - lib/optics-agent/reporting/schema.rb
 - lib/optics-agent/reporting/schema_job.rb
 - spec/benchmark/benchmark.rb
+- spec/field_connection_instrumenter_spec.rb
 - spec/field_instrumenter_spec.rb
 - spec/latency_spec.rb
 - spec/query-normalization_spec.rb
@@ -188,6 +189,7 @@ specification_version: 4
 summary: An Agent for Apollo Optics
 test_files:
 - spec/benchmark/benchmark.rb
+- spec/field_connection_instrumenter_spec.rb
 - spec/field_instrumenter_spec.rb
 - spec/latency_spec.rb
 - spec/query-normalization_spec.rb