AO3-6467 Record Fannish Next of Kin changes in user history

app/controllers/admin/admin_users_controller.rb

@@ -47,7 +47,7 @@ def show
     @user = authorize User.find_by!(login: params[:id])
     @hide_dashboard = true
     @page_subtitle = t(".page_title", login: @user.login)
-    @log_items = @user.log_items.sort_by(&:created_at).reverse
+    log_items
   end
 
   # POST admin/users/update
@@ -75,6 +75,12 @@ def update_next_of_kin
     if kin.blank? && kin_email.blank?
       if fnok.present?
         fnok.destroy
+        @user.create_log_item({
+                                action: ArchiveConfig.ACTION_REMOVE_FNOK,
+                                fnok_user_id: fnok.kin.id,
+                                admin_id: current_admin.id,
+                                note: "Change made by #{current_admin.login}"
+                              })
         flash[:notice] = ts("Fannish next of kin was removed.")
       end
       redirect_to admin_user_path(@user)
@@ -84,11 +90,17 @@ def update_next_of_kin
     fnok = @user.build_fannish_next_of_kin if fnok.blank?
     fnok.assign_attributes(kin: kin, kin_email: kin_email)
     if fnok.save
+      @user.create_log_item({
+                              action: ArchiveConfig.ACTION_ADD_FNOK,
+                              fnok_user_id: fnok.kin.id,
+                              admin_id: current_admin.id,
+                              note: "Change made by #{current_admin.login}"
+                            })
       flash[:notice] = ts("Fannish next of kin was updated.")
       redirect_to admin_user_path(@user)
     else
       @hide_dashboard = true
-      @log_items = @user.log_items.sort_by(&:created_at).reverse
+      log_items
       render :show
     end
   end
@@ -168,4 +180,8 @@ def activate
       redirect_to action: :show
     end
   end
+
+  def log_items
+    @log_items ||= (@user.log_items + LogItem.where(fnok_user_id: @user.id)).sort_by(&:created_at).reverse
+  end
 end

app/helpers/users_helper.rb

@@ -119,31 +119,66 @@ def authored_items(pseud, work_counts = {}, rec_counts = {})
     items.html_safe
   end
 
-  def log_item_action_name(action)
-    if action == ArchiveConfig.ACTION_ACTIVATE
-      t('users_helper.log_validated', default: 'Account Validated')
-    elsif action == ArchiveConfig.ACTION_ADD_ROLE
-      t('users_helper.log_role_added', default: 'Role Added: ')
-    elsif action == ArchiveConfig.ACTION_REMOVE_ROLE
-      t('users_helper.log_role_removed', default: 'Role Removed: ')
-    elsif action == ArchiveConfig.ACTION_SUSPEND
-      t('users_helper.log_suspended', default: 'Suspended until ')
-    elsif action == ArchiveConfig.ACTION_UNSUSPEND
-      t('users_helper.log_lift_suspension', default: 'Suspension Lifted')
-    elsif action == ArchiveConfig.ACTION_BAN
-      t('users_helper.log_ban', default: 'Suspended Permanently')
-    elsif action == ArchiveConfig.ACTION_WARN
-      t('users_helper.log_warn', default: 'Warned')
-    elsif action == ArchiveConfig.ACTION_RENAME
-      t('users_helper.log_rename', default: 'Username Changed')
-    elsif action == ArchiveConfig.ACTION_PASSWORD_RESET
-      t('users_helper.log_password_change', default: 'Password Changed')
-    elsif action == ArchiveConfig.ACTION_NEW_EMAIL
-      t('users_helper.log_email_change', default: 'Email Changed')
-    elsif action == ArchiveConfig.ACTION_TROUBLESHOOT
-      t('users_helper.log_troubleshot', default: 'Account Troubleshot')
-    elsif action == ArchiveConfig.ACTION_NOTE
-      t('users_helper.log_note', default: 'Note Added')
+  def log_item_action_name(item, user)
+    action = item.action
+
+    if [ArchiveConfig.ACTION_ADD_FNOK, ArchiveConfig.ACTION_REMOVE_FNOK].include?(action)
+      if item.fnok_user_id == user.id
+        if action == ArchiveConfig.ACTION_REMOVE_FNOK
+          return t(
+            "users_helper.log_removed_as_fnok",
+            default: "Removed as Fannish Next of Kin for: %{user_id}",
+            user_id: item.user_id
+          )
+        end
+
+        return t(
+          "users_helper.log_added_as_fnok",
+          default: "Added as Fannish Next of Kin for: %{user_id}",
+          user_id: item.user_id
+        )
+      end
+
+      if action == ArchiveConfig.ACTION_REMOVE_FNOK
+        return t(
+          "users_helper.log_remove_fnok",
+          default: "Fannish Next of Kin Removed: %{user_id}",
+          user_id: item.fnok_user_id
+        )
+      end
+
+      return t(
+        "users_helper.log_add_fnok",
+        default: "Fannish Next of Kin Added: %{user_id}",
+        user_id: item.fnok_user_id
+      )
+    end
+
+    case action
+    when ArchiveConfig.ACTION_ACTIVATE
+      t("users_helper.log_validated", default: "Account Validated")
+    when ArchiveConfig.ACTION_ADD_ROLE
+      t("users_helper.log_role_added", default: "Role Added: ")
+    when ArchiveConfig.ACTION_REMOVE_ROLE
+      t("users_helper.log_role_removed", default: "Role Removed: ")
+    when ArchiveConfig.ACTION_SUSPEND
+      t("users_helper.log_suspended", default: "Suspended until ")
+    when ArchiveConfig.ACTION_UNSUSPEND
+      t("users_helper.log_lift_suspension", default: "Suspension Lifted")
+    when ArchiveConfig.ACTION_BAN
+      t("users_helper.log_ban", default: "Suspended Permanently")
+    when ArchiveConfig.ACTION_WARN
+      t("users_helper.log_warn", default: "Warned")
+    when ArchiveConfig.ACTION_RENAME
+      t("users_helper.log_rename", default: "Username Changed")
+    when ArchiveConfig.ACTION_PASSWORD_RESET
+      t("users_helper.log_password_change", default: "Password Changed")
+    when ArchiveConfig.ACTION_NEW_EMAIL
+      t("users_helper.log_email_change", default: "Email Changed")
+    when ArchiveConfig.ACTION_TROUBLESHOOT
+      t("users_helper.log_troubleshot", default: "Account Troubleshot")
+    when ArchiveConfig.ACTION_NOTE
+      t("users_helper.log_note", default: "Note Added")
     end
   end
 

app/models/log_item.rb

@@ -7,6 +7,8 @@ class LogItem < ApplicationRecord
 
   belongs_to :role
 
+  belongs_to :fnok_user, class_name: "User"
+
   validates_presence_of :note
   validates_presence_of :action
 

app/views/admin/admin_users/_user_history.html.erb

@@ -36,7 +36,7 @@
          @log_items.each do |item| %>
         <tr>
           <td><%= item.created_at %></td>
-          <td><%= log_item_action_name(item.action) %><%= item.role.name if item.role %><%= item.enddate if item.enddate %></td>
+          <td><%= log_item_action_name(item, @user) %><%= item.role.name if item.role %><%= item.enddate if item.enddate %></td>
           <td><%= item.note %></td>
         </tr>
       <% end %>

config/config.yml

@@ -428,6 +428,8 @@ ACTION_PASSWORD_RESET: 8
 ACTION_NEW_EMAIL: 9
 ACTION_TROUBLESHOOT: 10
 ACTION_NOTE: 11
+ACTION_ADD_FNOK: 12
+ACTION_REMOVE_FNOK: 13
 
 
 # Elasticsearch index prefix

config/i18n-tasks.yml

@@ -166,6 +166,10 @@ ignore_missing:
   - users_helper.log_troubleshot
   - users_helper.log_validated
   - users_helper.log_warn
+  - users_helper.log_add_fnok
+  - users_helper.log_remove_fnok
+  - users_helper.log_added_as_fnok
+  - users_helper.log_removed_as_fnok
   # Files: app/views/admin/_admin_nav.html.erb and app/views/admin_posts/show.html.erb
   - admin.admin_nav.delete
   # File: app/views/admin/admin_invitations/find.html.erb

db/migrate/20230717161221_add_fnok_user_id_to_log_items.rb

@@ -0,0 +1,51 @@
+class AddFnokUserIdToLogItems < ActiveRecord::Migration[6.1]
+  def up
+    if Rails.env.staging? || Rails.env.production?
+      database = LogItem.connection.current_database
+
+      puts <<~PTOSC
+        Schema Change Command:
+
+        pt-online-schema-change D=#{database},t=log_items \\
+          --alter "ADD `fnok_user_id` int,
+                  ADD INDEX `index_log_items_on_fnok_user_id` (`fnok_user_id`)" \\
+          --no-drop-old-table \\
+          -uroot --ask-pass --chunk-size=5k --max-flow-ctl 0 --pause-file /tmp/pauseme \\
+          --max-load Threads_running=15 --critical-load Threads_running=100 \\
+          --set-vars innodb_lock_wait_timeout=2 --alter-foreign-keys-method=auto \\
+          --execute
+
+        Table Deletion Command:
+
+        DROP TABLE IF EXISTS `#{database}`.`_log_items_old`;
+      PTOSC
+    else
+      add_column :log_items, :fnok_user_id, :integer, nullable: true
+      add_index :log_items, :fnok_user_id
+    end
+  end
+
+  def down
+    if Rails.env.staging? || Rails.env.production?
+      database = LogItem.connection.current_database
+
+      puts <<~PTOSC
+        Schema Change Command:
+
+        pt-online-schema-change D=#{database},t=log_items \\
+          --alter "DROP COLUMN `fnok_user_id`"\\
+          --no-drop-old-table \\
+          -uroot --ask-pass --chunk-size=5k --max-flow-ctl 0 --pause-file /tmp/pauseme \\
+          --max-load Threads_running=15 --critical-load Threads_running=100 \\
+          --set-vars innodb_lock_wait_timeout=2 --alter-foreign-keys-method=auto \\
+          --execute
+
+        Table Deletion Command:
+
+        DROP TABLE IF EXISTS `#{database}`.`_log_items_old`;
+      PTOSC
+    else
+      remove_column :log_items, :fnok_user_id
+    end
+  end
+end

factories/fannish_next_of_kin.rb

@@ -0,0 +1,9 @@
+require "faker"
+
+FactoryBot.define do
+  factory :fannish_next_of_kin do
+    user { create(:user) }
+    kin { create(:user) }
+    kin_email { |u| u.kin.email }
+  end
+end

features/admins/users/admin_fnok.feature

@@ -15,6 +15,7 @@ Feature: Admin Fannish Next Of Kind actions
       And I fill in "Fannish next of kin's email" with "[email protected]"
       And I press "Update Fannish Next of Kin"
     Then I should see "Fannish next of kin was updated."
+    Then I should see "Fannish Next of Kin Added"
 
     When I go to the manage users page
       And I fill in "Name" with "harrykim"
@@ -24,6 +25,9 @@ Feature: Admin Fannish Next Of Kind actions
     When I follow "libby"
     Then I should be on libby's user page
 
+    When I go to the user administration page for "libby"
+    Then I should see "Added as Fannish Next of Kin"
+
   Scenario: An invalid Fannish Next of Kin username is added
     Given the fannish next of kin "libby" for the user "harrykim"
       And I am logged in as a "support" admin
@@ -66,6 +70,9 @@ Feature: Admin Fannish Next Of Kind actions
       And I fill in "Fannish next of kin's email" with ""
       And I press "Update Fannish Next of Kin"
     Then I should see "Fannish next of kin was removed."
+      And I should see "Fannish Next of Kin Removed"
+    When I go to the user administration page for "libby"
+    Then I should see "Removed as Fannish Next of Kin"
 
   Scenario: A Fannish Next of Kin updates when the next of kin user changes their username
     Given the fannish next of kin "libby" for the user "harrykim"

spec/controllers/admin/admin_users_controller_spec.rb

@@ -226,6 +226,39 @@
         it_behaves_like "authorized admin can add next of kin"
       end
     end
+
+    it "logs adding a fannish next of kin" do
+      admin = create(:support_admin)
+      fake_login_admin(admin)
+
+      post :update_next_of_kin, params: {
+        user_login: user.login, next_of_kin_name: kin.login, next_of_kin_email: kin.email
+      }
+      user.reload
+      expect(user.fannish_next_of_kin.kin).to eq(kin)
+      log_item = user.log_items.last
+      expect(log_item.action).to eq(ArchiveConfig.ACTION_ADD_FNOK)
+      expect(log_item.fnok_user.id).to eq(kin.id)
+      expect(log_item.admin_id).to eq(admin.id)
+      expect(log_item.note).to eq("Change made by #{admin.login}")
+    end
+
+    it "logs removing a fannish next of kin" do
+      admin = create(:support_admin)
+      fake_login_admin(admin)
+      kin_user_id = create(:fannish_next_of_kin, user: user).kin_id
+
+      post :update_next_of_kin, params: {
+        user_login: user.login
+      }
+      user.reload
+      expect(user.fannish_next_of_kin).to be_nil
+      log_item = user.log_items.last
+      expect(log_item.action).to eq(ArchiveConfig.ACTION_REMOVE_FNOK)
+      expect(log_item.fnok_user.id).to eq(kin_user_id)
+      expect(log_item.admin_id).to eq(admin.id)
+      expect(log_item.note).to eq("Change made by #{admin.login}")
+    end
   end
 
   describe "POST #update_status" do