Record time that user responds to user research request, and defaults all users to "to_be_asked"

- Adds a db migration and updated schema/seeds to default all users to "to_be_asked"
- Adds timestamp to record what time the user opted into user research
- sorts the users in the report  that have consented by time of opting in to make it easier to keep track of users
- updates the tests to reflect the new changes

Author: alice-carr

app/input_objects/account/contact_for_research_input.rb

@@ -9,6 +9,7 @@ def submit
     return false if invalid?
 
     user.research_contact_status = research_contact_status
+    user.user_research_opted_in_at = Time.zone.now
     user.save!
   end
 

app/models/user.rb

@@ -23,7 +23,6 @@ class UserAuthenticationException < StandardError; end
   enum :research_contact_status, {
     consented: "consented",
     declined: "declined",
-    not_asked: "not_asked",
     to_be_asked: "to_be_asked",
   }, prefix: "research_contact"
 

app/services/reports/contact_for_research_service.rb

@@ -18,12 +18,12 @@ def rows
   end
 
   def as_data_rows(raw_data)
-    raw_data.map do |name, email, created_at|
-      [{ text: name }, { text: email }, { text: created_at.to_date.to_formatted_s }]
+    raw_data.map do |name, email, user_research_opted_in_at|
+      [{ text: name }, { text: email }, { text: user_research_opted_in_at.to_formatted_s(:long) }]
     end
   end
 
   def user_contact_for_research
-    User.research_contact_consented.order(created_at: :desc).pluck(:name, :email, :created_at)
+    User.research_contact_consented.order(user_research_opted_in_at: :desc).pluck(:name, :email, :user_research_opted_in_at)
   end
 end

config/initializers/warden/strategies/user_research.rb

@@ -17,6 +17,8 @@ def prep_user(auth_hash)
       provider: Settings.auth_provider,
       uid: auth_hash[:uid],
       terms_agreed_at: Time.zone.now,
+      research_contact_status: "declined",
+      user_research_opted_in_at: Time.zone.now,
     )
   end
 

config/locales/en.yml

@@ -1417,9 +1417,9 @@ en:
     back_link: Back to reports
     back_to_feature_usage: Back to feature and answer type usage
     contact_for_research:
-      heading: Users who have agreed to be contacted for user research
+      heading: Users who’ve agreed to be contacted about user research
       table_headings:
-        date_added: Sign up date
+        date_added: Date agreed
         email: Email
         name: Name
       title: Users interested in research

db/migrate/20250403131603_add_contact_for_research_to_users.rb

@@ -0,0 +1,8 @@
+class AddContactForResearchToUsers < ActiveRecord::Migration[8.0]
+  def change
+    change_table(:users, bulk: true) do |t|
+      t.column :research_contact_status, :string, default: "to_be_asked"
+      t.column :user_research_opted_in_at, :datetime
+    end
+  end
+end

db/migrate/20250908155727_add_contact_for_research_to_users.rb

@@ -25,7 +25,8 @@
                                 uid: "123456",
                                 provider: :mock_gds_sso,
                                 terms_agreed_at: Time.zone.now,
-                                research_contact_status: :consented })
+                                research_contact_status: :consented,
+                                user_research_opted_in_at: Time.zone.now })
 
   MouSignature.create! user: default_user, organisation: gds
 
@@ -57,6 +58,7 @@
     organisation: test_org,
     provider: :seed,
     research_contact_status: :consented,
+    user_research_opted_in_at: Time.zone.now,
   )
 
   # create extra super admins
@@ -90,6 +92,7 @@
     terms_agreed_at: Time.utc(2024, 4, 22, 9, 30),
     provider: :seed,
     research_contact_status: :consented,
+    user_research_opted_in_at: Time.utc(2024, 4, 22, 9, 30),
   )
 
   # while we're using Signon it is possible to have users who aren't linked to

db/schema.rb

@@ -10,6 +10,8 @@
     updated_at { created_at }
     last_signed_in_at { created_at }
     terms_agreed_at { Time.zone.now }
+    research_contact_status { "declined" }
+    user_research_opted_in_at { Time.zone.now }
 
     factory :basic_auth_user do
       provider { "basic_auth" }