Skip to content

fix: improve error handling during package updates #633 #643

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
jaredhendrickson13 merged 5 commits into from
Jan 19, 2025
Merged

fix: improve error handling during package updates #633 #643

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e2bd4af
style: run prettier on changed files
jaredhendrickson13 Jan 11, 2025
21188aa
docs: add info about unavailability during updates #633
jaredhendrickson13 Jan 11, 2025
c181ed6
fix: give friendlier error messages during updates #633
jaredhendrickson13 Jan 11, 2025
eac2c03
fix: correctly set http response code for 503s during updates
jaredhendrickson13 Jan 11, 2025
abf5d1a
Merge branch 'master' into next_patch
jaredhendrickson13 Jan 19, 2025
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
290 changes: 140 additions & 150 deletions composer.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 12 additions & 1 deletion pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Core/Endpoint.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1199,9 +1199,20 @@ class Endpoint {
$nq_class_name = $this->get_class_shortname();

# Specify the PHP code to write to the Endpoints index.php file
$unavailable_error = new ServiceUnavailableError(
message: 'This resource is either not installed or is currently updating. Please try again later.',
response_id: 'ENDPOINT_UNAVAILABLE',
);
$unavailable_error_json = json_encode($unavailable_error->to_representation());
$code =
"<?php\n" .
"require_once('RESTAPI/Endpoints/$nq_class_name.inc');\n" .
"\$include = include('RESTAPI/Endpoints/$nq_class_name.inc');\n" .
"if (!\$include) {\n" .
" header('Content-Type: application/json');\n" .
" http_response_code(503);\n" .
" echo '$unavailable_error_json';\n" .
" exit(503);\n" .
"}\n" .
"echo (new $fq_class_name())->process_request();\n" .
"header('Referer: no-referrer');\n" .
"session_destroy();\n" .
Expand Down
19 changes: 10 additions & 9 deletions pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Core/Form.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -529,14 +529,16 @@ class Form {

# Specify the PHP code to write to the Endpoints index.php file
$code =
"<?php
require_once('RESTAPI/Forms/" .
$nq_class_name .
".inc');
require_once('guiconfig.inc');
(new " .
$fq_class_name .
'())->print_form();';
"<?php\n" .
"require_once('guiconfig.inc');\n" .
"\$include = include('RESTAPI/Forms/$nq_class_name.inc');\n" .
"if (!\$include) {\n" .
" http_response_code(503);\n" .
" echo '<h1>Service Unavailable</h1>';\n" .
" echo 'This resource is either not installed or is currently updating. Please try again later.';\n" .
" exit();\n" .
"}\n" .
"(new $fq_class_name())->print_form();\n";

# Assign the absolute path to the file. Assume index.php filename if not specified.
$filename = "/usr/local/www/$this->url";
Expand All @@ -548,7 +550,6 @@ class Form {
if (is_file($filename)) {
return true;
}

return false;
}
}
6 changes: 4 additions & 2 deletions pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Forms/SystemRESTAPIUpdatesForm.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,10 @@ class SystemRESTAPIUpdatesForm extends Form {

public function on_save(string $success_banner_msg = ''): void {
parent::on_save(
success_banner_msg: 'The requested version is being installed in the background. Check this page again ' .
'later to see the status.',
success_banner_msg: 'The requested version is being installed in the background. During the update, the ' .
"REST API may be intermittently unavailable. Attempts to access the REST API's endpoints and web " .
'pages during the update may result in errors until it completes. Check this page again later to see ' .
'the status.',
);
}
}
Loading