feat(tracer): add try/catch logic to decorator and middleware close

[dreamorosi]

Description of your changes

This PR introduces some try/catch logic to the parts of the code that are in charge of closing a subsegment in decorators and middleware usage.

As reported in the linked issue, if the segment contains metadata that cannot be serialized calling the subsegment.close() (or subsegment.flush()) method will throw an error.

This happens because the segment is serialized using JSON.stringify() twice right before being emitted and so if the stringify method encounters an entity that doesn't know how to serialize, it'll throw an error.

Even though the linked issue propsosed to add this try/catch logic to the tracer.putMetdata() method, this would be useless as the serialization is done just-in-time before emitting the segment.

For this reason we must guard against runtime errors when closing the segment that we (Powertools) opened. In this case, we are now catching the error and logging a warning.

Customers can use this warning to:

• detect potential issues in the data being emitted using the provided stack trace
• be warned about potential data loss

It's important to note that this fix only safeguards against runtime errors for segments that Tracer opens under the hood. If customers try to call segment.close() directly on a segment the error will still be thrown.

We are attempting to work with the X-Ray team to provide a more permanent fix.

Related issues, RFCs

Issue number: #1713

Checklist

• My changes meet the tenets criteria
• I have performed a self-review of my own code
• I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my change is effective and works
• The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

• I have documented the migration process
• I have added, implemented necessary warnings (if it can live side by side)

---

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]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
29.5% Duplication

[dreamorosi]

Passing integration tests: https://github.com/aws-powertools/powertools-lambda-typescript/actions/runs/6328457720