rubocop-fluentd 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d78546e0c0644c62cc7d4601b79402c2ce6d3efeac313b42f81fe4c7ec73b819
-  data.tar.gz: c89dc3efd294e5b21f686aebe6dbeec67fb0efa5fe14a857d8be644c14fdec82
+  metadata.gz: 149f9a4ff32c3408a5d331c88d772893ca157a8b05ee310a040d8457269bbc12
+  data.tar.gz: fbfe6edd440e502c49634fac50f6c764025490dcf612c0ff0b3d4102a0d1eab4
 SHA512:
-  metadata.gz: 5ba5b3d713f3b862983997fd05b005c34c815d06616252ecd9db93d303ab108c1694ff304ad64920be505661e8560781009f98aabf920bb7263143144aa18957
-  data.tar.gz: e48973d36a3f0c31c21e9a4b6a1e3d5f7a81a1a274e87911b98df55e5d9ba107b5e0e6646950df8392b5d8f8420df89abb6b23f34ce634441ed7b133dbbf1401
+  metadata.gz: 5f30b04de13493b6ac74545ce33199085a097c5869e1245a6a02e55589c8160394dab3e3b8ab235e79df60aa99561b50e5174bacb15b7e05a03385554bf5414e
+  data.tar.gz: 342407d0004d958a0361f26bf8843af2c6c214403ab8e467ee2afc092071cd55f8462605d4842f8c5ce6445e8169f809fc89916debb99b728f1be8971efbfc78

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## 0.2.4 - 2025-07-24
+
+* `Lint/FluentdPluginIgnoreStandardError`: Warn if `StandardError` was ignored in #write.
+
 ## 0.2.3 - 2025-07-22
 
 * `Lint/FluentdPluginLogScope`: Delay string evaluation if assumed log level is lower than info.

data/README.md

@@ -26,6 +26,8 @@ Lint/FluentdPluginLogScope:
   Enabled: true
 Lint/FluentdPluginConfigParamDefaultTime:
   Enabled: true
+Lint/FluentdPluginIgnoreStandardError:
+  Enabled: true
 Performance/FluentdPluginLogStringInterpolation:
   Enabled: true
 ```

data/config/default.yml

@@ -11,6 +11,11 @@ Lint/FluentdPluginLogLevel:
   AssumeConfigLogLevel: 'info'
   VersionAdded: '0.1.0'
 
+Lint/FluentdPluginIgnoreStandardError:
+  Description: 'Warn if StandardError was shelved in #write. It makes hard to resume from recoverable error.'
+  Enabled: true
+  VersionAdded: '0.2.4'
+
 Performance/FluentdPluginLogStringInterpolation:
   Description: 'Warn if log message contains string interpolation. Use block to delay needless string interpolation'
   Enabled: true

data/lib/rubocop/cop/fluentd_cops.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 require_relative 'lint/plugin_config_param_time'
+require_relative 'lint/plugin_ignore_standard_error'
 require_relative 'lint/plugin_log_scope'
 require_relative 'performance/plugin_log_string_interpolation'

data/lib/rubocop/cop/lint/plugin_ignore_standard_error.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Lint
+      # @example FluentdPluginIgnoreStandardError (default)
+      #
+      #   # bad
+      #   def write
+      #     begin
+      #       ...
+      #     rescue StandardError => e
+      #       log.error "Unexpected error: #{e.message}"
+      #     end
+      #   end
+      #
+      #   # bad
+      #   def write
+      #     begin
+      #       ...
+      #     rescue => e
+      #       log.error "Unexpected error: #{e.message}"
+      #     end
+      #   end
+      #
+      #   # good
+      #   def write
+      #     begin
+      #       ...
+      #       # Do not shelve StandardError here, let StandardError exception handling by Fluentd
+      #       raise "something weird"
+      #     rescue OtherError => e
+      #       log.error "Unexpected error: #{e.message}"
+      #     end
+      #   end
+      #
+      class FluentdPluginIgnoreStandardError < Base
+        MSG = 'Should not rescue StandardError in #write in usually. StandardError should be handled in Fluentd side. Do it if you know what you are doing.'
+
+        # @!method fluent_plugin?(node)
+        def_node_matcher :fluent_plugin?, <<~PATTERN
+          (module (const (const nil? :Fluent) :Plugin) $_)
+        PATTERN
+
+        # @!method output_plugin?(node)
+        def_node_matcher :output_plugin?, <<~PATTERN
+          (class (const nil? $_) (const nil? :Output) $(...))
+        PATTERN
+
+        # @!method write_method?(node)
+        def_node_matcher :write_method?, <<~PATTERN
+          (def :write (args (arg _)) $_)
+        PATTERN
+
+        # @!method rescue_ndoe?(node)
+        def_node_matcher :rescue_node?, <<~PATTERN
+          (kwbegin (rescue $_+))
+        PATTERN
+
+        # @!method ignore_standard_error?(node)
+        def_node_matcher :ignore_standard_error?, <<~PATTERN
+          (resbody (array (const nil? :StandardError)) $_ $(...))
+        PATTERN
+
+        def on_module(node)
+          plugin_node = fluent_plugin?(node)
+          unless plugin_node
+            return
+          end
+          process_descendant_class(plugin_node) do |klass_and_node|
+            # [klass_name, function]
+            klass_and_node.each do |child|
+              next if child.is_a?(Symbol)
+              process_descendant_def(child) do |def_node|
+
+                method_body =  write_method?(def_node)
+                next unless method_body
+
+                # directly below def
+                rescue_body = rescue_node?(method_body)
+                next unless rescue_body
+                rescue_body.each do |resbody_node|
+                  next unless resbody_node.is_a?(RuboCop::AST::ResbodyNode)
+                  expression = ignore_standard_error?(resbody_node)
+                  next unless expression
+                  add_offense(resbody_node)
+                end
+              end
+            end
+          end
+        end
+
+        def process_descendant_def(node)
+          if node.is_a?(RuboCop::AST::DefNode)
+            yield node
+          else
+            node.each_descendant(:def) do |def_node|
+              yield def_node
+            end
+          end
+        end
+
+        def process_descendant_class(node)
+          # under Fluent::Plugin
+          if node.is_a?(RuboCop::AST::ClassNode)
+            klass_and_node = output_plugin?(node)
+            return unless klass_and_node
+            yield klass_and_node
+          else
+            # multiple class under Fluent::Plugin module
+            node.each_descendant(:class) do |klass_node|
+              klass_and_node = output_plugin?(klass_node)
+              # skip except output plugin
+              next unless klass_and_node
+              yield klass_and_node
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/fluentd/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Fluentd
-    VERSION = "0.2.3"
+    VERSION = "0.2.4"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-fluentd
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Kentaro Hayashi
@@ -68,6 +68,7 @@ files:
 - lib/rubocop-fluentd.rb
 - lib/rubocop/cop/fluentd_cops.rb
 - lib/rubocop/cop/lint/plugin_config_param_time.rb
+- lib/rubocop/cop/lint/plugin_ignore_standard_error.rb
 - lib/rubocop/cop/lint/plugin_log_scope.rb
 - lib/rubocop/cop/performance/plugin_log_string_interpolation.rb
 - lib/rubocop/fluentd.rb