Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove checked exceptions from most external APIs #1969

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

bitwiseman
Copy link
Member

Description

Before submitting a PR:

  • Changes must not break binary backwards compatibility. If you are unclear on how to make the change you think is needed while maintaining backward compatibility, CONTRIBUTING.md for details.
  • Add JavaDocs and other comments explaining the behavior.
  • When adding or updating methods that fetch entities, add @link JavaDoc entries to the relevant documentation on https://docs.github.com/en/rest .
  • Add tests that cover any added or changed code. This generally requires capturing snapshot test data. See CONTRIBUTING.md for details.
  • Run mvn -D enable-ci clean install site locally. If this command doesn't succeed, your change will not pass CI.
  • Push your changes to a branch other than main. You will create your PR from that branch.

When creating a PR:

  • Fill in the "Description" above with clear summary of the changes. This includes:
    • If this PR fixes one or more issues, include "Fixes #" lines for each issue.
    • Provide links to relevant documentation on https://docs.github.com/en/rest where possible. If not including links, explain why not.
  • All lines of new code should be covered by tests as reported by code coverage. Any lines that are not covered must have PR comments explaining why they cannot be covered. For example, "Reaching this particular exception is hard and is not a particular common scenario."
  • Enable "Allow edits from maintainers".

Comment on lines +1612 to +1613
} catch (UncheckedIOException ex) {
assertThat(ex.getCause(), instanceOf(FileNotFoundException.class));
Copy link
Member Author

@bitwiseman bitwiseman Oct 3, 2024

Choose a reason for hiding this comment

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

This going to be a massive issue.

Consumers of this library that expect to be able to detect missing items by catching FileNotFoundException will have to catch UncheckedIOException and then check the type of e.getCause(). That's not so bad per se, but it is a significant change in behavior.

We could handled this by replacing the generic UncheckedIOException with an UncheckedFileNotFoundException, but it would still be a significant change not something that could be used by existing consumers without updates.

Copy link
Contributor

Choose a reason for hiding this comment

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

Is it just one more thing people must consider and adjust when switching from 1.x to 2.x? As a maintainer, I would put a bold notice about all these things in a changelog.

@bitwiseman bitwiseman marked this pull request as draft October 4, 2024 08:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants