Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shipsaas/laravel-inbox-process

The Inbox Pattern/Process for Laravel apps. Ensure the ordering, uniqueness, and reliable handling of webhook requests.
https://github.com/shipsaas/laravel-inbox-process

design-patterns exactly-once inbox inbox-pattern laravel library microservice ordering sequential

Last synced: 3 months ago
JSON representation

The Inbox Pattern/Process for Laravel apps. Ensure the ordering, uniqueness, and reliable handling of webhook requests.

Host: GitHub
URL: https://github.com/shipsaas/laravel-inbox-process
Owner: shipsaas
License: mit
Created: 2023-07-15T04:54:37.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-05-12T04:34:54.000Z (9 months ago)
Last Synced: 2024-11-07T02:48:11.448Z (3 months ago)
Topics: design-patterns, exactly-once, inbox, inbox-pattern, laravel, library, microservice, ordering, sequential
Language: PHP
Homepage: https://inbox.shipsaas.tech
Size: 4.6 MB
Stars: 12
Watchers: 0
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# ShipSaaS - Laravel Inbox Process

[![Build & Test (MySQL & PgSQL)](https://github.com/shipsaas/laravel-inbox-process/actions/workflows/build.yml/badge.svg)](https://github.com/shipsaas/laravel-inbox-process/actions/workflows/build.yml)
[![codecov](https://codecov.io/gh/shipsaas/laravel-inbox-process/graph/badge.svg?token=3Z1X9S69C4)](https://codecov.io/gh/shipsaas/laravel-inbox-process)

Talking about distributed computers & servers, it is quite normal nowadays to communicate between servers.

Unlike a regular conversation though, there's no guarantee the message gets delivered only once, arrives in the right order, or even gets a "got it!" reply.

Thus, we have **Inbox Pattern** to help us to achieve that.

## What is the Inbox Pattern

**The Inbox Pattern** is a popular design pattern in the microservice architecture that ensures:

- High availability ✅
- Guaranteed webhook deliverance, no msg lost ✅
- Guaranteed **exactly-once/unique** webhook requests ✅
- Execute webhook requests **in ORDER/sequence** ✅
- (Optional) High visibility & debug all prev requests ✅

And with that being said:

**Laravel Inbox Process (powered by ShipSaaS)** ships everything out-of-the-box and
helps you to roll out the inbox process in no time 😎🚀.

## Supports
- Laravel 10 & 11
- PHP 8.2+
- MySQL 8, MariaDB, Postgres 13+ and SQLite

## Architecture Diagram

![ShipSaaS - Laravel Inbox Process](./.github/arch.png)

## Installation

Install the library:

```bash
composer require shipsaas/laravel-inbox-process
```

Export config & migration files and then run the migration:

```bash
php artisan vendor:publish --tag=laravel-inbox-process
php artisan migrate
```

## Documentation & Usage

Visit: [ShipSaaS Inbox Documentation](https://inbox.shipsaas.tech)

Best practices, usage & notes are well documented too 😎!

## Testing

Run `composer test` 😆

Available Tests:

- Unit Testing 💪
- Integration Testing against MySQL & PostgreSQL for the `inbox:work` command 😎
- Human validation (lol) 🔥

ShipSaaS loves tests, we won't ship sh!tty libraries 🌹

## Contributors
- Seth Phat

## Contributions & Support the Project

Feel free to submit any PR, please follow PSR-1/PSR-12 coding conventions and testing is a must.

If this package is helpful, please give it a ⭐️⭐️⭐️. Thank you!

## License
MIT License