pgb_connection_reaper_rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 569b771b3f4350ebf2fd979525dbe1823bd008d094116056291a86d701cf9fdb
+  data.tar.gz: 29b698807ee595d91025dd69153df2df9397f725ef3219ceac33e5326e868b49
+SHA512:
+  metadata.gz: c9de9d77a18a19f314123b1d2810dfdda78fd2287f2c59b03e1e8050585ef7eb6ae6b43e80a9ebe47afa93bec301b699863aaa2457463e060aa5176408969744
+  data.tar.gz: a4c4d0208f843c30170be8e967051866eacb259f7d22e6cda80a3f2f1f83903733ed1c398c44b2c827eab29ef2d6f5d1ffcbaf2100e0eaa4fdaba993e675daea

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+Metrics/BlockLength:
+  Max: 100
+  Exclude:
+    - 'spec/**/*'
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.7
+before_install: gem install bundler -v 2.1.4

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 anton.borisov@fresha.com. 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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pgb_connection_reaper_rb.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    pgb_connection_reaper_rb (0.1.0)
+      activerecord (>= 4.2)
+      activesupport (>= 4.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.0.8.2)
+      activesupport (= 7.0.8.2)
+    activerecord (7.0.8.2)
+      activemodel (= 7.0.8.2)
+      activesupport (= 7.0.8.2)
+    activesupport (7.0.8.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    concurrent-ruby (1.2.3)
+    diff-lcs (1.5.0)
+    i18n (1.14.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.23.1)
+    rake (12.3.3)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pgb_connection_reaper_rb!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/Gemfile.test

@@ -0,0 +1,8 @@
+# Gemfile.test
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'sqlite3', '~> 1.6.3'
+gem 'rspec'
+gem 'activerecord', '~> 6.1'

data/Gemfile.test.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    pgb_connection_reaper_rb (0.1.0)
+      activerecord (>= 4.2)
+      activesupport (>= 4.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.1.7.8)
+      activesupport (= 6.1.7.8)
+    activerecord (6.1.7.8)
+      activemodel (= 6.1.7.8)
+      activesupport (= 6.1.7.8)
+    activesupport (6.1.7.8)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    concurrent-ruby (1.3.4)
+    diff-lcs (1.5.1)
+    i18n (1.14.6)
+      concurrent-ruby (~> 1.0)
+    mini_portile2 (2.8.7)
+    minitest (5.25.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.1)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    sqlite3 (1.6.9)
+      mini_portile2 (~> 2.8.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.6.18)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 6.1)
+  pgb_connection_reaper_rb!
+  rspec
+  sqlite3 (~> 1.6.3)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Anton Borisov
+
+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,55 @@
+# PgbConnectionReaperRb
+
+Gem created to handle K8S PGBouncer issue with gracefull shutdown by setting ttl on connections for PG adapter.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pgb_connection_reaper_rb'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install pgb_connection_reaper_rb
+
+## Usage
+
+* Install gem
+* specify config for ttl/idle_timeout in your config/database.yml
+  ```
+    production:
+      adapter: postgresql
+      database: your_database
+      username: your_username
+      password: your_password
+      host: your_host
+      port: 5432
+      pool: 5
+      ttl: 300 
+      idle_timeout: 300
+  ```    
+
+## 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]/pgb_connection_reaper_rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/pgb_connection_reaper_rb/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PgbConnectionReaperRb project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/pgb_connection_reaper_rb/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'pgb_connection_reaper_rb'
+
+# 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/lib/pgb_connection_reaper_rb/postgresql_adapter_extension.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module PgbConnectionReaperRb
+  module PostgreSQLAdapterExtension
+    def reconnect!
+      @lock.synchronize do
+        super
+        disconnect!
+        connect
+      end
+    end
+  end
+end

data/lib/pgb_connection_reaper_rb/railtie.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_record'
+
+module PgbConnectionReaperRb
+  class Railtie < Rails::Railtie
+    initializer 'pgb_connection_reaper_rb.configure_rails_initialization' do
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::ConnectionAdapters::AbstractAdapter.prepend PgbConnectionReaperRb::Reaper
+        ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.prepend PgbConnectionReaperRb::PostgreSQLAdapterExtension
+      end
+    end
+  end
+end

data/lib/pgb_connection_reaper_rb/reaper.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'concurrent'
+
+module PgbConnectionReaperRb
+  module Reaper
+    def initialize(*args)
+      super
+      @connected_at = Concurrent.monotonic_time
+      @pgb_ttl = self.class.type_cast_config_to_integer(@config.fetch(:pgb_ttl, nil))
+    end
+
+    attr_reader :connected_at, :pgb_ttl
+
+    def reconnect!(*args)
+      super(*args)
+      @connected_at = Concurrent.monotonic_time
+    end
+
+    def age
+      Concurrent.monotonic_time - @connected_at
+    end
+
+    def eligible?
+      pgb_ttl && age > pgb_ttl
+    end
+
+    def verify!(*args)
+      super(*args)
+      reconnect! if eligible?
+    end
+  end
+end

data/lib/pgb_connection_reaper_rb/version.rb

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

data/lib/pgb_connection_reaper_rb.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'pgb_connection_reaper_rb/version'
+require 'pgb_connection_reaper_rb/reaper'
+require 'pgb_connection_reaper_rb/postgresql_adapter_extension'
+require 'pgb_connection_reaper_rb/railtie' if defined?(Rails)
+
+module PgbConnectionReaperRb
+  class Error < StandardError; end
+end

data/pgb_connection_reaper_rb.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'lib/pgb_connection_reaper_rb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pgb_connection_reaper_rb'
+  spec.version       = PgbConnectionReaperRb::VERSION
+  spec.authors       = ['Anton Borisov']
+  spec.email         = ['anton.borisov@fresha.com']
+
+  spec.summary       = 'Gem for forcing cycling disconnections for Rails connections to PGBouncer'
+  spec.homepage      = 'https://github.com/surgeventures/pgb_connection_reaper_rb'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.5.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/surgeventures/pgb_connection_reaper_rb'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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.add_dependency 'activerecord', '>= 4.2'
+  spec.add_dependency 'activesupport', '>= 4.2'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: pgb_connection_reaper_rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anton Borisov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !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'
+description:
+email:
+- anton.borisov@fresha.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- Gemfile.test
+- Gemfile.test.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pgb_connection_reaper_rb.rb
+- lib/pgb_connection_reaper_rb/postgresql_adapter_extension.rb
+- lib/pgb_connection_reaper_rb/railtie.rb
+- lib/pgb_connection_reaper_rb/reaper.rb
+- lib/pgb_connection_reaper_rb/version.rb
+- pgb_connection_reaper_rb.gemspec
+homepage: https://github.com/surgeventures/pgb_connection_reaper_rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/surgeventures/pgb_connection_reaper_rb
+  source_code_uri: https://github.com/surgeventures/pgb_connection_reaper_rb
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Gem for forcing cycling disconnections for Rails connections to PGBouncer
+test_files: []