prosa 0.3.4

ProSA core
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

ProSA - **Pro**tocol **S**ervice **A**daptor
==============================

ProSA is a merge of multiple [Worldline](https://worldline.com/) internal product concepts caviarized to be released as a [Rust](https://www.rust-lang.org/) open-source.
The library aimed at providing a simple and lightweight protocol service adaptor for service oriented architectures.
The goal of this project is to provide a flexible and scalable platform for developing and deploying microservices, allowing developers to focus on writing business logic while ProSA takes care of the underlying infrastructure concers.

A [ProSA mdBook](https://worldline.github.io/ProSA/) is available if you want to learn everything about ProSA.

## Legend

ProSA components are illustrated:
 - Main: [<img alt="main" src="https://raw.githubusercontent.com/worldline/ProSA/main/assets/main.svg" width="26">](https://docs.rs/prosa/latest/prosa/core/main/ "main")
 - TVF: [<img alt="tvf" src="https://raw.githubusercontent.com/worldline/ProSA/main/assets/tvf.svg" width="26">](https://docs.rs/prosa_utils/latest/prosa_utils/msg/tvf/ "tvf")
 - Processor: [<img alt="processor" src="https://raw.githubusercontent.com/worldline/ProSA/main/assets/proc.svg" width="26">](https://docs.rs/prosa/latest/prosa/core/proc/ "processor")
 - Settings: [<img alt="settings" src="https://raw.githubusercontent.com/worldline/ProSA/main/assets/settings.svg" width="26">](https://docs.rs/prosa/latest/prosa/core/settings/ "settings")
 - Adaptor: [<img alt="adaptor" src="https://raw.githubusercontent.com/worldline/ProSA/main/assets/adaptor.svg" width="26">](https://docs.rs/prosa/latest/prosa/core/adaptor/ "adaptor")


## Service approach

ProSA is made to empower SOA (*S*ervice *O*riented *A*rchitecture).
To do so, ProSA is built around a _service bus_ that can be local or distributed.

Around the service bus, there are gravitating processors that offer or consume services.
``` mermaid
flowchart LR
    proc1(Processor)
    proc2(Processor)
    bus((Main))
    proc1 <--> bus
    bus <--> proc2
```

ProSA processors can be autonomous or built to connect external systems to make them accessible as a service.

``` mermaid
flowchart LR
    ext(External System)
    adapt(Adaptor)
    proc(Processor)
    bus((Main))
    ext <-- Protocol Exchange --> adapt
    subgraph Processor
    adapt <-- protocol adaptation --> proc
    end
    proc -- internal service message --> bus
```


## Getting Started

Everything you need to know about ProSA components is describe in the [Docs.rs](https://docs.rs/prosa/latest/prosa/) documentation.

``` mermaid
flowchart LR
    main((Main))
    tvf([TVF])
    proc(Processor)
    settings(Settings)
    adapt(Adaptor)
    click main "https://docs.rs/prosa/latest/prosa/core/main/" "Main"
    click tvf "https://docs.rs/prosa_utils/latest/prosa_utils/msg/tvf/" "TVF"
    click proc "https://docs.rs/prosa/latest/prosa/core/proc/" "Processor"
    click settings "https://docs.rs/prosa/latest/prosa/core/settings/" "Settings"
    click adapt "https://docs.rs/prosa/latest/prosa/core/adaptor/" "Adaptor"
    main <--> proc
    adapt <--> tvf
    subgraph Processor
    proc <--> adapt
    end
    settings --> Processor
```


## Deploying

ProSA is not a full product that you can run.
It's intended to be a framework to run processors that offer/consume services.

So ProSA needs to be built with a set of processors (internal or external) to work.
To build one, please refer to [cargo-prosa](./cargo-prosa/README.md).


## Processor list

### Worldline

- [Hyper](https://github.com/worldline/ProSA-Hyper): HTTP processor

### Third parties

- [Fetcher](https://github.com/reneca/ProSA-Fetcher): Fetch information from remote systems
- [Ollama](https://github.com/reneca/ProSA-Ollama): Ollama processor

## Authors

### Worldline

- [Jérémy HERGAULT](https://github.com/reneca)
- [Anthony THOMAS](https://github.com/Timmy80)
- [Olivier SCHYNS](https://github.com/oschijns)
- [René-Louis EYMARD](https://github.com/rleymard)

### Posterity

- [Julien TERUEL](https://github.com/JT117)