How event delivery to your module is ensured

Overview

This document outlines the changes made to the external application communication process, which is crucial for ensuring seamless interaction between our system and third-party services. The previous method, which relied heavily on web protocols, was found to be brittle and prone to frequent failures. In response, we have simplified the communication process by integrating services directly within the Node Chat. This document will detail the transition, highlighting the pros and cons of the new approach.

Previous Communication Method

The previous communication method involved multiple services and was characterized by its complexity and resilience. However, it required significant effort to manage and was susceptible to failures due to the numerous components involved. Below is a sequence diagram illustrating the old communication flow:

New Communication Method

Simplification and Integration

The new communication method simplifies the process by moving services directly inside the Node Chat. This integration allows the Node Chat to query the repository for configured endpoints and call external applications directly on every message-related event. This streamlined approach reduces the number of services involved, making the system faster and easier to manage.

New Flow Sequence Diagram

Below is a sequence diagram illustrating the new communication flow:

Pros and Cons

Pros

• Simplicity: The new method involves fewer services, reducing complexity and making it easier to manage.

• Speed: Direct integration within the Node Chat results in faster communication with external applications.

Cons

• Resilience: The new method is less resilient than the old one. If an event fails to send, retries are limited, and there is no message broker to maintain a history of failed events.

Conclusion

The transition to a simplified communication method within the Node Chat represents a significant improvement in terms of speed and manageability. However, it is important to acknowledge the trade-off in resilience. As we continue to refine this process, we will explore ways to enhance reliability while maintaining the benefits of simplicity and speed.