feat(core): Re-add _experiments.enableLogs option (#18299)

We're re-introducing
`_experiments.enableLogs`. The option stays deprecated and maybe we can
actually remove it or type it as `undefined` in the next major to sunset
it for good. Main motivation for re-adding: The flag was introduced in
v9 while we already worked on v10 where we removed it again. Therefore,
it had an unusually short lifespan. Some users didn't realize this when
upgrading to v10 and were wondering where their logs went.

Author: Lms24

dev-packages/browser-integration-tests/suites/public-api/logger/init.js

@@ -4,5 +4,8 @@ window.Sentry = Sentry;
 
 Sentry.init({
   dsn: 'https://[email protected]/1337',
-  enableLogs: true,
+  // purposefully testing against the experimental flag here
+  _experiments: {
+    enableLogs: true,
+  },
 });

dev-packages/browser-integration-tests/suites/public-api/logger/integration/init.js

@@ -5,5 +5,10 @@ window.Sentry = Sentry;
 Sentry.init({
   dsn: 'https://[email protected]/1337',
   enableLogs: true,
+  // Purposefully specifying the experimental flag here
+  // to ensure the top level option is used instead.
+  _experiments: {
+    enableLogs: false,
+  },
   integrations: [Sentry.consoleLoggingIntegration()],
 });

dev-packages/node-core-integration-tests/suites/winston/subject.ts

@@ -8,7 +8,11 @@ const client = Sentry.init({
   dsn: 'https://[email protected]/1337',
   release: '1.0.0',
   environment: 'test',
-  enableLogs: true,
+  // Purposefully specifying the experimental flag here
+  // to ensure the top level option is still respected.
+  _experiments: {
+    enableLogs: true,
+  },
   transport: loggingTransport,
 });
 

packages/core/src/client.ts

@@ -239,6 +239,11 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
       });
     }
 
+    // Backfill enableLogs option from _experiments.enableLogs
+    // TODO(v11): Remove or change default value
+    // eslint-disable-next-line deprecation/deprecation
+    this._options.enableLogs = this._options.enableLogs ?? this._options._experiments?.enableLogs;
+
     // Setup log flushing with weight and timeout tracking
     if (this._options.enableLogs) {
       setupWeightBasedFlushing(this, 'afterCaptureLog', 'flushLogs', estimateLogSizeInBytes, _INTERNAL_flushLogsBuffer);

packages/core/src/types-hoist/options.ts

@@ -306,6 +306,14 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp
      * @deprecated Use the top level`beforeSendMetric` option instead.
      */
     beforeSendMetric?: (metric: Metric) => Metric | null;
+
+    /**
+     * Determines if logs support should be enabled.
+     *
+     * @default false
+     * @deprecated Use the top level `enableLogs` option instead.
+     */
+    enableLogs?: boolean;
   };
 
   /**

packages/core/test/lib/client.test.ts

@@ -2734,6 +2734,36 @@ describe('Client', () => {
     });
   });
 
+  describe('enableLogs', () => {
+    it('defaults to  `undefined`', () => {
+      const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN });
+      const client = new TestClient(options);
+      expect(client.getOptions().enableLogs).toBeUndefined();
+    });
+
+    it('can be set as a top-level option', () => {
+      const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, enableLogs: true });
+      const client = new TestClient(options);
+      expect(client.getOptions().enableLogs).toBe(true);
+    });
+
+    it('can be set as an experimental option', () => {
+      const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, _experiments: { enableLogs: true } });
+      const client = new TestClient(options);
+      expect(client.getOptions().enableLogs).toBe(true);
+    });
+
+    test('top-level option takes precedence over experimental option', () => {
+      const options = getDefaultTestClientOptions({
+        dsn: PUBLIC_DSN,
+        enableLogs: true,
+        _experiments: { enableLogs: false },
+      });
+      const client = new TestClient(options);
+      expect(client.getOptions().enableLogs).toBe(true);
+    });
+  });
+
   describe('log weight-based flushing', () => {
     beforeEach(() => {
       vi.useFakeTimers();