graphql-hive 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9f7e0924e498a6030eed43104a7fcf813d99ec671ecfc4b833ea58ca7670255
-  data.tar.gz: ffe20148dc4cec94758aec3633d4892ea88e5559ae253e23eb633c3f32d9c645
+  metadata.gz: ddb07c0967f9d855e35fe6fc0e4de8d150296a696bddfa04b03a51871d22ec5d
+  data.tar.gz: 3a061660f99486014a748b457a1a573b62b87f7126dd2ee11eb2ed0a51d73153
 SHA512:
-  metadata.gz: aebc0b8ec85f52e51fdf21328fad34c000d82fde6998832ee3581d2746167f41eca88a3e98d267f8dc02fa85cd34b3214028ece370f2446c7ca39c52b65e6fd3
-  data.tar.gz: 4fcc8132d44004f2fe19431c29782c1872975a8d1acd59218b41a95ab69ab72463ac7135ae64a5b14f1cfea660e432b63216dcaae3d8a4180401786bdf329fbc
+  metadata.gz: da040838d105fef9cf821681045aa247733ddc6d53da991fb8fb9d64950a713846cee35e645ef6b8db70f40b955b05d2446367ed5625b152ef66c59917d9b0ea
+  data.tar.gz: bf78194e3f7bd1cb405794060e693e80f0fa1cd111c1d776b45f19f2c2a288b0d266fe40d61e8fba66afe37209c7ec45e42882b221f7b5cf6e6ba87738a854b0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    graphql-hive (0.2.0)
+    graphql-hive (0.3.1)
       graphql (~> 2.0.9)
 
 GEM
@@ -9,7 +9,7 @@ GEM
   specs:
     ast (2.4.2)
     diff-lcs (1.5.0)
-    graphql (2.0.15)
+    graphql (2.0.16)
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)

data/README.md

@@ -64,6 +64,44 @@ If you only want to use the operations monitoring, replace the `reporting` optio
 
 <br/>
 
+## 3. (Optional) Configure Lifecycle Hooks
+
+Calling these hooks are situational - it's likely that you may not need to call
+them at all!
+
+### `on_start`
+
+Call this hook if you are running `GraphQL::Hive` in a process that `fork`s
+itself.
+
+example: `puma` web server running in (["clustered
+mode"](https://github.com/puma/puma/tree/6d8b728b42a61bcf3c1e4c698c9165a45e6071e8#clustered-mode))
+
+```ruby
+# config/puma.rb
+preload_app!
+
+on_worker_boot do
+  GraphQL::Hive.instance.on_start
+end
+```
+
+### `on_exit`
+
+If your GraphQL API process is shut down non-gracefully but has a shutdown hook
+to call into, call `on_worker_exit`.
+
+`puma` example:
+
+```ruby
+# config/puma.rb
+
+on_worker_shutdown do
+  GraphQL::Hive.instance.on_exit
+end
+```
+
+<br />
 
 **You are all set! 🚀**
 
@@ -74,7 +112,7 @@ When deploying or starting up your GraphQL API, `graphql-hive` will immediately:
 
 <br/>
 
-## 3. See how your GraphQL API is operating
+## 4. See how your GraphQL API is operating
 
 You should now see operations information (RPM, error rate, queries performed) on your [GraphQL Hive dashboard](https://app.graphql-hive.com/):
 
@@ -86,7 +124,7 @@ You should now see operations information (RPM, error rate, queries performed) o
 <br/>
 
 
-## 4. Going further: use the Hive Github app
+## 5. Going further: use the Hive Github app
 
 Stay on top of your GraphQL Schema changes by installing the Hive Github Application and enabling Slack notifications about breaking changes:
 
@@ -117,6 +155,7 @@ class MySchema < GraphQL::Schema
       endpoint: 'app.graphql-hive.com',  # optional
       port: 80,  # optional
       buffer_size: 50, # forward the operations data to Hive every 50 requests
+      collect_usage_sampling: 1.0,
       reporting: {  # mandatory if `report_schema: true`
         # mandatory member of `reporting`
         author: 'Author of the latest change',

data/RELEASING.md

@@ -0,0 +1,10 @@
+## Releasing `graphql-hive` on RubyGems
+
+
+1. Ensure dependencies are properly installed: `bundle`
+1. Ensure the is working as expected: `bundle exec rspec`
+1. **Make sure to manually bump the version in `lib/graphql-hive/version.rb`**
+1. Build the gem: `gem build graphql-hive`
+1. A new file should have been created, ex: `graphql-hive-0.3.0.gem`
+1. Then, login to RubyGems: `gem login`
+1. And publish the new version: `gem publish <path_to_gem_file>` (ex: `gem publish graphql-hive-0.3.0.gem`)

data/k6/graphql-api/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    graphql-hive (0.1.3)
+    graphql-hive (0.3.1)
       graphql (~> 2.0.9)
 
 GEM

data/lib/graphql-hive/printer.rb

@@ -33,7 +33,13 @@ module GraphQL
       end
 
       def print_selections(selections, indent: '')
-        super(selections.sort_by(&:name), indent: indent)
+        sorted_nodes = selections.sort_by do |s|
+          next s.name if s.respond_to?(:name)
+          next s.type.name if s.respond_to?(:type)
+
+          raise "don't know how to sort selection node: #{s.inspect}"
+        end
+        super(sorted_nodes, indent: indent)
       end
 
       def print_directive(directive)

data/lib/graphql-hive/usage_reporter.rb

@@ -27,6 +27,31 @@ module GraphQL
 
         @options_mutex = Mutex.new
         @queue = Queue.new
+
+        start_thread
+      end
+
+      def add_operation(operation)
+        @queue.push(operation)
+      end
+
+      def on_exit
+        @queue.close
+        @thread.join
+      end
+
+      def on_start
+        start_thread
+      end
+
+      private
+
+      def start_thread
+        if @thread&.alive?
+          @options[:logger].warn('Tried to start operations flushing thread but it was already alive')
+          return
+        end
+
         @thread = Thread.new do
           buffer = []
           while (operation = @queue.pop(false))
@@ -44,20 +69,16 @@ module GraphQL
             @options[:logger].debug('shuting down with buffer, sending!')
             process_operations(buffer)
           end
-        end
-      end
+        rescue StandardError => e
+          # ensure configured logger receives exception as well in setups where STDERR might not be
+          # monitored.
+          @options[:logger].error('GraphQL Hive usage collection thread terminating')
+          @options[:logger].error(e)
 
-      def add_operation(operation)
-        @queue.push(operation)
-      end
-
-      def on_exit
-        @queue.close
-        @thread.join
+          raise e
+        end
       end
 
-      private
-
       def process_operations(operations)
         report = {
           size: 0,

data/lib/graphql-hive/version.rb

@@ -2,6 +2,6 @@
 
 module Graphql
   module Hive
-    VERSION = '0.2.0'
+    VERSION = '0.3.1'
   end
 end

data/lib/graphql-hive.rb

@@ -148,6 +148,10 @@ module GraphQL
       @usage_reporter.on_exit
     end
 
+    def on_start
+      @usage_reporter.on_start
+    end
+
     private
 
     def initialize_options!(options)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-hive
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Charly POLY
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-26 00:00:00.000000000 Z
+date: 2023-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -97,6 +97,7 @@ files:
 - Gemfile.lock
 - LICENSE
 - README.md
+- RELEASING.md
 - Rakefile
 - cover.png
 - examples/simple-api/Gemfile
@@ -141,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: '"GraphQL Hive integration for `graphql-ruby`"'