You are viewing a plain text version of this content. The canonical link for it is here.

Posted to commits@cordova.apache.org by GitBox <gi...@apache.org> on 2020/04/11 02:33:11 UTC

[GitHub] [cordova-android] breautek opened a new pull request #948: Feature: JVM Args flag

breautek opened a new pull request #948: Feature: JVM Args flag
URL: https://github.com/apache/cordova-android/pull/948

<!--
Please make sure the checklist boxes are all checked before submitting the PR. The checklist is intended as a quick reference, for complete details please see our Contributor Guidelines:

http://cordova.apache.org/contribute/contribute_guidelines.html

Thanks!
-->

### Platforms affected
Android

### Motivation and Context


Provides a `--jvmargs` flag to pass through JVM args to gradle. This is mostly useful for changing the `-Xmx` flag, allowing the JVM to use more memory on larger projects.

There was no feature request made, but it does closes https://github.com/apache/cordova-android/pull/945 ; a PR that changes the default memory size to 4096m.

I believe this is a better alternative as I believe it is better to keep the `-Xmx` as low as possible and for most users, our default value of 2048m is probably fine, but allows the flexibility for users to change the value based on their own unique needs. Additionally, this accepts any [JVM args](https://docs.gradle.org/current/userguide/build_environment.html#sec:configuring_jvm_memory), so not necessary limited to `-Xmx` flag.

The flag works on `prepare`, `build`, and `run` cordova commands. Example is given below:

`cordova prepare android -- --jvmargs='-Xmx4g'`

Do note the double set of dashes. Value memory size units are `k`, `m`, and `g` and is case-insensitive. This matches what JVM supports.

### Description

This PR looks at the option vargs in `prepare` and sets the appropriate key for `GradlePropertiesParser` for jvm args.

Some changes were made to the `Api` class, which was required to get unit tests configured properly. (The entire `prepare` function was not unit tested at all). Unit tests changes are made in a separate commit.

Lastly, there is an informational log that was printed to the console if the user changes the `-Xmx` option to something other than the cordova default. I've changed this to only produce that log if the numerical size value is smaller than the cordova default. Code was added to parse the byte value for comparison. Unit tests were also added. This particular part is made in a separate commit from the jvmargs flag implementation.

This PR should be accompanied by a `cordova-docs` PR (which is currently not done)

### Testing

`npm test` was ran with all existing and new tests passing.
I have also manually tested these changes in a dummy project, ensuring that the `gradle.properties` file produced expected results both with and without the flag.

### Checklist

- [x] I've run the tests to see all new and existing tests pass
- [x] I added automated test coverage as appropriate for this change
- [x] Commit is prefixed with `(platform)` if this change only applies to one platform (e.g. `(android)`)
- [x] If this Pull Request resolves an issue, I linked to the issue in the text above (and used the correct [keyword to close issues using keywords](https://help.github.com/articles/closing-issues-using-keywords/))
- [] I've updated the documentation if necessary

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

With regards,
Apache Git Services

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org