Thanks to visit codestin.com
Credit goes to github.com

Skip to content

fix: handle empty or incomplete conferencing objects in events #432

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Aug 18, 2025
Merged

fix: handle empty or incomplete conferencing objects in events #432

merged 2 commits into from
Aug 18, 2025

Conversation

AaronDDM
Copy link
Contributor

What did you do?

  • Fixed KeyError when processing events with empty conferencing objects ({})
  • Fixed KeyError when conferencing details missing required provider field
  • Fixed KeyError when conferencing autocreate missing required provider field
  • Added comprehensive backwards compatibility tests for edge cases
  • Maintains existing behavior for valid conferencing objects
  • Returns None for malformed conferencing data instead of raising errors

Resolves issue where SDK version 6.11.0 would throw KeyError when processing events containing empty or incomplete conferencing objects.

License

I confirm that this contribution is made under the terms of the MIT license and that I have the authority necessary to make this contribution on behalf of its copyright owner.

@AaronDDM
fix: handle empty or incomplete conferencing objects in events
b53f598 
- Fixed KeyError when processing events with empty conferencing objects ({})
- Fixed KeyError when conferencing details missing required provider field
- Fixed KeyError when conferencing autocreate missing required provider field
- Added comprehensive backwards compatibility tests for edge cases
- Maintains existing behavior for valid conferencing objects
- Returns None for malformed conferencing data instead of raising errors

Resolves issue where SDK version 6.11.0 would throw KeyError when
processing events containing empty or incomplete conferencing objects.
@AaronDDM AaronDDM requested a review from ajay-k August 18, 2025 13:22
@AaronDDM AaronDDM requested a review from samLRodrigues August 18, 2025 13:23
@playerzero-ai PlayerZero AI
Copy link

playerzero-ai bot commented Aug 18, 2025 •
edited
Loading

Pull Request Summary

  • Event Deserialization Tests:

    • Added new tests to handle various scenarios with conferencing objects in events.
    • Ensures that events with empty, incomplete, or unknown conferencing data set the conferencing attribute to None.
    • Aims to improve robustness and consistency in handling conferencing data during event deserialization.

  • Conferencing Object Handling:

    • Updated the _decode_conferencing function in nylas/models/events.py.
    • Improved checks for "details" and "provider" keys to ensure valid conferencing objects.
    • Enhanced logic to return None for unknown or incomplete conferencing data, maintaining backward compatibility.
    • Added comments for better understanding of the logic, improving code clarity and reliability in processing conferencing data.

Functional Tests

  • Verify that events with an empty conferencing object set the conferencing attribute to None.
  • Test events with incomplete conferencing details (missing provider) to ensure the conferencing attribute is set to None.
  • Check that events with incomplete conferencing autocreate (missing provider) result in the conferencing attribute being None.
  • Ensure events with unknown conferencing fields have their conferencing attribute set to None.
  • Confirm that the decode_conferencing function returns None for conferencing objects missing required fields like 'provider'.
  • Test the system's overall behavior with malformed or incomplete conferencing data to ensure no errors occur during event processing.

Files Changed

File Name Summary
tests/resources/test_events.py Added tests for event deserialization covering various conferencing scenarios, including empty, incomplete, and unknown conferencing data, ensuring the conferencing attribute is set to None when appropriate.
nylas/models/events.py Renamed and updated _decode_conferencing to validate presence of "details" and "provider" keys, returning None for incomplete or unknown conferencing data to improve robustness and maintain compatibility.

View more in PlayerZero
updated: Aug 18 @ 01:29 PM UTC

@AaronDDM
style: fix pylint issues in _decode_conferencing function
0f866a3 
- Remove unnecessary else statements after return (no-else-return)
- Remove trailing whitespace (trailing-whitespace)
- Reduce number of return statements to comply with complexity limits (too-many-return-statements)
- Consolidate conditional logic for better readability
- Maintain identical functionality and test coverage
samLRodrigues
samLRodrigues approved these changes Aug 18, 2025
View reviewed changes
Copy link

@samLRodrigues samLRodrigues left a comment

Choose a reason for hiding this comment

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

LGTM

@AaronDDM AaronDDM merged commit bc8b773 into main Aug 18, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@samLRodrigues samLRodrigues samLRodrigues approved these changes

@ajay-k ajay-k Awaiting requested review from ajay-k

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@AaronDDM @samLRodrigues