Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marcellodesales/middleware-js
A Node.js middleware framework that allows dependency injection from modules.
https://github.com/marcellodesales/middleware-js
Last synced: about 2 months ago
JSON representation
A Node.js middleware framework that allows dependency injection from modules.
- Host: GitHub
- URL: https://github.com/marcellodesales/middleware-js
- Owner: marcellodesales
- License: mit
- Created: 2015-11-29T04:09:17.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2015-12-27T22:36:26.000Z (about 9 years ago)
- Last Synced: 2024-10-12T23:42:19.338Z (3 months ago)
- Language: JavaScript
- Size: 18.6 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Middleware.js
[](https://travis-ci.org/marcellodesales/middleware-js) [](http://badge.fury.io/js/middleware-js) [](https://www.codacy.com/app/marcellodesales/middleware-js) [](https://david-dm.org/marcellodesales/middleware-js) [](https://david-dm.org/marcellodesales/middleware-js#info=devDependencies) [](https://coveralls.io/github/marcellodesales/middleware-js?branch=master) 
Declare middleware dependencies from your modules, that are injectable to your modules. No more `require('../../../../my/middleware')`!
```js
// Instead the combersome path calculation. DONT DO THIS ANYMORE!
var conf = require("../../../middleware/config");
// Loads APP_DIR/middleware/config. DO THIS INSTEAD!
var config = MiddlewareJs.require("middleware.config");
```
[](https://nodei.co/npm/middleware-js/)
# What is this?
* Facility to easily `require` any module in your module or application without computing paths.
* No more `require('../../../../my/middleware/logging')` in your code but just `require('my.middleware.logging')`.
* Your module or application requires something that only the user knows how to setup.
* New Relic uses its own instance of Bunyan logger.
* You want to provide freedom to users to choose whatever depedency they want.
* Logging using Bunyan or Winston.
# Installation
```sh
npm install --save middleware-js
```
# MiddlewareJS Object
Requiring dependencies that range from a variety of modules needed by any Enterprise application:
* *Logging*: Most applications use a logger. It is imperative for cloud applications to comply to standards.
* Logger instances that write to the file-system breaks 12-factor apps.
* You cannot control the logger instance from the required module. For instance, the module `newrelic` creates its own logger which writes to the file system.
* The instance you use is different than the module. For instance, some use `Bunyan` while others `Winston`. However, both uses the same interface methods for logging as `log.info`, `log.error`, etc.
* *Configuration*: Building settings related to a given module is harder, specially because you don't know how your client uses configuration management.
* You can require your clients to provide settings in a given directory. For instance, the module `newrelic` loads a file from the root directory. They could provide a different loader function that loads the properties from your configuration management such as `nconf`.
## Middleware.require(path)
The module computes the APP directory by default and loads the module at the given path.
* *path*: Path to the middleware you want to be required.
*path-notation*: You can use the path notation: "path/to/middleware". Specially when you are automating using files.
*dot-notation*: You can use the dot notation: "path.to.middleware". Specially when you are automating using object-paths.
The file in the path can either a file or a directory:
* *file*: Can be used as a very simple middleware such as constants, simple modules etc.
* *directory*: When dealing with complex middleware implementation, you may have multiple sub-modules that implement the given middleware. Very useful to only expose the middleware and not its implementation details.
```js
// Loads APP_DIR/middleware/config.
var config = MiddlewareJs.require("middleware.config");
```
The module loaded can be in either files:
* APP_DIR/middleware/config.js: simpler configuration.
* APP_DIR/middleware/config/index.js: more complex implementation with other sub-modules supporting it in the same directory.
See the test cases `test/loadSettingsFromMiddleware.js` for complete details.
## Middleware.from(dirPath)
The module uses the given dirPath as the base dir and return the middleware itself as fluent API and, thus, must be used with `load()`.
* *dirPath*: the search path other than the current APP directory resolved by default.
* Useful when loading anything outside your application directory.
```js
// Loads /shared/modules/default/logger
var logger = MiddlewareJs.from("/shared/modules").require("default.logger");
// Loads /secret-service/certs
var secrets = MiddlewareJs.from("/secret-service").require("certs");
```
See the test cases `test/loadSettingsFromMiddleware.js` for complete details.
# Error Handling
Since this is a synchronous library, attempting to load modules from computed paths that are non-existent will throw exceptions.
Also, remember that this module uses `require()` and the middleware loaded is cached as usual.
See the test cases `test/loadSettingsWithErrors.js` for complete details.
# Use cases
* *New Relic*: it uses their own logging capability. What if they required you to provide the logging capability instead?
* *Frameworks*: You can be smart frameworks that requires middlewares in order to properly work.
* This is a good example of designing a shared module using Interfaces.
# Contributing
We use the GitFlow branching model http://nvie.com/posts/a-successful-git-branching-model/.
1. Fork this project.
2. Create your feature branch (`git checkout -b feature/issue-444-Add-Rest-APIs origin/master --track`)
* Adding the Jira ticket ID helps communicating where this feature is coming from.
3. Commit your changes (`git commit -am 'Fix #444: Add support to REST-APIs'`)
* Adding "fix #444" will trigger a link to the GitHub issue #444.
4. Push to the branch (`git push feature/issue-444-Add-Rest-APIS`)
5. Create new Pull Request as indicated by this page or your forked repo.