[JENKINS-72509] show error message in progressive logs on 4xx status codes #8907

mawinter69 · 2024-01-28T11:50:06Z

when accessing the log of a running build and the job gets deleted or someone removes read permissions (without discover) the log just appends the output of the call to logText/progressiveHtml which is the 404 message from Jenkins.
The same happens when one accesses the log of an agent and the agent is deleted.
This is due to only checking for 403 status and ignoring other status codes from the 4xx range.
With this change all 4xx http status code will lead to a reload and then showing a proper 404 page in mentioned cases

See JENKINS-72509.

Testing done

Agents:

create an agent and connect it
visit the log page of the agent
in another window delete the agent
-> the page shows an error message instead of adding the 404 to the logoutput

Jobs:

Create a job, that sleeps for a few minutes
start the job and look at the console output (dito for consolFull)
In a separate window delete the job
-> the page shows an error message instead of adding the 404 to the logoutput
Create a job, that sleeps for a few minutes
start the job
As a different user that has job read permissions open the job log (use another browser)
as admin user remove read permissions for that other
-> the page shows an error message instead of adding the 404 to the logoutput

Proposed changelog entries

JENKINS-72509, show error message in progressive logs on 4xx status codes

Proposed upgrade guidelines

N/A

Submitter checklist

Give feedback

The Jira issue, if it exists, is well-described.

The Jira issue, if it exists, is well-described.
Options
Successfully updated the issue's project

There was an error updating the issue's project
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](https://github.com/jenkins-infra/jenkins.io/blob/master/content/_data/changelogs/weekly.yml)). Fill in the **Proposed upgrade guidelines** section only if there are breaking changes or changes that may require extra steps from users during upgrade.

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.
Options
Successfully updated the issue's project

There was an error updating the issue's project
There is automated testing or an explanation as to why this change has no tests.

There is automated testing or an explanation as to why this change has no tests.
Options
Successfully updated the issue's project

There was an error updating the issue's project
New public classes, fields, and methods are annotated with `@Restricted` or have `@since TODO` Javadocs, as appropriate.

New public classes, fields, and methods are annotated with @Restricted or have @since TODO Javadocs, as appropriate.
Options
Successfully updated the issue's project

There was an error updating the issue's project
New deprecations are annotated with `@Deprecated(since = "TODO")` or `@Deprecated(forRemoval = true, since = "TODO")`, if applicable.

New deprecations are annotated with @Deprecated(since = "TODO") or @Deprecated(forRemoval = true, since = "TODO"), if applicable.
Options
Successfully updated the issue's project

There was an error updating the issue's project
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](https://www.jenkins.io/doc/developer/security/csp/)).

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).
Options
Successfully updated the issue's project

There was an error updating the issue's project
For dependency updates, there are links to external changelogs and, if possible, full differentials.

For dependency updates, there are links to external changelogs and, if possible, full differentials.
Options
Successfully updated the issue's project

There was an error updating the issue's project
For new APIs and extension points, there is a link to at least one consumer.

For new APIs and extension points, there is a link to at least one consumer.
Options
Successfully updated the issue's project

There was an error updating the issue's project
Options

Desired reviewers

@mention

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.

There are at least two (2) approvals for the pull request and no outstanding requests for change.
Options
Successfully updated the issue's project

There was an error updating the issue's project
Conversations in the pull request are over, or it is explicit that a reviewer is not blocking the change.

Conversations in the pull request are over, or it is explicit that a reviewer is not blocking the change.
Options
Successfully updated the issue's project

There was an error updating the issue's project
Changelog entries in the pull request title and/or **Proposed changelog entries** are accurate, human-readable, and in the imperative mood.

Changelog entries in the pull request title and/or Proposed changelog entries are accurate, human-readable, and in the imperative mood.
Options
Successfully updated the issue's project

There was an error updating the issue's project
Proper changelog labels are set so that the changelog can be generated automatically.

Proper changelog labels are set so that the changelog can be generated automatically.
Options
Successfully updated the issue's project

There was an error updating the issue's project
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](https://github.com/jenkinsci/jenkins/pull/4387)).

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).
Options
Successfully updated the issue's project

There was an error updating the issue's project
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](https://issues.jenkins.io/issues/?filter=12146)).

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
Successfully updated the issue's project

There was an error updating the issue's project
Options

when accessing the log of a running build and the job gets deleted or someone removes read permissions (without discover) the log just appends the output of the call to logText/progressiveHtml which is the 404 message from Jenkins. The same happens when one accesses the log of an agent and the agent is deleted. This is due to only checking for 403 status and ignoring other status codes from the 400 range.

NotMyFault

Thanks!

timja · 2024-01-29T20:42:21Z

core/src/main/resources/lib/hudson/progressive-text.js

@@ -38,8 +38,8 @@ Behaviour.specify(
          }, 1000);
          return;
        }
-        if (rsp.status === 403) {
-          // likely an expired crumb
+        if (rsp.status >= 400) {


should this reload on server errors? it might get in a reload loop?

server errors are already catched in the previous if (line 35)

daniel-beck · 2024-01-29T21:24:54Z

Is the diagnosis of short-lived logs a relevant use case we should continue to support, e.g., cloud agent connection logs? If so, a forced reload when it goes away makes for a worse experience. Not saying no to this, but this seems to have notable downsides compared to e.g. showing a message summarizing the error (rather than inlining the entire page, see e.g. how form validation currently does it) and offering to reload.

mawinter69 · 2024-01-30T20:06:09Z

Is the diagnosis of short-lived logs a relevant use case we should continue to support, e.g., cloud agent connection logs? If so, a forced reload when it goes away makes for a worse experience. Not saying no to this, but this seems to have notable downsides compared to e.g. showing a message summarizing the error (rather than inlining the entire page, see e.g. how form validation currently does it) and offering to reload.

Valid point. Changed it to print an error instead of reloading for return codes other than 403

NotMyFault

Thanks!

timja · 2024-01-31T07:59:15Z

/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!

mawinter69 changed the title ~~[JENKINS-72509] avoid broken log when deleting job/agent~~ [JENKINS-72509] reload progressive logs on all 4xx status codes Jan 28, 2024

mawinter69 force-pushed the JENKINS-72509 branch from 496a35a to 1ab9182 Compare January 28, 2024 11:52

NotMyFault approved these changes Jan 29, 2024

View reviewed changes

NotMyFault added web-ui The PR includes WebUI changes which may need special expertise bug For changelog: Minor bug. Will be listed after features labels Jan 29, 2024

NotMyFault requested a review from a team January 29, 2024 18:47

timja reviewed Jan 29, 2024

View reviewed changes

timja approved these changes Jan 29, 2024

View reviewed changes

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

do not reload but print an error

c8aa4f0

daniel-beck requested review from daniel-beck, timja and NotMyFault January 30, 2024 20:24

mawinter69 changed the title ~~[JENKINS-72509] reload progressive logs on all 4xx status codes~~ [JENKINS-72509] show error message in progressive logs on 4xx status codes Jan 30, 2024

apply prettier

b4d0472

NotMyFault approved these changes Jan 30, 2024

View reviewed changes

timja approved these changes Jan 31, 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 Jan 31, 2024

NotMyFault merged commit d7be82a into jenkinsci:master Feb 1, 2024
17 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[JENKINS-72509] show error message in progressive logs on 4xx status codes #8907

[JENKINS-72509] show error message in progressive logs on 4xx status codes #8907

mawinter69 commented Jan 28, 2024 •

edited

Submitter checklist

Maintainer checklist

NotMyFault left a comment

timja Jan 29, 2024

mawinter69 Jan 29, 2024

daniel-beck commented Jan 29, 2024

mawinter69 commented Jan 30, 2024

NotMyFault left a comment

timja commented Jan 31, 2024

[JENKINS-72509] show error message in progressive logs on 4xx status codes #8907

[JENKINS-72509] show error message in progressive logs on 4xx status codes #8907

Conversation

mawinter69 commented Jan 28, 2024 • edited

Testing done

Proposed changelog entries

Proposed upgrade guidelines

Submitter checklist

Desired reviewers

Maintainer checklist

NotMyFault left a comment

Choose a reason for hiding this comment

timja Jan 29, 2024

Choose a reason for hiding this comment

mawinter69 Jan 29, 2024

Choose a reason for hiding this comment

daniel-beck commented Jan 29, 2024

mawinter69 commented Jan 30, 2024

NotMyFault left a comment

Choose a reason for hiding this comment

timja commented Jan 31, 2024

mawinter69 commented Jan 28, 2024 •

edited