logstruct 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b926657fc690c72031cf72973642c3654264b3ea348f2212a625788b62d1ade
-  data.tar.gz: 650b11e3b8b3e975feee474994ae9420b68da2eb933942f28cc495649d71f225
+  metadata.gz: a65754f5cc8e4753585ca448eec8e78b5f8586aba5161d94d5c5ccce20386909
+  data.tar.gz: 9088ba81fe6319a9dfd1740949c87c7a793bd1535ae97a4d44bc98b0ca3b60b9
 SHA512:
-  metadata.gz: 2e0339abeafbea5bf239799dcf1ca843f57aae004e356e407a18909d9c0b6e4d1302c897f358be7bf539b5e0534efd032319a0b3055ff29e169c1d3f22557193
-  data.tar.gz: de385bc25a32f189044fbf1749e4511c1f9411d37a9af8628fc655e9706daba1a6b94b9482de756ef12557cc497deffa6f49a39ab9b434b3be6e25c7cb402214
+  metadata.gz: 1bccedd39623795cef4059ec14029c6ed4dd9edba94b355c9147c78052e163d41f6d1d46988bf367bc1c726e0cabaab8f30c8cc36a5470f3b7d1f0c5463b56d6
+  data.tar.gz: e0a3d5b784338c0d647ff03e12a92852e4c0de3fb2f93febba9df0bd3871f0b41ef262c1915db368a0b9db71afd0d005db05a325d2314f276dbd23e7b291f654

data/CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.1.2] - 2025-10-03
+
+Better default policy for when JSON logs are enabled: machines get JSON, humans get readable logs.
+Enable LogStruct for production servers or when running tests on CI.
+Keep dev-friendly logging on local machines or when running interactive commands on production servers.
+
 ## [0.1.1] - 2025-09-29
 
 Added dotenv-rails integration. Many other fixes and improvements.

data/README.md

@@ -6,7 +6,7 @@ We support all your other favorite gems too, like Sidekiq, Sentry, and Shrine. (
 
 ## Features
 
-- JSON logging enabled by default in production and test environments
+- JSON logging enabled by default for server processes in production and test environments, and for CI test runs (automatically disabled for console, local tests, and other Rake tasks)
 - ActionMailer integration for email delivery logging
 - ActiveJob integration for job execution logging
 - Sidekiq integration for background job logging
@@ -58,11 +58,16 @@ Once initialized (and enabled), the gem automatically includes its modules into
 - Rails `config.filter_parameters` are merged into LogStruct's filters and then cleared (to avoid double filtering). Configure sensitive keys via `LogStruct.config.filters`.
 - When `RAILS_LOG_TO_STDOUT` is set, we log to STDOUT only. Otherwise, we log to STDOUT by default without adding a file appender to avoid duplicate logs.
 
-### Development behavior
+### Default behavior by process type
 
-- Disabled by default in development. Enable explicitly via `LOGSTRUCT_ENABLED=true` or `LogStruct.configure { |c| c.enabled = true }`.
-- When enabled in development, LogStruct now defaults to production‑style JSON output so you can preview exactly what will be shipped in prod.
-- You can opt back into the colorful human formatter with:
+- **Server processes** (`rails server`): JSON logging is enabled by default in production and test environments
+- **CI test runs** (`rails test` when `CI=true`): JSON logging is enabled by default to catch production bugs in your automated tests
+- **Local test runs** (`rails test` locally): JSON logging is disabled by default, providing human-readable logs for debugging
+- **Console** (`rails console`): JSON logging is disabled by default in all environments, providing human-readable logs instead
+- **Other Rake tasks** (`rake db:migrate`, etc.): JSON logging is disabled by default in production, providing human-readable logs instead
+- **Development environment**: Disabled by default for all process types. Enable explicitly via `LOGSTRUCT_ENABLED=true` or `LogStruct.configure { |c| c.enabled = true }`.
+
+When enabled in development, LogStruct defaults to production‑style JSON output so you can preview exactly what will be shipped in prod. You can opt back into the colorful human formatter with:
 
 ```ruby
 LogStruct.configure do |c|
@@ -71,6 +76,8 @@ LogStruct.configure do |c|
 end
 ```
 
+To force JSON logs in console, local test runs, or other Rake tasks (e.g., for debugging), set `LOGSTRUCT_ENABLED=true` in your environment.
+
 ## Documentation
 
 Please see the [documentation](https://logstruct.com/docs) for more details. (All code examples are type-checked and tested, and it's harder to keep a README up to date.)

data/lib/log_struct/concerns/configuration.rb

@@ -10,6 +10,11 @@ module LogStruct
       module ClassMethods
         extend T::Sig
 
+        SERVER_COMMAND_ARGS = T.let(["server", "s"].freeze, T::Array[String])
+        CONSOLE_COMMAND_ARGS = T.let(["console", "c"].freeze, T::Array[String])
+        EMPTY_ARGV = T.let([].freeze, T::Array[String])
+        CI_FALSE_VALUES = T.let(["false", "0", "no"].freeze, T::Array[String])
+
         sig { params(block: T.proc.params(config: LogStruct::Configuration).void).void }
         def configure(&block)
           yield(config)
@@ -45,14 +50,20 @@ module LogStruct
           #    - Sets enabled=true only when value is "true", "yes", "1", etc.
           #    - Sets enabled=false when value is any other value
           # 2. Otherwise, check if current Rails environment is in enabled_environments
+          #    AND one of: Rails::Server is defined, OR test environment with CI=true
+          #    BUT NOT Rails::Console (to exclude interactive console)
           # 3. Otherwise, leave as config.enabled (defaults to true)
 
           # Then check if LOGSTRUCT_ENABLED env var is set
           config.enabled = if ENV["LOGSTRUCT_ENABLED"]
-            # Override to true only if env var is "true"
             %w[true t yes y 1].include?(ENV["LOGSTRUCT_ENABLED"]&.strip&.downcase)
           else
-            config.enabled_environments.include?(::Rails.env.to_sym)
+            is_console = console_process?
+            is_server = server_process?
+            is_ci = ci_build?
+            in_enabled_env = config.enabled_environments.include?(::Rails.env.to_sym)
+
+            in_enabled_env && !is_console && (is_server || (::Rails.env.test? && is_ci))
           end
         end
 
@@ -112,6 +123,45 @@ module LogStruct
 
         private
 
+        sig { returns(T::Boolean) }
+        def console_process?
+          return true if defined?(::Rails::Console)
+
+          current_argv.any? { |arg| CONSOLE_COMMAND_ARGS.include?(arg) }
+        end
+
+        sig { returns(T::Boolean) }
+        def server_process?
+          return true if logstruct_server_mode?
+
+          current_argv.any? { |arg| SERVER_COMMAND_ARGS.include?(arg) }
+        end
+
+        sig { returns(T::Boolean) }
+        def logstruct_server_mode?
+          ::LogStruct.server_mode?
+        end
+
+        sig { returns(T::Array[String]) }
+        def current_argv
+          raw = ::ARGV
+          strings = raw.map { |arg| arg.to_s }
+          T.let(strings, T::Array[String])
+        rescue NameError
+          EMPTY_ARGV
+        end
+
+        sig { returns(T::Boolean) }
+        def ci_build?
+          value = ENV["CI"]
+          return false if value.nil?
+
+          normalized = value.strip.downcase
+          return false if normalized.empty?
+
+          !CI_FALSE_VALUES.include?(normalized)
+        end
+
         sig { params(filter: T.untyped).returns(T.nilable(Symbol)) }
         def normalize_filter_symbol(filter)
           return filter if filter.is_a?(Symbol)

data/lib/log_struct/integrations/puma.rb

@@ -139,12 +139,7 @@ module LogStruct
 
         sig { params(e: StandardError).void }
         def handle_integration_error(e)
-          server_mode = false
-          begin
-            server_mode = ::LogStruct.instance_variable_defined?(:@server_mode) && ::LogStruct.instance_variable_get(:@server_mode)
-          rescue
-            server_mode = false
-          end
+          server_mode = ::LogStruct.server_mode?
           if defined?(::Rails) && ::Rails.respond_to?(:env) && ::Rails.env.test? && !server_mode
             raise e
           else

data/lib/log_struct/rails_boot_banner_silencer.rb

@@ -54,25 +54,18 @@ module LogStruct
 
       sig { params(args: T.untyped, block: T.nilable(T.proc.returns(T.untyped))).returns(T.untyped) }
       def perform(*args, &block)
-        mark_server_mode!
+        ::LogStruct.server_mode = true
         super
       end
 
       sig { params(server: T.untyped, url: T.nilable(String)).void }
       def print_boot_information(server, url)
-        mark_server_mode!
+        ::LogStruct.server_mode = true
         consume_boot_banner(server, url)
       end
 
       private
 
-      sig { void }
-      def mark_server_mode!
-        ::LogStruct.instance_variable_set(:@server_mode, true)
-      rescue
-        # Ignore – server mode is best-effort
-      end
-
       sig { params(server: T.untyped, url: T.nilable(String)).void }
       def consume_boot_banner(server, url)
         return unless defined?(::LogStruct::Integrations::Puma)

data/lib/log_struct/railtie.rb

@@ -55,11 +55,7 @@ module LogStruct
 
     # Emit Puma lifecycle logs when running `rails server`
     initializer "logstruct.puma_lifecycle", after: "logstruct.configure_logger" do
-      begin
-        is_server = ::LogStruct.instance_variable_defined?(:@server_mode) && ::LogStruct.instance_variable_get(:@server_mode)
-      rescue
-        is_server = false
-      end
+      is_server = ::LogStruct.server_mode?
       next unless is_server
       begin
         require "log_struct/log/puma"

data/lib/log_struct/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module LogStruct
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/log_struct.rb

@@ -23,12 +23,26 @@ require "log_struct/semantic_logger/setup"
 require "log_struct/rails_boot_banner_silencer"
 
 module LogStruct
+  extend T::Sig
+
+  @server_mode = T.let(false, T::Boolean)
+
   class Error < StandardError; end
 
   extend Concerns::ErrorHandling::ClassMethods
   extend Concerns::Configuration::ClassMethods
   extend Concerns::Logging::ClassMethods
 
+  sig { returns(T::Boolean) }
+  def self.server_mode?
+    @server_mode
+  end
+
+  sig { params(value: T::Boolean).void }
+  def self.server_mode=(value)
+    @server_mode = value
+  end
+
   # Set enabled at require time based on current Rails environment.
   # (Users can disable or enable LogStruct later in an initializer.)
   set_enabled_from_rails_env!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logstruct
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - DocSpring