@platformatic/basic 2.0.0-alpha.9 → 2.0.0

package/index.js

@@ -7,13 +7,34 @@ import pino from 'pino'
 import { packageJson, schema } from './lib/schema.js'
 import { importFile } from './lib/utils.js'
 
+const importStackablePackageMarker = '__pltImportStackablePackage.js'
+
+export const configCandidates = [
+  'platformatic.application.json',
+  'platformatic.json',
+  'watt.json',
+  'platformatic.application.yaml',
+  'platformatic.yaml',
+  'watt.yaml',
+  'platformatic.application.yml',
+  'platformatic.yml',
+  'watt.yml',
+  'platformatic.application.toml',
+  'platformatic.toml',
+  'watt.toml',
+  'platformatic.application.tml',
+  'platformatic.tml',
+  'watt.tml'
+]
+
 function isImportFailedError (error, pkg) {
-  if (error.code !== 'ERR_MODULE_NOT_FOUND') {
+  if (error.code !== 'ERR_MODULE_NOT_FOUND' && error.code !== 'MODULE_NOT_FOUND') {
     return false
   }
 
   const match = error.message.match(/Cannot find package '(.+)' imported from (.+)/)
-  return match?.[1] === pkg
+
+  return match?.[1] === pkg || error.requireStack?.[0].endsWith(importStackablePackageMarker)
 }
 
 async function importStackablePackage (opts, pkg, autodetectDescription) {
@@ -27,7 +48,7 @@ async function importStackablePackage (opts, pkg, autodetectDescription) {
       }
 
       // Scope to the service
-      const require = createRequire(resolve(opts.context.directory, 'index.js'))
+      const require = createRequire(resolve(opts.context.directory, importStackablePackageMarker))
       const imported = require.resolve(pkg)
       return await importFile(imported)
     }
@@ -36,17 +57,10 @@ async function importStackablePackage (opts, pkg, autodetectDescription) {
       throw e
     }
 
-    const rootFolder = relative(process.cwd(), workerData.dirname)
-
-    let errorMessage = `Unable to import package, "${pkg}". Please add it as a dependency `
-
-    if (rootFolder) {
-      errorMessage += `in the package.json file in the folder ${rootFolder}.`
-    } else {
-      errorMessage += 'in the root package.json file.'
-    }
-
-    throw new Error(errorMessage)
+    const serviceDirectory = relative(workerData.dirname, opts.context.directory)
+    throw new Error(
+      `Unable to import package '${pkg}'. Please add it as a dependency  in the package.json file in the folder ${serviceDirectory}.`
+    )
   }
 }
 
@@ -65,10 +79,13 @@ async function buildStackable (opts) {
   const hadConfig = opts.config
 
   if (!hadConfig) {
-    const candidate = resolve(root, 'platformatic.application.json')
+    for (const candidate of configCandidates) {
+      const candidatePath = resolve(root, candidate)
 
-    if (existsSync(candidate)) {
-      opts.config = candidate
+      if (existsSync(candidatePath)) {
+        opts.config = candidatePath
+        break
+      }
     }
   }
 
@@ -91,7 +108,10 @@ async function buildStackable (opts) {
   const imported = await importStackablePackage(opts, toImport, autodetectDescription)
 
   const serviceRoot = relative(process.cwd(), opts.context.directory)
-  if (!hadConfig && !existsSync(resolve(serviceRoot, 'platformatic.application.json'))) {
+  if (
+    !hadConfig &&
+    !existsSync(resolve(serviceRoot, 'platformatic.json') || existsSync(resolve(serviceRoot, 'watt.json')))
+  ) {
     const logger = pino({
       level: opts.context.serverConfig?.logger?.level ?? 'warn',
       name: opts.context.serviceId
@@ -100,7 +120,7 @@ async function buildStackable (opts) {
     logger.warn(
       [
         `Platformatic has auto-detected that service ${opts.context.serviceId} ${autodetectDescription}.\n`,
-        `We suggest you create a platformatic.application.json file in the folder ${serviceRoot} with the "$schema" `,
+        `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".`
       ].join('')
     )

package/lib/base.js

@@ -1,3 +1,4 @@
+import { deepmerge } from '@platformatic/utils'
 import { parseCommandString } from 'execa'
 import { spawn } from 'node:child_process'
 import { once } from 'node:events'
@@ -19,10 +20,11 @@ export class BaseStackable {
     this.type = type
     this.version = version
     this.id = options.context.serviceId
+    this.telemetryConfig = options.context.telemetryConfig
     this.options = options
     this.root = root
     this.configManager = configManager
-    this.serverConfig = options.context.serverConfig
+    this.serverConfig = deepmerge(options.context.serverConfig ?? {}, configManager.current.server ?? {})
     this.openapiSchema = null
     this.getGraphqlSchema = null
     this.isEntrypoint = options.context.isEntrypoint
@@ -30,7 +32,7 @@ export class BaseStackable {
 
     // Setup the logger
     const pinoOptions = {
-      level: (this.configManager.current.server ?? this.serverConfig)?.logger?.level ?? 'trace'
+      level: this.serverConfig?.logger?.level ?? 'trace'
     }
 
     if (this.id) {
@@ -54,6 +56,10 @@ export class BaseStackable {
     return this.configManager.current
   }
 
+  async getEnv () {
+    return this.configManager.env
+  }
+
   async getWatchConfig () {
     const config = this.configManager.current
 
@@ -175,7 +181,6 @@ export class BaseStackable {
   async startWithCommand (command, loader) {
     const config = this.configManager.current
     const basePath = config.application?.basePath ? cleanBasePath(config.application?.basePath) : ''
-
     this.#childManager = new ChildManager({
       logger: this.logger,
       loader,
@@ -185,7 +190,8 @@ export class BaseStackable {
         root: pathToFileURL(this.root).toString(),
         basePath,
         logLevel: this.logger.level,
-        port: (this.isEntrypoint ? this.serverConfig?.port || 0 : undefined) ?? true
+        port: (this.isEntrypoint ? this.serverConfig?.port || 0 : undefined) ?? true,
+        telemetry: this.telemetryConfig
       }
     })
 

package/lib/worker/child-manager.js

@@ -1,5 +1,5 @@
 import { ITC, generateNotification } from '@platformatic/itc'
-import { createDirectory, errors } from '@platformatic/utils'
+import { createDirectory, ensureLoggableError } from '@platformatic/utils'
 import { once } from 'node:events'
 import { rm, writeFile } from 'node:fs/promises'
 import { createServer } from 'node:http'
@@ -213,7 +213,7 @@ export class ChildManager extends ITC {
   }
 
   #handleUnexpectedError (error, message, exitCode) {
-    this.#logger.error({ err: errors.ensureLoggableError(error) }, message)
+    this.#logger.error({ err: ensureLoggableError(error) }, message)
     process.exit(exitCode)
   }
 }

package/lib/worker/child-process.js

@@ -1,11 +1,13 @@
 import { ITC } from '@platformatic/itc'
-import { createPinoWritable, errors } from '@platformatic/utils'
+import { setupNodeHTTPTelemetry } from '@platformatic/telemetry'
+import { createPinoWritable, ensureLoggableError } from '@platformatic/utils'
 import { tracingChannel } from 'node:diagnostics_channel'
 import { once } from 'node:events'
 import { readFile } from 'node:fs/promises'
 import { register } from 'node:module'
 import { platform, tmpdir } from 'node:os'
 import { basename, resolve } from 'node:path'
+import { fileURLToPath } from 'node:url'
 import { isMainThread } from 'node:worker_threads'
 import pino from 'pino'
 import { getGlobalDispatcher, setGlobalDispatcher } from 'undici'
@@ -90,6 +92,7 @@ export class ChildProcess extends ITC {
 
     this.listen()
     this.#setupLogger()
+    this.#setupTelemetry()
     this.#setupHandlers()
     this.#setupServer()
     this.#setupInterceptors()
@@ -115,7 +118,7 @@ export class ChildProcess extends ITC {
       try {
         this.#listener(JSON.parse(message))
       } catch (error) {
-        this.#logger.error({ err: errors.ensureLoggableError(error) }, 'Handling a message failed.')
+        this.#logger.error({ err: ensureLoggableError(error) }, 'Handling a message failed.')
         process.exit(exitCodes.PROCESS_MESSAGE_HANDLING_FAILED)
       }
     })
@@ -158,12 +161,18 @@ export class ChildProcess extends ITC {
       })
 
       Reflect.defineProperty(process, 'stdout', { value: createPinoWritable(this.#logger, 'info') })
-      Reflect.defineProperty(process, 'stderr', { value: createPinoWritable(this.#logger, 'error') })
+      Reflect.defineProperty(process, 'stderr', { value: createPinoWritable(this.#logger, 'error', true) })
     } else {
       this.#logger = pino({ level: 'info', name: globalThis.platformatic.id })
     }
   }
 
+  #setupTelemetry () {
+    if (globalThis.platformatic.telemetry) {
+      setupNodeHTTPTelemetry(globalThis.platformatic.telemetry, this.#logger)
+    }
+  }
+
   #setupServer () {
     const subscribers = {
       asyncStart ({ options }) {
@@ -196,9 +205,8 @@ export class ChildProcess extends ITC {
 
   #setupHandlers () {
     function handleUnhandled (type, err) {
-      process._rawDebug(globalThis.platformatic.id, err)
       this.#logger.error(
-        { err: errors.ensureLoggableError(err) },
+        { err: ensureLoggableError(err) },
         `Child process for service ${globalThis.platformatic.id} threw an ${type}.`
       )
 
@@ -216,6 +224,10 @@ async function main () {
 
   globalThis.platformatic = data
 
+  if (data.root && isMainThread) {
+    process.chdir(fileURLToPath(data.root))
+  }
+
   if (loader) {
     register(loader, { data })
   }

package/lib/worker/child-transport.js

@@ -1,5 +1,5 @@
 import { generateRequest } from '@platformatic/itc'
-import { errors } from '@platformatic/utils'
+import { ensureLoggableError } from '@platformatic/utils'
 import { once } from 'node:events'
 import { platform } from 'node:os'
 import { workerData } from 'node:worker_threads'
@@ -9,7 +9,7 @@ import { getSocketPath } from './child-manager.js'
 
 function logDirectError (message, error) {
   process._rawDebug(`Logger thread for child process of service ${workerData.id} ${message}.`, {
-    error: errors.ensureLoggableError(error)
+    error: ensureLoggableError(error)
   })
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/basic",
-  "version": "2.0.0-alpha.9",
+  "version": "2.0.0",
   "description": "",
   "main": "index.js",
   "type": "module",
@@ -23,15 +23,16 @@
     "split2": "^4.2.0",
     "undici": "^6.19.5",
     "ws": "^8.18.0",
-    "@platformatic/config": "2.0.0-alpha.9",
-    "@platformatic/itc": "2.0.0-alpha.9",
-    "@platformatic/utils": "2.0.0-alpha.9"
+    "@platformatic/config": "2.0.0",
+    "@platformatic/itc": "2.0.0",
+    "@platformatic/telemetry": "2.0.0",
+    "@platformatic/utils": "2.0.0"
   },
   "devDependencies": {
     "borp": "^0.17.0",
     "eslint": "9",
     "express": "^4.19.2",
-    "fastify": "5.0.0-alpha.4",
+    "fastify": "^5.0.0",
     "json-schema-to-typescript": "^15.0.0",
     "neostandard": "^0.11.1",
     "next": "^14.2.5",
@@ -39,8 +40,8 @@
     "react-dom": "^18.3.1",
     "typescript": "^5.5.4",
     "vite": "^5.4.0",
-    "@platformatic/composer": "2.0.0-alpha.9",
-    "@platformatic/service": "2.0.0-alpha.9"
+    "@platformatic/service": "2.0.0",
+    "@platformatic/composer": "2.0.0"
   },
   "scripts": {
     "gen-schema": "node lib/schema.js > schema.json",

package/schema.json

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