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

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
@@ -34,12 +34,19 @@ async function loadPlugins (app) {
     isOutDirAccessible = await isFileAccessible(outDir)
   }
 
+  if (opts.context?.isProduction && !isOutDirAccessible) {
+    throw new Error(
+      `Cannot access directory '${outDir}'. Please run the 'build' command before running in production mode.`
+    )
+  }
+
   if (config.plugins.paths && isOutDirAccessible) {
-    config.plugins.paths = config.plugins.paths.map((plugin) => {
+    config.plugins.paths = config.plugins.paths.map(plugin => {
       /* c8 ignore next 3 */
-      const tmp = typeof plugin === 'string'
-        ? getJSPluginPath(workingDir, plugin, outDir)
-        : { ...plugin, path: getJSPluginPath(workingDir, plugin.path, outDir) }
+      const tmp =
+        typeof plugin === 'string'
+          ? getJSPluginPath(workingDir, plugin, outDir)
+          : { ...plugin, path: getJSPluginPath(workingDir, plugin.path, outDir) }
       return tmp
     })
   }

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/schema.js

@@ -5,7 +5,7 @@
 const pkg = require('../package.json')
 const openApiDefs = require('./openapi-schema-defs')
 const telemetry = require('@platformatic/telemetry').schema
-const { server, cors, watch } = require('@platformatic/utils').schemas
+const { server, cors, watch } = require('@platformatic/utils').schemaComponents
 
 const plugins = {
   type: 'object',
@@ -15,23 +15,23 @@ const plugins = {
       items: {
         anyOf: [
           {
-            type: 'string',
+            type: 'string'
           },
           {
             type: 'object',
             properties: {
               name: {
-                type: 'string',
+                type: 'string'
               },
               options: {
                 type: 'object',
-                additionalProperties: true,
-              },
+                additionalProperties: true
+              }
             },
-            required: ['name'],
-          },
-        ],
-      },
+            required: ['name']
+          }
+        ]
+      }
     },
     paths: {
       type: 'array',
@@ -39,63 +39,63 @@ const plugins = {
         anyOf: [
           {
             type: 'string',
-            resolvePath: true,
+            resolvePath: true
           },
           {
             type: 'object',
             properties: {
               path: {
                 type: 'string',
-                resolvePath: true,
+                resolvePath: true
               },
               encapsulate: {
                 type: 'boolean',
-                default: true,
+                default: true
               },
               maxDepth: {
-                type: 'integer',
+                type: 'integer'
               },
               autoHooks: {
-                type: 'boolean',
+                type: 'boolean'
               },
               autoHooksPattern: {
-                type: 'string',
+                type: 'string'
               },
               cascadeHooks: {
-                type: 'boolean',
+                type: 'boolean'
               },
               overwriteHooks: {
-                type: 'boolean',
+                type: 'boolean'
               },
               routeParams: {
-                type: 'boolean',
+                type: 'boolean'
               },
               forceESM: {
-                type: 'boolean',
+                type: 'boolean'
               },
               ignoreFilter: {
-                type: 'string',
+                type: 'string'
               },
               matchFilter: {
-                type: 'string',
+                type: 'string'
               },
               ignorePattern: {
-                type: 'string',
+                type: 'string'
               },
               scriptPattern: {
-                type: 'string',
+                type: 'string'
               },
               indexPattern: {
-                type: 'string',
+                type: 'string'
               },
               options: {
                 type: 'object',
-                additionalProperties: true,
-              },
-            },
-          },
-        ],
-      },
+                additionalProperties: true
+              }
+            }
+          }
+        ]
+      }
     },
     typescript: {
       anyOf: [
@@ -105,47 +105,47 @@ const plugins = {
             enabled: {
               anyOf: [
                 {
-                  type: 'boolean',
+                  type: 'boolean'
                 },
                 {
-                  type: 'string',
-                },
-              ],
+                  type: 'string'
+                }
+              ]
             },
             tsConfig: {
               type: 'string',
-              resolvePath: true,
+              resolvePath: true
             },
             outDir: {
               type: 'string',
-              resolvePath: true,
+              resolvePath: true
             },
             flags: {
               type: 'array',
               items: {
-                type: 'string',
-              },
-            },
-          },
+                type: 'string'
+              }
+            }
+          }
         },
         {
-          type: 'boolean',
+          type: 'boolean'
         },
         {
-          type: 'string',
-        },
-      ],
-    },
+          type: 'string'
+        }
+      ]
+    }
   },
   additionalProperties: false,
   anyOf: [
     {
-      required: ['paths'],
+      required: ['paths']
     },
     {
-      required: ['packages'],
-    },
-  ],
+      required: ['packages']
+    }
+  ]
 }
 
 const metrics = {
@@ -155,143 +155,143 @@ const metrics = {
       type: 'object',
       properties: {
         port: {
-          anyOf: [{ type: 'integer' }, { type: 'string' }],
+          anyOf: [{ type: 'integer' }, { type: 'string' }]
         },
         hostname: { type: 'string' },
         endpoint: { type: 'string' },
         server: {
           type: 'string',
-          enum: ['own', 'parent', 'hide'],
+          enum: ['own', 'parent', 'hide']
         },
         defaultMetrics: {
           type: 'object',
           properties: {
-            enabled: { type: 'boolean' },
+            enabled: { type: 'boolean' }
           },
           required: ['enabled'],
-          additionalProperties: false,
+          additionalProperties: false
         },
         auth: {
           type: 'object',
           properties: {
             username: { type: 'string' },
-            password: { type: 'string' },
+            password: { type: 'string' }
           },
           additionalProperties: false,
-          required: ['username', 'password'],
+          required: ['username', 'password']
         },
         labels: {
           type: 'object',
-          additionalProperties: { type: 'string' },
-        },
+          additionalProperties: { type: 'string' }
+        }
       },
-      additionalProperties: false,
-    },
-  ],
+      additionalProperties: false
+    }
+  ]
 }
 
 const openApiBase = {
   type: 'object',
   properties: {
     info: {
-      $ref: '#/$defs/info',
+      $ref: '#/$defs/info'
     },
     jsonSchemaDialect: {
       type: 'string',
 
-      default: 'https://spec.openapis.org/oas/3.1/dialect/base',
+      default: 'https://spec.openapis.org/oas/3.1/dialect/base'
     },
     servers: {
       type: 'array',
       items: {
-        $ref: '#/$defs/server',
+        $ref: '#/$defs/server'
       },
       default: [
         {
-          url: '/',
-        },
-      ],
+          url: '/'
+        }
+      ]
     },
     paths: {
-      $ref: '#/$defs/paths',
+      $ref: '#/$defs/paths'
     },
     webhooks: {
       type: 'object',
       additionalProperties: {
-        $ref: '#/$defs/path-item-or-reference',
-      },
+        $ref: '#/$defs/path-item-or-reference'
+      }
     },
     components: {
-      $ref: '#/$defs/components',
+      $ref: '#/$defs/components'
     },
     security: {
       type: 'array',
       items: {
-        $ref: '#/$defs/security-requirement',
-      },
+        $ref: '#/$defs/security-requirement'
+      }
     },
     tags: {
       type: 'array',
       items: {
-        $ref: '#/$defs/tag',
-      },
+        $ref: '#/$defs/tag'
+      }
     },
     externalDocs: {
-      $ref: '#/$defs/external-documentation',
+      $ref: '#/$defs/external-documentation'
     },
     swaggerPrefix: {
       type: 'string',
-      description: 'Base URL for the OpenAPI Swagger Documentation',
+      description: 'Base URL for the OpenAPI Swagger Documentation'
     },
     path: {
       type: 'string',
       description: 'Path to an OpenAPI spec file',
-      resolvePath: true,
-    },
-  },
+      resolvePath: true
+    }
+  }
 }
 
 const openapi = {
   anyOf: [
     {
       ...openApiBase,
-      additionalProperties: false,
+      additionalProperties: false
     },
     {
-      type: 'boolean',
-    },
-  ],
+      type: 'boolean'
+    }
+  ]
 }
 
 const graphqlBase = {
   type: 'object',
   properties: {
     graphiql: {
-      type: 'boolean',
-    },
+      type: 'boolean'
+    }
   },
-  additionalProperties: false,
+  additionalProperties: false
 }
 
 const graphql = {
   anyOf: [
     {
       ...graphqlBase,
-      additionalProperties: false,
+      additionalProperties: false
     },
     {
-      type: 'boolean',
-    },
-  ],
+      type: 'boolean'
+    }
+  ]
 }
 
 const service = {
   type: 'object',
   properties: {
     openapi,
-    graphql,
+    graphql
   },
-  additionalProperties: false,
+  additionalProperties: false
 }
 
 const clients = {
@@ -300,32 +300,32 @@ const clients = {
     type: 'object',
     properties: {
       serviceId: {
-        type: 'string',
+        type: 'string'
       },
       name: {
-        type: 'string',
+        type: 'string'
       },
       type: {
         type: 'string',
-        enum: ['openapi', 'graphql'],
+        enum: ['openapi', 'graphql']
       },
       path: {
         type: 'string',
-        resolvePath: true,
+        resolvePath: true
       },
       schema: {
         type: 'string',
-        resolvePath: true,
+        resolvePath: true
       },
       url: {
-        type: 'string',
+        type: 'string'
       },
       fullResponse: { type: 'boolean' },
       fullRequest: { type: 'boolean' },
-      validateResponse: { type: 'boolean' },
+      validateResponse: { type: 'boolean' }
     },
-    additionalProperties: false,
-  },
+    additionalProperties: false
+  }
 }
 
 const platformaticServiceSchema = {
@@ -342,24 +342,24 @@ const platformaticServiceSchema = {
       anyOf: [
         watch,
         {
-          type: 'boolean',
+          type: 'boolean'
         },
         {
-          type: 'string',
-        },
-      ],
+          type: 'string'
+        }
+      ]
     },
     $schema: {
-      type: 'string',
+      type: 'string'
     },
     module: {
-      type: 'string',
+      type: 'string'
     },
     service,
-    clients,
+    clients
   },
   additionalProperties: false,
-  $defs: openApiDefs,
+  $defs: openApiDefs
 }
 
 /*
@@ -368,52 +368,52 @@ const platformaticServiceSchema = {
  */
 Object.defineProperty(platformaticServiceSchema, 'schema', {
   enumerable: false,
-  value: platformaticServiceSchema,
+  value: platformaticServiceSchema
 })
 
 Object.defineProperty(platformaticServiceSchema, 'server', {
   enumerable: false,
-  value: server,
+  value: server
 })
 
 Object.defineProperty(platformaticServiceSchema, 'cors', {
   enumerable: false,
-  value: cors,
+  value: cors
 })
 
 Object.defineProperty(platformaticServiceSchema, 'metrics', {
   enumerable: false,
-  value: metrics,
+  value: metrics
 })
 
 Object.defineProperty(platformaticServiceSchema, 'plugins', {
   enumerable: false,
-  value: plugins,
+  value: plugins
 })
 
 Object.defineProperty(platformaticServiceSchema, 'watch', {
   enumerable: false,
-  value: watch,
+  value: watch
 })
 
 Object.defineProperty(platformaticServiceSchema, 'openApiDefs', {
   enumerable: false,
-  value: openApiDefs,
+  value: openApiDefs
 })
 
 Object.defineProperty(platformaticServiceSchema, 'openApiBase', {
   enumerable: false,
-  value: openApiBase,
+  value: openApiBase
 })
 
 Object.defineProperty(platformaticServiceSchema, 'graphqlBase', {
   enumerable: false,
-  value: graphqlBase,
+  value: graphqlBase
 })
 
 Object.defineProperty(platformaticServiceSchema, 'clients', {
   enumerable: false,
-  value: clients,
+  value: clients
 })
 
 /* end */

package/lib/stackable.js

@@ -3,21 +3,26 @@
 const { dirname } = require('node:path')
 const { printSchema } = require('graphql')
 const pino = require('pino')
+const httpMetrics = require('@platformatic/fastify-http-metrics')
+const { extractTypeScriptCompileOptionsFromConfig } = require('./compile')
+const { compile } = require('@platformatic/ts-compiler')
 
 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
+    this.context = options.context ?? {}
+    this.context.stackable = this
 
-    this.configManager.on('error', (err) => {
+    this.configManager.on('error', err => {
       /* c8 ignore next */
       this.stackable.log({
         message: 'error reloading the configuration' + err,
-        level: 'error',
+        level: 'error'
       })
     })
 
@@ -29,6 +34,10 @@ class ServiceStackable {
 
     if (this.app === null) {
       this.app = await this._init()
+
+      if (this.metricsRegistry) {
+        this.#setHttpMetrics()
+      }
     }
     return this.app
   }
@@ -48,6 +57,20 @@ class ServiceStackable {
     await this.app.close()
   }
 
+  async build () {
+    this.#initLogger()
+    const typeScriptCompileOptions = extractTypeScriptCompileOptionsFromConfig(this.configManager.current)
+    const cwd = dirname(this.configManager.fullPath)
+    const compileOptions = {
+      ...typeScriptCompileOptions,
+      cwd,
+      logger: this.configManager.current.server.logger,
+    }
+    if (!await compile(compileOptions)) {
+      throw new Error(`Failed to compile ${cwd}`)
+    }
+  }
+
   getUrl () {
     return this.app !== null ? this.app.url : null
   }
@@ -76,15 +99,13 @@ class ServiceStackable {
   async getWatchConfig () {
     const config = this.configManager.current
 
-    const enabled =
-      config.watch?.enabled !== false &&
-      config.plugins !== undefined
+    const enabled = config.watch?.enabled !== false && config.plugins !== undefined
 
     return {
       enabled,
       path: dirname(this.configManager.fullPath),
       allow: config.watch?.allow,
-      ignore: config.watch?.ignore,
+      ignore: config.watch?.ignore
     }
   }
 
@@ -105,15 +126,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,18 +158,45 @@ 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
 
-    const {
-      serviceId,
-      telemetryConfig,
-      metricsConfig,
-      serverConfig,
-      hasManagementApi,
-      isEntrypoint,
-      isProduction,
-    } = this.context
+    const { serviceId, telemetryConfig, metricsConfig, serverConfig, hasManagementApi, isEntrypoint, isProduction } =
+      this.context
 
     const config = this.configManager.current
 
@@ -164,15 +210,13 @@ class ServiceStackable {
       config.server = serverConfig
     }
 
-    if (
-      (hasManagementApi && config.metrics === undefined) || config.metrics
-    ) {
+    if ((hasManagementApi && config.metrics === undefined) || config.metrics) {
       const labels = config.metrics?.labels || {}
       config.metrics = {
         server: 'hide',
         defaultMetrics: { enabled: isEntrypoint },
         ...config.metrics,
-        labels: { serviceId, ...labels },
+        labels: { serviceId, ...labels }
       }
     }
 
@@ -196,7 +240,7 @@ class ServiceStackable {
     const level = this.configManager.current.server.logger?.level
 
     const pinoOptions = {
-      level: level ?? 'trace',
+      level: level ?? 'trace'
     }
 
     if (this.context?.serviceId) {

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.8",
   "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.8",
+    "@platformatic/generators": "2.0.0-alpha.8",
+    "@platformatic/scalar-theme": "2.0.0-alpha.8",
+    "@platformatic/config": "2.0.0-alpha.8",
+    "@platformatic/telemetry": "2.0.0-alpha.8",
+    "@platformatic/ts-compiler": "2.0.0-alpha.8",
+    "@platformatic/utils": "2.0.0-alpha.8"
   },
   "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.8.json",
+  "version": "2.0.0-alpha.8",
   "title": "Platformatic Service",
   "type": "object",
   "properties": {