feat(profiling-node): Expose nodeProfilingIntegration

Author: mydea

MIGRATION.md

@@ -780,6 +780,8 @@ The following list shows how integrations should be migrated:
 | `new Hapi()`                 | `hapiIntegration()`                 | `@sentry/node`                                                                                          |
 | `new Undici()`               | `nativeNodeFetchIntegration()`      | `@sentry/node`                                                                                          |
 | `new Http()`                 | `httpIntegration()`                 | `@sentry/node`                                                                                          |
+| `new ProfilingIntegration()`        | `nodeProfilingIntegration()`        | `@sentry/profiling-node`                                                                                |
+| `new BrowserProfilingIntegration()` | `browserProfilingIntegration()`     | `@sentry/browser`                                                                                       |
 
 ## Deprecate `hub.bindClient()` and `makeMain()`
 

packages/profiling-node/README.md

@@ -27,14 +27,14 @@ npm install --save @sentry/node @sentry/profiling-node
 
 ```javascript
 import * as Sentry from '@sentry/node';
-import { ProfilingIntegration } from '@sentry/profiling-node';
+import { nodeProfilingIntegration } from '@sentry/profiling-node';
 
 Sentry.init({
   dsn: 'https://[email protected]/6625302',
   debug: true,
   tracesSampleRate: 1,
   profilesSampleRate: 1, // Set profiling sampling rate.
-  integrations: [new ProfilingIntegration()],
+  integrations: [nodeProfilingIntegration()],
 });
 ```
 

packages/profiling-node/src/index.ts

@@ -1 +1,5 @@
-export { ProfilingIntegration } from './integration';
+export {
+  // eslint-disable-next-line deprecation/deprecation
+  ProfilingIntegration,
+  nodeProfilingIntegration,
+} from './integration';

packages/profiling-node/src/integration.ts

@@ -1,6 +1,14 @@
 import { spanToJSON } from '@sentry/core';
 import type { NodeClient } from '@sentry/node-experimental';
-import type { Event, EventProcessor, Hub, Integration, Transaction } from '@sentry/types';
+import type {
+  Event,
+  EventProcessor,
+  Hub,
+  Integration,
+  IntegrationFn,
+  IntegrationFnResult,
+  Transaction,
+} from '@sentry/types';
 
 import { logger } from '@sentry/utils';
 
@@ -40,6 +48,8 @@ function addToProfileQueue(profile: RawThreadCpuProfile): void {
  * and inspect each event to see if it is a transaction event and if that transaction event
  * contains a profile on it's metadata. If that is the case, we create a profiling event envelope
  * and delete the profile from the transaction metadata.
+ *
+ * @deprecated Use `nodeProfilingIntegration` instead.
  */
 export class ProfilingIntegration implements Integration {
   /**
@@ -245,3 +255,14 @@ export class ProfilingIntegration implements Integration {
     return maybeRemoveProfileFromSdkMetadata(event);
   }
 }
+
+/**
+ * We need this integration in order to send data to Sentry. We hook into the event processor
+ * and inspect each event to see if it is a transaction event and if that transaction event
+ * contains a profile on it's metadata. If that is the case, we create a profiling event envelope
+ * and delete the profile from the transaction metadata.
+ */
+export const nodeProfilingIntegration = (() => {
+  // eslint-disable-next-line deprecation/deprecation
+  return new ProfilingIntegration() as unknown as IntegrationFnResult;
+}) satisfies IntegrationFn;

packages/profiling-node/test/hubextensions.hub.test.ts

@@ -7,6 +7,7 @@ import { CpuProfilerBindings } from '../src/cpu_profiler';
 import { ProfilingIntegration } from '../src/index';
 
 function makeClientWithoutHooks(): [Sentry.NodeClient, Transport] {
+  // eslint-disable-next-line deprecation/deprecation
   const integration = new ProfilingIntegration();
   const transport = Sentry.makeNodeTransport({
     url: 'https://[email protected]/6625302',
@@ -41,6 +42,7 @@ function makeClientWithoutHooks(): [Sentry.NodeClient, Transport] {
 }
 
 function makeClientWithHooks(): [Sentry.NodeClient, Transport] {
+  // eslint-disable-next-line deprecation/deprecation
   const integration = new ProfilingIntegration();
   const client = new Sentry.NodeClient({
     stackParser: Sentry.defaultStackParser,

packages/profiling-node/test/index.test.ts

@@ -23,6 +23,7 @@ function makeStaticTransport(): MockTransport {
 }
 
 function makeClientWithoutHooks(): [Sentry.NodeClient, MockTransport] {
+  // eslint-disable-next-line deprecation/deprecation
   const integration = new ProfilingIntegration();
   const transport = makeStaticTransport();
   const client = new Sentry.NodeClient({

packages/profiling-node/test/integration.test.ts

@@ -43,10 +43,12 @@ describe('ProfilingIntegration', () => {
     jest.clearAllMocks();
   });
   it('has a name', () => {
+    // eslint-disable-next-line deprecation/deprecation
     expect(new ProfilingIntegration().name).toBe('ProfilingIntegration');
   });
 
   it('stores a reference to getCurrentHub', () => {
+    // eslint-disable-next-line deprecation/deprecation
     const integration = new ProfilingIntegration();
 
     const getCurrentHub = jest.fn().mockImplementation(() => {
@@ -66,6 +68,7 @@ describe('ProfilingIntegration', () => {
         send: jest.fn().mockImplementation(() => Promise.resolve()),
         flush: jest.fn().mockImplementation(() => Promise.resolve()),
       };
+      // eslint-disable-next-line deprecation/deprecation
       const integration = new ProfilingIntegration();
 
       const getCurrentHub = jest.fn((): Hub => {
@@ -100,6 +103,7 @@ describe('ProfilingIntegration', () => {
 
     it('when Hub.getClient returns undefined', async () => {
       const logSpy = jest.spyOn(logger, 'log');
+      // eslint-disable-next-line deprecation/deprecation
       const integration = new ProfilingIntegration();
 
       const getCurrentHub = jest.fn((): Hub => {
@@ -115,6 +119,7 @@ describe('ProfilingIntegration', () => {
     });
     it('when getDsn returns undefined', async () => {
       const logSpy = jest.spyOn(logger, 'log');
+      // eslint-disable-next-line deprecation/deprecation
       const integration = new ProfilingIntegration();
 
       const getCurrentHub = jest.fn((): Hub => {
@@ -136,6 +141,7 @@ describe('ProfilingIntegration', () => {
     });
     it('when getTransport returns undefined', async () => {
       const logSpy = jest.spyOn(logger, 'log');
+      // eslint-disable-next-line deprecation/deprecation
       const integration = new ProfilingIntegration();
 
       const getCurrentHub = jest.fn((): Hub => {
@@ -165,6 +171,7 @@ describe('ProfilingIntegration', () => {
         send: jest.fn().mockImplementation(() => Promise.resolve()),
         flush: jest.fn().mockImplementation(() => Promise.resolve()),
       };
+      // eslint-disable-next-line deprecation/deprecation
       const integration = new ProfilingIntegration();
 
       const getCurrentHub = jest.fn((): Hub => {
@@ -198,6 +205,7 @@ describe('ProfilingIntegration', () => {
         send: jest.fn().mockImplementation(() => Promise.resolve()),
         flush: jest.fn().mockImplementation(() => Promise.resolve()),
       };
+      // eslint-disable-next-line deprecation/deprecation
       const integration = new ProfilingIntegration();
       const emitter = new EventEmitter();
 
@@ -233,6 +241,7 @@ describe('ProfilingIntegration', () => {
         send: jest.fn().mockImplementation(() => Promise.resolve()),
         flush: jest.fn().mockImplementation(() => Promise.resolve()),
       };
+      // eslint-disable-next-line deprecation/deprecation
       const integration = new ProfilingIntegration();
       const emitter = new EventEmitter();