@platformatic/runtime 3.72.0 → 4.0.0-alpha.2

package/lib/management-api.js

@@ -3,18 +3,22 @@ import fastifyWebsocket from '@fastify/websocket'
 import {
   applications as applicationSchema,
   createDirectory,
+  createValidator,
   createSharedTemporaryDirectory,
   kMetadata,
   safeRemove,
   validate
 } from '@platformatic/foundation'
+import { schemaComponents } from '@platformatic/foundation/schema'
 import fastify from 'fastify'
 import { chmod } from 'node:fs/promises'
 import { platform, tmpdir } from 'node:os'
 import { dirname, join } from 'node:path'
 import { setTimeout as sleep } from 'node:timers/promises'
 import { createWebSocketStream } from 'ws'
-import { prepareApplication } from './config.js'
+import { prepareAddedApplications } from './config.js'
+import { readMemory } from './memory.js'
+import { MetricsDisabledError } from './errors.js'
 
 const PLATFORMATIC_TMP_DIR = join(tmpdir(), 'platformatic', 'runtimes')
 
@@ -99,18 +103,6 @@ export async function managementApiPlugin (app, opts) {
     return runtime.getRuntimeMetadata()
   })
 
-  app.get('/config', quiet, async request => {
-    const metadata = request.query.metadata === 'true'
-    const rawConfig = await runtime.getRuntimeConfig(metadata)
-
-    if (metadata) {
-      const { [kMetadata]: __metadata, ...config } = rawConfig
-      return { ...config, __metadata }
-    }
-
-    return rawConfig
-  })
-
   app.get('/env', quiet, async () => {
     return { ...process.env, ...runtime.getRuntimeEnv() }
   })
@@ -147,6 +139,20 @@ export async function managementApiPlugin (app, opts) {
     return runtime.getApplications()
   })
 
+  app.get('/memory', quiet, async () => {
+    return readMemory()
+  })
+
+  app.get('/workers/scaler', quiet, async (_request, reply) => {
+    const scaler = runtime.getDynamicWorkersScaler()
+    if (!scaler) {
+      reply.code(404)
+      return { statusCode: 404, error: 'Not Found', message: 'Dynamic workers scaling is not enabled.' }
+    }
+
+    return scaler.getDiagnostics()
+  })
+
   app.post('/applications', async (request, reply) => {
     let applications = request.body
 
@@ -169,11 +175,9 @@ export async function managementApiPlugin (app, opts) {
       }
     }
 
-    for (let i = 0; i < applications.length; i++) {
-      applications[i] = await prepareApplication(config, applications[i], config.workers)
-    }
+    const prepared = await prepareAddedApplications(config, applications, runtime.getApplicationsIds())
 
-    const created = await runtime.addApplications(applications, request.query.start !== 'false')
+    const created = await runtime.addApplications(prepared, request.query.start !== 'false')
     reply.code(201)
     return created
   })
@@ -302,16 +306,31 @@ export async function managementApiPlugin (app, opts) {
     return reply
   })
 
+  const metricsSchema = schemaComponents.runtimeProperties.metrics.anyOf[1]
+  app.patch('/metrics', {
+    schema: {
+      body: {
+        ...metricsSchema,
+        minProperties: 1,
+        properties: { ...metricsSchema.properties, enabled: { type: 'boolean' } }
+      }
+    },
+    // A patch must not inject defaults, coerce values, or silently discard unknown options.
+    validatorCompiler: ({ schema }) => createValidator(schema, {
+      useDefaults: false,
+      coerceTypes: false,
+      removeAdditional: false
+    }, { root: runtime.getRuntimeConfig(true)[kMetadata].root })
+  }, async req => runtime.updateMetricsConfig(req.body))
+
   app.get('/metrics', quiet, async (req, reply) => {
-    const config = await runtime.getRuntimeConfig()
+    // The live read: this needs one boolean, and the public getter builds a frozen snapshot of the
+    // whole configuration -- which is the right shape to hand a consumer and the wrong one to pay
+    // for on a scrape.
+    const config = runtime.getRuntimeConfig(true)
 
-    if (config.metrics?.enabled === false) {
-      reply.code(501)
-      return {
-        statusCode: 501,
-        error: 'Not Implemented',
-        message: 'Metrics are disabled.'
-      }
+    if (config.metrics === false || config.metrics?.enabled === false) {
+      throw new MetricsDisabledError()
     }
 
     const accepts = req.accepts()
@@ -326,53 +345,6 @@ export async function managementApiPlugin (app, opts) {
     return metrics
   })
 
-  // TODO: Remove in next major version - deprecated endpoint
-  app.get('/metrics/live', { ...quiet, websocket: true }, async socket => {
-    const config = await runtime.getRuntimeConfig()
-
-    if (config.metrics?.enabled === false) {
-      socket.send(
-        JSON.stringify({
-          statusCode: 501,
-          error: 'Not Implemented',
-          message: 'Metrics are disabled.'
-        }),
-        () => {
-          socket.close()
-        }
-      )
-
-      return
-    }
-
-    const pollAndSendMetrics = async () => {
-      try {
-        const metrics = await runtime.getFormattedMetrics()
-        if (metrics) {
-          const serializedMetrics = JSON.stringify(metrics)
-          socket.send(serializedMetrics + '\n')
-        }
-      } catch (error) {
-        // If there's an error, stop polling and close the connection
-        clearInterval(pollingInterval)
-        socket.close()
-      }
-    }
-
-    // Poll every second
-    const pollingInterval = setInterval(pollAndSendMetrics, 1000)
-
-    // Send initial metrics immediately
-    await pollAndSendMetrics()
-
-    const cleanup = () => {
-      clearInterval(pollingInterval)
-    }
-
-    socket.on('error', cleanup)
-    socket.on('close', cleanup)
-  })
-
   app.get('/logs/live', { ...quiet, websocket: true }, async socket => {
     runtime.addLoggerDestination(createWebSocketStream(socket))
   })

package/lib/management-handlers.js

@@ -3,7 +3,7 @@ import {
   kMetadata,
   validate
 } from '@platformatic/foundation'
-import { prepareApplication } from './config.js'
+import { prepareAddedApplications } from './config.js'
 
 const allOperations = [
   'getRuntimeStatus',
@@ -138,11 +138,9 @@ export function createManagementHandlers (runtime, allowedOperations) {
 
     validate(applicationSchema, applications, {}, true, config[kMetadata].root)
 
-    for (let i = 0; i < applications.length; i++) {
-      applications[i] = await prepareApplication(config, applications[i], config.workers)
-    }
+    const prepared = await prepareAddedApplications(config, applications, runtime.getApplicationsIds())
 
-    return runtime.addApplications(applications, start)
+    return runtime.addApplications(prepared, start)
   })
 
   register('removeApplications', async ({ ids }) => {

package/lib/memory.js

@@ -0,0 +1,29 @@
+import { getMemoryInfo } from './metrics.js'
+
+// Memory readings are shared for ttlMs, and concurrent callers share one read.
+// The scope (host or cgroup) is detected on the first read and then reused.
+export function createMemoryReader ({ read = getMemoryInfo, ttlMs = 1000 } = {}) {
+  let scope
+  let reading = null
+  let readAt = 0
+  let pending = null
+
+  return function readMemory () {
+    if (reading && Date.now() - readAt < ttlMs) return Promise.resolve(reading)
+
+    pending ??= read({ scope })
+      .then(info => {
+        scope = info.scope
+        reading = info
+        readAt = Date.now()
+        return info
+      })
+      .finally(() => {
+        pending = null
+      })
+    return pending
+  }
+}
+
+// Shared by every caller in the process, so they share one cached reading.
+export const readMemory = createMemoryReader()

package/lib/policies.js

@@ -21,3 +21,30 @@ export function createChannelCreationHook (config) {
     return !forbidden.has(`${first.toLowerCase()}:${second.toLowerCase()}`)
   }
 }
+
+export function createTargetPermissionHook (config) {
+  const denyList = config.policies?.deny
+
+  if (typeof denyList === 'undefined') {
+    return undefined
+  }
+
+  const forbidden = new Set()
+
+  for (let [first, unalloweds] of Object.entries(denyList)) {
+    for (let second of unalloweds) {
+      first = first.toLowerCase()
+      second = second.toLowerCase()
+
+      forbidden.add(`${first}:${second}`)
+      forbidden.add(`${second}:${first}`)
+    }
+  }
+
+  return function targetPermissionHook (req, target) {
+    const source = config.applicationId ?? req?.headers?.['x-plt-application-id']
+    const destination = target?.metadata?.applicationId
+
+    return !source || !destination || !forbidden.has(`${source.toLowerCase()}:${destination.toLowerCase()}`)
+  }
+}