Skip to content

GHPerson#getType() should call populate() only if type is null #2015

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

Merged
merged 3 commits into from
Feb 25, 2025

Conversation

anujhydrabadi
Copy link
Contributor

@anujhydrabadi anujhydrabadi commented Jan 21, 2025

Description

While calling the app or app installations endpoints, type is returned in the response from GitHub for users and organizations. Do not call populate() if type is already set. Perhaps we can fix this at the design level to prevent these kinds of bugs (caused because we do not know what fields have been populated already) from occurring altogether, but making a quick fix for this in the meantime.
Fixes #1816

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

Copy link

codecov bot commented Jan 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.57%. Comparing base (e14ec3b) to head (7201986).
Report is 6 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff              @@
##               main    #2015      +/-   ##
============================================
- Coverage     83.61%   83.57%   -0.04%     
+ Complexity     2381     2380       -1     
============================================
  Files           235      235              
  Lines          7258     7259       +1     
  Branches        382      382              
============================================
- Hits           6069     6067       -2     
- Misses          955      956       +1     
- Partials        234      236       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@anujhydrabadi
Copy link
Contributor Author

Please review. The codecov check is failing as it expects me to test the following code block too, which I feel will not be required. Please let me know if I need to add anything here.

if (isOffline()) {
            return; // cannot populate, will have to live with what we have
        }

Thanks!

@bitwiseman
Copy link
Member

That code coverage hole is odd, but obviously not due to this change.

@bitwiseman bitwiseman merged commit 5d3344a into hub4j:main Feb 25, 2025
11 of 12 checks passed
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.

401 when trying to extract GHUser#type
2 participants