Skip to content

Commit

Permalink
[Core] Added None type for wrapper (#1279)
Browse files Browse the repository at this point in the history
# Description

What - lint fix

Why - pipeline fails for two resync kinds on one resource

How - add none as possible value

## Type of change

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

- [ ] 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.
  • Loading branch information
matan84 authored Dec 31, 2024
1 parent 82a0c7d commit 8d77bd2
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 3 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

<!-- towncrier release notes start -->
## 0.17.1 (2024-12-31)


### Bug Fixes

- Fixed lint failure for resources that have two `on_resync` decorators


## 0.17.0 (2024-12-31)


Expand Down
4 changes: 3 additions & 1 deletion port_ocean/context/ocean.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,9 @@ def on_resync(
self,
kind: str | None = None,
) -> Callable[[RESYNC_EVENT_LISTENER], RESYNC_EVENT_LISTENER | None]:
def wrapper(function: RESYNC_EVENT_LISTENER) -> RESYNC_EVENT_LISTENER | None:
def wrapper(
function: RESYNC_EVENT_LISTENER | None,
) -> RESYNC_EVENT_LISTENER | None:
if not self.app.config.event_listener.should_resync:
logger.debug(
"Webhook only event listener is used, resync events are ignored"
Expand Down
4 changes: 3 additions & 1 deletion port_ocean/core/integrations/mixins/events.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ def on_start(self, func: START_EVENT_LISTENER) -> START_EVENT_LISTENER:
return func

def on_resync(
self, func: RESYNC_EVENT_LISTENER, kind: str | None = None
self, func: RESYNC_EVENT_LISTENER| None, kind: str | None = None
) -> RESYNC_EVENT_LISTENER:
"""Register a function as a listener for a "resync" event.
Expand All @@ -57,6 +57,8 @@ def on_resync(
Returns:
RESYNC_EVENT_LISTENER: The input function, unchanged.
"""
if func is None:
return None
if kind is None:
logger.debug(f"Registering resync event listener any kind")
else:
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.17.0"
version = "0.17.1"
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 8d77bd2

Please sign in to comment.