@platformatic/wattpm-pprof-capture 0.0.1 → 3.0.0-alpha.8

package/LICENSE

@@ -0,0 +1,196 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (which shall not include communications that are clearly marked or
+      otherwise designated in writing by the author as "Not a License").
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based upon (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and derivative works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control
+      systems, and issue tracking systems that are managed by, or on behalf
+      of, the Licensor for the purpose of discussing and improving the Work,
+      but excluding communication that is clearly marked or otherwise
+      designated in writing by the author as "Not a License".
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to use, reproduce, modify, display, perform,
+      sublicense, and distribute the Work and derivative works thereof in
+      Source and Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, trademark, patent,
+          and attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright notice to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Support. When redistributing the Work or
+      Derivative Works thereof, You may choose to offer, and charge a fee
+      for, acceptance of support, warranty, indemnity, or other liability
+      obligations and/or rights consistent with this License. However, in
+      accepting such obligations, You may act only on Your own behalf and on
+      Your sole responsibility, not on behalf of any other Contributor, and
+      only if You agree to indemnify, defend, and hold each Contributor
+      harmless for any liability incurred by, or claims asserted against,
+      such Contributor by reason of your accepting any such warranty or support.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed by the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same page as the copyright notice for easier identification within
+      third-party archives.
+
+   Copyright 2022-2024 Platformatic Inc. and contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,13 @@
+Copyright 2022-2024 Platformatic Inc. and contributors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/eslint.config.js

@@ -0,0 +1,3 @@
+import neostandard from 'neostandard'
+
+export default neostandard({})

package/index.js

@@ -1 +1,69 @@
-throw new Error('This is a stub for new packages. Do not use.')
+import { time } from '@datadog/pprof'
+import { NoProfileAvailableError, ProfilingAlreadyStartedError, ProfilingNotStartedError } from './lib/errors.js'
+
+const kITC = Symbol.for('plt.runtime.itc')
+
+let isCapturing = false
+let latestProfile = null
+let captureInterval = null
+
+// Keep trying until ITC is available. This is needed because preloads run
+// before the app thread initialization, so globalThis.platformatic.messaging
+// and ITC don't exist yet.
+const registerInterval = setInterval(() => {
+  if (globalThis[kITC]) {
+    globalThis[kITC].handle('getLastProfile', getLastProfile)
+    globalThis[kITC].handle('startProfiling', startProfiling)
+    globalThis[kITC].handle('stopProfiling', stopProfiling)
+    clearInterval(registerInterval)
+  }
+}, 10)
+
+function rotateProfile () {
+  // `true` immediately restarts profiling after stopping
+  latestProfile = time.stop(true)
+}
+
+export function startProfiling (options = {}) {
+  if (isCapturing) {
+    throw new ProfilingAlreadyStartedError()
+  }
+  isCapturing = true
+
+  time.start(options)
+
+  // Set up profile window rotation if durationMillis is provided
+  const timeout = options.durationMillis
+  if (timeout) {
+    captureInterval = setInterval(rotateProfile, timeout)
+    captureInterval.unref()
+  }
+}
+
+export function stopProfiling () {
+  if (!isCapturing) {
+    throw new ProfilingNotStartedError()
+  }
+  isCapturing = false
+
+  clearInterval(captureInterval)
+  captureInterval = null
+
+  latestProfile = time.stop()
+  return latestProfile.encode()
+}
+
+export function getLastProfile () {
+  // TODO: Should it be allowed to get last profile after stopping?
+  if (!isCapturing) {
+    throw new ProfilingNotStartedError()
+  }
+
+  if (latestProfile == null) {
+    throw new NoProfileAvailableError()
+  }
+
+  return latestProfile.encode()
+}
+
+export * as errors from './lib/errors.js'

package/lib/errors.js

@@ -0,0 +1,21 @@
+import createError from '@fastify/error'
+
+export const ERROR_PREFIX = 'PLT_PPROF'
+
+export const ProfilingAlreadyStartedError = createError(
+  `${ERROR_PREFIX}_PROFILING_ALREADY_STARTED`,
+  'Profiling is already started',
+  400
+)
+
+export const ProfilingNotStartedError = createError(
+  `${ERROR_PREFIX}_PROFILING_NOT_STARTED`,
+  'Profiling not started - call startProfiling() first',
+  400
+)
+
+export const NoProfileAvailableError = createError(
+  `${ERROR_PREFIX}_NO_PROFILE_AVAILABLE`,
+  'No profile available - wait for profiling to complete or trigger manual capture',
+  400
+)

package/package.json

@@ -1,10 +1,9 @@
 {
   "name": "@platformatic/wattpm-pprof-capture",
-  "version": "0.0.1",
+  "version": "3.0.0-alpha.8",
+  "description": "pprof profiling capture for wattpm",
   "main": "index.js",
-  "files": [
-    "index.js"
-  ],
+  "type": "module",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/platformatic/platformatic.git"
@@ -14,5 +13,23 @@
   "bugs": {
     "url": "https://github.com/platformatic/platformatic/issues"
   },
-  "homepage": "https://github.com/platformatic/platformatic#readme"
+  "homepage": "https://github.com/platformatic/platformatic#readme",
+  "dependencies": {
+    "@datadog/pprof": "^5.3.0",
+    "@fastify/error": "^4.0.0",
+    "undici": "^6.0.0"
+  },
+  "devDependencies": {
+    "eslint": "9",
+    "neostandard": "^0.12.0",
+    "@platformatic/foundation": "3.0.0-alpha.8",
+    "@platformatic/service": "3.0.0-alpha.8"
+  },
+  "engines": {
+    "node": ">=22.18.0"
+  },
+  "scripts": {
+    "test": "node --test --test-reporter=cleaner-spec-reporter --test-concurrency=1 --test-timeout=2000000 test/*.test.js test/**/*.test.js",
+    "lint": "eslint"
+  }
 }

package/test/fixtures/runtime-test/platformatic.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/2.0.0.json",
+  "entrypoint": "service",
+  "preload": "../../../index.js",
+  "autoload": {
+    "path": "./"
+  },
+  "server": {
+    "hostname": "127.0.0.1",
+    "port": 0
+  },
+  "logger": {
+    "level": "error"
+  }
+}

package/test/fixtures/runtime-test/service/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "test-service",
+  "version": "1.0.0",
+  "type": "commonjs"
+}

package/test/fixtures/runtime-test/service/platformatic.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/service/2.0.0.json",
+  "server": {
+    "logger": {
+      "level": "warn"
+    }
+  },
+  "plugins": {
+    "paths": [{
+      "path": "plugin.js",
+      "encapsulate": false
+    }]
+  }
+}

package/test/fixtures/runtime-test/service/plugin.js

@@ -0,0 +1,13 @@
+'use strict'
+
+module.exports = async function (app) {
+  // Simple hello world service
+  app.get('/', async () => {
+    return { message: 'Hello World' }
+  })
+
+  // Health check endpoint
+  app.get('/health', async () => {
+    return { status: 'ok' }
+  })
+}

package/test/watt-pprof-capture.test.js

@@ -0,0 +1,202 @@
+import assert from 'node:assert'
+import { resolve } from 'node:path'
+import test from 'node:test'
+import { request } from 'undici'
+import { createRuntime } from '../../runtime/test/helpers.js'
+
+async function createApp (t) {
+  const configFile = resolve(import.meta.dirname, 'fixtures/runtime-test/platformatic.json')
+  const app = await createRuntime(configFile)
+
+  t.after(async () => {
+    await app.close()
+  })
+
+  const url = await app.start()
+  // Wait for services and handlers to register
+  await new Promise(resolve => setTimeout(resolve, 200))
+
+  return { app, url }
+}
+
+test('basic service functionality should work with wattpm-pprof-capture', async t => {
+  const { url } = await createApp(t)
+
+  // Test that the hello world service is working (verifying preload didn't break anything)
+  const res = await request(`${url}/`)
+  const json = await res.body.json()
+
+  assert.strictEqual(res.statusCode, 200)
+  assert.strictEqual(json.message, 'Hello World')
+
+  // Test health endpoint
+  const healthRes = await request(`${url}/health`)
+  const healthJson = await healthRes.body.json()
+
+  assert.strictEqual(healthRes.statusCode, 200)
+  assert.strictEqual(healthJson.status, 'ok')
+})
+
+test('getLastProfile should throw error when profiling not started', async t => {
+  const { app } = await createApp(t)
+
+  await assert.rejects(
+    () => app.sendCommandToApplication('service', 'getLastProfile'),
+    { code: 'PLT_PPROF_PROFILING_NOT_STARTED' },
+    'Should throw ProfilingNotStartedError when profiling not started'
+  )
+})
+
+test('error types should be distinguishable throughout lifecycle', async t => {
+  const { app } = await createApp(t)
+
+  // Test ProfilingNotStartedError before starting
+  await assert.rejects(
+    () => app.sendCommandToApplication('service', 'getLastProfile'),
+    { code: 'PLT_PPROF_PROFILING_NOT_STARTED' },
+    'Should throw ProfilingNotStartedError (not NoProfileAvailableError)'
+  )
+
+  // Start profiling with profile rotation
+  await app.sendCommandToApplication('service', 'startProfiling', { durationMillis: 500 })
+
+  // Test NoProfileAvailableError (before any rotation happens)
+  await assert.rejects(
+    () => app.sendCommandToApplication('service', 'getLastProfile'),
+    { code: 'PLT_PPROF_NO_PROFILE_AVAILABLE' },
+    'Should throw NoProfileAvailableError (not ProfilingNotStartedError)'
+  )
+
+  // Wait for the profile to be captured through rotation
+  await new Promise(resolve => setTimeout(resolve, 600))
+
+  // Get the profile (should succeed now)
+  const profile = await app.sendCommandToApplication('service', 'getLastProfile')
+  assert.ok(profile instanceof Uint8Array, 'Profile should be Uint8Array from ITC')
+  assert.ok(profile.length > 0, 'Profile should have content')
+
+  // Test stopping profiling
+  const stopResult = await app.sendCommandToApplication('service', 'stopProfiling')
+  assert.ok(stopResult instanceof Uint8Array, 'stopProfiling should return final profile')
+  assert.ok(stopResult.length > 0, 'Final profile should have content')
+
+  // Test ProfilingNotStartedError after stopping
+  await assert.rejects(
+    () => app.sendCommandToApplication('service', 'getLastProfile'),
+    { code: 'PLT_PPROF_PROFILING_NOT_STARTED' },
+    'Should throw ProfilingNotStartedError after stopping'
+  )
+})
+
+test('profiling without rotation should only provide profile on stop', async t => {
+  const { app } = await createApp(t)
+
+  // Start profiling without durationMillis (no rotation)
+  await app.sendCommandToApplication('service', 'startProfiling', {})
+
+  // Wait some time - should still get NoProfileAvailableError since no rotation
+  await new Promise(resolve => setTimeout(resolve, 500))
+  await assert.rejects(
+    () => app.sendCommandToApplication('service', 'getLastProfile'),
+    { code: 'PLT_PPROF_NO_PROFILE_AVAILABLE' },
+    'Should throw NoProfileAvailableError without rotation'
+  )
+
+  // Stop profiling should return the profile
+  const finalProfile = await app.sendCommandToApplication('service', 'stopProfiling')
+  assert.ok(finalProfile instanceof Uint8Array, 'Should get final profile from stopProfiling')
+  assert.ok(finalProfile.length > 0, 'Final profile should have content')
+})
+
+test('multiple start attempts should throw error', async t => {
+  const { app } = await createApp(t)
+
+  // Start profiling
+  await app.sendCommandToApplication('service', 'startProfiling', { durationMillis: 500 })
+
+  // Try to start again - should throw ProfilingAlreadyStartedError
+  await assert.rejects(
+    () => app.sendCommandToApplication('service', 'startProfiling', { durationMillis: 500 }),
+    { code: 'PLT_PPROF_PROFILING_ALREADY_STARTED' },
+    'Should throw ProfilingAlreadyStartedError'
+  )
+
+  // Should still be able to get profile after first rotation
+  await new Promise(resolve => setTimeout(resolve, 600))
+  const profile = await app.sendCommandToApplication('service', 'getLastProfile')
+  assert.ok(profile instanceof Uint8Array, 'Should get Uint8Array from ITC')
+
+  await app.sendCommandToApplication('service', 'stopProfiling')
+})
+
+test('multiple stop attempts should throw error', async t => {
+  const { app } = await createApp(t)
+
+  // Start and stop profiling
+  await app.sendCommandToApplication('service', 'startProfiling', { durationMillis: 500 })
+  await app.sendCommandToApplication('service', 'stopProfiling')
+
+  // Try to stop again - should throw ProfilingNotStartedError
+  await assert.rejects(
+    () => app.sendCommandToApplication('service', 'stopProfiling'),
+    { code: 'PLT_PPROF_PROFILING_NOT_STARTED' },
+    'Should throw ProfilingNotStartedError on double stop'
+  )
+})
+
+test('stopProfiling should throw error when called without starting', async t => {
+  const { app } = await createApp(t)
+
+  // Try to stop without starting
+  await assert.rejects(
+    () => app.sendCommandToApplication('service', 'stopProfiling'),
+    { code: 'PLT_PPROF_PROFILING_NOT_STARTED' },
+    'Should throw ProfilingNotStartedError'
+  )
+})
+
+test('profile rotation should update available profiles', async t => {
+  const { app } = await createApp(t)
+
+  // Start with short rotation interval
+  await app.sendCommandToApplication('service', 'startProfiling', { durationMillis: 200 })
+
+  // Wait for first rotation
+  await new Promise(resolve => setTimeout(resolve, 250))
+  const profile1 = await app.sendCommandToApplication('service', 'getLastProfile')
+  assert.ok(profile1 instanceof Uint8Array)
+
+  // Wait for second rotation
+  await new Promise(resolve => setTimeout(resolve, 250))
+  const profile2 = await app.sendCommandToApplication('service', 'getLastProfile')
+  assert.ok(profile2 instanceof Uint8Array)
+
+  // Profiles should be the latest captured (may or may not be different)
+  // The important thing is that we can get profiles after each rotation
+
+  await app.sendCommandToApplication('service', 'stopProfiling')
+})
+
+test('getLastProfile should return same profile until next rotation', async t => {
+  const { app } = await createApp(t)
+
+  await app.sendCommandToApplication('service', 'startProfiling', { durationMillis: 500 })
+
+  // Wait for first rotation
+  await new Promise(resolve => setTimeout(resolve, 600))
+
+  // Multiple getLastProfile calls should return the same profile
+  const profile1 = await app.sendCommandToApplication('service', 'getLastProfile')
+  const profile2 = await app.sendCommandToApplication('service', 'getLastProfile')
+  const profile3 = await app.sendCommandToApplication('service', 'getLastProfile')
+
+  assert.ok(profile1 instanceof Uint8Array)
+  assert.ok(profile2 instanceof Uint8Array)
+  assert.ok(profile3 instanceof Uint8Array)
+
+  // All should be the same profile (latest captured)
+  assert.deepStrictEqual(profile1, profile2, 'Should return same profile')
+  assert.deepStrictEqual(profile2, profile3, 'Should return same profile')
+
+  await app.sendCommandToApplication('service', 'stopProfiling')
+})