ocean icon indicating copy to clipboard operation
ocean copied to clipboard

[Integration][Octopus] Refactor Webhook Handling for Scalable Live Events

Open dev-habib-nuhu opened this issue 6 months ago • 1 comments

Description

What - Refactor the Octopus integration to align with the new scalable webhook handling pattern, ensuring modularity, scalability, and maintainability.

Why - Scalability: The current implementation processes all events in a single handler, which can become a bottleneck as the volume of events grows.

Modularity: Separating event handling into dedicated processors improves code organization and makes it easier to extend or modify.

Maintainability: A modular design simplifies debugging and future updates.

How - Creating Dedicated Webhook Processors

Type of change

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

  • [ ] Non-breaking change (fix of existing functionality that will not change current behavior)

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.

dev-habib-nuhu avatar May 06 '25 10:05 dev-habib-nuhu

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-1609.d1ftd8v2gowp8w.amplifyapp.com