rails_api_logger 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fda8a1c76ae8f88f8753f6a24b0e794031f2fe699cf517b2bdc0dc4a9492047
-  data.tar.gz: 6435707109046e2f3444290e8f1c18381a2bbd3b9558602198752c077de3f7ed
+  metadata.gz: 2583006d0378e6989e3da41641c44fd31c9ff89c705150389c3da33bb7d194da
+  data.tar.gz: 7c747c7058c67fa855ce16a92f97c9d4a6d87066e5cd96e6edecf6b08384e4d4
 SHA512:
-  metadata.gz: d8660e1388c86679bc3be3004049b783e96eef9bf18c6c61fb4d885fdd9cf4f2408bb131adf35193652687a3f37b2a7411e3e7953eb919fc468ab99a165e147c
-  data.tar.gz: 53bbe981627e011159acaf23468f1b1bf00b6171ae9f50fc6d577d3461937a871e9955f29e391fdb38027902fd6db42a6a9b20614d6da21d50bacbf0bb2cc980
+  metadata.gz: bc76a1c027e3e1271e9475bc54ac2a64a3bcab962d6ef67d20c0500bb221ece0af56085e982317bb17802d65b5117eba76c5956745899ac3a152a32d715edff3
+  data.tar.gz: b90b9f94f8e1a742ed084687151649e3a9bbcf962beeacdfad8c211c9dfcd3a1f31d31d3f26f016f07e40a6e67133e2d5d557f8a1c04c75ee258de076259b180

data/.gitignore

@@ -9,8 +9,11 @@
 /spec/dummy/log
 /spec/dummy/tmp
 /spec/dummy/db/*.sqlite3*
+/spec/dummy/db/schema.rb
+/spec/dummy/db/api_logger_schema.rb
+/spec/tmp/*
 .env
-
+.byebug_history
 # rspec failure tracking
 .rspec_status
 Gemfile.lock

data/.ruby-version

@@ -1 +1 @@
-3.2.1
+3.2.9

data/.semaphore/main-deploy.yml

@@ -2,8 +2,8 @@ version: v1.0
 name: main-deploy
 agent:
   machine:
-    type: e1-standard-2
-    os_image: ubuntu2004
+    type: f1-standard-2
+    os_image: ubuntu2204
 
 blocks:
   - name: main-deploy

data/.semaphore/semaphore.yml

@@ -2,8 +2,8 @@ version: "v1.0"
 name: rails_api_logger
 agent:
   machine:
-    type: e1-standard-2
-    os_image: ubuntu2004
+    type: f1-standard-2
+    os_image: ubuntu2204
 auto_cancel:
   running:
     when: "true"
@@ -23,61 +23,153 @@ 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 | rails 8.0
           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 | rails 8.0
           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 | rails 8.0
           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: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:schema:load
+            - bin/rails db:create db:migrate
+            - bundle exec rspec
+        - name: tests sqlite separate db and separate target | rails 8.0
+          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 | rails 8.0
+          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
+        - name: tests webrick | rails 8.0
+          env_vars:
+            - name: SAME_DB
+              value: "true"
+            - name: TARGET_DB
+              value: sqlite
+            - name: RAILS_ENV
+              value: test
+            - name: BUNDLE_GEMFILE
+              value: /home/semaphore/rails_api_logger/gemfiles/rails_webrick_8.0.gemfile
+          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,51 @@
+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"
+  gem "ammeter", "~> 1.1"
+  gem "webmock", "~> 3.25.0"
+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"
+  gem "ammeter", "~> 1.1"
+  gem "webmock", "~> 3.25.0"
+end
+
+appraise "rails-7.1" do
+  gem "rails", "~> 7.1.0"
+  gem "rspec-rails", "~> 7.1.0"
+  gem "sqlite3", "~> 1.7.3"
+  gem "ammeter", "~> 1.1"
+  gem "webmock", "~> 3.25.0"
+end
+
+appraise "rails-7.2" do
+  gem "rails", "~> 7.2.0"
+  gem "rspec-rails", "~> 7.1.0"
+  gem "sqlite3", "~> 1.7.3"
+  gem "ammeter", "~> 1.1"
+  gem "webmock", "~> 3.25.0"
+end
+
+appraise "rails-8.0" do
+  gem "rails", "~> 8.0.0"
+  gem "rspec-rails", "~> 7.1.0"
+  gem "sqlite3", "~> 2.1.0"
+  gem "ammeter", "~> 1.1"
+  gem "puma"
+  gem "webmock", "~> 3.25.0"
+end
+
+appraise "rails-webrick-8.0" do
+  gem "rails", "~> 8.0.0"
+  gem "rspec-rails", "~> 7.1.0"
+  gem "sqlite3", "~> 2.1.0"
+  gem "ammeter", "~> 1.1"
+  gem "webrick", "~> 1.9.1"
+  gem "webmock", "~> 3.25.0"
+end

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+# 0.11.0
+
+* Fix stack trace to deep in webrick
+* Fixes for Rails < 7.1
+* Support custom primary key types in migration template
+
+# 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 +26,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 +37,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

@@ -54,9 +54,14 @@ config.rails_api_logger.connects_to = { database: { writing: :api_logger } }
 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.
+> writing of logs.
+> 
+> If you are not on SQLite you can simply point `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:
+> ```
+> config.rails_api_logger.connects_to = { database: { writing: :primary } }
+> ```
+> This is probably what you want if you are using a single Postgres database.
 
 ## Log Outbound Requests
 
@@ -124,7 +129,7 @@ config.middleware.insert_before Rails::Rack::Logger, RailsApiLogger::Middleware,
 If you want to log only requests on a certain path, you can pass a regular expression:
 
 ```ruby
-config.middleware.insert_before Rails::Rack::Logger, RailsApiLogger::Middleware, path_regexp: /api/
+config.middleware.insert_before Rails::Rack::Logger, RailsApiLogger::Middleware, path_regexp: %r{^/api}
 ```
 
 If you want to log only requests on a certain host, you can also use a regular expression:
@@ -200,11 +205,20 @@ This configuration will give you some nice views, and searches to work with the
     show do
       include_fields :loggable, :method, :path, :response_code
       field(:created_at)
+      field(:query_params) do
+        formatted_value do
+          params = bindings[:object].path.split("?").second
+          if params.present?
+            params = CGI.parse(params)
+            bindings[:view].tag.pre JSON.pretty_generate(params)
+          end
+        end
+      end
       field(:request_body) do
-        formatted_value { "<pre>#{JSON.pretty_generate(bindings[:object].request_body)}</pre>".html_safe }
+        formatted_value { bindings[:view].tag.pre JSON.pretty_generate(bindings[:object].request_body) }
       end
       field(:response_body) do
-        formatted_value { "<pre>#{JSON.pretty_generate(bindings[:object].response_body)}</pre>".html_safe }
+        formatted_value { bindings[:view].tag.pre JSON.pretty_generate(bindings[:object].response_body) }
       end
     end
   end
@@ -213,13 +227,56 @@ 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,
 push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### Start dummy app
+
+You can spin up the dummy rails app with the following command:
+
+```bash
+TARGET_DB=sqlite BUNDLE_GEMFILE=gemfiles/rails_8.0.gemfile bin/rails server
+```
+
+and invoke the API endpoints. Here are some examples:
+
+```bash
+curl -X POST http://localhost:3000/api/books -d '{"book": {"name": "John Doe"}}' -H "Content-Type: application/json"
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/renuo/rails_api_logger.

data/app/middlewares/rails_api_logger/middleware.rb

@@ -20,7 +20,7 @@ module RailsApiLogger
       logging = log?(env, request)
       if logging
         env["INBOUND_REQUEST_LOG"] = InboundRequestLog.from_request(request, skip_request_body: skip_request_body?(env))
-        request.body.rewind if request.body.respond_to?(:read)
+        request.body.rewind if request.body.respond_to?(:rewind)
       end
       status, headers, body = @app.call(env)
       if logging
@@ -61,16 +61,17 @@ module RailsApiLogger
 
     def parsed_body(body)
       return unless body.present?
-
-      if body.respond_to?(:to_ary)
-        JSON.parse(body.to_ary[0])
+      parsable_body = if body.respond_to?(:to_ary)
+        body.to_ary[0]
       elsif body.respond_to?(:body)
-        JSON.parse(body.body)
+        body.body
       else
         body
       end
+
+      JSON.parse(parsable_body)
     rescue JSON::ParserError, ArgumentError
-      body
+      parsable_body
     end
 
     def request_with_state_change?(request)

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/bin/rails

@@ -10,7 +10,12 @@ APP_PATH = File.expand_path('../spec/dummy/config/application', __dir__)
 
 # Set up gems listed in the Gemfile.
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
-require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+if File.exist?(ENV['BUNDLE_GEMFILE'])
+  require 'bundler/setup'
+else
+  puts "Gemfile not found."
+  exit 1
+end
 
 require 'rails/all'
 require 'rails/engine/commands'

data/gemfiles/rails_6.1.gemfile

@@ -0,0 +1,12 @@
+# 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"
+gem "ammeter", "~> 1.1"
+gem "webmock", "~> 3.25.0"
+
+gemspec path: "../"