mqtt::lib::admin Namespace Reference

Classes
struct	AdminOptions
struct	ReloadResult

Typedefs
using	ReloadCallback = std::function<ReloadResult(bool)>

Functions
express::Router	makeMappingAdminRouter (ConfigApplication *configApplication, const AdminOptions &opt, ReloadCallback onDeploy)

Typedef Documentation

ReloadCallback

using mqtt::lib::admin::ReloadCallback = std::function<ReloadResult(bool)>

Definition at line 75 of file MappingAdminRouter.h.

Function Documentation

makeMappingAdminRouter()

express::Router mqtt::lib::admin::makeMappingAdminRouter	(	ConfigApplication *	configApplication,
		const AdminOptions &	opt,
		ReloadCallback	onDeploy = {} )

Definition at line 67 of file MappingAdminRouter.cpp.

                                                                                                                                 {
        express::Router api;
 
        api.use(express::middleware::JsonMiddleware());
        api.use(express::middleware::BasicAuthentication(opt.user, opt.pass, opt.realm));
 
        // GET /schema
        api.get("/schema", [] APPLICATION(req, res) {
            res->status(200).send(MqttMapper::getSchema());
        });
 
        // GET /config
        api.get("/config", [configApplication] APPLICATION(req, res) {
            try {
                res->status(200).json(configApplication->getMqttMapper()->getMapping());
            } catch (const std::exception& e) {
                res->status(500).json({{"error", "Failed to load configuration"}, {"details", e.what()}});
            }
        });
 
        // PATCH /config
        api.patch("/config", [configApplication] APPLICATION(req, res) {
            try {
                const std::string bodyStr(req->body.begin(), req->body.end());
                nlohmann::json patchOps = nlohmann::json::parse(bodyStr);
 
                nlohmann::json current = configApplication->getMqttMapper()->getMapping();
                current = current.patch(patchOps);
 
                JsonMappingReader::saveDraft(configApplication->getMappingFilename(), current);
 
                res->status(200).json({{"status", "patched"}, {"path", configApplication->getMappingFilename()}});
            } catch (const nlohmann::json::parse_error& e) {
                res->status(400).json({{"error", "Invalid JSON body"}, {"details", e.what()}});
            } catch (const std::exception& e) {
                res->status(422).json({{"error", "Patch application failed"}, {"details", e.what()}});
            }
        });
 
        // POST /config (replace full draft config)
        api.post("/config", [configApplication] APPLICATION(req, res) {
            try {
                const std::string bodyStr(req->body.begin(), req->body.end());
                nlohmann::json replacement = nlohmann::json::parse(bodyStr);
 
                if (!replacement.is_object()) {
                    res->status(422).json({{"error", "Config replacement must be a JSON object"}});
                    return;
                }
 
                JsonMappingReader::saveDraft(configApplication->getMappingFilename(), replacement);
 
                res->status(200).json({{"status", "replaced"}, {"path", configApplication->getMappingFilename()}});
            } catch (const nlohmann::json::parse_error& e) {
                res->status(400).json({{"error", "Invalid JSON body"}, {"details", e.what()}});
            } catch (const std::exception& e) {
                res->status(422).json({{"error", "Config replacement failed"}, {"details", e.what()}});
            }
        });
 
        // POST /config/deploy
        api.post("/config/deploy", [configApplication, onDeploy] APPLICATION(req, res) {
            try {
                nlohmann::json newMappingJson = JsonMappingReader::deployDraft(configApplication->getMappingFilename());
 
                bool mustReconnect = configApplication->getMqttMapper()->setMapping(newMappingJson); // throws in case of an error during
                                                                                                     // loading or validation. This exeption
                                                                                                     // is catched in the MappingAdminRouter
                configApplication->persistMapping();
 
                if (onDeploy) {
                    ReloadResult reloadResult = onDeploy(mustReconnect);
 
                    res->status(200).json({{"status", "deploy-ack"},
                                           {"reload_mode", reloadResult.mode},
                                           {"instances", reloadResult.instances},
                                           {"subscribed", reloadResult.subscribed},
                                           {"unsubscribed", reloadResult.unsubscribed}});
                } else {
                    res->status(200).json(
                        {{"status", "deploy-ack"}, {"reload_mode", "none"}, {"instances", 0}, {"subscribed", 0}, {"unsubscribed", 0}});
                }
            } catch (const std::exception& e) {
                res->status(500).json({{"error", "Deploy failed"}, {"details", e.what()}});
            }
        });
 
        // POST /config/validate
        api.post("/config/validate", [] APPLICATION(req, res) {
            try {
                const std::string bodyStr(req->body.begin(), req->body.end());
                auto document = nlohmann::json::parse(bodyStr);
 
                nlohmann::json_schema::basic_error_handler err;
                MqttMapper::validate(document, err);
 
                if (err) {
                    res->status(422).json({{"valid", false}, {"error", "Validation failed"}});
                } else {
                    res->status(200).json({{"valid", true}});
                }
            } catch (const std::exception& e) {
                res->status(400).json({{"error", "Validation exception"}, {"details", e.what()}});
            }
        });
 
        // GET /config/validateDraft
        api.get("/config/validateDraft", [configApplication] APPLICATION(req, res) {
            try {
                const std::string draftPath = JsonMappingReader::getDraftPath(configApplication->getMappingFilename());
 
                if (!std::filesystem::exists(draftPath)) {
                    res->status(404).json({{"valid", false}, {"error", "No draft configuration available"}, {"path", draftPath}});
                    return;
                }
 
                std::ifstream draftFile(draftPath);
                if (!draftFile) {
                    res->status(500).json({{"valid", false}, {"error", "Cannot open draft configuration"}, {"path", draftPath}});
                    return;
                }
 
                nlohmann::json draftDocument;
                draftFile >> draftDocument;
 
                nlohmann::json_schema::basic_error_handler err;
                MqttMapper::validate(draftDocument, err);
 
                if (err) {
                    res->status(422).json({{"valid", false}, {"error", "Draft validation failed"}, {"path", draftPath}});
                } else {
                    res->status(200).json({{"valid", true}, {"path", draftPath}});
                }
            } catch (const std::exception& e) {
                res->status(400).json({{"valid", false}, {"error", "Draft validation exception"}, {"details", e.what()}});
            }
        });
 
        // POST /config/rollback
        api.post("/config/rollback", [configApplication, onDeploy] APPLICATION(req, res) {
            try {
                const std::string bodyStr(req->body.begin(), req->body.end());
                auto jsonBody = nlohmann::json::parse(bodyStr);
 
                if (!jsonBody.contains("version_id")) {
                    res->status(400).json({{"error", "Missing version_id"}});
                    return;
                }
 
                std::string versionId = jsonBody["version_id"];
 
                nlohmann::json rolledbackMappingJson = JsonMappingReader::rollbackTo(configApplication->getMappingFilename(), versionId);
 
                bool mustReconnect =
                    configApplication->getMqttMapper()->setMapping(rolledbackMappingJson); // throws in case of an error during loading
                                                                                           // or validation. This exeption is catched
                                                                                           // in the MappingAdminRouter
                configApplication->persistMapping();
 
                ReloadResult reloadResult;
                if (onDeploy) {
                    reloadResult = onDeploy(mustReconnect); // Trigger hot-reload
                }
 
                res->status(200).json({{"status", "deploy-ack"},
                                       {"reload_mode", reloadResult.mode},
                                       {"instances", reloadResult.instances},
                                       {"subscribed", reloadResult.subscribed},
                                       {"unsubscribed", reloadResult.unsubscribed}});
            } catch (const std::exception& e) {
                res->status(500).json({{"error", "Rollback failed"}, {"details", e.what()}});
            }
        });
 
        // GET /config/history
        api.get("/config/history", [configApplication] APPLICATION(req, res) {
            try {
                auto history = JsonMappingReader::getHistory(configApplication->getMappingFilename());
                nlohmann::json list = nlohmann::json::array();
                for (const auto& h : history) {
                    list.push_back({{"id", h.id}, {"comment", h.comment}, {"date", h.date}});
                }
                res->status(200).json(list);
            } catch ([[maybe_unused]] const std::exception& e) {
                res->status(500).json({{"error", "Failed to fetch history"}});
            }
        });
 
        api.get("/", [] APPLICATION(req, res) {
            res->redirect("/ui");
        });
 
        api.get("/ui", [] APPLICATION(req, res) {
            res->redirect("/ui/index.html");
        });
 
        api.use("/ui",
                express::middleware::StaticMiddleware("/home/voc/tmp/integrator/mqtt-integrator-ui/dist/mqtt-integrator-ui/browser"));
 
        api.get("*", [] APPLICATION(req, res) {
            res->redirect("/ui/index.html");
        });
 
        return api;
    }

References mqtt::lib::JsonMappingReader::VersionEntry::comment, mqtt::lib::JsonMappingReader::VersionEntry::date, mqtt::lib::JsonMappingReader::deployDraft(), mqtt::lib::JsonMappingReader::getDraftPath(), mqtt::lib::JsonMappingReader::getHistory(), mqtt::lib::MqttMapper::getMapping(), mqtt::lib::ConfigApplication::getMappingFilename(), mqtt::lib::ConfigApplication::getMqttMapper(), mqtt::lib::MqttMapper::getSchema(), mqtt::lib::JsonMappingReader::VersionEntry::id, mqtt::lib::admin::ReloadResult::instances, mqtt::lib::admin::ReloadResult::mode, mqtt::lib::admin::AdminOptions::pass, mqtt::lib::ConfigApplication::persistMapping(), mqtt::lib::admin::AdminOptions::realm, mqtt::lib::JsonMappingReader::rollbackTo(), mqtt::lib::JsonMappingReader::saveDraft(), mqtt::lib::MqttMapper::setMapping(), mqtt::lib::admin::ReloadResult::subscribed, mqtt::lib::admin::ReloadResult::unsubscribed, mqtt::lib::admin::AdminOptions::user, and mqtt::lib::MqttMapper::validate().

Here is the call graph for this function: