Updated msi windows installers to use wix v5 #851

jmjaffe37 · 2024-04-10T17:22:25Z

In moving to wix v5, some of the code could be simplified a bit (mainly: light.exe and candle.exe commands could be combined into one). For end users to use this wix installer creation tool, they will just need to run:
dotnet tool install --global wix --version 5.0.0

To install wix 5.0.0 (or they can install another version of wix v4 or wix v5 if they so choose).

jmjaffe37 · 2024-04-10T17:23:09Z

Notes on my testing:
I ensured that both OpenJDK and Microsoft MSI installers are able to be created for all supported versions. I downloaded the resulting MSIs, installed it, checked that the java --version string was correct, and then uninstalled it (with the installer) and made sure that it was gone.

Link to successful run on my fork (although I believe that this PR will also do the same checks): https://github.com/jmjaffe37/openjdk-installer/actions/runs/8624015173

jmjaffe37 · 2024-04-10T17:43:57Z

Converted to draft due to ongoing release. Note: currently passing all PR checks

jmjaffe37 · 2024-04-10T17:50:21Z

Note: I had to change the xml propery ID ALLUSERS in Main.wxs.template to ALLUSERSSETUP to avoid a duplicate symbol error that I was getting locally. Here is a link to a run I did on github actions to recreate this error that I previously had locally:
https://github.com/jmjaffe37/openjdk-installer/actions/runs/8635538967/job/23673480230#step:7:61

jmjaffe37 · 2024-04-10T20:17:32Z

Just did a test run using wix 5.0.0 and it seems to have built properly:
https://github.com/jmjaffe37/openjdk-installer/actions/runs/8635971450

I also did an internal test run to create Microsoft OpenJDK MSIs and the resulting MSIs passed the test outlined above (install, correct java version, uninstall as expected)

jmjaffe37 · 2024-04-10T20:18:19Z

EDIT: I figured out how to test different languages. Below shows what I did:

I have confirmed that all available translations (uncommented lines in /wix/Lang/LanguageList.config) are available and work as expected. Method used to test (run on powershell):
msiexec.exe /i 'C:\<path_to_msi>\OpenJDK17-jdk_x64_windows_hotspot-17.0.10.0.7.msi' ProductLanguage="<LANGUAGE_CODE>"

This is true for MSIs created with wixV4 and wixV5

karianna · 2024-04-10T20:26:24Z

I think some useful testing will be to upgrade from older installations of Eclipse Temurin and MSFT builds of OpenJDK respectively.

karianna · 2024-04-10T20:27:19Z

Is anyone able to help me test if the installer translations into other languages/cultures is still behaving as expected? I am unsure on how to do that at the moment 😅

@douph1 - Are you able to check for French?

For the rest I recommend adding a note to the installer channel in Slack and giving folks some instructions on how to self serve this PR and test translations.

jmjaffe37 · 2024-04-10T20:34:12Z

Is anyone able to help me test if the installer translations into other languages/cultures is still behaving as expected? I am unsure on how to do that at the moment 😅

@douph1 - Are you able to check for French?

For the rest I recommend adding a note to the installer channel in Slack and giving folks some instructions on how to self serve this PR and test translations.

@karianna I actually figured out how to do it after posting that comment 😅
I updated it to instead explain how I tested it (I made that update before I saw your reply)

wix/Build.OpenJDK_generic.cmd

wix/BuildSetupTranslationTransform.cmd

jmjaffe37 · 2024-04-10T22:13:20Z

Another note: wix v5 was officially release (taken out of beta) on april 5th according to this blog post on their website:
https://www.firegiant.com/blog/2024/4/5/wix-v5.0.0-has-been-released/

Since I did my testing on both wix v4.0.5 and wix v5.0.0 (the first non-beta version), would we like me to change the default wix version to 5.0.0?

karianna · 2024-04-10T22:31:47Z

Another note: wix v5 was officially release (taken out of beta) on april 5th according to this blog post on their website: https://www.firegiant.com/blog/2024/4/5/wix-v5.0.0-has-been-released/

Since I did my testing on both wix v4.0.5 and wix v5.0.0 (the first non-beta version), would we like me to change the default wix version to 5.0.0?

Yes please

…e sybol' issue

jmjaffe37 · 2024-04-30T22:47:19Z

Note: to address a request made here: #888, I implemented a feature to allow vendors to implement custom licenses for hotspot JVMs. It also allows the vendors to choose whether or not to have the end user read and agree to this license (for example, this is optional for the GPLv2 license). Lastly, I added an explanation of this to the README.md

Successful test run with visible GPLv2 license for Eclipse Adoptium vendor: https://github.com/adoptium/installer/actions/runs/8911988475?pr=851

See the PR check for a successful test run for Eclipse Adoptium vendor MSIs without the license showing (default behavior for all vendors with the GPLv2 license unless specified)

Edit: looks like it was decided to remove this logic. The updates have3 been made to remove it properly.

… updated README.md

gdams · 2024-05-02T12:46:38Z

raised adoptium/infrastructure#3545 to install wix v5.0.0 on the CI machines

jmjaffe37 · 2024-05-02T16:13:26Z

Ok, I believe that this PR is ready to be merged now!

CC: @gdams, @karianna, @douph1

karianna

Some nitpicks

karianna · 2024-05-02T22:50:51Z

wix/Main.wxs.template

+          <RegistryValue Root="HKLM"
+            Key="SOFTWARE\JavaSoft\$(var.OracleJavasoftBaseKey)\$(var.OracleVersionKey)"
+            Name="RuntimeLib" Type="string" Value="[INSTALLDIR]$(var.DllPath)" KeyPath="no" />
+          <!-- Oracle doesn't set RuntimeLib for JDK .. because JRE is "private" JRE so no ?else? -->
        <?endif?>
        <RegistryValue Root="HKLM"


Whitespace for this doesn't match your change above?

@karianna I am unsure which section you are referring to about the whitespace mismatch. I will say, some of the whitespace tweaks were done by @gdams, but I wanted to change back the inner blocks of if-statements to be indented so the reader is more clear on which lines fall within the if-statement block

@jmjaffe37 feel free to tweak them to however you prefer

.github/workflows/wix.yml

wix/InstallerChangelog.md

wix/README.md

wix/InstallerChangelog.md

Co-authored-by: Martijn Verburg <[email protected]>

karianna · 2024-05-04T01:09:48Z

Probably worth communicating this major change to the whole community and landing all of the related PRs in sync. Then we should ask for volunteers to test various scenarios (fresh install, upgrade from previously installed version with old WIX installer, downgrade etc).

steelhead31

Tested GHA built MSI installers for JDK8, JDK11, JDK17 & JDK21 on Windows x64, all behave as expected, other than an expected oddity with upgrade behaviour, which will work normally when this PR is merged. Approving on that basis.

douph1 · 2024-06-03T08:39:02Z

Hi @jmjaffe37 great work.
I have seen you have made best effort to maintain dual capability of installer to work perUser or perMachine.

I have added perUser installer capability in #107

Some time later, Adoptium team have decided that perUser is not the way to go and won't be supported anymore:
See
https://adoptium.net/installation/windows/

The installer is designed for use on a per-machine basis, not per-user basis, so you can have only one installation of the MSI on a machine for all users.

If ALLUSERS was here it was only because cleanup was not done by the dev who disable perUser capability..

jmjaffe37 · 2024-06-03T17:41:09Z

Hi @jmjaffe37 great work. I have seen you have made best effort to maintain dual capability of installer to work perUser or perMachine.

I have added perUser installer capability in #107

Some time later, Adoptium team have decided that perUser is not the way to go and won't be supported anymore: See https://adoptium.net/installation/windows/

The installer is designed for use on a per-machine basis, not per-user basis, so you can have only one installation of the MSI on a machine for all users.

If ALLUSERS was here it was only because cleanup was not done by the dev who disable perUser capability..

Thanks for letting me know @douph1! This raises a few questions for me:

Does this mean that additional work would be necessary to support a perUser installation? From my understanding, my update takes care of the necessary prerequisites to support this.
Do we prefer to turn off the perUser option?
I noticed that the linked page states that only windows x64 is supported, but Microsoft has been using this code to generate installers for x86 and aarm64 without issue. In fact, recent updates have specifically debugged aarm64 installer creation. Is there somewhere I can propose new wording?

Thanks!

CC: @d3r3kk, @gdams, @karianna

karianna · 2024-06-03T22:57:59Z

@jmjaffe37 For that last point (docs) - you can send a PR into the adoptium.net repo.

douph1 · 2024-06-21T11:57:39Z

I think TSC don't want to support "perUser", I don't understand why, as it worked by the past. If changing we probably need a little more testing for install/upgrade/uninstall and maybe cohabitation with x64. I have no time for this.
1. I have no opinion, nor interest, but thanks for asking :)
Adoptium seems to not build x86 MSI installer after JDK 19. JDK 20/21/22 installer for x86 is missing. I don't know why but it is maybe the meaning of "Note: Windows installer packages are supported only on Windows x64 systems."
If someone has clue on this we can fix the docs of the website.

Adoptium don't build/test/publish arm64 (AArch64) MSI installer. So this is not documented on the Website, but you can add some wording on wix/README.md

jmjaffe37 marked this pull request as draft April 10, 2024 17:43

jmjaffe37 commented Apr 10, 2024

View reviewed changes

wix/Build.OpenJDK_generic.cmd Outdated Show resolved Hide resolved

jmjaffe37 commented Apr 10, 2024

View reviewed changes

wix/BuildSetupTranslationTransform.cmd Outdated Show resolved Hide resolved

jmjaffe37 changed the title ~~Updated msi windows installers to use wix v4~~ Updated msi windows installers to use wix v5 Apr 10, 2024

gdams requested a review from douph1 April 12, 2024 14:38

jmjaffe37 added 15 commits April 16, 2024 13:28

First attempt at converting wix/Build.OpenJDK_generic.cmd to .ps1 file

0dc7ad5

Updated main + base + hotspot wix xml templates

3dd44ad

Updated dragonwell + openj9 wix templates to wixv4

3fe7cbd

Updated remaining templates to wix v4

3fc05bb

Updated extensions used in wix commands

c2fce74

First attempt at converting to wixv4

af7f7ea

No attempting to use wix_heat_directory

b0d976b

Now using wix 4.0.5

93cde4d

Now placing heat.exe in Resources dir

3ba44b5

updated default heat path and error messages

f678094

Now adding wix extensions

a818e88

Now keeping all heat tools files

eed8bf1

updated default heat path, fixed error message

64c1c3b

Removed 'ALLUSERS' property from Main.wxs.template; causing 'duplicat…

f35ec13

…e sybol' issue

Changed ID ALLUSERS to ALLUSERSSETUP

3e50487

Added sample code and comment

6149aef

Added license end-user license behavior section to README.md

eb0b678

jmjaffe37 mentioned this pull request Apr 30, 2024

Generated MSIs lack end-user license agreement #888

Closed

Now using env var for vendor

ccab40c

jmjaffe37 force-pushed the jmj/wix4_update branch from d2eb32c to ccab40c Compare May 1, 2024 16:33

Took out vendor logic for end-user license agreements (as requested),…

0507767

… updated README.md

Updated wix installer changelog.md

375429d

jmjaffe37 requested review from gdams and karianna May 2, 2024 17:57

Fixed formatting

00f04bb

karianna requested changes May 2, 2024

View reviewed changes

gdams reviewed May 3, 2024

View reviewed changes

wix/InstallerChangelog.md Show resolved Hide resolved

gdams approved these changes May 3, 2024

View reviewed changes

gdams and others added 4 commits May 3, 2024 16:27

Update .github/workflows/wix.yml

1bcb898

Co-authored-by: Martijn Verburg <[email protected]>

Updated README.md minimum supported wix version

bd16b79

formatting tweak

35d0e69

Merge branch 'master' into jmj/wix4_update

6d8c0b3

karianna approved these changes May 4, 2024

View reviewed changes

Merge branch 'master' into jmj/wix4_update

9dd8b96

steelhead31 approved these changes May 9, 2024

View reviewed changes

gdams merged commit c660929 into adoptium:master May 9, 2024
9 checks passed

jmjaffe37 deleted the jmj/wix4_update branch May 9, 2024 16:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updated msi windows installers to use wix v5 #851

Updated msi windows installers to use wix v5 #851

jmjaffe37 commented Apr 10, 2024 •

edited

Loading

jmjaffe37 commented Apr 10, 2024 •

edited

Loading

jmjaffe37 commented Apr 10, 2024

jmjaffe37 commented Apr 10, 2024

jmjaffe37 commented Apr 10, 2024

jmjaffe37 commented Apr 10, 2024 •

edited

Loading

karianna commented Apr 10, 2024

karianna commented Apr 10, 2024

jmjaffe37 commented Apr 10, 2024

jmjaffe37 commented Apr 10, 2024

karianna commented Apr 10, 2024

jmjaffe37 commented Apr 30, 2024 •

edited

Loading

gdams commented May 2, 2024

jmjaffe37 commented May 2, 2024

karianna left a comment

karianna May 2, 2024

jmjaffe37 May 3, 2024

gdams May 3, 2024

karianna commented May 4, 2024

steelhead31 left a comment

douph1 commented Jun 3, 2024

jmjaffe37 commented Jun 3, 2024 •

edited

Loading

karianna commented Jun 3, 2024

douph1 commented Jun 21, 2024 •

edited

Loading

Updated msi windows installers to use wix v5 #851

Updated msi windows installers to use wix v5 #851

Conversation

jmjaffe37 commented Apr 10, 2024 • edited Loading

jmjaffe37 commented Apr 10, 2024 • edited Loading

jmjaffe37 commented Apr 10, 2024

jmjaffe37 commented Apr 10, 2024

jmjaffe37 commented Apr 10, 2024

jmjaffe37 commented Apr 10, 2024 • edited Loading

karianna commented Apr 10, 2024

karianna commented Apr 10, 2024

jmjaffe37 commented Apr 10, 2024

jmjaffe37 commented Apr 10, 2024

karianna commented Apr 10, 2024

jmjaffe37 commented Apr 30, 2024 • edited Loading

gdams commented May 2, 2024

jmjaffe37 commented May 2, 2024

karianna left a comment

Choose a reason for hiding this comment

karianna May 2, 2024

Choose a reason for hiding this comment

jmjaffe37 May 3, 2024

Choose a reason for hiding this comment

gdams May 3, 2024

Choose a reason for hiding this comment

karianna commented May 4, 2024

steelhead31 left a comment

Choose a reason for hiding this comment

douph1 commented Jun 3, 2024

jmjaffe37 commented Jun 3, 2024 • edited Loading

karianna commented Jun 3, 2024

douph1 commented Jun 21, 2024 • edited Loading

jmjaffe37 commented Apr 10, 2024 •

edited

Loading

jmjaffe37 commented Apr 10, 2024 •

edited

Loading

jmjaffe37 commented Apr 10, 2024 •

edited

Loading

jmjaffe37 commented Apr 30, 2024 •

edited

Loading

jmjaffe37 commented Jun 3, 2024 •

edited

Loading

douph1 commented Jun 21, 2024 •

edited

Loading