Improve rendering of relative timestamps

This improves a few things about the way we render timestamps based on
feedback on the mailinglist:

1. Allow users to configure if they want to see relative timestamps or not
2. Only show one level of precision, so no "1 month, 1 day"
3. Add precision at the "seconds" level
4. Add a special case for "yesterday"

Also changes how we render

Author: JelteF

pgcommitfest/commitfest/templates/commitfest.html

@@ -65,13 +65,13 @@ <h3>{{p.is_open|yesno:"Active patches,Closed patches"}}</h3>
      {%if not cfb %}
       <span class="label label-default">Not processed</span>
      {%elif p.needs_rebase_since %}
-      <a href="{{cfb.apply_url}}" title="View git apply logs. Needs rebase since {{p.needs_rebase_since|timesince}}. {%if p.failing_since and p.failing_since != p.needs_rebase_since %}Failing since {{p.failing_since|timesince}}.{%endif%}">
+      <a href="{{cfb.apply_url}}" title="View git apply logs. Needs rebase {% cfsince p.needs_rebase_since %}. {%if p.failing_since and p.failing_since != p.needs_rebase_since %}Failing {% cfsince p.failing_since %}.{%endif%}">
        <span class="label label-warning">Needs rebase!</span>
       </a>
      {%else%}
       <a href="https://github.com/postgresql-cfbot/postgresql/compare/cf/{{p.id}}~1...cf/{{p.id}}" title="View last patch set on GitHub"><img class="github-logo" src="/media/commitfest/github-mark.svg"/></a>
       <a href="https://cirrus-ci.com/github/postgresql-cfbot/postgresql/cf%2F{{p.id}}"
-         title="View CI history. {%if p.failing_since%}Failing since {{p.failing_since|timesince}}. {%endif%}{%if cfb.failed_task_names %}Failed jobs: {{cfb.failed_task_names}}{%endif%}">
+         title="View CI history. {%if p.failing_since%}Failing {% cfsince p.failing_since %}. {%endif%}{%if cfb.failed_task_names %}Failed jobs: {{cfb.failed_task_names}}{%endif%}">
        {%if cfb.failed > 0 or cfb.branch_status == 'failed' or cfb.branch_status == 'timeout' %}
         <img src="/media/commitfest/new_failure.svg"/>
        {%elif cfb.completed < cfb.total  %}
@@ -95,7 +95,7 @@ <h3>{{p.is_open|yesno:"Active patches,Closed patches"}}</h3>
     <td>{{p.reviewer_names|default:''}}</td>
     <td>{{p.committer|default:''}}</td>
     <td>{{p.num_cfs}}</td>
-    <td style="white-space: nowrap;" title="{{p.lastmail}}">{%if p.lastmail %}{{p.lastmail|timesince}} ago{%endif%}</td>
+    <td style="white-space: nowrap;" title="{{p.lastmail}}">{%if p.lastmail and user.userprofile.show_relative_timestamps %}{% cfwhen p.lastmail %}{%elif p.lastmail %}{{p.lastmail|date:"Y-m-d"}}<br/>{{p.lastmail|date:"H:i"}}{%endif%}</td>
     {%if user.is_staff%}
      <td style="white-space: nowrap;"><input type="checkbox" class="sender_checkbox" id="send_authors_{{p.id}}">Author<br/><input type="checkbox" class="sender_checkbox" id="send_reviewers_{{p.id}}">Reviewer</td>
     {%endif%}

pgcommitfest/commitfest/templates/me.html

@@ -59,13 +59,13 @@ <h3>{%if user.is_authenticated%}Open patches you are subscribed to{%elif p.is_op
      {%if not cfb %}
       <span class="label label-default">Not processed</span>
      {%elif p.needs_rebase_since %}
-      <a href="{{cfb.apply_url}}" title="View git apply logs. Needs rebase since {{p.needs_rebase_since|timesince}}. {%if p.failing_since and p.failing_since != p.needs_rebase_since %}Failing since {{p.failing_since|timesince}}.{%endif%}">
+      <a href="{{cfb.apply_url}}" title="View git apply logs. Needs rebase {% cfsince p.needs_rebase_since %}. {%if p.failing_since and p.failing_since != p.needs_rebase_since %}Failing {% cfsince p.failing_since %}.{%endif%}">
        <span class="label label-warning">Needs rebase!</span>
       </a>
      {%else%}
       <a href="https://github.com/postgresql-cfbot/postgresql/compare/cf/{{p.id}}~1...cf/{{p.id}}" title="View last patch set on GitHub"><img class="github-logo" src="/media/commitfest/github-mark.svg"/></a>
       <a href="https://cirrus-ci.com/github/postgresql-cfbot/postgresql/cf%2F{{p.id}}"
-         title="View CI history. {%if p.failing_since%}Failing since {{p.failing_since|timesince}}. {%endif%}{%if cfb.failed_task_names %}Failed jobs: {{cfb.failed_task_names}}{%endif%}">
+         title="View CI history. {%if p.failing_since%}Failing {% cfsince p.failing_since %}. {%endif%}{%if cfb.failed_task_names %}Failed jobs: {{cfb.failed_task_names}}{%endif%}">
        {%if cfb.failed > 0 or cfb.branch_status == 'failed' or cfb.branch_status == 'timeout' %}
         <img src="/media/commitfest/new_failure.svg"/>
        {%elif cfb.completed < cfb.total  %}
@@ -89,7 +89,7 @@ <h3>{%if user.is_authenticated%}Open patches you are subscribed to{%elif p.is_op
     <td>{{p.reviewer_names|default:''}}</td>
     <td>{{p.committer|default:''}}</td>
     <td>{{p.num_cfs}}</td>
-    <td style="white-space: nowrap;" title="{{p.lastmail}}">{%if p.lastmail %}{{p.lastmail|timesince}} ago{%endif%}</td>
+    <td style="white-space: nowrap;" title="{{p.lastmail}}">{%if p.lastmail and user.userprofile.show_relative_timestamps %}{% cfwhen p.lastmail %}{%elif p.lastmail %}{{p.lastmail|date:"Y-m-d"}}<br/>{{p.lastmail|date:"H:i"}}{%endif%}</td>
    </tr>
    {%if forloop.last%}
     </tbody>

pgcommitfest/commitfest/templates/patch.html

@@ -20,7 +20,7 @@
      {%elif cfbot_branch.needs_rebase_since %}
       <a href="{{cfbot_branch.apply_url}}">
        <span class="label label-warning" title="View git apply logs">Needs rebase!</span></a>
-      Needs rebase since {{cfbot_branch.needs_rebase_since|timesince}}. {%if cfbot_branch.failing_since and cfbot_branch.failing_since != cfbot_branch.needs_rebase_since %}Failing since {{cfbot_branch.failing_since|timesince}}. {%endif%}<br>Additional links previous successfully applied patch (outdated):<br>
+      Needs rebase {% cfsince cfbot_branch.needs_rebase_since %}. {%if cfbot_branch.failing_since and cfbot_branch.failing_since != cfbot_branch.needs_rebase_since %}Failing {% cfsince cfbot_branch.failing_since %}. {%endif%}<br>Additional links previous successfully applied patch (outdated):<br>
       <a href="https://github.com/postgresql-cfbot/postgresql/compare/cf/{{patch.id}}~1...cf/{{patch.id}}" title="View previous successfully applied patch set on GitHub"><img class="github-logo" src="/media/commitfest/github-mark.svg"/></a>
       <a href="https://cirrus-ci.com/github/postgresql-cfbot/postgresql/cf%2F{{patch.id}}">
        <span class="label label-default">Summary</span></a>
@@ -73,11 +73,11 @@
    </tr>
    <tr>
     <th style="white-space: nowrap;">Last modified</th>
-    <td>{{patch.modified}} ({{patch.modified|timesince}} ago)</td>
+    <td>{{patch.modified}} ({% cfwhen patch.modified %})</td>
    </tr>
    <tr>
     <th style="white-space: nowrap;">Latest email</th>
-    <td>{%if patch.lastmail%}{{patch.lastmail}} ({{patch.lastmail|timesince}} ago){%endif%}</td>
+    <td>{%if patch.lastmail%}{{patch.lastmail}} ({% cfwhen patch.lastmail %}){%endif%}</td>
    </tr>
    <tr>
     <th>Status</th>

pgcommitfest/commitfest/templatetags/commitfest.py

@@ -1,6 +1,11 @@
 from django import template
 from django.template.defaultfilters import stringfilter
+from django.utils.html import avoid_wrapping
+from django.utils.timesince import MONTHS_DAYS
+from django.utils.timezone import is_aware
+from django.utils.translation import ngettext_lazy
 
+import datetime
 from uuid import uuid4
 
 from pgcommitfest.commitfest.models import CommitFest, PatchOnCommitFest
@@ -75,3 +80,141 @@ def static_file_param():
 @stringfilter
 def hidemail(value):
     return value.replace("@", " at ")
+
+
+TIME_STRINGS = {
+    "year": ngettext_lazy("%(num)d year", "%(num)d years", "num"),
+    "month": ngettext_lazy("%(num)d month", "%(num)d months", "num"),
+    "week": ngettext_lazy("%(num)d week", "%(num)d weeks", "num"),
+    "day": ngettext_lazy("%(num)d day", "%(num)d days", "num"),
+    "hour": ngettext_lazy("%(num)d hour", "%(num)d hours", "num"),
+    "minute": ngettext_lazy("%(num)d minute", "%(num)d minutes", "num"),
+    "second": ngettext_lazy("%(num)d second", "%(num)d seconds", "num"),
+}
+
+TIME_STRINGS_KEYS = list(TIME_STRINGS.keys())
+
+TIME_CHUNKS = [
+    60 * 60 * 24 * 7,  # week
+    60 * 60 * 24,  # day
+    60 * 60,  # hour
+    60,  # minute
+    1,  # second
+]
+
+
+@register.simple_tag(takes_context=True)
+def cfsince(context, d):
+    if (
+        context["user"].is_authenticated
+        and not context["user"].userprofile.show_relative_timestamps
+    ):
+        return f"since {d}"
+    partials = cf_duration_partials(d)
+    if partials is None:
+        return "since some time in the future"
+
+    # Find the first non-zero part (if any) and then build the result, until
+    # depth.
+    i = 0
+    for i, value in enumerate(partials):
+        if value != 0:
+            break
+    else:
+        return "since now"
+
+    value = partials[i]
+    name = TIME_STRINGS_KEYS[i]
+    if name == "day" and value == 1:
+        return avoid_wrapping("since yesterday")
+    return avoid_wrapping("since " + TIME_STRINGS[name] % {"num": value})
+
+
+@register.simple_tag()
+def cfwhen(d):
+    partials = cf_duration_partials(d)
+    if partials is None:
+        return "some time in the future"
+
+    # Find the first non-zero part (if any) and then build the result, until
+    # depth.
+    i = 0
+    for i, value in enumerate(partials):
+        if value != 0:
+            break
+    else:
+        return "now"
+
+    value = partials[i]
+    name = TIME_STRINGS_KEYS[i]
+
+    if name == "day" and value == 1:
+        return avoid_wrapping("yesterday")
+
+    return avoid_wrapping(TIME_STRINGS[name] % {"num": value} + " ago")
+
+
+def cf_duration_partials(d):
+    """
+    Take two datetime objects and return the time between d and now as a nicely
+    formatted string, e.g. "10 minutes". If d occurs after now, return
+    "0 minutes".
+
+    Units used are years, months, weeks, days, hours, and minutes.
+    Seconds and microseconds are ignored.
+
+    The algorithm takes into account the varying duration of years and months.
+    There is exactly "1 year, 1 month" between 2013/02/10 and 2014/03/10,
+    but also between 2007/08/10 and 2008/09/10 despite the delta being 393 days
+    in the former case and 397 in the latter.
+
+    Adapted from Django's timesince function.
+    """
+    # Convert datetime.date to datetime.datetime for comparison.
+    if not isinstance(d, datetime.datetime):
+        d = datetime.datetime(d.year, d.month, d.day)
+
+    now = datetime.datetime.now(d.tzinfo if is_aware(d) else None)
+
+    delta = now - d
+
+    # Ignore microseconds.
+    since = delta.days * 24 * 60 * 60 + delta.seconds
+    if since <= 0:
+        # d is in the future compared to now, stop processing.
+        return "in the future"
+
+    # Get years and months.
+    total_months = (now.year - d.year) * 12 + (now.month - d.month)
+    if d.day > now.day or (d.day == now.day and d.time() > now.time()):
+        total_months -= 1
+    years, months = divmod(total_months, 12)
+
+    # Calculate the remaining time.
+    # Create a "pivot" datetime shifted from d by years and months, then use
+    # that to determine the other parts.
+    if years or months:
+        pivot_year = d.year + years
+        pivot_month = d.month + months
+        if pivot_month > 12:
+            pivot_month -= 12
+            pivot_year += 1
+        pivot = datetime.datetime(
+            pivot_year,
+            pivot_month,
+            min(MONTHS_DAYS[pivot_month - 1], d.day),
+            d.hour,
+            d.minute,
+            d.second,
+            tzinfo=d.tzinfo,
+        )
+    else:
+        pivot = d
+    remaining_time = (now - pivot).total_seconds()
+    partials = [years, months]
+    for chunk in TIME_CHUNKS:
+        count = int(remaining_time // chunk)
+        partials.append(count)
+        remaining_time -= chunk * count
+
+    return partials

pgcommitfest/userprofile/migrations/0004_per_user_show_relative_timestamps.py

@@ -0,0 +1,22 @@
+# Generated by Django 4.2.19 on 2025-03-04 22:15
+
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ("userprofile", "0003_emails_managed_upstream"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="userprofile",
+            name="show_relative_timestamps",
+            field=models.BooleanField(
+                default=True,
+                verbose_name="Show relative timestamps throughout the site",
+            ),
+        ),
+    ]

pgcommitfest/userprofile/models.py

@@ -52,5 +52,12 @@ class UserProfile(models.Model):
         verbose_name="Notify on all where committer",
     )
 
+    show_relative_timestamps = models.BooleanField(
+        null=False,
+        blank=False,
+        default=True,
+        verbose_name="Show relative timestamps throughout the site",
+    )
+
     def __str__(self):
         return str(self.user)