[FEATURE] prevent error reporting after user has navigated during pageload

Author: rommelfreddy

Block/SentryScript.php

@@ -170,4 +170,9 @@ public function getIgnoreJsErrors(): string
     {
         return $this->json->serialize($this->dataHelper->getIgnoreJsErrors());
     }
+
+    public function isPreventReportingAfterUnload(): bool
+    {
+        return $this->dataHelper->isPreventReportingAfterUnload();
+    }
 }

Helper/Data.php

@@ -36,7 +36,8 @@ class Data extends AbstractHelper
         'js_sdk_version',
         'tracing_enabled',
         'tracing_sample_rate',
-        'ignore_js_errors'
+        'ignore_js_errors',
+        'prevent_reporting_after_unload'
     ];
 
     /**
@@ -344,4 +345,9 @@ public function shouldCaptureException(\Throwable $ex)
 
         return true;
     }
+
+    public function isPreventReportingAfterUnload(): bool
+    {
+        return (bool) ($this->config['prevent_reporting_after_unload'] ?? false);
+    }
 }

README.md

@@ -24,7 +24,8 @@ This module uses the [Magento Deployment Configuration](https://devdocs.magento.
     'js_sdk_version' => \JustBetter\Sentry\Block\SentryScript::CURRENT_VERSION
     'tracing_enabled' => true, 
     'tracing_sample_rate' => 0.5,
-    'ignore_js_errors' => []
+    'ignore_js_errors' => [],
+    'prevent_reporting_after_unload' => false
 ]
 ```
 
@@ -41,6 +42,7 @@ Next to that there are some configuration options under Stores > Configuration >
 * `tracing_enabled` if this option is set to true, tracing got enabled (bundle file got loaded automatically). Default: `false`
 * `tracing_sample_rate` if tracing is enabled, you should also set the sample rate. Default: `0.2`
 * `ignore_js_errors` array of javascript error messages, which should be not send to Sentry.
+* `prevent_reporting_after_unload` if this option is set to `true`, no errors will be reported after unload event. Can be useful, when the user navigates to an different page, during loading of resources by requirejs. 
 
 ## Optional error page configuration
 - Optional you can configure custom error pages in pub/errors. You can use the sentry feedback form and insert here the sentry log ID. The Sentry Log Id is captured in de customer session and can be retrieved in `processor.php`.

view/frontend/templates/script/sentry.phtml

@@ -17,48 +17,68 @@ $remoteFile = sprintf('https://browser.sentry-cdn.com/%s/%s', $block->escapeHtml
 <script src="https://cdn.polyfill.io/v2/polyfill.min.js?features=Promise" crossorigin></script>
 <script src="<?= /** @noEscape */$remoteFile ?>" crossorigin="anonymous"></script>
 <script>
-    Sentry.init({
-        dsn: '<?= $block->escapeUrl(trim($block->getDSN())) ?>',
-        release: '<?= $block->escapeHtml(trim($block->getVersion())) ?>',
-        environment: '<?= $block->escapeHtml(trim($block->getEnvironment())) ?>',
-        integrations: [
-            <?php if ($block->isTracingEnabled()) : ?>
-                new Sentry.BrowserTracing(),
-            <?php endif ?>
-        ],
-        <?php if ($block->isTracingEnabled()) : ?>
-        tracesSampleRate: <?=$block->getTracingSampleRate()?>,
-        <?php endif ?>
-        ignoreErrors: <?= /** @noEscape */ $block->getIgnoreJsErrors() ?>,
-        <?php if ($block->stripStaticContentVersion() || $block->stripStoreCode()): ?>
-        beforeSend: function(event) {
-            event.exception.values.map(function (value) {
-                if (value.stacktrace === undefined || ! value.stacktrace) {
-                    return value;
-                }
+    (function () {
+        <?php if ($block->isPreventReportingAfterUnload()): ?>
+            let preventSentryReporting = false;
+            window.addEventListener('beforeunload', () => {
+                preventSentryReporting = true;
+            });
 
-                <?php if ($block->stripStaticContentVersion()): ?>
-                value.stacktrace.frames.map(function (frame) {
-                    frame.filename = frame.filename.replace(/version[0-9]{10}\//, '');
-                    return frame;
-                });
-                <?php endif; ?>
+            if (preventSentryReporting) {
+                return;
+            }
+        <?php endif ?>
 
-                <?php if ($block->stripStoreCode()): ?>
-                value.stacktrace.frames.map(function (frame) {
-                    <?php // phpcs:disable Generic.Files.LineLength ?>
-                    frame.filename = frame.filename.replace('/<?= $block->escapeHtml($block->getStoreCode()); ?>/', '/');
-                    <?php // phpcs:enable Generic.Files.LineLength ?>
-                    return frame;
-                });
+        Sentry.init({
+            dsn: '<?= $block->escapeUrl(trim($block->getDSN())) ?>',
+            release: '<?= $block->escapeHtml(trim($block->getVersion())) ?>',
+            environment: '<?= $block->escapeHtml(trim($block->getEnvironment())) ?>',
+            integrations: [
+                <?php if ($block->isTracingEnabled()): ?>
+                new Sentry.BrowserTracing(),
+                <?php endif ?>
+            ],
+            <?php if ($block->isTracingEnabled()): ?>
+            tracesSampleRate: <?=$block->getTracingSampleRate()?>,
+            <?php endif ?>
+            ignoreErrors: <?= /** @noEscape */ $block->getIgnoreJsErrors() ?>,
+            beforeSend: function (event) {
+                <?php if ($block->isPreventReportingAfterUnload()): ?>
+                    if (preventSentryReporting) {
+                        return null;
+                    }
+                <?php endif ?>
+
+                <?php if ($block->stripStaticContentVersion() || $block->stripStoreCode()): ?>
+                    event.exception.values.map(function (value) {
+                        if (value.stacktrace === undefined || !value.stacktrace) {
+                            return value;
+                        }
+
+                        <?php if ($block->stripStaticContentVersion()): ?>
+                        value.stacktrace.frames.map(function (frame) {
+                            frame.filename = frame.filename.replace(/version[0-9]{10}\//, '');
+                            return frame;
+                        });
+                        <?php endif; ?>
+
+                        <?php if ($block->stripStoreCode()): ?>
+                        value.stacktrace.frames.map(function (frame) {
+                            <?php // phpcs:disable Generic.Files.LineLength ?>
+                            frame.filename = frame.filename.replace('/<?= $block->escapeHtml($block->getStoreCode()); ?>/', '/');
+                            <?php // phpcs:enable Generic.Files.LineLength ?>
+                            return frame;
+                        });
+                        <?php endif; ?>
+
+                        return value;
+                    });
                 <?php endif; ?>
 
-                return value;
-            });
-            return event;
-        }
-    <?php endif; ?>
-    });
+                return event;
+            }
+        });
+    })();
 </script>
 
 <?php if ($block->useLogRocket()): ?>