Bug/56771 meeting timestamp in edit form not the same as in details #16567

ulferts · 2024-08-30T14:37:05Z

Ticket

https://community.openproject.org/wp/56771

What are you trying to accomplish?

The PR ensures that times and time zones displayed in the meetings module are always in the time zone of the current user. The bug originally reported in the work package could not be reproduced but before, different code paths have been used for rendering the time zone and the calculation on times was in part achieved by setting the request's time to be in the current user's time.

What approach did you choose and why?

Querying for User.current.time_zone will now always return a value. It will never be nil. Either the time zone selected by the user or the time zone set as the default (Setting.user_default_timezone) is returned. This already used to be the case for logged in users. For those, in case no default is set, UTC is now returned. Internally, it was already handled as such as both server and database are running on UTC. The internal users (e.g. AnonymousUser) follow the same pattern.
The i18n helpers for format_time and format_date_as_time have been simplified. There used to be code in there that was working with the localtime. Since a few rails versions back, the server is always running in UTC so there is no need for this code. The only times now necessary are UTC and the user's local time. The server's local time should have no effect. Those methods get their signature updated to use named parameters.
formatted_time_zone_offset is added to I18n which will give the currently active time offset to the user's time zone compared to UTC. This is now employed throughout the meeting module.
Because time/date calculations are now handled at the places that matter, the before action that changed the request's time zone is no longer necessary and is thus removed.
The user settings time zone select field has it's blank value removed. This is in line with the user always having UTC as their fallback timezone. Along the same line of thinking it would make sense to remove the blank value from the Setting.user_default_timezone select and set the value to UTC as a default but this is not done in the scope of this PR.

Merge checklist

Added/updated tests

The system did this anyway, but now it becomes explicit

With the server now always running in UTC time, using the local time makes no sense any more

ulferts · 2024-09-06T12:52:16Z

Rubocop is complaining about the complexity of a method touched within the PR. The PR only changes the call signature of a method called from within the complained about method. Therefore, I deem it ok to not improve that method.

cbliard

Really nice refactoring 👏 It simplifies the code dealing with time zones and removes a lot of useless code which is always a good sign.

I only have some minor improvement suggestions.
Feel free to merge whenever you see fit.

For that long method rubocop is complaining about, if it's ok to keep it, then it could be # rubocop:disable Metrics/AbcSize.

app/models/user.rb

cbliard · 2024-09-09T08:57:33Z

app/models/anonymous_user.rb

@@ -49,7 +49,7 @@ def name(*_args); I18n.t(:label_user_anonymous) end

  def mail; nil end

-  def time_zone; nil end
+  def time_zone; ActiveSupport::TimeZone[Setting.user_default_timezone.presence || "Etc/UTC"] end


Why not rely on the default implementation of User#time_zone? Implementation is

class User def time_zone @time_zone ||= ActiveSupport::TimeZone[pref.time_zone] || ActiveSupport::TimeZone["Etc/UTC"] end end

As a pref record does not exist for AnonymousUser, it would be automatically built without touching the db and its time_zone will return the right value, so it should work as expected.

Same applies for DeletedUser and SystemUser.

cbliard · 2024-09-09T09:00:20Z

app/views/users/_preferences.html.erb

    container_class: (defined? input_size) ? "-#{input_size}" : "-wide"
  )
+


Unneeded new line

cbliard · 2024-09-09T09:02:52Z

lib_static/redmine/i18n.rb

-      local = if zone
-                time.in_time_zone(zone)
-              else
-                (time.utc? ? time.to_time.localtime : time)
-              end
+      local = time.in_time_zone(zone)


cbliard · 2024-09-09T09:13:23Z

modules/meeting/app/controllers/meetings_controller.rb

+      unless User.current.pref.time_zone?
+        link = I18n.t(:notice_timezone_missing, zone: formatted_time_zone_offset)
        text += " #{view_context.link_to(link, { controller: '/my', action: :settings, anchor: 'pref_time_zone' },
                                         class: 'link_to_profile')}"


I tried it. When there is no time zone set for the user, the message is displayed inviting the user to set a time zone, but the notification disappears after 5 seconds (or so). This is extremely short to read and take action. I suggest the success toast should not autoclose in this case. Probably worth a new bug work package for it.

cbliard · 2024-09-09T09:14:23Z

modules/meeting/app/controllers/meetings_controller.rb

-  def set_time_zone(&)
-    zone = User.current.time_zone
-    if zone.nil?
-      localzone = Time.current.utc_offset
-      localzone -= 3600 if Time.current.dst?
-      zone = ::ActiveSupport::TimeZone[localzone]
-    end
-
-    Time.use_zone(zone, &)
-  end


Goodbye buggy code (a dst is not always 1h).

cbliard · 2024-09-09T09:26:51Z

lib_static/redmine/i18n.rb

@@ -133,18 +129,25 @@ def format_time_as_date(time, format = nil)
      end
    end

-    def format_time(time, include_date = true)
+    def format_time(time, include_date: true, format: Setting.time_format)


It's hard to know that this method uses user time zone without reading its code. We could rename it, but I propose adding some docs for it.

Suggested change

def format_time(time, include_date: true, format: Setting.time_format)

# Formats the given time as a time string according to the user's time zone

# and optional specified format.

#

# @param time [Time, String] The time to format. Can be a Time object or a

# String.

# @param include_date [Boolean] Whether to include the date in the formatted

# output. Defaults to true.

# @param format [String] The strftime format to use for the time. Defaults

# to the format in `Setting.time_format`.

# @return [String, nil] The formatted time string, or nil if the time is not

# provided.

def format_time(time, include_date: true, format: Setting.time_format)

cbliard · 2024-09-09T09:36:56Z

lib_static/redmine/i18n.rb

@@ -116,15 +116,11 @@ def link_regex
    # Format the time to a date in the user time zone if one is set.
    # If none is set and the time is in utc time zone (meaning it came from active record), format the date in the system timezone
    # otherwise just use the date in the time zone attached to the time.
-    def format_time_as_date(time, format = nil)
+    def format_time_as_date(time, format: nil)


Documentation is not up-to-date anymore

Here is a proposal:

# Formats the given time as a date string according to the user's time zone and # optional specified format. # # @param time [Time, String] The time to format. Can be a Time object or a String. # @param format [String, nil] The strftime format to use for the date. If nil, the default # date format from `Setting.date_format` is used. # @return [String, nil] The formatted date string, or nil if the time is not provided. def format_time_as_date(time, format: nil)

cbliard · 2024-09-09T09:38:21Z

spec/lib/redmine/i18n_spec.rb

-    after do
-      Time.zone = nil
-    end
+    describe "#format_time_as_date" do


There are no tests taking time parameter as string. Not sure if it's used that way in our code and how it deals with time strings without timezone information.
Not sure it's worth it though.

same for #format_time.

ulferts added 13 commits August 30, 2024 09:50

restructure i18n spec - use Time.use_zone instead of Time.zone

0495a96

introduce a helper method for rendering the user's time zone

b840990

remove width limitation to reliably show selected option

8252131

use UTC time zone as user pref if non is explicitly configured

6298b87

The system did this anyway, but now it becomes explicit

factor DST into the calculation of the formatted time zone offset

b27f164

remove local time reference from format_time_as_date

1373a18

With the server now always running in UTC time, using the local time makes no sense any more

remove around_action altering the server`s time zone for this request

ebc6cdf

use named parameter

8b004a1

include fallback to user_default_timezone and utc into all system users

35ca717

fix showing a message in case no own time zone is configured

48377fc

nil memoized tz variable on reload

1d7fd3c

adapt specs to use actual UTC time zone

a5714f7

increase time_zone robustness

4c61ce1

ulferts force-pushed the bug/56771-meeting-timestamp-in-edit-form-not-the-same-as-in-details branch from c234011 to 4c61ce1 Compare September 6, 2024 08:16

ulferts marked this pull request as ready for review September 6, 2024 12:52

ulferts added the needs review label Sep 6, 2024

cbliard approved these changes Sep 9, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bug/56771 meeting timestamp in edit form not the same as in details #16567

Bug/56771 meeting timestamp in edit form not the same as in details #16567

ulferts commented Aug 30, 2024 •

edited

Loading

ulferts commented Sep 6, 2024

cbliard left a comment

cbliard Sep 9, 2024

cbliard Sep 9, 2024

cbliard Sep 9, 2024

cbliard Sep 9, 2024

cbliard Sep 9, 2024

cbliard Sep 9, 2024

cbliard Sep 9, 2024

cbliard Sep 9, 2024

cbliard Sep 9, 2024

		container_class: (defined? input_size) ? "-#{input_size}" : "-wide"
		)

-    def format_time(time, include_date: true, format: Setting.time_format)
+    # Formats the given time as a time string according to the user's time zone
+    # and optional specified format.
+    #
+    # @param time [Time, String] The time to format. Can be a Time object or a
+    #   String.
+    # @param include_date [Boolean] Whether to include the date in the formatted
+    #   output. Defaults to true.
+    # @param format [String] The strftime format to use for the time. Defaults
+    #   to the format in `Setting.time_format`.
+    # @return [String, nil] The formatted time string, or nil if the time is not
+    #   provided.
+    def format_time(time, include_date: true, format: Setting.time_format)

Bug/56771 meeting timestamp in edit form not the same as in details #16567

Are you sure you want to change the base?

Bug/56771 meeting timestamp in edit form not the same as in details #16567

Conversation

ulferts commented Aug 30, 2024 • edited Loading

Ticket

What are you trying to accomplish?

What approach did you choose and why?

Merge checklist

ulferts commented Sep 6, 2024

cbliard left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ulferts commented Aug 30, 2024 •

edited

Loading