Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions Block/SentryScript.php
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,14 @@ public function useSessionReplay(): bool
return $this->dataHelper->useSessionReplay();
}

/**
* Whether to enable session replay.
*/
public function isFeedbackButtonEnabled(): bool
{
return $this->dataHelper->isFeedbackButtonEnabled();
}

/**
* Get the session replay sample rate.
*/
Expand Down
8 changes: 8 additions & 0 deletions Helper/Data.php
Original file line number Diff line number Diff line change
Expand Up @@ -509,6 +509,14 @@ public function useSessionReplay(): bool
return $this->scopeConfig->isSetFlag(static::XML_PATH_SRS.'enable_session_replay', ScopeInterface::SCOPE_STORE);
}

/**
* Whether to enable the user feedback button.
*/
public function isFeedbackButtonEnabled(): bool
{
return $this->scopeConfig->isSetFlag(static::XML_PATH_SRS.'enable_feedback_button', ScopeInterface::SCOPE_STORE);
}

/**
* Get the session replay sample rate.
*/
Expand Down
8 changes: 8 additions & 0 deletions etc/adminhtml/system.xml
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,14 @@
<field id="enable_script_tag">1</field>
</depends>
</field>
<field id="enable_feedback_button" translate="label" type="select" sortOrder="40" showInDefault="1" showInStore="1" showInWebsite="1" canRestore="1">
<label>Enable Customer Feedback button</label>
<comment>Enabling the feedback button will also include session replay and tracing in the javascript bundle, to use it also enable the options accordingly</comment>
<source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
<depends>
<field id="enable_script_tag">1</field>
</depends>
</field>
<field id="replay_session_sample_rate" translate="label" type="text" sortOrder="50" showInDefault="1" showInStore="1" showInWebsite="1" canRestore="1">
<label>Session Sample Rate</label>
<depends>
Expand Down
4 changes: 2 additions & 2 deletions view/frontend/layout/default.xml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<?xml version="1.0"?>
<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
<body>
<!-- <referenceBlock name="head.additional">
<referenceBlock name="head.additional">
<block class="JustBetter\Sentry\Block\SentryScript" before="-" template="JustBetter_Sentry::script/sentry.phtml" name="sentry.head.additional" />
</referenceBlock>

<referenceContainer name="before.body.end">
<block class="JustBetter\Sentry\Block\SentryScript" before="-" template="JustBetter_Sentry::script/sentry.phtml" name="sentry.before.body.end" />
</referenceContainer> -->
</referenceContainer>
</body>
</page>
8 changes: 6 additions & 2 deletions view/frontend/templates/script/sentry.phtml
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,18 @@ if (!$block->canUseScriptTag($block->getNameInLayout())) {
<?php
$bundleFile = 'bundle';

if ($block->isTracingEnabled()) {
if ($block->isTracingEnabled() || $block->isFeedbackButtonEnabled()) {
$bundleFile .= '.tracing';
}

if ($block->useSessionReplay()) {
if ($block->useSessionReplay() || $block->isFeedbackButtonEnabled()) {
$bundleFile .= '.replay';
}

if ($block->isFeedbackButtonEnabled()) {
$bundleFile .= '.feedback';
}

$bundleFile .= '.min.js';

$remoteFile = sprintf(
Expand Down
111 changes: 60 additions & 51 deletions view/frontend/templates/script/sentry_init.phtml
Original file line number Diff line number Diff line change
@@ -1,57 +1,66 @@
<?php /** @var \JustBetter\Sentry\Block\SentryScript $block */ ?>
if (typeof Sentry !== 'undefined') {
Sentry.init({
dsn: '<?= $escaper->escapeUrl(trim($block->getDSN())) ?>',
release: '<?= $escaper->escapeHtml(trim($block->getVersion())) ?>',
environment: '<?= $escaper->escapeHtml(trim($block->getEnvironment())) ?>',
integrations: [
<?php if ($block->isTracingEnabled()): ?>
Sentry.browserTracingIntegration({
enableInp: true,
}),
<?php endif ?>
<?php if ($block->useSessionReplay()): ?>
Sentry.replayIntegration({
blockAllMedia: <?= $escaper->escapeHtml($block->getReplayBlockMedia() ? 'true' : 'false') ?>,
maskAllText: <?= $escaper->escapeHtml($block->getReplayMaskText() ? 'true' : 'false') ?>,
})
<?php endif ?>
],
<?php if ($block->isTracingEnabled()): ?>
tracesSampleRate: <?= $escaper->escapeHtml($block->getTracingSampleRate()) ?>,
<?php endif ?>
<?php if ($block->useSessionReplay()): ?>
replaysSessionSampleRate: <?= $escaper->escapeHtml($block->getReplaySessionSampleRate()) ?>,
replaysOnErrorSampleRate: <?= $escaper->escapeHtml($block->getReplayErrorSampleRate()) ?>,
<?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;
}
<?php

<?php if ($block->stripStaticContentVersion()): ?>
value.stacktrace.frames.map(function (frame) {
frame.filename = frame.filename.replace(/version[0-9]{10}\//, '');
return frame;
});
<?php endif; ?>
/** @var \JustBetter\Sentry\Block\SentryScript $block */ ?>
if (typeof Sentry !== 'undefined') {
Sentry.init({
dsn: '<?= $escaper->escapeUrl(trim($block->getDSN())) ?>',
release: '<?= $escaper->escapeHtml(trim($block->getVersion())) ?>',
environment: '<?= $escaper->escapeHtml(trim($block->getEnvironment())) ?>',
integrations: [
<?php if ($block->isTracingEnabled()): ?>
Sentry.browserTracingIntegration({
enableInp: true,
}),
<?php endif ?>
<?php if ($block->useSessionReplay()): ?>
Sentry.replayIntegration({
blockAllMedia: <?= $escaper->escapeHtml($block->getReplayBlockMedia() ? 'true' : 'false') ?>,
maskAllText: <?= $escaper->escapeHtml($block->getReplayMaskText() ? 'true' : 'false') ?>,
}),
<?php endif ?>
<?php if ($block->isFeedbackButtonEnabled()): ?>
Sentry.feedbackIntegration({}),
<?php endif ?>
],
<?php if ($block->isTracingEnabled()): ?>
tracesSampleRate: <?= $escaper->escapeHtml($block->getTracingSampleRate()) ?>,
<?php endif ?>
<?php if ($block->useSessionReplay()): ?>
replaysSessionSampleRate: <?= $escaper->escapeHtml($block->getReplaySessionSampleRate()) ?>,
replaysOnErrorSampleRate: <?= $escaper->escapeHtml($block->getReplayErrorSampleRate()) ?>,
<?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;
}

<?php if ($block->stripStoreCode()): ?>
value.stacktrace.frames.map(function (frame) {
<?php // phpcs:disable Generic.Files.LineLength ?>
frame.filename = frame.filename.replace('/<?= $escaper->escapeHtml($block->getStoreCode()); ?>/', '/');
<?php // phpcs:enable Generic.Files.LineLength ?>
return frame;
});
<?php endif; ?>
<?php if ($block->stripStaticContentVersion()): ?>
value.stacktrace.frames.map(function (frame) {
frame.filename = frame.filename.replace(/version[0-9]{10}\//, '');
return frame;
});
<?php endif; ?>

return value;
<?php if ($block->stripStoreCode()): ?>
value.stacktrace.frames.map(function (frame) {
<?php // phpcs:disable Generic.Files.LineLength
?>
frame.filename = frame.filename.replace('/<?= $escaper->escapeHtml($block->getStoreCode()); ?>/', '/');
<?php // phpcs:enable Generic.Files.LineLength
?>
return frame;
});
return event;
}
<?php endif; ?>

return value;
});
}
return event;
}
<?php endif; ?>
});
}