Skip to content

Fix plain text log output dropping trailing partial lines - #27233

Open
thswlsqls wants to merge 1 commit into
jenkinsci:masterfrom
thswlsqls:fix/annotatedlargetext-plaintext-partial-line
Open

Fix plain text log output dropping trailing partial lines#27233
thswlsqls wants to merge 1 commit into
jenkinsci:masterfrom
thswlsqls:fix/annotatedlargetext-plaintext-partial-line

Conversation

@thswlsqls

Copy link
Copy Markdown
Contributor

Part of #26739
Follow-up to #26871

AnnotatedLargeText.writeLogTo(long, OutputStream) neither flushes its PlainTextConsoleOutputStream line buffer nor back-tracks the returned offset, so a trailing partial line is withheld but still counted as delivered: a client resuming at that offset never sees it. #26871 fixed both in the sibling writeHtmlTo(long, Writer), adding lineBufferSize() for it, but not here.

Reached by tailing a running build: logText/progressiveText with Accept: multipart/form-data runs doProgressTextStreaming -> writeLogTo(long, Writer) (non-HTML) -> writeLogTo(start, new WriterOutputStream(...)) -> here, and that streaming branch bulk-writes to EOF instead of stopping at a line boundary, so the partial line stays buffered. Buffered progressiveText sets delegateToWriteLogTo=false and never reaches this method; Run/_api.jelly (lines 48, 61) documents both.

Testing done

No Jenkins instance available. Reviewer steps: run a build emitting text without a trailing newline (sh 'printf partial'), then poll curl -H 'Accept: multipart/form-data' "$JENKINS/job/$NAME/$N/logText/progressiveText?start=0" while it runs.

  • New AnnotatedLargeTextPartialLineTest: 3 of 5 cases fail without the fix; all assert emitted bytes and the returned offset.
  • JDK 21, build cache off: mvn -pl core -am test -Dtest='TaskActionTest,AnnotatedLargeTextPartialLineTest,LineTransformationOutputStreamTest,UrlAnnotatorTest' gave Tests run: 12, Failures: 0, Errors: 0, Skipped: 0.
  • mvn spotless:check -pl core passed.

Screenshots (UI changes only)

N/A, no UI change.

Before

After

Proposed changelog entries

  • Fix loss of trailing partial lines when tailing plain text console logs.

Proposed changelog category

/label bug

Proposed upgrade guidelines

N/A

Submitter checklist

  • The 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.
  • UI changes do not introduce regressions when enforcing the current default rules of Content Security Policy Plugin. In particular, 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.

Desired reviewers

@mention

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

Maintainer checklist

  • 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, be a Bug or Improvement, and either the issue or pull request must be labeled as lts-candidate to be considered.

@comment-ops-bot comment-ops-bot Bot added the bug For changelog: Minor bug. Will be listed after features label Aug 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug For changelog: Minor bug. Will be listed after features

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant