apollo-tracing 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce351de83cfe780dc152768b22274e822bd3bd02
-  data.tar.gz: 77e54bc35f506288f4456828f7968694bea3eab3
+  metadata.gz: 5427c1c7ad4c390d7ea73e5089b4291cbb6012c6
+  data.tar.gz: 06cb235d0c59d3e0fae40e7ac7b1a09b2deb4709
 SHA512:
-  metadata.gz: b9fb6347e03e0d62173308209d46316aa5ce5b49f0c858d11367c201a1b3d660d3bb8790f8f3e1e8d374f16d9a20004ea25f10acd65a432a89dfdbaea77c56d4
-  data.tar.gz: d611be717f55895b345c1399ff2b39be246e46e0ae0425ce111c04924d0e1737c95943edbcba15b7b39106cf7cb6949fecd36ebafc6e15f9cc1862b2f3bceff3
+  metadata.gz: 8a69276f3105a1e7deff72b05e5adad500848a3160118672fb3708016a591eacea074c23b73cf8150a7781c4e501980d42ba2d5ef7dafc712463d8d9515a5fdb
+  data.tar.gz: f9b06d4e3d7b14a56f96a01c48640ec92f04a9042c1ebb5254a8781117f98280f5816c79ea3c8826b8748a626590deed35c2dfdbff85780c3a7a53a2e7628f64

data/.gitignore

@@ -7,6 +7,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/bin/engineproxy*
 
 # rspec failure tracking
 .rspec_status

data/.travis.yml

@@ -2,4 +2,4 @@ sudo: false
 language: ruby
 rvm:
   - 2.3.4
-script: bundle exec rspec
+script: make download_binaries && bundle exec rspec

data/CHANGELOG.md

@@ -8,10 +8,14 @@ one of the following labels: `Added`, `Changed`, `Deprecated`,
 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.0.0...HEAD)
+#### [Unreleased](https://github.com/uniiverse/apollo-tracing-ruby/compare/v1.1.0...HEAD)
 
 * WIP
 
+#### [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`.

data/Makefile

@@ -0,0 +1,17 @@
+download_binaries:
+	curl -O https://registry.npmjs.org/apollo-engine-binary-darwin/-/apollo-engine-binary-darwin-0.2017.10-408-g497e1410.tgz
+	curl -O https://registry.npmjs.org/apollo-engine-binary-darwin/-/apollo-engine-binary-linux-0.2017.10-408-g497e1410.tgz
+	curl -O https://registry.npmjs.org/apollo-engine-binary-darwin/-/apollo-engine-binary-windows-0.2017.10-408-g497e1410.tgz
+	tar -xzf apollo-engine-binary-darwin-0.2017.10-408-g497e1410.tgz
+	tar -xzf apollo-engine-binary-linux-0.2017.10-408-g497e1410.tgz
+	tar -xzf apollo-engine-binary-windows-0.2017.10-408-g497e1410.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.2017.10-408-g497e1410.tgz
+	rm apollo-engine-binary-linux-0.2017.10-408-g497e1410.tgz
+	rm apollo-engine-binary-windows-0.2017.10-408-g497e1410.tgz
+
+release: download_binaries
+	bundle exec rake release

data/README.md

@@ -4,6 +4,17 @@
 
 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:
@@ -49,16 +60,18 @@ Schema = GraphQL::Schema.define do
 end
 
 # Execute query
-query = "query($user_id: ID!) {
-          posts(user_id: $user_id) {
-            id
-            title
-          }
-        }"
+query = "
+  query($user_id: ID!) {
+    posts(user_id: $user_id) {
+      id
+      title
+    }
+  }
+"
 Schema.execute(query, variables: { user_id: 1 })
 ```
 
-### Setup Tracing
+### Tracing
 
 Add 'ApolloTracing' to your schema:
 
@@ -141,6 +154,89 @@ Now your response should look something like:
 }
 ```
 
+### 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 data |
+                                          |
+                                          ˅
+                                  -----------------
+                                 |                 |
+                                 |  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": "127.0.0.1", "port": 3001, "endpoint": "/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>
+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 3001
+```
+
+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.
@@ -154,4 +250,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/uniive
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/apollo-tracing.gemspec

@@ -14,9 +14,14 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/uniiverse/apollo-tracing-ruby"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
+  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"]

data/bin/setup

@@ -4,5 +4,6 @@ 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

@@ -4,6 +4,43 @@ require "graphql"
 require "apollo_tracing/version"
 
 class ApolloTracing
+  def self.start_proxy(config_filepath = 'config/apollo-engine.json')
+    config_json = File.read(config_filepath)
+    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 -restart=true",
+      {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)

data/lib/apollo_tracing/version.rb

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

data/spec/apollo_tracing_spec.rb

@@ -0,0 +1,105 @@
+require "spec_helper"
+
+require 'fixtures/user'
+require 'fixtures/post'
+require 'fixtures/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
+  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 '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": "DEBUG" },
+  "origins": [{
+    "http": { "url": "http://localhost:3000/graphql" }
+  }],
+  "frontends": [{
+    "host": "127.0.0.1", "port": 3001, "endpoint": "/graphql"
+  }]
+}

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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apollo-tracing
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Reginald Suh
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-17 00:00:00.000000000 Z
+date: 2017-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -103,14 +103,24 @@ files:
 - 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/post.rb
+- spec/fixtures/schema.rb
+- spec/fixtures/user.rb
+- spec/spec_helper.rb
 homepage: https://github.com/uniiverse/apollo-tracing-ruby
 licenses:
 - MIT