pg-locks-monitor 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c15914dcf0512070ba0f629249a9743c04aad078d6f7dcd23a96acda248284f4
-  data.tar.gz: bbf242ededb3f441489be230e5e013d362c85b0964f34667a89b9ffe12589aa0
+  metadata.gz: a3bd2f4561c83a6d10a0120670bb89f8140f01f3afad7434fbea969e113cc542
+  data.tar.gz: 2fdb6e38890f1b085a32e72fee4d32eeb4e77e6a1f865737b2f3541d76d333ad
 SHA512:
-  metadata.gz: c17edd2b3419837fd7e6f909ba8f7bf2878a28df97f0f80f0a2a12e5534188895d44f3897372445267ff8d524f1b1825d09c4a77b29ad8a991dedd4b71ba4dfb
-  data.tar.gz: a876c3894b680a8cc20bb29070d1e9dc8af6678cd09ed6293501ede52eecae134ddfb48b37d7441676f9a9f4499f8b0f2eba46108b963da19ebf8f6ef78992ee
+  metadata.gz: 1396e94b66ae62db3ee552855cfe8b2e7d10c5efdf87f323bc889c8fb17530cf9076e6239f2dc9713907f28ddbb5de602f4baa507b38621419534be545be83c6
+  data.tar.gz: a9bafef4918812b931737a0096cd2096181512e6eb5b35585b4e5caf50d7230f1dca4b8b2a37eeac7b521968577cf915cd97bff1f79b757dc909b5d1a4eb4f18

data/.github/workflows/ci.yml

@@ -48,7 +48,15 @@ jobs:
           docker run --env POSTGRES_USER=postgres \
             --env POSTGRES_DB=pg-locks-monitor-test \
             --env POSTGRES_PASSWORD=secret \
-            -d -p 5436:5432 postgres:15.1-alpine \
+            -d -p 5436:5432 postgres:15.8-alpine \
+            postgres -c shared_preload_libraries=pg_stat_statements
+          sleep 15
+      - name: Run PostgreSQL 16
+        run: |
+          docker run --env POSTGRES_USER=postgres \
+            --env POSTGRES_DB=pg-locks-monitor-test \
+            --env POSTGRES_PASSWORD=secret \
+            -d -p 5437:5432 postgres:16.4-alpine \
             postgres -c shared_preload_libraries=pg_stat_statements
           sleep 15
       - name: Set up Ruby ${{ matrix.ruby-version }}
@@ -73,17 +81,7 @@ jobs:
           POSTGRES_PASSWORD: secret
           DATABASE_URL: postgresql://postgres:secret@localhost:5432/pg-locks-monitor-test
         run: |
-          bundle exec rspec spec/
-      - name: Run tests for PG 11
-        env:
-          PG_VERSION: 11
-          POSTGRES_HOST: localhost
-          POSTGRES_USER: postgres
-          POSTGRES_DB: pg-locks-monitor-test
-          POSTGRES_PASSWORD: secret
-          DATABASE_URL: postgresql://postgres:secret@localhost:5432/pg-locks-monitor-test
-        run: |
-          bundle exec rake test_all
+          bundle exec rspec spec
       - name: Run tests for PG 12
         env:
           PG_VERSION: 12
@@ -93,7 +91,7 @@ jobs:
           POSTGRES_PASSWORD: secret
           DATABASE_URL: postgresql://postgres:secret@localhost:5433/pg-locks-monitor-test
         run: |
-          bundle exec rake test_all
+          bundle exec rspec spec
       - name: Run tests for PG 13
         env:
           PG_VERSION: 13
@@ -103,7 +101,7 @@ jobs:
           POSTGRES_PASSWORD: secret
           DATABASE_URL: postgresql://postgres:secret@localhost:5434/pg-locks-monitor-test
         run: |
-          bundle exec rake test_all
+          bundle exec rspec spec
       - name: Run tests for PG 14
         env:
           PG_VERSION: 14
@@ -113,7 +111,7 @@ jobs:
           POSTGRES_PASSWORD: secret
           DATABASE_URL: postgresql://postgres:secret@localhost:5435/pg-locks-monitor-test
         run: |
-          bundle exec rake test_all
+          bundle exec rspec spec
       - name: Run tests for PG 15
         env:
           PG_VERSION: 15
@@ -123,5 +121,17 @@ jobs:
           POSTGRES_PASSWORD: secret
           DATABASE_URL: postgresql://postgres:secret@localhost:5436/pg-locks-monitor-test
         run: |
-          bundle exec rake test_all
+          bundle exec rspec spec
+      - name: Run tests for PG 16
+        env:
+          PG_VERSION: 15
+          POSTGRES_HOST: localhost
+          POSTGRES_USER: postgres
+          POSTGRES_DB: pg-locks-monitor-test
+          POSTGRES_PASSWORD: secret
+          DATABASE_URL: postgresql://postgres:secret@localhost:5437/pg-locks-monitor-test
+        run: |
+          bundle exec rspec spec
+
+
 

data/Rakefile

@@ -5,5 +5,5 @@ RSpec::Core::RakeTask.new(:spec)
 
 desc "Test all PG versions"
 task :test_all do
-  system("PG_VERSION=11 bundle exec rspec spec/ && PG_VERSION=12 bundle exec rspec spec/ && PG_VERSION=13 bundle exec rspec spec/ && PG_VERSION=14 bundle exec rspec spec/")
+  system("PG_VERSION=11 bundle exec rspec spec && PG_VERSION=12 bundle exec rspec spec && PG_VERSION=13 bundle exec rspec spec && PG_VERSION=14 bundle exec rspec spec && PG_VERSION=16 bundle exec rspec spec && PG_VERSION=16 bundle exec rspec spec")
 end

data/docker-compose.yml.sample

@@ -1,5 +1,3 @@
-version: '3'
-
 services:
   postgres11:
     image: postgres:11.16-alpine

data/lib/pg-locks-monitor.rb

@@ -2,6 +2,7 @@
 
 require "uri"
 require "pg"
+require "ruby-pg-extras"
 
 module PgLocksMonitor
   def self.snapshot!
@@ -9,23 +10,28 @@ module PgLocksMonitor
       in_format: :hash,
     ).select do |lock|
       if (age = lock.fetch("age"))
-        (ActiveSupport::Duration.parse(age).to_f * 1000) > configuration.locks_min_duration_ms
+        DurationHelper.parse_to_ms(age) > configuration.locks_min_duration_ms
       end
     end.select(&configuration.locks_filter_proc)
       .first(configuration.locks_limit)
 
-    if locks.present? && configuration.monitor_locks
+    if locks.count > 0 && configuration.monitor_locks
       configuration.notifier_class.call(locks)
     end
 
     blocking = RubyPgExtras.blocking(in_format: :hash).select do |block|
-      (ActiveSupport::Duration.parse(block.fetch("blocking_duration")).to_f * 1000) > configuration.blocking_min_duration_ms
+      DurationHelper.parse_to_ms(block.fetch("blocking_duration")) > configuration.blocking_min_duration_ms
     end.select(&configuration.blocking_filter_proc)
       .first(configuration.locks_limit)
 
-    if blocking.present? && configuration.monitor_blocking
+    if blocking.count > 0 && configuration.monitor_blocking
       configuration.notifier_class.call(blocking)
     end
+
+    {
+      locks: locks,
+      blocking: blocking,
+    }
   end
 
   def self.configuration
@@ -35,6 +41,22 @@ module PgLocksMonitor
   def self.configure
     yield(configuration)
   end
+
+  class DurationHelper
+    require "date"
+
+    def self.parse_to_ms(duration_str)
+      time = DateTime.strptime(duration_str, "%H:%M:%S.%N")
+      hours = time.hour
+      minutes = time.minute
+      seconds = time.second
+      nanoseconds = time.second_fraction * (10 ** 9)
+
+      total_ms = (hours * 3600 * 1000) + (minutes * 60 * 1000) + (seconds * 1000) + (nanoseconds / 1_000_000).to_i
+
+      total_ms
+    end
+  end
 end
 
 require "pg_locks_monitor/default_notifier"

data/lib/pg_locks_monitor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PgLocksMonitor
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/spec/default_notifier_spec.rb

@@ -3,14 +3,6 @@
 require "spec_helper"
 
 describe PgLocksMonitor::DefaultNotifier do
-  before do
-    # Mock Rails and its logger
-    Rails = nil
-    logger_double = double("Logger")
-    allow(logger_double).to receive(:info)
-    allow(Rails).to receive(:logger).and_return(logger_double)
-  end
-
   it "requires correct config if Slack notifications enabled" do
     expect {
       PgLocksMonitor::DefaultNotifier.call({})
@@ -24,14 +16,26 @@ describe PgLocksMonitor::DefaultNotifier do
     }.to raise_error(RuntimeError)
   end
 
-  it "sends the Slack notification if enabled" do
-    PgLocksMonitor.configure do |config|
-      config.notify_slack = true
-      config.slack_webhook_url = "https://hooks.slack.com/services/123456789/123456789/123456789"
-      config.slack_channel = "pg-locks-monitor"
+  describe "Slack notification enabled" do
+    before do
+      PgLocksMonitor.configure do |config|
+        config.notify_slack = true
+        config.slack_webhook_url = "https://hooks.slack.com/services/123456789/123456789/123456789"
+        config.slack_channel = "pg-locks-monitor"
+      end
     end
 
-    expect_any_instance_of(Slack::Notifier).to receive(:ping)
-    PgLocksMonitor::DefaultNotifier.call({ locks: "data" })
+    after do
+      PgLocksMonitor.configure do |config|
+        config.notify_slack = false
+        config.slack_webhook_url = nil
+        config.slack_channel = nil
+      end
+    end
+
+    it "sends the Slack notification" do
+      expect_any_instance_of(Slack::Notifier).to receive(:ping)
+      PgLocksMonitor::DefaultNotifier.call({ locks: "data" })
+    end
   end
 end

data/spec/smoke_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe PgLocksMonitor do
+  def spawn_update
+    Thread.new do
+      conn = PG.connect(ENV["DATABASE_URL"])
+      conn.exec("
+        BEGIN;
+        UPDATE pg_locks_monitor_users SET name = 'Updated';
+        select pg_sleep(2);
+        COMMIT;
+        ")
+    end
+  end
+
+  describe "snapshot!" do
+    it "works" do
+      expect {
+        PgLocksMonitor.snapshot!
+      }.not_to raise_error
+    end
+
+    it "returns correct locks data" do
+      spawn_update
+      spawn_update
+      sleep 1
+
+      result = PgLocksMonitor.snapshot!
+      expect(result.fetch(:locks).count).to eq(5)
+      expect(result.fetch(:blocking).count).to eq(1)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -14,8 +14,35 @@ port = if pg_version == "11"
     "5434"
   elsif pg_version == "14"
     "5435"
+  elsif pg_version == "15"
+    "5436"
+  elsif pg_version == "16"
+    "5437"
   else
     "5432"
   end
 
 ENV["DATABASE_URL"] ||= "postgresql://postgres:secret@localhost:#{port}/pg-locks-monitor-test"
+
+RSpec.configure do |config|
+  Rails = {}
+
+  config.before(:each) do
+    # Mock Rails and its logger
+    logger_double = double("Logger")
+    allow(logger_double).to receive(:info)
+    allow(Rails).to receive(:logger).and_return(logger_double)
+  end
+
+  config.before(:suite) do
+    conn = RubyPgExtras.connection
+    conn.exec("CREATE TABLE IF NOT EXISTS pg_locks_monitor_users (id SERIAL PRIMARY KEY, name VARCHAR(255) NOT NULL);")
+    conn.exec("INSERT INTO pg_locks_monitor_users (name) VALUES ('Alice');")
+    conn.exec("INSERT INTO pg_locks_monitor_users (name) VALUES ('Bob');")
+  end
+
+  config.after(:suite) do
+    conn = RubyPgExtras.connection
+    conn.exec("DROP TABLE IF EXISTS pg_locks_monitor_users;")
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pg-locks-monitor
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - pawurb
@@ -105,6 +105,7 @@ files:
 - pg-locks-monitor.gemspec
 - spec/configuration_spec.rb
 - spec/default_notifier_spec.rb
+- spec/smoke_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/pawurb/pg-locks-monitor
 licenses:
@@ -133,4 +134,5 @@ summary: Observe PostgreSQL database locks obtained by a Rails application.
 test_files:
 - spec/configuration_spec.rb
 - spec/default_notifier_spec.rb
+- spec/smoke_spec.rb
 - spec/spec_helper.rb