graphql-tracing 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 86eeee08cec50fcf2d935fd6ed9837b04eb718ec
+  data.tar.gz: 37aa1ad2c354d3c3a402116558a79b22c4f903dc
+SHA512:
+  metadata.gz: 37a18ea8688bb312a6c07508a2745ec4c4d946a2909de3d1502f26c5fb883688ee245b04cf732dad85ddb1f43b1633b2006ed487e8222ab3d6c7b2c1d12e1e08
+  data.tar.gz: a3581be9dfdf320b86912e6760c073dea01c9b03018d8f322c739cedd363d7ca4bfd0d0360fa5a819744fee90bf6607c56f7696741b7f0be182b97a8c1a1e78d

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# 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: bundle exec rspec

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 graphql-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/README.md

@@ -0,0 +1,158 @@
+# GraphQL Tracing
+
+[![Build Status](https://travis-ci.org/uniiverse/graphql-tracing.svg?branch=master)](https://travis-ci.org/uniiverse/graphql-tracing)
+
+Ruby implementation of [GraphQL](https://github.com/rmosolgo/graphql-ruby) trace data in the [Apollo Tracing](https://github.com/apollographql/apollo-tracing) format.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphql-tracing'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install graphql-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 })
+```
+
+### Setup Tracing
+
+Add 'GraphQL::Tracing' to your schema:
+
+<pre>
+Schema = GraphQL::Schema.define do
+  query QueryType
+  use GraphQL::Tracing.new
+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
+               }
+            ]
+         }
+      }
+   }
+}
+```
+
+## 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/[USERNAME]/graphql-tracing. 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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "graphql/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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/graphql-tracing.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'graphql/tracing/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "graphql-tracing"
+  spec.version       = Graphql::Tracing::VERSION
+  spec.authors       = ["Reginald Suh", "Evgeny Li"]
+  spec.email         = ["evgeny.li@universe.com", "rsuh@edu.uwaterloo.ca"]
+
+  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/uniiverse/graphql-tracing"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  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.6.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/lib/graphql/tracing/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Graphql
+  module Tracing
+    VERSION = "0.1.0"
+  end
+end

data/lib/graphql/tracing.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "graphql"
+require "graphql/tracing/version"
+
+module GraphQL
+  class Tracing
+    def use(schema_definition)
+      schema_definition.instrument(:query, self)
+      schema_definition.instrument(:field, self)
+    end
+
+    def before_query(query)
+      query.context['graphql-tracing'] = {
+        'start_time' => Time.now.utc,
+        'resolvers' => []
+      }
+    end
+
+    def after_query(query)
+      result = query.result
+      end_time = Time.now.utc
+      duration_nanos = duration_nanos(start_time: query.context['graphql-tracing']['start_time'], end_time: end_time)
+
+      result["extensions"] ||= {}
+      result["extensions"]["tracing"] = {
+        "version" => 1,
+        "startTime" => query.context['graphql-tracing']['start_time'].strftime('%FT%T.%3NZ'),
+        "endTime" => end_time.strftime('%FT%T.%3NZ'),
+        "duration" => duration_nanos,
+        "execution" => {
+          "resolvers" => query.context['graphql-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['graphql-tracing']['resolvers'] << {
+          'path' => ctx.path,
+          'parentType' => type.name,
+          'fieldName' => field.name,
+          'returnType' => field.type.to_s,
+          'startOffset' => duration_nanos(start_time: ctx['graphql-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
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: graphql-tracing
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Reginald Suh
+- Evgeny Li
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.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:
+- evgeny.li@universe.com
+- rsuh@edu.uwaterloo.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- graphql-tracing.gemspec
+- lib/graphql/tracing.rb
+- lib/graphql/tracing/version.rb
+homepage: https://github.com/uniiverse/graphql-tracing
+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: []