https://github.com/forestadmin/forest-live-demo-rpc
https://github.com/forestadmin/forest-live-demo-rpc
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/forestadmin/forest-live-demo-rpc
- Owner: ForestAdmin
- Created: 2024-07-12T14:00:45.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-12T14:09:58.000Z (almost 2 years ago)
- Last Synced: 2024-07-12T16:12:57.276Z (almost 2 years ago)
- Language: TypeScript
- Size: 21.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
You'll need 3 empty databases, `rpc_1`, `rpc_2`, `rpc_3`.
The gateway behaves like a classic `agent-nodejs`, so all the agent capabilities are supported when developed directly on it.
The RPC agents also have customisation capabilities. Some aren't supported though, they should be listed in the "Known Limitations" section.
# Install
- `cp .env.example .env` and fill in the necessary details.
- `yarn` to install.
- `yarn seed` to seed the database with dummy data.
In the following order
- `yarn watch:rpc1` to start RPC Agent 1 (Containing the user collection)
- `yarn watch:rpc3` to start RPC Agent 3 (Containing the Country with extension collection)
- `yarn watch:rpc2` to start RPC Agent 2 (Containing the company collection, depends on RPC 3)
- `yarn watch:gateway` to start the Gateway (That'll contain both RPC Agent 1 & RPC Agent 2 data)
# Technical details
```
┌──────────┐
│ │
│ Gateway │
│ │
├┬────────┬┤
┌──────────┴┘ └┴───────┐
│ │
┌───▼───┐ ┌───▼───┐
│ RPC 1 │ │ RPC 2 │
└───────┘ └───┬───┘
│
┌───▼───┐
│ RPC 3 │
└───────┘
```
## RPC DataSource
The RPC data source allows get and proxify data from a RPC agent.
### Installation
- install the package `@forestadmin-experimental/datasource-rpc`.
- give the URI, FOREST_ENV_SECRET & FOREST_AUTH_SECRET
```javascript
const { createAgent } = require('@forestadmin/agent');
const { createRpcDataSource } = require('@forestadmin-experimental/datasource-rpc');
const agent = createAgent(options).addDataSource(
createRpcDataSource({
uri: 'http://localhost:3352',
authSecret: process.env.FOREST_AUTH_SECRET,
}),
);
```
## RPC Agent
The RPC agent is created to split your data into microservices, combined with a real agent and a RPC data source,
you will be able to access all your collections as this is a normal agent.
### Installation
- install the package `@forestadmin-experimental/rpc-agent`.
- give options like a real agent.
```javascript
const { createRpcAgent } = require('@forestadmin-experimental/rpc-agent');
const agent = createRpcAgent({
authSecret: process.env.FOREST_AUTH_SECRET,
isProduction: process.env.NODE_ENV === 'production',
loggerLevel: 'Info',
});
// use the agent like a real one.
```
# Known limitations
- The RPC agent are not able to communicate with each other. They can only communicate with the Gateway.
- Using files (Upload or download) on RPC Agents aren't supported yet.
- If a RPC agent cannot start, the gateway won't start as well.
- If 2 RPCs share the same collection (name), they will conflict, and only one will be used and display. Using the `rename` option will be mandatory in this case.