Skip to content

DGS-427 Improve logs section: collapse request/response into modal vi… #168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rokaszygmantas merged 4 commits into from
May 25, 2026
Merged

DGS-427 Improve logs section: collapse request/response into modal vi… #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9a7e7c6
DGS-427 Improve logs section: collapse request/response into modal vi…
May 5, 2026
5124f10
DGS-427 Restructure logs list and JSON-encode payloads
May 5, 2026
be643c3
DGS-427 Override logs CSV export with diagnostic header
May 5, 2026
a8c1f36
Merge branch 'release-3.3.1' into DGS-427-improve-logs-section
TLabutis May 25, 2026
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
3 changes: 2 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,7 @@
- Added PrestaShop 9 compatibility
- Fixed issue with price rule "All"
- Fixed other minor issues
- Improved Logs section by collapsing request/response into a modal viewer to fix table overflow on long URLs

## [3.3.1]
- Fixed incorrect COD label amount when discount code is applied
Expand All @@ -199,4 +200,4 @@
- Fixed automatic PUDO point pre-selection in LIST mode
- Fixed PUDO shipment CSS styling
- Added timeframes to shipment request
- Fixed DPDBaltics menu item disappearing from sidebar when navigating to module pages
- Fixed DPDBaltics menu item disappearing from sidebar when navigating to module pages
283 changes: 266 additions & 17 deletions controllers/admin/AdminDPDBalticsLogsController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,9 @@
* @license https://opensource.org/licenses/AFL-3.0 Academic Free License version 3.0
*/

use Invertus\dpdBaltics\Config\Config;
use Invertus\dpdBaltics\Controller\AbstractAdminController;
use Invertus\dpdBaltics\Logger\Logger;
use Invertus\dpdBaltics\Infrastructure\Bootstrap\ModuleTabs;

require_once dirname(__DIR__).'/../vendor/autoload.php';

Expand All @@ -29,6 +30,11 @@

class AdminDPDBalticsLogsController extends AbstractAdminController
{
const FILE_NAME = 'AdminDPDBalticsLogsController';

const LOG_INFORMATION_TYPE_REQUEST = 'request';
const LOG_INFORMATION_TYPE_RESPONSE = 'response';

public function __construct()
{
$this->className = 'DPDProduct';
Expand All @@ -46,37 +52,280 @@ public function initToolbar()
unset($this->toolbar_btn['new']);
}

public function setMedia($isNewTheme = false)
{
parent::setMedia($isNewTheme);

Media::addJsDef([
'dpdbaltics' => [
'logsUrl' => $this->context->link->getAdminLink(ModuleTabs::ADMIN_LOGS_CONTROLLER),
],
]);

$this->addCSS($this->module->getPathUri() . 'views/css/admin/logs_tab.css');
$this->addJS($this->module->getPathUri() . 'views/js/admin/log.js');
}

public function printRequestButton($request, $data)
{
return $this->getDisplayButton($data['id_dpd_log'], $request, self::LOG_INFORMATION_TYPE_REQUEST);
}

public function printResponseButton($response, $data)
{
return $this->getDisplayButton($data['id_dpd_log'], $response, self::LOG_INFORMATION_TYPE_RESPONSE);
}

public function printSeverity($severity, $data)
{
$level = strtolower((string) $severity);
$levelMap = [
'emergency' => 1, 'alert' => 1, 'critical' => 1, 'error' => 1,
'warning' => 2,
'notice' => 3, 'info' => 3,
'debug' => 4,
];
$num = isset($levelMap[$level]) ? $levelMap[$level] : null;
$cssClass = $num ? 'dpd-log-severity dpd-log-severity-' . $num : 'dpd-log-severity';
$label = $level !== '' ? ucfirst($level) : '--';

return sprintf(
'<span class="%s">%s</span>',
htmlspecialchars($cssClass, ENT_QUOTES, 'UTF-8'),
$num ? sprintf('%d &middot; %s', $num, htmlspecialchars($label, ENT_QUOTES, 'UTF-8')) : htmlspecialchars($label, ENT_QUOTES, 'UTF-8')
);
}

public function printMessage($message, $data)
{
if ($message === null || $message === '') {
return '--';
}
$value = (string) $message;
$decoded = json_decode($value, true);
if (json_last_error() === JSON_ERROR_NONE && is_array($decoded) && isset($decoded['message'])) {
$value = (string) $decoded['message'];
}
$clean = trim(preg_replace('/\s+/', ' ', strip_tags($value)));
if (function_exists('mb_strlen') && mb_strlen($clean) > 90) {
$clean = mb_substr($clean, 0, 87) . '...';
}
return htmlspecialchars($clean, ENT_QUOTES, 'UTF-8');
}

public function printContext($context, $data)
{
if ($context === null || $context === '') {
return '--';
}
$endpoint = '';
$decoded = json_decode((string) $context, true);
if (json_last_error() === JSON_ERROR_NONE && is_array($decoded) && !empty($decoded['endpoint'])) {
$endpoint = (string) $decoded['endpoint'];
} else {
$endpoint = (string) $context;
}
$endpoint = strtok($endpoint, '?');
$endpoint = $endpoint !== false ? basename($endpoint) : '';
if ($endpoint === '') {
return '--';
}
return htmlspecialchars($endpoint, ENT_QUOTES, 'UTF-8');
}

public function processExport($textDelimiter = '"')
{
if (ob_get_level() && ob_get_length() > 0) {
ob_clean();
}

$fileName = sprintf('dpdbaltics_logs_%s.csv', date('Y-m-d_His'));
header('Content-Type: text/csv; charset=utf-8');
header('Content-Disposition: attachment; filename=' . $fileName);
header('Cache-Control: no-store, no-cache');

$fd = fopen('php://output', 'wb');

$storeInfo = [
'PrestaShop Version' => _PS_VERSION_,
'PHP Version' => phpversion(),
'Module Version' => $this->module->version,
'MySQL Version' => Db::getInstance()->getVersion(),
'Shop URL' => $this->context->shop ? $this->context->shop->getBaseURL(true) : '',
'Shop Name' => Configuration::get('PS_SHOP_NAME'),
];

$moduleConfigurations = [
'Test mode' => Configuration::get(Config::SHIPMENT_TEST_MODE) ? 'Yes' : 'No',
'API country' => Configuration::get(Config::WEB_SERVICE_COUNTRY),
'Track logs' => Configuration::get(Config::TRACK_LOGS) ? 'Yes' : 'No',
];

$psSettings = [
'Default country' => Configuration::get('PS_COUNTRY_DEFAULT'),
'Default currency' => Configuration::get('PS_CURRENCY_DEFAULT'),
'Default language' => Configuration::get('PS_LANG_DEFAULT'),
'Round mode' => Configuration::get('PS_PRICE_ROUND_MODE'),
'Round type' => Configuration::get('PS_ROUND_TYPE'),
'PHP memory limit' => ini_get('memory_limit'),
];

fputcsv($fd, array_keys($storeInfo), ';', $textDelimiter);
fputcsv($fd, array_values($storeInfo), ';', $textDelimiter);
fputcsv($fd, [], ';', $textDelimiter);

$moduleConfigInfo = "**Module configurations:**\n";
foreach ($moduleConfigurations as $key => $value) {
$moduleConfigInfo .= '- ' . $key . ': ' . $value . "\n";
}

$psSettingsInfo = "**Prestashop settings:**\n";
foreach ($psSettings as $key => $value) {
$psSettingsInfo .= '- ' . $key . ': ' . $value . "\n";
}

fputcsv($fd, [$moduleConfigInfo], ';', $textDelimiter);
fputcsv($fd, [$psSettingsInfo], ';', $textDelimiter);
fputcsv($fd, [], ';', $textDelimiter);

fputcsv($fd, [
$this->module->l('ID', self::FILE_NAME),
$this->module->l('Severity', self::FILE_NAME),
$this->module->l('Message', self::FILE_NAME),
$this->module->l('Request', self::FILE_NAME),
$this->module->l('Response', self::FILE_NAME),
$this->module->l('Context', self::FILE_NAME),
$this->module->l('Date', self::FILE_NAME),
], ';', $textDelimiter);

$rows = Db::getInstance()->executeS(
'SELECT id_dpd_log, request, response, status, date_add FROM `' . _DB_PREFIX_ . pSQL($this->table) . '` ORDER BY id_dpd_log ASC'
);
if ($rows === false) {
$rows = [];
}

foreach ($rows as $row) {
$message = (string) ($row['response'] ?? '');
$decodedRes = $message !== '' ? json_decode($message, true) : null;
if (json_last_error() === JSON_ERROR_NONE && is_array($decodedRes) && isset($decodedRes['message'])) {
$message = (string) $decodedRes['message'];
}

$endpoint = '';
$decodedReq = isset($row['request']) ? json_decode((string) $row['request'], true) : null;
if (json_last_error() === JSON_ERROR_NONE && is_array($decodedReq) && !empty($decodedReq['endpoint'])) {
$endpoint = basename(strtok((string) $decodedReq['endpoint'], '?'));
}

fputcsv($fd, [
$row['id_dpd_log'],
$row['status'],
$message,
$row['request'],
$row['response'],
$endpoint,
$row['date_add'],
], ';', $textDelimiter);
}

fclose($fd);
exit;
}

public function displayAjaxGetLog()
{
$logId = (int) Tools::getValue('log_id');
$log = new DPDLog($logId);

if (!Validate::isLoadedObject($log)) {
$this->ajaxDie(json_encode([
'error' => true,
'message' => $this->module->l('No log information found.', self::FILE_NAME),
]));
}

$this->ajaxDie(json_encode([
'error' => false,
'log' => [
self::LOG_INFORMATION_TYPE_REQUEST => $log->request,
self::LOG_INFORMATION_TYPE_RESPONSE => $log->response,
],
]));
}

private function initList()
{
$this->list_no_link = true;
$this->_select = 'a.status AS severity, a.response AS message, a.request AS context';

$this->fields_list = [
'id_dpd_log' => [
'title' => $this->module->l('ID'),
'type' => 'text',
'havingFilter' => true
'title' => $this->module->l('ID', self::FILE_NAME),
'align' => 'text-center',
'class' => 'fixed-width-xs',
'havingFilter' => true,
],
'severity' => [
'title' => $this->module->l('Severity (1-4)', self::FILE_NAME),
'align' => 'text-center',
'callback' => 'printSeverity',
'search' => false,
'orderby' => false,
'remove_onclick' => true,
],
'message' => [
'title' => $this->module->l('Message', self::FILE_NAME),
'callback' => 'printMessage',
'search' => false,
'orderby' => false,
'remove_onclick' => true,
],
'request' => [
'title' => $this->module->l('request'),
'type' => 'text',
'havingFilter' => true
'title' => $this->module->l('Request', self::FILE_NAME),
'align' => 'text-center',
'callback' => 'printRequestButton',
'orderby' => false,
'search' => false,
'remove_onclick' => true,
],
'response' => [
'title' => $this->module->l('response'),
'type' => 'text',
'havingFilter' => true
'title' => $this->module->l('Response', self::FILE_NAME),
'align' => 'text-center',
'callback' => 'printResponseButton',
'orderby' => false,
'search' => false,
'remove_onclick' => true,
],
'status' => [
'title' => $this->module->l('status'),
'type' => 'text',
'havingFilter' => true
'context' => [
'title' => $this->module->l('Context', self::FILE_NAME),
'callback' => 'printContext',
'search' => false,
'orderby' => false,
'remove_onclick' => true,
],
'date_add' => [
'title' => $this->module->l('Created date'),
'title' => $this->module->l('Date', self::FILE_NAME),
'align' => 'right',
'type' => 'datetime',
'havingFilter' => true
]
'havingFilter' => true,
],
];
}

private function getDisplayButton($logId, $data, $logInformationType)
{
if (empty($data)) {
return '--';
}

$this->context->smarty->assign([
'log_id' => $logId,
'log_information_type' => $logInformationType,
]);

return $this->context->smarty->fetch(
$this->module->getLocalPath() . 'views/templates/admin/logs/log_modal.tpl'
);
}
}
Loading
Loading