rails_api_logger 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fda8a1c76ae8f88f8753f6a24b0e794031f2fe699cf517b2bdc0dc4a9492047
-  data.tar.gz: 6435707109046e2f3444290e8f1c18381a2bbd3b9558602198752c077de3f7ed
+  metadata.gz: 4959094cde8a80515bac5d15b4bd4f475e7c723b94803a2ecdc00de59aba1995
+  data.tar.gz: 283881fcb6952b5ffab21a816558f8c6ef9c705252d25f183a261e614317db3b
 SHA512:
-  metadata.gz: d8660e1388c86679bc3be3004049b783e96eef9bf18c6c61fb4d885fdd9cf4f2408bb131adf35193652687a3f37b2a7411e3e7953eb919fc468ab99a165e147c
-  data.tar.gz: 53bbe981627e011159acaf23468f1b1bf00b6171ae9f50fc6d577d3461937a871e9955f29e391fdb38027902fd6db42a6a9b20614d6da21d50bacbf0bb2cc980
+  metadata.gz: 1d727ed904aff3668f16d2bdfdedee5576b30c53819911303f7df0723608344fbe9c30eb7e313cde7c2ca6d33e832c9ac4073baa065331f2cb9e11276975e3f8
+  data.tar.gz: e76f28822d9646a1973f4fb75612c52a0ed0d18d089ae27e9eccc5ac5f1313ee58e5236564b086246a17d6f158d4616a29ebc1419e25484a7a6cb73021529629

data/.gitignore

@@ -9,6 +9,8 @@
 /spec/dummy/log
 /spec/dummy/tmp
 /spec/dummy/db/*.sqlite3*
+/spec/dummy/db/schema.rb
+/spec/dummy/db/api_logger_schema.rb
 .env
 
 # rspec failure tracking

data/.semaphore/semaphore.yml

@@ -23,61 +23,140 @@ blocks:
           - bundle install -j 4
 
           - cache store
+      env_vars:
+        - name: BUNDLE_GEMFILE
+          value: /home/semaphore/rails_api_logger/gemfiles/rails_8.0.gemfile
       jobs:
         - name: linter
           commands:
             - bundle exec standardrb
-        - name: tests sqlite separate db
+        - name: tests postgres separate db and separate target
           env_vars:
+            - name: SAME_DB
+              value: "false"
+            - name: SAME_TARGET
+              value: "false"
             - name: TARGET_DB
-              value: sqlite
+              value: postgres
             - name: RAILS_ENV
               value: test
           commands:
+            - sem-service start postgres 14
+            - bin/rails db:create db:migrate
             - bundle exec rspec
-        - name: tests postgres separate db
+        - name: tests postgres separate db and same target
           env_vars:
+            - name: SAME_DB
+              value: "false"
+            - name: SAME_TARGET
+              value: "true"
             - name: TARGET_DB
               value: postgres
             - name: RAILS_ENV
               value: test
           commands:
             - sem-service start postgres 14
-            - bin/rails db:create db:schema:load
+            - bin/rails db:create db:migrate
             - bundle exec rspec
-        - name: tests sqlite same db
+        - name: tests postgres same db and separate target
           env_vars:
             - name: SAME_DB
               value: "true"
             - name: TARGET_DB
-              value: sqlite
+              value: postgres
             - name: RAILS_ENV
               value: test
           commands:
+            - sem-service start postgres 14
+            - bin/rails db:create db:migrate
             - bundle exec rspec
-        - name: tests postgres same db
+        - name: tests postgres separate db and separate target | rails 6.1
           env_vars:
             - name: SAME_DB
-              value: "true"
+              value: "false"
+            - name: SAME_TARGET
+              value: "false"
             - name: TARGET_DB
               value: postgres
             - name: RAILS_ENV
               value: test
+            - name: BUNDLE_GEMFILE
+              value: /home/semaphore/rails_api_logger/gemfiles/rails_6.1.gemfile
           commands:
             - sem-service start postgres 14
-            - bin/rails db:create db:schema:load
+            - bin/rails db:create db:migrate
             - bundle exec rspec
-        - name: tests postgres same target
+        - name: tests postgres separate db and separate target | rails 7.0
           env_vars:
+            - name: SAME_DB
+              value: "false"
             - name: SAME_TARGET
-              value: "true"
+              value: "false"
+            - name: TARGET_DB
+              value: postgres
+            - name: RAILS_ENV
+              value: test
+            - name: BUNDLE_GEMFILE
+              value: /home/semaphore/rails_api_logger/gemfiles/rails_7.0.gemfile
+          commands:
+            - sem-service start postgres 14
+            - bin/rails db:create db:migrate
+            - bundle exec rspec
+        - name: tests postgres separate db and separate target | rails 7.1
+          env_vars:
+            - name: SAME_DB
+              value: "false"
+            - name: SAME_TARGET
+              value: "false"
             - name: TARGET_DB
               value: postgres
             - name: RAILS_ENV
               value: test
+            - name: BUNDLE_GEMFILE
+              value: /home/semaphore/rails_api_logger/gemfiles/rails_7.1.gemfile
           commands:
             - sem-service start postgres 14
-            - bin/rails db:create db:schema:load
+            - bin/rails db:create db:migrate
+            - bundle exec rspec
+        - name: tests postgres separate db and separate target | rails 7.2
+          env_vars:
+            - name: SAME_DB
+              value: "false"
+            - name: SAME_TARGET
+              value: "false"
+            - name: TARGET_DB
+              value: postgres
+            - name: RAILS_ENV
+              value: test
+            - name: BUNDLE_GEMFILE
+              value: /home/semaphore/rails_api_logger/gemfiles/rails_7.2.gemfile
+          commands:
+            - sem-service start postgres 14
+            - bin/rails db:create db:migrate
+            - bundle exec rspec
+        - name: tests sqlite separate db and separate target
+          env_vars:
+            - name: SAME_DB
+              value: "false"
+            - name: SAME_TARGET
+              value: "false"
+            - name: TARGET_DB
+              value: sqlite
+            - name: RAILS_ENV
+              value: test
+          commands:
+            - bin/rails db:create db:migrate
+            - bundle exec rspec
+        - name: tests sqlite same db
+          env_vars:
+            - name: SAME_DB
+              value: "true"
+            - name: TARGET_DB
+              value: sqlite
+            - name: RAILS_ENV
+              value: test
+          commands:
+            - bin/rails db:create db:migrate
             - bundle exec rspec
 promotions:
   - name: main

data/.standard.yml

@@ -0,0 +1,2 @@
+ignore:
+  - 'gemfiles/**/*'

data/Appraisals

@@ -0,0 +1,31 @@
+appraise "rails-6.1" do
+  gem "concurrent-ruby", "1.3.4"
+  gem "rails", "~> 6.1.0"
+  gem "rspec-rails", "~> 6.1.0"
+  gem "sqlite3", "~> 1.7.3"
+end
+
+appraise "rails-7.0" do
+  gem "concurrent-ruby", "1.3.4"
+  gem "rails", "~> 7.0.0"
+  gem "rspec-rails", "~> 7.1.0"
+  gem "sqlite3", "~> 1.7.3"
+end
+
+appraise "rails-7.1" do
+  gem "rails", "~> 7.1.0"
+  gem "rspec-rails", "~> 7.1.0"
+  gem "sqlite3", "~> 1.7.3"
+end
+
+appraise "rails-7.2" do
+  gem "rails", "~> 7.2.0"
+  gem "rspec-rails", "~> 7.1.0"
+  gem "sqlite3", "~> 1.7.3"
+end
+
+appraise "rails-8.0" do
+  gem "rails", "~> 8.0.0"
+  gem "rspec-rails", "~> 7.1.0"
+  gem "sqlite3", "~> 2.1.0"
+end

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 0.10.1
+
+* Fix a bug introduced in 0.8.1 where we fixed Rails 7.1 warnings. This broke the serialization in Rails < 7.1.
+  We now configure the serializer differently if you are running Rails 7.0 or lower.
+  If you used the gem version 0.8.1 or above in combination with Rails 7.0 or lower this caused the serialization of
+  the request and response body into YML format instead of JSON. This is now fixed and tests run on different rails
+  versions as well.
+
 # 0.10.0
 
 **BREAKING CHANGES**
@@ -12,7 +20,7 @@ This version contains many breaking changes. Consider this when upgrading:
 * `InboundRequestsLoggerMiddleware` has been renamed to `RailsApiLogger::Middleware`
 
 > Do the changes above and then continue with the following steps if you want to connect rails_api_logger to a different
-database:
+> database:
 
 * Specify a database called `api_logger`. [Check here](spec/dummy/config/database.yml) for an example.
 * Check that everything still works (also in production!) with the new configuration.
@@ -23,8 +31,8 @@ database:
 * Add the following line into `production.rb`:
   `config.rails_api_logger.connects_to = { database: { writing: :api_logger } }` if you want to point to a new database.
 
-> If you are not on SQLite you can point also `api_logger` database to the current database you have, so you benefit from
-isolated transactions but don't need to create a new database or migrate data.
+> If you are not on SQLite you can point also `api_logger` database to the current database you have, so you benefit
+> from isolated transactions but don't need to create a new database or migrate data.
 
 ### List of changes in this version:
 

data/README.md

@@ -56,7 +56,10 @@ and [configure a new database](spec/dummy/config/database.yml) accordingly.
 > ⚠️ If you skip this step, rails_api_logger will use your primary database but a rollback will also rollback the
 > writing of logs
 > If you are not on SQLite you can point also `api_logger` to the same database! By doing so you can use a single
-> database but still guarantee the writing of logs in an isolated transaction.
+> database but still guarantee the writing of logs in an isolated transaction:
+> ```
+> config.rails_api_logger.connects_to = { database: { writing: :primary } }
+> ```
 
 ## Log Outbound Requests
 
@@ -213,8 +216,37 @@ end
 
 ## 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.
+We use Appraisals to un on different Rails versions. This is a run example:
+
+```bash
+export SAME_TARGET=false 
+export SAME_DB=false 
+export TARGET_DB=postgres 
+export BUNDLE_GEMFILE=/Users/alessandrorodi/RenuoWorkspace/rails_api_logger/gemfiles/rails_6.1.gemfile 
+bundle exec rails db:create db:migrate
+bundle exec rspec
+```
+
+These are the possible ENV variables:
+
+* `SAME_TARGET` if true, the api_logger database is the same as the primary one. It will still use two separate
+  connection pools, but they'll point to the same database. This cannot be set to true if TARGET_DB is sqlite because
+  sqlite does not support multiple connection pools to the same database.
+* `SAME_DB` if true, the api_logger uses the primary database. In this case SAME_TARGET is ignored.
+* `TARGET_DB` the database to use. Can be `postgres`, `mysql`, or `sqlite`.
+* `BUNDLE_GEMFILE` the gemfile to use. This is used to run the tests on different Rails versions.
+
+Possible combinations:
+
+| SAME_DB | SAME_TARGET | TARGET_DB | Description                                                          |
+|---------|-------------|-----------|----------------------------------------------------------------------|
+| false   | false       | postgres  | Separate database, separate connection pool.                         |
+| false   | true        | postgres  | Same database, separate connection pool.                             |
+| true    | -           | postgres  | Same connection pool so the separate target is ignored.              |
+| false   | false       | sqlite    | Separate database, separate connection pool.                         |
+| false   | true        | sqlite    | Not allowed. sqlite cannot have two connection pools to the same db. |
+| true    | -           | sqlite    | Same connection pool so the separate target is ignored.              |
+
 
 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,

data/app/models/rails_api_logger/request_log.rb

@@ -4,8 +4,13 @@ module RailsApiLogger
 
     connects_to(**RailsApiLogger.connects_to) if RailsApiLogger.connects_to
 
-    serialize :request_body, coder: JSON
-    serialize :response_body, coder: JSON
+    if Gem::Version.new(Rails.version) >= Gem::Version.new("7.1")
+      serialize :request_body, coder: JSON
+      serialize :response_body, coder: JSON
+    else
+      serialize :request_body, JSON
+      serialize :response_body, JSON
+    end
 
     belongs_to :loggable, optional: true, polymorphic: true
 

data/gemfiles/rails_6.1.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "concurrent-ruby", "1.3.4"
+gem "rails", "~> 6.1.0"
+gem "rspec-rails", "~> 6.1.0"
+gem "sqlite3", "~> 1.7.3"
+
+gemspec path: "../"

data/gemfiles/rails_6.1.gemfile.lock

@@ -0,0 +1,240 @@
+PATH
+  remote: ..
+  specs:
+    rails_api_logger (0.10.1)
+      activejob (>= 6.0)
+      activerecord (>= 6.0)
+      nokogiri
+      railties (>= 6.0)
+      zeitwerk (>= 2.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.7.10)
+      actionpack (= 6.1.7.10)
+      activesupport (= 6.1.7.10)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.7.10)
+      actionpack (= 6.1.7.10)
+      activejob (= 6.1.7.10)
+      activerecord (= 6.1.7.10)
+      activestorage (= 6.1.7.10)
+      activesupport (= 6.1.7.10)
+      mail (>= 2.7.1)
+    actionmailer (6.1.7.10)
+      actionpack (= 6.1.7.10)
+      actionview (= 6.1.7.10)
+      activejob (= 6.1.7.10)
+      activesupport (= 6.1.7.10)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.7.10)
+      actionview (= 6.1.7.10)
+      activesupport (= 6.1.7.10)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.7.10)
+      actionpack (= 6.1.7.10)
+      activerecord (= 6.1.7.10)
+      activestorage (= 6.1.7.10)
+      activesupport (= 6.1.7.10)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.7.10)
+      activesupport (= 6.1.7.10)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.7.10)
+      activesupport (= 6.1.7.10)
+      globalid (>= 0.3.6)
+    activemodel (6.1.7.10)
+      activesupport (= 6.1.7.10)
+    activerecord (6.1.7.10)
+      activemodel (= 6.1.7.10)
+      activesupport (= 6.1.7.10)
+    activestorage (6.1.7.10)
+      actionpack (= 6.1.7.10)
+      activejob (= 6.1.7.10)
+      activerecord (= 6.1.7.10)
+      activesupport (= 6.1.7.10)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.7.10)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    appraisal (2.5.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    builder (3.3.0)
+    concurrent-ruby (1.3.4)
+    crass (1.0.6)
+    date (3.4.1)
+    diff-lcs (1.6.0)
+    erubi (1.13.1)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    json (2.10.1)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    loofah (2.24.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    method_source (1.1.0)
+    mini_mime (1.1.5)
+    minitest (5.25.4)
+    mysql2 (0.5.6)
+    net-imap (0.5.6)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.1)
+      net-protocol
+    nio4r (2.7.4)
+    nokogiri (1.18.2-arm64-darwin)
+      racc (~> 1.4)
+    parallel (1.26.3)
+    parser (3.3.7.1)
+      ast (~> 2.4.1)
+      racc
+    pg (1.5.9)
+    racc (1.8.1)
+    rack (2.2.11)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rails (6.1.7.10)
+      actioncable (= 6.1.7.10)
+      actionmailbox (= 6.1.7.10)
+      actionmailer (= 6.1.7.10)
+      actionpack (= 6.1.7.10)
+      actiontext (= 6.1.7.10)
+      actionview (= 6.1.7.10)
+      activejob (= 6.1.7.10)
+      activemodel (= 6.1.7.10)
+      activerecord (= 6.1.7.10)
+      activestorage (= 6.1.7.10)
+      activesupport (= 6.1.7.10)
+      bundler (>= 1.15.0)
+      railties (= 6.1.7.10)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.2)
+      loofah (~> 2.21)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (6.1.7.10)
+      actionpack (= 6.1.7.10)
+      activesupport (= 6.1.7.10)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+    rainbow (3.1.1)
+    rake (12.3.3)
+    regexp_parser (2.10.0)
+    rspec-core (3.13.3)
+      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-rails (6.1.5)
+      actionpack (>= 6.1)
+      activesupport (>= 6.1)
+      railties (>= 6.1)
+      rspec-core (~> 3.13)
+      rspec-expectations (~> 3.13)
+      rspec-mocks (~> 3.13)
+      rspec-support (~> 3.13)
+    rspec-support (3.13.2)
+    rubocop (1.71.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.38.0)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.23.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    ruby-progressbar (1.13.0)
+    sprockets (4.2.1)
+      concurrent-ruby (~> 1.0)
+      rack (>= 2.2.4, < 4)
+    sprockets-rails (3.5.2)
+      actionpack (>= 6.1)
+      activesupport (>= 6.1)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.7.3-arm64-darwin)
+    standard (1.45.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.71.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.6)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.6.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.23.0)
+    thor (1.3.2)
+    timeout (0.4.3)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    websocket-driver (0.7.7)
+      base64
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.18)
+
+PLATFORMS
+  arm64-darwin
+
+DEPENDENCIES
+  appraisal (~> 2.5)
+  concurrent-ruby (= 1.3.4)
+  mysql2 (~> 0.5.6)
+  pg (~> 1.5.4)
+  rack
+  rails (~> 6.1.0)
+  rails_api_logger!
+  rake (~> 12.0)
+  rspec-rails (~> 6.1.0)
+  sqlite3 (~> 1.7.3)
+  standard (~> 1.31)
+
+BUNDLED WITH
+   2.5.4

data/gemfiles/rails_7.0.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "concurrent-ruby", "1.3.4"
+gem "rails", "~> 7.0.0"
+gem "rspec-rails", "~> 7.1.0"
+gem "sqlite3", "~> 1.7.3"
+
+gemspec path: "../"