getninjas-apollo-tracing 1.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 44ca5e07e050320b24646b9a688983629f72ff8c
+  data.tar.gz: e0a0014bf7b5f778f8ef848db16676be3b6eac35
+SHA512:
+  metadata.gz: 3422bba6a0fbb161bdbe226672511f018c9ab20d483ae225fd0c25ed0351b184c8ea8d512e3c53e84fd214a5a34824209da8b7ec117bfb11dfeb67d7c646daa0
+  data.tar.gz: dc9d87d08f3f696fd3edbfd6b4869fdd6d11d9da97e7fe466f2b150a638220fe920930146435c08d53c17370c90278df773d24ad4f5967fc5c526a7b1b7f38cf

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/bin/engineproxy*
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.3.4

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.4
+script: make download_binaries && bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,102 @@
+# Changelog
+
+The following are lists of the notable changes included with each release.
+This is intended to help keep people informed about notable changes between
+versions, as well as provide a rough history. Each item is prefixed with
+one of the following labels: `Added`, `Changed`, `Deprecated`,
+`Removed`, `Fixed`, `Security`. We also use [Semantic Versioning](http://semver.org)
+to manage the versions of this gem so
+that you can set version constraints properly.
+
+#### [Unreleased](https://github.com/uniiverse/apollo-tracing-ruby/compare/v1.6.0...HEAD)
+
+* WIP
+
+
+#### [v1.6.0](https://github.com/uniiverse/apollo-tracing-ruby/compare/v1.5.0...v1.6.0)
+
+* `Changed`: Engine Proxy version to 1.1.0. [#11](https://github.com/uniiverse/apollo-tracing-ruby/pull/11)
+
+#### [v1.5.0](https://github.com/uniiverse/apollo-tracing-ruby/compare/v1.4.0...v1.5.0) – 2018-03-12
+
+* `Fixed`: Avoid trying to instrument failed query results. [#7](https://github.com/uniiverse/apollo-tracing-ruby/pull/7)
+* `Changed`: Drop support for `graphql` version `1.6`. [c88e6bb](https://github.com/uniiverse/apollo-tracing-ruby/commit/c88e6bb4de575665df15714e23a5cd23755b2cf1)
+
+#### [v1.4.0](https://github.com/uniiverse/apollo-tracing-ruby/compare/v1.3.0...v1.4.0) – 2018-02-09
+
+* `Changed`: Apollo Engine Proxy version to [2018.02-2-g0b77ff3e3](https://www.apollographql.com/docs/engine/proxy-release-notes.html#2018.02-2-g0b77ff3e3) to fix using arrays as arguments. [#9](https://github.com/uniiverse/apollo-tracing-ruby/pull/9)
+
+Please note, that if you use multiple origins:
+
+```
+{
+  "origins": [
+    { "http": { "url": "http://localhost:3000/graphql/beta" } },
+    { "http": { "url": "http://localhost:3000/graphql" } }
+  ],
+  "frontends": [
+    { "host": "localhost", "port": 3001, "endpoint": "/graphql/beta" },
+    { "host": "localhost", "port": 3001, "endpoint": "/graphql" }
+  ]
+  ...
+}
+```
+
+Each origin should have a unique name now, was introduced in [2017.12-28-gcc16cbea7](https://www.apollographql.com/docs/engine/proxy-release-notes.html#2017.12-28-gcc16cbea7) Apollo Engine Proxy version:
+
+```
+{
+  "origins": [
+    { "http": { "url": "http://localhost:3000/graphql/beta" }, "name": "graphql-beta" },
+    { "http": { "url": "http://localhost:3000/graphql" }, "name": "graphql" }
+  ],
+  "frontends": [
+    { "host": "localhost", "port": 3001, "endpoints": ["/graphql/beta", "/graphql"], "originName": "graphql" }
+  ]
+  ...
+}
+```
+
+#### [v1.3.0](https://github.com/uniiverse/apollo-tracing-ruby/compare/v1.2.1...v1.3.0) – 2017-11-09
+
+* `Changed`: Apollo Engine Proxy version to [2017.11-40-g9585bfc6](https://www.apollographql.com/docs/engine/proxy-release-notes.html#2017-11-40-g9585bfc6).
+
+#### [v1.2.1](https://github.com/uniiverse/apollo-tracing-ruby/compare/v1.2.0...v1.2.1) – 2017-10-26
+
+* `Fixed`: bump Apollo Engine Proxy version to [2017.10-425-gdd4873ae](https://www.apollographql.com/docs/engine/proxy-release-notes.html) to remove empty `operationName` and `extensions`.
+
+#### [v1.2.0](https://github.com/uniiverse/apollo-tracing-ruby/compare/v1.1.0...v1.2.0) – 2017-10-26
+
+* `Added`: `ApolloTracing.start_proxy` accepts a JSON string. [#3](https://github.com/uniiverse/apollo-tracing-ruby/pull/3)
+
+#### [v1.1.0](https://github.com/uniiverse/apollo-tracing-ruby/compare/v1.0.0...v1.1.0) – 2017-10-25
+
+* `Added`: Apollo Engine Proxy version [2017.10-408-g497e1410](https://www.apollographql.com/docs/engine/proxy-release-notes.html). [#2](https://github.com/uniiverse/apollo-tracing-ruby/pull/2)
+
+#### [v1.0.0](https://github.com/uniiverse/apollo-tracing-ruby/compare/v0.1.1...v1.0.0) – 2017-10-17
+
+* `Changed`: the gem name from `graphql-tracing` to `apollo-tracing`.
+
+```ruby
+# Before:
+
+Schema = GraphQL::Schema.define do
+  use GraphQL::Tracing.new
+end
+```
+
+```ruby
+# After:
+
+Schema = GraphQL::Schema.define do
+  use ApolloTracing.new
+end
+```
+
+#### [v0.1.1](https://github.com/uniiverse/apollo-tracing-ruby/compare/v0.1.0...v0.1.1) – 2017-10-17
+
+* `Fixed`: naming conflicts with [graphql-ruby](https://github.com/rmosolgo/graphql-ruby/pull/996) by restricting the gem version.
+
+#### [v0.1.0](https://github.com/uniiverse/apollo-tracing-ruby/compare/d346dd2...v0.1.0) – 2017-08-28
+
+* `Added`: initial functional version.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at rsuh@uwaterloo.ca. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in apollo-tracing.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Reginald
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Makefile

@@ -0,0 +1,19 @@
+PROXY_VERSION := 2018.6-20-gc0e4bb519
+
+download_binaries:
+	curl -O https://registry.npmjs.org/apollo-engine-binary-darwin/-/apollo-engine-binary-darwin-0.$(PROXY_VERSION).tgz
+	curl -O https://registry.npmjs.org/apollo-engine-binary-linux/-/apollo-engine-binary-linux-0.$(PROXY_VERSION).tgz
+	curl -O https://registry.npmjs.org/apollo-engine-binary-windows/-/apollo-engine-binary-windows-0.$(PROXY_VERSION).tgz
+	tar -xzf apollo-engine-binary-darwin-0.$(PROXY_VERSION).tgz
+	tar -xzf apollo-engine-binary-linux-0.$(PROXY_VERSION).tgz
+	tar -xzf apollo-engine-binary-windows-0.$(PROXY_VERSION).tgz
+	mv package/engineproxy_darwin_amd64 bin/
+	mv package/engineproxy_linux_amd64 bin/
+	mv package/engineproxy_windows_amd64.exe bin/
+	rm -r package/
+	rm apollo-engine-binary-darwin-0.$(PROXY_VERSION).tgz
+	rm apollo-engine-binary-linux-0.$(PROXY_VERSION).tgz
+	rm apollo-engine-binary-windows-0.$(PROXY_VERSION).tgz
+
+release: download_binaries
+	bundle exec rake release

data/README.md

@@ -0,0 +1,258 @@
+# Apollo Tracing
+
+[![Build Status](https://travis-ci.org/uniiverse/apollo-tracing-ruby.svg?branch=master)](https://travis-ci.org/uniiverse/apollo-tracing-ruby)
+[![Latest Version](https://img.shields.io/gem/v/apollo-tracing.svg)](https://rubygems.org/gems/apollo-tracing)
+
+Ruby implementation of [GraphQL](https://github.com/rmosolgo/graphql-ruby) trace data in the [Apollo Tracing](https://github.com/apollographql/apollo-tracing) format.
+
+
+## Contents
+
+* [Installation](#installation)
+* [Usage](#usage)
+  * [Tracing](#tracing)
+  * [Engine Proxy](#engine-proxy)
+* [Development](#development)
+* [Contributing](#contributing)
+* [License](#license)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'apollo-tracing'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install apollo-tracing
+
+## Usage
+
+Define a GraphQL schema:
+
+```ruby
+# Define a type
+PostType = GraphQL::ObjectType.define do
+  name "Post"
+
+  field :id, !types.ID
+  field :title, !types.String
+end
+
+# Define a query
+QueryType = GraphQL::ObjectType.define do
+  name "Query"
+
+  field :posts, !types[PostType] do
+    argument :user_id, !types.ID
+    resolve ->(obj, args, ctx) { Post.where(user_id: args[:user_id]) }
+  end
+end
+
+# Define a schema
+Schema = GraphQL::Schema.define do
+  query QueryType
+end
+
+# Execute query
+query = "
+  query($user_id: ID!) {
+    posts(user_id: $user_id) {
+      id
+      title
+    }
+  }
+"
+Schema.execute(query, variables: { user_id: 1 })
+```
+
+### Tracing
+
+Add 'ApolloTracing' to your schema:
+
+<pre>
+<b>require "apollo/tracing"</b>
+
+Schema = GraphQL::Schema.define do
+  query QueryType
+  <b>use ApolloTracing.new</b>
+end
+</pre>
+
+Now your response should look something like:
+```
+{
+   "data":{
+      "posts":[
+         {
+            "id":"1",
+            "title":"Post Title"
+         }
+      ]
+   },
+   "extensions":{
+      "tracing":{
+         "version":1,
+         "startTime":"2017-08-25T19:55:04.821Z",
+         "endTime":"2017-08-25T19:55:04.823Z",
+         "duration":1702785,
+         "execution":{
+            "resolvers":[
+               {
+                  "path":[
+                     "posts"
+                  ],
+                  "parentType":"Query",
+                  "fieldName":"posts",
+                  "returnType":"[Post!]!",
+                  "startOffset":1451015,
+                  "duration":15735
+               },
+               {
+                  "path":[
+                     "posts",
+                     0,
+                     "id"
+                  ],
+                  "parentType":"Post",
+                  "fieldName":"id",
+                  "returnType":"ID!",
+                  "startOffset":1556873,
+                  "duration":6914
+               },
+               {
+                  "path":[
+                     "posts",
+                     0,
+                     "title"
+                  ],
+                  "parentType":"Post",
+                  "fieldName":"title",
+                  "returnType":"String!",
+                  "startOffset":1604795,
+                  "duration":4053
+               },
+               {
+                  "path":[
+                     "posts",
+                     0,
+                     "user_id"
+                  ],
+                  "parentType":"Post",
+                  "fieldName":"user_id",
+                  "returnType":"ID!",
+                  "startOffset":1642942,
+                  "duration":3814
+               }
+            ]
+         }
+      }
+   }
+}
+```
+
+### Engine Proxy
+
+Now you can start using the [Apollo Engine](https://www.apollographql.com/engine/) service.
+Here is the general architecture overview of a sidecar mode – Proxy runs next to your application server:
+
+```
+ -----------------    request     -----------------    request     -----------------
+|                 | -----------> |                 | -----------> |                 |
+|     Client      |              |  Engine Proxy   |              |   Application   |
+|                 | <----------- |                 | <----------- |                 |
+ -----------------    response    -----------------    response    -----------------
+                                          |
+                                          |
+                          GraphQL tracing | from response
+                                          |
+                                          ˅
+                                  -----------------
+                                 |                 |
+                                 |  Apollo Engine  |
+                                 |                 |
+                                  -----------------
+```
+
+`ApolloTracing` gem comes with the [Apollo Engine Proxy](https://www.apollographql.com/docs/engine/index.html#engine-proxy) binary written in Go.
+To configure the Proxy create a Proxy config file:
+
+```
+# config/apollo-engine-proxy.json
+
+{
+  "apiKey": "service:YOUR_ENGINE_API_KEY",
+  "logging": { "level": "INFO" },
+  "origins": [{
+    "http": { "url": "http://localhost:3000/graphql" }
+  }],
+  "frontends": [{
+    "host": "localhost", "port": 3001, "endpoints": ["/graphql"]
+  }]
+}
+```
+
+* `apiKey` – get this on your [Apollo Engine](https://engine.apollographql.com/) home page.
+* `logging.level` – a log level for the Proxy ("INFO", "DEBUG" or "ERROR").
+* `origins` – a list of URLs with your GraphQL endpoints in the Application.
+* `frontends` – an address on which the Proxy will be listening.
+
+To run the Proxy as a child process, which will be automatically terminated if the Application proccess stoped, add the following line to the `config.ru` file:
+
+<pre>
+# config.ru – this file is used by Rack-based servers to start the application
+require File.expand_path('../config/environment',  __FILE__)
+
+<b>ApolloTracing.start_proxy('config/apollo-engine-proxy.json')</b>
+# or pass a JSON string:
+# ApolloTracing.start_proxy('{"apiKey": "KEY", ...}')
+
+run Your::Application
+</pre>
+
+For example, if you use [rails](https://github.com/rails/rails) with [puma](https://github.com/puma/puma) application server and run it like:
+
+```
+bundle exec puma -w 2 -t 16 -p 3000
+```
+
+The proccess tree may look like:
+
+```
+                ---------------
+               |  Puma Master  |
+               |   Port 3000   |
+                ---------------
+                   |      |
+         ----------        ----------
+        |                            |    ----------------
+        ˅                             -> |  Puma Worker1  |
+ ----------------                    |    -----------------
+|  Engine Proxy  |                   |    ----------------
+|   Port 3001    |                    -> |  Puma Worker2  |
+ ----------------                         ----------------
+```
+
+Now you can send requests to the reverse Proxy `http://localhost:3001`.
+It'll proxy any (GraphQL and non-GraphQL) requests to the Application `http://localhost:3000`.
+If the request matches the endpoints described in `origins`, it'll strip the `tracing` data from the response and will send it to the Apollo Engine service.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/uniiverse/apollo-tracing-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/apollo-tracing.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'apollo_tracing/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "getninjas-apollo-tracing"
+  spec.version       = ApolloTracing::VERSION
+  spec.authors       = ["Reginald Suh", "Evgeny Li"]
+  spec.email         = ["tech@getninjas.com.br"]
+
+  spec.summary       = %q{Ruby implementation of GraphQL trace data in the Apollo Tracing format.}
+  spec.description   = %q{Ruby implementation of GraphQL trace data in the Apollo Tracing format.}
+  spec.homepage      = "https://github.com/getninjas/apollo-tracing-ruby"
+  spec.license       = "MIT"
+
+  spec.files         =
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^test/}) } +
+    %w[
+      bin/engineproxy_darwin_amd64
+      bin/engineproxy_linux_amd64
+      bin/engineproxy_windows_amd64.exe
+    ]
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.1.0' # keyword args
+
+  spec.add_runtime_dependency "graphql", ">= 1.7.0", "< 2"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "apollo_tracing"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+make download_binaries
+
+# Do any other automated setup that you need to do here

data/lib/apollo/tracing.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative '../apollo_tracing'

data/lib/apollo_tracing.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require "graphql"
+require "apollo_tracing/version"
+
+class ApolloTracing
+  def self.start_proxy(config_filepath_or_json = 'config/apollo-engine.json')
+    config_json =
+      if File.exist?(config_filepath_or_json)
+        File.read(config_filepath_or_json)
+      else
+        config_filepath_or_json
+      end
+    binary_path =
+      if RUBY_PLATFORM.include?('darwin')
+        File.expand_path('../../bin/engineproxy_darwin_amd64', __FILE__)
+      elsif /cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM
+        File.expand_path('../../bin/engineproxy_windows_amd64.exe', __FILE__)
+      else
+        File.expand_path('../../bin/engineproxy_linux_amd64', __FILE__)
+      end
+
+    @@proxy_pid = spawn(
+      {"ENGINE_CONFIG" => config_json},
+      "#{binary_path} -config=env",
+      {out: STDOUT, err: STDERR}
+    )
+    at_exit { stop_proxy }
+    Process.detach(@@proxy_pid)
+    @@proxy_pid
+  end
+
+  def self.stop_proxy
+    Process.getpgid(@@proxy_pid)
+    Process.kill('TERM', @@proxy_pid)
+
+    3.times do
+      Process.getpgid(@@proxy_pid)
+      sleep 1
+    end
+
+    Process.getpgid(@@proxy_pid)
+    puts "Couldn't cleanly terminate the Apollo Engine Proxy in 3 seconds!"
+    Process.kill('KILL', @@proxy_pid)
+  rescue Errno::ESRCH
+    # process does not exist
+  end
+
+  def use(schema_definition)
+    schema_definition.instrument(:query, self)
+    schema_definition.instrument(:field, self)
+  end
+
+  def before_query(query)
+    query.context['apollo-tracing'] = {
+      'start_time' => Time.now.utc,
+      'resolvers' => []
+    }
+  end
+
+  def after_query(query)
+    result = query.result
+    return if result.nil? || result.to_h.nil?
+    end_time = Time.now.utc
+    duration_nanos = duration_nanos(start_time: query.context['apollo-tracing']['start_time'], end_time: end_time)
+
+    result["extensions"] ||= {}
+    result["extensions"]["tracing"] = {
+      "version" => 1,
+      "startTime" => query.context['apollo-tracing']['start_time'].strftime('%FT%T.%3NZ'),
+      "endTime" => end_time.strftime('%FT%T.%3NZ'),
+      "duration" => duration_nanos,
+      "execution" => {
+        "resolvers" => query.context['apollo-tracing']['resolvers']
+      }
+    }
+  end
+
+  def instrument(type, field)
+    old_resolve_proc = field.resolve_proc
+
+    new_resolve_proc = ->(obj, args, ctx) do
+      resolve_start_time = Time.now.utc
+      result = old_resolve_proc.call(obj, args, ctx)
+      resolve_end_time = Time.now.utc
+
+      ctx['apollo-tracing']['resolvers'] << {
+        'path' => ctx.path,
+        'parentType' => type.name,
+        'fieldName' => field.name,
+        'returnType' => field.type.to_s,
+        'startOffset' => duration_nanos(start_time: ctx['apollo-tracing']['start_time'], end_time: resolve_start_time),
+        'duration' => duration_nanos(start_time: resolve_start_time, end_time: resolve_end_time)
+      }
+
+      result
+    end
+
+    field.redefine { resolve(new_resolve_proc) }
+  end
+
+  private
+
+  def duration_nanos(start_time:, end_time:)
+    ((end_time.to_f - start_time.to_f) * 1e9).to_i
+  end
+end

data/lib/apollo_tracing/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ApolloTracing
+  VERSION = "1.6.0"
+end

data/spec/apollo_tracing_spec.rb

@@ -0,0 +1,121 @@
+require "spec_helper"
+
+require 'fixtures/user'
+require 'fixtures/post'
+require 'fixtures/schema'
+require 'fixtures/broken_schema'
+
+RSpec.describe ApolloTracing do
+  describe '.start_proxy' do
+    it 'runs a proxy' do
+      pid = ApolloTracing.start_proxy('spec/fixtures/apollo-engine-proxy.json')
+      expect { Process.getpgid(pid) }.not_to raise_error
+      ApolloTracing.stop_proxy
+    end
+
+    it 'runs a proxy with a given JSON instead of a file path' do
+      config_json = File.read('spec/fixtures/apollo-engine-proxy.json')
+      pid = ApolloTracing.start_proxy(config_json)
+      expect { Process.getpgid(pid) }.not_to raise_error
+      ApolloTracing.stop_proxy
+    end
+  end
+
+  describe '.stop_proxy' do
+    it 'stops a proxy' do
+      pid = ApolloTracing.start_proxy('spec/fixtures/apollo-engine-proxy.json')
+      ApolloTracing.stop_proxy
+      expect { Process.getpgid(pid) }.to raise_error(Errno::ESRCH, 'No such process')
+    end
+  end
+
+  context 'introspection' do
+    it 'supports a nil result for failures' do
+      query = 'query($user_id: ID!) { posts(user_id: $user_id) { id title user_id } }'
+
+      expect {
+        BrokenSchema.execute(query, variables: { 'user_id' => '1' })
+      }.to raise_error(NoMethodError, /undefined method `title' for/)
+    end
+
+    it 'returns time in RFC 3339 format' do
+      query = "query($user_id: ID!) { posts(user_id: $user_id) { id title user_id } }"
+      now = Time.new(2017, 8, 25, 0, 0, 0, '+00:00')
+      allow(Time).to receive(:now).and_return(now)
+
+      result = Schema.execute(query, variables: {'user_id' => "1"})
+
+      expect(result.dig("extensions", 'tracing', 'startTime')).to eq('2017-08-25T00:00:00.000Z')
+      expect(result.dig("extensions", 'tracing', 'endTime')).to eq('2017-08-25T00:00:00.000Z')
+    end
+
+    it "resolves graphql query with tracing extension" do
+      query = "query($user_id: ID!) { posts(user_id: $user_id) { id title user_id } }"
+
+      result = Schema.execute(query, variables: {'user_id' => "1"})
+
+      expect(result["data"]).to eq(
+        "posts" => [{
+          "id" => "1",
+          "title" => "Post Title",
+          "user_id" => "1"
+        }]
+      )
+      tracing = result.dig("extensions", 'tracing')
+
+      expect(tracing['version']).to eq(1)
+      expect(tracing['startTime']).to be_a(String)
+      expect(tracing['endTime']).to be_a(String)
+      expect(tracing['duration']).to be >= 0
+
+      resolvers = tracing.dig('execution', 'resolvers')
+
+      expect(resolvers.dig(0, 'path')).to eq(["posts"])
+      expect(resolvers.dig(0, 'parentType')).to eq("Query")
+      expect(resolvers.dig(0, 'fieldName')).to eq("posts")
+      expect(resolvers.dig(0, 'returnType')).to eq("[Post!]!")
+      expect(resolvers.dig(0, 'startOffset')).to be >= 0
+      expect(resolvers.dig(0, 'duration')).to be >= 0
+
+      expect(resolvers.dig(1, 'path')).to eq(["posts", 0, "id"])
+      expect(resolvers.dig(1, 'parentType')).to eq("Post")
+      expect(resolvers.dig(1, 'fieldName')).to eq("id")
+      expect(resolvers.dig(1, 'returnType')).to eq("ID!")
+      expect(resolvers.dig(1, 'startOffset')).to be >= 0
+      expect(resolvers.dig(1, 'duration')).to be >= 0
+
+      expect(resolvers.dig(2, 'path')).to eq(["posts", 0, "title"])
+      expect(resolvers.dig(2, 'parentType')).to eq("Post")
+      expect(resolvers.dig(2, 'fieldName')).to eq("title")
+      expect(resolvers.dig(2, 'returnType')).to eq("String!")
+      expect(resolvers.dig(2, 'startOffset')).to be >= 0
+      expect(resolvers.dig(2, 'duration')).to be >= 0
+
+      expect(resolvers.dig(3, 'path')).to eq(["posts", 0, "user_id"])
+      expect(resolvers.dig(3, 'parentType')).to eq("Post")
+      expect(resolvers.dig(3, 'fieldName')).to eq("user_id")
+      expect(resolvers.dig(3, 'returnType')).to eq("ID!")
+      expect(resolvers.dig(3, 'startOffset')).to be >= 0
+      expect(resolvers.dig(3, 'duration')).to be >= 0
+    end
+
+    it "resolves without race conditions and multiple threads by sharing vars in the context" do
+      thread1 = Thread.new do
+        query1 = "query($user_id: ID!) { posts(user_id: $user_id) { id slow_id } }"
+        @result1 = Schema.execute(query1, variables: {'user_id' => "1"})
+      end
+
+      thread2 = Thread.new do
+        sleep 1
+        query2 = "query($user_id: ID!) { posts(user_id: $user_id) { title } }"
+        @result2 = Schema.execute(query2, variables: {'user_id' => "1"})
+      end
+
+      [thread1, thread2].map(&:join)
+
+      expect(@result1.dig('extensions', 'tracing', 'execution', 'resolvers', 1, 'path')).to eq(['posts', 0, 'id'])
+      expect(@result1.dig('extensions', 'tracing', 'execution', 'resolvers', 2, 'path')).to eq(['posts', 0, 'slow_id'])
+      expect(@result2.dig('extensions', 'tracing', 'execution', 'resolvers', 1, 'path')).to eq(['posts', 0, 'title'])
+    end
+  end
+end

data/spec/fixtures/apollo-engine-proxy.json

@@ -0,0 +1,10 @@
+{
+  "apiKey": "service:YOUR_ENGINE_API_KEY",
+  "logging": { "level": "INFO" },
+  "origins": [{
+    "http": { "url": "http://localhost:3000/graphql" }
+  }],
+  "frontends": [{
+    "host": "localhost", "port": 3001, "endpoint": "/graphql"
+  }]
+}

data/spec/fixtures/broken_schema.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+
+BadPostType = GraphQL::ObjectType.define do
+  name 'Foo'
+  description 'See also PostType, for a working version of this'
+
+  field :id, !types.String, hash_key: :id
+  field :user_id, !types.String, hash_key: :user_id
+  field :title, !types.String # This is the intended broken-ness: missing a hash_key setting
+end
+
+BrokenQueryType = GraphQL::ObjectType.define do
+  name 'BrokenQuery'
+  description 'See also QueryType, for a working version of this'
+  field :posts, !types[!BadPostType] do
+    argument :user_id, !types.ID
+    resolve ->(_obj, _args, _ctx) {
+      [ { id: 'foo1', title: 'titel1', user_id: 'Sven'} ]
+    }
+  end
+end
+
+BrokenSchema = GraphQL::Schema.define do
+  query BrokenQueryType
+  use ApolloTracing.new
+end

data/spec/fixtures/post.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class Post
+  def self.where(user_id:)
+    [new(user_id: user_id)]
+  end
+
+  attr_accessor :id, :user_id, :title
+
+  def initialize(user_id:)
+    self.user_id = user_id
+    self.id = 1
+    self.title = 'Post Title'
+  end
+end

data/spec/fixtures/schema.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+PostType = GraphQL::ObjectType.define do
+  name "Post"
+
+  field :id, !types.ID
+  field :title, !types.String
+  field :user_id, !types.ID
+  field :slow_id, !types.ID, resolve: ->(obj, _, _) do
+    sleep 2
+    obj.id
+  end
+end
+
+QueryType = GraphQL::ObjectType.define do
+  name "Query"
+
+  field :posts, !types[!PostType] do
+    argument :user_id, !types.ID
+    resolve ->(obj, args, ctx) { Post.where(user_id: args[:user_id]) }
+  end
+end
+
+Schema = GraphQL::Schema.define do
+  query QueryType
+  use ApolloTracing.new
+end

data/spec/fixtures/user.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class User
+  attr_accessor :id, :role
+
+  def initialize(id:, role:)
+    self.id = id
+    self.role = role
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require "bundler/setup"
+require "pry"
+
+require "apollo_tracing"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: getninjas-apollo-tracing
+version: !ruby/object:Gem::Version
+  version: 1.6.0
+platform: ruby
+authors:
+- Reginald Suh
+- Evgeny Li
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby implementation of GraphQL trace data in the Apollo Tracing format.
+email:
+- tech@getninjas.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- apollo-tracing.gemspec
+- bin/console
+- bin/engineproxy_darwin_amd64
+- bin/engineproxy_linux_amd64
+- bin/engineproxy_windows_amd64.exe
+- bin/setup
+- lib/apollo/tracing.rb
+- lib/apollo_tracing.rb
+- lib/apollo_tracing/version.rb
+- spec/apollo_tracing_spec.rb
+- spec/fixtures/apollo-engine-proxy.json
+- spec/fixtures/broken_schema.rb
+- spec/fixtures/post.rb
+- spec/fixtures/schema.rb
+- spec/fixtures/user.rb
+- spec/spec_helper.rb
+homepage: https://github.com/getninjas/apollo-tracing-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Ruby implementation of GraphQL trace data in the Apollo Tracing format.
+test_files: []