Changes to schedule all reports, even for once

octopoes/octopoes/models/ooi/reports.py

@@ -61,6 +61,6 @@ class ReportRecipe(OOI):
     parent_report_type: str | None = None
     report_types: list[str]
 
-    cron_expression: str
+    cron_expression: str | None = None
 
     _natural_key_attrs = ["recipe_id"]

rocky/reports/forms.py

@@ -70,7 +70,13 @@ class ReportScheduleStartDateForm(BaseRockyForm):
         label=_("Recurrence"),
         required=True,
         widget=forms.Select(attrs={"form": "generate_report"}),
-        choices=[("daily", _("Daily")), ("weekly", _("Weekly")), ("monthly", _("Monthly")), ("yearly", _("Yearly"))],
+        choices=[
+            ("once", _("No recurrence, just once")),
+            ("daily", _("Daily")),
+            ("weekly", _("Weekly")),
+            ("monthly", _("Monthly")),
+            ("yearly", _("Yearly")),
+        ],
     )
 
     def clean(self):
@@ -121,19 +127,3 @@ class CustomReportScheduleForm(BaseRockyForm):
     end_date = forms.DateField(
         label=_(""), widget=forms.HiddenInput(), initial=lambda: datetime.now(tz=timezone.utc).date(), required=False
     )
-
-
-class ParentReportNameForm(BaseRockyForm):
-    parent_report_name = forms.CharField(
-        label=_("Report name format"), required=False, initial="${report_type} for ${oois_count} objects"
-    )
-
-
-class ChildReportNameForm(BaseRockyForm):
-    child_report_name = forms.CharField(
-        label=_("Subreports name format"), required=True, initial="${report_type} for ${ooi}"
-    )
-
-
-class ReportNameForm(ParentReportNameForm, ChildReportNameForm):
-    pass

rocky/reports/runner/report_runner.py

@@ -101,9 +101,9 @@ def run(self, report_task: ReportTask) -> None:
                 for ooi in data:
                     ooi_human_readable = Reference.from_str(ooi).human_readable
                     subreport_name = now.strftime(
-                        Template(recipe.subreport_name_format).safe_substitute(
-                            ooi=ooi_human_readable, report_type=str(report_type.name)
-                        )
+                        Template(
+                            "" if recipe.subreport_name_format is None else recipe.subreport_name_format
+                        ).safe_substitute(ooi=ooi_human_readable, report_type=str(report_type.name))
                     )
                     subreport_names.append((subreport_name, subreport_name))
 
@@ -112,7 +112,7 @@ def run(self, report_task: ReportTask) -> None:
             )
 
             if "${ooi}" in parent_report_name and oois_count == 1:
-                parent_report_name = Template(parent_report_name).safe_substitute(ooi=ooi[0].human_readable)
+                parent_report_name = Template(parent_report_name).safe_substitute(ooi=ooi_human_readable)
 
             save_report_data(
                 self.bytes_client,

rocky/reports/runner/worker.py

@@ -243,7 +243,7 @@ def _start_working(
         finally:
             try:
                 # The docker runner could have handled this already
-                if scheduler.get_task_details(p_item.id).status == TaskStatus.RUNNING:
+                if scheduler.get_task_details(str(p_item.id)).status == TaskStatus.RUNNING:
                     scheduler.patch_task(p_item.id, status)  # Note that implicitly, we have p_item.id == task_id
                     logger.info("Set status to %s in the scheduler for task[id=%s]", status, p_item.id)
             except HTTPError:

rocky/reports/templates/partials/export_report_settings.html

@@ -15,53 +15,58 @@ <h2>{% translate "Report schedule" %}</h2>
                     or monthly. If you need the report just for a single occasion, select the one-time option.
                 {% endblocktranslate %}
             </p>
-            <form class="inline" method="post" action="{{ current }}">
+            <form id="generate_report" class="inline" method="post" action="{{ next }}">
                 {% csrf_token %}
                 {% include "forms/report_form_fields.html" %}
-                {% include "partials/form/fieldset.html" with fields=report_schedule_form_recurrence_choice %}
+                {% include "partials/form/fieldset.html" with fields=report_schedule_form_start_date fieldset_parent_class="column-2" %}
 
-                {% if is_scheduled_report %}
+                <div>
+                    <h2>{% translate "Report name" %}</h2>
                     <p>
                         {% blocktranslate trimmed %}
-                            Please choose a start date, time and recurrence for scheduling your report(s).
-                            If you select a date on the 28th-31st of the month, it will always be scheduled on the last day of the month.
+                            Define a custom name format for your report(s). This format will be applied to all generated
+                            (sub)reports.
                         {% endblocktranslate %}
                     </p>
                     <p>
                         {% blocktranslate trimmed %}
-                            The date you select will be the reference date for the data set for your report.
-                            Please allow for up to 24 hours for your report to be ready.
+                            To make the report names more descriptive, you can include placeholders for the
+                            object name, the report type and/or the reference date. For subreports and reports over a single object,
+                            use the placeholder "${ooi}" for the object name, "${report_type}" for the report type and use a
+                            <a href="https://strftime.org/" target="_blank" rel="noopener">Python strftime code</a> for the reference
+                            date. For reports over multiple objects, use "${oois_count}" for the number of objects in the report.
                         {% endblocktranslate %}
                     </p>
-                    <div class="column-2">
-                        {% include "partials/form/fieldset.html" with fields=report_schedule_form_start_date %}
-
+                    <p>
+                        {% blocktranslate trimmed %}
+                            For example, the format "${report_type} for ${ooi} at %x" could generate:
+                            "DNS Report for example.com at 01/01/25".
+                        {% endblocktranslate %}
+                    </p>
+                </div>
+                <fieldset>
+                    <div>
+                        <label for="parent_report_name_format">{% translate "Report name format" %}</label>
+                        <input type="text"
+                               id="parent_report_name_format"
+                               name="parent_report_name_format"
+                               value="{{ initial_report_names.0 }}">
                     </div>
+                </fieldset>
+                {% if initial_report_names.1 %}
+                    <fieldset>
+                        <div>
+                            <label for="subreport_name_format">{% translate "Subreports name format" %}</label>
+                            <input type="text"
+                                   id="subreport_name_format"
+                                   name="subreport_name_format"
+                                   value="{{ initial_report_names.1 }}">
+                        </div>
+                    </fieldset>
                 {% endif %}
-            </form>
-            <form id="generate_report" class="inline" method="post" action="{{ next }}">
-                {% csrf_token %}
-                {% include "forms/report_form_fields.html" %}
-
-                {% if not is_scheduled_report %}
-                    {% include "partials/report_names_header.html" %}
-                    {% include "partials/report_names_form.html" %}
-
-                    <button type="submit" form="generate_report">
-                        {% translate "Generate report" %}<span class="icon ti-chevron-right" aria-hidden="true"></span>
-                    </button>
-                {% else %}
-                    {% include "partials/report_names_header.html" with recurrence=True %}
-                    {% include "partials/form/fieldset.html" with fields=report_parent_name_form %}
-
-                    {% if reports|length > 1 %}
-                        {% include "partials/form/fieldset.html" with fields=report_child_name_form %}
-
-                    {% endif %}
-                    <button type="submit" form="generate_report">
-                        {% translate "Generate report" %}<span class="icon ti-chevron-right" aria-hidden="true"></span>
-                    </button>
-                {% endif %}
+                <button type="submit">
+                    {% translate "Generate report" %}<span class="icon ti-chevron-right" aria-hidden="true"></span>
+                </button>
             </form>
         {% else %}
             {% include "partials/return_button.html" with btn_text="Go back" %}

rocky/reports/templates/report_overview/report_history_table.html

@@ -134,8 +134,8 @@
                             </td>
                             <td class="nowrap report_reference_date">{{ report.parent_report.observed_at|date }}</td>
                             <td class="nowrap report_creation_date">{{ report.parent_report.date_generated }}</td>
-                            {% if report.children_reports %}
-                                <td class="sticky-cell">
+                            <td class="sticky-cell">
+                                {% if report.children_reports %}
                                     <button type="button"
                                             class="expando-button icon ti-chevron-down"
                                             data-icon-open-class="icon ti-chevron-down"
@@ -144,8 +144,8 @@
                                             aria-expanded="false">
                                         {% translate "Open children report object details" %}
                                     </button>
-                                </td>
-                            {% endif %}
+                                {% endif %}
+                            </td>
                         </tr>
                         {% if report.children_reports %}
                             <tr class="expando-row">

rocky/reports/templates/report_overview/scheduled_reports_table.html

@@ -27,40 +27,44 @@
                     {% if schedule.recipe %}
                         <tr>
                             <td class="nowrap">{{ schedule.recipe.report_name_format }}</td>
-                            <td>
+                            <td class="nowrap">
                                 <ul class="tags horizontal-view">
                                     {% if schedule.recipe.parent_report_type == "aggregate-organisation-report" %}
-                                        <li class="label tags-color-{{ schedule.recipe.parent_report_type|get_report_type_label_style }}">
-                                            {{ schedule.recipe.parent_report_type|get_report_type_name }}
+                                        <li>
+                                            <span class="label tags-color-{{ schedule.recipe.parent_report_type|get_report_type_label_style }}">{{ schedule.recipe.parent_report_type|get_report_type_name }}</span>
                                         </li>
                                     {% else %}
                                         {% for report_type in schedule.recipe.report_types %}
                                             {% if forloop.counter0 < 2 %}
-                                                <li class="label tags-color-{{ report_type|get_report_type_label_style }}">{{ report_type|get_report_type_name }}</li>
+                                                <li>
+                                                    <span class="label tags-color-{{ report_type|get_report_type_label_style }}">{{ report_type|get_report_type_name }}</span>
+                                                </li>
                                             {% endif %}
                                             {% if forloop.counter0 == 2 %}
-                                                <li class="label tags-color-grey-2">+ {{ schedule.recipe.report_types|length|add:"-2" }}</li>
+                                                <li>
+                                                    <span class="label tags-color-grey-2">+ {{ schedule.recipe.report_types|length|add:"-2" }}</span>
+                                                </li>
                                             {% endif %}
                                         {% endfor %}
                                     {% endif %}
                                 </ul>
                             </td>
+                            <td class="nowrap">{{ schedule.deadline_at }}</td>
                             <td class="nowrap">
-                                {% if not schedule.enabled %}
-                                    -
+                                {% if schedule.cron is None %}
+                                    {% translate "Once" %}
                                 {% else %}
-                                    {{ schedule.deadline_at }}
+                                    {{ schedule.cron }}
                                 {% endif %}
                             </td>
-                            <td class="nowrap">{{ schedule.cron }}</td>
                             <td class="nowrap">
                                 {% if schedule.enabled %}
                                     <span class="label system-tag color-2">{% translate "Enabled" %}</span>
                                 {% else %}
                                     <span class="label system-tag color-3">{% translate "Disabled" %}</span>
                                 {% endif %}
                             </td>
-                            <td class="actions sticky-cell">
+                            <td class="nowrap actions sticky-cell">
                                 <button class="expando-button"
                                         data-icon-open-class="icon ti-chevron-down"
                                         data-icon-close-class="icon ti-chevron-up"