@platformatic/runtime 2.0.0-alpha.1 → 2.0.0-alpha.3

package/lib/api-client.js

@@ -1,500 +0,0 @@
-'use strict'
-
-const { tmpdir } = require('node:os')
-const { join } = require('node:path')
-const { once, EventEmitter } = require('node:events')
-const { randomUUID, createHash } = require('node:crypto')
-const { createReadStream, watch } = require('node:fs')
-const { readdir, readFile, stat, access } = require('node:fs/promises')
-const { setTimeout: sleep } = require('node:timers/promises')
-const errors = require('./errors')
-const ts = require('tail-file-stream')
-
-const platformaticVersion = require('../package.json').version
-
-const MAX_LISTENERS_COUNT = 100
-const MAX_METRICS_QUEUE_LENGTH = 5 * 60 // 5 minutes in seconds
-const COLLECT_METRICS_TIMEOUT = 1000
-
-class RuntimeApiClient extends EventEmitter {
-  #exitCode
-  #exitPromise
-  #configManager
-  #runtimeTmpDir
-  #metrics
-  #metricsTimeout
-
-  constructor (worker, configManager) {
-    super()
-    this.setMaxListeners(MAX_LISTENERS_COUNT)
-
-    this.#configManager = configManager
-    this.#runtimeTmpDir = getRuntimeTmpDir(configManager.dirname)
-
-    this.setWorker(worker)
-  }
-
-  async setWorker (worker) {
-    if (!worker) {
-      throw new errors.WorkerIsRequired()
-    }
-    if (this.worker) {
-      this.worker.removeAllListeners('message')
-      // Ignore all things that happen after the worker has been replaced
-      this.#exitPromise.catch(() => {})
-    }
-    this.worker = worker
-    this.#exitPromise = this.#exitHandler()
-    this.worker.on('message', (message) => {
-      if (message.operationId) {
-        this.emit(message.operationId, message)
-      }
-    })
-
-    if (this.started) {
-      await this.start()
-    }
-  }
-
-  async #getRuntimePackageJson () {
-    const runtimeDir = this.#configManager.dirname
-    const packageJsonPath = join(runtimeDir, 'package.json')
-    const packageJsonFile = await readFile(packageJsonPath, 'utf8')
-    const packageJson = JSON.parse(packageJsonFile)
-    return packageJson
-  }
-
-  async getRuntimeMetadata () {
-    const packageJson = await this.#getRuntimePackageJson()
-    const entrypointDetails = await this.getEntrypointDetails()
-
-    return {
-      pid: process.pid,
-      cwd: process.cwd(),
-      argv: process.argv,
-      uptimeSeconds: Math.floor(process.uptime()),
-      execPath: process.execPath,
-      nodeVersion: process.version,
-      projectDir: this.#configManager.dirname,
-      packageName: packageJson.name ?? null,
-      packageVersion: packageJson.version ?? null,
-      url: entrypointDetails?.url ?? null,
-      platformaticVersion
-    }
-  }
-
-  getRuntimeConfig () {
-    return this.#configManager.current
-  }
-
-  async start () {
-    const address = await this.#sendCommand('plt:start-services')
-    this.started = true
-    this.emit('start', address)
-    return address
-  }
-
-  async close () {
-    this.started = false
-    await this.#sendCommand('plt:stop-services')
-
-    this.worker.postMessage({ command: 'plt:close' })
-    const res = await Promise.race([
-      this.#exitPromise,
-      // We must kill the worker if it doesn't exit in 10 seconds
-      // because it may be stuck in an infinite loop.
-      // This is a workaround for
-      // https://github.com/nodejs/node/issues/47748
-      // https://github.com/nodejs/node/issues/49344
-      // Remove once https://github.com/nodejs/node/pull/51290 is released
-      // on all lines.
-      // Likely to be removed when we drop support for Node.js 18.
-      sleep(10000, 'timeout', { ref: false })
-    ])
-
-    if (res === 'timeout') {
-      this.worker.unref()
-    }
-  }
-
-  async restart () {
-    return this.#sendCommand('plt:restart-services')
-  }
-
-  async getEntrypointDetails () {
-    return this.#sendCommand('plt:get-entrypoint-details')
-  }
-
-  async getServices () {
-    return this.#sendCommand('plt:get-services')
-  }
-
-  async getServiceDetails (id) {
-    return this.#sendCommand('plt:get-service-details', { id })
-  }
-
-  async getServiceConfig (id) {
-    return this.#sendCommand('plt:get-service-config', { id })
-  }
-
-  async getServiceOpenapiSchema (id) {
-    return this.#sendCommand('plt:get-service-openapi-schema', { id })
-  }
-
-  async getServiceGraphqlSchema (id) {
-    return this.#sendCommand('plt:get-service-graphql-schema', { id })
-  }
-
-  async getMetrics (format = 'json') {
-    return this.#sendCommand('plt:get-metrics', { format })
-  }
-
-  async startService (id) {
-    return this.#sendCommand('plt:start-service', { id })
-  }
-
-  async stopService (id) {
-    return this.#sendCommand('plt:stop-service', { id })
-  }
-
-  async inject (id, injectParams) {
-    return this.#sendCommand('plt:inject', { id, injectParams })
-  }
-
-  getCachedMetrics () {
-    return this.#metrics
-  }
-
-  async getFormattedMetrics () {
-    const { metrics } = await this.getMetrics()
-
-    if (metrics === null) return null
-
-    const entrypointDetails = await this.getEntrypointDetails()
-    const entrypointConfig = await this.getServiceConfig(entrypointDetails.id)
-    const entrypointMetricsPrefix = entrypointConfig.metrics?.prefix
-
-    const cpuMetric = metrics.find(
-      (metric) => metric.name === 'process_cpu_percent_usage'
-    )
-    const rssMetric = metrics.find(
-      (metric) => metric.name === 'process_resident_memory_bytes'
-    )
-    const totalHeapSizeMetric = metrics.find(
-      (metric) => metric.name === 'nodejs_heap_size_total_bytes'
-    )
-    const usedHeapSizeMetric = metrics.find(
-      (metric) => metric.name === 'nodejs_heap_size_used_bytes'
-    )
-    const heapSpaceSizeTotalMetric = metrics.find(
-      (metric) => metric.name === 'nodejs_heap_space_size_total_bytes'
-    )
-    const newSpaceSizeTotalMetric = heapSpaceSizeTotalMetric.values.find(
-      (value) => value.labels.space === 'new'
-    )
-    const oldSpaceSizeTotalMetric = heapSpaceSizeTotalMetric.values.find(
-      (value) => value.labels.space === 'old'
-    )
-    const eventLoopUtilizationMetric = metrics.find(
-      (metric) => metric.name === 'nodejs_eventloop_utilization'
-    )
-
-    let p50Value = 0
-    let p90Value = 0
-    let p95Value = 0
-    let p99Value = 0
-
-    if (entrypointMetricsPrefix) {
-      const metricName = entrypointMetricsPrefix + 'http_request_all_summary_seconds'
-      const httpLatencyMetrics = metrics.find((metric) => metric.name === metricName)
-
-      p50Value = httpLatencyMetrics.values.find(
-        (value) => value.labels.quantile === 0.5
-      ).value || 0
-      p90Value = httpLatencyMetrics.values.find(
-        (value) => value.labels.quantile === 0.9
-      ).value || 0
-      p95Value = httpLatencyMetrics.values.find(
-        (value) => value.labels.quantile === 0.95
-      ).value || 0
-      p99Value = httpLatencyMetrics.values.find(
-        (value) => value.labels.quantile === 0.99
-      ).value || 0
-
-      p50Value = Math.round(p50Value * 1000)
-      p90Value = Math.round(p90Value * 1000)
-      p95Value = Math.round(p95Value * 1000)
-      p99Value = Math.round(p99Value * 1000)
-    }
-
-    const cpu = cpuMetric.values[0].value
-    const rss = rssMetric.values[0].value
-    const elu = eventLoopUtilizationMetric.values[0].value
-    const totalHeapSize = totalHeapSizeMetric.values[0].value
-    const usedHeapSize = usedHeapSizeMetric.values[0].value
-    const newSpaceSize = newSpaceSizeTotalMetric.value
-    const oldSpaceSize = oldSpaceSizeTotalMetric.value
-
-    const formattedMetrics = {
-      version: 1,
-      date: new Date().toISOString(),
-      cpu,
-      elu,
-      rss,
-      totalHeapSize,
-      usedHeapSize,
-      newSpaceSize,
-      oldSpaceSize,
-      entrypoint: {
-        latency: {
-          p50: p50Value,
-          p90: p90Value,
-          p95: p95Value,
-          p99: p99Value
-        }
-      }
-    }
-    return formattedMetrics
-  }
-
-  startCollectingMetrics () {
-    this.#metrics = []
-    this.#metricsTimeout = setInterval(async () => {
-      let metrics = null
-      try {
-        metrics = await this.getFormattedMetrics()
-      } catch (error) {
-        if (!(error instanceof errors.RuntimeExitedError)) {
-          // TODO(mcollina): use the logger
-          console.error('Error collecting metrics', error)
-        }
-        return
-      }
-
-      this.emit('metrics', metrics)
-      this.#metrics.push(metrics)
-      if (this.#metrics.length > MAX_METRICS_QUEUE_LENGTH) {
-        this.#metrics.shift()
-      }
-    }, COLLECT_METRICS_TIMEOUT).unref()
-  }
-
-  async pipeLogsStream (writableStream, logger, startLogId, endLogId, runtimePID) {
-    endLogId = endLogId || Infinity
-    runtimePID = runtimePID ?? process.pid
-
-    const runtimeLogFiles = await this.#getRuntimeLogFiles(runtimePID)
-    if (runtimeLogFiles.length === 0) {
-      writableStream.end()
-      return
-    }
-
-    let latestFileId = parseInt(runtimeLogFiles.at(-1).slice('logs.'.length))
-
-    let waiting = false
-    let fileStream = null
-    let fileId = startLogId ?? latestFileId
-
-    const runtimeLogsDir = this.#getRuntimeLogsDir(runtimePID)
-
-    const watcher = watch(runtimeLogsDir, async (event, filename) => {
-      if (event === 'rename' && filename.startsWith('logs')) {
-        const logFileId = parseInt(filename.slice('logs.'.length))
-        if (logFileId > latestFileId) {
-          latestFileId = logFileId
-          if (waiting) {
-            streamLogFile(++fileId)
-          }
-        }
-      }
-    }).unref()
-
-    const streamLogFile = () => {
-      if (fileId > endLogId) {
-        writableStream.end()
-        return
-      }
-
-      const fileName = 'logs.' + fileId
-      const filePath = join(runtimeLogsDir, fileName)
-
-      const prevFileStream = fileStream
-
-      fileStream = ts.createReadStream(filePath)
-      fileStream.pipe(writableStream, { end: false })
-
-      if (prevFileStream) {
-        prevFileStream.unpipe(writableStream)
-        prevFileStream.destroy()
-      }
-
-      fileStream.on('error', (err) => {
-        logger.error(err, 'Error streaming log file')
-        fileStream.destroy()
-        watcher.close()
-        writableStream.end()
-      })
-
-      fileStream.on('data', () => {
-        waiting = false
-      })
-
-      fileStream.on('eof', () => {
-        if (fileId >= endLogId) {
-          writableStream.end()
-          return
-        }
-        if (latestFileId > fileId) {
-          streamLogFile(++fileId)
-        } else {
-          waiting = true
-        }
-      })
-
-      return fileStream
-    }
-
-    streamLogFile(fileId)
-
-    writableStream.on('close', () => {
-      watcher.close()
-      fileStream.destroy()
-    })
-    writableStream.on('error', () => {
-      watcher.close()
-      fileStream.destroy()
-    })
-  }
-
-  async getLogIds (runtimePID) {
-    runtimePID = runtimePID ?? process.pid
-
-    const runtimeLogFiles = await this.#getRuntimeLogFiles(runtimePID)
-    const runtimeLogIds = []
-
-    for (const logFile of runtimeLogFiles) {
-      const logId = parseInt(logFile.slice('logs.'.length))
-      runtimeLogIds.push(logId)
-    }
-    return runtimeLogIds
-  }
-
-  async getAllLogIds () {
-    const runtimesLogFiles = await this.#getAllLogsFiles()
-    const runtimesLogsIds = []
-
-    for (const runtime of runtimesLogFiles) {
-      const runtimeLogIds = []
-      for (const logFile of runtime.runtimeLogFiles) {
-        const logId = parseInt(logFile.slice('logs.'.length))
-        runtimeLogIds.push(logId)
-      }
-      runtimesLogsIds.push({
-        pid: runtime.runtimePID,
-        indexes: runtimeLogIds
-      })
-    }
-
-    return runtimesLogsIds
-  }
-
-  async getLogFileStream (logFileId, runtimePID) {
-    const runtimeLogsDir = this.#getRuntimeLogsDir(runtimePID)
-    const filePath = join(runtimeLogsDir, `logs.${logFileId}`)
-    return createReadStream(filePath)
-  }
-
-  #getRuntimeLogsDir (runtimePID) {
-    return join(this.#runtimeTmpDir, runtimePID.toString(), 'logs')
-  }
-
-  async #getRuntimeLogFiles (runtimePID) {
-    const runtimeLogsDir = this.#getRuntimeLogsDir(runtimePID)
-    const runtimeLogsFiles = await readdir(runtimeLogsDir)
-    return runtimeLogsFiles
-      .filter((file) => file.startsWith('logs'))
-      .sort((log1, log2) => {
-        const index1 = parseInt(log1.slice('logs.'.length))
-        const index2 = parseInt(log2.slice('logs.'.length))
-        return index1 - index2
-      })
-  }
-
-  async #getAllLogsFiles () {
-    try {
-      await access(this.#runtimeTmpDir)
-    } catch (error) {
-      return []
-    }
-
-    const runtimePIDs = await readdir(this.#runtimeTmpDir)
-    const runtimesLogFiles = []
-
-    for (const runtimePID of runtimePIDs) {
-      const runtimeLogsDir = this.#getRuntimeLogsDir(runtimePID)
-      const runtimeLogsDirStat = await stat(runtimeLogsDir)
-      const runtimeLogFiles = await this.#getRuntimeLogFiles(runtimePID)
-      const lastModified = runtimeLogsDirStat.mtime
-
-      runtimesLogFiles.push({
-        runtimePID: parseInt(runtimePID),
-        runtimeLogFiles,
-        lastModified
-      })
-    }
-
-    return runtimesLogFiles.sort(
-      (runtime1, runtime2) => runtime1.lastModified - runtime2.lastModified
-    )
-  }
-
-  async #sendCommand (command, params = {}) {
-    const operationId = randomUUID()
-    this.worker.postMessage({ operationId, command, params })
-    const [message] = await Promise.race(
-      [once(this, operationId), this.#exitPromise]
-    )
-
-    if (this.#exitCode !== undefined) {
-      if (this.exitCode === 1) {
-        throw new errors.AddressInUseError()
-      }
-      throw new errors.RuntimeExitedError()
-    }
-    const { error, data, code } = message
-    if (error !== null) {
-      const err = new Error(error)
-      err.code = code
-      throw err
-    }
-
-    return JSON.parse(data)
-  }
-
-  async #exitHandler () {
-    this.#exitCode = undefined
-    return once(this.worker, 'exit').then((msg) => {
-      clearInterval(this.#metricsTimeout)
-      this.#exitCode = msg[0]
-      this.emit('close')
-      return msg
-    })
-  }
-}
-
-function getRuntimeTmpDir (runtimeDir) {
-  const platformaticTmpDir = join(tmpdir(), 'platformatic', 'applications')
-  const runtimeDirHash = createHash('md5').update(runtimeDir).digest('hex')
-  return join(platformaticTmpDir, runtimeDirHash)
-}
-
-function getRuntimeLogsDir (runtimeDir, runtimePID) {
-  const runtimeTmpDir = getRuntimeTmpDir(runtimeDir)
-  return join(runtimeTmpDir, runtimePID.toString(), 'logs')
-}
-
-module.exports = {
-  RuntimeApiClient,
-  getRuntimeTmpDir,
-  getRuntimeLogsDir
-}