npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@neohelden/node

v3.0.8

Published

Meta library for common Node.js dependencies necessary / recommended for developing Neo Sentinels.

Downloads

1,410

Readme

Neo SDK: Node.js

Build and Release SDK Quality Gate Status

@neohelden/node

Neo SDK for Node.js with some additional libraries to support the development of Neo Sentinels (NSX).

Terminology

  • Task: A task (or Sentinel Task) is a job processed or created by so called Sentinels.
  • Sentinel: Fancy name for a worker consuming / producing tasks. They are usually not that evil.
  • Particle: All tasks / messages / responses flowing through the Neo internals are generalized as „particles“. Particles can be the payload for tasks, the response to the Neo client or just some metadata. Particles have to be objects.

Installation

yarn add @neohelden/node

Configuration

The Neo SDK can be configured through environment variables (ENVs in short). The following ENVs are supported:

  • NPQ_DISABLE_AUTOCONNECT: Set to true in order to prevent the SDK from autoconnecting.
  • NPQ_NAME: A identifiable name for your Sentinel.
  • NPQ_CA: A base64 encoded CA used for The NATS TLS Option
  • NPQ_CERT: A base64 encoded string used as a client certificate (signed by the NPQ_CA)
  • NPQ_CERT_KEY: A base64 encoded private key belonging to the NPQ_CERT.

Initialization

The SDK comes with its own healthcheck server and admi application. This server allows to dynamically change the logging level and to check the health of the service.

To init it use:

AdminApplication.init('nsx.test');

Tasks

Tasks are an integral part of the Neo plattform.

Requesting information from a Sentinel

This method is not intended to be used anymore since it violates the principles of MQTT messaging. The Pub/Sub model is intended to achieve async messages. However until there are more etablished patterns for the Neo plattform, this method can be used to request information from a Sentinel.

import { TaskConnector } from '@neohelden/node';
import { IsString } from 'class-validator';
import { Expose } from 'class-transformer';

const client = new TaskConnector();

class Transmit {
  @IsString()
  test!: string;
}

class Response {
  @Expose()
  @IsString()
  test!: string;
}

await client.connect();
const response = await client.requestOne('nsx.test', new Transmit(), Response);

console.log(response.test); // 'Hello World'

Receiving tasks

A subscription modal can be achieved in two modes:

  1. Subscriptions which do not respond to messages. These subscriptions are purely informational and are encouraged to be used.
  2. Subscriptions which respond to messages. These subscriptions are discouraged to be used since they violate the principles of MQTT messaging.
import { TaskConnector } from '@neohelden/node';
import { IsString } from 'class-validator';
import { Expose } from 'class-transformer';

const client = new TaskConnector();

class Transmit {
  @IsString()
  test!: string;
}

class Response {
  @Expose()
  @IsString()
  test!: string;
}

await client.connect();

client.subscribe(
  'nsx.test',
  Transmit,
  async (err: Error | null, transmit: Transmit) => {
    // Response will not be used

    console.log(transmit.test); // 'Hello World'
  },
);

client.respondingSubscribe('nsx.test', Transmit, async (transmit: Transmit) => {
  return new Response();
});

Publishing data

By publishing data, a Sentinel can inform other Sentinels about something.

const { TaskConnector } = require('@neohelden/node');

const client = new TaskConnector();

class Transmit {
  @IsString()
  test!: string;
}

await client.connect();

const transmit = new Transmit();
transmit.test = 'Hello World';

await client.publish('nsx.test', transmit);

Health

A service can inform the infrastructure if it is operational or not. This can be achieved using the admin Application. The singelton is responsible for managing logging and health.

import AdminApplication from '../AdminApplication';
import HealthCheckResponse from '../health/HealthCheckResponse';

await AdminApplication.init('nsx.current.name');

await AdminApplication.addHealthProbe({
  call: () => HealthCheckResponse.up('test'),
}); // for health
await AdminApplication.addReadinessProbe({
  call: () => HealthCheckResponse.up('test'),
}); // for readiness

await AdminApplication.stop();

Logging (optional)

Module for logging information (based on pino).

import { LoggerFactory } from '@neohelden/node';

const logger = LoggerFactory.create('my-sentinel');

logger.info('Neo informs.');
logger.warn('Neo warns.');
logger.error('aaaah, houston?');

To change the logging verbosity, set the environment variable LOG_LEVEL. Additionally the logging can be changed while running through an HTTP server located in the ADMIN_PORT || 8081.

Sentry (Exception logging)

import { Sentry } from '@neohelden/node';
sentry.initSentry({
  release: 'v0.1.0',
});