@ohos-ports/polarsignals-pprof 0.1.3-beta.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 authorized by
+      the copyright owner that is 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" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form 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
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (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 conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   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 reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or 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, patent, trademark, 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 statement 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 Additional Liability. While 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 additional liability.
+
+   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 in 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 "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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/README.md

@@ -0,0 +1,64 @@
+# @polarsignals/pprof
+
+Node.js profiling library that automatically uploads heap profiles to Polar Signals.
+
+## Installation
+
+```bash
+npm install @polarsignals/pprof
+```
+
+## Usage
+
+```javascript
+const { heapProfiler, monitorOutOfMemory } = require('@polarsignals/pprof');
+
+// Start heap profiling
+heapProfiler.start(512 * 1024, 64); // 512KB sampling, stack depth 64
+
+// Monitor for out-of-memory events and auto-upload profiles
+monitorOutOfMemory({
+  exportOptions: {
+    labels: { service: 'my-app', version: '1.0.0' },
+  },
+});
+
+// Resolve frames locally against .map files; skips server-side resolution.
+const profile = await heapProfiler.encodedProfile({
+  localSourceMapRoots: [process.cwd()],
+});
+```
+
+`endpoint`, `projectId`, and `token` fall back to `POLARSIGNALS_SERVER_URL`,
+`POLARSIGNALS_PROJECT_ID`, and `POLARSIGNALS_TOKEN` env vars respectively, so
+typical deployments don't need to set them in code.
+
+## `exportOptions`
+
+| Field        | Type                     | Default                                              | Description                                                                                                                                       |
+| ------------ | ------------------------ | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Field                 | Type                     | Default                                              | Description                                                                                                                                       |
+| --------------------- | ------------------------ | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `endpoint`            | `string`                 | `https://api.polarsignals.com/api/parca/profilestore` | Profile-store base URL.                                                                                                                           |
+| `projectId`           | `string`                 | `$POLARSIGNALS_PROJECT_ID`                           | Polar Signals project UUID.                                                                                                                       |
+| `labels`              | `Record<string, string>` | —                                                    | Extra series labels attached to the profile (e.g. `service`, `version`).                                                                          |
+| `headers`             | `Record<string, string>` | —                                                    | Extra HTTP headers added to the upload request.                                                                                                   |
+| `timeout`             | `number`                 | `30000`                                              | Request timeout in ms.                                                                                                                            |
+| `localSourceMapRoots` | `string[]`               | —                                                    | If set, the OOM upload-worker resolves frames against `.map` files in these dirs and skips server-side resolution. The same option is available on `heapProfiler.encodedProfile` — see below. |
+
+The bearer token is read exclusively from `POLARSIGNALS_TOKEN` env var.
+
+## `heapProfiler.encodedProfile(options?)`
+
+Returns a gzipped pprof Buffer for ad-hoc serving (e.g. a `/debug/pprof/allocs` endpoint).
+
+| Field                 | Type       | Default | Description                                                                                                                                                                                                                          |
+| --------------------- | ---------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `localSourceMapRoots` | `string[]` | —       | If set, the lib walks these directories for `.map` files and resolves frames locally at encode time, skipping server-side resolution. If omitted, frames are encoded for server-side resolution. |
+
+## Features
+
+- Automatic heap profile collection
+- Out-of-memory monitoring with automatic profile upload
+- Background upload process to ensure profiles are saved even during crashes
+- Configurable labels for profile metadata

package/debug-ids.js

@@ -0,0 +1,39 @@
+const fs = require('node:fs');
+
+const DEBUG_ID_RE =
+  /\/\/# debugId=([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12})/i;
+
+// `//# debugId=<uuid>` is appended at the end of the bundle; tail-read it.
+const TAIL_BYTES = 256;
+
+// Per-file debugId cache; lazy, null for non-bundle files.
+const debugIdCache = new Map();
+
+function readTail(fd, fileSize) {
+  const length = Math.min(TAIL_BYTES, fileSize);
+  const buf = Buffer.alloc(length);
+  fs.readSync(fd, buf, 0, length, fileSize - length);
+  return buf.toString('utf8');
+}
+
+function debugIdFor(filePath) {
+  if (debugIdCache.has(filePath)) return debugIdCache.get(filePath);
+  let debugId = null;
+  let fd;
+  try {
+    fd = fs.openSync(filePath, 'r');
+    const { size } = fs.fstatSync(fd);
+    const m = readTail(fd, size).match(DEBUG_ID_RE);
+    if (m) debugId = m[1];
+  } catch {
+    // ignore unreadable files (node: internals, deleted files, etc.)
+  } finally {
+    if (fd !== undefined) {
+      try { fs.closeSync(fd); } catch { /* ignore */ }
+    }
+  }
+  debugIdCache.set(filePath, debugId);
+  return debugId;
+}
+
+module.exports = { debugIdFor };

package/index.d.ts

@@ -0,0 +1,33 @@
+import type { heap } from "@datadog/pprof"
+
+
+export type ExportOptions = {
+	endpoint?: string
+	projectId?: string
+	labels?: Record<string, string>
+	headers?: Record<string, string>
+	timeout?: number
+	localSourceMapRoots?: string[]
+}
+
+export type EncodeOptions = {
+	/**
+	 * Directories to walk for `.map` files. When set, frames are resolved
+	 * locally at encode time and server-side resolution is skipped. When
+	 * omitted (default), frames are encoded for server-side resolution.
+	 */
+	localSourceMapRoots?: string[]
+}
+
+export const heapProfiler: typeof heap & {
+	encodedProfile(options?: EncodeOptions): Promise<Buffer>
+}
+
+export function encodedProfileFromTree(
+	rootNode: unknown,
+	options?: EncodeOptions,
+): Promise<Buffer>
+
+export function monitorOutOfMemory(args: {
+	exportOptions: ExportOptions
+}): void

package/index.js

@@ -0,0 +1,100 @@
+const path = require('node:path');
+const { SourceMapper, encode, heap } = require('@ohos-ports/datadog-pprof');
+const { Mapping } = require('pprof-format');
+const { debugIdFor } = require('./debug-ids');
+
+// pprof Line has no column field. Encode V8's column as a `:L#<line>:C#<col>`
+// suffix on the function name via the serializer's source-mapper hook.
+const COLUMN_ENCODING_SOURCE_MAPPER = {
+  // Only called for frames with line > 0 and defined column (per isGeneratedLocation).
+  mappingInfo(loc) {
+    // Only applied to bundles with a //# debugId= marker.
+    if (!loc.file || debugIdFor(loc.file) === null) return loc;
+    const baseName = loc.name || 'anonymous';
+    return {
+      ...loc,
+      name: `${baseName}:L#${loc.line}:C#${loc.column}`,
+    };
+  },
+};
+
+// Tag JS frames with a v8js Mapping + build_id so consumers can resolve them
+// against the matching sourcemap.
+function addBuildIdMappings(profile) {
+  const st = profile.stringTable;
+  const v8jsFilenameId = st.dedup('v8js');
+  const pathToMappingId = new Map();
+  let nextId = profile.mapping.length + 1;
+
+  for (const fn of profile.function) {
+    const fname = st.strings[Number(fn.filename)];
+    if (!fname || pathToMappingId.has(fname)) continue;
+    const debugId = debugIdFor(fname);
+    if (debugId === null) continue;
+    profile.mapping.push(
+      new Mapping({
+        id: nextId,
+        filename: v8jsFilenameId,
+        buildId: st.dedup(debugId),
+      }),
+    );
+    pathToMappingId.set(fname, nextId);
+    nextId++;
+  }
+  if (pathToMappingId.size === 0) return;
+
+  // Assign the mapping to the correct location references.
+  for (const loc of profile.location) {
+    const firstLine = loc.line[0];
+    if (!firstLine) continue;
+    const fn = profile.function[Number(firstLine.functionId) - 1];
+    if (!fn) continue;
+    const mid = pathToMappingId.get(st.strings[Number(fn.filename)]);
+    if (mid != null) loc.mappingId = mid;
+  }
+}
+
+// Returns { mapper, injectBuildIds } depending on whether the caller wants
+// local sourcemap resolution or server-side resolution.
+async function pickEncodeMode(options) {
+  if (options?.localSourceMapRoots) {
+    return {
+      mapper: await SourceMapper.create(options.localSourceMapRoots),
+      injectBuildIds: false,
+    };
+  }
+  return { mapper: COLUMN_ENCODING_SOURCE_MAPPER, injectBuildIds: true };
+}
+
+async function finalize(profile, injectBuildIds) {
+  if (injectBuildIds) addBuildIdMappings(profile);
+  return encode(profile);
+}
+
+module.exports = {
+  heapProfiler: {
+    ...heap,
+    async encodedProfile(options) {
+      const { mapper, injectBuildIds } = await pickEncodeMode(options);
+      return finalize(await heap.profile('', mapper), injectBuildIds);
+    },
+  },
+  async encodedProfileFromTree(rootNode, options) {
+    const { mapper, injectBuildIds } = await pickEncodeMode(options);
+    return finalize(heap.convertProfile(rootNode, undefined, mapper), injectBuildIds);
+  },
+  monitorOutOfMemory(config = {}) {
+    heap.monitorOutOfMemory(
+      0,
+      0,
+      false,
+      [
+        process.execPath,
+        path.join(__dirname, 'upload-worker.js'),
+        JSON.stringify(config.exportOptions),
+      ],
+      null, // no callback, just the above export command
+      0, // not async
+    );
+  },
+};

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@ohos-ports/polarsignals-pprof",
+  "version": "0.1.3-beta.0",
+  "description": "Node.js profiling library that automatically uploads heap profiles to Polar Signals",
+  "main": "index.js",
+  "files": [
+    "*.js",
+    "*.ts"
+  ],
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "publish:ci": "lerna publish --yes --no-verify-access"
+  },
+  "keywords": [
+    "profiling",
+    "pprof",
+    "heap",
+    "memory",
+    "performance",
+    "polar-signals",
+    "observability"
+  ],
+  "author": "Polar Signals",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ohos-ports/ohos-ports.git",
+    "directory": "ports/polarsignals-pprof/0.1.3"
+  },
+  "bugs": {
+    "url": "https://github.com/ohos-ports/ohos-ports/issues"
+  },
+  "homepage": "https://github.com/polarsignals/pprof-nodejs#readme",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "packageManager": "pnpm@10.33.0",
+  "dependencies": {
+    "@ohos-ports/datadog-pprof": "^5.17.0-beta.0",
+    "pprof-format": "^2.2.1"
+  },
+  "devDependencies": {
+    "@types/node": "^24.7.2",
+    "lerna": "9.0.7",
+    "typescript": "^5.9.3"
+  },
+  "optionalDependencies": {
+    "express": "^4.21.2"
+  }
+}

package/upload-worker.js

@@ -0,0 +1,152 @@
+#!/usr/bin/env node
+
+// Separate process for uploading profiles to Parca
+// This runs independently of the main process to ensure uploads complete
+// even if the main process crashes due to OOM
+
+const fs = require('fs');
+const http = require('http');
+const https = require('https');
+const { URL } = require('url');
+const { encodedProfileFromTree } = require('./index');
+
+async function uploadProfile (profilePath, config) {
+  try {
+    // Read the profile data and metadata
+    if (!fs.existsSync(profilePath)) {
+      return { success: false, error: 'Profile file not found' };
+    }
+
+    const profileDataJSON = JSON.parse(fs.readFileSync(profilePath));
+    const encodedProfile = await encodedProfileFromTree(profileDataJSON, {
+      localSourceMapRoots: config.localSourceMapRoots,
+    });
+      
+    // Prepare Parca WriteRaw request
+    const defaultLabels = [
+      { name: '__name__', value: 'memory' }
+    ];
+
+    const customLabels = Object.entries(config.labels || {}).map(([name, value]) => ({
+      name,
+      value: String(value)
+    }));
+
+    const requestPayload = {
+      series: [{
+        labels: {
+          labels: [...defaultLabels, ...customLabels]
+        },
+        samples: [{
+          raw_profile: encodedProfile.toString('base64')
+        }]
+      }],
+      normalized: false
+    };
+
+    const payloadJson = JSON.stringify(requestPayload);
+    const endpoint = config.endpoint
+      ?? process.env.POLARSIGNALS_SERVER_URL
+      ?? 'https://api.polarsignals.com/api/parca/profilestore';
+    const projectId = config.projectId ?? process.env.POLARSIGNALS_PROJECT_ID;
+    const bearerToken = process.env.POLARSIGNALS_TOKEN;
+    const url = new URL(endpoint);
+    const isHttps = url.protocol === 'https:';
+    const client = isHttps ? https : http;
+
+    const headers = {
+      'Content-Type': 'application/json',
+      'Content-Length': Buffer.byteLength(payloadJson).toString(),
+      ...(bearerToken ? { 'Authorization': `Bearer ${bearerToken}` } : {}),
+      ...(projectId ? { 'Grpc-Metadata-projectid': projectId } : {}),
+      ...config.headers,
+    };
+
+    return new Promise((resolve) => {
+      const req = client.request({
+        hostname: url.hostname,
+        port: url.port || (isHttps ? 443 : 80),
+        path: `${url.pathname}/profiles/writeraw`,
+        method: 'POST',
+        headers,
+        timeout: config.timeout || 30000, // Longer timeout for worker
+      }, (res) => {
+        let responseData = '';
+        
+        res.on('data', (chunk) => {
+          responseData += chunk;
+        });
+
+        res.on('end', () => {
+          const success = res.statusCode >= 200 && res.statusCode < 300;
+          
+          if (success) {
+            // Clean up files after successful upload
+            try {
+              fs.unlinkSync(profilePath);
+            } catch (cleanupError) {
+            }
+          }
+          
+          resolve({
+            success,
+            statusCode: res.statusCode,
+            error: success ? undefined : `HTTP ${res.statusCode}: ${res.statusMessage}`,
+            responseData
+          });
+        });
+      });
+
+      req.on('error', (error) => {
+        resolve({
+          success: false,
+          error: error.message
+        });
+      });
+
+      req.on('timeout', () => {
+        req.destroy();
+        resolve({
+          success: false,
+          error: 'Request timeout'
+        });
+      });
+
+      req.write(payloadJson);
+      req.end();
+    });
+
+  } catch (error) {
+    return {
+      success: false,
+      error: error.message
+    };
+  }
+}
+
+// Main worker execution
+async function main() {
+  const args = process.argv.slice(2);
+  
+  if (args.length < 2) {
+    process.exit(1);
+  }
+
+  const configJson = args[0];
+  const profilePath = args[1];
+  
+  try {
+    const config = JSON.parse(configJson);
+    
+    const result = await uploadProfile(profilePath, config);
+    
+    process.exit(result.success ? 0 : 1);
+    
+  } catch (error) {
+    process.exit(1);
+  }
+}
+
+if (require.main === module) {
+  main();
+}