8320692: Null icon returned for .exe without custom icon #17475

azuev-java · 2024-01-18T00:47:00Z

Replaced asserts with NullPointerException calls because outside of testing that would be more informative - i do not think many people running their applications with assertions in system libraries enabled;
Added a code that will analyze the result of the getIcon and will fall back to the default icon for the file type retrieved from the ShellFolder;
Added a test case made by Aleksei Ivanov.

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-8320692: Null icon returned for .exe without custom icon (Bug - P4)

Reviewers

Alexey Ivanov (@aivanov-jdk - Reviewer)

Contributors

Alexey Ivanov <aivanov@openjdk.org>

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 17475

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

Using diff file

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

Webrev

Link to Webrev Comment

Replaced asserts with NullPointerException calls because outside of testing that would be more informative - i do not think many people running their applications with assertions in system libraries enabled; Added a code that will analyze the result of the getIcon and will fall back to the default icon for the file type retrieved from the ShellFolder; Added a test case made by Aleksei Ivanov.

bridgekeeper · 2024-01-18T00:48:34Z

👋 Welcome back kizune! 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.

azuev-java · 2024-01-18T00:51:01Z

/label client

openjdk · 2024-01-18T00:51:30Z

@azuev-java The following label will be automatically applied to this pull request:

client

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 · 2024-01-18T00:52:29Z

@azuev-java The client label was already applied.

mlbridge · 2024-01-18T00:56:18Z

Webrevs

aivanov-jdk · 2024-01-18T17:26:30Z

src/java.desktop/windows/classes/sun/awt/shell/Win32ShellFolder2.java

+            if (multiResolutionIcon.containsValue(null)) {
+                return null;
+            } else {
+                return new MultiResolutionIconImage(size, multiResolutionIcon);
+            }


Can we return null immediately if an icon that we're about to put into multiResolutionIcon is null?

That is change the line 1198(1195)

jdk/src/java.desktop/windows/classes/sun/awt/shell/Win32ShellFolder2.java

Line 1198 in 1640fbb

multiResolutionIcon.put(s, newIcon);

to

if (newIcon == null) { return null; } multiResolutionIcon.put(s, newIcon);

I assume if newIcon == null then hIcon is also null, in which case we can move this condition to the line 1195(1192)

jdk/src/java.desktop/windows/classes/sun/awt/shell/Win32ShellFolder2.java

Line 1195 in 1640fbb

newIcon = makeIcon(hIcon);

before calling makeIcon.

Ok, i will move it to the line 1198 because i can not guarantee that we do not need to dispose hIcon if we can not make icon out of it so i would rather avoid potential resource leak.

We need to dispose of hIcon if it's non-null. I see that in this case hIcon is not null yet makeIcon fails to get the bitmap for whatever reason.

It would be good to understand why makeIcon fails even though hIcon is not null.

It is possible that makeIcon fails to extract an icon, so the added null-check ensures null is returned instead of returning a broken MRI.

aivanov-jdk · 2024-01-18T17:30:11Z

src/java.desktop/windows/classes/sun/awt/shell/Win32ShellFolder2.java

-            assert !resolutionVariants.containsValue(null)
-                   : "There are null icons in the MRI variants map";
+            if (resolutionVariants.containsValue(null)) {
+                throw new NullPointerException("There are null icons in the MRI variants map");
+            }


I'm unsure about this. The idea with assert was to provide a debugging aid without affecting regular runtime. We control all the paths that call this constructor and, therefore, we should ensure it's never called if resolutionVariants contains null.

It's exactly what you've done in this PR.

Ok, i will revert that part.

azuev-java · 2024-01-18T17:45:14Z

/contributor add @aivanov-jdk

openjdk · 2024-01-18T17:46:46Z

@azuev-java
Contributor Alexey Ivanov <aivanov@openjdk.org> successfully added.

Move null check inside the loop so we do not retrieve extra icons if we encounter a null one

aivanov-jdk · 2024-01-19T17:42:58Z

src/java.desktop/windows/classes/sun/awt/shell/Win32ShellFolder2.java

-                   : "There are null icons in the MRI variants map";
+                    : "There are null icons in the MRI variants map";


Here's an extra space. The colon aligned with ! which starts the condition.

Could you please revert it too?

openjdk · 2024-01-19T17:45:06Z

@azuev-java 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:

8320692: Null icon returned for .exe without custom icon

Co-authored-by: Alexey Ivanov <aivanov@openjdk.org>
Reviewed-by: aivanov

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 118 new commits pushed to the master branch:

5acd37f: 8324207: Serial: Remove Space::set_saved_mark_word
f5e6d11: 8324210: Serial: Remove unused methods in Generation
bcb340d: 8324286: Fix backsliding on use of nullptr instead of NULL
3696765: 8323964: runtime/Thread/ThreadCountLimit.java fails intermittently on AIX
5a74c2a: 8323438: Enhance assertions for Windows sync API failures
52523d3: 8324050: Issue store-store barrier after re-materializing objects during deoptimization
df370d7: 8314329: AgeTable: add is_clear() & allocation spec, and relax assert to allow use of 0-index slot
0d8543d: 8324065: Daylight saving information for Africa/Casablanca are incorrect
c9cacfb: 8323657: Compilation of snippet results in VerifyError at runtime with --release 9 (and above)
bde650f: 8322282: Incorrect LoaderConstraintTable::add_entry after JDK-8298468
... and 108 more: https://git.openjdk.org/jdk/compare/84cf4cb350331aac147fdf4c6d130cdf5448c987...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.

mrserb · 2024-01-22T00:33:34Z

test/jdk/javax/swing/JFileChooser/FileSystemView/NoIconExeNPE.java

+
+            FileSystemView fsv = FileSystemView.getFileSystemView();
+            // No NullPointerException is expected
+            fsv.getSystemIcon(hello.toFile());


Maybe we should check that something useful is returned? at least non-null VS null value?

Maybe we should check that something useful is returned? at least non-null VS null value?

Makes sense to ensure the returned value is not null.

Test now checks for returned icon not to be null

azuev-java · 2024-01-24T22:09:58Z

/integrate

openjdk · 2024-01-24T22:10:30Z

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

32eb529: 8324553: Shenandoah: Move periodic tasks closer to their collaborators
c702dca: 8323815: Source launcher should find classes with $ in names
c432dc0: 8322149: ConcurrentHashMap smarter presizing for copy constructor and putAll
fb822e4: 8324514: ClassLoaderData::print_on should print address of class loader
00bb6bf: 8324220: jdk/jfr/event/io/TestSerializationMisdeclarationEvent.java had 22 failures
bccd823: 8324613: Serial: Rename GenerationPool to TenuredGenerationPool
8c003d8: 8321512: runtime/CommandLine/OptionsValidation/TestOptionsWithRanges.java fails on 32-bit platforms
67f29b1: 8324537: Remove superfluous _FILE_OFFSET_BITS=64
1c1cb04: 8324512: Serial: Remove Generation::Name
b65e5eb: 8324543: Remove Space::object_iterate
... and 128 more: https://git.openjdk.org/jdk/compare/84cf4cb350331aac147fdf4c6d130cdf5448c987...master

Your commit was automatically rebased without conflicts.

openjdk · 2024-01-24T22:10:36Z

@azuev-java Pushed as commit 6212264.

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

openjdk bot added the rfr Pull request is ready for review label Jan 18, 2024

openjdk bot added the client client-libs-dev@openjdk.org label Jan 18, 2024

aivanov-jdk reviewed Jan 18, 2024

View reviewed changes

Revert NPE to asserts

b9e453d

Move null check inside the loop so we do not retrieve extra icons if we encounter a null one

aivanov-jdk approved these changes Jan 19, 2024

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Jan 19, 2024

mrserb reviewed Jan 22, 2024

View reviewed changes

Fixed indentation

83998a2

Test now checks for returned icon not to be null

aivanov-jdk approved these changes Jan 23, 2024

View reviewed changes

openjdk bot added the integrated Pull request has been integrated label Jan 24, 2024

openjdk bot closed this Jan 24, 2024

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Jan 24, 2024

azuev-java deleted the JDK-8320692 branch March 14, 2024 12:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

8320692: Null icon returned for .exe without custom icon #17475

8320692: Null icon returned for .exe without custom icon #17475

azuev-java commented Jan 18, 2024 •

edited by openjdk bot

Loading

bridgekeeper bot commented Jan 18, 2024

azuev-java commented Jan 18, 2024

openjdk bot commented Jan 18, 2024

openjdk bot commented Jan 18, 2024

mlbridge bot commented Jan 18, 2024 •

edited

Loading

aivanov-jdk Jan 18, 2024

azuev-java Jan 18, 2024

aivanov-jdk Jan 19, 2024

aivanov-jdk Jan 18, 2024

azuev-java Jan 18, 2024

azuev-java commented Jan 18, 2024

openjdk bot commented Jan 18, 2024

aivanov-jdk Jan 19, 2024

azuev-java Jan 22, 2024

openjdk bot commented Jan 19, 2024 •

edited

Loading

mrserb Jan 22, 2024

aivanov-jdk Jan 22, 2024

azuev-java Jan 22, 2024

azuev-java commented Jan 24, 2024

openjdk bot commented Jan 24, 2024

openjdk bot commented Jan 24, 2024

		: "There are null icons in the MRI variants map";
		: "There are null icons in the MRI variants map";

8320692: Null icon returned for .exe without custom icon #17475

8320692: Null icon returned for .exe without custom icon #17475

Conversation

azuev-java commented Jan 18, 2024 • edited by openjdk bot Loading

Progress

Issue

Reviewers

Contributors

Reviewing

Webrev

bridgekeeper bot commented Jan 18, 2024

azuev-java commented Jan 18, 2024

openjdk bot commented Jan 18, 2024

openjdk bot commented Jan 18, 2024

mlbridge bot commented Jan 18, 2024 • edited Loading

Webrevs

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

azuev-java commented Jan 18, 2024

openjdk bot commented Jan 18, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

openjdk bot commented Jan 19, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

azuev-java commented Jan 24, 2024

openjdk bot commented Jan 24, 2024

openjdk bot commented Jan 24, 2024

azuev-java commented Jan 18, 2024 •

edited by openjdk bot

Loading

mlbridge bot commented Jan 18, 2024 •

edited

Loading

openjdk bot commented Jan 19, 2024 •

edited

Loading