Move some Roda plugins out of server default and into SSR plugin

- Add new documentation on how Roda is configured
- BREAKING CHANGE: the `flash` plugin is no longer loaded by the file-based routes plugin by default, it's now configured with `sessions: true` in the ssr plugin init. Flash required sessions to be set up anyway, which used to be manual but is now provided by this new config.

Author: jaredcwhite

bridgetown-core/lib/bridgetown-core/rack/boot.rb

@@ -24,14 +24,6 @@ def self.boot(*)
         Bridgetown::Utils::LoadersManager.new(Bridgetown::Current.preloaded_configuration)
       Bridgetown::Current.preloaded_configuration.run_initializers! context: :server
       autoload_server_folder
-    rescue Roda::RodaError => e
-      if e.message.include?("sessions plugin :secret option")
-        raise Bridgetown::Errors::InvalidConfigurationError,
-              "The Roda sessions plugin can't find a valid secret. Run `bin/bridgetown secret' " \
-              "and put the key in a ENV var you can use to configure the session in the Roda app"
-      end
-
-      raise e
     end
 
     # @param root [String] root of Bridgetown site, defaults to config value

bridgetown-core/lib/bridgetown-core/utils/initializers.rb

@@ -4,9 +4,9 @@
   Bridgetown.load_dotenv root: config.root_dir
 end
 
-Bridgetown.initializer :ssr do |config, setup: nil|
+Bridgetown.initializer :ssr do |config, setup: nil, **options|
   config.roda do |app|
-    app.plugin(:bridgetown_ssr, &setup)
+    app.plugin(:bridgetown_ssr, options, &setup)
   end
 end
 

bridgetown-core/lib/roda/plugins/bridgetown_server.rb

@@ -13,14 +13,9 @@ def self.load_dependencies(app) # rubocop:disable Metrics
 
         app.extend ClassMethods # we need to do this here because Roda hasn't done it yet
         app.plugin :initializers
-        app.plugin :method_override
-        app.plugin :all_verbs
-        app.plugin :hooks
         app.plugin :common_logger, Bridgetown::Rack::Logger.new($stdout), method: :info
         app.plugin :json
         app.plugin :json_parser
-        app.plugin :indifferent_params
-        app.plugin :cookies, path: "/"
         app.plugin :ssg, root: Bridgetown::Current.preloaded_configuration.destination
         app.plugin :not_found do
           output_folder = Bridgetown::Current.preloaded_configuration.destination

bridgetown-core/lib/roda/plugins/bridgetown_ssr.rb

@@ -13,13 +13,31 @@ def bridgetown_site
         alias_method :site, :bridgetown_site
       end
 
-      def self.load_dependencies(app)
-        app.plugin :custom_block_results
+      def self.load_dependencies(app, opts = { sessions: false })
+        app.plugin :all_verbs
+        app.plugin :cookies, path: "/"
+        app.plugin :indifferent_params
+        app.plugin :method_override
+        app.plugin :route_csrf
 
         # This lets us return callable objects directly in Roda response blocks
+        app.plugin :custom_block_results
         app.handle_block_result(Bridgetown::RodaCallable) do |callable|
           callable.(self)
         end
+
+        return unless opts[:sessions]
+
+        secret_key = ENV.fetch("RODA_SECRET_KEY", nil)
+        unless secret_key
+          raise Bridgetown::Errors::InvalidConfigurationError,
+                "The Roda sessions plugin can't find a valid secret. Run " \
+                "`bin/bridgetown secret' and put the key in your ENV as the " \
+                "RODA_SECRET_KEY variable"
+        end
+
+        app.plugin :sessions, secret: secret_key
+        app.plugin :flashier
       end
 
       def self.configure(app, _opts = {}, &)

bridgetown-core/lib/roda/plugins/flashier.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+class Roda
+  module RodaPlugins
+    module Flashier
+      module FlashHashAdditions
+        def info
+          self["info"]
+        end
+
+        def info=(val)
+          self["info"] = val
+        end
+
+        def alert
+          self["alert"]
+        end
+
+        def alert=(val)
+          self["alert"] = val
+        end
+      end
+
+      module FlashHashIndifferent
+        def []=(key, val)
+          @next[key.to_s] = val
+        end
+      end
+
+      module FlashNowHashIndifferent
+        def []=(key, val)
+          super(key.to_s, val)
+        end
+
+        def [](key)
+          super(key.to_s)
+        end
+      end
+
+      def self.load_dependencies(app)
+        require "roda/plugins/flash"
+
+        Roda::RodaPlugins::Flash::FlashHash.include FlashHashAdditions, FlashHashIndifferent
+        Roda::RodaPlugins::Flash::FlashHash.class_eval do
+          def initialize(hash = {})
+            super(hash || {})
+            now.singleton_class.include FlashHashAdditions, FlashNowHashIndifferent
+            @next = {}
+          end
+        end
+        app.plugin :flash
+      end
+    end
+
+    register_plugin :flashier, Flashier
+  end
+end

bridgetown-core/lib/site_template/config/initializers.rb

@@ -68,6 +68,8 @@
   #
   # init :ssr
   #
+  # Add `sessions: true` if you need to use session data, flash, etc.
+  #
 
   # Uncomment to use file-based dynamic template routing via Roda (make sure you
   # uncomment the gem dependency in your `Gemfile` as well):

bridgetown-core/test/ssr/config/local_ssr_init.rb

@@ -2,6 +2,7 @@
 
 Bridgetown.initializer :local_ssr_init do |config|
   config.init :ssr do
+    sessions true
     setup -> site do # rubocop:disable Layout/SpaceInLambdaLiteral, Style/StabbyLambdaParentheses
       site.data.iterations ||= 0
       site.data.iterations += 1

bridgetown-core/test/ssr/server/routes/flashy.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class Routes::Flashy < Bridgetown::Rack::Routes
+  route do |r|
+    # route: POST /flashy/:name
+    r.post "flashy", String do |name|
+      flash.info = "Save this value: #{name}"
+    end
+
+    r.get "flashy" do
+      { saved: flash.info }
+    end
+  end
+end

bridgetown-core/test/test_ssr.rb

@@ -8,7 +8,10 @@ class TestSSR < BridgetownUnitTest
   include Rack::Test::Methods
 
   def app
-    @@ssr_app ||= Rack::Builder.parse_file(File.expand_path("ssr/config.ru", __dir__)) # rubocop:disable Style/ClassVars
+    @@ssr_app ||= begin # rubocop:disable Style/ClassVars
+      ENV["RODA_SECRET_KEY"] = SecureRandom.hex(64)
+      Rack::Builder.parse_file(File.expand_path("ssr/config.ru", __dir__))
+    end
   end
 
   def site
@@ -93,5 +96,13 @@ def site
       assert_equal "application/rss+xml", last_response["Content-Type"]
       assert_equal "<rss>WOW true</rss>", last_response.body
     end
+
+    should "return flash value" do
+      post "/flashy/abc12356"
+
+      get "/flashy"
+
+      assert_equal({ "saved" => "Save this value: abc12356" }, JSON.parse(last_response.body))
+    end
   end
 end