1658

Committed 10 Sep 2023 11:58PM UTC coverage: 91.222% (-0.04%) from 91.263%

Build # 1658

Build Type

push

Evergreen

Committed by GitHub

Commit Message

Merge pull request #6938 from realm/tg/tls-error-reporting

Run Details

95840 of 175760 branches covered (0.0%)

142 of 146 new or added lines in 7 files covered. (97.26%)

290 existing lines in 22 files now uncovered.

233460 of 255926 relevant lines covered (91.22%)

6997123.82 hits per line

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

98.5

/test/object-store/sync/session/session.cpp

////////////////////////////////////////////////////////////////////////////
//
// Copyright 2017 Realm Inc.
//
// 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 <util/event_loop.hpp>
#include <util/test_utils.hpp>
#include <util/sync/session_util.hpp>

#include <realm/object-store/feature_checks.hpp>
#include <realm/object-store/object_schema.hpp>
#include <realm/object-store/object_store.hpp>
#include <realm/object-store/property.hpp>
#include <realm/object-store/schema.hpp>

#include <realm/util/time.hpp>
#include <realm/util/scope_exit.hpp>

#include <catch2/catch_all.hpp>

#include <atomic>
#include <chrono>
#include <fstream>
#ifndef _WIN32
#include <unistd.h>
#endif

using namespace realm;
using namespace realm::util;

static const std::string dummy_auth_url = "https://realm.example.org";
static const std::string dummy_device_id = "123400000000000000000000";

static std::shared_ptr<SyncUser> get_user(const std::shared_ptr<app::App>& app)
{
    return app->sync_manager()->get_user("user_id", ENCODE_FAKE_JWT("fake_refresh_token"),
                                         ENCODE_FAKE_JWT("fake_access_token"), dummy_auth_url, dummy_device_id);
}

TEST_CASE("SyncSession: management by SyncUser", "[sync][session]") {
    if (!EventLoop::has_implementation())
        return;

    TestSyncManager init_sync_manager;
    auto& server = init_sync_manager.sync_server();
    auto app = init_sync_manager.app();
    const std::string realm_base_url = server.base_url();

    SECTION("a SyncUser can properly retrieve its owned sessions") {
        auto user = get_user(app);
        auto session1 = sync_session(user, "/test1a-1");
        auto session2 = sync_session(user, "/test1a-2");
        EventLoop::main().run_until([&] {
            return sessions_are_active(*session1, *session2);
        });

        // Check the sessions on the SyncUser.
        REQUIRE(user->all_sessions().size() == 2);
        auto s1 = user->session_for_on_disk_path(session1->path());
        REQUIRE(s1 == session1);
        auto s2 = user->session_for_on_disk_path(session2->path());
        REQUIRE(s2 == session2);
    }

    SECTION("a SyncUser properly unbinds its sessions upon logging out") {
        auto user = get_user(app);
        auto session1 = sync_session(user, "/test1b-1");
        auto session2 = sync_session(user, "/test1b-2");
        EventLoop::main().run_until([&] {
            return sessions_are_active(*session1, *session2);
        });

        // Log the user out.
        user->log_out();
        // The sessions should log themselves out.
        EventLoop::main().run_until([&] {
            return sessions_are_inactive(*session1, *session2);
        });
        CHECK(user->all_sessions().size() == 0);
    }

    SECTION("a SyncUser defers binding new sessions until it is logged in") {
        auto user = get_user(app);
        user->log_out();
        REQUIRE(user->state() == SyncUser::State::LoggedOut);
        auto session1 = sync_session(user, "/test1c-1");
        auto session2 = sync_session(user, "/test1c-2");
        // Run the runloop many iterations to see if the sessions spuriously bind.
        spin_runloop();
        REQUIRE(session1->state() == SyncSession::State::Inactive);
        REQUIRE(session2->state() == SyncSession::State::Inactive);
        REQUIRE(user->all_sessions().size() == 0);
        // Log the user back in via the sync manager.
        user = get_user(app);
        EventLoop::main().run_until([&] {
            return sessions_are_active(*session1, *session2);
        });
        REQUIRE(user->all_sessions().size() == 2);
    }

    SECTION("a SyncUser properly rebinds existing sessions upon logging back in") {
        auto user = get_user(app);
        auto session1 = sync_session(user, "/test1d-1");
        auto session2 = sync_session(user, "/test1d-2");
        // Make sure the sessions are bound.
        EventLoop::main().run_until([&] {
            return sessions_are_active(*session1, *session2);
        });
        REQUIRE(user->all_sessions().size() == 2);
        // Log the user out.
        user->log_out();
        REQUIRE(user->state() == SyncUser::State::LoggedOut);
        // Run the runloop many iterations to see if the sessions spuriously rebind.
        spin_runloop();
        REQUIRE(session1->state() == SyncSession::State::Inactive);
        REQUIRE(session2->state() == SyncSession::State::Inactive);
        REQUIRE(user->all_sessions().size() == 0);
        // Log the user back in via the sync manager.
        user = get_user(app);
        EventLoop::main().run_until([&] {
            return sessions_are_active(*session1, *session2);
        });
        REQUIRE(user->all_sessions().size() == 2);
    }

    SECTION("sessions that were destroyed can be properly recreated when requested again") {
        const std::string path = "/test1e";
        std::weak_ptr<SyncSession> weak_session;
        std::string on_disk_path;
        util::Optional<SyncConfig> config;
        auto user = get_user(app);
        {
            // Create the session within a nested scope, so we can control its lifetime.
            auto session = sync_session(
                user, path, [](auto, auto) {}, SyncSessionStopPolicy::Immediately, &on_disk_path);
            weak_session = session;
            config = session->config();
            REQUIRE(on_disk_path.size() > 0);
            REQUIRE(weak_session.lock());
        }
        // Wait for the session to die. It may not happen immediately if a progress or error handler
        // is called on a background thread and keeps the session alive past the scope of the above block.
        EventLoop::main().run_until([&] {
            return weak_session.expired();
        });

        // The next time we request it, it'll be created anew.
        // The call to `get_session()` should result in `SyncUser::register_session()` being called.
        auto session = sync_session(
            user, path, [](auto, auto) {}, SyncSessionStopPolicy::Immediately, &on_disk_path);
        CHECK(session);
        session = user->session_for_on_disk_path(on_disk_path);
        CHECK(session);
    }

    SECTION("a user can create multiple sessions for the same URL") {
        auto user = get_user(app);
        // Note that this should put the sessions at different paths.
        auto session1 = sync_session(user, "/test");
        auto session2 = sync_session(user, "/test");
        REQUIRE(session1 != session2);
        REQUIRE(session1->path() != session2->path());
    }
}

TEST_CASE("sync: log-in", "[sync][session]") {
    if (!EventLoop::has_implementation())
        return;

    // Disable file-related functionality and metadata functionality for testing purposes.
    TestSyncManager init_sync_manager;
    auto app = init_sync_manager.app();
    auto user = get_user(app);

    SECTION("Can log in") {
        std::atomic<int> error_count(0);
        auto session = sync_session(user, "/test", [&](auto, auto) {
            ++error_count;
        });

        std::atomic<bool> download_did_complete(false);
        session->wait_for_download_completion([&](auto) {
            download_did_complete = true;
        });
        EventLoop::main().run_until([&] {
            return download_did_complete.load() || error_count > 0;
        });
        CHECK(error_count == 0);
    }

    // TODO: write a test that logs out a Realm with multiple sessions, then logs it back in?
    // TODO: write tests that check that a Session properly handles various types of errors reported via its callback.
}

TEST_CASE("SyncSession: close() API", "[sync][session]") {
    TestSyncManager init_sync_manager;
    auto app = init_sync_manager.app();
    auto user = get_user(app);

    SECTION("Behaves properly when called on session in the 'active' or 'inactive' state") {
        auto session = sync_session(user, "/test-close-for-active");
        EventLoop::main().run_until([&] {
            return sessions_are_active(*session);
        });
        REQUIRE(sessions_are_active(*session));
        session->close();
        EventLoop::main().run_until([&] {
            return sessions_are_inactive(*session);
        });
        REQUIRE(sessions_are_inactive(*session));
        // Try closing the session again. This should be a no-op.
        session->close();
        REQUIRE(sessions_are_inactive(*session));
    }

    SECTION("Close session after it was detached from the SyncManager") {
        auto session = sync_session(user, "/test-close-after-detach");
        session->detach_from_sync_manager();
        REQUIRE_NOTHROW(session->close());
    }
}

TEST_CASE("SyncSession: pause()/resume() API", "[sync][session]") {
    TestSyncManager init_sync_manager;
    auto app = init_sync_manager.app();
    auto user = get_user(app);

    auto session = sync_session(user, "/test-close-for-active");
    EventLoop::main().run_until([&] {
        return sessions_are_active(*session);
    });
    REQUIRE(sessions_are_active(*session));

    SECTION("making the session inactive and then pausing it should end up in the paused state") {
        session->force_close();
        EventLoop::main().run_until([&] {
            return sessions_are_inactive(*session);
        });
        REQUIRE(sessions_are_inactive(*session));

        session->pause();
        EventLoop::main().run_until([&] {
            return session->state() == SyncSession::State::Paused;
        });
        REQUIRE(session->state() == SyncSession::State::Paused);
    }

    SECTION("pausing from the active state should end up in the paused state") {
        session->pause();
        EventLoop::main().run_until([&] {
            return session->state() == SyncSession::State::Paused;
        });
        REQUIRE(session->state() == SyncSession::State::Paused);

        // Pausing it again should be a no-op
        session->pause();
        REQUIRE(session->state() == SyncSession::State::Paused);

        // "Logging out" the session should be a no-op.
        session->force_close();
        REQUIRE(session->state() == SyncSession::State::Paused);
    }

    // Reviving the session via revive_if_needed() should be a no-op.
    session->revive_if_needed();
    REQUIRE(session->state() == SyncSession::State::Paused);

    // Only resume() can revive a paused session.
    session->resume();
    EventLoop::main().run_until([&] {
        return sessions_are_active(*session);
    });
    REQUIRE(sessions_are_active(*session));
}

TEST_CASE("SyncSession: shutdown_and_wait() API", "[sync][session]") {
    TestSyncManager init_sync_manager;
    auto app = init_sync_manager.app();
    auto user = get_user(app);

    SECTION("Behaves properly when called on session in the 'active' or 'inactive' state") {
        auto session = sync_session(user, "/test-close-for-active");
        EventLoop::main().run_until([&] {
            return sessions_are_active(*session);
        });
        REQUIRE(sessions_are_active(*session));
        session->shutdown_and_wait();
        session->close();
        EventLoop::main().run_until([&] {
            return sessions_are_inactive(*session);
        });
        REQUIRE(sessions_are_inactive(*session));
        // Try closing the session again. This should be a no-op.
        session->close();
        REQUIRE(sessions_are_inactive(*session));
    }
}

TEST_CASE("SyncSession: update_configuration()", "[sync][session]") {
    TestSyncManager init_sync_manager({}, {false});
    auto app = init_sync_manager.app();
    auto user = get_user(app);
    auto session = sync_session(user, "/update_configuration");

    SECTION("updates reported configuration") {
        auto config = session->config();
        REQUIRE(config.client_validate_ssl);
        config.client_validate_ssl = false;
        session->update_configuration(std::move(config));
        REQUIRE_FALSE(session->config().client_validate_ssl);
    }

    SECTION("handles reconnects while it's trying to deactivate session") {
        bool wait_called = false;
        session->wait_for_download_completion([&](Status s) {
            REQUIRE(s == ErrorCodes::OperationAborted);
            REQUIRE(session->config().client_validate_ssl);
            REQUIRE(session->state() == SyncSession::State::Inactive);

            wait_called = true;
            session->revive_if_needed();

            REQUIRE(session->state() != SyncSession::State::Inactive);
        });

        auto config = session->config();
        config.client_validate_ssl = false;
        session->update_configuration(std::move(config));
        REQUIRE(wait_called);
    }
}

TEST_CASE("sync: error handling", "[sync][session]") {
    TestSyncManager init_sync_manager;
    auto app = init_sync_manager.app();

    std::string on_disk_path;
    std::optional<SyncError> error;
    std::mutex mutex;
    auto store_sync_error = [&](auto, SyncError e) {
        std::lock_guard lock(mutex);
        error = e;
    };

    SECTION("reports DNS error") {
        app->sync_manager()->set_sync_route("ws://invalid.com:9090");

        auto user = get_user(app);
        auto session = sync_session(user, "/test", store_sync_error);
        timed_wait_for(
            [&] {
                std::lock_guard lock(mutex);
                return error.has_value();
            },
            std::chrono::seconds(35)); // this sometimes needs to wait for a 30s dns timeout
        REQUIRE(error);
        CHECK(error->status.code() == ErrorCodes::SyncConnectFailed);
        // May end with either (authoritative) or (non-authoritative)
        CHECK_THAT(error->status.reason(), Catch::Matchers::StartsWith("Failed to connect to sync: Host not found"));
    }

#ifndef SWIFT_PACKAGE // requires test resource files
    SECTION("reports TLS error as handshake failed") {
        TestSyncManager ssl_sync_manager({}, {StartImmediately{true}, EnableSSL{true}});
        auto app = ssl_sync_manager.app();

        auto user = get_user(app);
        auto session = sync_session(user, "/test", store_sync_error);
        timed_wait_for([&] {
            std::lock_guard lock(mutex);
            return error.has_value();
        });
        REQUIRE(error);
        CHECK(error->status.code() == ErrorCodes::TlsHandshakeFailed);
#if REALM_HAVE_SECURE_TRANSPORT
        CHECK(error->status.reason() ==
              "TLS handshake failed: SecureTransport error: invalid certificate chain (-9807)");
#else
        // The exact error code seems to vary, so only check the message
        CHECK_THAT(error->status.reason(),
                   Catch::Matchers::StartsWith("TLS handshake failed: OpenSSL error: certificate verify failed"));
#endif
    }
#endif

    using ProtocolError = realm::sync::ProtocolError;
    using ProtocolErrorInfo = realm::sync::ProtocolErrorInfo;

    SECTION("Doesn't treat unknown system errors as being fatal") {
        auto user = get_user(app);
        auto session = sync_session(user, "/test", store_sync_error);
        EventLoop::main().run_until([&] {
            return sessions_are_active(*session);
        });

        sync::SessionErrorInfo err{Status{ErrorCodes::UnknownError, "unknown error"}, true};
        err.server_requests_action = ProtocolErrorInfo::Action::Transient;
        SyncSession::OnlyForTesting::handle_error(*session, std::move(err));
        CHECK(!sessions_are_inactive(*session));
        // Error is non-fatal so it's not reported to the error handler
        std::lock_guard lock(mutex);
        REQUIRE_FALSE(error);
    }

    SECTION("Properly handles a client reset error") {
        auto user = get_user(app);
        auto session = sync_session(user, "/test", store_sync_error);
        std::string on_disk_path = session->path();
        EventLoop::main().run_until([&] {
            return sessions_are_active(*session);
        });

        auto code = GENERATE(ProtocolError::bad_client_file_ident, ProtocolError::bad_server_version,
                             ProtocolError::diverging_histories);

        sync::SessionErrorInfo initial_error{sync::protocol_error_to_status(code, "Something bad happened"), true};
        initial_error.server_requests_action = ProtocolErrorInfo::Action::ClientReset;
        std::time_t just_before_raw = std::time(nullptr);
        SyncSession::OnlyForTesting::handle_error(*session, std::move(initial_error));
        REQUIRE(session->state() == SyncSession::State::Inactive);
        std::time_t just_after_raw = std::time(nullptr);
        auto just_before = util::localtime(just_before_raw);
        auto just_after = util::localtime(just_after_raw);
        // At this point error should be populated.
        REQUIRE(error);
        CHECK(error->is_client_reset_requested());
        CHECK(error->server_requests_action == ProtocolErrorInfo::Action::ClientReset);
        // The original file path should be present.
        CHECK(error->user_info[SyncError::c_original_file_path_key] == on_disk_path);
        // The path to the recovery file should be present, and should contain all necessary components.
        std::string recovery_path = error->user_info[SyncError::c_recovery_file_path_key];
        auto idx = recovery_path.find("recovered_realm");
        CHECK(idx != std::string::npos);
        idx = recovery_path.find(app->sync_manager()->recovery_directory_path());
        CHECK(idx != std::string::npos);
        if (just_before.tm_year == just_after.tm_year) {
            idx = recovery_path.find(util::format_local_time(just_after_raw, "%Y"));
            CHECK(idx != std::string::npos);
        }
        if (just_before.tm_mon == just_after.tm_mon) {
            idx = recovery_path.find(util::format_local_time(just_after_raw, "%m"));
            CHECK(idx != std::string::npos);
        }
        if (just_before.tm_yday == just_after.tm_yday) {
            idx = recovery_path.find(util::format_local_time(just_after_raw, "%d"));
            CHECK(idx != std::string::npos);
        }
    }
}

TEST_CASE("sync: stop policy behavior", "[sync][session]") {
    const std::string dummy_auth_url = "https://realm.example.org";
    if (!EventLoop::has_implementation())
        return;

    // Server is initially stopped so we can control when the session exits the dying state.
    TestSyncManager init_sync_manager({}, {false});
    auto& server = init_sync_manager.sync_server();
    auto sync_manager = init_sync_manager.app()->sync_manager();
    auto schema = Schema{
        {"object",
         {
             {"_id", PropertyType::Int, Property::IsPrimary{true}},
             {"value", PropertyType::Int},
         }},
    };

    std::atomic<bool> error_handler_invoked(false);
    Realm::Config config;
    auto user = get_user(init_sync_manager.app());

    auto create_session = [&](SyncSessionStopPolicy stop_policy) {
        auto session = sync_session(
            user, "/test-dying-state",
            [&](auto, auto) {
                error_handler_invoked = true;
            },
            stop_policy, nullptr, schema, &config);
        EventLoop::main().run_until([&] {
            return sessions_are_active(*session);
        });

        // Add an object so there's something to upload
        auto r = Realm::get_shared_realm(config);
        TableRef table = ObjectStore::table_for_object_type(r->read_group(), "object");
        r->begin_transaction();
        table->create_object_with_primary_key(0);
        r->commit_transaction();

        return session;
    };

    SECTION("Immediately") {
        SECTION("transitions directly to Inactive even with the server stopped") {
            auto session = create_session(SyncSessionStopPolicy::Immediately);
            session->close();
            REQUIRE(sessions_are_inactive(*session));
        }
    }

    SECTION("AfterChangesUploaded") {
        auto session = create_session(SyncSessionStopPolicy::AfterChangesUploaded);
        // Now close the session, causing the state to transition to Dying.
        // (it should remain stuck there until we start the server)
        session->close();
        REQUIRE(session->state() == SyncSession::State::Dying);

        SECTION("transitions to Inactive once the server is started") {
            server.start();
            EventLoop::main().run_until([&] {
                return sessions_are_inactive(*session);
            });
        }

        SECTION("transitions back to Active if the session is revived") {
            std::shared_ptr<SyncSession> session2;
            {
                auto realm = Realm::get_shared_realm(config);
                session2 = user->sync_manager()->get_existing_session(config.path);
            }
            REQUIRE(session->state() == SyncSession::State::Active);
            REQUIRE(session2 == session);
        }

        SECTION("transitions to Inactive if a fatal error occurs") {
            sync::SessionErrorInfo err{Status{ErrorCodes::SyncProtocolInvariantFailed, "Not a real error message"},
                                       sync::IsFatal{true}};
            err.server_requests_action = realm::sync::ProtocolErrorInfo::Action::ProtocolViolation;
            SyncSession::OnlyForTesting::handle_error(*session, std::move(err));
            CHECK(sessions_are_inactive(*session));
            // The session shouldn't report fatal errors when in the dying state.
            CHECK(!error_handler_invoked);
        }

        SECTION("ignores non-fatal errors and does not transition to Inactive") {
            // Fire a simulated *non-fatal* error.
            sync::SessionErrorInfo err{Status{ErrorCodes::ConnectionClosed, "Not a real error message"},
                                       sync::IsFatal{false}};
            err.server_requests_action = realm::sync::ProtocolErrorInfo::Action::Transient;
            SyncSession::OnlyForTesting::handle_error(*session, std::move(err));
            REQUIRE(session->state() == SyncSession::State::Dying);
            CHECK(!error_handler_invoked);
        }
    }

    SECTION("can change to Immediately after opening the session") {
        auto session = create_session(SyncSessionStopPolicy::AfterChangesUploaded);
        REQUIRE(session->state() == SyncSession::State::Active);

        auto config = session->config();
        config.stop_policy = SyncSessionStopPolicy::Immediately;
        session->update_configuration(std::move(config));

        session->close();
        REQUIRE(sessions_are_inactive(*session));
    }
}

TEST_CASE("session restart", "[sync][session]") {
    if (!EventLoop::has_implementation())
        return;

    TestSyncManager init_sync_manager({}, {false});
    auto& server = init_sync_manager.sync_server();
    auto app = init_sync_manager.app();
    Realm::Config config;
    auto schema = Schema{
        {"object",
         {
             {"_id", PropertyType::Int, Property::IsPrimary{true}},
             {"value", PropertyType::Int},
         }},
    };

    auto user = get_user(app);
    auto session = sync_session(
        user, "/test-restart", [&](auto, auto) {}, SyncSessionStopPolicy::AfterChangesUploaded, nullptr, schema,
        &config);

    EventLoop::main().run_until([&] {
        return sessions_are_active(*session);
    });

    server.start();

    // Add an object so there's something to upload
    auto realm = Realm::get_shared_realm(config);
    TableRef table = ObjectStore::table_for_object_type(realm->read_group(), "object");
    realm->begin_transaction();
    table->create_object_with_primary_key(0);
    realm->commit_transaction();

    // Close the current session and start a new one
    // The stop policy is ignored when closing the current session
    session->restart_session();

    REQUIRE(session->state() == SyncSession::State::Active);
    REQUIRE(!wait_for_upload(*realm));
}

TEST_CASE("sync: non-synced metadata table doesn't result in non-additive schema changes", "[sync][session]") {
    if (!EventLoop::has_implementation())
        return;

    // Disable file-related functionality and metadata functionality for testing purposes.
    TestSyncManager init_sync_manager;

    // Create a synced Realm containing a class with two properties.
    {
        SyncTestFile config1(init_sync_manager.app(), "schema-version-test");
        config1.schema_version = 1;
        config1.schema = Schema{
            {"object",
             {{"_id", PropertyType::Int, Property::IsPrimary{true}},
              {"property1", PropertyType::Int},
              {"property2", PropertyType::Int}}},
        };

        auto realm1 = Realm::get_shared_realm(config1);
        wait_for_upload(*realm1);
    }

    // Download the existing Realm into a second local file without specifying a schema,
    // mirroring how `openAsync` works.
    SyncTestFile config2(init_sync_manager.app(), "schema-version-test");
    config2.schema_version = 1;
    {
        auto realm2 = Realm::get_shared_realm(config2);
        wait_for_download(*realm2);
    }

    // Open the just-downloaded Realm while specifying a schema that contains a class with
    // only a single property. This should not result in us trying to remove `property2`,
    // and will throw an exception if it does.
    {
        SyncTestFile config3(init_sync_manager.app(), "schema-version-test");
        config3.path = config2.path;
        config3.schema_version = 1;
        config3.schema = Schema{
            {"object", {{"_id", PropertyType::Int, Property::IsPrimary{true}}, {"property1", PropertyType::Int}}},
        };

        auto realm3 = Realm::get_shared_realm(config3);
    }
}

realm / realm-core / 1658

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