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.

Sign up for GitHub

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

Jump to bottom

Remove --mutex network argument for Yarn builds #625

Merged
merged 11 commits into from
Nov 7, 2022
Merged

Remove --mutex network argument for Yarn builds #625

Changes from 4 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
8866e7b
[yarn2] add profile for yarn 2 which do not support the mutex argunme…
scherler Oct 28, 2022
7556d86
[yarn2] remove the target but set a default argument that can be over…
scherler Oct 31, 2022
b7b5e4e
[yarn2] fix formating
scherler Nov 2, 2022
b73c8ac
Merge branch 'master' into yarn2
scherler Nov 2, 2022
8afa526
Update pom.xml
scherler Nov 3, 2022
e076190
Update pom.xml
scherler Nov 4, 2022
a630140
[yarn2] Adopt PR feedback
scherler Nov 4, 2022
50f36bc
[yarn2] vscode should not have been committed
scherler Nov 4, 2022
738c258
[yarn2] remove legacy comment
scherler Nov 4, 2022
5e9ca32
Update pom.xml
scherler Nov 4, 2022
612216a
[yarn2] remove config section since it not needed
scherler Nov 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,10 @@
<node.version>you-must-override-the-node.version-property</node.version>
<npm.version>you-must-override-the-npm.version-property</npm.version>
<yarn.version>you-must-override-the-yarn.version-property</yarn.version>
<!-- can be set to the empty string or install for yarn2 -->
<!-- ensure only one concurrent 'yarn install' -->
<!-- when yarn cache is empty, multiple yarns performing network fetches frequently results in opaque errors -->
<yarn.args>---mutex network</yarn.args>
Copy link
Member

Choose a reason for hiding this comment

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

given we now require you to specify the yarn version (the previous release) I think we should just remove the property and the use of it on line 1333.

Then we document that users of yarn1 will need to add a property frontend.yarn.arguments to ---mutex network

@basil removed the node/yarn properties so I think this may well be better suited.
if not and we want to keep the default the property needs to be changed to <frontend.yarn.arguments>---mutex network</frontend.yarn.arguments> <!-- extra arguments needed for yarn --> to match the property of the plugin to make the understanding and override of it easier.

Suggested change
<yarn.args>---mutex network</yarn.args>
<frontend.yarn.arguments>---mutex network</frontend.yarn.arguments> <!-- extra arguments needed for yarn, --mutex network is needed for yarn1, yarn2+ do not need this flag -->

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yarnpkg/yarn#2146 (comment) you can as well create a .yarnrc and add --install.mutex network in case you want it.

scherler marked this conversation as resolved.
Show resolved Hide resolved
<frontend-version>1.12.1</frontend-version>
<nodeDownloadRoot>https://repo.jenkins-ci.org/nodejs-dist/</nodeDownloadRoot>
<npmDownloadRoot>https://repo.jenkins-ci.org/npm-dist/</npmDownloadRoot>
Expand Down Expand Up @@ -1326,9 +1330,7 @@
</goals>
<phase>initialize</phase>
<configuration>
<!-- ensure only one concurrent 'yarn install' -->
<!-- when yarn cache is empty, multiple yarns performing network fetches frequently results in opaque errors -->
<arguments>--mutex network</arguments>
<arguments>${yarn.args}</arguments>
jtnord marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

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

frontend-maven-plugin already uses the value of the frontend.yarn.arguments property, if defined, so for consistency I suggest using that same property name rather than yarn.args. That would allow you to delete this <arguments> line (and therefore its parent <configuration>).

Copy link
Member

Choose a reason for hiding this comment

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

(see https://github.com/eirslett/frontend-maven-plugin/blob/ec9f8050bc4c4014bbeb1ea84ae92e11682d9764/frontend-maven-plugin/src/main/java/com/github/eirslett/maven/plugins/frontend/mojo/YarnMojo.java#L26)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok @basil , the only thing is that we do

 <properties>
    <yarn.version>1.22.19</yarn.version>
  </properties>

So you are suggesting that would now become

 <properties>
    <yarn.version>1.22.19</yarn.version>
    <frontend.yarn.arguments>1.22.19</frontend.yarn.arguments>
  </properties>

I am fine with it, but personally would find it more readable, if we would drop the frontend prefix since it just forces us to remember it. Better like:

 <properties>
    <yarn.version>1.22.19</yarn.version>
    <yarn.arguments>1.22.19</yarn.arguments>
  </properties>

wdyt?

Copy link
Member

Choose a reason for hiding this comment

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

should be clearer now my previously unpublished comments are published, the question remains is what (if anything) should the default be (keep the default as yarn1 or remove it and make users specify it if they use yarn1)

</configuration>
</execution>

Expand Down