Fixes for Rails < 7.1 (#18)

Author: coorasse

.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

.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

.standard.yml

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

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

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:
 

README.md

@@ -216,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,

app/models/rails_api_logger/request_log.rb

@@ -4,8 +4,13 @@ class RequestLog < ActiveRecord::Base
 
     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
 

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: "../"