Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/herbsjs/buchu
Use Cases - Uniform, auditable and secure use case library
https://github.com/herbsjs/buchu
clean-architecture cleanarchitecture ddd domain-driven-design hacktoberfest herbsjs javascript usecase
Last synced: 27 days ago
JSON representation
Use Cases - Uniform, auditable and secure use case library
- Host: GitHub
- URL: https://github.com/herbsjs/buchu
- Owner: herbsjs
- License: other
- Created: 2019-07-28T20:29:36.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-11-22T14:40:57.000Z (about 1 year ago)
- Last Synced: 2024-12-01T10:12:33.813Z (about 1 month ago)
- Topics: clean-architecture, cleanarchitecture, ddd, domain-driven-design, hacktoberfest, herbsjs, javascript, usecase
- Language: JavaScript
- Homepage:
- Size: 1.78 MB
- Stars: 24
- Watchers: 6
- Forks: 22
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
 [](https://codecov.io/gh/herbsjs/buchu)
# buchu
Uniform, auditable and secure use case javascript library. Influenced by Clean Architecture and Trailblazer
## index
- [Installing](#installing)
- [Using](#using)
- [Motivations](#motivations)
- [Maintainability](#maintainability)
- [Metadata for system intent](#metadata-for-system-intent)
- [Auditable and Secure](#auditable-and-ecure)
- [Audit](#audit)
- [Request Validation](#request-validation)
- [Authorization](#authorization)
- [Use Case](#use-case)
- [What is it?](#what-is-it?)
- [Best-pratices](#best-pratices)
- [Errors](#errors)
- [Contribute](#contribute)
- [The Herb](#the-herb)
- [License](#license)
### Installing
``` $ npm install @herbsjs/buchu ```
### Using
Check the complete examples [here](https://github.com/herbsjs/buchu/tree/master/examples) or for a complete solution using herbsJS [here](https://github.com/herbsjs/todolist-on-herbs).
usecases/addOrUpdateItem.js:
```javascript
const { entity, field } = require('@herbsjs/gotu')
const Item = entity('Item', {
id: field(Number),
description: field(String),
isDone: field(Boolean),
position: field(Number)
})
const { Ok, Err, usecase, step, ifElse } = require('@herbsjs/buchu')
const dependency = {
ItemRepository: require('../repositories/ItemRepository').ItemRepository,
...
}
const addOrUpdateItem = (injection) =>
usecase('Add or Update an Item on a to-do List', {
// Input/Request type validation
request: { listId: Number, item: Item },
// Output/Response type
response: { item: Item },
// Authorization Audit
authorize: async (user) => user.isAdmin ? Ok() : Err(),
// Dependency Injection control
setup: (ctx) => ctx.di = Object.assign({}, dependency, injection),
// Step audit and description
'Check if the Item is valid': step((ctx) => {
...
return item.validate() // Ok or Error
}),
'Check if the List exists': step(async (ctx) => {
...
return Ok()
}),
// Conditional step
'Add or Update the Item': ifElse({
'If the Item exists': step(async (ctx) => {
...
return Ok(newItem)
}),
'Then: Add a new Item to the List': step(async (ctx) => {
...
return ctx.ret = await itemRepo.save(item) // Ok or Error
}),
'Else: Update Item on the List': step(async (ctx) => {
...
return ctx.ret = await itemRepo.save(item) // Ok or Error
})
})
})
```
to another resources like, `ctx.stop()` used to stop a use case next steps execution, look [here](https://github.com/herbsjs/buchu/tree/master/examples)
controler/addOrUpdateItem.js:
```javascript
app.put('/items/:item', function (req, res) {
const request = req.params
const user = { name: 'John', id: '923b8b9a', isAdmin: true } // from session
const uc = addOrUpdateItem()
await uc.authorize(user)
const ret = await uc.run(request)
res.send(ret)
})
```
`uc.doc()`:
```javascript
{
type: 'use case',
description: 'Add or Update an Item on a to-do List',
request: { listId: Number, item: Item },
response: String,
steps: [
{ type: 'step', description: 'Check if the Item is valid', steps: null },
{ type: 'step', description: 'Check if the List exists', steps: null },
{
type: 'if else',
if: { type: 'step', description: 'If the Item exists', steps: null },
then: { type: 'step', description: 'Then: Add a new Item to the List', steps: null },
else: { type: 'step', description: 'Else: Update Item on the List', steps: null }
}
]
}
```
### Motivations
#### Maintainability
"Programs must be written for people to read, and only incidentally for machines to execute" - Harold Abelson, Structure and Interpretation of Computer Programs
Understanding what a software is doing from a business perspective is a must in order to be able to change it quickly and in a sustainable way.
#### Metadata for system intent
It should be easy to retrieve a system's metadata for all its use cases and steps. This info could be used to leverage innovative interfaces (ex: dynamic admin pages, use case documentations, etc), helping narrow the gap between developers, testers and product managers.
#### Auditable and Secure
It should be easy to have enterprise grade features even for simple applications. Authorization and auditing, for instance, should be available out of the box. Not using should be opt-in.
### Audit
It is possible to retrieve the audit trail of an use case after its execution
`uc.auditTrail`:
```javascript
{
type: 'use case',
description: 'Add or Update an Item on a to-do List',
transactionId: '9985fb70-f56d-466a-b466-e200d1d4848c',
elapsedTime: 1981800n, // in nanosecods
user: { name: 'John', id: '923b8b9a', isAdmin: true },
authorized: true,
return: {
Ok: { item: { id: 100, name: 'Do not forget this', position: 9 } }
},
steps: [
{ type: 'step', description: 'Check if the Item is valid', elapsedTime: 208201n , return: {} },
{ type: 'step', description: 'Check if the List exists', elapsedTime: 114300n , return: {} },
{
type: 'if else',
description: 'Add or Update the Item',
returnIf: { Ok: true },
returnThen: {}
}
]
}
```
You can use like this, using a config inside use case to remove some output fields:
```javascript
const givenTheSimplestUseCaseWithAuditTrail = () => {
const uc = usecase('A use case', {
auditTrail: {
return: false,
user: false,
},
'A step': step(() => { return Ok() }),
})
return uc
}
```
In this example, the return of the audit trail you be:
```
{
configuration:{output: {return: false, user: false}}
description:'A use case'
elapsedTime:362700n
request:null
steps: [ {type: 'step', description: 'A step', return: {Ok: ''}, elapsedTime: 76100n}]
transactionId:'cfd88c2b-1d34-4c81-a07c-ac4ea5420d04'
type:'use case'
}
```
You can use those configuration to remove fields:
```javascript
const auditTrail = {
steps: false
request : false
return : false
user : false
elapsedTime : false
}
```
TIP: If you need to audit the exceptions thrown by the use case use `process.env.HERBS_EXCEPTION = "audit"`. This will swallow the exceptions and return a Err on the step. Recommended for production environments.
### Request Validation
A request can be validated against the field's type.
```javascript
const addOrUpdateItem = (injection) =>
usecase('Add or Update an Item on a to-do List', {
// Input/Request type validation
request: { listId: Number, item: Object },
...
```
#### Request types
A field in a request can be basic types from Javascript or entities created from gotu herbs lib:
`Number`: double-precision 64-bit binary format IEEE 754 value
`String`: a UTF‐16 character sequence
`Boolean`: true or false
`Date`: represents a single moment in time in a platform-independent format.
`Object`: the Object class represents one of JavaScript's data types.
`Array`: the Array class is a object that is used in the construction of arrays.
`Entity`: entity object represents an gotu base entity.
### Authorization
A usecase must declare the authorization function, which receives a user parameter, defined by some middleware in the infrastructure layer, this received parameter will be included within the ctx, and can be accessed from the steps with `ctx.user`.
```javascript
authorize: (user) => user.isAdmin ? Ok() : Err(),
```
### Use Case
#### What is it?
A Use Case reflects a single action exposed by the Domain to the end user. Ex: _Reopen Ticket_, _Reply Message_, _Add User_
Internaly a Use Case control the interaction between Entities, Repositories (infrastructure) and other Domain components.
It should:
- Be modeled around business
- Be reusable
- Be testable / Have clear acceptance criteria
- Help identify right architecture
- Ubiquitous language
"Use cases orchestrate the flow of data to and from the entities, and direct those entities to use their Critical Business Rules to achieve the goals of the use case." - Clean Architecture book
#### Best pratices
- Keep it simple by telling stories
- Understand the big picture
- Focus on value
- Build the use case in steps
Architecture:
- Implement business __flows__ using Use Cases.
Ex: _Reply Message_ use case interacts with `Message`, `Ticket`, `User` and others entities in order to reply a message for a user
- Split the __flows__ in smaller steps
- Avoid implement __validations__ using Use Cases. Prefer Entities for validations
- Access Use Cases from outside the Domain
Use cases are the "entry points" for the Domain layer, so it is the only accessible layer from outside the Domain.
- Don't access any other sublayer which belongs to Domain layer (Entities, etc) apart Use Case from outside Domain
- Name the Use Case folder, file and its steps as an action (verb).
Ex: `OpenTicket.js`, `ReplyMessage.js`, `AddUser.js`
Use Cases are implemented as [command patterns](https://sourcemaking.com/design_patterns/command).
References:
- Clean Architecture book [link](https://www.amazon.com/Clean-Architecture-Craftsmans-Software-Structure/dp/0134494164)
- Use Case 2.0 [link](https://www.ivarjacobson.com/sites/default/files/field_iji_file/article/use-case_2.0_final_rev3.pdf)
- Use Case diagram [link](http://www.agilemodeling.com/artifacts/useCaseDiagram.htm)
- Service Layer [link](https://martinfowler.com/eaaCatalog/serviceLayer.html)
### Errors
As you noted into [example](#using) session you can return an Err object, this class can be an generic Err as can be a structured Err too
``` js
const options = { message: 'message', payload: { entity: 'user' }, cause: Err("my message") || new Error() }
Err.notFound(options),
Err.alreadyExists(options),
Err.invalidEntity(options),
Err.invalidArguments({ ...options, args: { name: 'cant be empty' }}),
Err.permissionDenied(options),
Err.unknown(options),
Err.buildCustomErr(options),
```
or you can create your own structured Err
``` js
Err._buildCustomErr('ERROR_CODE', message, payload, cause)
```
### To Do
- [X] Base - Run a use case
- [X] Use Case Error - Ok or Error results for a use case (Rust inspired)
- [X] Steps - Enable multiple steps for a use case
- [X] Nested Steps - Enable multiple steps for a parent step
- [ ] Nested Steps - multiple files - Enable multiple steps in diferent files for a parent step
- [ ] Use usecase as a step
- [X] Doc Step - Get description and structure from use case and its steps
- [X] Request - Be able to describe and validate the use case request object
- [X] Response - Be able to describe and validate the use case response object
- [X] Dependency Injection (removed)
- [X] `ctx` var - Share context between Steps
- [X] Conditional Steps - Enable a If/Else constructor for steps
- [X] Authorization - Be able to authorize the execution of a use case and its steps
- [X] Audit - Be able to track use case runtime information
- [X] Audit - Timing - Be able to track use case and its steps execution time
- [ ] Async / MQ - Multiple Rounds - Be able to partially execute a use case and continue (when a MQ is necessary, for instance)
- [X] transaction ID - A ID to track execution between steps
- [ ] session ID - A ID to track execution between use cases
- [X] Deal with exceptions
- [ ] Deal with no default results (Ok/Err)
- [X] Deal with async / await steps
- [X] Use case examples
### Contribute
Come with us to make an awesome *Buchu*.
Now, if you do not have technical knowledge and also have intend to help us, do not feel shy, [click here](https://github.com/herbsjs/buchu/issues) to open an issue and collaborate their ideas, the contribution may be a criticism or a compliment (why not?)
If you would like to help contribute to this repository, please see [CONTRIBUTING](https://github.com/herbsjs/buchu/blob/master/.github/CONTRIBUTING.md)
### The Herb
Buchu is most often used as a stimulating tonic and a diuretic. It is now commonly used to treat urinary tract infections. In the past, this herb has also been used to treat arthritis, kidney stones and gout. It can also be used externally for bruises and sprains.
https://www.herbslist.net/
https://en.wikipedia.org/wiki/Agathosma_betulina
### License
**Buchu** is released under the
[MIT license](https://github.com/herbsjs/buchu/blob/development/LICENSE).