@mia-platform/lc39

Launch Complex 39

The Mia-Platform Node.js service launcher

lc39 is a Command line utility that will launch a Fastify instance configured for serving a Node.js service on Mia-Platform.

Getting Started

Install

To install the package you can run:

npm install @mia-platform/lc39 --save

It is possible to install the next version of the package, which use fastify v3. The version is a release candidate, so it is not yet a stable version and should not be used in production environments (next updates could be breaking). To try it, you can run:

npm install @mia-platform/lc39@next --save

We recommend to install the module locally on every one of your project to be able to update them indipendently one from the other. To use the locally installed instance you have to add the following script to your package.json:

"scripts": {
  "start": "lc39 index.js"
},

To see all the options you can add to the cli run:

npx lc39 --help

Now you are ready to code your mia-platform service!

Documentation

To work properly with lc39 your service main file should follow some rules:

• Main entrypoint
• Service options
• CLI flags
• Development affordance

Changelog

v7.0.0 - 2023-05-11

In this version, is added the support for Fastify v4. To upgrade, read the migration guide.

Metrics options

Metrics options are changed. Below there are the main changes. For other configuration, see here.

• enableDefaultMetrics: boolean --> defaultMetrics: {enabled: boolean}
• pluginName --> name
• enableRouteMetrics --> routeMetrics.enabled: boolean
• groupStatusCodes --> routeMetrics.groupStatusCodes
• invalidRouteGroup --> invalidRouteGroup (default changed from undefined to unknown)
• histogram and summary are moved under routeMetrics.overrides
• blacklist --> routeMetrics.routeBlacklist
• prefix --> defaultMetrics.prefix

Remove node 14 support

node 14 and below are not supported. If you want to use this version of lc39, upgrade node to version 16 and above

Export lc39 as the main function

Export lc39 as the main function exported by the package. This brings two big changes:

• options are internally merged in one single object. See the merge precedence.
• the default exported logLevel is not set to silent by default: this because it is not used only for tests

Changes

• exported lc39 function remove the default log level set to silent, and it is now set to info. This is required since it is possible to configure lc39 also from function and not only from CLI

• forceCloseConnections is set to 'idle' from false in node 18. This means that idle requests are destroyed on server close

• remove errorHandler option as unsupported by fastify-sensible

• migrated @fastify/swagger to v8, so that @fastify/swagger-ui package is now required to continue exposing Swagger UI

• upgraded fastify plugins to support latest fastify version

• upgraded library dependencies

• when you handle streams when using async-await you will need to return or await the reply object:

  fastify.get('/streams', async function (request, reply) {
    const fs = require('fs')
    const stream = fs.createReadStream('some-file', 'utf8')
    reply.header('Content-Type', 'application/octet-stream')
    return reply.send(stream)
  })
  

Added

• add custom error serializer in log for the field error
• add tracing instrumentation with OpenTelemetry in experimental
• export lc39 options