Skip to content
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

Jump to bottom

Missing log datas in some controllers and classes #18519

Merged
merged 10 commits into from May 20, 2020
Merged

Missing log datas in some controllers and classes #18519

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
10c4ad8
Add missing context log data in HookManager class
PululuK Apr 8, 2020
2a5067b
Add missing context log data in ModuleDataProvider class
PululuK Apr 8, 2020
8ec08aa
Add missing context log data in TranslationService class
PululuK Apr 8, 2020
0e28721
Add missing context log data in Productcontroller class
PululuK Apr 8, 2020
cb0e8a0
Add missing context log data in ModuleController class
PululuK Apr 8, 2020
89c9e3b
Fix php-cs-fixer
PululuK Apr 8, 2020
389b7e0
Fix php-cs-fixer
PululuK Apr 8, 2020
aba8cb3
Some fix ...
PululuK Apr 8, 2020
3545dfd
Remove static
PululuK Apr 8, 2020
7dc1f80
Cs fixer
May 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Adapter/HookManager.php
View file
Open in desktop
Expand Up @@ -79,7 +79,7 @@ public function exec(
return Hook::exec($hook_name, $hook_args, $id_module, $array_return, $check_exceptions, $use_push, $id_shop);
} catch (\Exception $e) {
$logger = ServiceLocator::get('\\PrestaShop\\PrestaShop\\Adapter\\LegacyLogger');
$logger->error(sprintf('Exception on hook %s for module %s. %s', $hook_name, $id_module, $e->getMessage()));
$logger->error(sprintf('Exception on hook %s for module %s. %s', $hook_name, $id_module, $e->getMessage()), ['object_type' => 'Module', 'object_id' => $id_module]);
}
}
}
Expand Down
8 changes: 6 additions & 2 deletions src/Adapter/Module/ModuleDataProvider.php
View file
Open in desktop
Expand Up @@ -219,6 +219,10 @@ public function isModuleMainClassValid($name)
}

$parser = (new PhpParser\ParserFactory())->create(PhpParser\ParserFactory::PREFER_PHP7);
$log_context_data = [
'object_type' => 'Module',
'object_id' => LegacyModule::getModuleIdByName($name),
];

try {
$parser->parse(file_get_contents($file_path));
Expand All @@ -231,7 +235,7 @@ public function isModuleMainClassValid($name)
'%parse_error%' => $exception->getMessage(),
],
'Admin.Modules.Notification'
)
), $log_context_data
PululuK marked this conversation as resolved.
Show resolved Hide resolved
);

return false;
Expand All @@ -254,7 +258,7 @@ public function isModuleMainClassValid($name)
'%module%' => $name,
'%error_message%' => $e->getMessage(), ],
'Admin.Modules.Notification'
)
), $log_context_data
PululuK marked this conversation as resolved.
Show resolved Hide resolved
);

return false;
Expand Down
6 changes: 5 additions & 1 deletion src/PrestaShopBundle/Controller/Admin/Improve/ModuleController.php
View file
Open in desktop
Expand Up @@ -375,6 +375,10 @@ public function moduleAction(Request $request)
$moduleManager->setActionParams($request->request->get('actionParams', []));
$moduleRepository = $this->container->get('prestashop.core.admin.module.repository');
$modulesProvider = $this->container->get('prestashop.core.admin.data_provider.module_interface');
// Get accessed module object
$moduleAccessed = $moduleRepository->getModule($module);
// Get accessed module DB Id
$moduleAccessedId = (int) $moduleAccessed->database->get('id');
$response = [$module => []];

if (!method_exists($moduleManager, $action)) {
Expand Down Expand Up @@ -465,7 +469,7 @@ public function moduleAction(Request $request)
);

$logger = $this->container->get('logger');
$logger->error($response[$module]['msg']);
$logger->error($response[$module]['msg'], ['object_type' => 'Module', 'object_id' => $moduleAccessedId]);
}

if ($response[$module]['status'] === true && $action != 'uninstall') {
Expand Down
43 changes: 28 additions & 15 deletions src/PrestaShopBundle/Controller/Admin/ProductController.php
View file
Open in desktop
Expand Up @@ -768,7 +768,7 @@ public function bulkAction(Request $request, $action)
);
}

$logger->info('Products activated: (' . implode(',', $productIdList) . ').');
$logger->info('Products activated: (' . implode(',', $productIdList) . ').', $this->getLogDataContext());
$hookDispatcher->dispatchWithParameters(
'actionAdminActivateAfter',
$hookEventParameters
Expand Down Expand Up @@ -797,7 +797,7 @@ public function bulkAction(Request $request, $action)
);
}

$logger->info('Products deactivated: (' . implode(',', $productIdList) . ').');
$logger->info('Products deactivated: (' . implode(',', $productIdList) . ').', $this->getLogDataContext());
$hookDispatcher->dispatchWithParameters(
'actionAdminDeactivateAfter',
$hookEventParameters
Expand Down Expand Up @@ -826,7 +826,7 @@ public function bulkAction(Request $request, $action)
);
}

$logger->info('Products deleted: (' . implode(',', $productIdList) . ').');
$logger->info('Products deleted: (' . implode(',', $productIdList) . ').', $this->getLogDataContext());
$hookDispatcher->dispatchWithParameters(
'actionAdminDeleteAfter',
$hookEventParameters
Expand Down Expand Up @@ -855,7 +855,7 @@ public function bulkAction(Request $request, $action)
);
}

$logger->info('Products duplicated: (' . implode(',', $productIdList) . ').');
$logger->info('Products duplicated: (' . implode(',', $productIdList) . ').', $this->getLogDataContext());
$hookDispatcher->dispatchWithParameters(
'actionAdminDuplicateAfter',
$hookEventParameters
Expand All @@ -871,15 +871,15 @@ public function bulkAction(Request $request, $action)
* should never happens since the route parameters are
* restricted to a set of action values in YML file.
*/
$logger->error('Bulk action from ProductController received a bad parameter.');
$logger->error('Bulk action from ProductController received a bad parameter.', $this->getLogDataContext());

throw new Exception('Bad action received from call to ProductController::bulkAction: "' . $action . '"', 2001);
}
} catch (UpdateProductException $due) {
//TODO : need to translate this with an domain name
$message = $due->getMessage();
$this->addFlash('failure', $message);
$logger->warning($message);
$logger->warning($message, $this->getLogDataContext());
}

return new Response(json_encode(['result' => 'ok']));
Expand Down Expand Up @@ -959,7 +959,7 @@ public function massEditAction(Request $request, $action)
);
$logger->info(
'Products sorted: (' . implode(',', $productIdList) .
') with positions (' . implode(',', $productPositionList) . ').'
') with positions (' . implode(',', $productPositionList) . ').', $this->getLogDataContext()
);
$hookEventParameters = [
'product_list_id' => $productIdList,
Expand All @@ -980,15 +980,15 @@ public function massEditAction(Request $request, $action)
* should never happens since the route parameters are
* restricted to a set of action values in YML file.
*/
$logger->error('Mass edit action from ProductController received a bad parameter.');
$logger->error('Mass edit action from ProductController received a bad parameter.', $this->getLogDataContext());

throw new Exception('Bad action received from call to ProductController::massEditAction: "' . $action . '"', 2001);
}
} catch (UpdateProductException $due) {
//TODO : need to translate with domain name
$message = $due->getMessage();
$this->addFlash('failure', $message);
$logger->warning($message);
$logger->warning($message, $this->getLogDataContext());
}

$urlGenerator = $this->get('prestashop.core.admin.url_generator');
Expand Down Expand Up @@ -1045,7 +1045,7 @@ public function unitAction($action, $id)
'success',
$this->trans('Product successfully deleted.', 'Admin.Catalog.Notification')
);
$logger->info('Product deleted: (' . $id . ').');
$logger->info('Product deleted: (' . $id . ').', $this->getLogDataContext($id));
$hookDispatcher->dispatchWithParameters(
'actionAdminDeleteAfter',
$hookEventParameters
Expand All @@ -1071,7 +1071,7 @@ public function unitAction($action, $id)
'success',
$this->trans('Product successfully duplicated.', 'Admin.Catalog.Notification')
);
$logger->info('Product duplicated: (from ' . $id . ' to ' . $duplicateProductId . ').');
$logger->info('Product duplicated: (from ' . $id . ' to ' . $duplicateProductId . ').', $this->getLogDataContext($id));
$hookDispatcher->dispatchWithParameters(
'actionAdminDuplicateAfter',
$hookEventParameters
Expand All @@ -1097,7 +1097,7 @@ public function unitAction($action, $id)
'success',
$this->trans('Product successfully activated.', 'Admin.Catalog.Notification')
);
$logger->info('Product activated: ' . $id);
$logger->info('Product activated: ' . $id, $this->getLogDataContext($id));
$hookDispatcher->dispatchWithParameters(
'actionAdminActivateAfter',
$hookEventParameters
Expand All @@ -1123,7 +1123,7 @@ public function unitAction($action, $id)
'success',
$this->trans('Product successfully deactivated.', 'Admin.Catalog.Notification')
);
$logger->info('Product deactivated: ' . $id);
$logger->info('Product deactivated: ' . $id, $this->getLogDataContext($id));
$hookDispatcher->dispatchWithParameters(
'actionAdminDeactivateAfter',
$hookEventParameters
Expand All @@ -1139,15 +1139,15 @@ public function unitAction($action, $id)
* should never happens since the route parameters are
* restricted to a set of action values in YML file.
*/
$logger->error('Unit action from ProductController received a bad parameter.');
$logger->error('Unit action from ProductController received a bad parameter.', $this->getLogDataContext($id));

throw new Exception('Bad action received from call to ProductController::unitAction: "' . $action . '"', 2002);
}
} catch (UpdateProductException $due) {
//TODO : need to translate with a domain name
$message = $due->getMessage();
$this->addFlash('failure', $message);
$logger->warning($message);
$logger->warning($message, $this->getLogDataContext($id));
}

return $this->redirect($this->get('prestashop.core.admin.url_generator')->generate('admin_product_catalog'));
Expand Down Expand Up @@ -1336,4 +1336,17 @@ private function getErrorMessages(): array
CannotUpdateProductException::class => $this->trans('An error occurred while updating the status for an object.', 'Admin.Notifications.Error'),
];
}

/**
* @return array
*/
private function getLogDataContext($id_product = null, $error_code = null, $allow_duplicate = null): array
{
return [
'object_type' => 'Product',
'object_id' => $id_product,
'error_code' => $error_code,
'allow_duplicate' => $allow_duplicate,
];
}
}
5 changes: 3 additions & 2 deletions src/PrestaShopBundle/Service/TranslationService.php
View file
Open in desktop
Expand Up @@ -288,9 +288,10 @@ public function saveTranslationMessage($lang, $domain, $key, $translationValue,

$validator = Validation::createValidator();
$violations = $validator->validate($translation, new PassVsprintf());
$log_context = ['object_type' => 'Translation'];
if (0 !== count($violations)) {
foreach ($violations as $violation) {
$logger->error($violation->getMessage());
$logger->error($violation->getMessage(), $log_context);
}

return false;
Expand All @@ -304,7 +305,7 @@ public function saveTranslationMessage($lang, $domain, $key, $translationValue,

$updatedTranslationSuccessfully = true;
} catch (Exception $exception) {
$logger->error($exception->getMessage());
$logger->error($exception->getMessage(), $log_context);
}

return $updatedTranslationSuccessfully;
Expand Down