From 0480f61226ce2d6e3ddcb0e028f26e6d45b30e4d Mon Sep 17 00:00:00 2001
From: Tomas Cohen Arazi <tomascohen@theke.io>
Date: Mon, 12 Sep 2022 14:54:08 -0300
Subject: [PATCH] Bug 30982: Adapt table to new API spec

Disclaimer: this patch is highly opinionated :-D

When I started looking at this patch I felt like the two tables
(current/past jobs) implemented on bug 30462 was the way to go.

In order to make this patches apply after it I had to redo all the
things. Or most of them.

But I decided to keep the idea of filtering out completed tasks, not
just having the option to display 'the last hour' tasks. For the task I
added some required helper methods and the relevant tests as well. So a
behavior change.

Hope you all agree with it.

Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>

Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
---
 .../prog/en/modules/admin/background_jobs.tt  | 178 ++++--------------
 1 file changed, 39 insertions(+), 139 deletions(-)

diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/background_jobs.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/background_jobs.tt
index bc8d8dd56d..886c2cfc68 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/background_jobs.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/background_jobs.tt
@@ -162,108 +162,15 @@
 
     <h1>Background jobs</h1>
 
-    <div id="taskstabs" class="toptabs">
-        <ul class="nav nav-tabs" role="tablist">
-            <li role="presentation" class="active"><a href="#queued" aria-controls="queued" role="tab" data-toggle="tab">Queued jobs</a></li>
-            <li role="presentation"><a href="#complete" aria-controls="complete" role="tab" data-toggle="tab">Completed jobs</a></li>
-        </ul>
-
-        <div class="tab-content">
-            <div role="tabpanel" class="tab-pane active" id="queued">
-                [% IF queued.count %]
-                    <table id="table_queued_jobs">
-                        <thead>
-                            <tr>
-                                <th>Job ID</th>
-                                <th>Status</th>
-                                <th>Progress</th>
-                                <th>Type</th>
-                                <th>Queued</th>
-                                <th>Started</th>
-                                <th class="noExport">Actions</th>
-                            </tr>
-                        </thead>
-                        <tbody>
-                            [% FOREACH job IN queued %]
-                            <tr>
-                                <td>[% job.id | html %]</td>
-                                <td>
-                                    [% PROCESS show_job_status %]
-                                </td>
-                                <td>[% job.progress || 0 | html %] / [% job.size | html %]</td>
-                                <td>
-                                    [% PROCESS show_job_type job_type => job.type %]
-                                </td>
-                                <td>[% job.enqueued_on | $KohaDates with_hours = 1 %]</td>
-                                <td>[% job.started_on| $KohaDates with_hours = 1 %]</td>
-                                <td class="actions">
-                                    <a class="btn btn-default btn-xs" href="/cgi-bin/koha/admin/background_jobs.pl?op=view&amp;id=[% job.id | html %]"><i class="fa fa-eye"></i> View</a>
-                                    [% IF job.status == 'new' || job.status == 'started' %]
-                                        <a class="btn btn-default btn-xs" href="/cgi-bin/koha/admin/background_jobs.pl?op=cancel&amp;id=[% job.id | html %]"><i class="fa fa-trash"></i> Cancel</a>
-                                    [% END %]
-                                </td>
-                            </tr>
-                            [% END %]
-                        </tbody>
-                    </table>
-                [% ELSE %]
-                    <div class="dialog message">
-                        There are no queued background jobs yet.
-                    </div>
-                [% END %]
-            </div>
-
-            <div role="tabpanel" class="tab-pane" id="complete">
-                [% IF complete.count %]
-                    <p>Jobs completed in the last 60 minutes.</p>
-                    <table id="table_complete_jobs">
-                        <thead>
-                            <tr>
-                                <th>Job ID</th>
-                                <th>Status</th>
-                                <th>Progress</th>
-                                <th>Type</th>
-                                <th>Queued</th>
-                                <th>Started</th>
-                                <th>Ended</th>
-                                <th class="noExport">Actions</th>
-                            </tr>
-                        </thead>
-                        <tbody>
-                            [% FOREACH job IN complete %]
-                            <tr>
-                                <td>[% job.id | html %]</td>
-                                <td>
-                                    [% PROCESS show_job_status %]
-                                </td>
-                                <td>[% job.progress || 0 | html %] / [% job.size | html %]</td>
-                                <td>
-                                    [% PROCESS show_job_type job_type => job.type %]
-                                </td>
-                                <td>[% job.enqueued_on | $KohaDates with_hours = 1 %]</td>
-                                <td>[% job.started_on| $KohaDates with_hours = 1 %]</td>
-                                <td>[% job.ended_on| $KohaDates with_hours = 1 %]</td>
-                                <td class="actions">
-                                    <a class="btn btn-default btn-xs" href="/cgi-bin/koha/admin/background_jobs.pl?op=view&amp;id=[% job.id | html %]"><i class="fa fa-eye"></i> View</a>
-                                    [% IF job.status == 'new' || job.status == 'started' %]
-                                        <a class="btn btn-default btn-xs" href="/cgi-bin/koha/admin/background_jobs.pl?op=cancel&amp;id=[% job.id | html %]"><i class="fa fa-trash"></i> Cancel</a>
-                                    [% END %]
-                                </td>
-                            </tr>
-                            [% END %]
-                        </tbody>
-                    </table>
-                [% ELSE %]
-                    <div class="dialog message">
-                        There were no completed background jobs completed in the last 60 minutes.
-                    </div>
-                [% END %]
-            </div>
-        </div>
+    <div>
+        <input type="checkbox" id="only_current" checked />
+        <label for="only_current">Current jobs only</label>
     </div>
 
-    <label for="include_last_hour">Only include jobs started in the last hour</label>
-    <input type="checkbox" id="include_last_hour" checked />
+    <div>
+        <input type="checkbox" id="include_last_hour" checked />
+        <label for="include_last_hour">Only include jobs started in the last hour</label>
+    </div>
 
     <table id="table_jobs">
         <thead>
@@ -296,26 +203,6 @@
     [% INCLUDE 'js-date-format.inc' %]
     [% INCLUDE 'datatables.inc' %]
     <script>
-        $(document).ready(function() {
-            $("#table_queued_jobs").dataTable($.extend(true, {}, dataTablesDefaults, {
-                "aoColumnDefs": [
-                    { "aTargets": [ -1, -2 ], "bSortable": false, "bSearchable": false },
-                ],
-                "aaSorting": [[ 0, "desc" ]],
-                "iDisplayLength": 10,
-                "sPaginationType": "full_numbers"
-            }));
-
-            $("#table_complete_jobs").dataTable($.extend(true, {}, dataTablesDefaults, {
-                "aoColumnDefs": [
-                    { "aTargets": [ -1, -2 ], "bSortable": false, "bSearchable": false },
-                ],
-                "aaSorting": [[ 0, "desc" ]],
-                "iDisplayLength": 10,
-                "sPaginationType": "full_numbers"
-            }));
-        });
-
         const job_statuses = [
             {'_id': 'new',       '_str': _("New")},
             {'_id': 'cancelled', '_str': _("Cancelled")},
@@ -389,16 +276,25 @@
                     } else {
                         return { "<": now.toISOString() };
                     }
-                },
+                }
             };
+
+            let only_current_filter = function(){
+                if ( $("#only_current").is(":checked") ) {
+                    return 'only_current=1';
+                } else {
+                    return 'only_current=0';
+                }
+            }
+
             let jobs_table = $("#table_jobs").kohaTable({
                 "ajax": {
-                    "url": "/api/v1/background_jobs"
+                    "url": "/api/v1/jobs?" + only_current_filter()
                 },
                 "order": [[ 1, "desc" ]],
                 "columns": [
                     {
-                        "data": "background_job_id",
+                        "data": "job_id",
                         "searchable": true,
                         "orderable": true
                     },
@@ -408,7 +304,7 @@
                         "orderable": true,
                         "render": function(data, type, row, meta) {
                             return get_job_status(row.status).escapeHtml();
-                        },
+                        }
                     },
                     {
                         "data": "progress,size",
@@ -416,7 +312,7 @@
                         "orderable": true,
                         "render": function(data, type, row, meta) {
                             return "%s/%s".format(row.progress, row.size).escapeHtml();
-                        },
+                        }
                     },
                     {
                         "data": "type",
@@ -424,41 +320,39 @@
                         "orderable": true,
                         "render": function(data, type, row, meta) {
                             return get_job_type(row.type).escapeHtml();
-                        },
+                        }
                     },
                     {
-                        "data": "enqueued_on",
+                        "data": "enqueued_date",
                         "searchable": true,
                         "orderable": true,
                         "render": function(data, type, row, meta) {
-                            return $datetime(row.enqueued_on);
-                        },
+                            return $datetime(row.enqueued_date);
+                        }
                     },
                     {
-                        "data": "started_on",
+                        "data": "started_date",
                         "searchable": true,
                         "orderable": true,
                         "render": function(data, type, row, meta) {
-                            return $datetime(row.started_on);
-                        },
+                            return $datetime(row.started_date);
+                        }
                     },
-
                     {
-                        "data": "ended_on",
+                        "data": "ended_date",
                         "searchable": true,
                         "orderable": true,
                         "render": function(data, type, row, meta) {
-                            return $datetime(row.ended_on);
-                        },
+                            return $datetime(row.ended_date);
+                        }
                     },
                     {
                         "data": function( row, type, val, meta ) {
-                            var result = '<a class="btn btn-default btn-xs" role="button" href="/cgi-bin/koha/admin/background_jobs.pl?op=view&amp;id='+ encodeURIComponent(row.background_job_id) +'"><i class="fa fa-eye" aria-hidden="true"></i> '+_("View")+'</a>'+"\n";
+                            var result = '<a class="btn btn-default btn-xs" role="button" href="/cgi-bin/koha/admin/background_jobs.pl?op=view&amp;id='+ encodeURIComponent(row.job_id) +'"><i class="fa fa-eye" aria-hidden="true"></i> '+_("View")+'</a>'+"\n";
                             if ( row.status == 'new' || row.status == 'started' ) {
-                                result += '<a class="btn btn-default btn-xs" role="button" href="/cgi-bin/koha/admin/bakcground_jobs.pl?op=cancel&amp;id='+ encodeURIComponent(row.background_job_id) +'"><i class="fa fa-trash" aria-hidden="true"></i> '+_("Cancel")+'</a>';
+                                result += '<a class="btn btn-default btn-xs" role="button" href="/cgi-bin/koha/admin/bakcground_jobs.pl?op=cancel&amp;id='+ encodeURIComponent(row.job_id) +'"><i class="fa fa-trash" aria-hidden="true"></i> '+_("Cancel")+'</a>';
                             }
                             return result;
-
                         },
                         "searchable": false,
                         "orderable": false
@@ -470,6 +364,12 @@
                 jobs_table.DataTable().draw();
                 return false;
             });
+
+            $("#only_current").on("change", function(){
+                jobs_table.DataTable().ajax.url("/api/v1/jobs?" + only_current_filter()).load();
+                return false;
+            });
+        });
     </script>
     [% IF op == 'view' %]
         [% PROCESS 'js' %]
-- 
2.39.5