db_log_tag 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bd902bdce242a671355a18146acde9967482666ad689a2ca51e961b08d0714de
+  data.tar.gz: 4ee6cc7a5a096829d98a1cbdc40251aa8d5c411a02ec838e9e26160a4a5b04fc
+SHA512:
+  metadata.gz: 3f6c7db7eeffca09b74c4258e7c7f7fde486c835c124d8d63b4cf9f1b6e0c922669dbf63bce3c7d7b483c6f32568efcd49fbaae1289e18ac5f42fb08f7514928
+  data.tar.gz: cb93a42802989964abeb42441699bd02b7109e1348825f71efcf671c666b6781ee4e33f9476e99c17439bce58fdd8852a64cb07babe9aed8999a57bb4b534d5c

data/lib/db_log_tag/colors.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module DbLogTag
+  module Colors
+    module_function
+
+    def colorize?
+      ActiveSupport::LogSubscriber.colorize_logging
+    end
+
+    # TODO: support more colors ?
+    def get_color_code(color)
+      "ActiveRecord::LogSubscriber::#{color.to_s.upcase}".constantize
+    end
+
+    FONT_MODE = {
+      bold:      1,
+      italic:    3,
+      underline: 4,
+    }
+    CLEAR = "\e[0m".freeze
+
+    def get_font_code(font_mode)
+      font_mode ? "\e[#{FONT_MODE[font_mode]}m" : ""
+    end
+
+    def set_color(text, color, font_mode)
+      return text if color.nil? || !colorize?
+
+      color = get_color_code(color) if color.is_a?(Symbol)
+      weight = get_font_code(font_mode)
+      "#{weight}#{color}#{text}#{CLEAR}"
+    end
+  end
+end

data/lib/db_log_tag/configuration.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module DbLogTag
+  class Configuration
+    attr_reader :envs
+
+    def initialize
+      reset
+    end
+
+    def reset
+      DbLogTag::MultipleDb.reset
+    end
+
+    def enable_environment=(envs)
+      DbLogTag.set_enable_environment(envs)
+    end
+
+    def db_tag(clazz = nil, **options, &block)
+      DbLogTag::MultipleDb.set_db_tag(clazz, block, **options)
+    end
+  end
+end

data/lib/db_log_tag/dynamic.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ActiveRecord::Querying
+    delegate :log_tag, to: :all
+  end
+
+  class Relation
+    Tags_Regex = /:tag:(.+):tag:/
+    Empty_Annotation = /\/\*\s*\*\//
+
+    attr_accessor :log_tags
+
+    def log_tag(tag_name=nil, **options)
+      return self unless DbLogTag.enable?
+      
+      if block_given?
+        tag_name = yield(
+          klass.connection_pool.db_config.name,
+          ActiveRecord::Base.current_shard,
+          ActiveRecord::Base.current_role
+        )
+      end
+
+      tag_color = options.dig(:color)
+      tag_font = options.dig(:font) || :bold
+      tag_name = DbLogTag::Colors.set_color(tag_name, tag_color, tag_font) unless tag_color.nil?
+      self.annotate_values += [":tag:#{tag_name}:tag:"]
+
+      self
+    end
+
+    def remove_log_tags
+      self.annotate_values = self.annotate_values.reject do |annotate|
+        annotate.start_with?(":tag:")
+      end
+      self
+    end
+  end
+end
+

data/lib/db_log_tag/enable.rb

@@ -0,0 +1,12 @@
+module DbLogTag
+    module_function
+
+    def set_enable_environment(envs)
+        @@envs = envs.map(&:to_s)
+    end
+
+    def enable?
+        @@envs ||= ["development", "test"]
+        @@envs.include?(ENV["RAILS_ENV"])
+    end
+end

data/lib/db_log_tag/multiple_db.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module DbLogTag
+  module MultipleDb
+    module_function
+    
+    def db_tags
+      @@db_tags ||= {
+        nil => {
+          proc: lambda { |db, shard, role| "[#{db}|#{shard}|#{role}]" }
+        }
+      }
+    end
+
+    def set_db_tag(clazz, format_tag_proc, **options)
+      tag_config = {
+        proc: format_tag_proc,
+        **options
+      }
+
+      if clazz.nil?
+        db_tags[nil] = tag_config
+      elsif clazz.is_a?(String) or clazz.is_a?(Symbol)
+        db_tags[clazz.to_s.classify] = tag_config
+      end
+    end
+
+    def reset
+      @@db_tags = nil
+    end
+
+    def db_info(clazz)
+      return unless db_tag_config = (db_tags[clazz] || db_tags[nil])
+      
+      clazz_const = clazz.constantize
+      db_info_tag = db_tag_config[:proc].call(
+        clazz_const.connection_pool.db_config.name, 
+        clazz_const.current_shard,
+        clazz_const.current_role
+      )
+
+      DbLogTag::Colors.set_color(db_info_tag, db_tag_config[:color], db_tag_config[:font] || :bold) 
+    end
+  end
+end

data/lib/db_log_tag/refinement.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module DbLogTag
+  # helper method to create refinement module
+  # that add refinement tag to all queries be called on refinement's scope
+  #
+  # ex:
+  # class PersonJob
+  #   using DbLogTag.refinement_tag { |db, shard, role| "PersonJob" }
+  #
+  # now all queries in this job
+  # will be automatically prepend refinement tag "PersonJob"
+  #
+  def self.refinement_tag(refinement_proc, **options)
+    return Module.new {} unless DbLogTag.enable?
+    
+    # init an anonymous module
+    # that will be `using`
+    Module.new do
+      refine ActiveRecord::Base.singleton_class do
+        # decorating all querying methods
+        # to add log_tag before call the origin query method
+        (ActiveRecord::Querying::QUERYING_METHODS + [:all]).each do |q|
+          define_method(q) do |*args, &block|
+            log_tag(**options) do |db, shard, role| 
+              refinement_proc.call(db, shard, role)
+            end.send(q, *args, &block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/db_log_tag.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative "db_log_tag/enable"
+require_relative "db_log_tag/colors"
+require_relative "db_log_tag/dynamic"
+require_relative "db_log_tag/refinement"
+require_relative "db_log_tag/multiple_db"
+require_relative "db_log_tag/configuration"
+
+require_relative  "rails/generators/db_log_tag/install_generator"
+
+module DbLogTag
+  extend ActiveSupport::Concern
+  
+  # global setting
+  class << self
+    def configuration
+      @configuration ||= DbLogTag::Configuration.new
+    end
+
+    def config
+      configuration.reset
+      yield(configuration)
+    end
+  end
+
+  included do
+    alias_method :origin_sql, :sql
+    def sql(event)
+      if DbLogTag.enable?
+        begin
+          db_log_tags(event)
+          parse_annotations_as_dynamic_tags(event)
+        rescue
+        end
+      end
+      
+      origin_sql(event)
+    end
+
+    private
+
+      def parse_annotations_as_dynamic_tags(event)
+        tags = event.payload[:sql].scan(ActiveRecord::Relation::Tags_Regex).map(&:first).join(" ")
+
+        unless should_ignore_log?(event) || tags.nil?
+          event.payload[:name] = "#{tags} #{event.payload[:name]}" 
+        end
+        
+        event.payload[:sql] = event.payload[:sql].gsub(ActiveRecord::Relation::Tags_Regex, "")
+        # still keep normal annotations
+        event.payload[:sql] = event.payload[:sql].gsub(ActiveRecord::Relation::Empty_Annotation, "")
+      end
+
+      def db_log_tags(event)
+        return if should_ignore_log?(event)
+
+        clazz, _ = event.payload[:name].split(" ")
+        _db_info = DbLogTag::MultipleDb.db_info(clazz)
+        event.payload[:name] = "#{_db_info} #{event.payload[:name]}"
+      end
+
+      def should_ignore_log?(event)
+        ActiveRecord::LogSubscriber::IGNORE_PAYLOAD_NAMES.include?(event.payload[:name])
+      end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  ActiveRecord::LogSubscriber.send(:include, DbLogTag)
+end

data/lib/rails/generators/db_log_tag/install_generator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require "rails/generators"
+
+module DbLogTag
+  class InstallGenerator < ::Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+    
+    def create_initializer
+      copy_file "initializer.rb", "config/initializers/db_log_tag.rb"
+    end
+  end
+end

data/lib/rails/generators/db_log_tag/templates/initializer.rb

@@ -0,0 +1,13 @@
+DbLogTag.config do |config|
+  # config.enable_environment = [:development, :test]
+
+  # # default for all
+  # config.db_tag do |db, shard, role|
+  #   "[#{db}|#{shard}|#{role}]"
+  # end
+
+  # # for only User
+  # config.db_tag :user, color: :red do |db, shard, role|
+  #   "[#{db}|#{shard}|#{role}]"
+  # end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: db_log_tag
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Lam Phan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allow to prepend prefix tags before query logs to track name, shard and
+  role of the database.
+email: theforestvn88@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/db_log_tag.rb
+- lib/db_log_tag/colors.rb
+- lib/db_log_tag/configuration.rb
+- lib/db_log_tag/dynamic.rb
+- lib/db_log_tag/enable.rb
+- lib/db_log_tag/multiple_db.rb
+- lib/db_log_tag/refinement.rb
+- lib/rails/generators/db_log_tag/install_generator.rb
+- lib/rails/generators/db_log_tag/templates/initializer.rb
+homepage: https://github.com/theforestvn88/rails_db_log_tag
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.4
+signing_key: 
+specification_version: 4
+summary: rails database log tags
+test_files: []