hanami 2.0.0.rc1 → 2.0.1

data/lib/hanami/web/rack_logger.rb

@@ -8,6 +8,9 @@ module Hanami
     # @api private
     # @since 2.0.0
     class RackLogger
+      EMPTY_PARAMS = {}.freeze
+      private_constant :EMPTY_PARAMS
+
       REQUEST_METHOD = "REQUEST_METHOD"
       private_constant :REQUEST_METHOD
 
@@ -29,10 +32,46 @@ module Hanami
       CONTENT_LENGTH = "Content-Length"
       private_constant :CONTENT_LENGTH
 
+      MILISECOND = "ms"
+      private_constant :MILISECOND
+
+      MICROSECOND = "µs"
+      private_constant :MICROSECOND
+
+      # Dynamic extension used in production environments
+      # @api private
+      module Production
+        private
+
+        # @since 1.0.0
+        # @api private
+        def data(env, status:, elapsed:)
+          payload = super
+          payload[:elapsed] = elapsed
+          payload[:elapsed_unit] = MICROSECOND
+          payload
+        end
+      end
+
+      # Dynamic extension used in non-production environments
+      # @api private
+      module Development
+        private
+
+        # @since 1.0.0
+        # @api private
+        def data(env, status:, elapsed:)
+          payload = super
+          payload[:elapsed] = elapsed > 1000 ? "#{elapsed / 1000}ms" : "#{elapsed}#{MICROSECOND}"
+          payload
+        end
+      end
+
       # @api private
       # @since 2.0.0
-      def initialize(logger)
+      def initialize(logger, env: :development)
         @logger = logger
+        extend(env == :production ? Production : Development)
       end
 
       # @api private
@@ -43,36 +82,46 @@ module Hanami
         end
 
         rack_monitor.on :error do |event|
-          log_exception event[:exception]
+          # TODO: why we don't provide time on error?
+          log_exception event[:env], event[:exception], 500, 0
         end
       end
 
       # @api private
       # @since 2.0.0
       def log_request(env, status, elapsed)
-        data = {
-          verb: env[REQUEST_METHOD],
-          status: status,
-          elapsed: "#{elapsed}ms",
-          ip: env[HTTP_X_FORWARDED_FOR] || env[REMOTE_ADDR],
-          path: env[SCRIPT_NAME] + env[PATH_INFO].to_s,
-          length: extract_content_length(env),
-          params: env[ROUTER_PARAMS]
-        }
-
-        logger.info(data)
+        logger.tagged(:rack) do
+          logger.info(data(env, status: status, elapsed: elapsed))
+        end
       end
 
       # @api private
       # @since 2.0.0
-      def log_exception(exception)
-        logger.error(exception)
+      def log_exception(env, exception, status, elapsed)
+        logger.tagged(:rack) do
+          logger.error(exception, **data(env, status: status, elapsed: elapsed))
+        end
       end
 
       private
 
       attr_reader :logger
 
+      # @api private
+      # @since 2.0.0
+      def data(env, status:, elapsed:)
+        {
+          verb: env[REQUEST_METHOD],
+          status: status,
+          ip: env[HTTP_X_FORWARDED_FOR] || env[REMOTE_ADDR],
+          path: "#{env[SCRIPT_NAME]}#{env[PATH_INFO]}",
+          length: extract_content_length(env),
+          params: env.fetch(ROUTER_PARAMS, EMPTY_PARAMS)
+        }
+      end
+
+      # @api private
+      # @since 2.0.0
       def extract_content_length(env)
         value = env[CONTENT_LENGTH]
         !value || value.to_s == "0" ? "-" : value

data/lib/hanami.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "pathname"
 require "zeitwerk"
 require_relative "hanami/constants"
 
@@ -36,7 +37,8 @@ module Hanami
     app_path = self.app_path
 
     if app_path
-      require(app_path)
+      prepare_load_path
+      require(app_path.to_s)
       app
     elsif raise_exception
       raise(
@@ -47,6 +49,23 @@ module Hanami
     end
   end
 
+  # Prepare the load path as early as possible (based on the default root inferred from the location
+  # of `config/app.rb`), so `require` can work at the top of `config/app.rb`. This may be useful
+  # when external classes are needed for configuring certain aspects of the app.
+  #
+  # @api private
+  # @since 2.0.0
+  private_class_method def self.prepare_load_path
+    lib_path = app_path&.join("..", "..", LIB_DIR)
+
+    if lib_path&.directory?
+      path = lib_path.realpath.to_s
+      $LOAD_PATH.prepend(path) unless $LOAD_PATH.include?(path)
+    end
+
+    lib_path
+  end
+
   # Returns the Hamami app class.
   #
   # To ensure your Hanami app is loaded, run {.setup} (or `require "hanami/setup"`) first.
@@ -98,10 +117,10 @@ module Hanami
   # Searches within the given directory, then searches upwards through parent directories until the
   # app file can be found.
   #
-  # @param dir [String] The directory from which to start searching. Defaults to the current
-  #   directory.
+  # @param dir [String, Pathname] The directory from which to start searching. Defaults to the
+  #   current directory.
   #
-  # @return [String, nil] the app file path, or nil if not found.
+  # @return [Pathname, nil] the app file path, or nil if not found.
   #
   # @api public
   # @since 2.0.0
@@ -110,7 +129,7 @@ module Hanami
     path = dir.join(APP_PATH)
 
     if path.file?
-      path.to_s
+      path
     elsif !dir.root?
       app_path(dir.parent)
     end

data/spec/integration/action/format_config_spec.rb

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+
+require "json"
+require "rack/test"
+
+RSpec.describe "App action / Format config", :app_integration do
+  include Rack::Test::Methods
+
+  let(:app) { Hanami.app }
+
+  around do |example|
+    with_tmp_directory(Dir.mktmpdir, &example)
+  end
+
+  it "adds a body parser middleware for the accepted formats from the action config" do
+    write "config/app.rb", <<~RUBY
+      require "hanami"
+
+      module TestApp
+        class App < Hanami::App
+          config.logger.stream = StringIO.new
+
+          config.actions.format :json
+        end
+      end
+    RUBY
+
+    write "config/routes.rb", <<~RUBY
+      module TestApp
+        class Routes < Hanami::Routes
+          post "/users", to: "users.create"
+        end
+      end
+    RUBY
+
+    write "app/action.rb", <<~RUBY
+      # auto_register: false
+
+      module TestApp
+        class Action < Hanami::Action
+        end
+      end
+    RUBY
+
+    write "app/actions/users/create.rb", <<~RUBY
+      module TestApp
+        module Actions
+          module Users
+            class Create < TestApp::Action
+              def handle(req, res)
+                res.body = req.params[:users].join("-")
+              end
+            end
+          end
+        end
+      end
+    RUBY
+
+    require "hanami/boot"
+
+    post(
+      "/users",
+      JSON.generate("users" => %w[jane john jade joe]),
+      "CONTENT_TYPE" => "application/json"
+    )
+
+    expect(last_response).to be_successful
+    expect(last_response.body).to eql("jane-john-jade-joe")
+  end
+
+  specify "adds a body parser middleware configured to parse any custom content type for the accepted formats" do
+    write "config/app.rb", <<~RUBY
+      require "hanami"
+
+      module TestApp
+        class App < Hanami::App
+          config.logger.stream = StringIO.new
+
+          config.actions.formats.add :json, ["application/json+scim", "application/json"]
+        end
+      end
+    RUBY
+
+    write "config/routes.rb", <<~RUBY
+      module TestApp
+        class Routes < Hanami::Routes
+          post "/users", to: "users.create"
+        end
+      end
+    RUBY
+
+    write "app/action.rb", <<~RUBY
+      # auto_register: false
+
+      module TestApp
+        class Action < Hanami::Action
+        end
+      end
+    RUBY
+
+    write "app/actions/users/create.rb", <<~RUBY
+      module TestApp
+        module Actions
+          module Users
+            class Create < TestApp::Action
+              def handle(req, res)
+                res.body = req.params[:users].join("-")
+              end
+            end
+          end
+        end
+      end
+    RUBY
+
+    require "hanami/boot"
+
+    post(
+      "/users",
+      JSON.generate("users" => %w[jane john jade joe]),
+      "CONTENT_TYPE" => "application/json+scim"
+    )
+
+    expect(last_response).to be_successful
+    expect(last_response.body).to eql("jane-john-jade-joe")
+
+    post(
+      "/users",
+      JSON.generate("users" => %w[jane john jade joe]),
+      "CONTENT_TYPE" => "application/json"
+    )
+
+    expect(last_response).to be_successful
+    expect(last_response.body).to eql("jane-john-jade-joe")
+  end
+
+  it "does not add a body parser middleware if one is already added" do
+    write "config/app.rb", <<~RUBY
+      require "hanami"
+
+      module TestApp
+        class App < Hanami::App
+          config.logger.stream = StringIO.new
+
+          config.actions.format :json
+          config.middleware.use :body_parser, [json: "application/json+custom"]
+        end
+      end
+    RUBY
+
+    write "config/routes.rb", <<~RUBY
+      module TestApp
+        class Routes < Hanami::Routes
+          post "/users", to: "users.create"
+        end
+      end
+    RUBY
+
+    write "app/action.rb", <<~RUBY
+      # auto_register: false
+
+      module TestApp
+        class Action < Hanami::Action
+        end
+      end
+    RUBY
+
+    write "app/actions/users/create.rb", <<~RUBY
+      module TestApp
+        module Actions
+          module Users
+            class Create < TestApp::Action
+              config.formats.clear
+
+              def handle(req, res)
+                res.body = req.params[:users].join("-")
+              end
+            end
+          end
+        end
+      end
+    RUBY
+
+    require "hanami/boot"
+
+    post(
+      "/users",
+      JSON.generate("users" => %w[jane john jade joe]),
+      "CONTENT_TYPE" => "application/json+custom"
+    )
+
+    expect(last_response).to be_successful
+    expect(last_response.body).to eql("jane-john-jade-joe")
+  end
+end

data/spec/integration/action/slice_configuration_spec.rb

@@ -34,24 +34,25 @@ RSpec.describe "App action / Slice configuration", :app_integration do
       it "applies default actions config from the app", :aggregate_failures do
         prepare_app
 
-        expect(TestApp::Action.config.default_request_format).to eq :html
-        expect(TestApp::Action.config.default_response_format).to eq :html
+        expect(TestApp::Action.config.formats.values).to eq []
       end
 
       it "applies actions config from the app" do
-        Hanami.app.config.actions.default_response_format = :json
+        Hanami.app.config.actions.format :json
 
         prepare_app
 
-        expect(TestApp::Action.config.default_response_format).to eq :json
+        expect(TestApp::Action.config.formats.values).to eq [:json]
       end
 
       it "does not override config in the base class" do
-        Hanami.app.config.actions.default_response_format = :csv
+        Hanami.app.config.actions.format :csv
 
         prepare_app
 
-        TestApp::Action.config.default_response_format = :json
+        TestApp::Action.config.format :json
+
+        expect(TestApp::Action.config.formats.values).to eq [:json]
       end
     end
 
@@ -74,24 +75,23 @@ RSpec.describe "App action / Slice configuration", :app_integration do
       it "applies default actions config from the app", :aggregate_failures do
         prepare_app
 
-        expect(TestApp::Actions::Articles::Index.config.default_request_format).to eq :html
-        expect(TestApp::Actions::Articles::Index.config.default_response_format).to eq :html
+        expect(TestApp::Actions::Articles::Index.config.formats.values).to eq []
       end
 
       it "applies actions config from the app" do
-        Hanami.app.config.actions.default_response_format = :json
+        Hanami.app.config.actions.format :json
 
         prepare_app
 
-        expect(TestApp::Actions::Articles::Index.config.default_response_format).to eq :json
+        expect(TestApp::Actions::Articles::Index.config.formats.values).to eq [:json]
       end
 
       it "applies config from the base class" do
         prepare_app
 
-        TestApp::Action.config.default_response_format = :json
+        TestApp::Action.config.format :json
 
-        expect(TestApp::Actions::Articles::Index.config.default_response_format).to eq :json
+        expect(TestApp::Actions::Articles::Index.config.formats.values).to eq [:json]
       end
     end
 
@@ -114,24 +114,23 @@ RSpec.describe "App action / Slice configuration", :app_integration do
       it "applies default actions config from the app", :aggregate_failures do
         prepare_app
 
-        expect(Admin::Actions::Articles::Index.config.default_request_format).to eq :html
-        expect(Admin::Actions::Articles::Index.config.default_response_format).to eq :html
+        expect(Admin::Actions::Articles::Index.config.formats.values).to eq []
       end
 
       it "applies actions config from the app" do
-        Hanami.app.config.actions.default_response_format = :json
+        Hanami.app.config.actions.format :json
 
         prepare_app
 
-        expect(Admin::Actions::Articles::Index.config.default_response_format).to eq :json
+        expect(Admin::Actions::Articles::Index.config.formats.values).to eq [:json]
       end
 
       it "applies config from the base class" do
         prepare_app
 
-        TestApp::Action.config.default_response_format = :json
+        TestApp::Action.config.format :json
 
-        expect(Admin::Actions::Articles::Index.config.default_response_format).to eq :json
+        expect(Admin::Actions::Articles::Index.config.formats.values).to eq [:json]
       end
     end
   end
@@ -152,24 +151,23 @@ RSpec.describe "App action / Slice configuration", :app_integration do
       it "applies default actions config from the app", :aggregate_failures do
         prepare_app
 
-        expect(Admin::Action.config.default_request_format).to eq :html
-        expect(Admin::Action.config.default_response_format).to eq :html
+        expect(Admin::Action.config.formats.values).to eq []
       end
 
       it "applies actions config from the app" do
-        Hanami.app.config.actions.default_response_format = :json
+        Hanami.app.config.actions.format :json
 
         prepare_app
 
-        expect(Admin::Action.config.default_response_format).to eq :json
+        expect(Admin::Action.config.formats.values).to eq [:json]
       end
 
       it "applies config from the app base class" do
         prepare_app
 
-        TestApp::Action.config.default_response_format = :json
+        TestApp::Action.config.format :json
 
-        expect(Admin::Action.config.default_response_format).to eq :json
+        expect(Admin::Action.config.formats.values).to eq [:json]
       end
 
       context "slice actions config present" do
@@ -178,7 +176,7 @@ RSpec.describe "App action / Slice configuration", :app_integration do
             write "config/slices/admin.rb", <<~'RUBY'
               module Admin
                 class Slice < Hanami::Slice
-                  config.actions.default_response_format = :csv
+                  config.actions.format :csv
                 end
               end
             RUBY
@@ -188,24 +186,24 @@ RSpec.describe "App action / Slice configuration", :app_integration do
         it "applies actions config from the slice" do
           prepare_app
 
-          expect(Admin::Action.config.default_response_format).to eq :csv
+          expect(Admin::Action.config.formats.values).to eq [:csv]
         end
 
         it "prefers actions config from the slice over config from the app-level base class" do
           prepare_app
 
-          TestApp::Action.config.default_response_format = :json
+          TestApp::Action.config.format :json
 
-          expect(Admin::Action.config.default_response_format).to eq :csv
+          expect(Admin::Action.config.formats.values).to eq [:csv]
         end
 
         it "prefers config from the base class over actions config from the slice" do
           prepare_app
 
-          TestApp::Action.config.default_response_format = :csv
-          Admin::Action.config.default_response_format = :json
+          TestApp::Action.config.format :csv
+          Admin::Action.config.format :json
 
-          expect(Admin::Action.config.default_response_format).to eq :json
+          expect(Admin::Action.config.formats.values).to eq [:json]
         end
       end
     end
@@ -229,16 +227,15 @@ RSpec.describe "App action / Slice configuration", :app_integration do
       it "applies default actions config from the app", :aggregate_failures do
         prepare_app
 
-        expect(Admin::Actions::Articles::Index.config.default_request_format).to eq :html
-        expect(Admin::Actions::Articles::Index.config.default_response_format).to eq :html
+        expect(Admin::Actions::Articles::Index.config.formats.values).to eq []
       end
 
       it "applies actions config from the app" do
-        Hanami.app.config.actions.default_response_format = :json
+        Hanami.app.config.actions.format :json
 
         prepare_app
 
-        expect(Admin::Actions::Articles::Index.config.default_response_format).to eq :json
+        expect(Admin::Actions::Articles::Index.config.formats.values).to eq [:json]
       end
 
       it "applies actions config from the slice" do
@@ -246,7 +243,7 @@ RSpec.describe "App action / Slice configuration", :app_integration do
           write "config/slices/admin.rb", <<~'RUBY'
             module Admin
               class Slice < Hanami::Slice
-                config.actions.default_response_format = :json
+                config.actions.format :json
               end
             end
           RUBY
@@ -254,15 +251,15 @@ RSpec.describe "App action / Slice configuration", :app_integration do
 
         prepare_app
 
-        expect(Admin::Actions::Articles::Index.config.default_response_format).to eq :json
+        expect(Admin::Actions::Articles::Index.config.formats.values).to eq [:json]
       end
 
       it "applies config from the slice base class" do
         prepare_app
 
-        Admin::Action.config.default_response_format = :json
+        Admin::Action.config.format :json
 
-        expect(Admin::Actions::Articles::Index.config.default_response_format).to eq :json
+        expect(Admin::Actions::Articles::Index.config.formats.values).to eq [:json]
       end
 
       it "prefers config from the slice base class over actions config from the slice" do
@@ -270,7 +267,7 @@ RSpec.describe "App action / Slice configuration", :app_integration do
           write "config/slices/admin.rb", <<~'RUBY'
             module Admin
               class Slice < Hanami::Slice
-                config.actions.default_response_format = :csv
+                config.actions.format :csv
               end
             end
           RUBY
@@ -278,9 +275,9 @@ RSpec.describe "App action / Slice configuration", :app_integration do
 
         prepare_app
 
-        Admin::Action.config.default_response_format = :json
+        Admin::Action.config.format :json
 
-        expect(Admin::Actions::Articles::Index.config.default_response_format).to eq :json
+        expect(Admin::Actions::Articles::Index.config.formats.values).to eq [:json]
       end
     end
   end

data/spec/integration/code_loading/loading_from_lib_spec.rb

@@ -82,6 +82,40 @@ RSpec.describe "Code loading / Loading from lib directory", :app_integration do
     end
   end
 
+  describe "default root with requires at top of app file" do
+    before :context do
+      with_directory(@dir = make_tmp_directory.realpath) do
+        write "config/app.rb", <<~'RUBY'
+          require "hanami"
+          require "external_class"
+
+          module TestApp
+            class App < Hanami::App
+              @class_from_lib = ExternalClass
+
+              def self.class_from_lib
+                @class_from_lib
+              end
+            end
+          end
+        RUBY
+
+        write "lib/external_class.rb", <<~'RUBY'
+          class ExternalClass
+          end
+        RUBY
+      end
+    end
+
+    before do
+      with_directory(@dir) { require "hanami/setup" }
+    end
+
+    specify "classes in lib/ can be required directly from the top of the app file" do
+      expect(Hanami.app.class_from_lib).to be ExternalClass
+    end
+  end
+
   context "app root reconfigured" do
     before :context do
       with_directory(@dir = make_tmp_directory.realpath) do

data/spec/integration/dotenv_loading_spec.rb

@@ -5,6 +5,7 @@
 RSpec.describe "Dotenv loading", :app_integration do
   before do
     @orig_env = ENV.to_h
+    allow(Hanami::Env).to receive(:loaded?).and_return(false)
   end
 
   after do

data/spec/integration/rack_app/body_parser_spec.rb

@@ -18,6 +18,7 @@ RSpec.describe "Hanami web app", :app_integration do
 
       module TestApp
         class App < Hanami::App
+          config.actions.format :json
           config.middleware.use :body_parser, :json
           config.logger.stream = StringIO.new
         end
@@ -37,8 +38,6 @@ RSpec.describe "Hanami web app", :app_integration do
         module Actions
           module Users
             class Create < Hanami::Action
-              accept :json
-
               def handle(req, res)
                 res.body = req.params[:users].join("-")
               end
@@ -66,7 +65,7 @@ RSpec.describe "Hanami web app", :app_integration do
 
       module TestApp
         class App < Hanami::App
-          config.actions.formats["application/json+scim"] = :json
+          config.actions.formats.add :json, ["application/json+scim"]
           config.middleware.use :body_parser, [json: "application/json+scim"]
           config.logger.stream = StringIO.new
         end
@@ -86,8 +85,6 @@ RSpec.describe "Hanami web app", :app_integration do
         module Actions
           module Users
             class Create < Hanami::Action
-              accept :json
-
               def handle(req, res)
                 res.body = req.params[:users].join("-")
               end