Skip to content

Commit

Permalink
[Core] Handle and log client timeouts (#1195)
Browse files Browse the repository at this point in the history
What -
Handle uncaught exceptions.
Why -
Missing logs in upsert entities caused by timeouts.
How -
Add try catch block to transport layer in ocean client to log unhandled
client timeouts of non retryable methods.

## Type of change

Please leave one option from the following and delete the rest:

- [x] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] New Integration (non-breaking change which adds a new integration)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] Non-breaking change (fix of existing functionality that will not
change current behavior)
- [ ] Documentation (added/updated documentation)

<h4> All tests should be run against the port production
environment(using a testing org). </h4>

### Core testing checklist

- [ ] Integration able to create all default resources from scratch
- [ ] Resync finishes successfully
- [ ] Resync able to create entities
- [ ] Resync able to update entities
- [ ] Resync able to detect and delete entities
- [ ] Scheduled resync able to abort existing resync and start a new one
- [ ] Tested with at least 2 integrations from scratch
- [ ] Tested with Kafka and Polling event listeners
- [ ] Tested deletion of entities that don't pass the selector


### Integration testing checklist

- [ ] Integration able to create all default resources from scratch
- [ ] Resync able to create entities
- [ ] Resync able to update entities
- [ ] Resync able to detect and delete entities
- [ ] Resync finishes successfully
- [ ] If new resource kind is added or updated in the integration, add
example raw data, mapping and expected result to the `examples` folder
in the integration directory.
- [ ] If resource kind is updated, run the integration with the example
data and check if the expected result is achieved
- [ ] If new resource kind is added or updated, validate that
live-events for that resource are working as expected
- [ ] Docs PR link [here](#)

### Preflight checklist

- [ ] Handled rate limiting
- [ ] Handled pagination
- [ ] Implemented the code in async
- [ ] Support Multi account

## Screenshots

Include screenshots from your environment showing how the resources of
the integration will look.

## API Documentation

Provide links to the API documentation used for this integration.

Co-authored-by: Ivan Kalinovski <[email protected]>
  • Loading branch information
ivankalinovski and Ivan Kalinovski authored Dec 3, 2024
1 parent ea4ff43 commit 741bec3
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 15 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm

<!-- towncrier release notes start -->

## 0.14.4 (2024-12-03)


### Bug Fixes

- Add try/except block on httpx transport of ocean client to log timeouts and other exceptions (Client timeouts not recorded)


## 0.14.3 (2024-11-25)


Expand Down
39 changes: 25 additions & 14 deletions port_ocean/helpers/retry.py
Original file line number Diff line number Diff line change
Expand Up @@ -132,13 +132,18 @@ def handle_request(self, request: httpx.Request) -> httpx.Response:
httpx.Response: The response received.
"""
transport: httpx.BaseTransport = self._wrapped_transport # type: ignore
if request.method in self._retryable_methods:
send_method = partial(transport.handle_request)
response = self._retry_operation(request, send_method)
else:
response = transport.handle_request(request)
return response
try:
transport: httpx.BaseTransport = self._wrapped_transport # type: ignore
if request.method in self._retryable_methods:
send_method = partial(transport.handle_request)
response = self._retry_operation(request, send_method)
else:
response = transport.handle_request(request)
return response
except Exception as e:
if not self._is_retryable_method(request) and self._logger is not None:
self._logger.exception(f"{repr(e)} - {request.url}", exc_info=e)
raise e

async def handle_async_request(self, request: httpx.Request) -> httpx.Response:
"""Sends an HTTP request, possibly with retries.
Expand All @@ -150,13 +155,19 @@ async def handle_async_request(self, request: httpx.Request) -> httpx.Response:
The response.
"""
transport: httpx.AsyncBaseTransport = self._wrapped_transport # type: ignore
if self._is_retryable_method(request):
send_method = partial(transport.handle_async_request)
response = await self._retry_operation_async(request, send_method)
else:
response = await transport.handle_async_request(request)
return response
try:
transport: httpx.AsyncBaseTransport = self._wrapped_transport # type: ignore
if self._is_retryable_method(request):
send_method = partial(transport.handle_async_request)
response = await self._retry_operation_async(request, send_method)
else:
response = await transport.handle_async_request(request)
return response
except Exception as e:
# Retyable methods are logged via _log_error
if not self._is_retryable_method(request) and self._logger is not None:
self._logger.exception(f"{repr(e)} - {request.url}", exc_info=e)
raise e

async def aclose(self) -> None:
"""
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "port-ocean"
version = "0.14.3"
version = "0.14.4"
description = "Port Ocean is a CLI tool for managing your Port projects."
readme = "README.md"
homepage = "https://app.getport.io"
Expand Down

0 comments on commit 741bec3

Please sign in to comment.