Skip to content
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.

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

[Core] Create webhooks only resync #1225

Open
wants to merge 18 commits into
base: main
Choose a base branch
from

Conversation

matan84
Copy link
Member

@matan84 matan84 commented Dec 12, 2024

Description

What - Added new event listener type- Webhooks only

Why - In order to enable 2 different integration types

How - Added new event listener without resync logic

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)

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

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.

@matan84 matan84 requested a review from a team as a code owner December 12, 2024 09:53
Copy link
Contributor

@Tankilevitch Tankilevitch left a comment

Choose a reason for hiding this comment

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

Nice!! left a few comments & questions

port_ocean/run.py Outdated Show resolved Hide resolved
port_ocean/core/integrations/base.py Outdated Show resolved Hide resolved
port_ocean/core/event_listener/factory.py Show resolved Hide resolved
port_ocean/context/ocean.py Outdated Show resolved Hide resolved
port_ocean/core/integrations/base.py Outdated Show resolved Hide resolved
Comment on lines +79 to +82
logger.debug(
"Webhook only event listener is used, resync events are ignored"
)
return None
Copy link
Contributor

Choose a reason for hiding this comment

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

do we need this?

@@ -88,7 +92,11 @@ async def create_event_listener(self) -> BaseEventListener:
config, OnceEventListenerSettings
), assert_message.format(type(config))
event_listener = OnceEventListener(wrapped_events, config)

case "webhooks_only":
Copy link
Contributor

Choose a reason for hiding this comment

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

can we manage those consts from one place?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants