Skip to content

Use maven plugin to prevent API/ABI breakage as part of build process#8904

Merged
normanmaurer merged 2 commits into4.1from
verify_api_abi
Mar 1, 2019
Merged

Use maven plugin to prevent API/ABI breakage as part of build process#8904
normanmaurer merged 2 commits into4.1from
verify_api_abi

Conversation

@normanmaurer
Copy link
Copy Markdown
Member

Motivation:

Netty is very widely used which can lead to a lot of pain when we break API / ABI. We should make use japicmp-maven-plugin during the build to verify we do not introduce breakage by mistake.

Modifications:

  • Add japicmp-maven-plugin to the build process
  • Fix a method signature change in HttpProxyHandler that was flagged as a possible problem.

Result:

Ensure no API/ABI breakage accour between releases.

Motivation:

Netty is very widely used which can lead to a lot of pain when we break API / ABI. We should make use japicmp-maven-plugin during the build to verify we do not introduce breakage by mistake.

Modifications:

- Add japicmp-maven-plugin to the build process
- Fix a method signature change in HttpProxyHandler that was flagged as a possible problem.

Result:

Ensure no API/ABI breakage accour between releases.
<groupId>${project.groupId}</groupId>
<artifactId>netty-handler</artifactId>
<version>${project.version}</version>
<optional>true</optional>
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this was incorrect as it is not really an optional dependency.


@Override
protected boolean handleResponse(ChannelHandlerContext ctx, Object response) throws HttpProxyConnectException {
protected boolean handleResponse(ChannelHandlerContext ctx, Object response) throws Exception {
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was flagged as a breakage so I fixed it. That said I think this is a false positive as HttpProxyHandler is final so there should be no problem here in reality.

Copy link
Copy Markdown
Member

@ejona86 ejona86 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a bit worrying that it doesn't understand final classes too well, but it can still be helpful.

Copy link
Copy Markdown
Member

@Scottmitch Scottmitch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @normanmaurer !

@normanmaurer
Copy link
Copy Markdown
Member Author

@ejona86 I will open an issue for it and hopefully they can fix it

@normanmaurer normanmaurer merged commit 14ef469 into 4.1 Mar 1, 2019
@normanmaurer normanmaurer deleted the verify_api_abi branch March 1, 2019 18:42
normanmaurer added a commit that referenced this pull request Mar 1, 2019
…#8904)

Motivation:

Netty is very widely used which can lead to a lot of pain when we break API / ABI. We should make use japicmp-maven-plugin during the build to verify we do not introduce breakage by mistake.

Modifications:

- Add japicmp-maven-plugin to the build process
- Fix a method signature change in HttpProxyHandler that was flagged as a possible problem.

Result:

Ensure no API/ABI breakage accour between releases.
@normanmaurer normanmaurer added this to the 4.1.34.Final milestone Mar 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants