rename option, streamlie reportPageLoaded

Author: Lms24

dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/reportPageLoaded/default/init.js

@@ -5,7 +5,7 @@ window._testBaseTimestamp = performance.timeOrigin / 1000;
 
 Sentry.init({
   dsn: 'https://[email protected]/1337',
-  integrations: [Sentry.browserTracingIntegration({ explicitPageloadEnd: true })],
+  integrations: [Sentry.browserTracingIntegration({ enableReportPageLoaded: true })],
   tracesSampleRate: 1,
   debug: true,
 });

dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/reportPageLoaded/default/test.ts

@@ -9,7 +9,7 @@ import { sentryTest } from '../../../../../utils/fixtures';
 import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';
 
 sentryTest(
-  'waits for Sentry.reportPageLoaded() to be called when `explicitPageloadEnd` is true',
+  'waits for Sentry.reportPageLoaded() to be called when `enableReportPageLoaded` is true',
   async ({ getLocalTestUrl, page }) => {
     if (shouldSkipTracingTest()) {
       sentryTest.skip();

dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/reportPageLoaded/finalTimeout/init.js

@@ -5,7 +5,7 @@ window._testBaseTimestamp = performance.timeOrigin / 1000;
 
 Sentry.init({
   dsn: 'https://[email protected]/1337',
-  integrations: [Sentry.browserTracingIntegration({ explicitPageloadEnd: true, finalTimeout: 3000 })],
+  integrations: [Sentry.browserTracingIntegration({ enableReportPageLoaded: true, finalTimeout: 3000 })],
   tracesSampleRate: 1,
   debug: true,
 });

dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/reportPageLoaded/finalTimeout/test.ts

@@ -9,7 +9,7 @@ import { sentryTest } from '../../../../../utils/fixtures';
 import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';
 
 sentryTest(
-  'final timeout cancels the pageload span even if `explicitPageloadEnd` is true',
+  'final timeout cancels the pageload span even if `enableReportPageLoaded` is true',
   async ({ getLocalTestUrl, page }) => {
     if (shouldSkipTracingTest()) {
       sentryTest.skip();

dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/reportPageLoaded/navigation/init.js

@@ -5,7 +5,7 @@ window._testBaseTimestamp = performance.timeOrigin / 1000;
 
 Sentry.init({
   dsn: 'https://[email protected]/1337',
-  integrations: [Sentry.browserTracingIntegration({ explicitPageloadEnd: true, instrumentNavigation: false })],
+  integrations: [Sentry.browserTracingIntegration({ enableReportPageLoaded: true, instrumentNavigation: false })],
   tracesSampleRate: 1,
   debug: true,
 });

dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/reportPageLoaded/navigation/test.ts

@@ -9,7 +9,7 @@ import { sentryTest } from '../../../../../utils/fixtures';
 import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../../utils/helpers';
 
 sentryTest(
-  'starting a navigation span cancels the pageload span even if `explicitPageloadEnd` is true',
+  'starting a navigation span cancels the pageload span even if `enableReportPageLoaded` is true',
   async ({ getLocalTestUrl, page }) => {
     if (shouldSkipTracingTest()) {
       sentryTest.skip();

packages/browser/src/tracing/browserTracingIntegration.ts

@@ -265,7 +265,7 @@ export interface BrowserTracingOptions {
    * that the pageload duration can be arbitrary and might not be fully representative of a perceived
    * page load time.
    */
-  explicitPageloadEnd: boolean;
+  enableReportPageLoaded: boolean;
 
   /**
    * _experiments allows the user to send options to define how this integration works.
@@ -314,7 +314,7 @@ const DEFAULT_BROWSER_TRACING_OPTIONS: BrowserTracingOptions = {
   detectRedirects: true,
   linkPreviousTrace: 'in-memory',
   consistentTraceSampling: false,
-  explicitPageloadEnd: false,
+  enableReportPageLoaded: false,
   _experiments: {},
   ...defaultRequestInstrumentationOptions,
 };
@@ -363,7 +363,7 @@ export const browserTracingIntegration = ((options: Partial<BrowserTracingOption
     detectRedirects,
     linkPreviousTrace,
     consistentTraceSampling,
-    explicitPageloadEnd,
+    enableReportPageLoaded,
     onRequestSpanStart,
   } = {
     ...DEFAULT_BROWSER_TRACING_OPTIONS,
@@ -442,10 +442,10 @@ export const browserTracingIntegration = ((options: Partial<BrowserTracingOption
           _pageloadSpan = undefined;
         }
       },
-      trimIdleSpanEndTimestamp: !explicitPageloadEnd,
+      trimIdleSpanEndTimestamp: !enableReportPageLoaded,
     });
 
-    if (isPageloadSpan && explicitPageloadEnd) {
+    if (isPageloadSpan && enableReportPageLoaded) {
       _pageloadSpan = idleSpan;
     }
 
@@ -458,7 +458,7 @@ export const browserTracingIntegration = ((options: Partial<BrowserTracingOption
     }
 
     // Enable auto finish of the pageload span if users are not explicitly ending it
-    if (isPageloadSpan && !explicitPageloadEnd && optionalWindowDocument) {
+    if (isPageloadSpan && !enableReportPageLoaded && optionalWindowDocument) {
       optionalWindowDocument.addEventListener('readystatechange', () => {
         emitFinish();
       });
@@ -607,7 +607,7 @@ export const browserTracingIntegration = ((options: Partial<BrowserTracingOption
       });
 
       client.on('endPageloadSpan', () => {
-        if (explicitPageloadEnd && _pageloadSpan) {
+        if (enableReportPageLoaded && _pageloadSpan) {
           _pageloadSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_IDLE_SPAN_FINISH_REASON, 'reportPageLoaded');
           _pageloadSpan.end();
         }
@@ -765,17 +765,14 @@ export function getMetaContent(metaName: string): string | undefined {
 
 /**
  * Manually report the end of the page load, resulting in the SDK ending the pageload span.
- * This only works if {@link BrowserTracingOptions.explicitPageloadEnd} is set to `true`.
+ * This only works if {@link BrowserTracingOptions.enableReportPageLoaded} is set to `true`.
  * Otherwise, the pageload span will end itself based on the {@link BrowserTracingOptions.finalTimeout},
  * {@link BrowserTracingOptions.idleTimeout} and {@link BrowserTracingOptions.childSpanTimeout}.
  *
  * @param client - The client to use. If not provided, the global client will be used.
  */
-export function reportPageLoaded(client?: Client): void {
-  const clientToUse = client ?? getClient();
-  if (clientToUse) {
-    clientToUse.emit('endPageloadSpan');
-  }
+export function reportPageLoaded(client: Client | undefined = getClient()): void {
+  client?.emit('endPageloadSpan');
 }
 
 /** Start listener for interaction transactions */