Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eBay/oja
Lightweight Dependency Injection Framework for Node.JS Apps - Structure your application business logic
https://github.com/eBay/oja
dependency-injection discovery-service javascript logic middleware nodejs structure
Last synced: 11 days ago
JSON representation
Lightweight Dependency Injection Framework for Node.JS Apps - Structure your application business logic
- Host: GitHub
- URL: https://github.com/eBay/oja
- Owner: eBay
- License: other
- Created: 2019-12-02T23:35:07.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-21T04:55:38.000Z (5 months ago)
- Last Synced: 2024-10-22T15:34:25.816Z (21 days ago)
- Topics: dependency-injection, discovery-service, javascript, logic, middleware, nodejs, structure
- Language: JavaScript
- Homepage:
- Size: 11.6 MB
- Stars: 25
- Watchers: 9
- Forks: 5
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
v2.0
Lightweight dependency injection framework to structure application business logic.
[](https://github.com/lerna/lerna)
[](./LICENSE)
[](https://codecov.io/gh/eBay/oja)
[](https://travis-ci.org/eBay/oja) [](https://www.npmjs.com/package/oja)
[](https://snyk.io/test/github/eBay/oja)
## Idea
The context based approach allows a developer to slice the business logic into small, isolated business actions that communicate to each other via context. That encourages developers to use the same action interface across application code, which makes the code more predictable, easy to define/compose, and test with mock data. And yes - it makes it boring.
### Basic -> Components -> Actions (Dependency Injection)
## Example
### Action definition
* folder structure:
```
module-root/
action.json
action.js
```
* action.json:
```JSON
{
"MATH/sum": "./action"
}
```
* action.js
```js
module.exports = context => (a, b) => a + b;
```
### Calling action
```js
const { createContext } = require('@ebay/oja-action');
// context creation can be called for every new flow
const context = await createContext();
// calling action can be done many times within the same context
console.log(await context.action('MATH/sum', 1, 2)); // >> 3
console.log(await context.action('MATH/sum', 5, 2)); // >> 7
```
## Install
In order to realize all benefits of using oja framework you need to do the following:
* Install the following modules as part of your application
```
npm install @ebay/oja-context @ebay/oja-action --save
npm install @ebay/oja-linter --save-dev
```
* Install VSCode extension as part of your VSCode Editor
1. Open VS Code
2. Press F1
3. Type "install"
4. Select "Extensions: Install Extension".
5. Select vscode-oja from the list
Note: VSCode extension uses oja-linter to validate your project files (action.json, *.js/mjs) and it will start working as soon as you install @ebay/oja-linter, @ebay/oja-action and @ebay/oja-context under your application dependencies.
* Install optional hygen generator
```
npm install hygen hygen-add -g
hygen-add oja-generators
```
* Example
Feel free to explore [examples](https://github.com/eBay/oja/blob/master/packages/examples/README.md), a fully functional application.
## Documentation and Packages
Each package is documented in a separate readme:
- [oja-action](https://github.com/eBay/oja/blob/master/packages/oja-action#readme) -
Provides action discovery for oja actions based on dependency injection.
- [oja-context](https://github.com/eBay/oja/blob/master/packages/oja-context#readme) -
Provides dependency injection.
- [oja-generators](https://github.com/eBay/oja/blob/master/packages/hygen-oja-generators#readme) -
Provides code and unit test generation for oja-action framework.
- [oja-flow](https://github.com/eBay/oja/blob/master/packages/oja-flow#readme) -
Provides a flow components based on pub/sub pattern with event backlog. This is former oja 1.0 implementation.
- [oja-tools](https://github.com/eBay/oja/blob/master/packages/oja-tools#readme) -
Builds on oja-action to provide tools composing actions into higher level actions and/or instrument them via pipe pattern.
- [examples](https://github.com/eBay/oja/blob/master/packages/examples#readme) -
Example project demonstrating the use of dependency injection based on oja-action
- [vscode-oja](https://github.com/eBay/oja/blob/master/packages/vscode-oja#readme) -
VS Code extension that simplifies oja-action dependency injection usage with automatic suggestions and action discovery.
- [oja-linter](https://github.com/eBay/oja/blob/master/packages/oja-linter#readme) -
Oja linter for oja-action dependency injection layer that validates your project and discovers any unreachable actions (deleted/modified) at the point of the use of the action.
- [oja-pubsub](https://github.com/eBay/oja/blob/master/packages/oja-pubsub#readme) - Provides a way to organize actions into publishers and subscribers roles when the same business events need to be consumed by multiple consumer actions.
- TBD: [oja-workers](https://github.com/eBay/oja/blob/master/packages/oja-workers#readme) -
Provides an action pool that can be used to separate actions or group of actions into their own isolated execution environments based on Node v12 lightweight workers.
- TBD: [oja-cloud](https://github.com/eBay/oja/blob/master/packages/oja-cloud#readme) -
Provides an adaptor layer to organize and deploy actions to distributed environments aka lambda/serverless.
## Example Use-Cases
* Extension point
* Middleware
* Feature activation/selection
* Flow selection
* Pub/sub pattern to decouple producer actions from consumer actions
* What if you are "stuck" with express, but like Koa syntax?
## Code of Conduct
This project adheres to the [eBay Code of Conduct](./.github/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
# Author(s)
Dmytro Semenov
# License
Copyright (c) 2019 eBay Inc.
Released under the MIT License http://www.opensource.org/licenses/MIT