README

ClientLinker

Linker all clients whether rpc, addon, http request, mock data, local file ...

A solution to break out of network and OS.

Install

npm install clientlinker --save

Usage

Options

{
  flows: ['logger', 'pkghandler', 'httpproxy'],
  defaults: {
    timeout: 4000
  },
  clients: {
    mail: {
      // modify defaults flows
      flows: ['confighandler', 'httpproxy'],
      confighandler: {
        read: function(query, body, callback, options) {
          callback(null, {content: 'hi,'});
        },
        send: function(query, body, callback, options) {
          return Promise.resolve({id: 'xxxx'});
        }
      }
    },

    // use defaults
    profile: {
      pkghandler: __dirname+'/clients/profile.js'
    }
  }
}

Initialize

// `clientlinker.conf.js` file content

var clientlinker = require('clientlinker');
var linker = clientlinker(options);

// Register flows
linker.flow('confighandler', require('clientlinker-flow-confighandler'));
linker.flow('logger', require('clientlinker-flow-logger'));
linker.flow('httpproxy', require('clientlinker-flow-httpproxy'));
linker.flow('pkghandler', require('clientlinker-flow-pkghandler'));

// Add clients outsid of config step
linker.client(name, clientOptions);

module.exports = linker;

Run

Run in Server

var linker = require('./clientlinker.conf.js');

linker.run('mail.read', userid, {mailid: 'xxxx'}, options)
  .then(function(data){});

Upgrade

11.x.x => 12.0.0

remove andToError
remove ext errinfo of expandError
remove callback param of clientlinker.run and clientlinker.runIn
remove retry event
remove runtime.tmp

10x

Remove deps handlers

runtime.runOptions runtime.methodKey runtime.lastFlow flow.register runtime.getRunnedFlowByName runtime.runnedFlows runtime.isFinished runtime.isStarted linker.add linker.addClient linker.parseMethodKey linker.getFlow linker.runByKey linker.bindFlow linker.loadFlow linker.onInit linker.runInShell

Remove attrs runtime.promise

Remove options option.clientDefaultOptions

Flow not support init callback.

Remove callback handlers of flow.run(runtime, callback)

callback.toFuncCallback callback.reject callback.resolve callback.callback callback.nextAndResolve callback.promise callback.nextRunner

flow.run ret switch to Promise always.

Remove retry event of runtime. Add retry event of linker.

6.x.x => 7.0.0

Remove all sys flow. Please install and loadFlow for httpproxy confighandler pkghandler debugger localfile logger
Move proxyRoute of linker to clientlinker-flow-httpproxy pkg.
anyToError(err, runner) instead of anyToError(err, runtime). You can get runtime with runner.runtime.
err.fromClient instead of err.CLIENTLINKER_CLIENT. err.fromClientMethod install of err.CLIENTLINKER_ACTION.
Remove linker.run().runtime & linker.run().runtimePromise. You can get runtime width linker.lastRuntime after linker.run.

5.x.x => 6.0.0

If flow handler return a Promise, it bind callback auto.
Running callback.next like callback.next(true). Use callback.nextAndResolve() instead of previous caller.

If you do not modify custom flow and use callback.next in flow, the rpc will timeout.

4.x.x => 5.0.0

Please upgrade server first, if you are using httpproxy flow

Usage no npm install needed!