Improve User-Agent tracking (#31)

Author: mullermp

.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.3, 2.4, 2.5, 2.6, 2.7, '3.0', 3.1, 3.2, jruby-9.1, jruby-9.2, jruby-9.3, jruby-9.4]
+
+    steps:
+      - name: Setup
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - uses: actions/checkout@v2
+
+      - name: Install
+        run: bundle install --without docs
+
+      - name: Test
+        run: bundle exec rake spec

.gitignore

@@ -3,3 +3,4 @@ coverage
 .yardoc
 Gemfile.lock
 .release
+.idea/

CHANGELOG.md

@@ -1,6 +1,8 @@
 Unreleased Changes
 ------------------
 
+* Issue - Improve User-Agent tracking and bump minimum DynamoDB version.
+
 2.0.1 (2020-11-16)
 ------------------
 

Gemfile

@@ -13,4 +13,8 @@ group :test do
   gem 'rspec'
   gem 'simplecov', require: false
   gem 'rack-test'
+
+  if RUBY_VERSION >= '3.0'
+    gem 'rexml'
+  end
 end

aws-sessionstore-dynamodb.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'aws-sdk-dynamodb', '~> 1'
+  # Require 1.85.0 for user_agent_frameworks config
+  spec.add_dependency 'aws-sdk-dynamodb', '~> 1', '>= 1.85.0'
   spec.add_dependency 'rack', '~> 2'
 end

lib/aws/session_store/dynamo_db/configuration.rb

@@ -192,9 +192,9 @@ def to_hash
 
     # @return [Hash] DDB client.
     def gen_dynamo_db_client
-      client_opts = { user_agent_suffix: " aws-sessionstore/#{VERSION}" }
-      client = Aws::DynamoDB::Client
-      dynamo_db_client = @options[:dynamo_db_client] || client.new(client_opts)
+      dynamo_db_client = @options[:dynamo_db_client] || Aws::DynamoDB::Client.new
+      # this used to be aws-sessionstore/version on user_agent_suffix
+      dynamo_db_client.config.user_agent_frameworks << "aws-sessionstore-dynamodb"
       {:dynamo_db_client => dynamo_db_client}
     end
 

spec/aws/session_store/dynamo_db/error/default_error_handler_spec.rb

@@ -26,7 +26,7 @@
 
   let(:base_app) { MultiplierApplication.new }
   let(:app) { Aws::SessionStore::DynamoDB::RackMiddleware.new(base_app, @options) }
-  let(:client) { double('Aws::DynamoDB::Client') }
+  let(:client) { double('Aws::DynamoDB::Client', config: double(user_agent_frameworks: [])) }
 
   context 'Error handling for Rack Middleware with default error handler' do
     it 'raises error for missing secret key' do

spec/aws/session_store/dynamo_db/garbage_collection_spec.rb

@@ -124,9 +124,9 @@ def collect_garbage
       expect(dynamo_db_client).to receive(:scan).
         exactly(1).times.and_return(scan_resp3)
       expect(dynamo_db_client).to receive(:batch_write_item).ordered.
-        with(request_items: { 'sessions' => format_scan_result }).
+        with({request_items: { 'sessions' => format_scan_result }}).
         and_return(write_resp2)
-      expect(dynamo_db_client).to receive(:batch_write_item).ordered.with(
+      expect(dynamo_db_client).to receive(:batch_write_item).ordered.with({
         request_items: {
           'sessions' => [
             {
@@ -151,7 +151,7 @@ def collect_garbage
             }
           ]
         }
-      ).and_return(write_resp1)
+      }).and_return(write_resp1)
       collect_garbage
     end
   end

spec/aws/session_store/dynamo_db/rack_middleware_spec.rb

@@ -53,7 +53,8 @@ def ensure_data_updated(mutated_data)
             delete_item: 'Deleted',
             list_tables: { table_names: ['Sessions'] },
             get_item: { item: { 'data' => sample_packed_data } },
-            update_item: { attributes: { created_at: 'now' } }
+            update_item: { attributes: { created_at: 'now' } },
+            config: double(user_agent_frameworks: [])
           )
         end