@platformatic/service 2.0.0-alpha.6 → 2.0.0-alpha.7

package/index.js

@@ -80,9 +80,9 @@ async function platformaticService (app, opts) {
     }
 
     if (registerTsCompiler) {
-      app.register(setupTsCompiler)
+      app.register(setupTsCompiler, { context: opts.context })
     }
-    app.register(loadPlugins)
+    app.register(loadPlugins, { context: opts.context })
   }
 
   if (isKeyEnabled('cors', config.server)) {
@@ -168,7 +168,7 @@ async function buildStackable (
   }
 
   const stackable = new Stackable({
-    init: () => buildServer(configManager.current, app),
+    init: () => buildServer(configManager.current, app, options.context),
     stackable: app,
     configManager,
     context: options.context,

package/lib/plugins/plugins.js

@@ -7,14 +7,14 @@ const wrapper = require('./sandbox-wrapper')
 
 const { getJSPluginPath, isFileAccessible } = require('../utils')
 
-async function loadPlugins (app) {
+async function loadPlugins (app, opts) {
   const configManager = app.platformatic.configManager
   const config = configManager.current
 
   let isOutDirAccessible = false
   let outDir = null
 
-  const workingDir = configManager.dirname
+  const workingDir = opts?.context?.directory ?? configManager.dirname
   const tsConfigPath = configManager.current.plugins.typescript?.tsConfig || join(workingDir, 'tsconfig.json')
 
   // If the tsconfig.json file exists, then we need to adjust the plugin paths

package/lib/plugins/typescript.js

@@ -4,10 +4,10 @@ const fp = require('fastify-plugin')
 const compiler = require('@platformatic/ts-compiler')
 const { extractTypeScriptCompileOptionsFromConfig } = require('../compile')
 
-async function setupTsCompiler (app) {
+async function setupTsCompiler (app, opts) {
   const configManager = app.platformatic.configManager
   const config = configManager.current
-  const workingDir = configManager.dirname
+  const workingDir = opts?.context?.directory ?? configManager.dirname
 
   await compiler.compile({
     ...extractTypeScriptCompileOptionsFromConfig(config),

package/lib/stackable.js

@@ -3,12 +3,14 @@
 const { dirname } = require('node:path')
 const { printSchema } = require('graphql')
 const pino = require('pino')
+const httpMetrics = require('@platformatic/fastify-http-metrics')
 
 class ServiceStackable {
   constructor (options) {
     this.app = null
     this._init = options.init
     this.stackable = options.stackable
+    this.metricsRegistry = null
 
     this.configManager = options.configManager
     this.context = options.context
@@ -29,6 +31,10 @@ class ServiceStackable {
 
     if (this.app === null) {
       this.app = await this._init()
+
+      if (this.metricsRegistry) {
+        this.#setHttpMetrics()
+      }
     }
     return this.app
   }
@@ -73,6 +79,14 @@ class ServiceStackable {
     return config
   }
 
+  getMeta () {
+    return {
+      deploy: {
+        buildCommand: 'platformatic compile'
+      }
+    }
+  }
+
   async getWatchConfig () {
     const config = this.configManager.current
 
@@ -105,15 +119,13 @@ class ServiceStackable {
     return this.app.graphql ? printSchema(this.app.graphql.schema) : null
   }
 
-  async getMetrics ({ format }) {
-    await this.init()
-
-    const promRegister = this.app.metrics?.client?.register
-    if (!promRegister) return null
+  async collectMetrics ({ registry }) {
+    this.metricsRegistry = registry
 
-    return format === 'json'
-      ? promRegister.getMetricsAsJSON()
-      : promRegister.metrics()
+    return {
+      defaultMetrics: true,
+      httpMetrics: false
+    }
   }
 
   async inject (injectParams) {
@@ -139,6 +151,40 @@ class ServiceStackable {
     this.#updateConfig()
   }
 
+  #setHttpMetrics () {
+    this.app.register(httpMetrics, {
+      registry: this.metricsRegistry,
+      customLabels: ['telemetry_id'],
+      getCustomLabels: (req) => {
+        const telemetryId = req.headers['x-plt-telemetry-id'] ?? 'unknown'
+        return { telemetry_id: telemetryId }
+      },
+    })
+
+    this.app.register(httpMetrics, {
+      registry: this.metricsRegistry,
+      customLabels: ['telemetry_id'],
+      getCustomLabels: (req) => {
+        const telemetryId = req.headers['x-plt-telemetry-id'] ?? 'unknown'
+        return { telemetry_id: telemetryId }
+      },
+      histogram: {
+        name: 'http_request_all_duration_seconds',
+        help: 'request duration in seconds summary for all requests',
+        collect: function () {
+          process.nextTick(() => this.reset())
+        },
+      },
+      summary: {
+        name: 'http_request_all_summary_seconds',
+        help: 'request duration in seconds histogram for all requests',
+        collect: function () {
+          process.nextTick(() => this.reset())
+        },
+      },
+    })
+  }
+
   #updateConfig () {
     if (!this.context) return
 

package/lib/start.js

@@ -25,8 +25,8 @@ async function adjustHttpsKeyAndCert (arg) {
   return arg
 }
 
-async function createServer (context) {
-  const { app, configManager } = context
+async function createServer (serverContext) {
+  const { app, configManager, context } = serverContext
   const config = configManager.current
   let fastifyOptions = {}
 
@@ -42,14 +42,14 @@ async function createServer (context) {
   fastifyOptions.genReqId = function (req) { return randomUUID() }
   const root = fastify(fastifyOptions)
   root.decorate('platformatic', { configManager, config })
-  await root.register(app)
+  await root.register(app, { context })
   if (!root.hasRoute({ url: '/', method: 'GET' })) {
     await root.register(require('./root-endpoint'))
   }
 
   root.decorate('url', {
     getter () {
-      return context.url
+      return serverContext.url
     },
   })
 
@@ -65,7 +65,7 @@ async function buildConfigManager (options, app) {
   return configManager
 }
 
-async function buildServer (options, app) {
+async function buildServer (options, app, context) {
   const configManager = await buildConfigManager(options, app)
   const config = configManager.current
 
@@ -84,17 +84,18 @@ async function buildServer (options, app) {
     }
   }
 
-  const context = {
+  const serverContext = {
     app: typeof app === 'function' ? app : app.app,
     configManager,
+    context
   }
-  const handler = await createServer(context)
+  const handler = await createServer(serverContext)
   handler.decorate('start', async () => {
-    context.url = await handler.listen({
+    serverContext.url = await handler.listen({
       host: options.server?.hostname || '127.0.0.1',
       port: options.server?.port || 0,
     })
-    return context.url
+    return serverContext.url
   })
   configManager.on('error', function (err) {
     /* c8 ignore next 1 */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/service",
-  "version": "2.0.0-alpha.6",
+  "version": "2.0.0-alpha.7",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -47,6 +47,7 @@
     "@fastify/swagger": "^8.14.0",
     "@fastify/under-pressure": "^8.3.0",
     "@mercuriusjs/federation": "^3.0.0",
+    "@platformatic/fastify-http-metrics": "^0.1.0",
     "@scalar/fastify-api-reference": "^1.19.5",
     "@types/ws": "^8.5.10",
     "ajv": "^8.12.0",
@@ -76,13 +77,13 @@
     "rfdc": "^1.3.1",
     "semgrator": "^0.3.0",
     "undici": "^6.9.0",
-    "@platformatic/client": "2.0.0-alpha.6",
-    "@platformatic/config": "2.0.0-alpha.6",
-    "@platformatic/scalar-theme": "2.0.0-alpha.6",
-    "@platformatic/telemetry": "2.0.0-alpha.6",
-    "@platformatic/generators": "2.0.0-alpha.6",
-    "@platformatic/ts-compiler": "2.0.0-alpha.6",
-    "@platformatic/utils": "2.0.0-alpha.6"
+    "@platformatic/client": "2.0.0-alpha.7",
+    "@platformatic/scalar-theme": "2.0.0-alpha.7",
+    "@platformatic/generators": "2.0.0-alpha.7",
+    "@platformatic/config": "2.0.0-alpha.7",
+    "@platformatic/telemetry": "2.0.0-alpha.7",
+    "@platformatic/ts-compiler": "2.0.0-alpha.7",
+    "@platformatic/utils": "2.0.0-alpha.7"
   },
   "scripts": {
     "test": "pnpm run lint && borp -T --concurrency=1 --timeout=180000 && tsd",

package/schema.json

@@ -1,6 +1,6 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/service/2.0.0-alpha.6.json",
-  "version": "2.0.0-alpha.6",
+  "$id": "https://schemas.platformatic.dev/@platformatic/service/2.0.0-alpha.7.json",
+  "version": "2.0.0-alpha.7",
   "title": "Platformatic Service",
   "type": "object",
   "properties": {