fix(idempotency): add support for Optional type when serializing output

[leandrodamascena]

Issue number: #5589

Summary

Changes

This Pull Request addresses an issue with the PydanticSerializer when used in conjunction with the idempotent_function decorator. Currently, the serializer does not support optional return types (Optional[T] or T | None), leading to errors when functions are designed to return None.

Example

@idempotent_function(
    data_keyword_argument="order",
    config=config,
    persistence_store=dynamodb,
    output_serializer=PydanticSerializer(model=OrderOutput),
)
def process_order(order: Order) -> OrderOutput | None:
    if order:
        return OrderOutput(order_id=order.order_id)
    return None

Changes made to fix

• Type Handling: Modify the type-checking logic in the PydanticSerializer to recognize and accept optional return types.
• Error Messaging: Implement clear error messages that guide users on supported return types if an invalid type is encountered.
• Documentation: Updates the documentation to include information about optional return types.

User experience

Customers can now use None as return type.

Checklist

If your change doesn't seem to apply, please leave them unchecked.

• Meet tenets criteria
• I have performed a self-review of this change
• Changes have been tested
• Changes are documented
• PR title follows conventional commit semantics

Is this a breaking change?

RFC issue number:

Checklist:

• Migration process documented
• Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[codecov]

Codecov Report

Attention: Patch coverage is 90.47619% with 2 lines in your changes missing coverage. Please review.

Project coverage is 96.17%. Comparing base (9a961ec) to head (69adad9).
Report is 2 commits behind head on develop.

Files with missing lines	Patch %	Lines
...s/utilities/idempotency/serialization/functions.py	88.23%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #5590      +/-   ##
===========================================
- Coverage    96.18%   96.17%   -0.02%     
===========================================
  Files          231      232       +1     
  Lines        10919    10940      +21     
  Branches      2019     2023       +4     
===========================================
+ Hits         10502    10521      +19     
- Misses         328      329       +1     
- Partials        89       90       +1     

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

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud