wattpm 3.41.0 → 3.42.0

package/README.md

@@ -19,18 +19,19 @@ Watt supports the stacks you love most, including [Next.js](https://nextjs.org/)
 
 ```bash
 # Create a new application
-npx wattpm@latest init
+npx wattpm@latest create
 
 # Or install manually:
 npm install wattpm
 ```
 
 Follow our [Quick Start Guide](https://docs.platformatic.dev/docs/getting-started/quick-start)
-guide to get up and running with Platformatic.
+to get up and running with Watt.
 
 ## Documentation
 
-- [Getting Started](https://docs.platformatic.dev/docs/getting-started/quick-start)
+- [Quick Start](https://docs.platformatic.dev/docs/getting-started/quick-start)
+- [Running Your Project in Watt](https://docs.platformatic.dev/docs/getting-started/port-your-app)
 - [Reference](https://docs.platformatic.dev/docs/reference/wattpm/overview)
 - [Guides](https://docs.platformatic.dev/docs/guides/build-modular-monolith)
 

package/index.js

@@ -14,6 +14,7 @@ import { applicationsCommand, configCommand, envCommand, psCommand } from './lib
 import { metricsCommand } from './lib/commands/metrics.js'
 import { pprofCommand } from './lib/commands/pprof.js'
 import { replCommand } from './lib/commands/repl.js'
+import { heapSnapshotCommand } from './lib/commands/snapshot.js'
 import { version } from './lib/schema.js'
 
 export * from './lib/schema.js'
@@ -116,6 +117,9 @@ export async function main () {
     case 'pprof':
       command = pprofCommand
       break
+    case 'heap-snapshot':
+      command = heapSnapshotCommand
+      break
     case 'repl':
       command = replCommand
       break

package/lib/commands/help.js

@@ -20,7 +20,8 @@ async function loadCommands () {
     'inject',
     'metrics',
     'pprof',
-    'repl'
+    'repl',
+    'snapshot'
   ]) {
     const category = await import(`./${file}.js`)
     Object.assign(commands, category.help)

package/lib/commands/snapshot.js

@@ -0,0 +1,99 @@
+import { RuntimeApiClient, getMatchingRuntime } from '@platformatic/control'
+import { ensureLoggableError, logFatalError, parseArgs } from '@platformatic/foundation'
+import { bold } from 'colorette'
+import { createWriteStream } from 'node:fs'
+import { resolve } from 'node:path'
+import { pipeline } from 'node:stream/promises'
+
+export async function heapSnapshotCommand (logger, args) {
+  const client = new RuntimeApiClient({ logger, socket: this.socket })
+
+  try {
+    const { positionals, values } = parseArgs(
+      args,
+      {
+        dir: { type: 'string', short: 'd' }
+      },
+      false
+    )
+
+    const [runtime, remainingPositionals] = await getMatchingRuntime(client, positionals)
+    const { applications: runtimeApplications } = await client.getRuntimeApplications(runtime.pid)
+
+    const applicationId = remainingPositionals[0]
+    const timestamp = new Date().toISOString().replace(/:/g, '-').replace(/\./g, '-')
+    const outputDir = values.dir || process.cwd()
+
+    if (applicationId) {
+      const application = runtimeApplications.find(s => s.id === applicationId)
+      if (!application) {
+        return logFatalError(logger, `Application not found: ${applicationId}`)
+      }
+
+      logger.info(`Taking heap snapshot for application ${bold(applicationId)}...`)
+      const body = await client.takeApplicationHeapSnapshot(runtime.pid, applicationId)
+      const filename = `heap-${applicationId}-${timestamp}.heapsnapshot`
+      const filepath = resolve(outputDir, filename)
+      await pipeline(body, createWriteStream(filepath))
+      logger.info(`Heap snapshot saved to ${bold(filepath)}`)
+    } else {
+      for (const application of runtimeApplications) {
+        try {
+          logger.info(`Taking heap snapshot for application ${bold(application.id)}...`)
+          const body = await client.takeApplicationHeapSnapshot(runtime.pid, application.id)
+          const filename = `heap-${application.id}-${timestamp}.heapsnapshot`
+          const filepath = resolve(outputDir, filename)
+          await pipeline(body, createWriteStream(filepath))
+          logger.info(`Heap snapshot saved to ${bold(filepath)}`)
+        } catch (error) {
+          logger.warn(`Failed to take heap snapshot for application ${application.id}: ${error.message}`)
+        }
+      }
+    }
+  } catch (error) {
+    if (error.code === 'PLT_CTR_RUNTIME_NOT_FOUND') {
+      return logFatalError(logger, 'Cannot find a matching runtime.')
+    } else if (error.message && error.message.includes('Application not found')) {
+      return logFatalError(logger, error.message)
+    } else {
+      return logFatalError(
+        logger,
+        { error: ensureLoggableError(error) },
+        `Cannot take heap snapshot: ${error.message}`
+      )
+    }
+  } finally {
+    await client.close()
+  }
+}
+
+export const help = {
+  'heap-snapshot': {
+    usage: 'heap-snapshot [id] [application] [options]',
+    description: 'Take a heap snapshot of a running application',
+    options: [
+      {
+        name: '--dir, -d',
+        description: 'Directory to save the heap snapshot to (default: current working directory)'
+      }
+    ],
+    args: [
+      {
+        name: 'id',
+        description:
+          'The process ID or the name of the application (it can be omitted only if there is a single application running)'
+      },
+      {
+        name: 'application',
+        description: 'The application ID to snapshot (if omitted, snapshots all applications)'
+      }
+    ],
+    footer:
+      'Takes a V8 heap snapshot of a running application and saves it as a .heapsnapshot file.\n' +
+      'The resulting file can be loaded in Chrome DevTools (Memory tab) for analysis.\n\n' +
+      'Examples:\n' +
+      '  wattpm heap-snapshot my-app                              # Take heap snapshot of my-app\n' +
+      '  wattpm heap-snapshot --dir=/tmp/snapshots my-app         # Save to specific directory\n' +
+      '  wattpm heap-snapshot                                     # Snapshot all applications'
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wattpm",
-  "version": "3.41.0",
+  "version": "3.42.0",
   "description": "The Node.js Application Server",
   "main": "index.js",
   "type": "module",
@@ -30,9 +30,9 @@
     "pino-pretty": "^13.0.0",
     "split2": "^4.2.0",
     "table": "^6.8.2",
-    "@platformatic/foundation": "3.41.0",
-    "@platformatic/runtime": "3.41.0",
-    "@platformatic/control": "3.41.0"
+    "@platformatic/control": "3.42.0",
+    "@platformatic/foundation": "3.42.0",
+    "@platformatic/runtime": "3.42.0"
   },
   "devDependencies": {
     "cleaner-spec-reporter": "^0.5.0",
@@ -44,7 +44,7 @@
     "neostandard": "^0.12.0",
     "typescript": "^5.5.4",
     "undici": "^7.0.0",
-    "@platformatic/node": "3.41.0"
+    "@platformatic/node": "3.42.0"
   },
   "engines": {
     "node": ">=22.19.0"

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/wattpm/3.41.0.json",
+  "$id": "https://schemas.platformatic.dev/wattpm/3.42.0.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Runtime Config",
   "type": "object",