Add status codes to URL rewrites

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    katalyst-koi (4.3.1)
+    katalyst-koi (4.3.2)
       bcrypt
       importmap-rails
       katalyst-content

app/assets/javascripts/koi/admin.js

@@ -7,5 +7,8 @@ import "koi/controllers";
 /** Let GOVUK know that we've got JS enabled */
 window.addEventListener("turbo:load", () => {
   document.body.classList.toggle("js-enabled", true);
-  document.body.classList.toggle("govuk-frontend-supported", ('noModule' in HTMLScriptElement.prototype));
+  document.body.classList.toggle(
+    "govuk-frontend-supported",
+    "noModule" in HTMLScriptElement.prototype,
+  );
 });

app/controllers/admin/url_rewrites_controller.rb

@@ -56,7 +56,7 @@ def destroy
     private
 
     def url_rewrite_params
-      params.require(:url_rewrite).permit(:from, :to, :active)
+      params.require(:url_rewrite).permit(:from, :to, :status_code, :active)
     end
 
     def set_url_rewrite

app/models/url_rewrite.rb

@@ -1,6 +1,18 @@
 # frozen_string_literal: true
 
 class UrlRewrite < ApplicationRecord
+  StatusCode = Struct.new(:code, :label)
+
+  STATUS_CODES = [
+    StatusCode.new(303, "See other"),
+    StatusCode.new(307, "Temporary redirect"),
+    StatusCode.new(308, "Permanent redirect"),
+  ].freeze
+
+  enum status_code: STATUS_CODES.map(&:code).index_by(&:itself)
+
+  attribute :status_code, :integer, default: 303
+
   validates :from, :to, presence: true
   validates :from, format: { with: %r{\A/.*\z}, message: "should start with /" }
 
@@ -15,10 +27,6 @@ def to_s
     where(arel_table[:from].matches("%#{query}%").or(arel_table[:to].matches("%#{query}%")))
   end
 
-  def self.redirect_path_for(path)
-    active.find_by(from: path).try(:to)
-  end
-
   def title
     from.delete_prefix("/")
   end

app/views/admin/url_rewrites/_fields.html.erb

@@ -0,0 +1,4 @@
+<%= form.govuk_text_field :from, hint: { text: "Should begin with /" } %>
+<%= form.govuk_text_field :to %>
+<%= form.govuk_collection_radio_buttons :status_code, UrlRewrite::STATUS_CODES, :code, :label %>
+<%= form.govuk_check_box_field :active %>

app/views/admin/url_rewrites/edit.html.erb

@@ -3,7 +3,7 @@
 <% end %>
 
 <%= form_with(model: url_rewrite, url: admin_url_rewrite_path(url_rewrite)) do |form| %>
-  <%= render "form_fields", form: %>
+  <%= render "fields", form: %>
 
   <div class="actions">
     <%= form.admin_save %>

app/views/admin/url_rewrites/new.html.erb

@@ -3,7 +3,7 @@
 <% end %>
 
 <%= form_with(model: url_rewrite, url: admin_url_rewrites_path) do |form| %>
-  <%= render "form_fields", form: %>
+  <%= render "fields", form: %>
 
   <div class="actions">
     <%= form.admin_save %>

db/migrate/20231211005214_add_status_code_to_url_rewrites.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddStatusCodeToUrlRewrites < ActiveRecord::Migration[7.1]
+  def change
+    add_column :url_rewrites, :status_code, :integer, null: false, default: 303
+  end
+end

katalyst-koi.gemspec

@@ -3,7 +3,7 @@
 # Describe your gem and declare its dependencies:
 Gem::Specification.new do |s|
   s.name        = "katalyst-koi"
-  s.version     = "4.3.1"
+  s.version     = "4.3.2"
   s.authors     = ["Katalyst Interactive"]
   s.email       = ["[email protected]"]
 

lib/koi/middleware/url_redirect.rb

@@ -11,15 +11,15 @@ def call(env)
 
       current_path = env["REQUEST_URI"]
 
-      if status.to_i == 404 && (new_path = find_redirect(current_path))
+      if status.to_i == 404 && (redirect = UrlRewrite.active.find_by(from: current_path))
         request = ActionDispatch::Request.new(env)
 
         # Close the body as we will not use it for a 301 redirect
         body.close
 
-        # Issue a "Moved permanently" response with the redirect location
-        [301, { "Location" => new_location(current_path, new_path, request) },
-         ["#{current_path} moved. The document has moved to #{new_path}"]]
+        # Return a redirect response
+        [redirect.status_code, { "Location" => new_location(current_path, redirect.to, request) },
+         ["#{redirect.from} moved. The document has moved to #{redirect.to}"]]
       else
         # Not a 404 or no redirect found, just send the response as is
         [status, headers, body]
@@ -35,9 +35,5 @@ def new_location(current_path, new_path, request)
         request.original_url.gsub(current_path, new_path)
       end
     end
-
-    def find_redirect(path)
-      UrlRewrite.redirect_path_for(path)
-    end
   end
 end

spec/models/url_rewrite_spec.rb

@@ -15,10 +15,4 @@
 
     it { is_expected.to include(url_rewrite) }
   end
-
-  describe "#redirect_path_for" do
-    subject { described_class.redirect_path_for(url_rewrite.from) }
-
-    it { is_expected.to eq(url_rewrite.to) }
-  end
 end