Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

8321131: Console read line with zero out should zero out underlying buffer in JLine #16930

Closed

Conversation

naotoj
Copy link
Member

@naotoj naotoj commented Dec 1, 2023

This is the fix to JLine, which makes it on par with the built-in Console fix (JDK-8320798).


Progress

  • Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue

Issue

  • JDK-8321131: Console read line with zero out should zero out underlying buffer in JLine (Bug - P4)

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/16930/head:pull/16930
$ git checkout pull/16930

Update a local copy of the PR:
$ git checkout pull/16930
$ git pull https://git.openjdk.org/jdk.git pull/16930/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 16930

View PR using the GUI difftool:
$ git pr show -t 16930

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/16930.diff

Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Dec 1, 2023

👋 Welcome back naoto! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

@openjdk openjdk bot added the rfr Pull request is ready for review label Dec 1, 2023
@openjdk
Copy link

openjdk bot commented Dec 1, 2023

@naotoj The following label will be automatically applied to this pull request:

  • kulla

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

@openjdk openjdk bot added the kulla kulla-dev@openjdk.org label Dec 1, 2023
@mlbridge
Copy link

mlbridge bot commented Dec 1, 2023

Webrevs

@naotoj
Copy link
Member Author

naotoj commented Dec 1, 2023

/label add core-libs

@openjdk openjdk bot added the core-libs core-libs-dev@openjdk.org label Dec 1, 2023
@openjdk
Copy link

openjdk bot commented Dec 1, 2023

@naotoj
The core-libs label was successfully added.

@@ -110,6 +110,8 @@ public char[] readPassword(String fmt, Object ... args) {
return jline.readLine(fmt.formatted(args), '\0').toCharArray();
} catch (EndOfFileException eofe) {
return null;
} finally {
jline.zeroOut();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The location of the jline declaration at new line 134 is unfortunate, but not a problem this PR needs to resolve. The location makes sense if it was only used in initJLineIfNeeded() at some point in the past.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, Iris. Moved those instance fields to the top of the class.

@openjdk
Copy link

openjdk bot commented Dec 1, 2023

@naotoj This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8321131: Console read line with zero out should zero out underlying buffer in JLine

Reviewed-by: iris, alanb, jlahoda

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 24 new commits pushed to the master branch:

  • a9de5c7: 8315128: jdk/jfr/event/runtime/TestResidentSetSizeEvent.java fails with "The size should be less than or equal to peak"
  • d2c529c: 8319072: JFR: Turn off events for JFR.view
  • d5f59cf: 8321220: JFR: RecordedClass reports incorrect modifiers
  • 9769dfe: 8321214: Parallel: Remove unused SpaceInfo::_min_dense_prefix
  • d23f4f1: 8315559: Delay TempSymbol cleanup to avoid symbol table churn
  • c17b8cf: 8320655: awt screencast robot spin and sync issues with native libpipewire api
  • ed5b8c3: 8225220: When the Tab Policy is checked,the scroll button direction displayed incorrectly.
  • f32ab8c: 8320924: Improve heap dump performance by optimizing archived object checks
  • 93b9235: 8321120: Shenandoah: Remove ShenandoahElasticTLAB flag
  • 9b8eaa2: 8319872: AArch64: [vectorapi] Implementation of unsigned (zero extended) casts
  • ... and 14 more: https://git.openjdk.org/jdk/compare/f6be7fdf22eede767a0ac29b4f1cb770cfdc0b0f...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Dec 1, 2023
@@ -67,6 +67,9 @@ public JdkConsole console(boolean isTTY, Charset charset) {
* public Console class.
*/
private static class JdkConsoleImpl implements JdkConsole {
private final Terminal terminal;
private volatile LineReader jline;

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Relocation looks good. Thanks!

Copy link
Contributor

@AlanBateman AlanBateman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks okay. I think @MBaesken plans to try to create some automated tests for this.

Copy link
Contributor

@lahodaj lahodaj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks OK to me, thanks!

@naotoj
Copy link
Member Author

naotoj commented Dec 4, 2023

Thanks for the reviews!
/integrate

@openjdk
Copy link

openjdk bot commented Dec 4, 2023

Going to push as commit bd04f91.
Since your change was applied there have been 28 commits pushed to the master branch:

  • 155abc5: 8311906: Improve robustness of String constructors with mutable array inputs
  • 316b783: 8321276: runtime/cds/appcds/dynamicArchive/DynamicSharedSymbols.java failed with "'17 2: jdk/test/lib/apps ' missing from stdout/stderr"
  • 65be5e0: 8305931: jdk/jfr/jcmd/TestJcmdDumpPathToGCRoots.java failed with "Expected chains but found none"
  • f6be922: 8316193: jdk/jfr/event/oldobject/TestListenerLeak.java java.lang.Exception: Could not find leak
  • a9de5c7: 8315128: jdk/jfr/event/runtime/TestResidentSetSizeEvent.java fails with "The size should be less than or equal to peak"
  • d2c529c: 8319072: JFR: Turn off events for JFR.view
  • d5f59cf: 8321220: JFR: RecordedClass reports incorrect modifiers
  • 9769dfe: 8321214: Parallel: Remove unused SpaceInfo::_min_dense_prefix
  • d23f4f1: 8315559: Delay TempSymbol cleanup to avoid symbol table churn
  • c17b8cf: 8320655: awt screencast robot spin and sync issues with native libpipewire api
  • ... and 18 more: https://git.openjdk.org/jdk/compare/f6be7fdf22eede767a0ac29b4f1cb770cfdc0b0f...master

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Dec 4, 2023
@openjdk openjdk bot closed this Dec 4, 2023
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Dec 4, 2023
@openjdk
Copy link

openjdk bot commented Dec 4, 2023

@naotoj Pushed as commit bd04f91.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core-libs core-libs-dev@openjdk.org integrated Pull request has been integrated kulla kulla-dev@openjdk.org
4 participants