When using build.gradle.kts, extra gradle daemons might be expected. In this case we should display a message on how to disable the check.

Hello,

Trying out your tool (v0.6.2) in Android Studio 4.0, on Windows with the following javaHome config block:

 javaHome {
        ensureJavaHomeMatches = true
        ensureJavaHomeIsSet = true
        failOnError.set(false)
     }

And with JAVA_HOME not matching the build JDK on purpose, I get the following message:

If I set the failOnError flag to true, I then get a proper message that looks like this:

Hello, I got this while running a Gradle sync:

=============================== Gradle Doctor Prescriptions ============================================
| Detected a slow download speed downloading from External Repos.                                      |
| 1.29 MB downloaded in 3.99 s                                                                         |
| Total speed from External Repos = 0.33 MB/s                                                          |
========================================================================================================

Indeed, its slow for my fiber connection and closeby Wi-Fi, but I don't know which url was slow.
Is there a way that this plugin could report the affected urls to allow for analysis?

Build output

=============================== Gradle Doctor Prescriptions ============================================
| This build spent 24% garbage collecting.                                                             |
| If this is the first build with this Daemon, it likely means that this build needs more heap space.  |
| Otherwise, if this is happening after several builds it could indicate a memory leak.                |
| For a quick fix, restart this Gradle daemon. ./gradlew --stop                                        |
========================================================================================================

The phrase Otherwise, if this is happening after several builds it could indicate a memory leak. got me curious and I tried to learn about it, but I couldn't find anything about it on a google search.

It would be cool if you could give us some tips or link something about it.

Clicking on the top-left icon in https://runningcode.github.io/gradle-doctor/ brings you to https://runningcode.github.io/fladle/

Looks like a copy-paste error.

It seems that the problem is here: https://github.com/runningcode/gradle-doctor/blob/master/mkdocs.yml#L11

So I use sdkman to manage my sdk versions.

When I try to use this plugin I get:
| JAVA_HOME is /Users/e/.sdkman/candidates/java/current
| Gradle is using /Users/e/.sdkman/candidates/java/8.0.242.hs-adpt

JAVA_HOME is actually a symlink that points to the folder which is printed as used by Gradle.

[ ] Don't alert for build cache connection if we've downloaded less than 1MB.
[ ] Don't warn for garbage collection if build is less than 10 seconds.

See if there is a way to detect and report on non-incremental annotation processors that were used as part of the build. Both javac and kapt.

Log example:

[WARN] Incremental annotation processing requested, but support is disabled because the following processors are not incremental: androidx.lifecycle.LifecycleProcessor (NON_INCREMENTAL), androidx.room.RoomProcessor (NON_INCREMENTAL).

We only know the total duration for annotation processor timings so we can't subtract overlapping time intervals like we did for remote cache connection times in #63 . If we knew the start, end times we could subtract out overlapping time intervals to get a better estimate.

We could also use the time printed to the console as the end time for kapt and calculate based on that.

All I did is add this , and then trying to build:

    id "com.osacky.doctor" version "0.7.0"

This is what I get, and it thinks I should fix it using Linux/Unix commands:

A problem occurred configuring root project 'My Application'.
> =============================== Gradle Doctor Prescriptions ============================================
  | JAVA_HOME is not set.
                                                                               |
  | Please set JAVA_HOME so that switching between Android Studio and the terminal does not trigger a fu |
  | ll rebuild.
                                                                                         |
  | To set JAVA_HOME: (using bash)
                                                                      |
  | echo "export JAVA_HOME=$(/usr/libexec/java_home)" >> ~/.bash_profile
                                |
  | or `~/.zshrc` if using zsh.
                                                                         |
  |                                                                                                      |
  ========================================================================================================

My Application.zip

Reproducer

https://github.com/CristianGM/DoctorKotlinWrapperKtIssueReproducer

Context

I want to apply the doctor plugin on all the company projects.
We have internally a setings plugins (for artifactory and gradle enterprise configuration) and a project plugin (for static analysis and conventions)

I tried to apply the doctor using the project plugin but it fails because... it checks it's applied on the root and precompiled scripts generation use a "sample" project that doens't apply it into the root projects...

Then I thought we could use the settings plugin. It works unless a subproject is using kapt.

Issue

When a subproject use kapt and the doctor plugin is applied through settings.gradle.kts the build fails with:

java.lang.ClassNotFoundException: org.jetbrains.kotlin.gradle.plugin.KotlinPluginWrapperKt
at com.osacky.doctor.DoctorPlugin$apply$2$3.invoke(DoctorPlugin.kt:93)

You can see the scan: https://scans.gradle.com/s/i6w5wqolnkiu2
And the line from the doctor that produces the error: https://github.com/runningcode/gradle-doctor/blob/master/doctor-plugin/src/main/java/com/osacky/doctor/DoctorPlugin.kt#L93

https://docs.gradle.org/release-nightly/userguide/configuration_cache.html

I started to use Gradle Doctor, thanks for working on this. I have feedback about testCaching.

Gradle Doctor disables this by default which is against the default behavior suggested by Gradle. For us this is really good feature since it speeds up test execution and feedback time. We're ok since we don't use time or any non-deterministic value in tests.

I'm actually ok since I can just enable it. I just wanted to give feedback from our perspective.

I am experiencing this issue with AS with Gradle Doctor enabled, where I get the JAVA_HOME is not set. error when running gradle-doctor during project configuration.

The root cause seems to be Android Studio keeping a wrong value for JAVA_HOME, and I reported that here:
https://issuetracker.google.com/issues/162313337

Since Gradle Doctor's error persists after manually selecting the same path as JAVA_HOME from File -> Project Structure -> SDK Location -> JDK location in Android Studio, which should ensure that the same JDK is used for AS and terminal, I thought there might be some issue with Gradle Doctor as well, or that at least you might have some additional insight on this.

It is probably time-consuming and not worse the effort.

How about checking some redundant AGP, kotlin and maybe major annotation processor properties.

As an example - kotlin kapt is incremental now by default so having kapt.incremental.apt=true is not needed now.

Hi Thank you for this plugins, it works like a charm.

I have a question about "Disable assembling all apps in repository simultaneously"

Our project has a legit reason to do the ./gradlew assembleRelease which is how our CI/CD works.

But the gradle-doctor complains this and stop the building, can I have a flag or something to ignore this checking for our building flow.

Thanks

Logs look like this:

[WARN] Incremental annotation processing requested, but support is disabled because the following processors are not incremental: androidx.lifecycle.LifecycleProcessor (NON_INCREMENTAL), androidx.room.RoomProcessor (NON_INCREMENTAL).

Print negative time savings as a warning at the end of the build if detected.

Inspired by gradle/gradle#13908

• Get permission
• Update plugin

This adds configuration time as well as increases build time on ephemeral agents since the jetifier transform is not cacheable.

Hello Nelson,
I have seen you talked about your project at an Android meetup in Berlin but it's the first time I take a deeper look.

There is a feature I could contribute to gradle-doctor (because I already did it here Splitties/refreshVersions#234 ) is to warn that a newer version of Gradle is available and remind people how to upgrade

You are currently running Gradle 6.1.0. 
To update to the current stable versions, run
    $ ./gradlew wrapper --gradle-version 6.6.1

Of course we could disable the warning as here
https://runningcode.github.io/gradle-doctor/configuration/

Is that something you are interested in?

https://github.com/runningcode/gradle-doctor/blob/master/doctor-plugin/src/main/java/com/osacky/doctor/internal/DaemonCheck.kt

DaemonCheck class has /bin/bash usage and it fails to run on windows if disallowMultipleDaemons is true.

Add a mechanism for it to measure it's own impact on the build time.

If a project has a source directory like: foo/bar/baz where baz is empty, bar contains only baz and nothing else, and foo contains only bar and nothing else (i.e. they are also empty aside from the empty folder they contain), this will be flagged as an empty source directory, and the suggested solution is removing foo/bar/baz. However, this only removes baz, and the next run will flag foo/bar as an empty directory and prompt you to remove bar, and so on. This means it takes a few runs to clear out all of these folders if you go purely by the doctor's orders. It would be great if the plugin could recognize the entire tree as being empty and prompt you to remove the "root" empty directory (and subfolders) in the first pass.

I think your formula to calculate *MBSavings is incorrect, here in this code snippet:

val oneMBTime = cacheSizeMB
val twoMBTime = cacheSizeMB / 2f
val tenMBTime = cacheSizeMB / 10f

val oneMBSavings = executionTimeSec - oneMBTime
val twoMBSavings = executionTimeSec - twoMBTime
val tenMBSavings = executionTimeSec - tenMBTime

You had subtracted oneMBTime(in MB) from executionTime(in sec), which isn't mathematically valid because you had subtracted different quantities, Hence we get incorrect results

I saw this in your talk, but I'm still confused about what this actually is. I'm having gradle speed issues and I'm curious if this is what that's for.

It seems that tests will succeed even if the messages we expect to be in the failure messages aren't there.

Currently, there's a Groovy only snippet, would be great to have the setup be straightforward to Kotlin DSL users.

Also, can't the plugins DSL be used? If it can, I can submit a PR for the doc edit.

Not sure if it'd be possible, but would be cool to add.

Example: click here

We'd like to add gradle-doctor to our repo, but developers can opt-in. And when I try to move the configuration to an external script, it breaks gradle-doctor, due to this line not able to find KotlinPluginWrapper.

Is there another way to show processing time of kapt, or is there another way to apply plugin from external script?

I think after the latest fix with the symlink you introduced also performance issue - the file operations are checked during the gradle configuration that is not recommended behaviour.

How about moving all checks to the execution phase?

The feature failOnEmptyDirectories causes a memory leak each time the build is run.

Disable by default or fix the memory leak.

I've found the next ones not specific enough:

1. Doesn't say about Windows OS how to set JAVA_HOME (can be done via command line too, but would be nice to have both UI-based and command-line instructions), even though it's running on it:

A problem occurred configuring root project 'My Application'.
> =============================== Gradle Doctor Prescriptions ============================================
  | JAVA_HOME is not set.
                                                                               |
  | Please set JAVA_HOME so that switching between Android Studio and the terminal does not trigger a fu |
  | ll rebuild.
                                                                                         |
  | To set JAVA_HOME: (using bash)
                                                                      |
  | echo "export JAVA_HOME=$(/usr/libexec/java_home)" >> ~/.bash_profile
                                |
  | or `~/.zshrc` if using zsh.
                                                                         |
  |                                                                                                      |
  ========================================================================================================

2. It doesn't say in which file to add "UseParallelGC" :

A problem occurred configuring root project 'My Application'.
> =============================== Gradle Doctor Prescriptions ============================================
  | For faster builds, use the parallel GC.                                                              |
  | Add -XX:+UseParallelGC to the org.gradle.jvmargs                                                     |
  ========================================================================================================

3. Doesn't say where to add "doctor" exactly:

=============================== Gradle Doctor Prescriptions ============================================
| Jetifier was enabled which means your builds are slower by 4-20%.                                    |
| Here's an article to help you disable it:                                                            |
| https://adambennett.dev/2020/08/disabling-jetifier/                                                  |
|                                                                                                      |
| To disable this warning, configure the Gradle Doctor extension:                                      |
| doctor {                                                                                             |
|   warnWhenJetifierEnable.set(false)                                                                  |
| }                                                                                                    |
========================================================================================================

We are simply taking the total amount of time spent downloading divided by the total amount downloaded.
This could mean that the total amount of time spent downloading is greater than the actual build time since multiple downloads can happen in parallel.

It would be useful if we could make these warnings instead of errors in the build, as it will take some teams time to roll it out properly

This is great to know multiple daemons are run.

But often I have some incompatible runners - AS is still finishing something I want to run extra task from the console, I work on gradle upgrade, etc.

It would be great to have possibility to turn it from error to warning.

I upgraded to the latest version of gradle doctor and was met with a new error:

Add -XX:+UseParallelGC to the org.gradle.jvmargs

This is what I currently have

org.gradle.jvmargs=-Xmx2048M -XX\:MaxPermSize\=4g -XX\:+HeapDumpOnOutOfMemoryError -Dfile.encoding\=UTF-8

I changed it to

org.gradle.jvmargs=-Xmx2048M -XX\:MaxPermSize\=4g -XX\:+HeapDumpOnOutOfMemoryError -Dfile.encoding\=UTF-8 -XX:+UseParallelGC

and it still doesn't work. I am a gradle noob, but this seems like the right spot? This is in the my root gradle.properties file.

Things I tried:

1. I thought maybe since a gradle damon is running these changes wouldn't be picked up so I stopped all gradle daemons and ran it again
2. I tried to edit something else in this file (android.enableJetifier) and set it to false, and my build failed... so this gradle.properties file is being picked up in general.
3. I tried to print out the args that started the jvm and got this

 /Library/Java/JavaVirtualMachines/adoptopenjdk-14.jdk/Contents/Home/bin/java --add-opens java.base/java.util=ALL-UNNAMED --add-opens java.base/java.lang=ALL-UNNAMED --add-opens java.base/java.lang.invoke=ALL-UNNAMED --add-opens java.prefs/java.util.prefs=ALL-UNNAMED -Xmx8192m -Dfile.encoding=UTF-8 -Duser.country=US -Duser.language=en -Duser.variant -cp /Users/coltonidle/.gradle/wrapper/dists/gradle-6.7-bin/efvqh8uyq79v2n7rcncuhu9sv/gradle-6.7/lib/gradle-launcher-6.7.jar org.gradle.launcher.daemon.bootstrap.GradleDaemon 6.7

But that doesn't seem right because it reports Xmx as 8192 and I have it set to 2048. So I don't know what is printing out about the instance of java running. Also, I could have sworn I was using jdk 11 not 14. Switching to 11 didn't help things.

Hope to help any way I can.

https://github.com/JakeWharton/picnic

It is faster
-XX:+UseParallelGC

There are use cases where building all projects might make sense for example on CI or multiplatform projects.
We should add the ability to whitelist tasks or disable the warning.

The gradle doctor finds empty directories in source directories, but if the root directory is empty, it does not warn you. Let's add a task which removes all empty source directories.
Related to: gradle/gradle#2463