2281564137

Committed 23 Jan 2026 10:59AM UTC coverage: 81.48% (+1.7%) from 79.764%

Build # 2281564137

Build Type

push

gitlab-ci

Committed by

michalkopczan

Commit Message

fix: Schedule next deployment poll if current one failed early causing no handler to be called

Ticket: MEN-9144
Changelog: Fix a hang when polling for deployment failed early causing no handler of API response
to be called. Added handler call for this case, causing the deployment polling
to continue.

Signed-off-by: Michal Kopczan <michal.kopczan@northern.tech>

Run Details

1 of 1 new or added line in 1 file covered. (100.0%)

327 existing lines in 44 files now uncovered.

8839 of 10848 relevant lines covered (81.48%)

20226.53 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

77.67

/src/mender-update/standalone/states.cpp

// Copyright 2024 Northern.tech AS
//
//    Licensed under the Apache License, Version 2.0 (the "License");
//    you may not use this file except in compliance with the License.
//    You may obtain a copy of the License at
//
//        http://www.apache.org/licenses/LICENSE-2.0
//
//    Unless required by applicable law or agreed to in writing, software
//    distributed under the License is distributed on an "AS IS" BASIS,
//    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//    See the License for the specific language governing permissions and
//    limitations under the License.

#include <mender-update/standalone/states.hpp>

#include <common/http.hpp>
#include <common/events_io.hpp>
#include <common/io.hpp>
#include <common/key_value_database.hpp>
#include <common/log.hpp>
#include <common/path.hpp>

#include <mender-update/standalone.hpp>

namespace mender {
namespace update {
namespace standalone {

namespace database = mender::common::key_value_database;
namespace events = mender::common::events;
namespace http = mender::common::http;
namespace io = mender::common::io;
namespace log = mender::common::log;
namespace path = mender::common::path;

// This is used to catch mistakes where we don't set the error before exiting the state machine.
static const error::Error kFallbackError = error::MakeError(
        error::ProgrammingError, "Returned from standalone operation without setting error code.");

static void UpdateResult(ResultAndError &result, const ResultAndError &update) {
        if (result.err == kFallbackError or result.err == error::NoError) {
                result.err = update.err;
        } else {
                result.err = result.err.FollowedBy(update.err);
        }

        result.result = result.result | update.result;
}

void SaveState::OnEnter(Context &ctx, sm::EventPoster<StateEvent> &poster) {
        ctx.state_data.in_state = state_;

        if (ResultContains(ctx.result_and_error.result, Result::Failed)) {
                ctx.state_data.failed = true;
        }
        if (ResultContains(ctx.result_and_error.result, Result::RolledBack)
                or ResultContains(ctx.result_and_error.result, Result::NoRollbackNecessary)) {
                ctx.state_data.rolled_back = true;
        }
        if (ResultContains(ctx.result_and_error.result, Result::RollbackFailed)) {
                ctx.state_data.rolled_back = false;
        }

        auto err = SaveStateData(ctx.main_context.GetMenderStoreDB(), ctx.state_data);
        if (err != error::NoError) {
                UpdateResult(ctx.result_and_error, {Result::Failed, err});
                poster.PostEvent(StateEvent::Failure);
                return;
        }

        OnEnterSaveState(ctx, poster);
}

void JustSaveState::OnEnterSaveState(Context &ctx, sm::EventPoster<StateEvent> &poster) {
        // Nothing other than saving, which has already happened.
        poster.PostEvent(StateEvent::Success);
}

error::Error DoEmptyPayloadArtifact(Context &ctx) {
        if (ctx.options != InstallOptions::NoStdout) {
                cout << "Installing artifact..." << endl;
                cout << "Artifact with empty payload. Committing immediately." << endl;
        }

        auto &data = ctx.state_data;
        return ctx.main_context.CommitArtifactData(
                data.artifact_name,
                data.artifact_group,
                data.artifact_provides,
                data.artifact_clears_provides,
                [](database::Transaction &txn) { return error::NoError; });
}

static io::ExpectedReaderPtr ReaderFromUrl(
        events::EventLoop &loop, http::Client &http_client, const string &src) {
        auto req = make_shared<http::OutgoingRequest>();
        req->SetMethod(http::Method::GET);
        auto err = req->SetAddress(src);
        if (err != error::NoError) {
                return expected::unexpected(err);
        }
        error::Error inner_err;
        io::AsyncReaderPtr reader;
        err = http_client.AsyncCall(
                req,
                [&loop, &inner_err, &reader](http::ExpectedIncomingResponsePtr exp_resp) {
                        // No matter what happens, we will want to stop the loop after the headers
                        // are received.
                        loop.Stop();

                        if (!exp_resp) {
                                inner_err = exp_resp.error();
                                return;
                        }

                        auto resp = exp_resp.value();

                        if (resp->GetStatusCode() != http::StatusOK) {
                                inner_err = context::MakeError(
                                        context::UnexpectedHttpResponse,
                                        to_string(resp->GetStatusCode()) + ": " + resp->GetStatusMessage());
                                return;
                        }

                        auto exp_reader = resp->MakeBodyAsyncReader();
                        if (!exp_reader) {
                                inner_err = exp_reader.error();
                                return;
                        }
                        reader = exp_reader.value();
                },
                [](http::ExpectedIncomingResponsePtr exp_resp) {
                        // Note: Since we stop the event loop above, this handler will not be called
                        // while we are inside the `ReaderFromUrl` stack frame. It will be called
                        // later though, when the reader that we return has finished reading
                        // everything (which includes resuming the loop). So be careful with
                        // captures in this handler.
                        if (!exp_resp) {
                                log::Warning("While reading HTTP body: " + exp_resp.error().String());
                        }
                });

        // Loop until the headers are received. Then we return and let the reader drive the
        // rest of the download.
        loop.Run();

        if (err != error::NoError) {
                return expected::unexpected(err);
        }

        if (inner_err != error::NoError) {
                return expected::unexpected(inner_err);
        }

        // Should not happen since we have checked both `err` and `inner_err`, but just to be safe.
        AssertOrReturnUnexpected(reader != nullptr);

        return make_shared<events::io::ReaderFromAsyncReader>(loop, reader);
}

StateData StateDataFromPayloadHeaderView(const artifact::PayloadHeaderView &header) {
        StateData dst;
        dst.version = context::MenderContext::standalone_data_version;
        dst.artifact_name = header.header.artifact_name;
        dst.artifact_group = header.header.artifact_group;
        dst.artifact_provides = header.header.type_info.artifact_provides;
        dst.artifact_clears_provides = header.header.type_info.clears_artifact_provides;
        dst.payload_types.clear();
        dst.payload_types.push_back(header.header.payload_type);
        return dst;
}

void PrepareDownloadState::OnEnter(Context &ctx, sm::EventPoster<StateEvent> &poster) {
        auto &main_context = ctx.main_context;

        if (ctx.artifact_src.find("http://") == 0 || ctx.artifact_src.find("https://") == 0) {
                ctx.http_client =
                        make_shared<http::Client>(main_context.GetConfig().GetHttpClientConfig(), ctx.loop);
                auto reader = ReaderFromUrl(ctx.loop, *ctx.http_client, ctx.artifact_src);
                if (!reader) {
                        UpdateResult(
                                ctx.result_and_error,
                                {Result::DownloadFailed | Result::Failed | Result::NoRollbackNecessary,
                                 reader.error()});
                        poster.PostEvent(StateEvent::Failure);
                        return;
                }
                ctx.artifact_reader = reader.value();
        } else {
                auto stream = io::OpenIfstream(ctx.artifact_src);
                if (!stream) {
                        UpdateResult(
                                ctx.result_and_error,
                                {Result::DownloadFailed | Result::Failed | Result::NoRollbackNecessary,
                                 stream.error()});
                        poster.PostEvent(StateEvent::Failure);
                        return;
                }
                auto file_stream = make_shared<ifstream>(std::move(stream.value()));
                ctx.artifact_reader = make_shared<io::StreamReader>(file_stream);
        }

        string art_scripts_path = main_context.GetConfig().paths.GetArtScriptsPath();

        // Clear the artifact scripts directory so we don't risk old scripts lingering.
        auto err = path::DeleteRecursively(art_scripts_path);
        if (err != error::NoError) {
                UpdateResult(
                        ctx.result_and_error,
                        {Result::DownloadFailed | Result::Failed | Result::NoRollbackNecessary,
                         err.WithContext("When preparing to parse artifact")});
                poster.PostEvent(StateEvent::Failure);
                return;
        }

        artifact::config::ParserConfig config {
                .artifact_scripts_filesystem_path = main_context.GetConfig().paths.GetArtScriptsPath(),
                .artifact_scripts_version = 3,
                .artifact_verify_keys = main_context.GetConfig().artifact_verify_keys,
                .verify_signature = ctx.verify_signature,
        };

        auto exp_parser = artifact::Parse(*ctx.artifact_reader, config);
        if (!exp_parser) {
                UpdateResult(
                        ctx.result_and_error,
                        {Result::DownloadFailed | Result::Failed | Result::NoRollbackNecessary,
                         exp_parser.error()});
                poster.PostEvent(StateEvent::Failure);
                return;
        }
        ctx.parser.reset(new artifact::Artifact(std::move(exp_parser.value())));

        auto exp_header = artifact::View(*ctx.parser, 0);
        if (!exp_header) {
                UpdateResult(
                        ctx.result_and_error,
                        {Result::DownloadFailed | Result::Failed | Result::NoRollbackNecessary,
                         exp_header.error()});
                poster.PostEvent(StateEvent::Failure);
                return;
        }
        auto &header = exp_header.value();

        ctx.state_data = StateDataFromPayloadHeaderView(header);

        if (header.header.payload_type == "") {
                err = DoEmptyPayloadArtifact(ctx);
                if (err != error::NoError) {
                        UpdateResult(
                                ctx.result_and_error,
                                {Result::DownloadFailed | Result::Failed | Result::FailedInPostCommit, err});
                        poster.PostEvent(StateEvent::Failure);
                        return;
                }
                UpdateResult(
                        ctx.result_and_error,
                        {Result::Downloaded | Result::Installed | Result::Committed, error::NoError});
                poster.PostEvent(StateEvent::EmptyPayloadArtifact);
                return;
        }

        auto exp_update_module =
                update_module::UpdateModule::Create(main_context, header.header.payload_type);
        if (!exp_update_module.has_value()) {
                UpdateResult(
                        ctx.result_and_error,
                        {Result::DownloadFailed | Result::Failed | Result::NoRollbackNecessary,
                         exp_update_module.error()});
                poster.PostEvent(StateEvent::Failure);
                return;
        }
        ctx.update_module = std::move(exp_update_module.value());

        err = ctx.update_module->CleanAndPrepareFileTree(
                ctx.update_module->GetUpdateModuleWorkDir(), header);
        if (err != error::NoError) {
                UpdateResult(
                        ctx.result_and_error,
                        {Result::DownloadFailed | Result::Failed | Result::NoRollbackNecessary, err});
                poster.PostEvent(StateEvent::Failure);
                return;
        }

        if (ctx.options != InstallOptions::NoStdout) {
                cout << "Installing artifact..." << endl;
        }

        auto exp_matches = main_context.MatchesArtifactDepends(header.header);
        if (!exp_matches) {
                UpdateResult(
                        ctx.result_and_error,
                        {Result::DownloadFailed | Result::Failed | Result::NoRollbackNecessary,
                         exp_matches.error()});
                poster.PostEvent(StateEvent::Failure);
                return;
        } else if (!exp_matches.value()) {
                // reasons already logged
                UpdateResult(
                        ctx.result_and_error,
                        {Result::DownloadFailed | Result::Failed | Result::NoRollbackNecessary,
                         error::NoError});
                poster.PostEvent(StateEvent::Failure);
                return;
        }

        poster.PostEvent(StateEvent::Success);
}

error::Error DoDownloadState(Context &ctx) {
        auto payload = ctx.parser->Next();
        if (!payload) {
                return payload.error();
        }

        // ProvidePayloadFileSizes
        auto with_sizes = ctx.update_module->ProvidePayloadFileSizes();
        if (!with_sizes) {
                log::Error("Could not query for provide file sizes: " + with_sizes.error().String());
                return with_sizes.error();
        }

        error::Error err;
        if (with_sizes.value()) {
                err = ctx.update_module->DownloadWithFileSizes(payload.value());
        } else {
                err = ctx.update_module->Download(payload.value());
        }
        if (err != error::NoError) {
                return err;
        }

        payload = ctx.parser->Next();
        if (payload) {
                err = error::Error(
                        make_error_condition(errc::not_supported),
                        "Multiple payloads are not supported in standalone mode");
        } else if (
                payload.error().code
                != artifact::parser_error::MakeError(artifact::parser_error::EOFError, "").code) {
                err = payload.error();
        }
        if (err != error::NoError) {
                return err;
        }

        return error::NoError;
}

void DownloadState::OnEnter(Context &ctx, sm::EventPoster<StateEvent> &poster) {
        auto err = DoDownloadState(ctx);
        if (err != error::NoError) {
                log::Error("Streaming failed: " + err.String());
                UpdateResult(
                        ctx.result_and_error,
                        {Result::DownloadFailed | Result::Failed | Result::NoRollbackNecessary, err});
                poster.PostEvent(StateEvent::Failure);
                return;
        }

        UpdateResult(ctx.result_and_error, {Result::Downloaded, error::NoError});
        poster.PostEvent(StateEvent::Success);
}

void ArtifactInstallState::OnEnter(Context &ctx, sm::EventPoster<StateEvent> &poster) {
        auto err = ctx.update_module->ArtifactInstall();
        if (err != error::NoError) {
                log::Error("Installation failed: " + err.String());
                UpdateResult(ctx.result_and_error, {Result::InstallFailed | Result::Failed, err});
                poster.PostEvent(StateEvent::Failure);
                return;
        }

        UpdateResult(ctx.result_and_error, {Result::Installed, error::NoError});
        poster.PostEvent(StateEvent::Success);
}

RebootAndRollbackQueryState::RebootAndRollbackQueryState() :
        SaveState(StateData::kBeforeStateArtifactCommit_Enter) {
}

void RebootAndRollbackQueryState::OnEnterSaveState(
        Context &ctx, sm::EventPoster<StateEvent> &poster) {
        auto reboot = ctx.update_module->NeedsReboot();
        if (!reboot) {
                log::Error("Could not query for reboot: " + reboot.error().String());
                UpdateResult(ctx.result_and_error, {Result::Failed, reboot.error()});
                poster.PostEvent(StateEvent::Failure);
                return;
        }

        if (reboot.value() != update_module::RebootAction::No) {
                UpdateResult(ctx.result_and_error, {Result::RebootRequired, error::NoError});
        }

        auto rollback_support = ctx.update_module->SupportsRollback();
        if (!rollback_support) {
                log::Error("Could not query for rollback support: " + rollback_support.error().String());
                UpdateResult(ctx.result_and_error, {Result::Failed, rollback_support.error()});
                poster.PostEvent(StateEvent::Failure);
                return;
        }

        if (rollback_support.value()) {
                poster.PostEvent(StateEvent::NeedsInteraction);
                return;
        } else {
                UpdateResult(ctx.result_and_error, {Result::AutoCommitWanted});
        }

        poster.PostEvent(StateEvent::Success);
}

void ArtifactCommitState::OnEnter(Context &ctx, sm::EventPoster<StateEvent> &poster) {
        auto err = ctx.update_module->ArtifactCommit();
        if (err != error::NoError) {
                log::Error("Commit failed: " + err.String());
                UpdateResult(ctx.result_and_error, {Result::CommitFailed | Result::Failed, err});
                poster.PostEvent(StateEvent::Failure);
                return;
        }

        UpdateResult(ctx.result_and_error, {Result::Committed, error::NoError});
        poster.PostEvent(StateEvent::Success);
}

void RollbackQueryState::OnEnter(Context &ctx, sm::EventPoster<StateEvent> &poster) {
        auto rollback_support = ctx.update_module->SupportsRollback();
        if (!rollback_support) {
                log::Error("Could not query for rollback support: " + rollback_support.error().String());
                UpdateResult(
                        ctx.result_and_error,
                        {Result::Failed | Result::RollbackFailed, rollback_support.error()});
                poster.PostEvent(StateEvent::Failure);
                return;
        }

        if (not rollback_support.value()) {
                bool already_failed = ResultContains(ctx.result_and_error.result, Result::Failed);
                UpdateResult(ctx.result_and_error, {Result::Failed | Result::NoRollback, error::NoError});
                if (already_failed) {
                        poster.PostEvent(StateEvent::NothingToDo);
                } else {
                        // If it hadn't failed already, it's because the user asked for the rollback
                        // explicitly. In this case bail out instead of continuing.
                        poster.PostEvent(StateEvent::NeedsInteraction);
                }
                return;
        }

        poster.PostEvent(StateEvent::Success);
}

void ArtifactRollbackState::OnEnter(Context &ctx, sm::EventPoster<StateEvent> &poster) {
        auto err = ctx.update_module->ArtifactRollback();
        if (err != error::NoError) {
                UpdateResult(ctx.result_and_error, {Result::Failed | Result::RollbackFailed, err});
                poster.PostEvent(StateEvent::Failure);
                return;
        }

        UpdateResult(ctx.result_and_error, {Result::RolledBack, error::NoError});
        poster.PostEvent(StateEvent::Success);
}

void ArtifactFailureState::OnEnter(Context &ctx, sm::EventPoster<StateEvent> &poster) {
        auto err = ctx.update_module->ArtifactFailure();
        if (err != error::NoError) {
                UpdateResult(ctx.result_and_error, {Result::Failed | Result::RollbackFailed, err});
                poster.PostEvent(StateEvent::Failure);
                return;
        }

        poster.PostEvent(StateEvent::Success);
}

void CleanupState::OnEnter(Context &ctx, sm::EventPoster<StateEvent> &poster) {
        auto final_event = StateEvent::Success;

        auto &data = ctx.state_data;

        // If this is null, then it is simply a no-op, the update did not even get started.
        if (ctx.update_module != nullptr) {
                auto err = ctx.update_module->Cleanup();
                if (err != error::NoError) {
                        UpdateResult(ctx.result_and_error, {Result::Failed | Result::CleanupFailed, err});
                        final_event = StateEvent::Failure;
                        data.failed = true;
                        // Fall through so that we update the DB.
                }
        }

        error::Error err;
        if (data.rolled_back) {
                // Successful rollback.
                auto &db = ctx.main_context.GetMenderStoreDB();
                err = db.Remove(context::MenderContext::standalone_state_key);
        } else {
                if (data.failed) {
                        // Unsuccessful rollback or missing rollback support.
                        data.artifact_name += ctx.main_context.broken_artifact_name_suffix;
                        if (data.artifact_provides) {
                                data.artifact_provides.value()["artifact_name"] = data.artifact_name;
                        }
                        // Fall through to success case.
                }
                // Commit artifact data and remove state data
                err = ctx.main_context.CommitArtifactData(
                        data.artifact_name,
                        data.artifact_group,
                        data.artifact_provides,
                        data.artifact_clears_provides,
                        [](database::Transaction &txn) {
                                return txn.Remove(context::MenderContext::standalone_state_key);
                        });
        }
        if (err != error::NoError) {
                err = err.WithContext("Error while updating database");
                UpdateResult(ctx.result_and_error, {Result::Failed | Result::RollbackFailed, err});
                poster.PostEvent(StateEvent::Failure);
                return;
        }

        UpdateResult(ctx.result_and_error, {Result::Cleaned, error::NoError});
        poster.PostEvent(final_event);
}

void ScriptRunnerState::OnEnter(Context &ctx, sm::EventPoster<StateEvent> &poster) {
        auto err = ctx.script_runner->RunScripts(state_, action_, on_error_);
        if (err != error::NoError) {
                log::Error("Error executing script: " + err.String());
                UpdateResult(ctx.result_and_error, {result_on_error_, err});
                poster.PostEvent(StateEvent::Failure);
                return;
        }

        poster.PostEvent(StateEvent::Success);
}

void ExitState::OnEnter(Context &ctx, sm::EventPoster<StateEvent> &poster) {
        auto err =
                ctx.main_context.GetMenderStoreDB().WriteTransaction([&ctx](database::Transaction &txn) {
                        auto exp_bytes = txn.Read(context::MenderContext::standalone_state_key);
                        if (!exp_bytes) {
                                if (exp_bytes.error().code == database::MakeError(database::KeyError, "").code) {
                                        // If the stata data is not saved, just do nothing here.
                                        return error::NoError;
                                } else {
                                        return exp_bytes.error();
                                }
                        }

                        // If there is state data, resave it with `failed` set to false. The rationale
                        // behind this is that if we have already recorded failure for this run, it will be
                        // returned in the error code. That does not mean that we should record error for
                        // the next run, which is independent. An example is rollback, if we are somewhere
                        // in the rollback flow, we are likely to have a failure here, because the *install*
                        // failed. But when we now exit, and then later resume the rollback, the rollback
                        // should return success, not failure.
                        if (ctx.state_data.failed) {
                                ctx.state_data.failed = false;
                                return SaveStateData(txn, ctx.state_data);
                        } else {
                                return error::NoError;
                        }
                });
        if (err != error::NoError) {
                UpdateResult(ctx.result_and_error, {Result::Failed, err});
                poster.PostEvent(StateEvent::Failure);
                return;
        }

        loop_.Stop();
}

} // namespace standalone
} // namespace update
} // namespace mender

mendersoftware / mender / 2281564137

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous