@platformatic/service 1.16.0 → 1.18.0

package/help/create.txt

@@ -0,0 +1,11 @@
+Creates a new Platformatic Service application.
+
+Options are
+
+* `dir <string>` - the directory where to create the project (Default: `process.cwd() + 'platformatic-composer'`)
+* `port <string>` - the port where the application will listen (Default: `3042`)
+* `hostname <string>` - the hostname where the application will listen (Default: `0.0.0.0`)
+* `git <boolean>` - Init the git repository (Default: `true`)
+* `typescript <boolean>` - Use Typescript (Default: `false`)
+* `install <boolean>` - Run or not `npm install` after creating the files (Default: `true`)
+* `plugin <boolean>` - Creates a sample plugin and tests (Default: `true`)

package/help/help.txt

@@ -1,5 +1,6 @@
 Available commands:
 
+* `create` - creates a new Platformatic Service application.
 * `help` - show this help message.
 * `help <command>` - show more information about a command.
 * `start` - start the server.

package/index.js

@@ -28,6 +28,11 @@ async function platformaticService (app, opts) {
   const beforePlugins = opts.beforePlugins || arguments[2] || []
 
   if (isKeyEnabled('metrics', config)) {
+    if (config.metrics.server === 'own' && parseInt(config.server.port) === parseInt(config.metrics.port)) {
+      app.log.warn('In order to serve metrics on the same port as the core applicaton, set metrics.server to "parent".')
+      config.metrics.server = 'parent'
+    }
+
     app.register(setupMetrics, config.metrics)
   }
 

package/lib/create.mjs

@@ -0,0 +1,85 @@
+'use strict'
+import minimist from 'minimist'
+import { Generator } from '../lib/generator/service-generator.js'
+import { join } from 'node:path'
+import { getPkgManager } from '@platformatic/utils'
+import { execa } from 'execa'
+import ora from 'ora'
+import { Table } from 'console-table-printer'
+import pino from 'pino'
+import pinoPretty from 'pino-pretty'
+
+function printAppSummary (args, logger) {
+  logger.info('Creating a Platformatic Service app with this config: ')
+  const table = [
+    { config: 'Directory', value: args.dir },
+    { config: 'Language', value: args.typescript ? 'Typescript' : 'Javascript' },
+    { config: 'Init Git Repository', value: args.git },
+    { config: 'Install Dependencies', value: args.install },
+    { config: 'Sample Plugin and Tests', value: args.plugin }
+  ]
+
+  const p = new Table({
+    columns: [
+      { name: 'config', alignment: 'right' },
+      { name: 'value', alignment: 'left' }
+    ]
+  })
+
+  p.addRows(table)
+  p.printTable()
+}
+async function createService (_args) {
+  const stream = pinoPretty({
+    translateTime: 'SYS:HH:MM:ss',
+    ignore: 'hostname,pid',
+    minimumLevel: 'debug',
+    sync: true
+  })
+
+  const logger = pino(stream)
+
+  const args = minimist(process.argv.slice(2), {
+    string: ['dir', 'port', 'hostname'],
+    boolean: ['typescript', 'install', 'plugin', 'git'],
+    default: {
+      dir: join(process.cwd(), 'platformatic-service'),
+      port: 3042,
+      hostname: '0.0.0.0',
+      plugin: true,
+      typescript: false,
+      git: false,
+      install: true
+    }
+
+  })
+
+  printAppSummary(args, logger)
+
+  const gen = new Generator({})
+  gen.setConfig({
+    port: args.port,
+    hostname: args.hostname,
+    plugin: args.plugin,
+    tests: args.plugin,
+    typescript: args.typescript,
+    initGitRepository: args.git,
+    targetDirectory: args.dir
+  })
+
+  try {
+    await gen.run()
+    if (args.install) {
+      const pkgManager = getPkgManager()
+      const spinner = ora('Installing dependencies...').start()
+      await execa(pkgManager, ['install'], { cwd: args.dir })
+      spinner.succeed()
+    }
+
+    logger.info('Done! 🎉')
+  } catch (err) {
+    logger.error(err.message)
+  }
+}
+
+export { createService }

package/lib/plugins/metrics.js

@@ -8,26 +8,44 @@ const basicAuth = require('@fastify/basic-auth')
 const fastifyAccepts = require('@fastify/accepts')
 const Fastify = require('fastify')
 
-// This is a global server to match global
+// This is a global httpServer to match global
 // prometheus. It's an antipattern, so do
 // not use it elsewhere.
-let server = null
+let httpServer = null
 
 module.exports = fp(async function (app, opts) {
-  let port = 9090
-  let host = '0.0.0.0'
-  if (typeof opts === 'object') {
-    if (undefined !== opts.port) {
-      port = opts.port
+  const server = opts.server ?? 'own'
+  const hostname = opts.hostname ?? '0.0.0.0'
+  const port = opts.port ?? 9090
+  const metricsEndpoint = opts.endpoint ?? '/metrics'
+  const auth = opts.auth ?? null
+
+  let basicAuthValidator = null
+  if (auth) {
+    const { username, password } = auth
+    basicAuthValidator = function (user, pass, req, reply, done) {
+      if (username !== user || password !== pass) {
+        return reply.code(401).send({ message: 'Unauthorized' })
+      }
+      return done()
     }
-    /* c8 ignore next 3 */
-    if (undefined !== opts.hostname) {
-      host = opts.hostname
+
+    if (server === 'parent') {
+      await app.register(basicAuth, {
+        validate: basicAuthValidator
+      })
+
+      app.addHook('onRoute', (routeOptions) => {
+        if (routeOptions.url === metricsEndpoint) {
+          routeOptions.onRequest = app.basicAuth
+        }
+      })
     }
   }
+
   app.register(metricsPlugin, {
     defaultMetrics: { enabled: true },
-    endpoint: null,
+    endpoint: server === 'parent' ? metricsEndpoint : null,
     name: 'metrics',
     routeMetrics: { enabled: true },
     clearRegisterOnInit: true
@@ -56,24 +74,28 @@ module.exports = fp(async function (app, opts) {
     app.metrics.client.register.registerMetric(eluMetric)
   })
 
-  if (server && server.address().port !== port) {
-    await new Promise((resolve) => server.close(resolve))
-    server = null
+  if (httpServer && httpServer.address().port !== port) {
+    await new Promise((resolve) => httpServer.close(resolve))
+    httpServer = null
+  }
+
+  if (server === 'parent') {
+    return
   }
 
-  if (!server) {
-    server = http.createServer()
-    server.listen(port, host)
-    server.unref()
+  if (!httpServer) {
+    httpServer = http.createServer()
+    httpServer.listen(port, hostname)
+    httpServer.unref()
   }
 
   const promServer = Fastify({
     name: 'Prometheus server',
     serverFactory: (handler) => {
-      server.removeAllListeners('request')
-      server.removeAllListeners('clientError')
-      server.on('request', handler)
-      return server
+      httpServer.removeAllListeners('request')
+      httpServer.removeAllListeners('clientError')
+      httpServer.on('request', handler)
+      return httpServer
     },
     logger: app.log.child({ name: 'prometheus' })
   })
@@ -81,7 +103,7 @@ module.exports = fp(async function (app, opts) {
   promServer.register(fastifyAccepts)
 
   const metricsEndpointOptions = {
-    url: '/metrics',
+    url: metricsEndpoint,
     method: 'GET',
     logLevel: 'warn',
     handler: async (req, reply) => {
@@ -95,15 +117,9 @@ module.exports = fp(async function (app, opts) {
     }
   }
 
-  if (opts.auth) {
-    const { username, password } = opts.auth
+  if (auth) {
     await promServer.register(basicAuth, {
-      validate: function (user, pass, req, reply, done) {
-        if (username !== user || password !== pass) {
-          return reply.code(401).send({ message: 'Unauthorized' })
-        }
-        return done()
-      }
+      validate: basicAuthValidator
     })
     metricsEndpointOptions.onRequest = promServer.basicAuth
   }

package/lib/schema.js

@@ -555,6 +555,11 @@ const metrics = {
           ]
         },
         hostname: { type: 'string' },
+        endpoint: { type: 'string' },
+        server: {
+          type: 'string',
+          enum: ['own', 'parent']
+        },
         auth: {
           type: 'object',
           properties: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/service",
-  "version": "1.16.0",
+  "version": "1.18.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -20,7 +20,7 @@
     "@fastify/aws-lambda": "^3.3.0",
     "@fastify/compress": "^6.5.0",
     "bindings": "^1.5.0",
-    "c8": "^8.0.1",
+    "c8": "^9.0.0",
     "glob": "^10.3.10",
     "json-schema-to-typescript": "^13.1.1",
     "openapi-types": "^12.1.3",
@@ -31,7 +31,7 @@
     "standard": "^17.1.0",
     "strip-ansi": "^7.1.0",
     "ts-standard": "^12.0.2",
-    "tsd": "^0.29.0",
+    "tsd": "^0.30.0",
     "typescript": "^5.2.2",
     "undici": "^6.0.0",
     "vscode-json-languageservice": "^5.3.6",
@@ -58,6 +58,7 @@
     "code-block-writer": "^12.0.0",
     "colorette": "^2.0.20",
     "commist": "^3.2.0",
+    "console-table-printer": "^2.11.2",
     "desm": "^1.3.0",
     "env-schema": "^5.2.0",
     "es-main": "^1.3.0",
@@ -71,19 +72,20 @@
     "mercurius": "^13.1.0",
     "minimist": "^1.2.8",
     "openapi-schema-diff": "^0.0.1",
+    "ora": "^6.3.1",
     "pino": "^8.15.3",
     "pino-pretty": "^10.2.0",
     "rfdc": "^1.3.0",
     "ua-parser-js": "^1.0.36",
     "undici": "^6.0.0",
-    "@platformatic/authenticate": "1.16.0",
-    "@platformatic/config": "1.16.0",
-    "@platformatic/generators": "1.16.0",
-    "@platformatic/scalar-theme": "1.16.0",
-    "@platformatic/telemetry": "1.16.0",
-    "@platformatic/utils": "1.16.0",
-    "@platformatic/client": "1.16.0",
-    "@platformatic/metaconfig": "1.16.0"
+    "@platformatic/authenticate": "1.18.0",
+    "@platformatic/client": "1.18.0",
+    "@platformatic/config": "1.18.0",
+    "@platformatic/metaconfig": "1.18.0",
+    "@platformatic/generators": "1.18.0",
+    "@platformatic/scalar-theme": "1.18.0",
+    "@platformatic/telemetry": "1.18.0",
+    "@platformatic/utils": "1.18.0"
   },
   "standard": {
     "ignore": [

package/service.mjs

@@ -11,7 +11,7 @@ import { generateJsonSchemaConfig } from './lib/gen-schema.js'
 import { bumpVersion } from './lib/bump-version.js'
 import { updateVersion } from './lib/update-version.js'
 import { generateTypes } from './lib/gen-types.mjs'
-
+import { createService } from './lib/create.mjs'
 import { buildCompileCmd } from './lib/compile.js'
 
 import { start, platformaticService } from './index.js'
@@ -43,6 +43,7 @@ program.register('start', (argv) => {
   start(platformaticService, argv).catch(printAndExitLoadConfigError)
 })
 
+program.register('create', wrapCommand(createService))
 program.register('compile', buildCompileCmd(platformaticService))
 program.register('types', wrapCommand(generateTypes))
 program.register('schema config', wrapCommand(generateJsonSchemaConfig))

package/.taprc

@@ -1,2 +0,0 @@
-timeout: 500
-coverage: false