graphql-hive 0.1.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 734441600a775933bd1250151b0234b7b8293d4ee49e087a86f80684fe116e74
-  data.tar.gz: fe27f880db8cd0d75856fd8586363b6913f445feac2b7f7041a245eb03f49270
+  metadata.gz: be9427b081e7a486adf0537b3afa6e073c6c31eba88acae351589d0e1f708c87
+  data.tar.gz: de06ee85feb0ddd539a248534fdfe642aab8a8bb693f0cb66f0519f53ab95e11
 SHA512:
-  metadata.gz: 967bd101bad2140070d198d8b98ae92e4cb7a2716d4709c30b33862683ea35b7b3970c6c32f8727b57619698e7af43c039e79747d5f46a931ef345c2b44d54a7
-  data.tar.gz: 9013380ae8c596b015571cc05cf0430658d984ee548c9fb21cc3d423d2a3b7459c298816dc765c053f33a49e41318916d665fd77aa4c5eae0a76fc5d7c81f1f6
+  metadata.gz: eae35b3398dfbf84327efcca83c3ccc206e50698b64646359b6134143b516f2c50a51504cd6a8165ced58487b526d7c019aa95235cb2ba6132146e61e75694af
+  data.tar.gz: 96377bff1cf7c9f7e4e69847f68dc8143bc68702cfedfc6359f0147c16e534e660dcb871f3464a361ec082910a75db2b7ae8410cd6926a6df387ba0143c05cb4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    graphql-hive (0.1.4)
+    graphql-hive (0.3.0)
       graphql (~> 2.0.9)
 
 GEM
@@ -9,7 +9,7 @@ GEM
   specs:
     ast (2.4.2)
     diff-lcs (1.5.0)
-    graphql (2.0.9)
+    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/examples/simple-api/schema.rb

@@ -41,7 +41,7 @@ end
 class Schema < GraphQL::Schema
   query QueryType
 
-  use(GraphQL::Hive, { buffer_size: 2, token: 'c3715c1afab97070c5c5b9bce8d02c7b', debug: true, reporting: { author: 'Charly Poly', commit: '109bb1e748bae21bdfe663c0ffc7e830' }, client_info: proc { |context|
+  use(GraphQL::Hive, { buffer_size: 2, token: 'YOUR_TOKEN', debug: true, reporting: { author: 'Charly Poly', commit: '109bb1e748bae21bdfe663c0ffc7e830' }, client_info: proc { |context|
                                                                                                                                                                                                 { name: context[:client_name], version: context[:client_version] }
                                                                                                                                                                                               } })
 end

data/k6/graphql-api/Gemfile.lock

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

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))
@@ -47,17 +72,6 @@ module GraphQL
         end
       end
 
-      def add_operation(operation)
-        @queue.push(operation)
-      end
-
-      def on_exit
-        @queue.close
-        @thread.join
-      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.1.4'
+    VERSION = '0.3.0'
   end
 end

data/lib/graphql-hive.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'logger'
+require 'securerandom'
 
 require 'graphql-hive/version'
 require 'graphql-hive/usage_reporter'
@@ -57,7 +58,8 @@ module GraphQL
       read_operations: true,
       report_schema: true,
       buffer_size: 50,
-      logger: nil
+      logger: nil,
+      collect_usage_sampling: 1.0
     }.freeze
 
     self.platform_keys = {
@@ -114,7 +116,9 @@ module GraphQL
           elapsed = ending - starting
           duration = (elapsed.to_f * (10**9)).to_i
 
-          report_usage(timestamp, queries, results, duration) unless queries.empty?
+          # rubocop:disable Layout/LineLength
+          report_usage(timestamp, queries, results, duration) if !queries.empty? && SecureRandom.random_number <= @options[:collect_usage_sampling]
+          # rubocop:enable Layout/LineLength
 
           results
         else
@@ -144,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.1.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Charly POLY
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-28 00:00:00.000000000 Z
+date: 2023-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql