Skip to content

Harden queue provider error messages #306

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

Open
jynbil1 wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Harden queue provider error messages #306

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
29 changes: 17 additions & 12 deletions common/models/Queue.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,41 +120,46 @@ public function beforeSave($insert) {

$this->queue_response = json_encode($createNewSiteResponse);

$message = 'Unable to create the site right now. Please try again later.';
Yii::error('[Netlify > While Creating new site]' . json_encode($createNewSiteResponse->data), __METHOD__);

if (isset(Yii::$app->session->id)) {
Yii::$app->session->setFlash('error', '[Netlify > While Creating new site]' . json_encode($createNewSiteResponse->data));
Yii::$app->session->setFlash('error', $message);
}

$this->addError('restaurant_uuid', '[Netlify > While Creating new site]' . json_encode($createNewSiteResponse->data));

//Yii::error('[Netlify > While Creating new site]' . json_encode($createNewSiteResponse->data), __METHOD__);
$this->addError('restaurant_uuid', $message);

return false;
}

} else{
$this->queue_response = json_encode($createBranchResponse);

$message = 'Unable to prepare the site repository right now. Please try again later.';
$createBranchMessage = isset($createBranchResponse->data['message']) ? $createBranchResponse->data['message'] : null;
Yii::error('[Github > Create branch]' . json_encode($createBranchMessage) . ' RestaurantUuid: '. $store_model->restaurant_uuid. ' Named: '. $store_model->name, __METHOD__);

if (isset(Yii::$app->session->id)) {
Yii::$app->session->setFlash('error', '[Github > Create branch]' . json_encode($createBranchResponse->data['message']) . ' RestaurantUuid: ' . $store_model->restaurant_uuid);
Yii::$app->session->setFlash('error', $message);
}

$this->addError('restaurant_uuid', '[Github > Create branch]' . json_encode($createBranchResponse->data['message']) . ' RestaurantUuid: '. $store_model->restaurant_uuid. ' Named: '. $store_model->name);

//Yii::error('[Github > Create branch]' . json_encode($createBranchResponse->data['message']) . ' RestaurantUuid: '. $store_model->restaurant_uuid. ' Named: '. $store_model->name, __METHOD__);
$this->addError('restaurant_uuid', $message);

return false;
}

} else {
$this->queue_response = json_encode($getLastCommitResponse);

$message = 'Unable to prepare the site repository right now. Please try again later.';
$lastCommitMessage = isset($getLastCommitResponse->data['message']) ? $getLastCommitResponse->data['message'] : null;
Yii::error('[Github > Last commit]' . json_encode($lastCommitMessage) . ' RestaurantUuid: '. $store_model->restaurant_uuid. ' Named: '. $store_model->name, __METHOD__);

if (isset(Yii::$app->session->id)) {
Yii::$app->session->setFlash('error', '[Github > Last commit]' . json_encode($getLastCommitResponse->data['message']) . ' RestaurantUuid: ' . $store_model->restaurant_uuid);
Yii::$app->session->setFlash('error', $message);
}

$this->addError('restaurant_uuid', '[Github > Last commit]' . json_encode($getLastCommitResponse->data['message']) . ' RestaurantUuid: '. $store_model->restaurant_uuid. ' Named: '. $store_model->name);

Yii::error('[Github > Last commit]' . json_encode($getLastCommitResponse->data['message']) . ' RestaurantUuid: '. $store_model->restaurant_uuid. ' Named: '. $store_model->name, __METHOD__);
$this->addError('restaurant_uuid', $message);

return false;
}
Expand Down
22 changes: 22 additions & 0 deletions tests/check-queue-provider-error-messages.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
#!/usr/bin/env bash
set -euo pipefail

target="common/models/Queue.php"

grep -q "Unable to create the site right now. Please try again later." "$target"
grep -q "Unable to prepare the site repository right now. Please try again later." "$target"
grep -q "Yii::error('\\[Netlify > While Creating new site\\]'" "$target"
grep -q "Yii::error('\\[Github > Create branch\\]'" "$target"
grep -q "Yii::error('\\[Github > Last commit\\]'" "$target"

if grep -nE "setFlash\\('error'.*(Response->data|RestaurantUuid|Named:)" "$target"; then
echo "queue provider flash still exposes raw provider details" >&2
exit 1
fi

if grep -nE "addError\\('restaurant_uuid'.*(Response->data|RestaurantUuid|Named:)" "$target"; then
echo "queue provider model error still exposes raw provider details" >&2
exit 1
fi

echo "Queue provider error message guard passed."