Improve ktlint performances when the input patterns are absolute paths

[rciovati]

Description

This PR proposes a solution for the performance issue described in #1135.

When ktlint gets a bunch of absolute paths there is no need to walk through the file system and search for them, we can just resolve and analyze them directly.

Before:

➜  android-listeners git:(rc/kitlint) ktlint -F --debug --relative MyFile.kt
[DEBUG] Discovered ruleset with "standard" id.
[DEBUG] Discovered reporter with "baseline" id.
[DEBUG] Discovered reporter with "checkstyle" id.
[DEBUG] Discovered reporter with "json" id.
[DEBUG] Discovered reporter with "html" id.
[DEBUG] Discovered reporter with "plain" id.
[DEBUG] Initializing "plain" reporter with {verbose=true, color=false, color_name=DARK_GRAY}
[DEBUG] Checking MyFile.kt
Loaded .editorconfig: [insert_final_newline: true, max_line_length: 200]
[DEBUG] 30291ms / 1 file(s) / 0 error(s)

After:

➜  android-listeners git:(rc/kitlint) java -jar ktlint-0.42.0-SNAPSHOT-all.jar -F --debug --relative MyFile.kt
[DEBUG] Discovered ruleset with "standard" id.
[DEBUG] Discovered reporter with "baseline" id.
[DEBUG] Discovered reporter with "checkstyle" id.
[DEBUG] Discovered reporter with "json" id.
[DEBUG] Discovered reporter with "html" id.
[DEBUG] Discovered reporter with "plain" id.
[DEBUG] Initializing "plain" reporter with {verbose=true, color=false, color_name=DARK_GRAY}
[DEBUG] Checking MyFile.kt
Loaded .editorconfig: [insert_final_newline: true, max_line_length: 200]
[DEBUG] 847ms / 1 file(s) / 0 error(s)

In our project it speeds up the execution from ~30s down to less than 1s.

No additional tests were added, the exist ones passes.

Checklist

• tests are added
• CHANGELOG.md is updated

[rciovati]

it looks like the build fails because of a dependency verification issue which I believe is not related to my change but I'll see what I can do.

For more details see https://docs.gradle.org/6.8.3/release-notes.html

Starting a Gradle Daemon (subsequent builds will be faster)
Dependency verification is an incubating feature.
> Task :buildSrc:extractPrecompiledScriptPluginPlugins
> Task :buildSrc:generateExternalPluginSpecBuilders FAILED

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':buildSrc:generateExternalPluginSpecBuilders'.
> Dependency verification failed for configuration ':buildSrc:compileClasspath'
  2 artifacts failed verification:
    - dokka-gradle-plugin-0.10.1.jar (org.jetbrains.dokka:dokka-gradle-plugin:0.10.1) from repository MavenRepo
    - dokka-gradle-plugin-0.10.1.pom (org.jetbrains.dokka:dokka-gradle-plugin:0.10.1) from repository MavenRepo
  If the artifacts are trustworthy, you will need to update the gradle/verification-metadata.xml file by following the instructions at https://docs.gradle.org/6.8.3/userguide/dependency_verification.html#sec:troubleshooting-verification
  
  Open this report for more details: file:///home/runner/work/ktlint/ktlint/build/reports/dependency-verification/at-1620670437192/dependency-verification-report.html

* Try:
Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output. Run with --scan to get full insights.

* Get more help at https://help.gradle.org

BUILD FAILED in 49s
Error: Process completed with exit code 1.

[shashachu]

@rciovati thanks so much for this change. I just merged a PR which should fix the CI builds; can you rebase?

[rciovati]

@shashachu rebased, thanks!

[shashachu]

argh. windows build failing. 🤦‍♀️

[shashachu]

@rciovati do you have this commit rebased in? fae2362

It might be the same issue.

[rciovati]

@shashachu I've just rebased one more time!

[shashachu]

haha it's killing me! i'm not sure what's happening with the dependency verification...

[Tapchicoma]

@rciovati could you rebase again? This time verification should pass

[Tapchicoma]

@rciovati tests are failing, could you update your change, so they will pass?

[rciovati]

@Tapchicoma I'll try. I don't have a windows machine so this might take a while.

[shashachu]

@rciovati @Tapchicoma Path.resolve seems to throw an exception on Windows when you pass in file globs. This change makes the tests pass; does it seem valid or too hacky?

val (existingFiles, actualGlobs) = globs.partition {
        try {
            Files.isRegularFile(rootDir.resolve(it))
        } catch (e: InvalidPathException) {
            false
        }
    }

[rciovati]

@shashachu it looks valid to me! I've just pushed the change. Thank you so much for looking into this one 🙏

[shashachu]

@rciovati looks like you are missing an import :) e: /home/runner/work/ktlint/ktlint/ktlint/src/main/kotlin/com/pinterest/ktlint/internal/FileUtils.kt: (31, 21): Unresolved reference: InvalidPathException

[rciovati]

@shashachu of course 🤦 fixed

[shashachu]

hallelujah! thanks @rciovati for your patience!