storyteller 0.0.2

data/lib/story_teller/environments/development/notifications.rb

@@ -0,0 +1,286 @@
+module StoryTeller::Notifications
+  INTERNAL_PARAMS = %w(controller action format _method only_path)
+  VIEWS_PATTERN = /^\/app\/views\//
+
+  ActiveSupport::Notifications.subscribe("process_action.action_controller") do |event|
+    payload = event.payload
+    additions = ::ActionController::Base.log_process_action(payload)
+    status = payload[:status]
+
+    if status.nil? && (exception_class_name = payload[:exception]&.first)
+      status = ::ActionDispatch::ExceptionWrapper.status_code_for_exception(exception_class_name)
+    end
+
+    color_code = if status.to_i > 399
+      "\e[1;31m%{status}\e[0m"
+    else
+      "\e[1m%{status}\e[0m"
+    end
+
+    StoryTeller.info(
+      "Response: #{color_code} - %{status_code} in %{duration}ms.",
+      controller: payload[:controller],
+      action: payload[:action],
+      allocations: event.allocations,
+      status_code: status,
+      status: Rack::Utils::HTTP_STATUS_CODES[status],
+      duration: event.duration.round,
+      duration_explained: additions.join(" | ")
+    )
+
+    # This newline output is to separate logs from one action to another.
+    # it is only useful in dev to give the user an easier time to browse through
+    # their log
+    STDOUT << "\n"
+  end
+
+  ActiveSupport::Notifications.subscribe("start_processing.action_controller") do |event|
+    payload = event.payload
+    params  = payload[:params].except(*INTERNAL_PARAMS)
+    format  = payload[:format]
+    format  = format.to_s.upcase if format.is_a?(Symbol)
+    format  = "*/*" if format.nil?
+
+    StoryTeller.info("Requested %{controller}#%{action} as %{format}",
+      controller: payload[:controller],
+      action: payload[:action],
+      format: format
+    )
+    StoryTeller.info("Parameters: %{params}", params: params) unless params.empty?
+  end
+
+  ActiveSupport::Notifications.subscribe("render_template.action_view") do |event|
+    path = event.payload[:identifier]
+    if !path.starts_with?(Rails.root.to_s)
+      next
+    end
+
+    path = path.sub(Rails.root.to_s, "").sub(VIEWS_PATTERN, "")
+    StoryTeller.info("Rendered template %{path} in %{duration}ms", 
+      path: path,
+      duration: event.duration.round(1)
+    )
+  end
+
+  ActiveSupport::Notifications.subscribe("render_partial.action_view") do |event|
+    path = event.payload[:identifier]
+    if !path.starts_with?(Rails.root.to_s)
+      next
+    end
+
+    path = path.sub(Rails.root.to_s, "").sub(VIEWS_PATTERN, "")
+    StoryTeller.info("Rendered partial %{path} in %{duration}ms", 
+      path: path,
+      duration: event.duration.round(1)
+    )
+  end
+
+  ActiveSupport::Notifications.subscribe("render_collection.action_view") do |event|
+    path = event.payload[:identifier]
+    if !path.starts_with?(Rails.root.to_s)
+      next
+    end
+
+    path = path.sub(Rails.root.to_s, "").sub(VIEWS_PATTERN, "")
+    StoryTeller.info("Rendered collection of %{size} for %{path} in %{duration}ms", 
+      path: path,
+      size: event.payload,
+      duration: event.duration.round(1)
+    )
+  end
+
+  ActiveSupport::Notifications.subscribe("render_layout.action_view") do |event|
+    path = event.payload[:identifier]
+    if !path.starts_with?(Rails.root.to_s)
+      next
+    end
+
+    path = path.sub(Rails.root.to_s, "").sub(VIEWS_PATTERN, "")
+    StoryTeller.info("Rendered layout %{path} in %{duration}ms", 
+      path: path,
+      duration: event.duration.round(1)
+    )
+  end
+
+  ActiveSupport::Notifications.subscribe("sql.active_record") do |event|
+    payload = event.payload
+
+    if payload[:binds]&.any?
+      StoryTeller.info("%{name} (%{duration}ms) %{sql}",
+        name: payload[:name],
+        duration: event.duration.round(1),
+        sql: payload[:sql],
+      )
+    end
+  end
+
+  ActiveSupport::Notifications.subscribe("deliver.action_mailer") do |event|
+    perform_deliveries = event.payload[:perform_deliveries]
+    if perform_deliveries
+      StoryTeller.info("Delivered mail #{event.payload[:message_id]} (#{event.duration.round(1)}ms)")
+    else
+      StoryTeller.info("Skipped delivery of mail #{event.payload[:message_id]} as `perform_deliveries` is false")
+    end
+  end
+
+  ActiveSupport::Notifications.subscribe("render.action_mailer") do |event|
+    mailer = event.payload[:mailer]
+    action = event.payload[:action]
+    StoryTeller.info("#{mailer}##{action}: processed outbound mail in #{event.duration.round(1)}ms")
+  end
+
+  ActiveSupport::Notifications.subscribe("service_upload.active_storage") do |event|
+    message = "Uploaded file to key: #{event.payload[:key]}"
+    message += " (checksum: #{event.payload[:checksum]})" if event.payload[:checksum]
+
+    StoryTeller.info "[#{event.payload[:service]} Storage] #{message}", duration: event.duration.round(1)
+  end
+
+  ActiveSupport::Notifications.subscribe("service_download.active_storage") do |event|
+    StoryTeller.info "[#{event.payload[:service]} Storage] Downloaded file from key: #{event.payload[:key]}"
+  end
+
+  ActiveSupport::Notifications.subscribe("service_streaming_download.active_storage") do |event|
+    StoryTeller.info "[#{event.payload[:service]} Storage] Downloaded file from key: #{event.payload[:key]}"
+  end
+
+  ActiveSupport::Notifications.subscribe("service_delete.active_storage") do |event|
+    StoryTeller.info "[#{event.payload[:service]} Storage] Deleted file from key: #{event.payload[:key]}"
+  end
+
+  ActiveSupport::Notifications.subscribe("service_delete_prefixed.active_storage") do |event|
+    StoryTeller.info "[#{event.payload[:service]} Storage] Deleted files by key prefix: #{event.payload[:prefix]}"
+  end
+
+  ActiveSupport::Notifications.subscribe("service_exist.active_storage") do |event|
+    StoryTeller.info "[#{event.payload[:service]} Storage] Checked if file exists at key: #{event.payload[:key]} (#{event.payload[:exist] ? "yes" : "no"})"
+  end
+
+  ActiveSupport::Notifications.subscribe("service_url.active_storage") do |event|
+    StoryTeller.info "[#{event.payload[:service]} Storage] Generated URL for file at key: #{event.payload[:key]} (#{event.payload[:url]})"
+  end
+
+  ActiveSupport::Notifications.subscribe("service_mirror.active_storage") do |event|
+    message = "Mirrored file at key: #{event.payload[:key]}"
+    message += " (checksum: #{event.payload[:checksum]})" if event.payload[:checksum]
+
+    StoryTeller.info "[#{event.payload[:service]} Storage] #{message}"
+  end
+
+  ActiveSupport::Notifications.subscribe("enqueue.active_job") do |event|
+    job = event.payload[:job]
+    exception = event.payload[:exception_object]
+    queue_name = event.payload[:adapter].class.name.demodulize.remove("Adapter") + "(#{event.payload[:job].queue_name})"
+
+    if exception
+      StoryTeller.info(
+        "Failed enqueuing %{job_class} to %{queue_name}",
+        job_class: job.class.name,
+        queue_name: queue_name
+      )
+      StoryTeller.error(ex)
+    elsif event.payload[:aborted]
+      StoryTeller.info(
+        "Failed enqueuing %{job_name} to %{queue_name}, a before_enqueue callback halted the enqueuing execution.",
+        job_class: job.class.name,
+        queue_name: queue_name
+      )
+    else
+      StoryTeller.info(
+        "Enqueued %{job_name} (Job ID: %{job_id}) to %{queue_name}",
+        job_id: job.job_id,
+        job_class: job.class.name,
+        queue_name: queue_name
+      )
+    end
+  end
+
+  ActiveSupport::Notifications.subscribe("enqueue_at.active_job") do |event|
+    job = event.payload[:job]
+    ex = event.payload[:exception_object]
+    queue_name = event.payload[:adapter].class.name.demodulize.remove("Adapter") + "(#{event.payload[:job].queue_name})"
+
+    if ex
+      StoryTeller.info(
+        "Failed enqueuing %{job_class} to %{queue_name}",
+        job_class: job.class.name,
+        queue_name: queue_name
+      )
+      StoryTeller.error(StoryTeller::Exception.new(exception: ex))
+    elsif event.payload[:aborted]
+      StoryTeller.info(
+        "Failed enqueuing %{job_class} to %{queue_name}, a before_enqueue callback halted the enqueuing execution.",
+        job_class: job.class.name,
+        queue_name: queue_name
+      )
+    else
+      StoryTeller.info(
+        "Enqueued %{job.class.name} (Job ID: %{job_id}) to %{queue_name} at %{scheduled_at}",
+        job_class: job.class.name,
+        job_id: job.job_id,
+        queue_name: queue_name,
+        scheduled_at: Time.at(event.payload[:job].scheduled_at).utc
+      )
+    end
+  end
+
+  ActiveSupport::Notifications.subscribe("perform_start.active_job") do |event|
+    job = event.payload[:job]
+    StoryTeller.info(
+      "Performing %{job_class} (Job ID: %{job_id}) from %{queue_name} enqueued at %{enqueued_at}",
+        job_class: job.class.name,
+        job_id: job.job_id,
+        queue_name: queue_name,
+        enqueued_at: job.enqueued_at
+    )
+  end
+
+  ActiveSupport::Notifications.subscribe("perform.active_job") do |event|
+    job = event.payload[:job]
+    ex = event.payload[:exception_object]
+    queue_name = event.payload[:adapter].class.name.demodulize.remove("Adapter") + "(#{event.payload[:job].queue_name})"
+    if ex
+      StoryTeller.info("Error performing #{job.class.name} (Job ID: #{job.job_id}) from #{queue_name} in #{event.duration.round(2)}ms")
+      StoryTeller.error(StoryTeller::Exception.new(ex))
+    elsif event.payload[:aborted]
+      StoryTeller.info("Error performing #{job.class.name} (Job ID: #{job.job_id}) from #{queue_name} in #{event.duration.round(2)}ms: a before_perform callback halted the job execution")
+    else
+      StoryTeller.info("Performed #{job.class.name} (Job ID: #{job.job_id}) from #{queue_name} in #{event.duration.round(2)}ms")
+    end
+  end
+
+  ActiveSupport::Notifications.subscribe("enqueue_retry.active_job") do |event|
+    job = event.payload[:job]
+    ex = event.payload[:error]
+    wait = event.payload[:wait]
+
+    if ex
+      StoryTeller.info(
+        "Retrying %{job_class} in %{wait} seconds, due to a %{exception_class}",
+        job_class: job.class,
+        wait: wait.to_i,
+        exception_class: ex.class
+      )
+    else
+      StoryTeller.info(
+        "Retrying %{job_class} in %{wait} seconds",
+        job_class: job.class,
+        wait: wait.to_i
+      )
+    end
+  end
+
+  ActiveSupport::Notifications.subscribe("retry_stopped.active_job") do |event|
+    job = event.payload[:job]
+    ex = event.payload[:error]
+
+    StoryTeller.error(StoryTeller::Exception(exception: ex))
+  end
+
+  ActiveSupport::Notifications.subscribe("discard.active_job") do |event|
+    job = event.payload[:job]
+    ex = event.payload[:error]
+
+    StoryTeller.error(StoryTeller::Exception(exception: ex))
+  end
+end

data/lib/story_teller/environments/development/rack.rb

@@ -0,0 +1,35 @@
+class StoryTeller::Rack < ::ActionDispatch::DebugExceptions
+  def call(env)
+    request_id = request_id(env)
+    request = ActionDispatch::Request.new(env)
+    StoryTeller.chapter(title: "path", subject: request.path) do |chapter|
+      if request_id.present?
+        chapter.attributes["request_id"] = request_id
+      end
+
+      _, headers, body = response = @app.call(env)
+      if headers["X-Cascade"] == "pass"
+        body.close if body.respond_to?(:close)
+        raise ActionController::RoutingError, "No route matches [#{env['REQUEST_METHOD']}] #{env['PATH_INFO'].inspect}"
+      end
+
+      response
+    end
+  rescue Exception => exception
+    invoke_interceptors(request, exception)
+    raise exception unless request.show_exceptions?
+    render_exception(request, exception)
+  ensure
+    ActiveSupport::LogSubscriber.flush_all!
+    StoryTeller::Book.clear!
+  end
+
+  private
+
+  # No-op with StoryTeller. The error is already logged in the chapter defined.
+  def log_error(request, wrapper);end
+
+  def request_id(env)
+    env["action_dispatch.request_id"] || env["HTTP_X_REQUEST_ID"]
+  end
+end

data/lib/story_teller/environments/development/sidekiq.rb

@@ -0,0 +1,33 @@
+module StoryTeller::Middlewares
+  module Sidekiq
+    class Client
+      include ::Sidekiq::ClientMiddleware
+
+      def call(worker, job, queue, redis_pool)
+        chapter = StoryTeller.book.current_chapter
+        if chapter.attributes.key?(:request_id)
+          msg[:request_id] = chapter.attributes[:request_id]
+        end
+
+        yield
+      end
+    end
+
+    class Server
+      include ::Sidekiq::ServerMiddleware
+
+      def call(worker, job, queue)
+        chapter = StoryTeller.book.current_chapter
+        if job.key?(:request_id)
+          chapter.attributes[:request_id] = job[:request_id]
+        end
+
+        chapter[:job] = job.class
+
+        yield
+      ensure
+        StoryTeller::Book.clear!
+      end
+    end
+  end
+end

data/lib/story_teller/environments/development.rb

@@ -0,0 +1,47 @@
+require "story_teller/environments/development/configuration"
+require "story_teller/environments/development/middleware"
+require "story_teller/environments/development/notifications"
+require "story_teller/environments/development/railties"
+
+module StoryTeller::Environments::Development
+  def self.included(mod)
+    StoryTeller::Chapter.prepend(Module.new do
+      attr_accessor :expand_attributes
+      def merge(parent)
+        if parent.expand_attributes || StoryTeller::Book.current_book.expand_attributes
+          self.expand_attributes = true
+        end
+
+        @attributes = parent.attributes.merge(attributes)
+      end
+
+      def expand_attributes
+        @expand_attributes || false
+      end
+    end)
+
+    StoryTeller::Book.prepend(Module.new do
+      attr_accessor :expand_attributes
+
+      def expand_attributes
+        @expand_attributes || false
+      end
+    end)
+
+    mod.extend(Module.new do
+      def expand_attributes!
+        book = StoryTeller::Book.current_book
+        chapter = book.current_chapter
+        if chapter
+          chapter.expand_attributes = true
+        else
+          book.expand_attributes = true
+        end
+      end
+    end)
+  end
+end
+
+module StoryTeller
+  require "story_teller/environments/development/rack"
+end

data/lib/story_teller/environments/production/configuration.rb

@@ -0,0 +1,4 @@
+class StoryTeller::Configuration
+  include StoryTeller::Configurable
+end
+

data/lib/story_teller/environments/production/middleware.rb

@@ -0,0 +1,13 @@
+class StoryTeller::Middleware
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    req = ::ActionDispatch::Request.new(env)
+    StoryTeller.chapter(title: req.params[:controller], subject: req.params[:action]) do
+      @app.call(env)
+    end
+  end
+end
+

data/lib/story_teller/environments/production/rack.rb

@@ -0,0 +1,36 @@
+class StoryTeller::Rack < ::ActionDispatch::DebugExceptions
+  def call(env)
+    request_id = request_id(env)
+    request = ActionDispatch::Request.new(env)
+    StoryTeller.chapter(title: "path", subject: request.path) do |chapter|
+      if request_id.present?
+        chapter.attributes["request_id"] = request_id
+      end
+
+      _, headers, body = response = @app.call(env)
+      if headers["X-Cascade"] == "pass"
+        body.close if body.respond_to?(:close)
+        raise ActionController::RoutingError, "No route matches [#{env['REQUEST_METHOD']}] #{env['PATH_INFO'].inspect}"
+      end
+
+      response
+    end
+  rescue Exception => exception
+    invoke_interceptors(request, exception)
+    raise exception unless request.show_exceptions?
+    render_exception(request, exception)
+  ensure
+    ActiveSupport::LogSubscriber.flush_all!
+    StoryTeller::Book.clear!
+  end
+
+  private
+
+  # No-op with StoryTeller. The error is already logged in the chapter defined.
+  def log_error(request, wrapper);end
+
+  def request_id(env)
+    env["action_dispatch.request_id"] || env["HTTP_X_REQUEST_ID"]
+  end
+end
+

data/lib/story_teller/environments/production.rb

@@ -0,0 +1,6 @@
+require "story_teller/environments/production/configuration"
+require "story_teller/environments/production/middleware"
+require "story_teller/environments/production/rack"
+
+module StoryTeller::Environments::Production
+end

data/lib/story_teller/environments/staging/configuration.rb

@@ -0,0 +1,4 @@
+class StoryTeller::Configuration
+  include StoryTeller::Configurable
+end
+

data/lib/story_teller/environments/staging.rb

@@ -0,0 +1,5 @@
+require "story_teller/environments/staging/configuration"
+
+module StoryTeller::Environments::Staging
+end
+

data/lib/story_teller/environments/test/configuration.rb

@@ -0,0 +1,4 @@
+class StoryTeller::Configuration
+  include StoryTeller::Configurable
+end
+

data/lib/story_teller/environments/test.rb

@@ -0,0 +1,4 @@
+require "story_teller/environments/test/configuration"
+
+module StoryTeller::Environments::Test
+end

data/lib/story_teller/environments.rb

@@ -0,0 +1,4 @@
+module StoryTeller::Environments
+  autoload :Development, "story_teller/environments/development"
+  autoload :Production, "story_teller/environments/production"
+end

data/lib/story_teller/exception.rb

@@ -0,0 +1,23 @@
+class StoryTeller::Exception
+  attr_reader :chapter, :exception, :timestamp
+
+  def initialize(exception:, chapter: nil)
+    self.timestamp = Time.now.utc
+    self.exception = exception
+    self.chapter = chapter
+  end
+
+  def to_hash
+    {
+      timestamp: timestamp.strftime("%s%N"),
+      message: exception.description,
+      data: {
+        story: exception.backtrace,
+        chapter: chapter&.attributes
+      }
+    }
+  end
+
+  private
+  attr_writer :chapter, :exception, :timestamp
+end

data/lib/story_teller/formatters/development/error.rb

@@ -0,0 +1,52 @@
+class StoryTeller::Formatters::Development::Error < StoryTeller::Formatters::Base
+  COLORS = {
+    default: 0,
+    black: 30,
+    red: 31,
+    green: 32,
+    yellow: 33,
+    blue: 34,
+    magenta: 35,
+    cyan: 36,
+    light_gray: 37,
+    light_grey: 37,
+    gray: 90,
+    grey: 90,
+    light_red: 91,
+    light_yellow: 93,
+    light_blue: 95,
+    light_magenta: 94,
+    light_cyan: 96,
+    white: 97
+  }.freeze
+
+  def config
+    @backtrace_cleaner = Rails.backtrace_cleaner
+    @colors = {
+      message: COLORS[:red],
+      trace: "1;#{COLORS[:red]}"
+    }
+  end
+
+
+  def write(story)
+    exception = story.exception
+    output << color("#{exception.class} (#{exception.message})", :message) << "\n"
+
+    trace = @backtrace_cleaner.clean(exception.backtrace, :noise).reverse
+    trace[-1] = color(trace.last, :trace)
+
+    output << "Backtrace: \t" << trace.join("\n\t\t") << "\n"
+
+    if output.respond_to?(:flush)
+      output.flush
+    end
+  end
+
+  private
+
+  def color(text, type)
+    "\e[1;#{@colors[type]}m#{text}\e[0m"
+  end
+
+end

data/lib/story_teller/formatters/development/info.rb

@@ -0,0 +1,85 @@
+class StoryTeller::Formatters::Development::Info < StoryTeller::Formatters::Base
+  COLORS = {
+    default: 0,
+    black: 30,
+    red: 31,
+    green: 32,
+    yellow: 33,
+    blue: 34,
+    magenta: 35,
+    cyan: 36,
+    light_gray: 37,
+    light_grey: 37,
+    gray: 90,
+    grey: 90,
+    light_red: 91,
+    light_yellow: 93,
+    light_blue: 95,
+    light_magenta: 94,
+    light_cyan: 96,
+    white: 97
+  }.freeze
+
+  def config
+    @colors = {
+      key: COLORS[:blue],
+      value: COLORS[:cyan],
+      chapter: COLORS[:green],
+    }
+  end
+
+  def write(story)
+    data = story.to_hash
+    attributes = expand(**data[:data])
+
+    chapter = if data[:data][:chapter].present?
+      data[:data][:chapter].map do |k, v|
+        "#{k.to_s}=#{v.to_s}"
+      end
+    else
+      []
+    end
+
+    output << "[" << color(chapter.join(" "), :chapter) << "] " if chapter.any?
+
+    # Might want to allow this to be configurable by the user which could then
+    # use the color(value, style) method
+    if story.attributes[:level] == :error
+      output << "\e[1;#{COLORS[:red]}m" << data[:message] << "\e[0;#{COLORS[:default]}m"
+    else
+      output << data[:message]
+    end
+
+    if attributes.size > 0
+      if story.chapter&.expand_attributes || StoryTeller::Book.current_book.expand_attributes
+        output << "\n\t" << attributes.join("\n\t")
+      else
+        output << color(" [#{attributes.size} Attribute#{attributes.size > 1 ? "s" : ""}] ", :key)
+      end
+    end
+
+    output << "\n"
+
+    if output.respond_to?(:flush)
+      output.flush
+    end
+  end
+
+  private
+
+  def color(text, type)
+    "\e[#{@colors[type]}m#{text}\e[0m"
+  end
+
+  def expand(**data)
+    elements = []
+
+    if data[:story].present? && data[:story].any?
+      data[:story].each do |k, v|
+        elements.push("#{color(k.to_s, :key)}: #{color(v.to_s, :value)}")
+      end
+    end
+
+    elements
+  end
+end

data/lib/story_teller/formatters/development.rb

@@ -0,0 +1,4 @@
+module StoryTeller::Formatters::Development
+  autoload :Error, "story_teller/formatters/development/error"
+  autoload :Info, "story_teller/formatters/development/info"
+end

data/lib/story_teller/formatters/null.rb

@@ -0,0 +1,3 @@
+class StoryTeller::Formatters::Null < StoryTeller::Formatters::Base
+  def write(story); end
+end

data/lib/story_teller/formatters/structured.rb

@@ -0,0 +1,8 @@
+class StoryTeller::Outputs::Structured < StoryTeller::Outputs::Base
+  def write(story)
+    output << story.to_json << "\n"
+    if output.respond_to?(:flush)
+      output.flush
+    end
+  end
+end