mirror of
https://github.com/OrcaSlicer/OrcaSlicer.git
synced 2026-10-04 14:20:58 +00:00
HanifKoh
e40030cf81
* Stop Malformed Network Responses from Crashing the App Duet, MKS and UltiMaker parsed print host replies with boost read_json inside the HTTP completion callback with no try, so an HTML or truncated reply threw out of the Physical Printer Test button and terminated the app, or killed the upload queue thread. The five identical copies of the parser (ESP3D's and Flashforge's were unused) are replaced by one shared PrintHost::get_err_code_from_body that reports a non-JSON reply as an error. The upload queue now catches a failing job per job, so one bad upload no longer leaves later jobs queued forever. Flashforge read material station slots with nlohmann value(), which throws on off-type fields or non-object entries. The parsing moves into Flashforge::parse_material_slots, which reads fields leniently with the existing try_parse_json_int and skips bad entries. UserManager::parse_json parsed the payload before its try block; the parse now happens inside it. * Keep UploadFinished Paired with UploadStarted When an Upload Throws The exception from a throwing upload was caught around perform_job, so the UploadFinished lifecycle event was skipped and plugins saw an upload start that never finished. The catch now sits around the upload call. The error is reported through the job's error callback and UploadFinished is fired with an error code, as for any other failed upload. The worker keeps running for the next job. The started, upload and finished sequence moved to PrintHostJobQueue::upload_job so it can be tested without the dialog.
375 lines
16 KiB
C++
375 lines
16 KiB
C++
#include <catch2/catch_all.hpp>
|
|
|
|
#include <memory>
|
|
#include <stdexcept>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include <nlohmann/json.hpp>
|
|
|
|
#include "libslic3r/LifecycleEvents.hpp"
|
|
#include "slic3r/Utils/PrintHost.hpp"
|
|
#include "slic3r/Utils/Flashforge.hpp"
|
|
|
|
using namespace Slic3r;
|
|
|
|
namespace {
|
|
|
|
class TestPrintHost : public PrintHost
|
|
{
|
|
public:
|
|
using PrintHost::format_error;
|
|
|
|
const char* get_name() const override { return "Test"; }
|
|
bool test(wxString&) const override { return true; }
|
|
wxString get_test_ok_msg() const override { return {}; }
|
|
wxString get_test_failed_msg(wxString&) const override { return {}; }
|
|
bool upload(PrintHostUpload, ProgressFn, ErrorFn, InfoFn) const override { return true; }
|
|
bool has_auto_discovery() const override { return false; }
|
|
bool can_test() const override { return false; }
|
|
PrintHostPostUploadActions get_post_upload_actions() const override { return {}; }
|
|
std::string get_host() const override { return {}; }
|
|
};
|
|
|
|
class ThrowingPrintHost : public TestPrintHost
|
|
{
|
|
public:
|
|
bool upload(PrintHostUpload, ProgressFn, ErrorFn, InfoFn) const override { throw std::runtime_error("reply could not be read"); }
|
|
};
|
|
|
|
struct UploadEvents
|
|
{
|
|
std::vector<LifecycleEvent> events;
|
|
std::vector<LifecycleEvtCode> codes;
|
|
std::vector<std::string> errors;
|
|
bool uploaded{false};
|
|
|
|
explicit UploadEvents(std::unique_ptr<PrintHost> host)
|
|
{
|
|
set_lifecycle_hook_fn([this](LifecycleEvent event, const LifecycleEventContext& ctx) {
|
|
events.push_back(event);
|
|
codes.push_back(ctx.code);
|
|
});
|
|
|
|
PrintHostJob job;
|
|
job.printhost = std::move(host);
|
|
job.upload_data.source_path = "plate.gcode";
|
|
try {
|
|
uploaded = PrintHostJobQueue::upload_job(job, [](Http::Progress, bool&) {},
|
|
[this](wxString error) { errors.push_back(error.ToStdString()); },
|
|
[](wxString, wxString) {});
|
|
} catch (...) {
|
|
set_lifecycle_hook_fn(nullptr);
|
|
throw;
|
|
}
|
|
set_lifecycle_hook_fn(nullptr);
|
|
}
|
|
};
|
|
|
|
std::string format_error(const std::string& body, const std::string& error, unsigned status)
|
|
{
|
|
return TestPrintHost().format_error(body, error, status).ToStdString();
|
|
}
|
|
|
|
std::string envelope(int code, const std::string& message, const std::string& traceback)
|
|
{
|
|
return nlohmann::json{{"error", {{"code", code}, {"message", message}, {"traceback", traceback}}}}.dump();
|
|
}
|
|
|
|
std::string moonraker_error(int code, const std::string& message, const std::string& detail = {})
|
|
{
|
|
std::string line = "tornado.web.HTTPError: HTTP " + std::to_string(code) + ": " + message;
|
|
if (!detail.empty())
|
|
line += " (" + detail + ")";
|
|
return envelope(code, message, "Traceback (most recent call last):\n ...\n" + line + "\n");
|
|
}
|
|
|
|
// A real Moonraker body for uploading a file that is being printed.
|
|
constexpr const char* k_busy_file_403 =
|
|
R"JSON({"error": {"code": 403, "message": "Forbidden", "traceback": "Traceback (most recent call last):\n\n File \"/home/lava/moonraker/moonraker/components/file_manager/file_manager.py\", line 1017, in _finish_gcode_upload\n can_start = self._handle_operation_check(check_path)\n ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nmoonraker.utils.exceptions.ServerError: File currently in use\n\nDuring handling of the above exception, another exception occurred:\n\nTraceback (most recent call last):\n\n File \"/home/lava/moonraker/moonraker/components/application.py\", line 1069, in post\n raise tornado.web.HTTPError(\ntornado.web.HTTPError: HTTP 403: Forbidden (File is loaded, upload not permitted)\n"}})JSON";
|
|
|
|
// Replies a print host can send instead of JSON: a proxy or login page, nothing, a cut-off body.
|
|
const std::vector<std::string> non_json_replies = {
|
|
"<html><body>proxy login required</body></html>",
|
|
"",
|
|
"{\"err\":",
|
|
"{\"detail\":{\"matlStationInfo\":{\"slotInfos\":[{\"slotId\":1,",
|
|
};
|
|
|
|
} // namespace
|
|
|
|
TEST_CASE("A Klipper upload error shows its reason instead of a Python traceback", "[PrintHost][Regression]")
|
|
{
|
|
const std::string msg = format_error(k_busy_file_403, "", 403);
|
|
INFO("actual: " << msg);
|
|
|
|
CHECK(msg == "HTTP 403: Forbidden (File is loaded, upload not permitted)");
|
|
CHECK_THAT(msg, !Catch::Matchers::ContainsSubstring("Traceback"));
|
|
CHECK_THAT(msg, !Catch::Matchers::ContainsSubstring("file_manager.py"));
|
|
}
|
|
|
|
TEST_CASE("The specific cause is recovered from a file endpoint's traceback", "[PrintHost]")
|
|
{
|
|
SECTION("a plain detail")
|
|
{
|
|
const std::string body = moonraker_error(403, "Forbidden", "File is loaded, upload not permitted");
|
|
CHECK(format_error(body, "", 403) == "HTTP 403: Forbidden (File is loaded, upload not permitted)");
|
|
}
|
|
|
|
SECTION("a detail whose own parentheses nest (a filename)")
|
|
{
|
|
const std::string detail = "Directory does not exist (/home/pi/gcodes/plate (1).gcode)";
|
|
const std::string body = moonraker_error(400, "Bad Request", detail);
|
|
CHECK(format_error(body, "", 400) == "HTTP 400: Bad Request (" + detail + ")");
|
|
}
|
|
|
|
SECTION("a detail that contains the reason phrase")
|
|
{
|
|
const std::string body = moonraker_error(403, "Forbidden", "Forbidden zone: access denied");
|
|
CHECK(format_error(body, "", 403) == "HTTP 403: Forbidden (Forbidden zone: access denied)");
|
|
}
|
|
|
|
SECTION("a detail that spans lines")
|
|
{
|
|
const std::string detail = "Move out of range\nX=250.000 Y=10.000";
|
|
const std::string body = moonraker_error(400, "Bad Request", detail);
|
|
CHECK(format_error(body, "", 400) == "HTTP 400: Bad Request (" + detail + ")");
|
|
}
|
|
|
|
SECTION("a detail that only repeats the reason phrase is dropped")
|
|
{
|
|
const std::string body = moonraker_error(401, "Unauthorized", "Unauthorized");
|
|
CHECK(format_error(body, "", 401) == "HTTP 401: Unauthorized");
|
|
}
|
|
}
|
|
|
|
TEST_CASE("An unhandled exception shows its type and message", "[PrintHost]")
|
|
{
|
|
const std::string frame = "Traceback (most recent call last):\n"
|
|
" File \"/home/pi/moonraker/moonraker/components/file_manager/file_manager.py\", line 1, in write\n"
|
|
" self._write(data)\n";
|
|
|
|
SECTION("a one-line message")
|
|
{
|
|
const std::string body = envelope(500, "Internal Server Error", frame + "OSError: [Errno 28] No space left on device\n");
|
|
CHECK(format_error(body, "", 500) == "HTTP 500: Internal Server Error (OSError: [Errno 28] No space left on device)");
|
|
}
|
|
|
|
SECTION("a message that spans lines")
|
|
{
|
|
const std::string body = envelope(500, "Internal Server Error", frame + "ServerError: Klippy request failed\n see klippy.log\n");
|
|
CHECK(format_error(body, "", 500) == "HTTP 500: Internal Server Error (ServerError: Klippy request failed\n see klippy.log)");
|
|
}
|
|
|
|
SECTION("raised while handling an HTTPError with the same code")
|
|
{
|
|
const std::string traceback = frame + "tornado.web.HTTPError: HTTP 500: Internal Server Error (Database locked)\n\n"
|
|
"During handling of the above exception, another exception occurred:\n\n" +
|
|
frame + "OSError: [Errno 5] Input/output error\n";
|
|
const std::string body = envelope(500, "Internal Server Error", traceback);
|
|
CHECK(format_error(body, "", 500) == "HTTP 500: Internal Server Error (OSError: [Errno 5] Input/output error)");
|
|
}
|
|
|
|
SECTION("a traceback with no header")
|
|
{
|
|
const std::string body = envelope(500, "Internal Server Error", "OSError: [Errno 5] Input/output error");
|
|
CHECK(format_error(body, "", 500) == "HTTP 500: Internal Server Error (OSError: [Errno 5] Input/output error)");
|
|
}
|
|
}
|
|
|
|
TEST_CASE("A reason already complete in message is shown unchanged", "[PrintHost]")
|
|
{
|
|
SECTION("message is the whole reason, no trailing detail")
|
|
{
|
|
const std::string body = moonraker_error(503, "Klippy is not ready");
|
|
CHECK(format_error(body, "", 503) == "HTTP 503: Klippy is not ready");
|
|
}
|
|
|
|
SECTION("a message that itself contains parentheses is not duplicated")
|
|
{
|
|
const std::string reason = "Requested blocks (0-5) are unavailable";
|
|
const std::string body = moonraker_error(400, reason);
|
|
CHECK(format_error(body, "", 400) == "HTTP 400: " + reason);
|
|
}
|
|
}
|
|
|
|
TEST_CASE("A Moonraker error with no usable detail shows just the reason phrase", "[PrintHost]")
|
|
{
|
|
struct Case
|
|
{
|
|
const char* name;
|
|
const char* body;
|
|
unsigned status;
|
|
const char* expected;
|
|
};
|
|
|
|
const auto c = GENERATE(
|
|
Case{"an empty traceback", R"JSON({"error": {"code": 500, "message": "Internal Server Error", "traceback": ""}})JSON", 500,
|
|
"HTTP 500: Internal Server Error"},
|
|
Case{"a traceback of only whitespace", R"JSON({"error": {"code": 500, "message": "Internal Server Error", "traceback": "\n \n"}})JSON",
|
|
500, "HTTP 500: Internal Server Error"});
|
|
|
|
DYNAMIC_SECTION(c.name) { CHECK(format_error(c.body, "", c.status) == c.expected); }
|
|
}
|
|
|
|
TEST_CASE("A percent sign in the reason is not a format specifier", "[PrintHost]")
|
|
{
|
|
const std::string body = moonraker_error(507, "Insufficient Storage", "disk 100% full");
|
|
CHECK(format_error(body, "", 507) == "HTTP 507: Insufficient Storage (disk 100% full)");
|
|
}
|
|
|
|
TEST_CASE("Error bodies that are not a Moonraker envelope are left unchanged", "[PrintHost]")
|
|
{
|
|
SECTION("OctoPrint's string-valued error member")
|
|
{
|
|
const std::string body = R"JSON({"error": "File not found"})JSON";
|
|
CHECK(format_error(body, "", 404) == "HTTP 404: " + body);
|
|
}
|
|
|
|
SECTION("PrusaLink's top-level message, not under error")
|
|
{
|
|
const std::string body = R"JSON({"title": "Conflict", "message": "Printer is printing"})JSON";
|
|
CHECK(format_error(body, "", 409) == "HTTP 409: " + body);
|
|
}
|
|
|
|
SECTION("a body that is not JSON")
|
|
{
|
|
const std::string html = "<html><head><title>502 Bad Gateway</title></head></html>";
|
|
CHECK(format_error(html, "", 502) == "HTTP 502: " + html);
|
|
}
|
|
|
|
SECTION("an error object with no traceback")
|
|
{
|
|
const std::string body = R"JSON({"error": {"code": 500, "message": "Internal Server Error"}})JSON";
|
|
CHECK(format_error(body, "", 500) == "HTTP 500: " + body);
|
|
}
|
|
|
|
SECTION("an error object whose traceback is null")
|
|
{
|
|
const std::string body = R"JSON({"error": {"code": 500, "message": "Internal Server Error", "traceback": null}})JSON";
|
|
CHECK(format_error(body, "", 500) == "HTTP 500: " + body);
|
|
}
|
|
|
|
SECTION("an envelope whose reason phrase is empty")
|
|
{
|
|
const std::string body = envelope(403, "", "Traceback (most recent call last):\nOSError: denied\n");
|
|
CHECK(format_error(body, "", 403) == "HTTP 403: " + body);
|
|
}
|
|
|
|
SECTION("a transport error with no HTTP status")
|
|
{
|
|
CHECK(format_error("", "curl:Could not connect", 0) == "curl:Could not connect");
|
|
}
|
|
}
|
|
|
|
TEST_CASE("Print host error code is read from a JSON reply", "[PrintHost]")
|
|
{
|
|
CHECK(PrintHost::get_err_code_from_body(R"({"err":0})") == 0);
|
|
CHECK(PrintHost::get_err_code_from_body(R"({"err":2})") == 2);
|
|
CHECK(PrintHost::get_err_code_from_body(R"({"status":"ok"})") == 0);
|
|
}
|
|
|
|
TEST_CASE("Print host error code reports a reply that is not JSON as an error", "[PrintHost]")
|
|
{
|
|
const std::string body = GENERATE(from_range(non_json_replies));
|
|
int err = 0;
|
|
REQUIRE_NOTHROW(err = PrintHost::get_err_code_from_body(body));
|
|
CHECK(err != 0);
|
|
}
|
|
|
|
TEST_CASE("Print host error code tolerates a wrongly typed err field", "[PrintHost]")
|
|
{
|
|
const std::string body = GENERATE(as<std::string>{}, R"({"err":"busy"})", R"({"err":{"code":1}})", R"([1,2])");
|
|
CHECK_NOTHROW(PrintHost::get_err_code_from_body(body));
|
|
}
|
|
|
|
TEST_CASE("Flashforge material slots are read from a well-formed reply", "[PrintHost][Flashforge]")
|
|
{
|
|
const std::string body = R"({"code":0,"detail":{"hasMatlStation":true,"matlStationInfo":{"slotCnt":2,"slotInfos":[
|
|
{"slotId":1,"hasFilament":true,"materialName":"PLA","materialColor":"#FFFFFF"},
|
|
{"slotId":2,"hasFilament":false,"materialName":"","materialColor":""}]}}})";
|
|
|
|
std::vector<FlashforgeMaterialSlot> slots;
|
|
bool supports_station = false;
|
|
REQUIRE(Flashforge::parse_material_slots(body, slots, &supports_station));
|
|
CHECK(supports_station);
|
|
REQUIRE(slots.size() == 2);
|
|
CHECK(slots[0].slot_id == 1);
|
|
CHECK(slots[0].has_filament);
|
|
CHECK(slots[0].material_name == "PLA");
|
|
CHECK(slots[0].material_color == "#FFFFFF");
|
|
CHECK(slots[1].slot_id == 2);
|
|
CHECK_FALSE(slots[1].has_filament);
|
|
}
|
|
|
|
TEST_CASE("Flashforge material slots accept numbers as strings and flags as numbers", "[PrintHost][Flashforge]")
|
|
{
|
|
const std::string body = R"({"detail":{"matlStationInfo":{"slotInfos":[
|
|
{"slotId":"3","hasFilament":1,"materialName":null,"materialColor":7}]}}})";
|
|
|
|
std::vector<FlashforgeMaterialSlot> slots;
|
|
REQUIRE_NOTHROW(Flashforge::parse_material_slots(body, slots, nullptr));
|
|
REQUIRE(slots.size() == 1);
|
|
CHECK(slots[0].slot_id == 3);
|
|
CHECK(slots[0].has_filament);
|
|
CHECK(slots[0].material_name.empty());
|
|
CHECK(slots[0].material_color.empty());
|
|
}
|
|
|
|
TEST_CASE("Flashforge material slots skip entries that are not objects", "[PrintHost][Flashforge]")
|
|
{
|
|
const std::string body = R"({"detail":{"matlStationInfo":{"slotInfos":[5,"slot",null,[],
|
|
{"slotId":4,"hasFilament":true,"materialName":"PETG"}]}}})";
|
|
|
|
std::vector<FlashforgeMaterialSlot> slots;
|
|
REQUIRE_NOTHROW(Flashforge::parse_material_slots(body, slots, nullptr));
|
|
REQUIRE(slots.size() == 1);
|
|
CHECK(slots[0].slot_id == 4);
|
|
CHECK(slots[0].material_name == "PETG");
|
|
}
|
|
|
|
TEST_CASE("Flashforge material slots tolerate slot info that is not a list", "[PrintHost][Flashforge]")
|
|
{
|
|
const std::string body = GENERATE(as<std::string>{},
|
|
R"({"detail":{"matlStationInfo":{"slotInfos":5}}})",
|
|
R"({"detail":{"matlStationInfo":{"slotInfos":"none"}}})",
|
|
R"({"detail":{"matlStationInfo":7}})",
|
|
R"({"detail":"offline"})");
|
|
|
|
std::vector<FlashforgeMaterialSlot> slots;
|
|
bool ok = false;
|
|
REQUIRE_NOTHROW(ok = Flashforge::parse_material_slots(body, slots, nullptr));
|
|
CHECK(ok);
|
|
CHECK(slots.empty());
|
|
}
|
|
|
|
TEST_CASE("Flashforge material slots reject a reply that is not JSON", "[PrintHost][Flashforge]")
|
|
{
|
|
const std::string body = GENERATE(from_range(non_json_replies));
|
|
std::vector<FlashforgeMaterialSlot> slots;
|
|
bool ok = true;
|
|
REQUIRE_NOTHROW(ok = Flashforge::parse_material_slots(body, slots, nullptr));
|
|
CHECK_FALSE(ok);
|
|
CHECK(slots.empty());
|
|
}
|
|
|
|
TEST_CASE("An upload that throws still finishes with an error", "[PrintHost][LifecycleEvents]")
|
|
{
|
|
UploadEvents run(std::make_unique<ThrowingPrintHost>());
|
|
|
|
CHECK_FALSE(run.uploaded);
|
|
CHECK(run.errors == std::vector<std::string>{"reply could not be read"});
|
|
CHECK(run.events == std::vector<LifecycleEvent>{LifecycleEvent::UploadStarted, LifecycleEvent::UploadFinished});
|
|
CHECK(run.codes == std::vector<LifecycleEvtCode>{LifecycleEvtCode::Ok, LifecycleEvtCode::Error});
|
|
}
|
|
|
|
TEST_CASE("A successful upload finishes without an error", "[PrintHost][LifecycleEvents]")
|
|
{
|
|
UploadEvents run(std::make_unique<TestPrintHost>());
|
|
|
|
CHECK(run.uploaded);
|
|
CHECK(run.errors.empty());
|
|
CHECK(run.events == std::vector<LifecycleEvent>{LifecycleEvent::UploadStarted, LifecycleEvent::UploadFinished});
|
|
CHECK(run.codes == std::vector<LifecycleEvtCode>{LifecycleEvtCode::Ok, LifecycleEvtCode::Ok});
|
|
}
|