microchassis

Microchassis

This package aims to help you build "simple" microservices in Typescript.

The Connect team at Schuberg Philis is building microservices which use Protobuf and GRPC as a basis and bolt REST on top of that for web usage. This package aims to use the proto as the basis for the service and make it simple to bolt REST on top of that.

It will help you setup health checks, do input validation etc. So that you can focus on implementing the actual business logic.

Getting started

There is an example service in the repo.

You can run this example using ts-node for example:

ts-node service.ts

This will start a really simple service based on the proto file. It will expose the HTTP server on the default 8000 port and the GRPC server on port 9000.

Concepts

This package is working based on a couple of concepts:

• service actual implementation of the GRPC services defined in the proto. The logic of mapping these to a REST endpoint is also contained in them.
• managers managers contain logic used by the services to accomplish their goal.
• providers providers provide an service mostly used by the managers to be able to do their job. Think of a database connections for example. Usually they register themselves with the healthmanager to be incorporated into the service healthcheck

Dependency injection

This framework relies heavily on dependency injection and uses inversify for that. Whenever you need an dependency in your services or managers you should use the constructor to inject it.

You can see an example in the helloservice which gets the HelloManager injected. Notice the @injectable decorator on the manager don't forget this otherwise an error will be thrown.