@platformatic/basic 2.25.0 → 2.26.0

package/index.js

@@ -37,7 +37,7 @@ function isImportFailedError (error, pkg) {
   return match?.[1] === pkg || error.requireStack?.[0].endsWith(importStackablePackageMarker)
 }
 
-async function importStackablePackage (opts, pkg) {
+async function importStackablePackage (directory, pkg) {
   try {
     try {
       // Try regular import
@@ -48,7 +48,7 @@ async function importStackablePackage (opts, pkg) {
       }
 
       // Scope to the service
-      const require = createRequire(resolve(opts.context.directory, importStackablePackageMarker))
+      const require = createRequire(resolve(directory, importStackablePackageMarker))
       const imported = require.resolve(pkg)
       return await importFile(imported)
     }
@@ -57,16 +57,15 @@ async function importStackablePackage (opts, pkg) {
       throw e
     }
 
-    const serviceDirectory = relative(workerData.dirname, opts.context.directory)
+    const serviceDirectory = workerData ? relative(workerData.dirname, directory) : directory
     throw new Error(
       `Unable to import package '${pkg}'. Please add it as a dependency  in the package.json file in the folder ${serviceDirectory}.`
     )
   }
 }
 
-async function buildStackable (opts) {
-  const root = opts.context.directory
-  let toImport = '@platformatic/node'
+export async function importStackableAndConfig (root, config) {
+  let moduleName = '@platformatic/node'
   let autodetectDescription = 'is using a generic Node.js application'
 
   let rootPackageJson
@@ -76,14 +75,12 @@ async function buildStackable (opts) {
     rootPackageJson = {}
   }
 
-  const hadConfig = opts.config
-
-  if (!hadConfig) {
+  if (!config) {
     for (const candidate of configCandidates) {
       const candidatePath = resolve(root, candidate)
 
       if (existsSync(candidatePath)) {
-        opts.config = candidatePath
+        config = candidatePath
         break
       }
     }
@@ -93,19 +90,27 @@ async function buildStackable (opts) {
 
   if (dependencies?.next || devDependencies?.next) {
     autodetectDescription = 'is using Next.js'
-    toImport = '@platformatic/next'
+    moduleName = '@platformatic/next'
   } else if (dependencies?.['@remix-run/dev'] || devDependencies?.['@remix-run/dev']) {
     autodetectDescription = 'is using Remix'
-    toImport = '@platformatic/remix'
+    moduleName = '@platformatic/remix'
   } else if (dependencies?.vite || devDependencies?.vite) {
     autodetectDescription = 'is using Vite'
-    toImport = '@platformatic/vite'
+    moduleName = '@platformatic/vite'
   } else if (dependencies?.astro || devDependencies?.astro) {
     autodetectDescription = 'is using Astro'
-    toImport = '@platformatic/astro'
+    moduleName = '@platformatic/astro'
   }
 
-  const imported = await importStackablePackage(opts, toImport)
+  const stackable = await importStackablePackage(root, moduleName)
+
+  return { stackable, config, autodetectDescription, moduleName }
+}
+
+async function buildStackable (opts) {
+  const hadConfig = !!opts.config
+  const { stackable, config, autodetectDescription, moduleName } = await importStackableAndConfig(opts.context.directory, opts.config)
+  opts.config = config
 
   const serviceRoot = relative(process.cwd(), opts.context.directory)
   if (
@@ -122,12 +127,12 @@ async function buildStackable (opts) {
       [
         `Platformatic has auto-detected that service "${opts.context.serviceId}" ${autodetectDescription}.\n`,
         `We suggest you create a platformatic.json or watt.json file in the folder ${serviceRoot} with the "$schema" `,
-        `property set to "https://schemas.platformatic.dev/${toImport}/${packageJson.version}.json".`
+        `property set to "https://schemas.platformatic.dev/${moduleName}/${packageJson.version}.json".`
       ].join('')
     )
   }
 
-  return imported.buildStackable(opts)
+  return stackable.buildStackable(opts)
 }
 
 /* c8 ignore next 3 */

package/lib/base.js

@@ -160,25 +160,31 @@ export class BaseStackable {
     }
   }
 
-  async buildWithCommand (command, basePath, loader, scripts) {
+  async buildWithCommand (command, basePath, opts = {}) {
+    const { loader, scripts, context, disableChildManager } = opts
+
     if (Array.isArray(command)) {
       command = command.join(' ')
     }
 
     this.logger.debug(`Executing "${command}" ...`)
 
-    const context = await this.#getChildManagerContext(basePath)
-    this.childManager = new ChildManager({
-      logger: this.logger,
-      loader,
-      scripts,
-      context: { ...context, isBuilding: true }
-    })
+    const baseContext = await this.getChildManagerContext(basePath)
+    this.childManager = disableChildManager
+      ? null
+      : new ChildManager({
+        logger: this.logger,
+        loader,
+        scripts,
+        context: { ...baseContext, isBuilding: true, ...context }
+      })
 
     try {
-      await this.childManager.inject()
+      await this.childManager?.inject()
 
       const subprocess = this.spawn(command)
+      subprocess.stdout.setEncoding('utf8')
+      subprocess.stderr.setEncoding('utf8')
 
       // Wait for the process to be started
       await new Promise((resolve, reject) => {
@@ -205,8 +211,8 @@ export class BaseStackable {
         throw error
       }
     } finally {
-      await this.childManager.eject()
-      await this.childManager.close()
+      await this.childManager?.eject()
+      await this.childManager?.close()
     }
   }
 
@@ -214,7 +220,7 @@ export class BaseStackable {
     const config = this.configManager.current
     const basePath = config.application?.basePath ? cleanBasePath(config.application?.basePath) : ''
 
-    const context = await this.#getChildManagerContext(basePath)
+    const context = await this.getChildManagerContext(basePath)
     this.childManager = new ChildManager({
       logger: this.logger,
       loader,
@@ -335,6 +341,7 @@ export class BaseStackable {
 
     this.#metricsCollected = true
     await this.#collectMetrics()
+    this.#setHttpCacheMetrics()
   }
 
   async #collectMetrics () {
@@ -367,6 +374,25 @@ export class BaseStackable {
     }
   }
 
+  #setHttpCacheMetrics () {
+    const { client, registry } = globalThis.platformatic.prometheus
+
+    const cacheHitMetric = new client.Counter({
+      name: 'http_cache_hit_count',
+      help: 'Number of http cache hits',
+      registers: [registry]
+    })
+
+    const cacheMissMetric = new client.Counter({
+      name: 'http_cache_miss_count',
+      help: 'Number of http cache misses',
+      registers: [registry]
+    })
+
+    globalThis.platformatic.onHttpCacheHit = () => { cacheHitMetric.inc() }
+    globalThis.platformatic.onHttpCacheMiss = () => { cacheMissMetric.inc() }
+  }
+
   async getMetrics ({ format } = {}) {
     if (this.childManager && this.clientWs) {
       return this.childManager.send(this.clientWs, 'getMetrics', { format })
@@ -387,7 +413,7 @@ export class BaseStackable {
     }
   }
 
-  async #getChildManagerContext (basePath) {
+  async getChildManagerContext (basePath) {
     const meta = await this.getMeta()
 
     return {
@@ -405,7 +431,8 @@ export class BaseStackable {
       /* c8 ignore next 2 */
       port: (this.isEntrypoint ? this.serverConfig?.port || 0 : undefined) ?? true,
       host: (this.isEntrypoint ? this.serverConfig?.hostname : undefined) ?? true,
-      telemetryConfig: this.telemetryConfig
+      telemetryConfig: this.telemetryConfig,
+      interceptLogging: typeof workerData?.loggingPort !== 'undefined'
     }
   }
 }

package/lib/worker/child-process.js

@@ -180,6 +180,26 @@ export class ChildProcess extends ITC {
 
   async #collectMetrics ({ serviceId, workerId, metricsConfig }) {
     await collectMetrics(serviceId, workerId, metricsConfig, this.#metricsRegistry)
+    this.#setHttpCacheMetrics()
+  }
+
+  #setHttpCacheMetrics () {
+    const { client, registry } = globalThis.platformatic.prometheus
+
+    const cacheHitMetric = new client.Counter({
+      name: 'http_cache_hit_count',
+      help: 'Number of http cache hits',
+      registers: [registry]
+    })
+
+    const cacheMissMetric = new client.Counter({
+      name: 'http_cache_miss_count',
+      help: 'Number of http cache misses',
+      registers: [registry]
+    })
+
+    globalThis.platformatic.onHttpCacheHit = () => { cacheHitMetric.inc() }
+    globalThis.platformatic.onHttpCacheMiss = () => { cacheMissMetric.inc() }
   }
 
   async #getMetrics ({ format } = {}) {
@@ -205,7 +225,7 @@ export class ChildProcess extends ITC {
       }
     }
 
-    if (isMainThread) {
+    if (isMainThread && globalThis.platformatic.interceptLogging) {
       pinoOptions.transport = {
         target: new URL('./child-transport.js', import.meta.url).toString()
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/basic",
-  "version": "2.25.0",
+  "version": "2.26.0",
   "description": "",
   "main": "index.js",
   "type": "module",
@@ -23,11 +23,11 @@
     "split2": "^4.2.0",
     "undici": "^7.0.0",
     "ws": "^8.18.0",
-    "@platformatic/config": "2.25.0",
-    "@platformatic/metrics": "2.25.0",
-    "@platformatic/itc": "2.25.0",
-    "@platformatic/telemetry": "2.25.0",
-    "@platformatic/utils": "2.25.0"
+    "@platformatic/config": "2.26.0",
+    "@platformatic/itc": "2.26.0",
+    "@platformatic/metrics": "2.26.0",
+    "@platformatic/utils": "2.26.0",
+    "@platformatic/telemetry": "2.26.0"
   },
   "devDependencies": {
     "borp": "^0.19.0",

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/basic/2.25.0.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/basic/2.26.0.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Stackable",
   "type": "object",