knifecycle

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

(★ 35)

Manage your NodeJS processes's lifecycle automatically with an unobtrusive dependency injection implementation.

knifecycle Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[//]: # ( )
[//]: # (This file is automatically generated by a `metapak`)
[//]: # (module. Do not change it  except between the)
[//]: # (`content:start/end` flags, your changes would)
[//]: # (be overridden.)
[//]: # ( )
# knifecycle
> Manage your NodeJS processes's lifecycle automatically with an unobtrusive dependency injection implementation.

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/nfroidure/knifecycle/blob/main/LICENSE)

[//]: # (::contents:start)

![The Knifecycle logo](https://raw.githubusercontent.com/nfroidure/knifecycle/main/knifecycle.svg)

Most (maybe all) applications rely on two kinds of dependencies.

![The lifecycle of most (all?) applications](https://raw.githubusercontent.com/nfroidure/knifecycle/main/dependency-injection.svg)

**The code dependencies** are fully covered by JavaScript modules in a testable
manner (with `mockery` or `System` directly). There is no need for another
dependency management system if those libraries are pure functions (involve no
global states at all).

Unfortunately, applications often rely on **global states** where the JavaScript
module system shows its limits. This is where `knifecycle` enters the game.

![The app lifecycle sequence graph](https://raw.githubusercontent.com/nfroidure/knifecycle/main/dependencies-graph-sequences.svg)

It is largely inspired by the Angular service system except it should not
provide code but access to global states (time, filesystem, db). It also have an
important additional feature to shutdown processes which is really useful for
back-end servers and doesn't exists in Angular.

Last but not least, you can build your code with Knifecycle so that once in
production, it do not have to resolve the dependency tree leading to better
performances and reduce the bundle size (especially for tools like AWS Lambda /
GCP Functions where each endpoint has its own zip).

You may want to look at the [architecture notes](./ARCHITECTURE.md) to better
handle the reasoning behind `knifecycle` and its implementation.

At this point you may think that a DI system is useless. My advice is that it
depends. But at least, you should not make a definitive choice and allow both
approaches, Knifecycle permits this, most modules made usable by Knifecycle can
in fact be used without it (this is also why static build works). See
[this blog post](https://insertafter.com/en/blog/unobstrusive_dependency_injection_with_knifecycle.html)
for more context about this statement.

## Features

- services management: start services taking their dependencies in count and
  shut them down the same way for graceful exits (namely dependency injection
  with inverted control),
- singleton: maintain singleton services across several running execution silos,
- easy end to end testing: just replace your services per your own mocks and
  stubs while ensuring your application integrity between testing and
  production,
- isolation: isolate processing in a clean manner, per concerns;
- functional programming ready: encapsulate global states allowing the rest of
  your application to be purely functional,
- no circular dependencies for services: circular dependencies are creating dead
  locks, `knifecycle` impeach that while providing an `$injector` service à la
  Angular to allow accessing existing services references if you really need to,
- generate Mermaid graphs of the dependency tree,
- auto-detect injected services names,
- build raw initialization modules to avoid embedding Knifecycle in your builds,
- optionally autoload services dependencies with custom logic.

You can find all Knifecycle compatible modules on NPM with the
[knifecycle keyword](https://www.npmjs.com/search?q=keywords:knifecycle).

## Usage

Using `knifecycle` is all about declaring the services our application needs and
running your application over it.

Let's say we are building a CLI script. Here is how we would proceed with
Knifecycle:

```js
// bin.js
import { readFile } from 'node:fs/promises';
import { YError } from 'YError';
import { Knifecycle, initializer, constant, inject, name } from 'knifecycle';

// First of all we create a new Knifecycle instance
const $ = new Knifecycle();

// Some of our code with rely on the process environment
// let's inject it as a constant instead of directly
// picking env vars in `process.env` to make our code
// easily testable
$.register(constant('ENV', process.env));

// Let's do so for CLI args with another constant
// in real world apps we would have created a service
// that would parse args in a complexer way
$.register(constant('ARGS', process.argv));

// We want our CLI tool to rely on some configuration
// Let's build an injectable service initializer that
// reads environment variables via an injected but
// optional `ENV` object
// In a real world app, you may use the
// `application-services` module services instead.
async function initConfig({ ENV = { CONFIG_PATH: '.' } }) {
  const data = JSON.parse(await readFile(ENV.CONFIG_PATH, 'utf-8'));
}

// We are using the `initializer` decorator to
// declare our service initializer specificities
// and register it with our Knifecycle instance
$.register(
  initializer(
    {
      // we have to give our final service a name
      // for further use in other services injections
      name: 'CONFIG',
      // we will need an `ENV` variable in the initializer
      // so adding it in the injected dependencies. The `?`
      // sign tells Knifecycle that the ENV dependency
      // is optional
      inject: ['?ENV'],
      // our initializer is simple so we use the `service`
      // type for the initializer which just indicate that
      // the initializer will return a promise of the actual
      // service
      type: 'service',
      // We don't want to read the config file every time we
      // inject it so declaring it as a singleton
      singleton: true,
    },
    initConfig,
  ),
);

// Our CLI also uses a database so let's write an
// initializer for it (in a real world app you
// can use `postgresql-service` instead):
const initDB = initializer(
  {
    name: 'db',
    // Here we are injecting the previous `CONFIG` service
    // as required so that our DB cannot be connected without
    // having a proper config.
    inject: ['CONFIG', 'DB_URI', '?log'],
    // The initializer type is slightly different. Indeed,
    // we need to manage the database connection errors
    // and wait for it to flush before shutting down the
    // process.
    // A service provider returns a promise of a provider
    // descriptor exposing:
    // - a mandatory `service` property containing the
    // actual service;
    // - an optional `dispose` function allowing to
    // gracefully close the service;
    // - an optional `fatalErrorPromise` property to
    // handle the service unrecoverable failure.
    type: 'provider',
    singleton: true,
  },
  async ({ CONFIG, DB_URI, log }) => {
    const db = await MongoClient.connect(DB_URI, CONFIG.databaseOptions);
    let fatalErrorPromise = new Promise((resolve, reject) => {
      db.once('error', reject);
    });

// Logging only if the `log` service is defined
    log && log('info', 'db service initialized!');

return {
      service: db,
      dispose: db.close.bind(db, true),
      fatalErrorPromise,
    };
  },
);

// Here we are registering our initializer apart to
// be able to reuse it, we also declare the required
// DB_URI constant it needs
$.register(constant('DB_URI', 'postgresql://xxxx'));
$.register(initDB);

// Say we need to use two different DB server
// We can reuse our initializer by tweaking
// some of its properties
$.register(constant('DB_URI2', 'postgresql://yyyy'));
$.register(
  // First we remap the injected dependencies. It will
  // take the `DB_URI2` constant and inject it as
  // `DB_URI`
  inject(
    ['CONFIG', 'DB_URI2>DB_URI', '?log'],
    // Then we override its name to make it
    // available as a different service
    name('db2', initDB),
  ),
);

// A lot of NodeJS functions have some side effects
// declaring them as constants allows you to easily
// mock/monitor/patch it. The `common-services` NPM
// module contains a few useful ones
$.register(constant('now', Date.now.bind(Date)))
  .register(constant('log', console.log.bind(console)))
  .register(constant('exit', process.exit.bind(process)));

// Finally, let's declare an `$autoload` service
// to allow us to load only the initializers needed
// to run the given commands
$.register(
  initializer(
    {
      name: '$autoload',
      type: 'service',
      inject: ['CONFIG', 'ARGS'],
      // Note that the auto loader must be a singleton
      singleton: true,
    },
    async ({ CONFIG, ARGS }) =>
      async (serviceName) => {
        if ('command' !== serviceName) {
          // Allows to signal that the dependency is not found
          // so that optional dependencies doesn't impeach the
          // injector to resolve the dependency tree
          throw new YError('E_UNMATCHED_DEPENDENCY', [serviceName]);
        }
        try {
          const path = CONFIG.commands + '/' + ARGS[2];
          return {
            path,
            initializer: require(path).default,
          };
        } catch (err) {
          throw new Error(`Cannot load ${serviceName}: ${ARGS[2]}!`);
        }
      },
  ),
);

// At this point, nothing is running. To instantiate the
// services, we have to create an execution silo using
// them. Note that we required the `$instance` service
// implicitly created by `knifecycle`
$.run(['command', '$instance', 'exit', 'log'])
  // Here, command contains the initializer eventually
  // found by automatically loading a NodeJS module
  // in the above `$autoload` service. The db connection
  // will only be instantiated if that command needs it
  .then(async ({ command, $instance, exit, log }) => {
    try {
      command();

log('It worked!');
    } catch (err) {
      log('It failed!', err);
    } finally {
      // Here we ensure every db connections are closed
      // properly. We could have use `$.destroy()` the same
      // way but this is to illustrate that the Knifecycle
      // instance can be injected in services contexts
      // (rarely done but good to know it exists)
      await $instance.destroy().catch((err) => {
        console.error('Could not exit gracefully:', err);
        exit(1);
      });
    }
  })
  .catch((err) => {
    console.error('Could not launch the app:', err);
    process.exit(1);
  });
```

Running the following should make the magic happen:

```sh
cat "{ commands: './commands'}" > config.json
DEBUG=knifecycle CONFIG_PATH=./config.json node -r @babel/register bin.js my_command test
// Prints: Could not launch the app: Error: Cannot load command: my_command!
// (...stack trace)
```

Or at least, we still have to create commands, let's create the `my_command`
one:

```js
// commands/my_command.js
import { initializer } from './dist';

// A simple command that prints the given args
export default initializer(
  {
    name: 'command',
    type: 'service',
    // Here we could have injected whatever we declared
    // in the previous file: db, now, exit...
    inject: ['ARGS', 'log'],
  },
  async ({ ARGS, log }) => {
    return () => log('Command args:', ARGS.slice(2));
  },
);
```

So now, it works:

```sh
DEBUG=knifecycle CONFIG_PATH=./config.json node -r @babel/register bin.js my_command test
// Prints: Command args: [ 'my_command', 'test' ]
// It worked!
```

This is a very simple example but you can find a complexer CLI usage with
(`metapak`)[https://github.com/nfroidure/metapak/blob/main/src/index.ts] and
(`jsarch`)[https://github.com/nfroidure/jsarch/blob/main/src/index.ts].

## Auto detection

Knifecycle also provide some utility function to automatically assign the
initializer property declarations, the following 3 ways to declare the `getUser`
service are equivalent:

```js
import noop from 'noop';
import { autoInject, inject, initializer, autoService } from 'knifecycle';

initializer({
  name: 'getUser',
  inject: ['db', '?log'],
  type: 'service',
}, getUser);

service('getUser', autoInject(getUser)));

autoService(getUser);

async function getUser({ db, log = noop}) {}
```

That said, if you need to build your code with `webpack`/`babel` you may have to
convert auto-detections to raw declarations with the
[babel-plugin-knifecycle](https://github.com/nfroidure/babel-plugin-knifecycle)
plugin. You can also do this only for the performance improvements it brings.

Also, keep in mind that the auto-detection is based on a simple regular
expression so you should care to keep initializer signatures simple to avoid
having a `E_AUTO_INJECTION_FAILURE` error. As a rule of thumb, avoid setting
complex default values.

```js
// Won't work
autoInject(async ({ log = () => {} }) => {});

// Will work
function noop() {}
autoInject(async ({ log = noop }) => {});
```

## Debugging

Simply use the DEBUG environment variable by setting it to 'knifecycle':

```sh
DEBUG=knifecycle npm t
```

The output is very verbose but lead to a deep understanding of mechanisms that
take place under the hood.

## Plans

The scope of this library won't change. However the plan is:

- improve performances;
- track bugs ;).

I'll also share most of my own initializers and their stubs/mocks in order to
let you reuse it through your projects easily. Here are the current projects
that use this DI lib:

- [common-services](https://github.com/nfroidure/common-services): contains the
  services I use the most in my apps,
- [memory-kv-store](https://github.com/nfroidure/memory-kv-store): a simple in
  memory key-value store,
- [whook](https://github.com/nfroidure/whook): a framework to build REST web
  services.
- [postgresql-service](https://github.com/nfroidure/postgresql-service): a
  simple wrapper around the `pg` module,
- [jwt-service](https://github.com/nfroidure/jwt-service): a simple wrapper
  around the `jwt` module to simplify its use,
- [ftp-service](https://github.com/nfroidure/ftp-service): a FTP client with
  clean defaults.

Notice that those modules remains usable without using Knifecycle at all which
is maybe the best feature of this library 😉.

[//]: # (::contents:end)

# API
## Functions

<dl>
<dt><a href="#initInitializerBuilder">initInitializerBuilder(services)</a> ⇒ <code>Promise.&lt;function()&gt;</code></dt>
<dd>Instantiate the initializer builder service
</dd>
<dt><a href="#initDispose">initDispose()</a></dt>
<dd>Allow to dispose the services of an
initialized silo content.
</dd>
<dt><a href="#constant">constant(name, value)</a> ⇒ <code>function</code></dt>
<dd>Decorator that creates an initializer for a constant value
</dd>
<dt><a href="#service">service(serviceBuilder, [name], [dependencies], [singleton], [extra])</a> ⇒ <code>function</code></dt>
<dd>Decorator that creates an initializer from a service builder
</dd>
<dt><a href="#autoService">autoService(serviceBuilder)</a> ⇒ <code>function</code></dt>
<dd>Decorator that creates an initializer from a service
 builder by automatically detecting its name
 and dependencies
</dd>
<dt><a href="#provider">provider(providerBuilder, [name], [dependencies], [singleton], [extra])</a> ⇒ <code>function</code></dt>
<dd>Decorator that creates an initializer for a provider
 builder
</dd>
<dt><a href="#autoProvider">autoProvider(providerBuilder)</a> ⇒ <code>function</code></dt>
<dd>Decorator that creates an initializer from a provider
 builder by automatically detecting its name
 and dependencies
</dd>
<dt><a href="#parseDependencyDeclaration">parseDependencyDeclaration(dependencyDeclaration)</a> ⇒ <code>Object</code></dt>
<dd>Explode a dependency declaration an returns its parts.
</dd>
<dt><a href="#stringifyDependencyDeclaration">stringifyDependencyDeclaration(dependencyDeclarationParts)</a> ⇒ <code>String</code></dt>
<dd>Stringify a dependency declaration from its parts.
</dd>
</dl>

## initInitializerBuilder(services) ⇒ <code>Promise.&lt;function()&gt;</code>
Instantiate the initializer builder service

**Kind**: global function 
**Returns**: <code>Promise.&lt;function()&gt;</code> - A promise of the buildInitializer function

| Param | Type | Description |
| --- | --- | --- |
| services | <code>Object</code> | The services to inject |
| services.$autoload | <code>Object</code> | The dependencies autoloader |

**Example**  
```js
import initInitializerBuilder from 'knifecycle/dist/build';

const buildInitializer = await initInitializerBuilder({
 $autoload: async () => {},
});
```
<a name="initInitializerBuilder..buildInitializer"></a>

### initInitializerBuilder~buildInitializer(dependencies) ⇒ <code>Promise.&lt;String&gt;</code>
Create a JavaScript module that initialize
a set of dependencies with hardcoded
import/awaits.

**Kind**: inner method of [<code>initInitializerBuilder</code>](#initInitializerBuilder) 
**Returns**: <code>Promise.&lt;String&gt;</code> - The JavaScript module content

| Param | Type | Description |
| --- | --- | --- |
| dependencies | <code>Array.&lt;String&gt;</code> | The main dependencies |

**Example**  
```js
import initInitializerBuilder from 'knifecycle/dist/build';

const buildInitializer = await initInitializerBuilder({
  $autoload: async () => {},
});

const content = await buildInitializer(['entryPoint']);
```
<a name="initDispose"></a>

## initDispose()
Allow to dispose the services of an
initialized silo content.

**Kind**: global function 
<a name="constant"></a>

## constant(name, value) ⇒ <code>function</code>
Decorator that creates an initializer for a constant value

**Kind**: global function 
**Returns**: <code>function</code> - Returns a new constant initializer

| Param | Type | Description |
| --- | --- | --- |
| name | <code>String</code> | The constant's name. |
| value | <code>any</code> | The constant's value |

**Example**  
```js
import Knifecycle, { constant, service } from 'knifecycle';

const { printAnswer } = new Knifecycle()
  .register(constant('THE_NUMBER', value))
  .register(constant('log', console.log.bind(console)))
  .register(service(
    async ({ THE_NUMBER, log }) => () => log(THE_NUMBER),
    'printAnswer',
    ['THE_NUMBER', 'log'],
  ))
  .run(['printAnswer']);

printAnswer(); // 42
```
<a name="service"></a>

## service(serviceBuilder, [name], [dependencies], [singleton], [extra]) ⇒ <code>function</code>
Decorator that creates an initializer from a service builder

**Kind**: global function 
**Returns**: <code>function</code> - Returns a new initializer

| Param | Type | Description |
| --- | --- | --- |
| serviceBuilder | <code>function</code> | An async function to build the service |
| [name] | <code>String</code> | The service's name |
| [dependencies] | <code>Array.&lt;String&gt;</code> | The service's injected dependencies |
| [singleton] | <code>Boolean</code> | Whether the service is a singleton or not |
| [extra] | <code>any</code> | Eventual extra information |

**Example**  
```js
import Knifecycle, { constant, service } from 'knifecycle';

printAnswer(); // 42
```
<a name="autoService"></a>

## autoService(serviceBuilder) ⇒ <code>function</code>
Decorator that creates an initializer from a service
 builder by automatically detecting its name
 and dependencies

**Kind**: global function 
**Returns**: <code>function</code> - Returns a new initializer

| Param | Type | Description |
| --- | --- | --- |
| serviceBuilder | <code>function</code> | An async function to build the service |

## provider(providerBuilder, [name], [dependencies], [singleton], [extra]) ⇒ <code>function</code>
Decorator that creates an initializer for a provider
 builder

**Kind**: global function 
**Returns**: <code>function</code> - Returns a new provider initializer

| Param | Type | Description |
| --- | --- | --- |
| providerBuilder | <code>function</code> | An async function to build the service provider |
| [name] | <code>String</code> | The service's name |
| [dependencies] | <code>Array.&lt;String&gt;</code> | The service's dependencies |
| [singleton] | <code>Boolean</code> | Whether the service is a singleton or not |
| [extra] | <code>any</code> | Eventual extra information |

**Example**  
```js
import Knifecycle, { provider } from 'knifecycle'
import { readFile } from 'node:fs/promises';

const $ = new Knifecycle();

$.register(provider(configProvider, 'config'));

async function configProvider() {
  const config = JSON.parse(
    await readFile('config.js', 'utf-8')
  );

return {
 service: config,
 };
}
```
<a name="autoProvider"></a>

## autoProvider(providerBuilder) ⇒ <code>function</code>
Decorator that creates an initializer from a provider
 builder by automatically detecting its name
 and dependencies

**Kind**: global function 
**Returns**: <code>function</code> - Returns a new provider initializer

| Param | Type | Description |
| --- | --- | --- |
| providerBuilder | <code>function</code> | An async function to build the service provider |

## parseDependencyDeclaration(dependencyDeclaration) ⇒ <code>Object</code>
Explode a dependency declaration an returns its parts.

**Kind**: global function 
**Returns**: <code>Object</code> - The various parts of it

| Param | Type | Description |
| --- | --- | --- |
| dependencyDeclaration | <code>String</code> | A dependency declaration string |

**Example** 
```js
parseDependencyDeclaration('pgsql>db');
// Returns
{
 serviceName: 'pgsql',
 mappedName: 'db',
 optional: false,
}
```
<a name="stringifyDependencyDeclaration"></a>

## stringifyDependencyDeclaration(dependencyDeclarationParts) ⇒ <code>String</code>
Stringify a dependency declaration from its parts.

**Kind**: global function 
**Returns**: <code>String</code> - The various parts of it

| Param | Type | Description |
| --- | --- | --- |
| dependencyDeclarationParts | <code>Object</code> | A dependency declaration string |

**Example**  
```js
stringifyDependencyDeclaration({
  serviceName: 'pgsql',
  mappedName: 'db',
  optional: false,
});

// Returns
'pgsql>db'
```

# Authors
- [Nicolas Froidure](http://insertafter.com/en/index.html)

# License
[MIT](https://github.com/nfroidure/knifecycle/blob/main/LICENSE)

knifecycle

knifecycle Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

knifecycle

knifecycle Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README