Spoof browser time (#5431)

* Added sinon library to spoof browser time during tests

* Updated deadline_day_controller to force RRule to calculate the next occurrence after today

* Updated reminder schedule form tests to run on specific dates and times

* Fixed deadline and reminder form shared example assuming the form always used the same path

* Swapped explicit path names for refresh, fixed the partner page not being handled correctly, applied linter

* Forgot sinon

Author: Benjamin-Couey

app/javascript/controllers/deadline_day_controller.js

@@ -44,13 +44,14 @@ export default class extends Controller {
     let today = new Date();
     let untilDate = new Date( today );
     untilDate.setMonth( untilDate.getMonth() + monthlyInterval + 1 )
-
+    
     if (this.byDayOfMonthTarget.checked && this.dayOfMonthTarget.value) {
       const rule = new RRule({
         dtstart: new Date(Date.UTC(today.getFullYear(), today.getMonth(), today.getDate(), 12)),
         freq: RRule.MONTHLY,
         interval: monthlyInterval,
         bymonthday: parseInt(this.dayOfMonthTarget.value),
+        byhour: 11, // Force RRule to calculate an occurrance after today
         until: untilDate
       })
       reminder_date = this.getFirstOccurrenceAfterToday( rule.all(), today )
@@ -61,6 +62,7 @@ export default class extends Controller {
         freq: RRule.MONTHLY,
         interval: monthlyInterval,
         byweekday: WEEKDAY_NUM_TO_OBJ[ parseInt(this.dayOfWeekTarget.value) ].nth( parseInt(this.everyNthDayTarget.value) ),
+        byhour: 11, // Force RRule to calculate an occurrance after today
         wkst: RRule.SU,
         until: untilDate
       })

app/views/layouts/application.html.erb

@@ -16,6 +16,23 @@
     # DO NOT LOAD ANY JAVASCRIPT BEFORE THIS!!!
     javascript_importmap_tags
   %>
+
+  <!-- Use sinon to make sure the browser's time matches Rails' potentially spoofed time.
+  Be sure to navigate to the page under test AFTER spoofing Rails' time or there will be a
+  mismatch. -->
+  <% if Rails.env.test? %>
+    <script type="module">
+      import sinon from "sinon"
+      if( window.fakeTimerClock ){
+        window.fakeTimerClock.restore();
+      }
+      window.fakeTimerClock = sinon.useFakeTimers({
+        now: <%= Time.now.to_i * 1000 %>,
+        shouldAdvanceTime: true
+      })
+    </script>
+  <% end %>
+
   <%= raw fullstory_script(current_user: current_user) if Rails.env.production? %>
   <script type="esms-options">
   {

config/importmap.rb

@@ -36,3 +36,4 @@
 pin "@rails/activestorage", to: "@rails--activestorage.js" # @8.0.100
 pin "rrule", to: "https://ga.jspm.io/npm:[email protected]/dist/esm/index.js" # @2.8.1
 pin "tslib", to: "https://ga.jspm.io/npm:[email protected]/tslib.es6.mjs" # @2.8.1
+pin "sinon" # @21.0.0

spec/support/deadline_day_fields_shared_example.rb

@@ -22,7 +22,7 @@ def safe_subtract_days(date, num)
   result
 end
 
-RSpec.shared_examples_for "deadline and reminder form" do |form_prefix, save_button, post_form_submit|
+RSpec.shared_examples_for "deadline and reminder form" do |form_prefix, save_button, post_form_submit, post_refresh|
   it "can set a reminder on a day of the month" do
     choose "Day of Month"
     fill_in "#{form_prefix}_reminder_schedule_service_day_of_month", with: 1
@@ -74,12 +74,17 @@ def safe_subtract_days(date, num)
     expect(page).to have_content("Deadline day must be between 1 and 28")
   end
 
-  # These tests make assertions about the dates calculated by the javascript in deadline_day_controller.js
-  # Because we currently don't have a great way of spoofing the date the headless browser sees during tests, they
-  # cannot effectively set the date for the tests (like with travel_to) and have to make due with the actual datetime
-  # of whenever the test is run. To the best of my knowledge, the tests are sound but be aware that they could
-  # pass or fail based on when they are run!
-  describe "reported reminder and deadline dates" do
+  RSpec.shared_examples_for "reported reminder and deadline dates" do |datetime|
+    before do
+      if datetime
+        travel_to datetime
+      end
+      refresh
+      if post_refresh
+        send(post_refresh)
+      end
+    end
+
     context "when the reminder is a day of the month" do
       before do
         choose "Day of Month"
@@ -169,4 +174,16 @@ def calc_every_nth_day(target_date)
       end
     end
   end
+
+  context "at the end of the month" do
+    it_behaves_like "reported reminder and deadline dates", Time.zone.local(2025, 9, 30)
+  end
+
+  context "in the middle of the month" do
+    it_behaves_like "reported reminder and deadline dates", Time.zone.local(2025, 9, 14)
+  end
+
+  context "at the start of the month" do
+    it_behaves_like "reported reminder and deadline dates", Time.zone.local(2025, 9, 1)
+  end
 end

spec/system/organization_system_spec.rb

@@ -74,6 +74,8 @@ def post_form_submit
       it_behaves_like "deadline and reminder form", "organization", "Save", :post_form_submit
 
       it "the deadline day form's reminder and deadline dates are consistent with the dates calculated by the FetchPartnersToRemindNowService and DeadlineService" do
+        travel_to Time.zone.local(2025, 9, 30)
+        refresh
         choose "Day of Month"
         fill_in "organization_reminder_schedule_service_day_of_month", with: safe_add_days(Time.zone.now, 1).day
         fill_in "Deadline day in reminder email", with: safe_add_days(Time.zone.now, 2).day

spec/system/partner_system_spec.rb

@@ -758,6 +758,11 @@
         end
 
         describe "editing a custom reminder schedule" do
+          def post_refresh
+            # Opt in to sending deadline reminders
+            check 'Yes'
+          end
+
           before do
             partner.update!(partner_group: existing_partner_group)
             visit partners_path
@@ -766,13 +771,15 @@
             assert page.has_content? existing_partner_group.name, wait: page_content_wait
 
             click_on 'Edit'
-            # Opt in to sending deadline reminders
-            check 'Yes'
+            post_refresh
           end
 
-          it_behaves_like "deadline and reminder form", "partner_group", "Update Partner Group"
+          it_behaves_like "deadline and reminder form", "partner_group", "Update Partner Group", nil, :post_refresh
 
           it "the deadline day form's reminder and deadline dates are consistent with the dates calculated by the FetchPartnersToRemindNowService and DeadlineService" do
+            travel_to Time.zone.local(2025, 9, 30)
+            refresh
+            post_refresh
             choose "Day of Month"
             fill_in "partner_group_reminder_schedule_service_day_of_month", with: safe_add_days(Time.zone.now, 1).day
             fill_in "Deadline day in reminder email", with: safe_add_days(Time.zone.now, 2).day