Use eirslett/frontend-maven-plugin#1157 #9772

basil · 2024-09-22T22:43:10Z

Decrease the maintenance burden in this repository by replacing our custom Ant (!) based code to bootstrap Yarn Berry using Yarn 1.x with Corepack as implemented in eirslett/frontend-maven-plugin#1157.

Testing done

Introduced stylelint and eslint failures in both CI and local builds. In both cases, verified that the error message was readable: in local builds, on the CLI; and in CI builds, in the Jenkins UI.

For the local builds, tested without path modifications on my local machine with Node LTS installed as well as with path modifications inside of a Docker container with no existing Node/NPM installation, thus exercising both supported paths as documented in CONTRIBUTING.md.

Proposed changelog entries

N/A

Proposed upgrade guidelines

N/A

Submitter checklist

Give feedback

The Jira 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.
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.
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.
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, a Jira issue must exist, be a Bug or Improvement, and be labeled as lts-candidate to be considered (see query).
Options

basil · 2024-09-22T22:43:39Z

.gitignore

@@ -65,9 +65,7 @@ junit.xml

 # Yarn
 # https://yarnpkg.com/getting-started/qa#which-files-should-be-gitignored
-.pnp.*


See the comments to .yarnrc.yml below for explanation.

basil · 2024-09-22T22:44:24Z

.gitignore

 .yarn/*
-.yarnrc.yml


Previously automatically generated on the fly by our custom Ant-based logic. This Ant-based logic is now deleted, and instead this file is checked into Git. This removes a layer of indirection and makes the code simpler, since the file that is used is now static rather than dynamically generated.

basil · 2024-09-22T22:44:38Z

.gitignore

@@ -78,7 +76,4 @@ node/
 node_modules/

 # Generated JavaScript Bundles
-jsbundles


Using a more specific path to jsbundles, since there is only a single such directory.

basil · 2024-09-22T22:45:21Z

.gitignore

-# In case someone accidentally runs npm install instead of yarn install
-package-lock.json


Using NPM is not supported, and having code in the source tree to handle an unsupported configuration by silently ignoring it (rather than failing fast) violates the principle of least surprise.

basil · 2024-09-22T22:45:37Z

.prettierignore

@@ -7,8 +7,6 @@ node/

 .git

-.yarnrc.yml


No longer automatically generated, so we can adhere to Prettier formatting rules now.

basil · 2024-09-22T22:48:16Z

.yarnrc.yml

+enableGlobalCache: false
+nodeLinker: node-modules


As recommended in https://github.com/eirslett/frontend-maven-plugin/blob/4a501a10677716a0e6676b603e3b93bc6bf319f1/frontend-maven-plugin/src/it/corepack-provided-integration/.yarnrc.yml. Note that without the nodeLinker line eirslett/frontend-maven-plugin#1157 does not actually work, instead complaining about corepack not being listed in package.json. I filed for another day any latent curiosity about why this might be the case (probably a deficiency in frontend-maven-plugin documentation at the very least).

basil · 2024-09-22T22:51:11Z

CONTRIBUTING.md

@@ -53,12 +53,12 @@ MAVEN_OPTS='--add-opens java.base/java.lang=ALL-UNNAMED --add-opens java.base/ja
 ### Running the Yarn frontend build

 > [!TIP]
-> If you already have Node.js installed, you do not need to change your path. Start using `yarn` by enabling [Corepack](https://yarnpkg.com/corepack) with `corepack enable`, if it isn't already; this will add the `yarn` binary to your PATH.
+> If you already have Node.js 20.x LTS installed, you do not need to change your path. Start using Yarn by enabling [Corepack](https://yarnpkg.com/corepack) with `corepack enable`, if it isn't already; this will add the `yarn` binary to your path.


Clarifying that we only support Node.js 20.x LTS.

I changed the first occurence of "yarn" to "Yarn" because this is a reference to the Yarn project, not the yarn binary. Even though we later use "yarn binary" in the same sentence, this is not inconsistent because the first usage refers to the project and the second usage refers to the binary.

Elsewhere in the sentence we replace "PATH" with "path" for consistency with the beginning of the sentence and the rest of the document. While both "PATH" (as a particular variable name) or "path" (referring to the general concept of a search path) would be correct here, this document generally uses the latter, so be consistent with usage elsewhere in this sentence and in this document.

basil · 2024-09-22T22:51:23Z

CONTRIBUTING.md


 To run the Yarn frontend build, after [building the WAR file](#building-the-war-file), add the downloaded versions of Node and Yarn to your path:

 ```sh
-export PATH=$PWD/node:$PWD/node/yarn/dist/bin:$PATH
+export PATH=$PWD/node:$PWD/node/node_modules/corepack/shims:$PATH


Adapting to the changes in pom.xml below.

basil · 2024-09-22T22:51:46Z

war/.gitignore

@@ -1,20 +0,0 @@
-work


Unneeded now that the corresponding entries are in the root directory's .gitignore file.

basil · 2024-09-22T23:09:26Z

pom.xml

-    <!-- frontend-maven-plugin will install this Yarn version as bootstrap, then hand over control to Yarn Berry. -->
-    <yarn.version>1.22.19</yarn.version>


Yarn 1.x is now no longer needed to bootstrap Yarn Berry, since we now use Corepack for this purpose.

basil · 2024-09-22T23:09:45Z

pom.xml

-    <!-- maven-antrun-plugin will download this Yarn version. -->
-    <yarn-berry.version>4.5.0</yarn-berry.version>
-    <yarn-berry.sha256sum>cc00dce5de4f68d11450519a0f69eadf2a1cbe5cc0d8e740bfac817a31d76874</yarn-berry.sha256sum>


This duplicate information is no longer needed, as this information is consumed from package.json via Corepack.

Use eirslett/frontend-maven-plugin#1157

1366ddd

basil added the skip-changelog Should not be shown in the changelog label Sep 22, 2024

basil commented Sep 22, 2024

View reviewed changes

basil added 2 commits September 22, 2024 15:52

Test 1

cf1fb1e

Test 2

167eee1

basil commented Sep 22, 2024

View reviewed changes

basil added 2 commits September 22, 2024 16:17

Test 3

7d07e78

Testing is finished

a98a3de

basil marked this pull request as ready for review September 22, 2024 23:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use eirslett/frontend-maven-plugin#1157 #9772

Use eirslett/frontend-maven-plugin#1157 #9772

basil commented Sep 22, 2024 •

edited

Loading

Submitter checklist

Maintainer checklist

basil Sep 22, 2024

basil Sep 22, 2024

basil Sep 22, 2024

basil Sep 22, 2024

basil Sep 22, 2024

basil Sep 22, 2024

basil Sep 22, 2024

basil Sep 22, 2024

basil Sep 22, 2024

basil Sep 22, 2024

basil Sep 22, 2024

		# In case someone accidentally runs npm install instead of yarn install
		package-lock.json

		<!-- frontend-maven-plugin will install this Yarn version as bootstrap, then hand over control to Yarn Berry. -->
		<yarn.version>1.22.19</yarn.version>

		enableGlobalCache: false
		nodeLinker: node-modules

Use eirslett/frontend-maven-plugin#1157 #9772

Are you sure you want to change the base?

Use eirslett/frontend-maven-plugin#1157 #9772

Conversation

basil commented Sep 22, 2024 • edited Loading

Testing done

Proposed changelog entries

Proposed upgrade guidelines

Submitter checklist

Desired reviewers

Maintainer checklist

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

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

Choose a reason for hiding this comment

basil commented Sep 22, 2024 •

edited

Loading