Add option to restart jobs upon comment submission #5971

b10n1k · 2024-10-02T07:42:01Z

Renamed addComments to bulkJobsAction to handle both commenting and restarting jobs.
Added button-specific actions using form.clickedButton.
Updated fetchWithCSRF logic to dynamically determine request URLs based on the button clicked.
Introduced separate success and error messages for restarting and commenting actions.
Updated HTML to include "Restart and Comment" and "Comment" buttons with individual data URLs.
Adjusted modal to allow submission of comments or restarts through the correct action handlers.

These updates enhance the user experience by allowing users to either comment on jobs, or perform restart with a comment simultaneously from the overview page. Comments always add to the original job of the overview page. By integrating this functionality we provide a workflow for users managing multiple jobs on the overview page.

https://progress.opensuse.org/issues/166559

b10n1k · 2024-10-02T07:47:07Z

okurz · 2024-10-02T11:52:30Z

please describe the relation to

Add option to restart jobs upon comment submission #5946

okurz

please describe the relation to

Add option to restart jobs upon comment submission #5946

Add option to restart jobs upon comment submission #5946 (comment)
The icon on /tests/overview should be changed. I was thinking of

<span class="fa-stack fa-2x">
    <i class="fa fa-comment" aria-hidden="true"></i>
    <i class="fa fa-undo" aria-hidden="true"></i>
  </span>

which probably needs CSS adaptations to work

codecov · 2024-10-03T12:34:21Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.75%. Comparing base (a94bc42) to head (e886fd5).
Report is 12 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5971      +/-   ##
==========================================
- Coverage   98.75%   98.75%   -0.01%     
==========================================
  Files         396      396              
  Lines       38983    38983              
==========================================
- Hits        38499    38496       -3     
- Misses        484      487       +3

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

okurz

please describe the relation to

Add option to restart jobs upon comment submission #5946

Add option to restart jobs upon comment submission #5946 (comment)
The icon on /tests/overview should be changed. I was thinking of

<span class="fa-stack fa-2x">
    <i class="fa fa-comment" aria-hidden="true"></i>
    <i class="fa fa-undo" aria-hidden="true"></i>
  </span>

which probably needs CSS adaptations to work
4. inline comments

assets/javascripts/overview.js

t/ui/10-tests_overview.t

templates/webapi/test/overview.html.ep

- Renamed `addComments` to `bulkJobsAction` to handle both commenting and restarting jobs. - Added button-specific actions using `form.clickedButton`. - Updated `fetchWithCSRF` logic to dynamically determine request URLs based on the button clicked. - Introduced separate success and error messages for restarting and commenting actions. - Updated HTML to include "Restart and Comment" and "Comment" buttons with individual data URLs. - Adjusted modal to allow submission of comments or restarts through the correct action handlers. These updates enhance the user experience by allowing users to either comment on jobs, or perform restart with a comment simultaneously from the overview page. Comments always add to the original job of the overview page. By integrating this functionality we provide a workflow for users managing multiple jobs on the overview page. https://progress.opensuse.org/issues/166559 Signed-off-by: Ioannis Bonatakis <[email protected]>

b10n1k · 2024-10-03T22:26:17Z

fa-comment

I will take a look on 3 tmr

okurz · 2024-10-04T10:53:30Z

assets/javascripts/overview.js

      done();
    });
+
+  if (actionBtn == 'restartAndCommentJobs') {
+    //const commenttUrl = document.getElementById('CommentJobsBtn').dataset.url;


Don't add disabled code as nobody but you will understand why this is not active. Better leave it out and keep in your local git repository, either in git stash or a temporary "WIP"-commit

See https://github.com/os-autoinst/os-autoinst-distri-opensuse/blob/master/CONTRIBUTING.md#coding-style for more details

okurz · 2024-10-04T10:55:53Z

assets/javascripts/overview.js

+    fetchWithCSRF(reqUrl, {method: 'POST', body: new FormData(form)})
+      .then(response => {
+        if (!response.ok) throw `Server returned ${response.status}: ${response.statusText}`;
+        addFlash('info', 'The comments have been created on the previous jobs');


this looks like a new flash. But there is already a info text with the reload link. Isn't this redundant?

(@okurz as this was actually a comment in reply to your remark.) It looks like with this approach the JavaScript code will first do the restarting and after that do the commenting. So I guess it is acceptable to also show two flash messages for this. Of course it would be nicer if both were combined.

However, the way these actions are combined here in terms of error handling is probably generally very problematic anyway, see my other inline comment.

Note that I would have preferred a solution where this is combined by the API on the server rather than in JavaScript code. This way the feature could also be used via e.g. openqa-cli and we generally have less back-and-forth between the server and client. The commenting could also be atomic this way¹.

(With this approach here we can have the annoying "error case outcome" that all jobs have been restarted but the comment creation failed at some point in the middle. This leaves it in an inconsistent state that the user cannot really repair (except by redoing the commenting manually).)

okurz · 2024-10-04T11:09:05Z

templates/webapi/test/overview.html.ep

@@ -42,7 +42,8 @@
        <div class="card-body">
            % my $allow_commenting = @$job_ids && current_user;
            % if ($allow_commenting) {
-            <button type="button" class="btn btn-secondary btn-circle btn-sm trigger-edit-button" onclick="showAddCommentsDialog()" title="Add comments">
+            <button type="button" class="btn btn-secondary btn-circle btn-sm
+            trigger-edit-button" onclick="showAddCommentsDialog()" title="Add comments or restart Jobs">


I now realize that there is inconsistent phrasing "Add comments and/or restart [jJ]obs" or "Restart and/or comment jobs". I suggest a consistent phrasing "Restart or comment jobs". Mind the proper casing. I am using "comment" as a verb replacing "Add comments". Also I am using "or" here as inclusive or meaning that it's one of restarting, commenting, restarting && commenting. And please use consistent phrasing in all cases including the button labels and javascript functions.

Martchus · 2024-10-04T11:23:28Z

assets/javascripts/overview.js

  const text = form.elements.text.value;
  if (!text.length) {
    return window.alert("The comment text mustn't be empty.");
  }
+  const actionBtn = form.clickedButton.value;
+  let reqUrl = form.clickedButton.dataset.url || form.action;


Also, this should probably use ?? to make the intention of the fallback more clear:

Suggested change

let reqUrl = form.clickedButton.dataset.url || form.action;

let reqUrl = form.clickedButton.dataset.url ?? form.action;

Martchus · 2024-10-04T11:34:46Z

templates/webapi/test/overview.html.ep

+                        <i class="fa fa-play-circle-o"></i> Restart and Comment <%= scalar @$job_ids %> jobs
+                      </button>
+                      <button type="submit" name="bulkAction" class="btn btn-info"
+                              value="commentJobs" id="CommentJobsBtn"


Please start IDs with lower case characters.

Martchus · 2024-10-04T11:36:36Z

templates/webapi/test/overview.html.ep

+                      </button>
+                      <button type="submit" name="bulkAction" class="btn btn-info"
+                              value="commentJobs" id="CommentJobsBtn"
+                              data-url="<%= url_for('apiv1_post_comments')->query(job_id=>$job_ids) %>"


You could use formaction here instead of a generic data attribute. It might also make sense to turn the form's action attribute into a formaction attribute of the other button. This way both URLs are defined on the same level.

Martchus · 2024-10-04T11:40:57Z

assets/javascripts/overview.js

+  let infoTxt =
+    'The comments have been created. <a href="javascript: location.reload()">Reload</a> the page to show changes.';
+  let errTxt = 'The comments could not be added:';
+  if (actionBtn == 'restartAndCommentJobs') {


Please follow common best practices, e.g. preferring === over ==:

Suggested change

if (actionBtn == 'restartAndCommentJobs') {

if (actionBtn === 'restartAndCommentJobs') {

This concerns other occurrences as well.

Martchus · 2024-10-04T11:42:10Z

assets/javascripts/overview.js

  const text = form.elements.text.value;
  if (!text.length) {
    return window.alert("The comment text mustn't be empty.");
  }
+  const actionBtn = form.clickedButton.value;


form.clickedButton might not be set if the form was submitted by other means than clicking one of the two buttons. The code has to handle that. Maybe it is good enough to simply return early.

Martchus · 2024-10-04T11:44:44Z

assets/javascripts/overview.js

@@ -301,17 +303,38 @@ function addComments(form) {
    controls.style.display = 'inline';
    window.addCommentsModal.hide();
  };
-  fetchWithCSRF(form.action, {method: 'POST', body: new FormData(form)})
+
+  let infoTxt =


I would avoid over-abbreviating variable names:

Suggested change

let infoTxt =

let infoText =

Martchus · 2024-10-04T11:44:58Z

assets/javascripts/overview.js

+
+  let infoTxt =
+    'The comments have been created. <a href="javascript: location.reload()">Reload</a> the page to show changes.';
+  let errTxt = 'The comments could not be added:';


Suggested change

let errTxt = 'The comments could not be added:';

let errorText = 'The comments could not be added:';

Martchus · 2024-10-04T11:46:47Z

assets/javascripts/overview.js

+  if (actionBtn == 'restartAndCommentJobs') {
+    //const commenttUrl = document.getElementById('CommentJobsBtn').dataset.url;
+    reqUrl = document.getElementById('CommentJobsBtn').dataset.url;
+    console.log('iob ' + reqUrl);


Suggested change

console.log('iob ' + reqUrl);

Martchus · 2024-10-04T11:52:17Z

assets/javascripts/overview.js

+    fetchWithCSRF(reqUrl, {method: 'POST', body: new FormData(form)})
+      .then(response => {
+        if (!response.ok) throw `Server returned ${response.status}: ${response.statusText}`;
+        addFlash('info', 'The comments have been created on the previous jobs');


(@okurz as this was actually a comment in reply to your remark.) It looks like with this approach the JavaScript code will first do the restarting and after that do the commenting. So I guess it is acceptable to also show two flash messages for this. Of course it would be nicer if both were combined.

However, the way these actions are combined here in terms of error handling is probably generally very problematic anyway, see my other inline comment.

Note that I would have preferred a solution where this is combined by the API on the server rather than in JavaScript code. This way the feature could also be used via e.g. openqa-cli and we generally have less back-and-forth between the server and client. The commenting could also be atomic this way¹.

(With this approach here we can have the annoying "error case outcome" that all jobs have been restarted but the comment creation failed at some point in the middle. This leaves it in an inconsistent state that the user cannot really repair (except by redoing the commenting manually).)

Martchus · 2024-10-04T12:12:57Z

assets/javascripts/overview.js

-        'info',
-        'The comments have been created. <a href="javascript: location.reload()">Reload</a> the page to show changes.'
-      );
+      addFlash('info', infoTxt);


This is not good enough. In case of a 200 response not all jobs might have been restarted. In fact, no jobs might have been restarted at all.

When restarting jobs, you might get a 200 response like {"enforceable":1,"errors":["Job 4339 misses the following mandatory assets: iso\/foo.iso\nEnsure to provide mandatory assets and\/or force re-triggering if necessary."],"warnings",[],"result":[],"test_url":[]}. The code has to display those errors and allow the user to force the restart if possible. There can also be warnings which also need to be displayed.

I suggest you check how restarting is dealt with in other places of the UI (like the job details page) and see what code you can share.

The code should also read the set of jobs that actually was restarted from the response and then do the commenting only on those jobs (because the comment is likely something like "I am restarting these jobs because of …") so it probably makes no sense to write the comments when the restart didn't actually happen.

okurz requested changes Oct 2, 2024

View reviewed changes

b10n1k force-pushed the batch_restart_with_comment branch 2 times, most recently from 7d7f709 to e886fd5 Compare October 3, 2024 12:12

okurz requested changes Oct 3, 2024

View reviewed changes

assets/javascripts/overview.js Outdated Show resolved Hide resolved

t/ui/10-tests_overview.t Outdated Show resolved Hide resolved

templates/webapi/test/overview.html.ep Outdated Show resolved Hide resolved

b10n1k force-pushed the batch_restart_with_comment branch from e886fd5 to b1590ed Compare October 3, 2024 22:25

okurz requested changes Oct 4, 2024

View reviewed changes

Martchus requested changes Oct 4, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add option to restart jobs upon comment submission #5971

Add option to restart jobs upon comment submission #5971

b10n1k commented Oct 2, 2024

b10n1k commented Oct 2, 2024

okurz commented Oct 2, 2024

okurz left a comment •

edited

Loading

codecov bot commented Oct 3, 2024

okurz left a comment

b10n1k commented Oct 3, 2024

okurz Oct 4, 2024

okurz Oct 4, 2024

Martchus Oct 4, 2024 •

edited

Loading

okurz Oct 4, 2024

Martchus Oct 4, 2024

Martchus Oct 4, 2024

Martchus Oct 4, 2024

Martchus Oct 4, 2024

Martchus Oct 4, 2024

Martchus Oct 4, 2024

Martchus Oct 4, 2024

Martchus Oct 4, 2024

Martchus Oct 4, 2024 •

edited

Loading

Martchus Oct 4, 2024

	let reqUrl = form.clickedButton.dataset.url \|\| form.action;
	let reqUrl = form.clickedButton.dataset.url ?? form.action;

	if (actionBtn == 'restartAndCommentJobs') {
	if (actionBtn === 'restartAndCommentJobs') {

	let errTxt = 'The comments could not be added:';
	let errorText = 'The comments could not be added:';

Add option to restart jobs upon comment submission #5971

Are you sure you want to change the base?

Add option to restart jobs upon comment submission #5971

Conversation

b10n1k commented Oct 2, 2024

b10n1k commented Oct 2, 2024

okurz commented Oct 2, 2024

okurz left a comment • edited Loading

Choose a reason for hiding this comment

codecov bot commented Oct 3, 2024

Codecov Report

okurz left a comment

Choose a reason for hiding this comment

b10n1k commented Oct 3, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Martchus Oct 4, 2024 • edited Loading

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

Martchus Oct 4, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

okurz left a comment •

edited

Loading

Martchus Oct 4, 2024 •

edited

Loading

Martchus Oct 4, 2024 •

edited

Loading