grpc_fork_safety 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cf32a7caf75ba7c10da05f6a07eb4fb071d8d1242947be0006d7c80d0789542e
+  data.tar.gz: d999967eb9c841a40ea919f507ed9e2c5eaaf17909ca6614ffe5686317b2bc25
+SHA512:
+  metadata.gz: 630e682ecaaf7352ae3a7db2db4e3768f348e52fa06ed1d906743ae07caced67af02ec0d231846ea6016983bbe0dff3cb52f065da389c89c0ee8908c6ac2a573
+  data.tar.gz: 2f9c820ab4004b05dd5f752ca02557e3e92818dcbd959fe067758203d37dc4b10da04bd76070de1da298fb5ae9cc6507bd611a2830e65c3758f56253f29385df

data/.rubocop.yml

@@ -0,0 +1,28 @@
+AllCops:
+  TargetRubyVersion: 3.1
+  SuggestExtensions: false
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.3.3

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-07-24
+
+- Initial release

data/README.md

@@ -0,0 +1,59 @@
+# GrpcForkSafety
+
+Small gem that makes it easier to use the `grpc` gem in a fork safe way.
+
+## Installation
+
+Add the gem to your gemfile **before the `grpc` gem, or any gem that depend on `grpc`:
+
+```ruby
+gem "grpc_fork_safety"
+gem "grpc"
+gem "some-gem-that-depend-on-grpc"
+```
+
+## Usage
+
+There isn't anything particular to do, the gem will hook itself into Ruby and properly call the GRPC fork hooks when needed.
+
+### `keep_disabled!`
+
+However, when a process will need to fork repeatedly and won't need to use GRPC, you can optimize by calling `GrpcForkSafety.keep_disabled!`.
+`grpc` will be enabled again in child process, but stay shutdown in the current process. This is useful for the main process of Puma or Unicorn
+and for the mold process of Pitchfork, e.g.
+
+```ruby
+before_fork do
+  GrpcForkSafety.keep_disabled!
+end
+```
+
+If for some reason you need to undo this, you can call `GrpcForkSafety.reenable!`
+
+### Hooks
+
+You can also register hooks to be called before GRPC is disabled and after it's re-enabled:
+
+```ruby
+GrpcForkSafety.before_disable do
+  ThreadPool.shutdown
+end
+
+GrpcForkSafety.after_enable do |in_child|
+  unless in_child
+    ThreadPool.start
+  end
+end
+```
+
+Typically if you have background threads using GRPC, you should make sure to shut them down in `before_disable`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 the created tag, 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/Shopify/grpc_fork_safety.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/grpc_fork_safety/init.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "version"
+
+if defined? GRPC::Core # ::GRPC may be loaded by bundler from `grpc.gemspec` so we check `GRPC::Core`
+  raise <<~ERROR
+    GRPC was loaded before `grpc_fork_safety` preventing to enable fork support
+
+    You may need to set `require: false` in your Gemfile where `grpc` is listed or
+    move `gem "grpc_fork_safety"` before `gem "grpc"`in your Gemfile.
+  ERROR
+end
+
+ENV["GRPC_ENABLE_FORK_SUPPORT"] = "1"
+require "grpc"

data/lib/grpc_fork_safety/no_patch.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require "grpc_fork_safety/init"
+
+module GrpcForkSafety
+  Error = Class.new(StandardError)
+
+  class LifeCycle
+    def initialize(grpc = ::GRPC, process = ::Process)
+      @grpc = grpc
+      @process = process
+      @shutdown_by = nil
+      @keep_disabled = false
+      @before_disable = []
+      @after_enable = []
+    end
+
+    def before_disable(&block)
+      raise Error, "No block given" unless block_given?
+
+      @before_disable << block
+    end
+
+    def after_enable(&block)
+      raise Error, "No block given" unless block_given?
+
+      @after_enable << block
+    end
+
+    def keep_disabled!
+      return if @keep_disabled
+
+      @keep_disabled = true
+      before_fork
+    end
+
+    def keep_disabled?
+      @keep_disabled
+    end
+
+    def reenable!
+      return unless @keep_disabled
+
+      @keep_disabled = false
+      after_fork
+    end
+
+    def before_fork
+      return if @shutdown_by
+
+      @before_disable.each(&:call)
+
+      @grpc.prefork
+      @shutdown_by = @process.pid
+    end
+
+    def after_fork
+      if @shutdown_by.nil?
+        # noop
+      elsif @shutdown_by == @process.pid # In parent
+        unless @keep_disabled
+          @grpc.postfork_parent
+          @shutdown_by = nil
+
+          @after_enable.each do |cb|
+            cb.call(false)
+          end
+        end
+      else
+        @keep_disabled = false
+        @shutdown_by = nil
+        @grpc.postfork_child
+        @after_enable.each do |cb|
+          cb.call(true)
+        end
+      end
+    end
+  end
+
+  class NoopLifeCycle
+    def initialize
+      @keep_disabled = false
+    end
+
+    def keep_disabled!
+      @keep_disabled = true
+    end
+
+    def keep_disabled?
+      @keep_disabled
+    end
+
+    def reenable!
+      @keep_disabled = false
+    end
+
+    def before_fork; end
+
+    def after_fork; end
+
+    def before_disable; end
+
+    def after_enable; end
+  end
+
+  GRPC_FORK_SUPPORT = RUBY_PLATFORM.match?(/linux/i)
+
+  @lifecycle = if GRPC_FORK_SUPPORT
+                 LifeCycle.new
+               else
+                 NoopLifeCycle.new
+               end
+
+  class << self
+    def keep_disabled!
+      @lifecycle.keep_disabled!
+    end
+
+    def reenable!
+      @lifecycle.keep_disabled = false
+      @lifecycle.after_fork
+    end
+
+    def before_disable(&)
+      @lifecycle.before_disable(&)
+    end
+
+    def after_enable(&)
+      @lifecycle.after_enable(&)
+    end
+
+    def _before_fork_hook
+      @lifecycle.before_fork
+    end
+
+    def _after_fork_hook
+      @lifecycle.after_fork
+    end
+  end
+end

data/lib/grpc_fork_safety/patch.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "grpc_fork_safety/no_patch"
+
+module GrpcForkSafety
+  module ProcessExtension
+    def _fork
+      GrpcForkSafety._before_fork_hook
+      pid = super
+      GrpcForkSafety._after_fork_hook
+      pid
+    end
+  end
+
+  class << self
+    def patch!
+      ::Process.singleton_class.prepend(ProcessExtension)
+    end
+  end
+end

data/lib/grpc_fork_safety/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GrpcForkSafety
+  VERSION = "0.1.0"
+end

data/lib/grpc_fork_safety.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "grpc_fork_safety/patch"
+
+GrpcForkSafety.patch!

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: grpc_fork_safety
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jean Boussier
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grpc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.57.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.57.0
+description:
+email:
+- jean.boussier@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- lib/grpc_fork_safety.rb
+- lib/grpc_fork_safety/init.rb
+- lib/grpc_fork_safety/no_patch.rb
+- lib/grpc_fork_safety/patch.rb
+- lib/grpc_fork_safety/version.rb
+homepage: https://github.com/Shopify/grpc_fork_safety
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/Shopify/grpc_fork_safety
+  source_code_uri: https://github.com/Shopify/grpc_fork_safety
+  changelog_uri: https://github.com/Shopify/grpc_fork_safety/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Simple gems to facilitate making the grpc gem fork safe
+test_files: []