@betit/orion-node-sdk
Version:
SDK for orion
333 lines (317 loc) • 19.2 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>@betit/orion-node-sdk</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="assets/js/search.js" data-base=".">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">@betit/orion-node-sdk</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="globals.html">Globals</a>
</li>
</ul>
<h1> @betit/orion-node-sdk</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<p><a href="https://www.npmjs.com/package/@betit/orion-node-sdk"><img src="https://badge.fury.io/js/%40betit%2Forion-node-sdk.svg" alt="NPM version"></a>
<a href="https://travis-ci.org/GiG/orion-node-sdk"><img src="https://travis-ci.org/GiG/orion-node-sdk.svg?branch=master" alt="Build Status"></a>
<a href="https://coveralls.io/github/GiG/orion-node-sdk"><img src="https://coveralls.io/repos/github/GiG/orion-node-sdk/badge.svg" alt="Test coverage"></a>
<a href="https://greenkeeper.io/"><img src="https://badges.greenkeeper.io/gig/orion-node-sdk.svg" alt="Greenkeeper badge"></a></p>
<a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
<h2>Installation</h2>
</a>
<pre><code class="language-sh">$ npm install @betit/orion-node-sdk</code></pre>
<a href="#basic-example" id="basic-example" style="color: inherit; text-decoration: none;">
<h2>Basic example</h2>
</a>
<a href="#note---you-will-need-to-have-running-all-of-the-orion-a-hrefhttpsgithubcomgigoriondependenciesa" id="note---you-will-need-to-have-running-all-of-the-orion-a-hrefhttpsgithubcomgigoriondependenciesa" style="color: inherit; text-decoration: none;">
<h3>Note - You will need to have running all of the orion <a href="https://github.com/gig/orion">dependencies</a></h3>
</a>
<p>Add the following into <code>foo.js</code> and then run <code>VERBOSE=true node foo.js</code></p>
<pre><code class="language-js"><span class="hljs-keyword">const</span> ORION = <span class="hljs-built_in">require</span>(<span class="hljs-string">'@betit/orion-node-sdk'</span>);
<span class="hljs-keyword">const</span> FOO = <span class="hljs-keyword">new</span> ORION.Service(<span class="hljs-string">'foo'</span>);
FOO.handle(<span class="hljs-string">'get'</span>, (req, reply) => {
reply(<span class="hljs-keyword">new</span> ORION.Response(<span class="hljs-string">'foo'</span>));
});
FOO.listen(<span class="hljs-function"><span class="hljs-params">()</span> =></span> FOO.logger.createMessage(<span class="hljs-string">'ready'</span>).send());</code></pre>
<p>Then add the following into <code>bar.js</code> and then run <code>node bar.js</code></p>
<pre><code class="language-js"><span class="hljs-keyword">const</span> ORION = <span class="hljs-built_in">require</span>(<span class="hljs-string">'@betit/orion-node-sdk'</span>);
<span class="hljs-keyword">const</span> BAR = <span class="hljs-keyword">new</span> ORION.Service(<span class="hljs-string">'bar'</span>);
<span class="hljs-keyword">const</span> REQ = <span class="hljs-keyword">new</span> ORION.Request(<span class="hljs-string">'/foo/get'</span>);
BAR.call(REQ, res => {
<span class="hljs-comment">// do stuff</span>
});</code></pre>
<p>You can find more detailed examples in the <code>examples</code> folder.</p>
<a href="#async-example" id="async-example" style="color: inherit; text-decoration: none;">
<h2>Async example</h2>
</a>
<p>This utility also supports functionality with Promises, so the following code can be also used:</p>
<pre><code class="language-js"><span class="hljs-keyword">const</span> ORION = <span class="hljs-built_in">require</span>(<span class="hljs-string">'@betit/orion-node-sdk'</span>);
<span class="hljs-keyword">const</span> FOO = <span class="hljs-keyword">new</span> ORION.Service(<span class="hljs-string">'foo'</span>);
FOO.handle(<span class="hljs-string">'get'</span>, <span class="hljs-keyword">async</span> (req) => {
<span class="hljs-keyword">return</span> <span class="hljs-keyword">new</span> ORION.Response(<span class="hljs-string">'foo'</span>);
});
<span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">initFOO</span>(<span class="hljs-params"></span>) </span>{
<span class="hljs-keyword">await</span> FOO.listen();
FOO.logger.createMessage(<span class="hljs-string">'ready'</span>).send()
}
init().then(exit);</code></pre>
<p>And in <code>bar.js</code>:</p>
<pre><code class="language-js"><span class="hljs-keyword">const</span> ORION = <span class="hljs-built_in">require</span>(<span class="hljs-string">'@betit/orion-node-sdk'</span>);
<span class="hljs-keyword">const</span> BAR = <span class="hljs-keyword">new</span> ORION.Service(<span class="hljs-string">'bar'</span>);
<span class="hljs-keyword">const</span> REQ = <span class="hljs-keyword">new</span> ORION.Request(<span class="hljs-string">'/foo/get'</span>);
<span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">main</span>(<span class="hljs-params"></span>) </span>{
<span class="hljs-keyword">const</span> res = <span class="hljs-keyword">await</span> BAR.call(REQ);
<span class="hljs-comment">// do stuff</span>
}
main().then(exit);</code></pre>
<p>Also, subscriptions can now be looped forever using: </p>
<pre><code class="language-js"><span class="hljs-keyword">const</span> ORION = <span class="hljs-built_in">require</span>(<span class="hljs-string">'@betit/orion-node-sdk'</span>);
<span class="hljs-keyword">const</span> BAR = <span class="hljs-keyword">new</span> ORION.Service(<span class="hljs-string">'bar'</span>);
<span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">processEvents</span>(<span class="hljs-params"></span>) </span>{
<span class="hljs-keyword">const</span> producer = BAR.onAsync(<span class="hljs-string">"event"</span>);
<span class="hljs-keyword">while</span> (<span class="hljs-literal">true</span>) {
<span class="hljs-keyword">const</span> event = <span class="hljs-keyword">await</span> producer.consume();
}
}
...</code></pre>
<a href="#health-checks" id="health-checks" style="color: inherit; text-decoration: none;">
<h2>Health checks</h2>
</a>
<p>Support for health checking is present if the services are running with the environment variable <code>WATCHDOG=true</code>. Also,
a <a href="https://github.com/GiG/orion-watchdog">watchdog</a> must be running in the same environment as the service.</p>
<p>You can write a network health check as:</p>
<pre><code class="language-ts"><span class="hljs-keyword">const</span> ping = <span class="hljs-built_in">require</span>(<span class="hljs-string">'ping'</span>);
<span class="hljs-keyword">const</span> host = <span class="hljs-string">'1.1.1.1'</span>;
<span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">checkNetwork</span>(<span class="hljs-params"></span>): <span class="hljs-title">Promise</span><[<span class="hljs-title">string</span>, <span class="hljs-title">OrionError</span> | <span class="hljs-title">undefined</span>]> </span>{
<span class="hljs-keyword">const</span> isAlive = <span class="hljs-keyword">await</span> ping.promise.probe(host);
<span class="hljs-keyword">if</span> (!isAlive) {
<span class="hljs-keyword">return</span> [<span class="hljs-string">`Can't connect to <span class="hljs-subst">${host}</span>`</span>, <span class="hljs-keyword">new</span> OrionError(<span class="hljs-string">'CRIT'</span>)];
} <span class="hljs-keyword">else</span> {
<span class="hljs-keyword">return</span> [<span class="hljs-string">''</span>, <span class="hljs-literal">undefined</span>];
}
}
<span class="hljs-keyword">const</span> healthCheck = {
checkIsWorking: checkNetwork,
name: <span class="hljs-string">'have_I_external_net'</span>,
timeout: <span class="hljs-number">1000</span>,
};
<span class="hljs-keyword">const</span> SERVICE = <span class="hljs-keyword">new</span> Service(<span class="hljs-string">'service_name'</span>);
SERVICE.registerHealthCheck(envDependency);</code></pre>
<a href="#tracer" id="tracer" style="color: inherit; text-decoration: none;">
<h2>Tracer</h2>
</a>
<p>The zipkin tracer is disabled by default and you can enable it using the <code>TRACER_ENABLED</code> env. variable with possible values of <code>1</code> or <code>true</code></p>
<a href="#documentation" id="documentation" style="color: inherit; text-decoration: none;">
<h1>Documentation</h1>
</a>
<p>Auto-generated documentation is located <a href="https://gig.github.io/orion-node-sdk/">here</a>.</p>
<a href="#tests" id="tests" style="color: inherit; text-decoration: none;">
<h2>Tests</h2>
</a>
<p> To run the test suite, first install the dependencies, then run <code>npm test</code>:</p>
<pre><code class="language-bash">$ npm install
$ npm <span class="hljs-built_in">test</span></code></pre>
<a href="#license" id="license" style="color: inherit; text-decoration: none;">
<h2>License</h2>
</a>
<p><a href="https://github.com/GiG/orion-node-sdk/blob/master/LICENSE">MIT</a></p>
</div>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="globals.html"><em>Globals</em></a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_codec_index_.html">"codec/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_codec_json_.html">"codec/json"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_codec_msgpack_.html">"codec/msgpack"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_error_error_.html">"error/error"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_health_health_.html">"health/health"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_health_messages_.html">"health/messages"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_logger_colors_.html">"logger/colors"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_logger_levels_.html">"logger/levels"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_logger_logger_.html">"logger/logger"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_logger_message_.html">"logger/message"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_orion_.html">"orion"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_request_request_.html">"request/request"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_response_response_.html">"response/response"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_service_index_.html">"service/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tracer_tracer_.html">"tracer/tracer"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_transport_index_.html">"transport/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_transport_kafka_.html">"transport/kafka"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_transport_nats_.html">"transport/nats"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_types_interfaces_.html">"types/interfaces"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_utils_asyncarray_.html">"utils/async<wbr>Array"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_utils_index_.html">"utils/index"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
</body>
</html>