repo: port profiling-node

Author: JonasBa

.craft.yml

@@ -40,6 +40,9 @@ targets:
   - name: npm
     id: '@sentry/node'
     includeNames: /^sentry-node-\d.*\.tgz$/
+  - name: npm
+    id: '@sentry/profiling-node'
+    includeNames: /^sentry-profiling-node-\d.*\.tgz$/
 
   ## 3 Browser-based Packages
   - name: npm

.github/workflows/build.yml

@@ -262,9 +262,222 @@ jobs:
       # `job_build` can't see `job_install_deps` and what it returned)
       dependency_cache_key: ${{ needs.job_install_deps.outputs.dependency_cache_key }}
 
+  job_build_bindings_profiling_node:
+    name: ${{ matrix.os }} (${{ matrix.target_platform }} node=${{ matrix.node || matrix.container }}, arch=${{ matrix.arch || matrix.container }}, compiler=${{ contains(matrix.container, 'alpine') && 'musl' || 'glibc'  }})
+    needs: [job_get_metadata, job_install_deps]
+    runs-on: ${{ matrix.os }}
+    container: ${{ matrix.container }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          # x64 glibc
+          - os: ubuntu-20.04
+            node: 16
+          - os: ubuntu-20.04
+            node: 18
+          - os: ubuntu-20.04
+            node: 20
+
+          # x64 musl
+          - os: ubuntu-20.04
+            container: node:16-alpine3.16
+            node: 16
+          - os: ubuntu-20.04
+            container: node:18-alpine3.17
+            node: 18
+          - os: ubuntu-20.04
+            container: node:20-alpine3.17
+            node: 20
+
+          # arm64 glibc
+          - os: ubuntu-20.04
+            arch: arm64
+            node: 16
+          - os: ubuntu-20.04
+            arch: arm64
+            node: 18
+          - os: ubuntu-20.04
+            arch: arm64
+            node: 20
+
+          # arm64 musl
+          - os: ubuntu-20.04
+            container: node:16-alpine3.16
+            arch: arm64
+            node: 16
+          - os: ubuntu-20.04
+            arch: arm64
+            container: node:18-alpine3.17
+            node: 18
+          - os: ubuntu-20.04
+            arch: arm64
+            container: node:20-alpine3.17
+            node: 20
+
+            # macos x64
+          - os: macos-11
+            node: 16
+            arch: x64
+          - os: macos-11
+            node: 18
+            arch: x64
+          - os: macos-11
+            node: 20
+            arch: x64
+
+            # macos arm64
+          - os: macos-12
+            arch: arm64
+            node: 16
+            target_platform: darwin
+
+          - os: macos-12
+            arch: arm64
+            node: 18
+            target_platform: darwin
+
+          - os: macos-12
+            arch: arm64
+            node: 20
+            target_platform: darwin
+
+            # windows x64
+          - os: windows-2019
+            node: 16
+            arch: x64
+
+          - os: windows-2019
+            node: 18
+            arch: x64
+
+          - os: windows-2019
+            node: 20
+            arch: x64
+    steps:
+      - name: setup (alpine)
+        if: contains(matrix.container, 'alpine')
+        run: apk add --no-cache build-base python3 g++ make curl
+
+      - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }})
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ env.HEAD_COMMIT }}
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node }}
+
+      - uses: actions/setup-python@v4
+        name: Setup python
+
+      - name: Install dependencies
+        run: |
+          cd packages/profiling-node
+          yarn install --ignore-scripts --frozen-lockfile
+
+      # configure build test copy x64
+      - name: Configure gyp
+        if: matrix.arch != 'arm64'
+        run: |
+          cd packages/profiling-node
+          yarn build:bindings:configure
+
+      - name: Build bindings
+        if: matrix.arch != 'arm64'
+        run: |
+          cd packages/profiling-node
+          yarn build:bindings
+
+      - name: setup (arm64, ${{ contains(matrix.container, 'alpine') && 'musl' || 'glibc'  }})
+        if: matrix.arch == 'arm64' && !contains(matrix.container, 'alpine') && matrix.target_platform != 'darwin'
+        run: |
+          sudo apt-get update
+          sudo apt install -y gcc-aarch64-linux-gnu g++-aarch64-linux-gnu
+
+      - name: "Configure gyp (arm64, ${{ contains(matrix.container, 'alpine') && 'musl' || 'glibc'  }})"
+        if: matrix.arch == 'arm64' && matrix.target_platform != 'darwin'
+        run: |
+          cd packages/profiling-node
+          yarn build:bindings:configure:arm64
+
+      - name: Setup musl cross compiler
+        if: contains(matrix.container, 'alpine')
+        run: |
+          cd packages/profiling-node
+          curl -OL https://musl.cc/aarch64-linux-musl-cross.tgz
+          tar -xzvf aarch64-linux-musl-cross.tgz
+          $(pwd)/aarch64-linux-musl-cross/bin/aarch64-linux-musl-gcc --version
+
+      - name: "Build bindings (arm64, ${{ contains(matrix.container, 'alpine') && 'musl' || 'glibc'  }})"
+        if: matrix.arch == 'arm64' && contains(matrix.container, 'alpine') && matrix.target_platform != 'darwin'
+        run: |
+          cd packages/profiling-node
+          CC=$(pwd)/aarch64-linux-musl-cross/bin/aarch64-linux-musl-gcc \
+          CXX=$(pwd)/aarch64-linux-musl-cross/bin/aarch64-linux-musl-g++ \
+          BUILD_ARCH=arm64 yarn build:bindings
+
+      - name: "Build bindings (arm64, ${{ contains(matrix.container, 'alpine') && 'musl' || 'glibc'  }})"
+        if: matrix.arch == 'arm64' && !contains(matrix.container, 'alpine') && matrix.target_platform != 'darwin'
+        run: |
+          cd packages/profiling-node
+          CC=aarch64-linux-gnu-gcc \
+          CXX=aarch64-linux-gnu-g++ \
+          BUILD_ARCH=arm64 yarn build:bindings:arm64
+
+      - name: "Configure gyp (arm64, darwin)"
+        if: matrix.arch == 'arm64' && matrix.target_platform == 'darwin'
+        run: |
+          cd packages/profiling-node
+          yarn build:bindings:configure:arm64
+
+      - name: "Build bindings (arm64, darwin)"
+        if: matrix.arch == 'arm64' && matrix.target_platform == 'darwin'
+        run: |
+          cd packages/profiling-node
+          BUILD_PLATFORM=darwin BUILD_ARCH=arm64 yarn build:bindings:arm64
+
+      - name: Archive binary
+        uses: actions/[email protected]
+        with:
+          name: profiling-node-binaries-${{ github.sha }}
+          path: |
+            ${{ github.workspace }}/packages/profiling-node/lib/*.node
+
+  job_pack_profiling_node:
+    runs-on: ubuntu-latest
+    needs: [job_get_metadata, job_build_bindings_profiling_node]
+    timeout-minutes: 5
+    steps:
+      - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }})
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ env.HEAD_COMMIT }}
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: 'package.json'
+
+      - run: |
+          cd packages/profiling-node
+          yarn install --frozen-lockfile
+
+      - run: |
+          cd packages/profiling-node
+          yarn build:lib
+
+      - uses: actions/[email protected]
+        with:
+          name: profiling-node-binaries-${{ github.sha }}
+          path: packages/profiling-node/lib/
+
+      - run: |
+          cd packages/profiling-node
+          yarn pack
+
   job_size_check:
     name: Size Check
-    needs: [job_get_metadata, job_build]
+    needs: [job_get_metadata, job_build, job_build_bindings_profiling_node]
     timeout-minutes: 15
     runs-on: ubuntu-20.04
     if:
@@ -299,7 +512,7 @@ jobs:
     name: Lint
     # Even though the linter only checks source code, not built code, it needs the built code in order check that all
     # inter-package dependencies resolve cleanly.
-    needs: [job_get_metadata, job_build]
+    needs: [job_get_metadata, job_build, job_build_bindings_profiling_node]
     timeout-minutes: 10
     runs-on: ubuntu-20.04
     steps:
@@ -317,6 +530,8 @@ jobs:
           DEPENDENCY_CACHE_KEY: ${{ needs.job_build.outputs.dependency_cache_key }}
       - name: Lint source files
         run: yarn lint
+      - name: Lint C++ files
+        run: yarn lint:clang
       - name: Validate ES5 builds
         run: yarn validate:es5
 
@@ -343,7 +558,7 @@ jobs:
 
   job_artifacts:
     name: Upload Artifacts
-    needs: [job_get_metadata, job_build]
+    needs: [job_get_metadata, job_build, job_build_bindings_profiling_node]
     runs-on: ubuntu-20.04
     # Build artifacts are only needed for releasing workflow.
     if: needs.job_get_metadata.outputs.is_release == 'true'
@@ -398,6 +613,24 @@ jobs:
       - name: Compute test coverage
         uses: codecov/codecov-action@v3
 
+  job_profiling_node_unit_tests:
+    name: Profiling Node Unit Tests
+    needs: [job_get_metadata, job_build]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }})
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ env.HEAD_COMMIT }}
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 'package.json'
+      - uses: actions/setup-python@v4
+      - run: yarn install --frozen-lockfile
+      - run: yarn build:bindings:configure
+      - run: yarn build
+      - run: yarn test
+
   job_bun_unit_tests:
     name: Bun Unit Tests
     needs: [job_get_metadata, job_build]

package.json

@@ -26,6 +26,7 @@
     "link:yarn": "lerna exec yarn link",
     "lint": "run-p lint:lerna lint:biome lint:prettier",
     "lint:lerna": "lerna run lint",
+    "lint:clang": "lerna run lint:clang",
     "lint:biome": "biome check .",
     "lint:prettier": "prettier **/*.md **/*.css --check",
     "validate:es5": "lerna run validate:es5",
@@ -63,6 +64,7 @@
     "packages/node-experimental",
     "packages/opentelemetry-node",
     "packages/opentelemetry",
+    "packages/profiling-node",
     "packages/react",
     "packages/remix",
     "packages/replay",

packages/profiling-node/.eslintrc.js

@@ -0,0 +1,18 @@
+module.exports = {
+  env: {
+    node: true,
+  },
+  extends: ['../../.eslintrc.js'],
+
+  ignorePatterns: [
+    'lib/**/*',
+    'demo_app/**/*',
+    'jest.co'
+  ],
+  rules: {
+    '@sentry-internal/sdk/no-optional-chaining': 'off',
+    '@sentry-internal/sdk/no-nullish-coalescing': 'off',
+    '@sentry-internal/sdk/no-unsupported-es6-methods': 'off',
+    '@sentry-internal/sdk/no-class-field-initializers': 'off',
+  },
+};

packages/profiling-node/.gitignore

@@ -0,0 +1,6 @@
+# See https://help.github.com/ignore-files/ for more about ignoring files.
+
+# compiled output
+/node_modules/
+/lib/
+