nfroidure / knifecycle Goto Github PK

The $.constant,$.service,$.initializer methods can be replaced by coupling $.register and initializer, service, constant decorators that would make it more composable and flexible.

Feature description

Instead of using $.depends which is a function, it is maybe better to use $inject since it is more known and may be more understood.

It will introduce breaking changes.

Use cases

I often end up creating files that exports a function like this which introduce a lot of boilerplate only to allow customizing services/deps name:

module.exports = initDBService;

function initDBService($, name='db', dependencies=['ENV']) {
  return $.service(name, $depends(dbService));
}

function dbService({ ENV }) {
/// actual service code
}

Which is later used like this:

import initDBService from 'db';
import $ from 'knifecycle/instance';

initDBService($);

It would be more concise to do this:

module.exports = dbService;

dbService.$inject = ['ENV'];

function dbService({ ENV }) {
/// actual service code
}

And use it that way:

import dbService from 'db';
import $ from 'knifecycle/instance';

$.service('db', dbService);

// Optionnally change deps
const customDBService = dbService.bind();
customDBService.$inject = ['CONFIG:ENV'];
$.service('customDB', customDBService);

The only con is that some people could forget the bind and this would create some weird behaviors.

• I will do it

Currently the mapping symbol is :. It unfortunately do not tells the direction in which the map takes places leading to constant lookup of the doc.

Maybe that > would be a better fit ?

This would be a breaking change so will wait the 2.0.0 version to do so.

The devDependency browserify was updated from 16.2.3 to 16.3.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

browserify is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

Feature request

Feature description

Allow to flag dependencies as optionnal: ?myOptionnalService

Use cases

Optionnal debugging service, optionnal ENV/CONSTANTS.

[x] I will do it

Follow up to https://twitter.com/nfroidure/status/865478307826946048

This project creates a tight link with the library instead of using the module system and functions while making testing harder. Why not just pass an rootContext down through the functions?

App.js

/**
 * @flow
 */
const AppLogger = require('./AppLogger')
import type { appLogger } from './AppLogger'
const Server = require('./Server')

type rootContext = {
  env: {
    LOGFILE: string,
    PORT: string,
  },
  now: () => number,
  logger: appLogger,
}

const main = async () => {
  if (
    typeof process.env.LOGFILE !== 'string' ||
    typeof process.env.PORT !== 'string'
  ) {
    return
  }
  const rootContext: rootContext = {
    env: process.env,
    now: () => Date.now(),
    logger: AppLogger.make(process.env.LOGFILE),
  }
  const server = await Server.make(rootContext)
}

main()

AppLogger.js

/**
 * @flow
 */
const Logger = require('logger')

export type appLogger = {
  +log: (info: 'info', string: string, ...args: Array<number | string>) => void,
}

exports.make = (outPath: string) => Logger.createLogger(outPath)

GetTimeRoute.js

/**
 * @flow
 */
import type { appLogger } from './AppLogger'

type rootContext = {
  +now: () => number,
  +logger: appLogger,
}

exports.make = (rootContext: rootContext) => (
  req: express$Request,
  res: express$Response,
  next: express$NextFunction
) => {
  const currentTime = rootContext.now()
  rootContext.logger.log('info', 'Sending the current time:', currentTime)
  res.status(200).end(String(currentTime))
}

Server.js

/**
 * @flow
 */
const express = require('express')
const GetTimeRoute = require('./GetTimeRoute')
import type { appLogger } from './AppLogger'

type rootContext = {
  +env: {
    +PORT: string,
  },
  +now: () => number,
  +logger: appLogger,
}

exports.make = async (rootContext: rootContext) => {
  const app = express()
  app.get('/time', GetTimeRoute.make(rootContext))
  const server = await new Promise(resolve =>
    app.listen(rootContext.env.PORT, resolve)
  )
  rootContext.logger.log(
    'info',
    'server listening on port ' + rootContext.env.PORT + '!'
  )
  return server
}

The $inject, $shutdown, $dispose, $autoload and $instance internal services should be documented and their interface should be specified in the types definitions.

It is better for reusability to use the decorators.

Some bad naming choices were made, the 2.0.0 breaking changes is a good occasion to bring better names:

• $shutdown would be better named $dispose
• $shutdownAll would be better named $destroy
• $fatalError should be renamed $fatalErrorPromise

There have been updates to the babel7 monorepo:

• • The devDependency @babel/cli was updated from 7.1.0 to 7.1.1.

• The devDependency @babel/core was updated from 7.1.0 to 7.1.1.
• The devDependency @babel/preset-env was updated from 7.0.0 to 7.1.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

This monorepo update includes releases of one or more dependencies which all belong to the babel7 group definition.

babel7 is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

When a batch initialize several services, we should do it in parallel:
https://github.com/nfroidure/knifecycle/blob/master/src/build.mocha.js#L79-L84

Maybe only allow override for unused services?
May worth to add a way to know if a service is already set with the given name.

Good explanations of the difference between constant, register and provider. Also explain how it relates to the initializer concept and the steps involved on bringing life to dependencies.

Would be nice to allow to specify that the injector is used in singleton context to avoid loading non-singletons into singletons.

Version 3.0.1 of jsdoc-to-markdown was just published.

This version is covered by your current version range and after updating it in your project the build failed.

jsdoc-to-markdown is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

Currently the handler util uses autoInject and autoName under the hood but it may be a mistake. Indeed, if we use Babel to replace auto-detections by their raw usage for perf reasons, we could use autoHandler and replace those calls with handler ones.

Such Babel transformation would change this:

import { autoHandler } from 'knifecycle';

export default autoHandler(async getUser({ db }, { userId})) {});

into

import { handler } from 'knifecycle';

export default handler('getUser', ['user'], async getUser({ db }, { userId})) {})

leading to better performances since handler would not attempt any auto-detection then.

The devDependency metapak was updated from 3.1.1 to 3.1.2.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

metapak is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

By detecting an equal sign, we should be able to auto detect optional dependencies (ie, log = noop gives '?log' dep).

Feature description

Currently adding extra infos can be done by adding properties to functions
but it won't be replicated by the various helpers Knifecyle provides.

For that matter, creating an _extra special props could lead to more flexibility.

Use cases

For example, in my Swagger HTTP Router
project, I could add extra informations like OAuth roles, CORS etc... to handlers so that
the router initialisation could reuse it to add some additionnel logic on their basis.

• I will/have implement the feature

The devDependency sinon was updated from 7.3.0 to 7.3.1.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

sinon is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

The devDependency eslint-plugin-prettier was updated from 3.0.1 to 3.1.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

eslint-plugin-prettier is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

In order to dynamically load dependencies code, allow to provide an $autoload service to automatically load initializers code could be nice and fit well to embrace SystemJS modules.

Would be nice to know which services were not used in order to have insights on what could be cleaned up.

The devDependency metapak-nfroidure was updated from 7.1.2 to 7.2.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

metapak-nfroidure is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

This commit do not solves every possible error:
8cfcabd

TypeError for example but maybe more errors ain't throwed back and lead to unexpected behaviors.

Maybe check for a single error code instead of white listing a set of common errors... Options to specify the error codes that should be ignored may be the best solution.

There have been updates to the babel7 monorepo:

• • The devDependency @babel/cli was updated from 7.1.2 to 7.1.5.

• The devDependency @babel/core was updated from 7.1.5 to 7.1.6.
• The devDependency @babel/preset-env was updated from 7.1.5 to 7.1.6.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

This monorepo update includes releases of one or more dependencies which all belong to the babel7 group definition.

babel7 is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

Seems that service mapping does not work for it (ie: $injector(['srv>srvMapped']) returns a srvMapped property instead of a srv one.

Also, should allow injector to autoload services and warn instead of fail here: https://github.com/nfroidure/knifecycle/blob/master/src/index.js#L638

Finally a small refactor to isolate the $injector in its own file if possible would be nice.

Version 10 of Node.js (code name Dubnium) has been released! 🎊

To see what happens to your code in Node.js 10, Greenkeeper has created a branch with the following changes:

• Added the new Node.js version to your .travis.yml
• The new Node.js version is in-range for the engines in 1 of your package.json files, so that was left alone

If you’re interested in upgrading this repo to Node.js 10, you can open a PR with these changes. Please note that this issue is just intended as a friendly reminder and the PR as a possible starting point for getting your code running on Node.js 10.

Your Greenkeeper Bot 🌴

The devDependency karma-browserify was updated from 6.0.0 to 6.1.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

karma-browserify is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

Version 2.1.0 of cz-conventional-changelog was just published.

This version is covered by your current version range and after updating it in your project the build failed.

cz-conventional-changelog is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

It could make the build simpler to ut the Knifecycle environment and autoloader instead of relying on a constants hash and an autoloader function.

Currently, for simplicity, the constants are casted into initializers https://github.com/nfroidure/knifecycle/blob/master/src/index.js#L204-L213

It would be more performant to create a separate flow for handling constants and it also would better fit the build that uses a different flow for those constants: https://github.com/nfroidure/knifecycle/blob/master/src/build.js#L40

Often having that kind of boilerplate code:

module.exports = initializer({
  name: getMovingDevicesMails.name,
  type: 'service',
  inject: [
    'getMovingDevices',
    'elasticSearch', '?log',
  ],
}, (...args) => Promise.resolve(
  getMovingDevicesMails.bind(null, ...args)
));

That could be simplified like so:

module.exports = handler(getMovingDevicesMails, [
  'getMovingDevices',
  'elasticSearch', '?log',
]);

There have been updates to the babel7 monorepo:

• • The devDependency @babel/cli was updated from 7.1.1 to 7.1.2.

• The devDependency @babel/core was updated from 7.1.1 to 7.1.2.
• The devDependency @babel/preset-env was updated from 7.0.0 to 7.1.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

This monorepo update includes releases of one or more dependencies which all belong to the babel7 group definition.

babel7 is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

I am not a big fan of chaining features but since Knifecycle is an OOP thing it may make sense to make it methods chainable.

Just spend time on debugging the following case:

$.constant('x',  $.depends(['y'], () -> { }));

A simple check for function given to constant with dependencies and a nice error would have saved me some time.

Also, find some time to check bad definitions like this one:

$.service('x',  $.depends(['x'], () -> { }));

Check for the use case of needing a servicePromise property on service initializers, looks like it doesn't make sense.

Also check for the necessity of having two imbrications of promises for the providers.

A singleton service instance is available across multiple running silos. It is maintained in a WeakMap in order to avoid spawning multiple instances of a service while ensuring unused services can still be garbage collected.

import { depends, service } from './knifecycle';
import LoggerService from 'logger';

service('logger', depends('stdout', LoggerService), { singleton: true });

Consider checking singleton dependencies are also singletons, not sure it is that important, but with no use case for singleton depending on non-singleton, it may help prevent programming errors.

Feature description

To be DRY, some knifecycle friendly libs will benefit from those exports while expressing the dependency to Knifecycle in a declarative way.

Use cases

$inject and other $ prefixed props, the optional/mapping symbols, the dependency declaration parser and available errors.

The devDependency sinon was updated from 7.2.5 to 7.2.6.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

sinon is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴