1896020 - `apilint` broken on Windows builds due to internal javadoc `sourcepath` with multiple paths and incorrect path separator

Status: NEW

(Fenix :: General, defect)

Description

[Zac McKenney [:zmckenney]]

Fenix -sourcepath is always using : for create_javadoc which causes it to break on Windows (which should use ;).

Additional Docs:

https://gitlab.kitware.com/cmake/cmake/-/merge_requests/3967
https://stackoverflow.com/questions/3692567/unable-to-use-javadoc-sourcepath-with-multiple-paths

Comment 1

[Nick Alexander :nalexander [he/him]]

It's actually the gradle-apilint internal configuration of the Javadoc task. The issue is at https://github.com/mozilla-mobile/gradle-apilint/blob/8b24554912917526c5899ecc58948d6819fcf7b9/apilint/src/main/groovy/org/mozilla/apilint/ApiCompatLintTask.groovy#L53 -- that needs to use File.pathSeparator or not specify, which is equivalent.

Comment 2

[BugBot [:suhaib / :marco/ :calixte]]

The severity field is not set for this bug.
:boek, could you have a look please?

For more information, please visit BugBot documentation.

Comment 3

[Makoto Kato [:m_kato]]

Attachment: GitHub Pull Request

Comment 4

[Makoto Kato [:m_kato]]

Also, we have to change text format of api.txt.map since ":" is drive separator on Windows, or use better regex in apilint.py.

Comment 5

[Makoto Kato [:m_kato]]

Attachment: Improve parsing map text for Windows

Comment 6

[Makoto Kato [:m_kato]]

We have to make a request to upload apidoc-plugin into maven.mozilla.org, like bug 1727585.

> Task :geckoview:apiGenerateWithGeckoBinariesDebug FAILED

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':geckoview:apiGenerateWithGeckoBinariesDebug'.
> Could not resolve all files for configuration ':geckoview:apidoc-plugin'.
   > Could not find org.mozilla.apilint:apidoc-plugin:0.5.3.
     Searched in the following locations:
       - https://maven.mozilla.org/maven2/org/mozilla/apilint/apidoc-plugin/0.5.3/apidoc-plugin-0.5.3.pom
       - https://maven.google.com/org/mozilla/apilint/apidoc-plugin/0.5.3/apidoc-plugin-0.5.3.pom
       - https://repo.maven.apache.org/maven2/org/mozilla/apilint/apidoc-plugin/0.5.3/apidoc-plugin-0.5.3.pom
       - https://plugins.gradle.org/m2/org/mozilla/apilint/apidoc-plugin/0.5.3/apidoc-plugin-0.5.3.pom
     Required by:
         project :geckoview

* 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.