Facets Microservice for Node.js / ES2017 V2

This is a faceted search microservice from Pip.Services library. It allows to search "facets" recorded by other microservices. For instance, statistics microservice can record groups and later use them in counters search.

The microservice currently supports the following deployment options:

• Deployment platforms: Standalone Process
• External APIs: HTTP/REST
• Persistence: Flat Files, MongoDB

This microservice has no dependencies on other microservices.

Quick Links:

• Use
• Run
• Source Documentation
• Development
• Configuration
• Deployment

Contract

Logical contract of the microservice is presented below. For physical implementation (HTTP/REST, Lambda, etc.), please, refer to documentation of the specific protocol.

class FacetV1 {
  public group: string;
  public name: string;
  public count: number;
}

interface IFacetsV1 {
  getFacetsByGroup(context: IContext, group: string): Promise<FacetV1>;

  addFacet(context: IContext, group: string, name: string): Promise<FacetV1>;

  removeFacet(context: IContext, group: string, name: string): Promise<FacetV1>;

  deleteFacetsByGroup(context: IContext, group: string): Promise<void>;

  clear(context: IContext): Promise<void>;
}

Download

Right now the only way to get the microservice is to check it out directly from github repository:

git clone [email protected]:entinco/eic-services-infrastructure.git

Pip.Controller team is working to implement packaging and make stable releases available for your as zip downloadable archieves.

Develop

Environment Setup

This is a Node.js project and you have to install Node.js tools. You can download them from official Node.js website: https://nodejs.org/en/download/

After node is installed you can check it by running the following command:

node -version

Then you need to configure node tools:

# Install typescript compiler
npm install typescript -g

# Install mocha test runner
npm install mocha -g

To work with GitHub code repository you need to install Git from: https://git-scm.com/downloads

If you are planning to develop and test using persistent storages other than flat files you may need to install database servers:

• Download and install MongoDB database from https://www.mongodb.org/downloads

Installing

After your environment is ready you can check out microservice source code from the Github repository:

git clone [email protected]:entinco/eic-services-infrastructure2.git

Then go to the project folder and install dependent modules:

# Install dependencies
npm install

If you worked with the microservice before you can check out latest changes and update the dependencies:

# Update source code updates from github
git pull

# Update dependencies
npm update

Building

This microservice is written in TypeScript language which is transcompiled into JavaScript. So, if you make changes to the source code you need to compile it before running or committing to github. The process will output compiled javascript files into /bin folder.

tsc

When you do continuous edit-build-test cycle, you can run typescript compiler with --watch option to detect and compile changes you make automatically:

tsc --watch

Testing

Before you execute tests you need to set configuration options in config.yml file.

Command to run unit tests:

npm test

You can also execute benchmarks as:

npm run benchmark

Contributing

Developers interested in contributing should read the following instructions:

• How to Contribute
• Guidelines
• Styleguide
• ChangeLog

Please do not ask general questions in an issue. Issues are only to report bugs, request enhancements, or request new features. For general questions and discussions, use the Contributors Forum.

It is important to note that for each release, the ChangeLog is a resource that will itemize all:

• Bug Fixes
• New Features
• Breaking Changes

Configure

Facets microservice configuration structure follows the standard configuration structure.

Persistence

The microservice supports three types of persistence: in-memory, flat files or MongoDB. In-memory and flat files are great for development and testing, while MongoDB is a good option with outstanding performance and scalability, suitable for demanding production installations. You can choose and configure the option that suits your needs.

For more information on this section read Pip.Controllers Configuration Guide

Memory

Memory persistence has the following configuration properties:

• options: object - Misc configuration options
  • max_page_size: number - Maximum number of items per page (default: 100)

Example:

- descriptor: "service-facets:persistence:memory:default:1.0"
  options:
    max_page_size: 100

File

Flat file persistence has the following configuration properties:

• path: string - file path where SystemEventV1 objects are stored. The object are written into the file in JSON format.
• options: object - Misc configuration options
  • max_page_size: number - Maximum number of items per page (default: 100)

Example:

- descriptor: "service-facets:persistence:file:default:1.0"
  path: "./data/facets.json"

MongoDB

MongoDB persistence has the following configuration properties:

• connection(s): object - MongoDB connection properties
• options: object - (optional) MongoDB connection options. See: https://www.mongodb.com/docs/drivers/node/current/fundamentals/connection/ for more details.
• debug: boolean - (optional) Enables or disables connection debugging

Example:

- descriptor: "service-facets:persistence:file:default:1.0"
  connection:
    uri: "mongodb://localhost/pipservicestest"
  options:
    server:
      poolSize: 4
      socketOptions:
        keepAlive: 1
        connectTimeoutMS: 5000
    auto_reconnect: true

Service

Service persistence has the following configuration properties:

• options: object - Misc configuration options
  • max_facet_count: number - Maximum number of recorded facets (default: 100)

Example:

- descriptor: "service-facets:service:default:default:1.0"

Controllers

The controller components (also called endpoints) expose external microservice API for the consumers. Each microservice can expose multiple APIs (HTTP/REST) and multiple versions of the same API type. At least one service is required for the microservice to run successfully.

Http

HTTP/REST controller has the following configuration properties:

• connection: object - HTTP transport configuration options
  • protocol: string - HTTP protocol - 'http' or 'https' (default is 'http')
  • host: string - IP address/hostname binding (default is '0.0.0.0')
  • port: number - HTTP port number

Example:

- descriptor: "service-facets:controller:commandable-http:default:1.0"
  connection:
    protocol: "http"
    host: "0.0.0.0"
    port: 3000

Run

Process

The simplest way to deploy the microservice is to run it as a standalone process. This microservice is implemented in JavaScript and requires installation of Node.js. You can get it from the official site at https://nodejs.org/en/download

Step 1. Download microservices by following instructions

Step 2. Add config.yml file to the config folder and set configuration parameters.

Step 3. Start the microservice using the command:

node ./bin/main.js

Use

The easiest way to work with the microservice is to use library.

Inside your code get the reference to the client library

var sdk = new require("client-facets2-node");

Define client configuration parameters that match configuration of the microservice external API

// Client configuration
var config = {
  connection: {
    protocol: "http",
    host: "localhost",
    port: 8080,
  },
};

Instantiate the client and open connection to the microservice

// Create the client instance
var client = sdk.HttpRestClientV1(config);

// Connect to the microservice
try {
    await client.open(null);
    // Work with the microservice
    ...
} catch(err) {
    console.error('Connection to the microservice failed');
    console.error(err);
}

Now the client is ready to perform operations

// Record facets for a user
let facet = await client.addFacet(null, "statistics", "12234");

// Get the list of user facets
let facets = await client.getFacetsByGroup(null, "statistics");

Acknowledgements

This microservice was created and currently maintained by:

• Sergey Seroukhov
• Danylo Kuznetsov