[MJAVADOC-656] Following redirects breaks valid links

• Type: Bug
• Status: Open
• Priority: Minor
• Resolution: Unresolved
• Affects Version/s: 3.0.1, 3.2.0
• Assignee: Unassigned
• Reporter: Robert Važan
• Created: 18/Jul/20 14:00
• Updated: 13/Jun/24 17:55

Description

Version 3.0.1 fixed #427 by following redirects. This feature unfortunately breaks when HTTP server is configured as follows:

/apidocs/package-list -> 200
/apidocs -> 301 /apidocs/com/example/package-summary.html
/apidocs/ -> 301 /apidocs/com/example/package-summary.html
/apidocs/com/example/package-summary.html -> 200

Without following redirects (in version 3.0.0), the link is passed to javadoc tool unchanged, the javadoc tool fetches /apidocs/package-list, and everything works fine. Since 3.0.1, javadoc plugin follows one of the redirects (/apidocs or /apidocs/), passes the package summary URL to javadoc tool, which then fails like this:

[WARNING] javadoc: warning - Error fetching URL: https://example.com/apidocs/com/example/package-summary.html/

And if you have failOnWarnings set to true, this will fail the whole build.

The solution is fairly simple. Construct the whole URL (.../package-list) and follow redirects on that one. Then check whether the final destination ends in /package-list, strip the /package-list suffix, and pass the result to the javadoc tool.

Issue Links

• requires: MJAVADOC-796 Do not follow links for Java 12+
• links to: Fixed in JDK-8190312
• links to: Logic in JDK