Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tmukammel/lib-repo-discovery
A lib to discover repositories across microservices
https://github.com/tmukammel/lib-repo-discovery
Last synced: 6 days ago
JSON representation
A lib to discover repositories across microservices
- Host: GitHub
- URL: https://github.com/tmukammel/lib-repo-discovery
- Owner: tmukammel
- Created: 2024-11-28T11:04:07.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-11-29T00:22:30.000Z (about 1 month ago)
- Last Synced: 2024-11-29T01:25:12.129Z (about 1 month ago)
- Language: TypeScript
- Size: 59.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# A lib to discover repositories across microservices
## Installation
```
npm i --save https://github.com/tmukammel/lib-repo-discovery.git
```
## Usage
### Step 01: Implement `IRepositoryInvoker` interface
```js
// Suppose RepositoryInvokerAdapter implements IRepositoryInvoker interface from infra layer
// and imports and uses IAppRepoInvoker from application layer
// forwards the interface method calls to IAppRepoInvoker implementar instance (e.g. UserService)
// to invert the dependency toward the application layer
// then ...
// In the application layer
// UserService.ts
export default class UserService implements IAppRepoInvoker {
// ...
// Likely implementation of IAppRepoInvoker interface
/************************************************************************************************/
async get(query: JSON, isCollection?: boolean): Model | Model[] {
query = await userQueryParser.parse(query);
return isCollection
? this.userRepository.getModelCollection(query)
: query?.params?.hasOwnProperty('id')
? this.userRepository.getModelById(query?.params?.id, 'include' in query ? query.include : null)
: this.userRepository.getModel(query);
}
async validate(query: JSON, validationLogic: (data: Model) => boolean): Promise {
const res = await this.userRepository.getModelById(
query?.params?.id,
'include' in query ? query.include : null
);
return validationLogic(res);
}
transact(method: string, query: JSON, transaction: Transaction, data?: Model): Model {
enum AllowedMethods {
post = 'POST',
put = 'PUT',
patch = 'PATCH',
delete = 'DELETE'
}
switch (method) {
case AllowedMethods.post:
return this.userRepository.createModel(query, transaction);
case AllowedMethods.put:
case AllowedMethods.patch:
return this.userRepository.updateModel(data, query, transaction);
case AllowedMethods.delete:
return this.userRepository.deleteModel(query, transaction);
}
}
/************************************************************************************************/
}
```
### Step 02: Add `IRepositoryInvoker` interface implementars to repo invoker registry
```js
// In the application bootstrap file
// App.ts
// Likely registration of services as IRepositoryInvoker
repoDiscovery: RepositoryDiscovery = RepositoryDiscovery.instance()
forEach((ModelName) => {
db: BaseORM = new Sequelize()
model: IModel = new UserModel(db)
repo: IRepository = new BaseRepo(model)
service: IRepositoryInvoker = new BaseService(repo)
controller: IController = BaseController(service)
// ... add to router
// add service to RepositoryInvokerRegistry as IRepositoryInvoker
repositoryInvokerAdapter = new RepositoryInvokerAdapter(service)
repoDiscovery.addToRepositoryInvokerRegistry(repositoryInvokerAdapter)
})
```
### Step 03: Discover invoker and invoke repository through invoker
```js
// Likely code sample of ivoker discovery and invocation of repository
// ...
repoInvoker: IRepositoryInvoker = RepositoryDiscovery.instance().getRepositoryInvoker("Users")
userData: UserModelStab = await repoInvoker.get({/*JSON query*/}, false)
```
## Specification
1. The lib should allow resource repository discovery across monolyth, packages and microservices
2. should be communication protocol agnostic (e.g: should support - HTTP, google RPC, socket, etc...)
3. client should use common interface for any communication protocol
## Background
lib-repo-discovery should enable a monolyth, monorepo packages, micro services to allow repository invocation across them without needing to import the specific repository. The lib-repo-discovery interfaces will specifically allow us to validate data, get data, run transactional updates on any repository across the system.
This lib should have three alternative working layers for communication
1. method call within monolyth probably with multiple packages
2. event driven communication between processes within same service (instance)
3. over the network communication between services in microservices environment
1. over the network communication can have different protocols
1. HTTP
2. gRPC
3. socket
Example,
> Suppose JobService & UserService are two microservices.
>
> We need to fetch UserProfile including any JobApplications.
>
> And that means, we need UserProfile from UserService and JobApplications from JobService.
>
> The client browser requested something like `api/user_profile/:id?include=JobApplications`.
>
> In UserProfileService we get the user data but JobService is in different microservice.
>
> Now we use the lib-repository-discovery to get the jobApplicationsRepoInvoker and call `jobApplicationsRepoInvoker.get(query: {where: {user_id: id}}, isCollection?: true)`.
## Current bottlenecks
Currently this lib only work for packages running in the same node instance.
In cluster environemnt, each cluster will have a full set of service packages running in each node with it's own instance of lib-repo-discovery, and lib-repo-discovery will route discovery calls to service packages running only within the node instance. In the following versions we should also be able to serve over the network calls using different protocols.
## Lib design
### Class diagram [edit](https://mermaid.live/edit#pako:eNqdVF1vmzAU_SuWn5KJoFAIKW5GpS17iLRIW5enjmlyjUOsgs2MiUbT_PddPvKlsE5aJBSufe45595rs8NMxRwTzFJaFHNBE02zSMZCc2aEkmj1IZKRbHbRA89VIYzS1VwUTG25rtAukgh-uRZbajgqDDWC9SJ_Cgm7knEgNAf8kuazwmghEwstTlkLuVXPXIdI80TAfnWpwhRQ6ZIBdDCs_TWb5VMK0p2DhJtFpzcYkj5DF1kAv1IfPPOKoNYdUFzbQ6-olDFfC8njCzYaxyt1BX_oajnntaDCXHWAPg0QflIq5RSq3NelHobRY6ebxWwmpOF6TRkPw3YJypt9tdAyHPwqoXSCIBDFR5Wm7Zjvjyqgt4S6lt9_tJlbmooYel6nz8_Tuw1I_qwSwQgaQEQJmg_R-_CM7YtWmSj4rFsJ71peo6ksKGtsrRrqjJuNik-NOUkdsKBFanAtdF8rwXPXteVvTema3hh9o0H_MzFGAfr2zA7u-u6Dbb-G_zBMkMjylGdcmqKfJMJOhNG70ah-s20JQc_BIHBjsmYRSLGFM64zKmK49k1HImw2IBJhAq9wnmmZmgiDdYDS0qhvlWSYwIXjFtaqTDaYrGlaQFTm9dnoPhvH1ZzKR6WyQ0oL-hTXlo4Y3oTL7uNT_zV5mOzwb0xGru_a3sQLxm7g3jjT8Xhi4QoT59a33Ukw9saB43qB4033Fn5ptBx7Mgn8wPennuv5wY3r7_8AL-O0Yg)
```mermaid
classDiagram
direction TB
class RepositoryDiscovery {
private static RepositoryDiscovery _instance
private Map registry
private constructor()
public static getInstance(): RepositoryDiscovery
public getRepositoryInvoker(key: string): IRepositoryInvoker | undefined
public addToRepositoryInvokerRegistry(key: string, repoInvoker: IRepositoryInvoker): boolean
}
class IRepositoryInvoker {
<>
get(query: Q, isCollection?: boolean): M | M[]
validate(query: Q, validationLogic: (data: D) => boolean): Promise;
transact(method: string, query: Q, transaction: T, data?: D): D;
}
class IRepositoryInvokerRegistration {
<>
addToRepositoryInvokerRegistry(key: string, repoInvocator: IRepositoryInvoker): boolean;
}
RepositoryDiscovery ..|> IRepositoryInvokerRegistration: implements
RepositoryDiscovery "1" *-- "1..n" IRepositoryInvoker : composition
```