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

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

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.98%. Comparing base (e85916c) to head (6a99188).
Report is 17 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #5971   +/-   ##
=======================================
  Coverage   98.98%   98.98%           
=======================================
  Files         395      395           
  Lines       39354    39364   +10     
=======================================
+ Hits        38954    38964   +10     
  Misses        400      400

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

assets/javascripts/overview.js

templates/webapi/test/overview.html.ep

assets/javascripts/overview.js

templates/webapi/test/overview.html.ep

assets/javascripts/overview.js

b10n1k · 2024-10-07T15:19:51Z

please describe the relation to

Add option to restart jobs upon comment submission #5946

The difference between this PR and the previews is that the old PR solves the problem integrating the logic in the Comments.pm passing parameters in the underline function.
It was requested to implement the solution using the Job.pm. This is not the case in this PR though.

Martchus · 2024-10-07T16:10:24Z

You could base your PR on #5981 but it looks like I'll have to put a little bit more work into it (as CI checks are currently failing).

b10n1k · 2024-10-14T10:13:58Z

UPDATED screenshot

**

**

t/ui/10-tests_overview.t

templates/webapi/test/overview.html.ep

assets/javascripts/overview.js

b10n1k · 2024-10-23T11:56:38Z

Some comments on 717e152

Review commit message for main changes
not sure if we prefer to rename the restartJob in openqa.js
not sure if we prefer to provide a link for reload as it is for comments submittion. I went with auto reload for now
I havent writen any additional tests as for now, other than the ones from the previous commit

perlpunk · 2024-10-24T12:02:54Z

A general request: Could you rebase your PRs more often on master?
I personally do this whenever I push new changes. I fetch the origin, and when I see new commits, I rebase.

assets/javascripts/overview.js

assets/javascripts/openqa.js

Martchus · 2024-10-25T12:52:18Z

assets/javascripts/openqa.js

+        if (singleJobId) {
+          newJobUrl = responseJSON.test_url[0][singleJobId];
+        } else {
+          var testUrlData = responseJSON.test_url;


Suggested change

var testUrlData = responseJSON.test_url;

const testUrlData = responseJSON?.test_url;

@b10n1k You missed the ? here

assets/javascripts/openqa.js

Martchus · 2024-10-25T12:56:21Z

assets/javascripts/openqa.js

+          setTimeout(() => {
+            window.location.reload();
+          }, 2000);


Suggested change

setTimeout(() => {

window.location.reload();

}, 2000);

setTimeout(() => window.location.reload(), 2000);

Although I don't like this whole approach of first adding an info to only reload the whole page 2 seconds later anyway. I would rather not reload the page automatically and change the info to "Changes have been applied. You may reload the page." where "reload" is a link that will reload the page. This way the info contains more useful information and one has more than 2 seconds to read it.

What's the benefit of having time to read that a reload is required? Why not just reload right away?

I changed to the manual reload with a similar text as it is for comments

I don't see that this has been updated. As-is it looks like you still can't decide whether to reload the page or show a notification.

I suggest to show a notification. Only this way it is apparent that the operation was actually successful. Otherwise the page is just reloading but the user has to interpret this behavior as success - which is not ideal in my opinion. The notification should also explicitly list of jobs that have actually been successfully restarted so one can easily go though the list to access them if wanted. It can of course also include a link for reloading the page.

assets/javascripts/overview.js

Martchus · 2024-10-25T13:13:49Z

templates/webapi/test/overview.html.ep

+            trigger-edit-button" onclick="showAddCommentsDialog()" title="Restart or comment jobs">
+                <span class="fa-stack" style="font-size: 0.9em" >
+		  <i class="fa fa-comment fa-stack-2x text-danger-info" aria-hidden="true"></i>
+		  <i class="fa fa-undo fa-stack-1x" style="color: #0c4374;" aria-hidden="true"></i>


Maybe we should add a CSS class for this color instead of defining it in HTML. Maybe we can then also use some existing CSS color values defined by Bootstrap or in our SCSS theme. You should also check whether this looks good in darkmode.

Checked in the dark mode and looks good.
styles moved to overview.scss

assets/javascripts/overview.js

Martchus · 2024-10-25T13:24:16Z

t/ui/10-tests_overview.t

+subtest "job template names displayed on 'Test result overview' page" => sub {
+    $driver->get('/group_overview/1002');
+    is($driver->find_element('.progress-bar-unfinished')->get_text(),
+        '1 unfinished', 'The number of unfinished jobs is right');


We normally start test names with lower case. You can also drop the "is right" in the end which is kind of a given for checks:

Suggested change

'1 unfinished', 'The number of unfinished jobs is right');

'1 unfinished', 'expected number of unfinished jobs');

EDIT: I now see that you're just moving this code. My suggestion would nevertheless be a good improvement.

@b10n1k How about this one?

t/ui/10-tests_overview.t

- Renamed `addComments` to `restartOrCommentJobs` 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 API endpoints via formaction. That removes action attribute from the form element. - Let "comments" be `btn-warning` and "restart" show more severe operation using `btn-danger`. - Adjusted modal to allow submission of comments or restarts through the correct action handlers. - Inform overview page with warning in case of errors in Response. - Redesign `restartOrCommentJobs` (previews addComments) to reflect the new features. 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 using the already existing API implementations. https://progress.opensuse.org/issues/166559 Signed-off-by: Ioannis Bonatakis <[email protected]>

Refactor restartJob in order to make sure that is able to handle request for multiple restarts. This follows up with some changes to the form and the javascript part of the overview.html.ep, which triggers the restart with the use of restartJob, as opposed of reimplement the logic. The advantage is that we have one common behavior and error handling on the restart operation. - An optional comment can be passed not to restartJob, which is included to the request. - restartJob handles both single and multible job restarts. - The form is designed to handle each occasion in separate functions making the code becomes more modular and easier to maintain. - The overvies's restartJobs function will restart only jobs with valid id. https://progress.opensuse.org/issues/166559 Signed-off-by: Ioannis Bonatakis <[email protected]>

github-actions · 2024-10-29T19:49:06Z

Great PR! Please pay attention to the following items before merging:

Files matching assets/stylesheets/**:

Consider providing screenshots in a PR comment to show the difference visually

This is an automatically generated QA checklist based on modified files.

Martchus · 2024-10-30T13:46:54Z

assets/javascripts/openqa.js

+          setTimeout(() => {
+            window.location.reload();
+          }, 2000);


I don't see that this has been updated. As-is it looks like you still can't decide whether to reload the page or show a notification.

I suggest to show a notification. Only this way it is apparent that the operation was actually successful. Otherwise the page is just reloading but the user has to interpret this behavior as success - which is not ideal in my opinion. The notification should also explicitly list of jobs that have actually been successfully restarted so one can easily go though the list to access them if wanted. It can of course also include a link for reloading the page.

Martchus · 2024-10-30T13:52:21Z

assets/stylesheets/overview.scss

+
+.group-comment-icon-stack .fa-undo {
+  color: #0c4374; /* Your specified color */


This comment makes no sense. I suggest you remove it.

Martchus · 2024-10-30T13:55:50Z

t/ui/10-tests_overview.t

+        $driver->get('/tests/overview?state=done&result=failed');
+        $driver->find_element('button[title="Restart or comment jobs"]')->click;
+        my $comment_text = 'comment current jobs and restart';
+        my $submit_button = $driver->find_element('#add-comments-controls button[id="restartAndCommentJobsBtn"]');


This selector is needlessly complicated. If the button has an ID use it directly. There cannot be another button under a different element with the same ID on that page.

Suggested change

my $submit_button = $driver->find_element('#add-comments-controls button[id="restartAndCommentJobsBtn"]');

my $submit_button = $driver->find_element('#restartAndCommentJobsBtn');

Martchus · 2024-10-30T13:59:34Z

templates/webapi/test/overview.html.ep

-                        <button type="submit" class="btn btn-danger">
-                            <i class="fa fa-comment"></i> Submit comment on all <%= scalar @$job_ids %> jobs
+                        <button type="button" class="btn btn-warning"
+                                value="commentJobs" id="commentJobsBtn"


The value seems unused so I suggest you remove it.

Martchus · 2024-10-30T13:59:40Z

templates/webapi/test/overview.html.ep

                        </button>
-                        <button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Discard</button>
+                        <button type="button" class="btn btn-danger"
+                                value="restartAndCommentJobs" id="restartAndCommentJobsBtn"


The value seems unused so I suggest you remove it.

Martchus · 2024-10-30T14:03:29Z

templates/webapi/test/overview.html.ep

+
+			<div class="flex-fill"><i class="fa fa-cog fa-spin
+							 fa-fw"></i> Saving…</div>
+			<div class="progress" id="restart-progress-bar">


This ID is not used. But is that right? Wouldn't one want to set the progress bar value at some point? It looks like this code is actually just a leftover. I suggest to stick with a simpler spinning loading indication anyway.

Martchus · 2024-10-30T14:04:18Z

templates/webapi/test/overview.html.ep

                <div class="modal-header">
                    <h4 class="modal-title">Add comment on all currently shown jobs</h4>
                    <button type="button" class="btn-close" data-bs-dismiss="modal"></button>
                </div>
                <div class="modal-body">
                    %= include 'comments/add_comment_form_groups', group_comment => 0, nosubmit => 1
                </div>
+


Suggested change

Martchus · 2024-10-30T14:05:34Z

templates/webapi/test/overview.html.ep

-                        <div class="flex-fill"><i class="fa fa-cog fa-spin fa-fw"></i> Saving…</div>
+
+			<div class="flex-fill"><i class="fa fa-cog fa-spin
+							 fa-fw"></i> Saving…</div>


Why did you break/wrap this line? It looked much nicer as a single line and without the blank line before it.

Martchus · 2024-10-30T14:06:38Z

templates/webapi/test/overview.html.ep

+            <button type="button" class="btn btn-secondary btn-circle btn-sm
+            trigger-edit-button" onclick="showAddCommentsDialog()" title="Restart or comment jobs">


Don't wrap this line in the middle of an attribute value.

Martchus · 2024-10-30T14:06:48Z

templates/webapi/test/overview.html.ep

-                <i class="fa fa-comment" aria-hidden="true"></i>
+            <button type="button" class="btn btn-secondary btn-circle btn-sm
+            trigger-edit-button" onclick="showAddCommentsDialog()" title="Restart or comment jobs">
+                <span class="fa-stack group-comment-icon-stack" >


Suggested change

<span class="fa-stack group-comment-icon-stack" >

<span class="fa-stack group-comment-icon-stack">

This comment was marked as outdated.

Sign in to view

This comment was marked as resolved.

Sign in to view

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

This comment was marked as resolved.

Sign in to view

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

This comment was marked as resolved.

Sign in to view

okurz requested changes Oct 4, 2024

View reviewed changes

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

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

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

Martchus requested changes Oct 4, 2024

View reviewed changes

b10n1k force-pushed the batch_restart_with_comment branch 2 times, most recently from dd44e25 to e188f9e Compare October 14, 2024 10:03

This comment was marked as resolved.

Sign in to view

b10n1k force-pushed the batch_restart_with_comment branch 2 times, most recently from 7577c7e to c07da9d Compare October 14, 2024 19:21

This comment was marked as resolved.

Sign in to view

b10n1k force-pushed the batch_restart_with_comment branch from c07da9d to d98507f Compare October 15, 2024 13:16

Martchus requested changes Oct 15, 2024

View reviewed changes

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

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

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

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

b10n1k force-pushed the batch_restart_with_comment branch from d98507f to f33859a Compare October 16, 2024 20:35

b10n1k added in progress not-ready labels Oct 17, 2024

kalikiana mentioned this pull request Oct 17, 2024

Add option to restart jobs upon comment submission #5946

Draft

okurz approved these changes Oct 23, 2024

View reviewed changes

This comment was marked as resolved.

Sign in to view

b10n1k removed the in progress label Oct 23, 2024

This comment was marked as resolved.

Sign in to view

b10n1k force-pushed the batch_restart_with_comment branch from 717e152 to 1a241aa Compare October 24, 2024 14:59

b10n1k removed the not-ready label Oct 24, 2024

okurz requested changes Oct 25, 2024

View reviewed changes

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

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

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

kalikiana approved these changes Oct 25, 2024

View reviewed changes

b10n1k force-pushed the batch_restart_with_comment branch from 1a241aa to d2d169f Compare October 25, 2024 08:47

okurz approved these changes Oct 25, 2024

View reviewed changes

Martchus requested changes Oct 25, 2024

View reviewed changes

b10n1k added 2 commits October 29, 2024 09:28

b10n1k force-pushed the batch_restart_with_comment branch from d2d169f to 6a99188 Compare October 29, 2024 19:48

Martchus requested changes Oct 30, 2024

View reviewed changes

	var testUrlData = responseJSON.test_url;
	const testUrlData = responseJSON?.test_url;

	'1 unfinished', 'The number of unfinished jobs is right');
	'1 unfinished', 'expected number of unfinished jobs');


		.group-comment-icon-stack .fa-undo {
		color: #0c4374; /* Your specified color */

	my $submit_button = $driver->find_element('#add-comments-controls button[id="restartAndCommentJobsBtn"]');
	my $submit_button = $driver->find_element('#restartAndCommentJobsBtn');

		<button type="button" class="btn btn-secondary btn-circle btn-sm
		trigger-edit-button" onclick="showAddCommentsDialog()" title="Restart or comment jobs">

	<span class="fa-stack group-comment-icon-stack" >
	<span class="fa-stack group-comment-icon-stack">

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

This comment was marked as outdated.

This comment was marked as resolved.

This comment was marked as resolved.

codecov bot commented Oct 3, 2024 • edited Loading

Codecov Report

This comment was marked as resolved.

This comment was marked as resolved.

b10n1k commented Oct 7, 2024

Martchus commented Oct 7, 2024

b10n1k commented Oct 14, 2024

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

b10n1k commented Oct 23, 2024 • edited Loading

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

perlpunk commented Oct 24, 2024

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

github-actions bot commented Oct 29, 2024

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

codecov bot commented Oct 3, 2024 •

edited

Loading

b10n1k commented Oct 23, 2024 •

edited

Loading