@platformatic/runtime 3.0.0-alpha.5 → 3.0.0-alpha.8

package/lib/management-api.js

@@ -1,16 +1,16 @@
-'use strict'
-
-const { platform, tmpdir } = require('node:os')
-const { join } = require('node:path')
-const { createDirectory, safeRemove } = require('@platformatic/foundation')
-
-const fastify = require('fastify')
-const ws = require('ws')
+import fastifyAccepts from '@fastify/accepts'
+import fastifyWebsocket from '@fastify/websocket'
+import { createDirectory, safeRemove } from '@platformatic/foundation'
+import fastify from 'fastify'
+import { platform, tmpdir } from 'node:os'
+import { join } from 'node:path'
+import { setTimeout as sleep } from 'node:timers/promises'
+import { createWebSocketStream } from 'ws'
 
 const PLATFORMATIC_TMP_DIR = join(tmpdir(), 'platformatic', 'runtimes')
 
-async function managementApiPlugin (app, opts) {
-  app.register(require('@fastify/accepts'))
+export async function managementApiPlugin (app, opts) {
+  app.register(fastifyAccepts)
 
   const runtime = opts.runtime
 
@@ -32,62 +32,62 @@ async function managementApiPlugin (app, opts) {
   })
 
   app.post('/stop', async () => {
-    app.log.debug('stop services')
+    app.log.debug('stop applications')
     await runtime.close()
   })
 
   app.post('/restart', async () => {
-    app.log.debug('restart services')
+    app.log.debug('restart applications')
     await runtime.restart()
   })
 
-  app.get('/services', async () => {
-    return runtime.getServices()
+  app.get('/applications', async () => {
+    return runtime.getApplications()
   })
 
-  app.get('/services/:id', async request => {
+  app.get('/applications/:id', async request => {
     const { id } = request.params
-    app.log.debug('get service details', { id })
-    return runtime.getServiceDetails(id)
+    app.log.debug('get application details', { id })
+    return runtime.getApplicationDetails(id)
   })
 
-  app.get('/services/:id/config', async request => {
+  app.get('/applications/:id/config', async request => {
     const { id } = request.params
-    app.log.debug('get service config', { id })
-    return runtime.getServiceConfig(id)
+    app.log.debug('get application config', { id })
+    return runtime.getApplicationConfig(id)
   })
 
-  app.get('/services/:id/env', async request => {
+  app.get('/applications/:id/env', async request => {
     const { id } = request.params
-    app.log.debug('get service config', { id })
-    return runtime.getServiceEnv(id)
+    app.log.debug('get application config', { id })
+    return runtime.getApplicationEnv(id)
   })
 
-  app.get('/services/:id/openapi-schema', async request => {
+  app.get('/applications/:id/openapi-schema', async request => {
     const { id } = request.params
     app.log.debug('get openapi-schema', { id })
-    return runtime.getServiceOpenapiSchema(id)
+    return runtime.getApplicationOpenapiSchema(id)
   })
 
-  app.get('/services/:id/graphql-schema', async request => {
+  app.get('/applications/:id/graphql-schema', async request => {
     const { id } = request.params
     app.log.debug('get graphql-schema', { id })
-    return runtime.getServiceGraphqlSchema(id)
+    return runtime.getApplicationGraphqlSchema(id)
   })
 
-  app.post('/services/:id/start', async request => {
+  app.post('/applications/:id/start', async request => {
     const { id } = request.params
-    app.log.debug('start service', { id })
-    await runtime.startService(id)
+    app.log.debug('start application', { id })
+    await runtime.startApplication(id)
   })
 
-  app.post('/services/:id/stop', async request => {
+  app.post('/applications/:id/stop', async request => {
     const { id } = request.params
-    app.log.debug('stop service', { id })
-    await runtime.stopService(id)
+    app.log.debug('stop application', { id })
+    await runtime.stopApplication(id)
   })
 
-  app.all('/services/:id/proxy/*', async (request, reply) => {
+  app.all('/applications/:id/proxy/*', async (request, reply) => {
     const { id, '*': requestUrl } = request.params
     app.log.debug('proxy request', { id, requestUrl })
 
@@ -112,6 +112,23 @@ async function managementApiPlugin (app, opts) {
     reply.code(res.statusCode).headers(res.headers).send(res.body)
   })
 
+  app.post('/applications/:id/pprof/start', async (request, reply) => {
+    const { id } = request.params
+    app.log.debug('start profiling', { id })
+
+    const options = request.body || {}
+    await runtime.startApplicationProfiling(id, options)
+    reply.code(200).send({})
+  })
+
+  app.post('/applications/:id/pprof/stop', async (request, reply) => {
+    const { id } = request.params
+    app.log.debug('stop profiling', { id })
+
+    const profileData = await runtime.stopApplicationProfiling(id)
+    reply.type('application/octet-stream').code(200).send(profileData)
+  })
+
   app.get('/metrics', { logLevel: 'debug' }, async (req, reply) => {
     const accepts = req.accepts()
 
@@ -149,46 +166,57 @@ async function managementApiPlugin (app, opts) {
   })
 
   app.get('/logs/live', { websocket: true }, async (socket, req) => {
-    runtime.addLoggerDestination(ws.createWebSocketStream(socket))
+    runtime.addLoggerDestination(createWebSocketStream(socket))
   })
 }
 
-async function startManagementApi (runtime, root) {
+export async function startManagementApi (runtime) {
   const runtimePID = process.pid
 
-  try {
-    const runtimePIDDir = join(PLATFORMATIC_TMP_DIR, runtimePID.toString())
+  const runtimePIDDir = join(PLATFORMATIC_TMP_DIR, runtimePID.toString())
+  if (platform() !== 'win32') {
+    await createDirectory(runtimePIDDir, true)
+  }
+
+  let socketPath = null
+  if (platform() === 'win32') {
+    socketPath = '\\\\.\\pipe\\platformatic-' + runtimePID.toString()
+  } else {
+    socketPath = join(runtimePIDDir, 'socket')
+  }
+
+  const managementApi = fastify()
+  managementApi.register(fastifyWebsocket)
+  managementApi.register(managementApiPlugin, { runtime, prefix: '/api/v1' })
+
+  managementApi.addHook('onClose', async () => {
     if (platform() !== 'win32') {
-      await createDirectory(runtimePIDDir, true)
+      await safeRemove(runtimePIDDir)
     }
+  })
 
-    let socketPath = null
-    if (platform() === 'win32') {
-      socketPath = '\\\\.\\pipe\\platformatic-' + runtimePID.toString()
-    } else {
-      socketPath = join(runtimePIDDir, 'socket')
-    }
+  // When the runtime closes, close the management API as well
+  runtime.on('closed', managementApi.close.bind(managementApi))
 
-    const managementApi = fastify()
-    managementApi.register(require('@fastify/websocket'))
-    managementApi.register(managementApiPlugin, { runtime, prefix: '/api/v1' })
+  /*
+    If runtime are started multiple times in a short
+    period of time (like in tests), there is a chance that the pipe is still in use
+    as the manament API server is closed after the runtime is closed (see event handler above).
 
-    managementApi.addHook('onClose', async () => {
-      if (platform() !== 'win32') {
-        await safeRemove(runtimePIDDir)
+    Since it's a very rare case, we simply retry couple of times.
+  */
+  for (let i = 0; i < 5; i++) {
+    try {
+      await managementApi.listen({ path: socketPath })
+      break
+    } catch (e) {
+      if (i === 5) {
+        throw e
       }
-    })
-
-    // When the runtime closes, close the management API as well
-    runtime.on('closed', managementApi.close.bind(managementApi))
 
-    await managementApi.listen({ path: socketPath })
-    return managementApi
-    /* c8 ignore next 4 */
-  } catch (err) {
-    console.error(err)
-    process.exit(1)
+      await sleep(100)
+    }
   }
-}
 
-module.exports = { startManagementApi, managementApiPlugin }
+  return managementApi
+}

package/lib/prom-server.js

@@ -1,6 +1,6 @@
-'use strict'
-
-const fastify = require('fastify')
+import fastifyAccepts from '@fastify/accepts'
+import fastifyBasicAuth from '@fastify/basic-auth'
+import fastify from 'fastify'
 
 const DEFAULT_HOSTNAME = '0.0.0.0'
 const DEFAULT_PORT = 9090
@@ -67,7 +67,7 @@ async function checkLiveness (runtime) {
   return { response, status }
 }
 
-async function startPrometheusServer (runtime, opts) {
+export async function startPrometheusServer (runtime, opts) {
   if (opts.enabled === false) {
     return
   }
@@ -77,19 +77,19 @@ async function startPrometheusServer (runtime, opts) {
   const auth = opts.auth ?? null
 
   const promServer = fastify({ name: 'Prometheus server' })
-  promServer.register(require('@fastify/accepts'))
+  promServer.register(fastifyAccepts)
 
   let onRequestHook
   if (auth) {
     const { username, password } = auth
 
-    await promServer.register(require('@fastify/basic-auth'), {
+    await promServer.register(fastifyBasicAuth, {
       validate: function (user, pass, req, reply, done) {
         if (username !== user || password !== pass) {
           return reply.code(401).send({ message: 'Unauthorized' })
         }
         return done()
-      },
+      }
     })
     onRequestHook = promServer.basicAuth
   }
@@ -129,7 +129,7 @@ async function startPrometheusServer (runtime, opts) {
         reply.type('text/plain')
       }
       return (await runtime.getMetrics(reqType)).metrics
-    },
+    }
   })
 
   if (opts.readiness !== false) {
@@ -167,7 +167,7 @@ async function startPrometheusServer (runtime, opts) {
             reply.status(failStatusCode).send(failBody)
           }
         }
-      },
+      }
     })
   }
 
@@ -206,14 +206,10 @@ async function startPrometheusServer (runtime, opts) {
             reply.status(failStatusCode).send(readiness?.body || failBody)
           }
         }
-      },
+      }
     })
   }
 
   await promServer.listen({ port, host })
   return promServer
 }
-
-module.exports = {
-  startPrometheusServer,
-}