Add download option to 'Console output', move 'View as plain text' and 'Copy' buttons to app bar #9169

janfaracik · 2024-04-14T09:14:20Z

Before

After

Small MR to add a 'Download' link to the console output, as well as to move the controls to the app bar so that they're grouped. Let me know your thoughts on the updated placement - happy to discuss alternatives.

Testing done

Copy button works as before
View as plain text works as before
Download button downloads the full log

Proposed changelog entries

Add download option to 'Console output', move 'View as plain text' and 'Copy' buttons to app bar

Proposed upgrade guidelines

N/A

Submitter checklist

Give feedback

The Jira issue, if it exists, is well-described.
The changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developers, depending on the change) and are in the imperative mood (see examples). Fill in the Proposed upgrade guidelines section only if there are breaking changes or changes that may require extra steps from users during upgrade.
There is automated testing or an explanation as to why this change has no tests.
New public classes, fields, and methods are annotated with @Restricted or have @since TODO Javadocs, as appropriate.
New deprecations are annotated with @Deprecated(since = "TODO") or @Deprecated(forRemoval = true, since = "TODO"), if applicable.
New or substantially changed JavaScript is not defined inline and does not call eval to ease future introduction of Content Security Policy (CSP) directives (see documentation).
For dependency updates, there are links to external changelogs and, if possible, full differentials.
For new APIs and extension points, there is a link to at least one consumer.
Options

Desired reviewers

@jenkinsci/sig-ux

Before the changes are marked as ready-for-merge:

Maintainer checklist

Give feedback

There are at least two (2) approvals for the pull request and no outstanding requests for change.
Conversations in the pull request are over, or it is explicit that a reviewer is not blocking the change.
Changelog entries in the pull request title and/or Proposed changelog entries are accurate, human-readable, and in the imperative mood.
Proper changelog labels are set so that the changelog can be generated automatically.
If the change needs additional upgrade steps from users, the upgrade-guide-needed label is set and there is a Proposed upgrade guidelines section in the pull request title (see example).
If it would make sense to backport the change to LTS, a Jira issue must exist, be a Bug or Improvement, and be labeled as lts-candidate to be considered (see query).
Options

mawinter69

Is the copy option really the best thing as being the one that is directly accessible?
So far I never had really the need to copy the logs. But looking at the log in plain text I do from time to time

mawinter69 · 2024-04-14T11:00:14Z

core/src/main/resources/hudson/model/Run/console.jelly

+        <l:copyButton ref="out" label="${%Copy}" />
+        <l:overflowButton>
+          <dd:custom>
+            <a class="jenkins-dropdown__item" href="consoleText" download="${it.displayName}.txt">


Is it really useful to use the displayname here? If I choose a displayname that contains a / this wouldn't be saveable.
something like
${it.parent.name}-{it.number}.txt would guarantee a valid filename

If I choose a displayname that contains a / this wouldn't be saveable.

Per https://html.spec.whatwg.org/multipage/links.html#attr-hyperlink-download

The attribute may have a value; the value, if any, specifies the default filename that the author recommends for use in labeling the resource in a local file system. There are no restrictions on allowed values, but authors are cautioned that most file systems have limitations with regard to what punctuation is supported in filenames, and user agents are likely to adjust filenames accordingly.

Trying this PR and DOM editing in Firefox, I get the file foo_bar_#1.txt from the attribute value foo/bar/#1.txt.

(parent.fullName might still be better though. Unsure whether we should go for display names, there's arguments for and against IMO)

mawinter69 · 2024-04-14T11:07:31Z

Is the copy option really the best thing as being the one that is directly accessible? So far I never had really the need to copy the logs. But looking at the log in plain text I do from time to time

probably OK to have it like proposed.

uhafner · 2024-04-17T07:11:34Z

It took me a while to understand that the result is visible in freestyle jobs only. Isn't the PR that unifies the console in pipelines and freestyle jobs already merged?

I think it is a good idea to move the actions to the app bar. I'm not sure why the copy action is a button (I never use this action, does it copy the whole log or the visible section?), but I very often use the "raw console" link. Maybe we can show the latter as button as well (or only this one). The app bar has a lot of space that is not used yet. Do we have anonymous user statistics about such preferences?

mawinter69 · 2024-04-17T07:58:50Z

but I very often use the "raw console" link

same for me

daniel-beck · 2024-04-17T08:09:33Z

I'm not sure why the copy action is a button (I never use this action, does it copy the whole log or the visible section?)

My guess is because it's a recently added action (#8960) that has been previously implemented like this? Copying seems like the least needed use case, and between view raw, and download raw, even seems redundant. (And it only copies the visible section, via JS.)

janfaracik · 2024-04-23T19:38:24Z

I'm not sure why the copy action is a button (I never use this action, does it copy the whole log or the visible section?)

My guess is because it's a recently added action (#8960) that has been previously implemented like this? Copying seems like the least needed use case, and between view raw, and download raw, even seems redundant. (And it only copies the visible section, via JS.)

Essentially that - I didn't want to undo the existing work, happy to prioritise the order of download/complete log however as I agree.

janfaracik · 2024-04-24T20:29:01Z

Updated it so that there's no longer an overflow menu - all actions are top level now.

janfaracik · 2024-05-17T08:07:10Z

ATH passing - jenkinsci/acceptance-test-harness#1563

timja

Needs a matching PR to Pipeline (probably workflow-job) as well.

Apart from that LGTM

core/src/main/resources/hudson/model/Run/console.jelly

mawinter69

looks good. One minor thing but not blocking

janfaracik · 2024-05-20T17:24:20Z

Needs a matching PR to Pipeline (probably workflow-job) as well.

Apart from that LGTM

Done - thanks! jenkinsci/workflow-job-plugin#439

timja

/label ready-for-merge

This PR is now ready for merge, after ~24 hours, we will merge it if there's no negative feedback.

Thanks!

FredericSouchon · 2024-08-21T07:35:02Z

Hello,

as I told in JENKINS-73657, This is a real regression because it is requires to open the "console output" view that may crash the browser if the log is heavy enough. this use case may have been forgotten.

Could you submit the comeback of the "view as plain text" option in the lateral menu ?

Thanks in advance,

JanKirsch · 2024-09-02T12:36:22Z

Hi there, same here.

This is a real regression because it is requires to open the "console output" view that may crash the browser if the log is heavy enough. this use case may have been forgotten.

Yes, that doesn't seem to have been taken into account. On our Jenkins we have huge logs, which leads to a broken "Console Output" view at approx. 80% of our jobs. We have to wait to get to the now hidden "View as plain text" button, because it is not clickable until the browser is able to breath again. That makes me very sad. I totally understand why this change come up, but unfortunately the "Console Output" view is not stable enough to handle huge logs.

Could you submit the comeback of the "view as plain text" option in the lateral menu ?

Please bring it back or come up with a configurable Job "Navigation menu" or improve the "Console Output" view. No matter what you do, please make the community happy again :)

mawinter69 · 2024-09-02T12:57:37Z

Could be easily done with a plugin.

mawinter69 · 2024-09-02T13:27:15Z

jenkins-infra/repository-permissions-updater#4063

mirao · 2024-09-24T08:45:50Z

Since 2.462.1, we can see the bug https://issues.jenkins.io/browse/JENKINS-73683.
As this pull request contains some changes related to console output, is it possible that it caused the issue with timestamps as mentioned in that bug?

MarkEWaite · 2024-09-24T12:36:41Z

Since 2.462.1, we can see the bug https://issues.jenkins.io/browse/JENKINS-73683. As this pull request contains some changes related to console output, is it possible that it caused the issue with timestamps as mentioned in that bug?

It seems unlikely to me, but you can experiment with it by building a Jenkins core yourself with this pull request reverted. See the CONTRIBUTING file for the instructions to build Jenkins core yourself.

janfaracik added 6 commits April 14, 2024 10:04

Init

22dd556

Update copyButton.jelly

e972dd4

Update console.jelly

4e5dfc1

Update console.jelly

ac013f2

Update console.jelly

32b24f8

Remove props

6336764

timja added rfe For changelog: Minor enhancement. use `major-rfe` for changes to be highlighted web-ui The PR includes WebUI changes which may need special expertise labels Apr 14, 2024

mawinter69 suggested changes Apr 14, 2024

View reviewed changes

Update console.jelly

d448e03

Merge branch 'master' into revamp-console-app-bar

db9105d

yaroslavafenkin added the security-approved @jenkinsci/core-security-review reviewed this PR for security issues label Apr 30, 2024

Merge branch 'master' into revamp-console-app-bar

60be52e

basil added the needs-ath-build Needs to run through the full acceptance-test-harness suite label May 14, 2024

janfaracik mentioned this pull request May 16, 2024

Tests for 'Add download option to console output #9169' jenkinsci/acceptance-test-harness#1563

Closed

Merge branch 'master' into revamp-console-app-bar

f7b2dda

timja added ath-successful This PR has successfully passed the full acceptance-test-harness suite and removed needs-ath-build Needs to run through the full acceptance-test-harness suite labels May 17, 2024

timja requested a review from mawinter69 May 19, 2024 10:14

timja reviewed May 19, 2024

View reviewed changes

mawinter69 reviewed May 19, 2024

View reviewed changes

core/src/main/resources/hudson/model/Run/console.jelly Outdated Show resolved Hide resolved

mawinter69 approved these changes May 19, 2024

View reviewed changes

janfaracik mentioned this pull request May 20, 2024

Add download option to 'Console output', move 'View as plain text' and 'Copy' buttons to app bar jenkinsci/workflow-job-plugin#439

Merged

6 tasks

Remove import

b810a3f

Merge branch 'master' into revamp-console-app-bar

fddb5d8

timja approved these changes May 21, 2024

View reviewed changes

comment-ops-bot bot added the ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback label May 21, 2024

timja merged commit caea9bd into jenkinsci:master May 22, 2024
17 checks passed

timja deleted the revamp-console-app-bar branch May 22, 2024 15:09

reinholdfuereder mentioned this pull request Jul 18, 2024

Add copy-to-clipboard button to the build console output #8960

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add download option to 'Console output', move 'View as plain text' and 'Copy' buttons to app bar #9169

Add download option to 'Console output', move 'View as plain text' and 'Copy' buttons to app bar #9169

janfaracik commented Apr 14, 2024 •

edited

Loading

Submitter checklist

Maintainer checklist

mawinter69 left a comment

mawinter69 Apr 14, 2024 •

edited

Loading

daniel-beck Apr 16, 2024

mawinter69 commented Apr 14, 2024 •

edited

Loading

uhafner commented Apr 17, 2024

mawinter69 commented Apr 17, 2024

daniel-beck commented Apr 17, 2024

janfaracik commented Apr 23, 2024

janfaracik commented Apr 24, 2024

janfaracik commented May 17, 2024

timja left a comment

mawinter69 left a comment

janfaracik commented May 20, 2024

timja left a comment

FredericSouchon commented Aug 21, 2024

JanKirsch commented Sep 2, 2024

mawinter69 commented Sep 2, 2024

mawinter69 commented Sep 2, 2024

mirao commented Sep 24, 2024 •

edited

Loading

MarkEWaite commented Sep 24, 2024

Add download option to 'Console output', move 'View as plain text' and 'Copy' buttons to app bar #9169

Add download option to 'Console output', move 'View as plain text' and 'Copy' buttons to app bar #9169

Conversation

janfaracik commented Apr 14, 2024 • edited Loading

Testing done

Proposed changelog entries

Proposed upgrade guidelines

Submitter checklist

Desired reviewers

Maintainer checklist

mawinter69 left a comment

Choose a reason for hiding this comment

mawinter69 Apr 14, 2024 • edited Loading

Choose a reason for hiding this comment

daniel-beck Apr 16, 2024

Choose a reason for hiding this comment

mawinter69 commented Apr 14, 2024 • edited Loading

uhafner commented Apr 17, 2024

mawinter69 commented Apr 17, 2024

daniel-beck commented Apr 17, 2024

janfaracik commented Apr 23, 2024

janfaracik commented Apr 24, 2024

janfaracik commented May 17, 2024

timja left a comment

Choose a reason for hiding this comment

mawinter69 left a comment

Choose a reason for hiding this comment

janfaracik commented May 20, 2024

timja left a comment

Choose a reason for hiding this comment

FredericSouchon commented Aug 21, 2024

JanKirsch commented Sep 2, 2024

mawinter69 commented Sep 2, 2024

mawinter69 commented Sep 2, 2024

mirao commented Sep 24, 2024 • edited Loading

MarkEWaite commented Sep 24, 2024

janfaracik commented Apr 14, 2024 •

edited

Loading

mawinter69 Apr 14, 2024 •

edited

Loading

mawinter69 commented Apr 14, 2024 •

edited

Loading

mirao commented Sep 24, 2024 •

edited

Loading