console-adapter-rails 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd24ef25ea142ca007009e32bf72a8b15addbc51fcd68e0b8764f4aa01b715db
-  data.tar.gz: 64cad4283b64c45dde83f84af277354cd184eacdb1f72ac6dd34e01d65e52009
+  metadata.gz: 4113b18d055a8163f32e2faf01bc4297c32c1ee36cc8fdbb74202b87b1532e92
+  data.tar.gz: 0f53176b8cf64ecbd393ada761e515d97c995da78ee093ec8c32e2b61d143838
 SHA512:
-  metadata.gz: 06f40cdd266f29ff91da9a63b8ff6dc53ba09af52718b0c1cc2636dd73870ed006fcbf83f043183c9678bc39dfc6b0d2255675ce29da6c996c7ca59934d59e71
-  data.tar.gz: 963a690fb77153a6509c4e8783b982ec02bf750f11dc8df63d7445ca5732746bbcc21ba5ba1c9e984680ac490f19a179fdac0e29a889b3a593a54a87124c15f6
+  metadata.gz: e2ffc06b392ca691d30c9d7ede74dbed6c56ab8a70ce794304a6d18c342b575c4b0479cc4f13e8d0508eb65889d482209856325f69c3a0145ec575d58b319b57
+  data.tar.gz: 46e0538d0ecc74f4bc03af56253804eb8178baa44bda5f84e5da96c29b862a47c17347ee3108bae8987d88ba398022348d6bd5aa70cea1e68d4fbfd6945a96cc

data/lib/console/adapter/rails/action_controller.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
+
+require 'console'
+
+require 'action_controller/log_subscriber'
+
+module Console
+	module Adapter
+		# A Rails adapter for the console logger.
+		module Rails
+			module ActionController
+				# A Rails log subscriber which is compatible with `Console::Logger`. It receives events from `ActiveSupport::Notifications` and logs them to the console.
+				class LogSubscriber < ::ActiveSupport::LogSubscriber
+					# Log an ActionController `process_action` event.
+					#
+					# Includes the following fields:
+					# - `subject`: "process_action.action_controller"
+					# - `controller`: The name of the controller.
+					# - `action`: The action performed.
+					# - `format`: The format of the response.
+					# - `method`: The HTTP method of the request.
+					# - `path`: The path of the request.
+					# - `status`: The HTTP status code of the response.
+					# - `view_runtime`: The time spent rendering views in milliseconds.
+					# - `db_runtime`: The time spent querying the database in milliseconds.
+					# - `location`: The redirect location if any.
+					# - `allocations`: The number of allocations performed.
+					# - `duration`: The total time spent processing the request in milliseconds.
+					def process_action(event)
+						payload = event.payload.dup
+						
+						# This may contain sensitive information:
+						params = payload.delete(:params)
+						
+						# These objects are not useful and may not serialize correctly:
+						headers = payload.delete(:headers)
+						request = payload.delete(:request)
+						response = payload.delete(:response)
+						
+						if request and ip = request.remote_ip
+							payload[:source_address] = ip
+						end
+						
+						if response and headers = response.headers
+							# Extract redirect location if any:
+							location = response.headers['Location'] || response.headers['location']
+							if location
+								payload[:location] = location
+							end
+						end
+						
+						payload[:allocations] = event.allocations
+						payload[:duration] = event.duration
+						
+						Console.logger.info(event.name, **payload)
+					end
+				end
+				
+				def self.apply!(notifications: ActiveSupport::Notifications)
+					LogSubscriber.attach_to(:action_controller, LogSubscriber.new, notifications)
+				end
+			end
+		end
+	end
+end

data/lib/console/adapter/rails/active_record.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
+
+require 'console'
+
+require 'active_record/log_subscriber'
+
+module Console
+	module Adapter
+		module Rails
+			module ActiveRecord
+				class LogSubscriber < ::ActiveSupport::LogSubscriber
+					IGNORE_PAYLOAD_NAMES = ["SCHEMA", "EXPLAIN", "TRANSACTION"]
+					
+					# Log an ActiveRecord sql event.
+					#
+					# Includes the following fields:
+					# - `subject`: "process_action.action_controller"
+					# - `sql`: The SQL query itself.
+					# - `name`: The name of the query.
+					# - `binds`: The bind parameters as an array of name-value pairs.
+					# - `allocations`: The number of allocations performed.
+					# - `duration`: The total time spent processing the request in milliseconds.
+					def sql(event)
+						return if IGNORE_PAYLOAD_NAMES.include?(event.payload[:name])
+						
+						payload = event.payload.dup
+						
+						# We don't want to dump the connection:
+						connection = payload.delete(:connection)
+						
+						update_binds(payload)
+						
+						payload[:allocations] = event.allocations
+						payload[:duration] = event.duration
+						
+						Console.logger.info(event.name, **payload)
+					end
+					
+					private
+					
+					def update_binds(payload)
+						binds = payload.delete(:binds)
+						type_casted_binds = payload.delete(:type_casted_binds)
+						
+						if binds&.any? and type_casted_binds
+							payload[:binds] = binds.map.with_index do |attribute, index|
+								[attribute.name, self.bind_value(attribute, type_casted_binds[index])]
+							end
+						end
+					end
+					
+					def bind_value(attribute, value)
+						value = self.filter(attribute.name, value)
+						
+						if attribute.type.binary?
+							"<#{value.bytesize} bytes of binary data>"
+						else
+							value
+						end
+					end
+					
+					def filter(name, value)
+						::ActiveRecord::Base.inspection_filter.filter_param(name, value)
+					end
+				end
+				
+				def self.apply!(notifications: ActiveSupport::Notifications)
+					LogSubscriber.attach_to(:active_record, LogSubscriber.new, notifications)
+				end
+			end
+		end
+	end
+end

data/lib/console/adapter/rails/logger.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
+
+require 'console/compatible/logger'
+
+require 'active_support/logger'
+require 'active_support/tagged_logging'
+require 'active_support/logger_silence'
+
+if ActiveSupport::Logger.respond_to?(:logger_outputs_to?)
+	# https://github.com/rails/rails/issues/44800
+	class ActiveSupport::Logger
+		def self.logger_outputs_to?(*)
+			true
+		end
+	end
+end
+
+module Console
+	module Adapter
+		# A Rails adapter for the console logger.
+		module Rails
+			class Logger < ::Console::Compatible::Logger
+				include ::ActiveSupport::LoggerSilence
+				
+				def self.apply!(configuration: ::Rails.configuration)
+					# Set the logger to a compatible logger to catch `Rails.logger` output:
+					configuration.logger = ActiveSupport::TaggedLogging.new(
+						Logger.new(::Rails)
+					)
+					
+					# Delete `Rails::Rack::Logger` as it also doubles up on request logs:
+					configuration.middleware.delete ::Rails::Rack::Logger
+				end
+			end
+		end
+	end
+end

data/lib/console/adapter/rails/version.rb

@@ -6,7 +6,7 @@
 module Console
 	module Adapter
 		module Rails
-			VERSION = "0.2.0"
+			VERSION = "0.3.0"
 		end
 	end
 end

data/lib/console/adapter/rails.rb

@@ -3,89 +3,30 @@
 # Released under the MIT License.
 # Copyright, 2023, by Samuel Williams.
 
-require 'console'
-require 'console/compatible/logger'
-
-require 'active_support/log_subscriber'
-require 'active_support/tagged_logging'
-require 'action_controller/log_subscriber'
-require 'action_view/log_subscriber'
-require 'active_job/log_subscriber'
-
-require_relative 'rails/active_support'
+require_relative 'rails/logger'
+require_relative 'rails/action_controller'
+require_relative 'rails/active_record'
 
 module Console
 	module Adapter
 		# A Rails adapter for the console logger.
 		module Rails
-			# A Rails log subscriber which is compatible with `Console::Logger`. It receives events from `ActiveSupport::Notifications` and logs them to the console.
-			class LogSubscriber < ActiveSupport::LogSubscriber
-				# Log controller action events.
-				#
-				# Includes the following fields:
-				# - `subject`: "process_action.action_controller"
-				# - `controller`: The name of the controller.
-				# - `action`: The action performed.
-				# - `format`: The format of the response.
-				# - `method`: The HTTP method of the request.
-				# - `path`: The path of the request.
-				# - `status`: The HTTP status code of the response.
-				# - `view_runtime`: The time spent rendering views in milliseconds.
-				# - `db_runtime`: The time spent querying the database in milliseconds.
-				# - `location`: The redirect location if any.
-				# - `allocations`: The number of allocations performed.
-				# - `duration`: The total time spent processing the request in milliseconds.
-				def process_action(event)
-					payload = event.payload.dup
-					
-					# This may contain sensitive information:
-					params = payload.delete(:params)
-					
-					# These objects are not useful and may not serialize correctly:
-					headers = payload.delete(:headers)
-					request = payload.delete(:request)
-					response = payload.delete(:response)
-					
-					if request and ip = request.remote_ip
-						payload[:source_address] = ip
-					end
-					
-					if response and headers = response.headers
-						# Extract redirect location if any:
-						location = response.headers['Location'] || response.headers['location']
-						if location
-							payload[:location] = location
-						end
-					end
-					
-					payload[:allocations] = event.allocations
-					payload[:duration] = event.duration
-					
-					Console.logger.info(event.name, **payload)
-				end
-			end
-			
 			# Apply the Rails adapter to the current process and Rails application.
 			# @parameter notifications [ActiveSupport::Notifications] The notifications object to use.
 			# @parameter configuration [Rails::Configuration] The configuration object to use.
 			def self.apply!(notifications: ActiveSupport::Notifications, configuration: ::Rails.configuration)
+				if configuration
+					Logger.apply!(configuration: configuration)
+				end
+				
 				if notifications
 					# Clear out all the existing subscribers otherwise you'll get double the logs:
 					notifications.notifier = ActiveSupport::Notifications::Fanout.new
-				end
-				
-				if configuration
-					# Set the logger to a compatible logger to catch `Rails.logger` output:
-					configuration.logger = ActiveSupport::TaggedLogging.new(
-						Console::Compatible::Logger.new(::Rails)
-					)
 					
-					# Delete `Rails::Rack::Logger` as it also doubles up on request logs:
-					configuration.middleware.delete ::Rails::Rack::Logger
+					# Add our own subscribers:
+					Rails::ActionController.apply!(notifications: notifications)
+					Rails::ActiveRecord.apply!(notifications: notifications)
 				end
-				
-				# Attach our log subscriber for action_controller events:
-				LogSubscriber.attach_to(:action_controller, LogSubscriber.new, notifications)
 			end
 		end
 	end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: console-adapter-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -37,7 +37,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-08-11 00:00:00.000000000 Z
+date: 2023-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: console
@@ -74,7 +74,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/console/adapter/rails.rb
-- lib/console/adapter/rails/active_support.rb
+- lib/console/adapter/rails/action_controller.rb
+- lib/console/adapter/rails/active_record.rb
+- lib/console/adapter/rails/logger.rb
 - lib/console/adapter/rails/version.rb
 - license.md
 - readme.md

data/lib/console/adapter/rails/active_support.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2023, by Samuel Williams.
-
-require 'active_support/logger'
-
-if ActiveSupport::Logger.respond_to?(:logger_outputs_to?)
-	# https://github.com/rails/rails/issues/44800
-	class ActiveSupport::Logger
-		def self.logger_outputs_to?(*)
-			true
-		end
-	end
-end