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

Warn on missing inverse relationships #1451

Merged
merged 1 commit into from
Apr 17, 2024

Conversation

lgebhardt
Copy link
Member

Adds method to the Relationship class to get the inverse_relationship. This supports warning once when the inverse can't be found. This is controllable with a configuration setting and is true by default.

It also adds an option to raise an exception if the inverse can't be found. This is false by default. In this default case if the inverse relationship is missing related resources will not collected or counted.

All Submissions:

  • I've checked to ensure there aren't other open Pull Requests for the same update/change.
  • I've submitted a ticket for my issue if one did not already exist.
  • My submission passes all tests. (Please run the full test suite locally to cut down on noise from travis failures.)
  • I've used Github auto-closing keywords in the commit message or the description.
  • I've added/updated tests for this change.

New Feature Submissions:

  • I've submitted an issue that describes this feature, and received the go ahead from the maintainers.
  • My submission includes new tests.
  • My submission maintains compliance with JSON:API.

Bug fixes and Changes to Core Features:

  • I've included an explanation of what the changes do and why I'd like you to include them.
  • I've provided test(s) that fails without the change.

Test Plan:

Reviewer Checklist:

  • Maintains compliance with JSON:API
  • Adequate test coverage exists to prevent regressions

@lgebhardt lgebhardt requested a review from bf4 March 20, 2024 19:20
@lgebhardt lgebhardt marked this pull request as ready for review March 20, 2024 19:21
@lgebhardt lgebhardt force-pushed the v0-11-dev-warn-on-missing-relationships branch from 867cb47 to 26f9502 Compare March 21, 2024 14:19
Copy link
Collaborator

@bf4 bf4 left a comment

Choose a reason for hiding this comment

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

I like it. I think the better naming of source relationship -> inverse relationship will drive better behavior

@lgebhardt lgebhardt merged commit 2cd1dc8 into v0-11-dev Apr 17, 2024
36 checks passed
@lgebhardt lgebhardt deleted the v0-11-dev-warn-on-missing-relationships branch April 17, 2024 14:42
lgebhardt added a commit that referenced this pull request Apr 18, 2024
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.

2 participants