@platformatic/basic 2.3.1 → 3.4.1

package/lib/base.js

@@ -26,7 +26,7 @@ export class BaseStackable {
     this.configManager = configManager
     this.serverConfig = deepmerge(options.context.serverConfig ?? {}, configManager.current.server ?? {})
     this.openapiSchema = null
-    this.getGraphqlSchema = null
+    this.graphqlSchema = null
     this.isEntrypoint = options.context.isEntrypoint
     this.isProduction = options.context.isProduction
 
@@ -65,6 +65,10 @@ export class BaseStackable {
 
     const enabled = config.watch?.enabled !== false
 
+    if (!enabled) {
+      return { enabled, path: this.root }
+    }
+
     return {
       enabled,
       path: this.root,
@@ -125,7 +129,7 @@ export class BaseStackable {
     }
   }
 
-  async buildWithCommand (command, basePath, loader) {
+  async buildWithCommand (command, basePath, loader, scripts) {
     if (Array.isArray(command)) {
       command = command.join(' ')
     }
@@ -135,12 +139,14 @@ export class BaseStackable {
     this.#childManager = new ChildManager({
       logger: this.logger,
       loader,
+      scripts,
       context: {
         id: this.id,
         // Always use URL to avoid serialization problem in Windows
         root: pathToFileURL(this.root).toString(),
         basePath,
         logLevel: this.logger.level,
+        /* c8 ignore next 2 */
         port: (this.isEntrypoint ? this.serverConfig?.port || 0 : undefined) ?? true,
         host: (this.isEntrypoint ? this.serverConfig?.hostname : undefined) ?? true
       }
@@ -158,10 +164,12 @@ export class BaseStackable {
       })
 
       // Route anything not catched by child process logger to the logger manually
+      /* c8 ignore next 3 */
       subprocess.stdout.pipe(split2()).on('data', line => {
         this.logger.info(line)
       })
 
+      /* c8 ignore next 3 */
       subprocess.stderr.pipe(split2()).on('data', line => {
         this.logger.error(line)
       })
@@ -191,6 +199,7 @@ export class BaseStackable {
         root: pathToFileURL(this.root).toString(),
         basePath,
         logLevel: this.logger.level,
+        /* c8 ignore next 2 */
         port: (this.isEntrypoint ? this.serverConfig?.port || 0 : undefined) ?? true,
         host: (this.isEntrypoint ? this.serverConfig?.hostname : undefined) ?? true,
         telemetry: this.telemetryConfig
@@ -207,10 +216,12 @@ export class BaseStackable {
       this.subprocess = this.spawn(command)
 
       // Route anything not catched by child process logger to the logger manually
+      /* c8 ignore next 3 */
       this.subprocess.stdout.pipe(split2()).on('data', line => {
         this.logger.info(line)
       })
 
+      /* c8 ignore next 3 */
       this.subprocess.stderr.pipe(split2()).on('data', line => {
         this.logger.error(line)
       })
@@ -223,14 +234,16 @@ export class BaseStackable {
 
       this.#subprocessStarted = true
     } catch (e) {
+      this.#childManager.close('SIGKILL')
       throw new Error(`Cannot execute command "${command}": executable not found`)
     } finally {
       await this.#childManager.eject()
     }
 
-    // // If the process exits prematurely, terminate the thread with the same code
+    // If the process exits prematurely, terminate the thread with the same code
     this.subprocess.on('exit', code => {
       if (this.#subprocessStarted && typeof code === 'number' && code !== 0) {
+        this.#childManager.close('SIGKILL')
         process.exit(code)
       }
     })
@@ -248,9 +261,14 @@ export class BaseStackable {
     await exitPromise
   }
 
+  getChildManager () {
+    return this.#childManager
+  }
+
   spawn (command) {
     const [executable, ...args] = parseCommandString(command)
 
+    /* c8 ignore next 3 */
     return platform() === 'win32'
       ? spawn(command, { cwd: this.root, shell: true, windowsVerbatimArguments: true })
       : spawn(executable, args, { cwd: this.root })

package/lib/errors.js

@@ -17,5 +17,5 @@ export const UnsupportedVersion = createError(
 
 export const NonZeroExitCode = createError(
   `${ERROR_PREFIX}_NON_ZERO_EXIT_CODE`,
-  'Process exit with non zero exit code %d.'
+  'Process exited with non zero exit code %d.'
 )

package/lib/utils.js

@@ -9,15 +9,15 @@ export function getServerUrl (server) {
 }
 
 export async function injectViaRequest (baseUrl, injectParams, onInject) {
-  const url = new URL(injectParams.url, baseUrl).href
-  const requestParams = { method: injectParams.method, headers: injectParams.headers }
+  try {
+    const url = new URL(injectParams.url, baseUrl).href
+    const requestParams = { method: injectParams.method, headers: injectParams.headers }
 
-  if (injectParams.body) {
-    const body = injectParams.body
-    requestParams.body = typeof body === 'object' ? JSON.stringify(body) : body
-  }
+    if (injectParams.body) {
+      const body = injectParams.body
+      requestParams.body = typeof body === 'object' ? JSON.stringify(body) : body
+    }
 
-  try {
     const { statusCode, headers, body } = await request(url, requestParams)
 
     const rawPayload = Buffer.from(await body.arrayBuffer())
@@ -53,11 +53,13 @@ export function ensureFileUrl (pathOrUrl) {
   return pathToFileURL(pathOrUrl)
 }
 
+/* c8 ignore next 4 */
 // This is to avoid common path/URL problems on Windows
 export function importFile (path) {
   return import(ensureFileUrl(path))
 }
 
+/* c8 ignore next 6 */
 export function resolvePackage (root, pkg) {
   const require = createRequire(root)
 

package/lib/worker/child-manager.js

@@ -11,17 +11,18 @@ import { request } from 'undici'
 import { WebSocketServer } from 'ws'
 import { exitCodes } from '../errors.js'
 import { ensureFileUrl } from '../utils.js'
-
 export const isWindows = platform() === 'win32'
 
 // In theory we could use the context.id to namespace even more, but due to
 // UNIX socket length limitation on MacOS, we don't.
-function generateChildrenId (context) {
+export function generateChildrenId (context) {
   return [process.pid, Date.now()].join('-')
 }
 
 export function getSocketPath (id) {
   let socketPath = null
+
+  /* c8 ignore next 7 */
   if (platform() === 'win32') {
     socketPath = `\\\\.\\pipe\\plt-${id}`
   } else {
@@ -59,7 +60,9 @@ export class ChildManager extends ITC {
       ...itcOpts,
       handlers: {
         log: message => {
-          return this.#log(message)
+          /* c8 ignore next */
+          const logs = Array.isArray(message.logs) ? message.logs : [message.logs]
+          this._forwardLogs(logs)
         },
         fetch: request => {
           return this.#fetch(request)
@@ -106,6 +109,7 @@ export class ChildManager extends ITC {
         this.#clients.delete(ws)
       })
 
+      /* c8 ignore next 7 */
       ws.on('error', error => {
         this.#handleUnexpectedError(
           error,
@@ -121,13 +125,16 @@ export class ChildManager extends ITC {
   }
 
   async close (signal) {
-    await rm(this.#dataPath)
+    if (this.#dataPath) {
+      await rm(this.#dataPath, { force: true })
+    }
 
     for (const client of this.#clients) {
       this.#currentClient = client
       this._send(generateNotification('close', signal))
     }
 
+    this.#server?.close()
     super.close()
   }
 
@@ -163,16 +170,24 @@ export class ChildManager extends ITC {
     process.env.PLT_MANAGER_ID = ''
   }
 
+  getSocketPath () {
+    return this.#socketPath
+  }
+
+  getClients () {
+    return this.#clients
+  }
+
   register () {
     register(this.#loader, { data: this.#context })
   }
 
   send (client, name, message) {
     this.#currentClient = client
-    super.send(name, message)
+    return super.send(name, message)
   }
 
-  _send (message) {
+  _send (message, stringify = true) {
     if (!this.#currentClient) {
       this.#currentClient = this.#requests.get(message.reqId)
       this.#requests.delete(message.reqId)
@@ -182,7 +197,7 @@ export class ChildManager extends ITC {
       }
     }
 
-    this.#currentClient.send(JSON.stringify(message))
+    this.#currentClient.send(stringify ? JSON.stringify(message) : message)
     this.#currentClient = null
   }
 
@@ -198,8 +213,8 @@ export class ChildManager extends ITC {
     this.#server.close()
   }
 
-  #log (message) {
-    const logs = Array.isArray(message.logs) ? message.logs : [message.logs]
+  /* c8 ignore next 3 */
+  _forwardLogs (logs) {
     workerData.loggingPort.postMessage({ logs: logs.map(m => JSON.stringify(m)) })
   }
 

package/lib/worker/child-process.js

@@ -86,6 +86,7 @@ export class ChildProcess extends ITC {
   constructor () {
     super({ throwOnMissingHandler: false, name: `${process.env.PLT_MANAGER_ID}-child-process` })
 
+    /* c8 ignore next */
     const protocol = platform() === 'win32' ? 'ws+unix:' : 'ws+unix://'
     this.#socket = new WebSocket(`${protocol}${getSocketPath(process.env.PLT_MANAGER_ID)}`)
     this.#pendingMessages = []
@@ -109,6 +110,7 @@ export class ChildProcess extends ITC {
       // Never hang the process on this socket.
       this.#socket._socket.unref()
 
+      /* c8 ignore next 3 */
       for (const message of this.#pendingMessages) {
         this.#socket.send(message)
       }
@@ -123,6 +125,7 @@ export class ChildProcess extends ITC {
       }
     })
 
+    /* c8 ignore next 5 */
     this.#socket.on('error', error => {
       process._rawDebug(error)
       // There is nothing to log here as the connection with the parent thread is lost. Exit with a special code
@@ -131,6 +134,7 @@ export class ChildProcess extends ITC {
   }
 
   _send (message) {
+    /* c8 ignore next 4 */
     if (this.#socket.readyState === WebSocket.CONNECTING) {
       this.#pendingMessages.push(JSON.stringify(message))
       return
@@ -143,6 +147,7 @@ export class ChildProcess extends ITC {
     return once(this.#socket, 'close')
   }
 
+  /* c8 ignore next 3 */
   _close () {
     this.#socket.close()
   }
@@ -167,6 +172,7 @@ export class ChildProcess extends ITC {
     }
   }
 
+  /* c8 ignore next 5 */
   #setupTelemetry () {
     if (globalThis.platformatic.telemetry) {
       setupNodeHTTPTelemetry(globalThis.platformatic.telemetry, this.#logger)
@@ -202,11 +208,12 @@ export class ChildProcess extends ITC {
         }
 
         const { family, address: host, port } = address
+        /* c8 ignore next */
         const url = new URL(family === 'IPv6' ? `http://[${host}]:${port}` : `http://${host}:${port}`).origin
 
         this.notify('url', url)
       },
-      error: error => {
+      error: ({ error }) => {
         tracingChannel('net.server.listen').unsubscribe(subscribers)
         this.notify('error', error)
       }
@@ -226,7 +233,8 @@ export class ChildProcess extends ITC {
         `Child process for service ${globalThis.platformatic.id} threw an ${type}.`
       )
 
-      process.exit(exitCodes.PROCESS_UNHANDLED_ERROR)
+      // Give some time to the logger and ITC notifications to land before shutting down
+      setTimeout(() => process.exit(exitCodes.PROCESS_UNHANDLED_ERROR), 100)
     }
 
     process.on('uncaughtException', handleUnhandled.bind(this, 'uncaught exception'))
@@ -255,6 +263,7 @@ async function main () {
   globalThis[Symbol.for('plt.children.itc')] = new ChildProcess()
 }
 
+/* c8 ignore next 3 */
 if (!isWindows || basename(process.argv.at(-1)) !== 'npm-prefix.js') {
   await main()
 }

package/lib/worker/child-transport.js

@@ -7,12 +7,14 @@ import build from 'pino-abstract-transport'
 import { WebSocket } from 'ws'
 import { getSocketPath } from './child-manager.js'
 
+/* c8 ignore next 5 */
 function logDirectError (message, error) {
   process._rawDebug(`Logger thread for child process of service ${workerData.id} ${message}.`, {
     error: ensureLoggableError(error)
   })
 }
 
+/* c8 ignore next 4 */
 function handleUnhandled (type, error) {
   logDirectError(`threw an ${type}`, error)
   process.exit(6)
@@ -23,6 +25,7 @@ process.on('unhandledRejection', handleUnhandled.bind(null, 'unhandled rejection
 
 export default async function (opts) {
   try {
+    /* c8 ignore next */
     const protocol = platform() === 'win32' ? 'ws+unix:' : 'ws+unix://'
     const socket = new WebSocket(`${protocol}${getSocketPath(process.env.PLT_MANAGER_ID)}`)
 
@@ -31,6 +34,7 @@ export default async function (opts) {
     // Do not process responses but empty the socket inbound queue
     socket.on('message', () => {})
 
+    /* c8 ignore next 3 */
     socket.on('error', error => {
       logDirectError('threw a socket error', error)
     })
@@ -48,6 +52,7 @@ export default async function (opts) {
         }
       }
     )
+    /* c8 ignore next 3 */
   } catch (error) {
     logDirectError('threw a connection error', error)
   }

package/lib/worker/listeners.js

@@ -1,7 +1,7 @@
 import { withResolvers } from '@platformatic/utils'
 import { subscribe, tracingChannel, unsubscribe } from 'node:diagnostics_channel'
 
-export function createServerListener (overridePort = true, overrideHost = true) {
+export function createServerListener (overridePort = true, overrideHost) {
   const { promise, resolve, reject } = withResolvers()
 
   const subscribers = {
@@ -19,9 +19,10 @@ export function createServerListener (overridePort = true, overrideHost = true)
       }
     },
     asyncEnd ({ server }) {
+      cancel()
       resolve(server)
     },
-    error (error) {
+    error ({ error }) {
       cancel()
       reject(error)
     }
@@ -32,8 +33,10 @@ export function createServerListener (overridePort = true, overrideHost = true)
   }
 
   tracingChannel('net.server.listen').subscribe(subscribers)
-  promise.finally(cancel)
-  promise.cancel = resolve.bind(null, null)
+  promise.cancel = function () {
+    cancel()
+    resolve(null)
+  }
 
   return promise
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/basic",
-  "version": "2.3.1",
+  "version": "3.4.1",
   "description": "",
   "main": "index.js",
   "type": "module",
@@ -23,10 +23,10 @@
     "split2": "^4.2.0",
     "undici": "^6.19.5",
     "ws": "^8.18.0",
-    "@platformatic/itc": "2.3.1",
-    "@platformatic/config": "2.3.1",
-    "@platformatic/utils": "2.3.1",
-    "@platformatic/telemetry": "2.3.1"
+    "@platformatic/config": "3.4.1",
+    "@platformatic/itc": "3.4.1",
+    "@platformatic/telemetry": "3.4.1",
+    "@platformatic/utils": "3.4.1"
   },
   "devDependencies": {
     "borp": "^0.17.0",

package/schema.json

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