mysql_framework 2.1.9 → 2.3.0

data/spec/lib/mysql_framework/stats/aws_metric_publisher_spec.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'mysql_framework/stats/aws_metric_publisher'
+
+describe MysqlFramework::Stats::AwsMetricPublisher do
+  let(:connection_pool) { instance_double(MysqlFramework::MysqlConnectionPool, pool_stats: stats) }
+  let(:connector) { instance_double(MysqlFramework::Connector, connection_pool: connection_pool) }
+  let(:stats) { { size: 5, available: 3, idle: 2 } }
+  let(:dimensions) do
+    [
+      { name: 'ServiceName', value: 'mysql-framework' },
+      { name: 'Environment', value: 'test' }
+    ]
+  end
+  let(:dimension_map) do
+    instance_double(
+      MysqlFramework::Stats::DimensionMap,
+      namespace: 'MysqlFramework',
+      to_cloudwatch_dimensions: dimensions
+    )
+  end
+  let(:cloudwatch_client) { instance_double(Aws::CloudWatch::Client) }
+  let(:logger) { instance_double(Logger, debug: nil, error: nil) }
+
+  subject(:reporter) do
+    described_class.new(
+      connector: connector,
+      dimension_map: dimension_map,
+      cloudwatch_client: cloudwatch_client,
+      publish_interval: 1
+    )
+  end
+
+  before do
+    allow(MysqlFramework).to receive(:logger).and_return(logger)
+    allow(ENV).to receive(:fetch).and_call_original
+  end
+
+  describe '#sample' do
+    it 'publishes connector pool stats to CloudWatch' do
+      expect(cloudwatch_client).to receive(:put_metric_data) do |payload|
+        expect(payload[:namespace]).to eq('MysqlFramework')
+        expect(payload[:metric_data].size).to eq(3)
+
+        size_metric = payload[:metric_data].find { |metric| metric[:metric_name] == 'MysqlConnectionPoolSize' }
+        available_metric = payload[:metric_data].find { |metric| metric[:metric_name] == 'MysqlConnectionPoolAvailable' }
+        idle_metric = payload[:metric_data].find { |metric| metric[:metric_name] == 'MysqlConnectionPoolIdle' }
+
+        expect(size_metric[:value]).to eq(5.0)
+        expect(available_metric[:value]).to eq(3.0)
+        expect(idle_metric[:value]).to eq(2.0)
+        expect(size_metric[:dimensions]).to eq(dimensions)
+        expect(size_metric[:unit]).to eq('Count')
+      end
+
+      reporter.send(:sample)
+    end
+
+    it 'does not publish when connector is nil' do
+      subject = described_class.new(
+        connector: nil,
+        dimension_map: dimension_map,
+        cloudwatch_client: cloudwatch_client
+      )
+
+      expect(cloudwatch_client).not_to receive(:put_metric_data)
+
+      subject.send(:sample)
+    end
+
+    it 'logs an error when cloudwatch publish raises' do
+      allow(cloudwatch_client).to receive(:put_metric_data).and_raise(StandardError, 'aws unavailable')
+      expect(logger).to receive(:error)
+
+      reporter.send(:sample)
+    end
+  end
+
+  describe '#build_metric_data' do
+    it 'skips nil values in stats map' do
+      data = reporter.send(:build_metric_data, size: 1, available: nil, idle: 0)
+
+      expect(data.size).to eq(2)
+      names = data.map { |metric| metric[:metric_name] }
+      expect(names).to contain_exactly('MysqlConnectionPoolSize', 'MysqlConnectionPoolIdle')
+    end
+  end
+end

data/spec/support/fixtures.rb

@@ -39,6 +39,16 @@ module MysqlFramework
         SQL
 
         connector.check_in(client)
+        connector.dispose
+
+        connector = MysqlFramework::Connector.new(
+          host: ENV.fetch('MYSQL_HOST'),
+          port: ENV.fetch('MYSQL_PORT'),
+          database: ENV.fetch('MYSQL_DATABASE'),
+          username: ENV.fetch('MYSQL_USERNAME'),
+          password: ENV.fetch('MYSQL_PASSWORD')
+        )
+        connector.setup
 
         manager = MysqlFramework::Scripts::Manager.new(connector)
         manager.execute

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mysql_framework
 version: !ruby/object:Gem::Version
-  version: 2.1.9
+  version: 2.3.0
 platform: ruby
 authors:
 - Sage
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-13 00:00:00.000000000 Z
+date: 2026-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +52,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-cloudwatch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: redlock
   requirement: !ruby/object:Gem::Requirement
@@ -91,6 +119,7 @@ files:
 - lib/mysql_framework/connector.rb
 - lib/mysql_framework/in_condition.rb
 - lib/mysql_framework/logger.rb
+- lib/mysql_framework/mysql_connection_pool.rb
 - lib/mysql_framework/scripts.rb
 - lib/mysql_framework/scripts/base.rb
 - lib/mysql_framework/scripts/lock_manager.rb
@@ -100,9 +129,12 @@ files:
 - lib/mysql_framework/sql_condition.rb
 - lib/mysql_framework/sql_query.rb
 - lib/mysql_framework/sql_table.rb
+- lib/mysql_framework/stats/aws_metric_publisher.rb
+- lib/mysql_framework/stats/dimension_map.rb
 - lib/mysql_framework/version.rb
 - spec/lib/mysql_framework/connector_spec.rb
 - spec/lib/mysql_framework/logger_spec.rb
+- spec/lib/mysql_framework/mysql_connection_pool_spec.rb
 - spec/lib/mysql_framework/scripts/base_spec.rb
 - spec/lib/mysql_framework/scripts/lock_manager_spec.rb
 - spec/lib/mysql_framework/scripts/manager_spec.rb
@@ -110,6 +142,7 @@ files:
 - spec/lib/mysql_framework/sql_condition_spec.rb
 - spec/lib/mysql_framework/sql_query_spec.rb
 - spec/lib/mysql_framework/sql_table_spec.rb
+- spec/lib/mysql_framework/stats/aws_metric_publisher_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixtures.rb
 - spec/support/procedure.sql
@@ -122,7 +155,7 @@ homepage: https://github.com/sage/mysql_framework
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -137,8 +170,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
-signing_key: 
+rubygems_version: 3.4.20
+signing_key:
 specification_version: 4
 summary: A lightweight framework to provide managers for working with MySQL.
 test_files: []