/**
 * @file tests/synctests.cpp
 * @brief Mega SDK test file
 *
 * (c) 2018 by Mega Limited, Wellsford, New Zealand
 *
 * This file is part of the MEGA SDK - Client Access Engine.
 *
 * Applications using the MEGA API must present a valid application key
 * and comply with the rules set forth in the Terms of Service.
 *
 * The MEGA SDK is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 * @copyright Simplified (2-clause) BSD License.
 *
 * You should have received a copy of the license along with this
 * program.
 */

// Many of these tests are still being worked on.

#include "env_var_accounts.h"
#include "gmock/gmock.h"
#include "gtest_common.h"
#include "mega/scoped_helpers.h"
#include "mega/syncinternals/syncuploadthrottlingmanager.h"
#include "mega/testhooks.h"
#include "mega/tlv.h"
#include "mega/user_attribute.h"
#include "test.h"

#define DEFAULTWAIT std::chrono::seconds(20)

using namespace ::mega;
using namespace ::std;

// we are on SRW branch
#define SRW_NEEDED_FOR_THIS_ONE

#ifdef ENABLE_SYNC

template<typename T>
shared_promise<T> makeSharedPromise()
{
    return shared_promise<T>(new promise<T>());
}

// Convenience.
auto makeScopedStallPredicateResetter(StandardClient& client)
{
    return makeScopedDestructor(
        [&client]()
        {
            client.setHasImmediateStall(nullptr);
            client.setIsImmediateStall(nullptr);
        });
}

auto makeScopedSyncPauser(StandardClient& client, handle id)
{
    auto result = client.setSyncPausedByBackupId(id, true);
    EXPECT_TRUE(result) << "Couldn't pause sync " << toHandle(id);

    return makeScopedDestructor(
        [&client, id]()
        {
            auto result = client.setSyncPausedByBackupId(id, false);
            EXPECT_TRUE(result) << "Couldn't resume sync " << toHandle(id);
        });
}

bool suppressfiles = false;

// dgw: TODO: Perhaps make this a runtime parameter?
#define SCAN_INTERVAL_SEC 3600

bool adjustLastModificationTime(const fs::path& path, int adjustment)
{
    using std::chrono::seconds;

    std::error_code ec;

    // Retrieve the file's current modification time.
    auto current = fs::last_write_time(path, ec);

    // Bail if we couldn't retrieve the time.
    if (ec) return false;

    // Update the modification time.
    fs::last_write_time(path, current + seconds(adjustment), ec);

    // Let the caller know whether we succeeded.
    return !ec;
}

// Creates a temporary directory in the current path
fs::path makeTmpDir(const int maxTries = 1000)
{
    const auto cwd = fs::current_path();
    std::random_device dev;
    std::mt19937 prng{dev()};
    std::uniform_int_distribution<uint64_t> rand{0};
    fs::path path;
    for (int i = 0;; ++i)
    {
        std::ostringstream os;
        os << std::hex << rand(prng);
        path = cwd / os.str();
        if (fs::create_directory(path))
        {
            break;
        }
        if (i == maxTries)
        {
            throw std::runtime_error{"Couldn't create tmp dir"};
        }
    }
    return path;
}

// Copies a file while maintaining the write time.
void copyFile(const fs::path& source, const fs::path& target)
{
    assert(fs::is_regular_file(source));
    const auto tmpDir = makeTmpDir();
    const auto tmpFile = tmpDir / "copied_file";
    fs::copy_file(source, tmpFile);
    fs::last_write_time(tmpFile, fs::last_write_time(source));
    fs::rename(tmpFile, target);
    fs::remove(tmpDir);
}

string leafname(const string& p)
{
    auto n = p.find_last_of("/");
    return n == string::npos ? p : p.substr(n+1);
}

string parentpath(const string& p)
{
    auto n = p.find_last_of("/");
    return n == string::npos ? "" : p.substr(0, n-1);
}


struct StandardClient;
bool CatchupClients(StandardClient* c1, StandardClient* c2 = nullptr, StandardClient* c3 = nullptr);

#ifdef _WIN32

bool createFile(const fs::path& path, const void* data, const size_t data_length)
{
    // Convenience.
    auto create = [&](DWORD disposition, DWORD flags) {
        return CreateFileW(path.c_str(),
                           GENERIC_WRITE,
                           FILE_SHARE_READ | FILE_SHARE_WRITE,
                           nullptr,
                           disposition,
                           flags,
                           nullptr);
    }; // create

    auto invalid = INVALID_HANDLE_VALUE;

    // Try and truncate any existing file.
    auto handle = create(TRUNCATE_EXISTING, FILE_FLAG_OPEN_REPARSE_POINT);

    // File may not exist.
    if (handle == invalid)
    {
        auto error = GetLastError();

        // File exists but we couldn't truncate it.
        if (error != ERROR_FILE_NOT_FOUND)
        {
            LOG_debug << "Unable to truncate data file: " << path_u8string(path)
                      << ". Error was: " << error;

            return false;
        }

        // Try creating the file directly.
        handle = create(CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL);

        // Couldn't create the file.
        if (handle == invalid)
        {
            // Latch error.
            error = GetLastError();

            // Let everyone know why we failed.
            LOG_debug << "Unable to create data file: " << path_u8string(path)
                      << ". Error was: " << error;

            // Let caller know we failed.
            return false;
        }
    }

    // Convenience.
    auto* m = static_cast<const char*>(data);
    auto* n = m + data_length;

    // Try and write the file's data to disk.
    while (m != n)
    {
        auto remaining = static_cast<DWORD>(n - m);
        auto written = 0ul;

        // Couldn't write the file's data to disk.
        if (!WriteFile(handle, m, remaining, &written, nullptr))
        {
            // Latch error.
            auto error = GetLastError();

            // Let debuggers know why we failed.
            LOG_debug << "Unable to write data to file: " << path_u8string(path)
                      << ". Error was: " << error;

            // Close handle and return failure to caller.
            return CloseHandle(handle), false;
        }

        // Move buffer position forward.
        m += written;
    }

    // Try and flush changes to disk.
    auto result = FlushFileBuffers(handle);

    // Couldn't flush changes to disk.
    if (!result)
    {
        // Latch error.
        auto error = GetLastError();

        // Let debuggers know why we failed.
        LOG_debug << "Couldn't flush file to disk: " << path_u8string(path)
                  << ". Error was: " << error;
    }

    // Release handle.
    CloseHandle(handle);

    // Return result to caller.
    return result;
}

#else // _WIN32

bool createFile(const fs::path &path, const void *data, const size_t data_length)
{
    ofstream ostream(path, ios::binary);

    LOG_verbose << "Creating local data file at " << path_u8string(path) << ", length "
                << data_length;

    ostream.write(reinterpret_cast<const char*>(data), static_cast<std::streamsize>(data_length));

    return ostream.good();
}

#endif // ! _WIN32

bool createFile(const fs::path &path, const std::string &data)
{
    return createFile(path, data.data(), data.size());
}

bool createFile(const fs::path& path, const std::string& data, std::chrono::seconds delta)
{
    if (!createFile(path, data)) return false;

    std::error_code result;
    auto current = fs::last_write_time(path, result);

    if (result) return false;

    fs::last_write_time(path, current + delta, result);

    return !result;
}

std::string randomData(const std::size_t length)
{
    std::vector<uint8_t> data(length);

    std::generate_n(data.begin(), data.size(), [](){ return (uint8_t)std::rand(); });

    return std::string((const char*)data.data(), data.size());
}

Model::ModelNode::ModelNode(const ModelNode& other)
    : type(other.type)
    , mCloudName()
    , mFsName()
    , name(other.name)
    , content(other.content)
    , kids()
    , parent()
    , changed(other.changed)
{
    for (auto& child : other.kids)
    {
        addkid(child->clone());
    }
}

Model::ModelNode& Model::ModelNode::fsName(const string& name)
{
    return mFsName = name, *this;
}

const string& Model::ModelNode::fsName() const
{
    return mFsName.empty() ? name : mFsName;
}

Model::ModelNode& Model::ModelNode::cloudName(const string& name)
{
    return mCloudName = name, *this;
}

const string& Model::ModelNode::cloudName() const
{
    return mCloudName.empty() ? name : mCloudName;
}

void Model::ModelNode::generate(const fs::path& path, bool force)
{
    const fs::path ourPath = path / fsName();

    if (type == file)
    {
        if (changed || force)
        {
            ASSERT_TRUE(createFile(ourPath, content))
                << "Couldn't generate model file: " << path_u8string(ourPath);

            changed = false;
        }
    }
    else
    {
        fs::create_directory(ourPath);

        for (auto& child : kids)
        {
            child->generate(ourPath, force);
        }
    }
}

string Model::ModelNode::path() const
{
    string s;
    for (auto p = this; p; p = p->parent)
        s = "/" + p->name + s;
    return s;
}

string Model::ModelNode::fsPath() const
{
    string s;
    for (auto p = this; p; p = p->parent)
        s = "/" + p->fsName() + s;
    return s;
}

Model::ModelNode* Model::ModelNode::addkid()
{
    return addkid(std::make_unique<ModelNode>());
}

Model::ModelNode* Model::ModelNode::addkid(unique_ptr<ModelNode>&& p)
{
    p->parent = this;
    kids.emplace_back(std::move(p));

    return kids.back().get();
}

bool Model::ModelNode::typematchesnodetype(nodetype_t nodetype) const
{
    switch (type)
    {
    case file: return nodetype == FILENODE;
    case folder: return nodetype == FOLDERNODE;
    }
    return false;
}

void Model::ModelNode::print(string prefix)
{
    out() << prefix << name;
    prefix.append(name).append("/");
    for (const auto &in: kids)
    {
        in->print(prefix);
    }
}

std::unique_ptr<Model::ModelNode> Model::ModelNode::clone()
{
    return std::make_unique<ModelNode>(*this);
}

Model::Model()
    : root(makeModelSubfolder("root"))
{
}

Model::Model(const Model& other)
    : root(other.root->clone())
{
}

Model& Model::operator=(const Model& rhs)
{
    Model temp(rhs);

    swap(temp);

    return *this;
}

Model::ModelNode* Model::addfile(const string& path, const string& content)
{
    auto* node = addnode(path, ModelNode::file);

    node->content = content;
    node->changed = true;

    return node;
}

Model::ModelNode* Model::addfile(const string& path)
{
    return addfile(path, path);
}

Model::ModelNode* Model::addfolder(const string& path)
{
    return addnode(path, ModelNode::folder);
}

Model::ModelNode* Model::addnode(const string& path, ModelNode::nodetype type)
{
    ModelNode* child;
    ModelNode* node = root.get();
    string name;
    size_t current = 0;
    size_t end = path.size();

    while (current < end)
    {
        size_t delimiter = path.find('/', current);

        if (delimiter == path.npos)
        {
            break;
        }

        name = path.substr(current, delimiter - current);

        if (!(child = childnodebyname(node, name)))
        {
            child = node->addkid();

            child->name = name;
            child->type = ModelNode::folder;
        }

        assert(child->type == ModelNode::folder);

        current = delimiter + 1;
        node = child;
    }

    assert(current < end);

    name = path.substr(current);

    if (!(child = childnodebyname(node, name)))
    {
        child = node->addkid();

        child->name = name;
        child->type = type;
    }

    assert(child->type == type);

    return child;
}

Model::ModelNode* Model::copynode(const string& src, const string& dst)
{
    const ModelNode* source = findnode(src);
    ModelNode* destination = addnode(dst, source->type);

    destination->content = source->content;
    destination->kids.clear();

    for (auto& child : source->kids)
    {
        destination->addkid(child->clone());
    }

    return destination;
}

unique_ptr<Model::ModelNode> Model::makeModelSubfolder(const string& utf8Name)
{
    unique_ptr<ModelNode> n(new ModelNode);
    n->name = utf8Name;
    return n;
}

unique_ptr<Model::ModelNode> Model::makeModelSubfile(const string& utf8Name, string content)
{
    unique_ptr<ModelNode> n(new ModelNode);
    n->name = utf8Name;
    n->type = ModelNode::file;
    n->content = content.empty() ? utf8Name : std::move(content);
    return n;
}

unique_ptr<Model::ModelNode> Model::buildModelSubdirs(const string& prefix, int n, int recurselevel, int filesperdir)
{
    if (suppressfiles) filesperdir = 0;

    unique_ptr<ModelNode> nn = makeModelSubfolder(prefix);

    for (int i = 0; i < filesperdir; ++i)
    {
        nn->addkid(makeModelSubfile("file" + to_string(i) + "_" + prefix));
    }

    if (recurselevel > 0)
    {
        for (int i = 0; i < n; ++i)
        {
            unique_ptr<ModelNode> sn = buildModelSubdirs(prefix + "_" + to_string(i), n, recurselevel - 1, filesperdir);
            sn->parent = nn.get();
            nn->addkid(std::move(sn));
        }
    }
    return nn;
}

Model::ModelNode* Model::childnodebyname(ModelNode* n, const std::string& s)
{
    for (auto& m : n->kids)
    {
        if (m->name == s)
        {
            return m.get();
        }
    }
    return nullptr;
}

Model::ModelNode* Model::findnode(string path, ModelNode* startnode)
{
    ModelNode* n = startnode ? startnode : root.get();
    while (n && !path.empty())
    {
        auto pos = path.find("/");
        n = childnodebyname(n, path.substr(0, pos));
        path.erase(0, pos == string::npos ? path.size() : pos + 1);
    }
    return n;
}

unique_ptr<Model::ModelNode> Model::removenode(const string& path)
{
    ModelNode* n = findnode(path);
    if (n && n->parent)
    {
        unique_ptr<ModelNode> extracted;
        ModelNode* parent = n->parent;
        auto newend = std::remove_if(parent->kids.begin(), parent->kids.end(), [&extracted, n](unique_ptr<ModelNode>& v) { if (v.get() == n) return extracted = std::move(v), true; else return false; });
        parent->kids.erase(newend, parent->kids.end());
        return extracted;
    }
    return nullptr;
}

bool Model::movenode(const string& sourcepath, const string& destpath)
{
    ModelNode* source = findnode(sourcepath);
    ModelNode* dest = findnode(destpath);
    if (source && source && source->parent && dest)
    {
        auto replaced_node = removenode(destpath + "/" + source->name);

        unique_ptr<ModelNode> n;
        ModelNode* parent = source->parent;
        auto newend = std::remove_if(parent->kids.begin(), parent->kids.end(), [&n, source](unique_ptr<ModelNode>& v) { if (v.get() == source) return n = std::move(v), true; else return false; });
        parent->kids.erase(newend, parent->kids.end());
        if (n)
        {
            dest->addkid(std::move(n));
            return true;
        }
    }
    return false;
}

bool Model::movetosynctrash(unique_ptr<ModelNode>&& node, const string& syncrootpath)
{
    ModelNode* syncroot;
    if (!(syncroot = findnode(syncrootpath)))
    {
        return false;
    }

    ModelNode* trash;
    if (!(trash = childnodebyname(syncroot, DEBRISFOLDER)))
    {
        auto uniqueptr = makeModelSubfolder(DEBRISFOLDER);
        trash = uniqueptr.get();
        syncroot->addkid(std::move(uniqueptr));
    }

    char today[50];
    auto rawtime = time(NULL);
    strftime(today, sizeof today, "%F", localtime(&rawtime));

    ModelNode* dayfolder;
    if (!(dayfolder = findnode(today, trash)))
    {
        auto uniqueptr = makeModelSubfolder(today);
        dayfolder = uniqueptr.get();
        trash->addkid(std::move(uniqueptr));
    }

    dayfolder->addkid(std::move(node));

    return true;
}

bool Model::movetosynctrash(const string& path, const string& syncrootpath)
{
    if (auto node = removenode(path))
        return movetosynctrash(std::move(node), syncrootpath);

    return false;
}

void Model::ensureLocalDebrisTmpLock(const string& syncrootpath)
{
    // if we've downloaded a file then it's put in debris/tmp initially, and there is a lock file
    if (ModelNode* syncroot = findnode(syncrootpath))
    {
        ModelNode* trash;
        if (!(trash = childnodebyname(syncroot, DEBRISFOLDER)))
        {
            auto uniqueptr = makeModelSubfolder(DEBRISFOLDER);
            trash = uniqueptr.get();
            trash->fsOnly = true;
            syncroot->addkid(std::move(uniqueptr));
        }

        ModelNode* tmpfolder;
        if (!(tmpfolder = findnode("tmp", trash)))
        {
            auto uniqueptr = makeModelSubfolder("tmp");
            tmpfolder = uniqueptr.get();
            trash->addkid(std::move(uniqueptr));
        }

        ModelNode* lockfile;
        if (!(lockfile = findnode("lock", tmpfolder)))
        {
            tmpfolder->addkid(makeModelSubfile("lock"));
        }
    }
}

bool Model::removesynctrash(const string& syncrootpath, const string& subpath)
{
    if (subpath.empty())
    {
        return removenode(syncrootpath + "/" + DEBRISFOLDER) != nullptr;
    }
    else
    {
        char today[50];
        auto rawtime = time(NULL);
        strftime(today, sizeof today, "%F", localtime(&rawtime));

        return removenode(syncrootpath + "/" + DEBRISFOLDER + "/" + today + "/" + subpath) !=
               nullptr;
    }
}

void Model::emulate_rename(std::string nodepath, std::string newname)
{
    auto node = findnode(nodepath);
    ASSERT_TRUE(!!node);
    if (node) node->name = newname;
}

void Model::emulate_move(std::string nodepath, std::string newparentpath)
{
    auto removed = removenode(newparentpath + "/" + leafname(nodepath));

    ASSERT_TRUE(movenode(nodepath, newparentpath));
}

void Model::emulate_copy(std::string nodepath, std::string newparentpath)
{
    auto node = findnode(nodepath);
    auto newparent = findnode(newparentpath);
    ASSERT_TRUE(!!node);
    ASSERT_TRUE(!!newparent);
    newparent->addkid(node->clone());
}

void Model::emulate_rename_copy(std::string nodepath, std::string newparentpath, std::string newname)
{
    auto node = findnode(nodepath);
    auto newparent = findnode(newparentpath);
    ASSERT_TRUE(!!node);
    ASSERT_TRUE(!!newparent);
    auto newnode = node->clone();
    newnode->name = newname;
    newparent->addkid(std::move(newnode));
}

void Model::emulate_delete(std::string nodepath)
{
    auto removed = removenode(nodepath);
    // ASSERT_TRUE(!!removed);
}

void Model::generate(const fs::path& path, bool force)
{
    fs::create_directories(path);

    for (auto& child : root->kids)
    {
        child->generate(path, force);
    }
}

void Model::swap(Model& other)
{
    using std::swap;

    swap(root, other.root);
}


bool waitonresults(future<bool>* r1 = nullptr, future<bool>* r2 = nullptr, future<bool>* r3 = nullptr, future<bool>* r4 = nullptr)
{
    if (r1) r1->wait();
    if (r2) r2->wait();
    if (r3) r3->wait();
    if (r4) r4->wait();
    return (!r1 || r1->get()) && (!r2 || r2->get()) && (!r3 || r3->get()) && (!r4 || r4->get());
}

atomic<int> next_request_tag{ 1 << 30 };

class StateCacheValidator
{
public:
    StateCacheValidator() = default;

    // Compare a local node tree against the loaded state cache.
    bool compare(const LocalNode& root) const
    {
        // Tracks nodes to be compared.
        list<const LocalNode*> pending(1, &root);

        // Nodes that've been processed.
        std::set<uint32_t> processed;

        // Compare nodes against the state cache.
        while (!pending.empty())
        {
            // Get our hands on the node.
            auto& node = *pending.front();

            // Node's being processed.
            pending.pop_front();

            // Track which IDs we've processed.
            if (node.dbid)
                processed.emplace(node.dbid);

            // Does the node represent a file?
            if (node.type == FILENODE)
            {
                // Is it consistent with the cache?
                if (!matchFile(node))
                    return false;

                // No further work necessary.
                continue;
            }

            // Node represents a directory.
            //
            // Is it consistent with the cache?
            if (!matchDirectory(node))
                return false;

            // Queue children.
            for (auto& childIt : node.children)
            {
                // But only those that've been written to disk.
                if (childIt.second->dbid)
                    pending.emplace_back(childIt.second);
            }
        }

        if (processed.size() != mNodeMap.size())
        {
            LOG_verbose << "StateCacheValidator::compare: processed node list size("
                        << processed.size() << ") does not match with mNodeMap size("
                        << mNodeMap.size() << ")";
            return false;
        }

        return true;
    }

    // Load a state cache from disk.
    bool load(MegaClient& client, const string& name)
    {
        constexpr auto flags = DB_OPEN_FLAG_TRANSACTED;

        if (!client.dbaccess)
            return false;

        // Convenience.
        auto& dbAccess = *client.dbaccess;
        auto& fsAccess = *client.fsaccess;
        auto& rng = client.rng;

        // Try and open the state cache.
        DbTablePtr db(dbAccess.open(rng, fsAccess, name, flags, nullptr));

        // Try and load the state cache.
        return db && read(*db, client.key);
    }

    // Translate the loaded state cache into a DOT diagram.
    string toDot() const
    {
        // No nodes? No graph.
        if (mNodeMap.empty())
            return "digraph {}\n";

        ostringstream ostream;

        // Emit DOT prologue.
        ostream << "digraph {\n";

        // Emit root node.
        ostream << "\t0 [ label=\"root\" ];\n";

        // Emit nodes.
        for (auto& i : mNodeMap)
        {
            auto& node = *i.second;

            // Node.
            ostream << "\t"
                    << node.dbid
                    << " [ label=\""
                    << node.localname.toPath(false)
                    << "\" ];\n";

            // Parent link.
            ostream << "\t"
                    << node.dbid
                    << " -> "
                    << node.parentID
                    << ";\n";
        }

        // Emit DOT epilogue.
        ostream << "}\n";

        return ostream.str();
    }

private:
    struct StateCacheNode
      : public LocalNodeCore
    {
        // Dummy implementation.
        bool serialize(string* destination) const override
        {
            return write(*destination, parentID);
        }

        // Useful for debugging purposes.
        uint32_t parentID = 0u;
    }; // StateCacheNode

    // Convenience.
    using StateCacheNodePtr = unique_ptr<StateCacheNode>;

    // Check if a directory node is consistent with the cache.
    bool matchDirectory(const LocalNode& node) const
    {
        static const std::set<uint32_t> empty;

        assert(node.dbid || !node.parent);
        assert(node.parent || !node.dbid);

        if (node.parent && !matchGeneral(node))
        {
            LOG_verbose << "matchDirectory: node's attributes are not consistent with cache";
            return false;
        }

        // What children does this node have in the cache?
        auto* children = &empty;

        if (mNodeChildMap.count(node.dbid))
            children = &mNodeChildMap.at(node.dbid);

        // Is the node's parent-child linkage consistent with the cache?
        size_t nChildren = 0;

        for (auto& childIt : node.children)
        {
            auto& child = *childIt.second;

            // Skip children that haven't been written to disk.
            if (!child.dbid)
                continue;

            // Is the child present in the cache?
            if (!children->count(child.dbid))
            {
                LOG_verbose << "matchDirectory: " << node.getLocalPath().toPath(false)
                            << ", child not present in the cache("
                            << child.getLocalPath().toPath(false) << ")";
                return false;
            }

            ++nChildren;
        }

        // Is the node's child count consistent with the cache?
        if (children->size() != nChildren)
        {
            LOG_verbose << "matchDirectory: " << node.getLocalPath().toPath(false)
                        << ", children size (" << children->size()
                        << ") does not match with nChildren value (" << nChildren << ")";
            return false;
        }

        return true;
    }

    // Check if a file node is consistent with the cache.
    bool matchFile(const LocalNode& node) const
    {
        assert(node.dbid);
        assert(node.parent);

        // Are the node's attributes consistent with the cache?
        if (!matchGeneral(node))
            return false;

        const std::string nodeReportStr{"matchFile: " + node.getLocalPath().toPath(false) + ". "};

        // Convenience.
        auto& entry = *mNodeMap.at(node.dbid);

        // This attribute is only meaningful for files.
        auto& lfp = node.syncedFingerprint;
        auto& rfp = entry.syncedFingerprint;

        if (lfp.isvalid != rfp.isvalid)
        {
            LOG_verbose << nodeReportStr << "LocalNode lfp.isvalid (" << lfp.isvalid
                        << ") does not match with rfp.isvalid value (" << rfp.isvalid << ")";
            return false;
        }

        if (lfp.isvalid && lfp != rfp)
        {
            LOG_verbose << nodeReportStr << "LocalNode lfp (" << lfp.isvalid
                        << ") does not match with rfp value (" << rfp.isvalid << ")";
            return false;
        }

        return true;
    }

    // Check if a node is consistent with the cache.
    bool matchGeneral(const LocalNode& node) const
    {
        assert(node.dbid);
        assert(node.parent);
        std::string nodeReportStr{"matchGeneral: " < node.getLocalPath().toPath(false) + ". "};

        // Is the node in the cache?
        if (!mNodeMap.count(node.dbid))
        {
            LOG_verbose << nodeReportStr + "Node is not in cache";
            return false;
        }

        // Convenience.
        auto& entry = *mNodeMap.at(node.dbid);

        // Compare serialized attributes.
        if (node.type != entry.type)
        {
            LOG_verbose << nodeReportStr << "LocalNode type (" << node.type
                        << ") does not match with StateCacheNode value (" << entry.type << ")";
            return false;
        }

        if (node.parent->dbid != entry.parentID)
        {
            LOG_verbose << nodeReportStr << "LocalNode parentID (" << node.parent->dbid
                        << ") does not match with StateCacheNode value (" << entry.parentID << ")";
            return false;
        }

        if (node.fsid_lastSynced != entry.fsid_lastSynced)
        {
            LOG_verbose << nodeReportStr << "LocalNode fsid_lastSynced (" << node.fsid_lastSynced
                        << ") does not match with StateCacheNode value (" << entry.fsid_lastSynced
                        << ")";
            return false;
        }

        if (node.localname != entry.localname)
        {
            LOG_verbose << nodeReportStr << "LocalNode localname (" << node.localname
                        << ") does not match with StateCacheNode value (" << entry.localname << ")";
            return false;
        }

        if (!node.slocalname != !entry.slocalname)
        {
            LOG_verbose << nodeReportStr << "LocalNode !slocalname (" << !node.slocalname
                        << ") does not match with StateCacheNode value (" << !entry.slocalname
                        << ")";
            return false;
        }

        if (node.slocalname && *node.slocalname != *entry.slocalname)
        {
            LOG_verbose << nodeReportStr << "LocalNode slocalname (" << *node.slocalname
                        << ") does not match with StateCacheNode value (" << *entry.slocalname
                        << ")";
            return false;
        }

        if (node.syncedCloudNodeHandle != entry.syncedCloudNodeHandle)
        {
            LOG_verbose << nodeReportStr << "LocalNode syncedCloudNodeHandle ("
                        << Base64Str<MegaClient::NODEHANDLE>(node.syncedCloudNodeHandle.as8byte())
                        << ") does not match with StateCacheNode value ("
                        << Base64Str<MegaClient::NODEHANDLE>(entry.syncedCloudNodeHandle.as8byte())
                        << ")";
            return false;
        }

        return true;
    }

    // Read a state cache's contents into memory.
    bool read(DbTable& db, SymmCipher& key)
    {
        // Convenience.
        using std::make_unique;
        using std::swap;

        // Parent-child relationships.
        map<uint32_t, set<uint32_t>> children;

        // Database ID of a serialized node.
        uint32_t id;

        // Serialized metadata representing a node.
        string metadata;

        // Deserialized nodes.
        map<uint32_t, StateCacheNodePtr> nodes;

        // Tracks pending parents.
        set<uint32_t> pending;

        // Make sure we're reading from the start.
        db.rewind();

        // Read and deserialize metadata from the state cache.
        while (db.next(&id, &metadata, &key))
        {
            auto node = std::make_unique<StateCacheNode>();

            // Try and deserialize the node.
            if (!node->read(metadata, node->parentID))
                return false;

            // Inject database ID.
            node->dbid = id;

            // Orphaned children are reunited with their parent.
            pending.erase(id);

            // Convenience.
            auto parentID = node->parentID;

            // Establish parent-child link.
            children[parentID].emplace(id);

            // Add node to the database.
            nodes.emplace(id, std::move(node));

            // Potential orphan?
            if (!parentID || !mNodeMap.count(parentID))
                continue;

            // Track potential orphans.
            pending.emplace(parentID);
        }

        // Have all children been linked?
        assert(pending.empty());

        // Swap loaded metadata into place.
        swap(children, mNodeChildMap);
        swap(nodes, mNodeMap);

        return true;
    }

    // Tracks the parent-child relationships of loaded nodes.
    map<uint32_t, set<uint32_t>> mNodeChildMap;

    // Node metadata loaded from the state cache.
    map<uint32_t, StateCacheNodePtr> mNodeMap;
}; // StateCacheValidator

CloudItem::CloudItem(const Node* node)
  : CloudItem(*node)
{
}

CloudItem::CloudItem(const Node& node)
  : mNodeHandle(node.nodeHandle())
  , mPath()
  , mFromRoot(false)
{
}

CloudItem::CloudItem(const string& path, bool fromRoot)
  : CloudItem(path.c_str(), fromRoot)
{
}

CloudItem::CloudItem(const char* path, bool fromRoot)
  : mNodeHandle()
  , mPath(path)
  , mFromRoot(fromRoot)
{
    if (mFromRoot && path && *path == '/')
        mPath.erase(0, 1);
}

CloudItem::CloudItem(const NodeHandle& nodeHandle)
  : mNodeHandle(nodeHandle)
  , mPath()
  , mFromRoot()
{
}

CloudItem::CloudItem(handle nodeHandle)
  : CloudItem(NodeHandle().set6byte(nodeHandle))
{
}

std::shared_ptr<Node> CloudItem::resolve(StandardClient& client) const
{
    if (!mNodeHandle.isUndef())
        return client.client.nodeByHandle(mNodeHandle);

    auto root = client.gettestbasenode();

    if (mFromRoot)
        root = client.getcloudrootnode();

    return client.drillchildnodebyname(root, mPath);
}

StandardClientInUse ClientManager::getCleanStandardClient(int loginIndex, fs::path workingFolder)
{
    EXPECT_GE(loginIndex, 0) << "ClientManager::getCleanStandardClient(): negative client index requested";
    EXPECT_LE(loginIndex, getEnvVarAccounts().size()) << "ClientManager::getCleanStandardClient(): invalid client index requested";

    for (auto i = clients[loginIndex].begin(); i != clients[loginIndex].end(); ++i)
    {
        if (!i->inUse)
        {
            i->ptr->cleanupForTestReuse(loginIndex);
            i->ptr->fsBasePath = i->ptr->ensureDir(workingFolder / u8path_compat(i->name));
            return StandardClientInUse(i);
        }
    }

    // otherwise, make a new one
    string clientname = std::to_string(loginIndex) + "_" + std::to_string(clients[loginIndex].size());
    fs::path localAccountRoot = makeReusableClientFolder(clientname);
    shared_ptr<StandardClient> c(
            new StandardClient(localAccountRoot, "client" + clientname, workingFolder));

    clients[loginIndex].push_back(StandardClientInUseEntry(false, c, clientname, loginIndex));
    const auto& [emailVarName, passVarName] =
        getEnvVarAccounts().getVarNames(static_cast<size_t>(loginIndex));
    c->login_reset(emailVarName, passVarName, false, false);

    c->cleanupForTestReuse(loginIndex);

    return StandardClientInUse(--clients[loginIndex].end());
}

ClientManager::~ClientManager()
{
    clear();
}

void ClientManager::clear()
{
    if (clients.empty())
        return;

    while (clients.size())
    {
        LOG_debug << "Shutting down ClientManager, remaining: " << clients.size();
        clients.erase(clients.begin());
    }
    LOG_debug << "ClientManager shutdown complete";
}

bool StandardSyncController::call(const Callback& callback,
                                  const LocalPath& path) const
{
    std::lock_guard<std::mutex> guard(mLock);

    if (callback)
        return callback(u8path_compat(path.toPath(false)));

    return false;
}

void StandardSyncController::set(Callback& callback, Callback value)
{
    std::lock_guard<std::mutex> guard(mLock);

    callback = std::move(value);
}

bool StandardSyncController::deferPutnode(const LocalPath& path) const
{
    return call(mDeferPutnode, path);
}

bool StandardSyncController::deferPutnodeCompletion(const LocalPath& path) const
{
    return call(mDeferPutnodeCompletion, path);
}

bool StandardSyncController::deferUpload(const LocalPath& path) const
{
    return call(mDeferUpload, path);
}

void StandardSyncController::setDeferPutnodeCallback(Callback callback)
{
    set(mDeferPutnode, std::move(callback));
}

void StandardSyncController::setDeferPutnodeCompletionCallback(Callback callback)
{
    set(mDeferPutnodeCompletion, std::move(callback));
}

void StandardSyncController::setDeferUploadCallback(Callback callback)
{
    set(mDeferUpload, std::move(callback));
}

void StandardClient::ResultProc::prepresult(resultprocenum rpe, int tag, std::function<void()>&& requestfunc, std::function<bool(error)>&& f, handle h)
{
    if (rpe != COMPLETION)
    {
        lock_guard<recursive_mutex> g(mtx);
        auto& perTypeTags = m[rpe];
        assert(perTypeTags.find(tag) == perTypeTags.end());
        perTypeTags.emplace(tag, id_callback(std::move(f), tag, h));
    }

    std::lock_guard<std::recursive_mutex> lg(client.clientMutex);

    assert(tag > 0);
    int oldtag = client.client.reqtag;
    client.client.reqtag = tag;
    requestfunc();
    client.client.reqtag = oldtag;
    LOG_debug << "tag-result prepared for operation " << rpe << " tag " << tag;

    client.client.waiter->notify();
}

void StandardClient::ResultProc::processresult(resultprocenum rpe, error e, handle, int tag)
{
    if (tag == 0 && rpe != CATCHUP)
    {
        //out() << "received notification of SDK initiated operation " << rpe << " tag " << tag; // too many of those to output
        return;
    }

    if (tag < (2 << 30))
    {
        out() << "ignoring callback from SDK internal sync operation " << rpe << " tag " << tag;
        return;
    }

    lock_guard<recursive_mutex> g(mtx);
    auto& entry = m[rpe];

    if (rpe == CATCHUP)
    {
        while (!entry.empty())
        {
            entry.begin()->second.f(e);
            entry.erase(entry.begin());
        }
        return;
    }

    if (entry.empty())
    {
        //out() << client.client.clientname
        //      << "received notification of operation type " << rpe << " completion but we don't have a record of it.  tag: " << tag;
        return;
    }

    auto it = entry.find(tag);
    if (it == entry.end())
    {
        out() << client.client.clientname
              << "tag not found for operation completion of " << rpe << " tag " << tag;
        return;
    }

    if (it->second.f(e))
    {
        entry.erase(it);
    }
}

string StandardClient::ensureDir(const fs::path& p)
{
    fs::create_directories(p);

    string result = path_u8string(p);

    if (result.back() != fs::path::preferred_separator)
    {
        result += fs::path::preferred_separator;
    }

    return result;
}

void StandardClient::setMinimumUploadThrottleSettings()
{
    const auto uploadThrottlingManager = std::make_shared<UploadThrottlingManager>();
    const auto throttleValueLimits = uploadThrottlingManager->throttleValueLimits();

    const auto throttleUpdateRate = throttleValueLimits.throttleUpdateRateLowerLimit;
    if (!uploadThrottlingManager->setThrottleUpdateRate(throttleUpdateRate))
    {
        LOG_warn << "[StandardClient::setMinimumUploadThrottleSettings] Operation to set the "
                    "upload throttle update rate to "
                 << throttleUpdateRate.count() << " secs has failed";
        return;
    }

    const auto maxUploadsBeforeThrottle = throttleValueLimits.maxUploadsBeforeThrottleUpperLimit;
    if (!uploadThrottlingManager->setMaxUploadsBeforeThrottle(maxUploadsBeforeThrottle))
    {
        LOG_warn << "[StandardClient::setMinimumUploadThrottleSettings] Operation to set the max "
                    "uploads before throttle to "
                 << maxUploadsBeforeThrottle << " has failed";
        return;
    }

    LOG_debug << "[StandardClient::setMinimumUploadThrottleSettings] throttleUpdateRate: "
              << throttleUpdateRate.count()
              << " secs, maxUploadsBeforeThrottle: " << maxUploadsBeforeThrottle;

    std::promise<error> setThrottlingManagerPromise;
    client.setSyncUploadThrottlingManager(uploadThrottlingManager,
                                          [&setThrottlingManagerPromise](const error e)
                                          {
                                              setThrottlingManagerPromise.set_value(e);
                                          });

    auto setThrottlingManagerFuture = setThrottlingManagerPromise.get_future();
    if (setThrottlingManagerFuture.wait_for(DEFAULTWAIT) != std::future_status::ready)
    {
        LOG_warn << "[StandardClient::setMinimumUploadThrottleSettings] Operation to update the "
                    "upload throttling manager with "
                    "minimum values has timed out!";
        return;
    }

    if (const auto result = setThrottlingManagerFuture.get(); result != API_OK)
    {
        LOG_warn << "[StandardClient::setThrottleUpdateRateToLowestValue] Operation to update "
                    "the upload throttling manager failed with "
                 << result;
    }
}

StandardClient::StandardClient(const fs::path& basepath,
                               const string& name,
                               const fs::path& workingFolder):
    waiter(new WAIT_CLASS),
#ifdef GFX_CLASS
    gfx(std::make_unique<GFX_CLASS>()),
#endif
    client_dbaccess_path(ensureDir(basepath / name)),
    httpio(new CurlHttpIO),
    client(this,
           waiter,
           httpio.get(),
#ifdef DBACCESS_CLASS
           new DBACCESS_CLASS(LocalPath::fromAbsolutePath(client_dbaccess_path)),
#else
           NULL,
#endif
#ifdef GFX_CLASS
           &gfx,
#else
           NULL,
#endif
           USER_AGENT.c_str(),
           THREADS_PER_MEGACLIENT),
    clientname(name + " "),
    resultproc(*this),
    clientthread(
        [this]()
        {
            threadloop();
        })
{
    client.clientname = clientname + " ";
    client.syncs.mDetailedSyncLogging = true;
    g_netLoggingOn = true;
#ifdef GFX_CLASS
    gfx.startProcessingThread();
#endif

    if (workingFolder.empty())
    {
        fsBasePath = basepath / u8path_compat(name);
    }
    else
    {
        fsBasePath = ensureDir(workingFolder / u8path_compat(name));
    }

    // SyncTests want to skip backup restrictions, so they are not
    // restricted to the path "Vault/My backups/<device>/<backup>"
    client.syncs.mBackupRestrictionsEnabled = false;

    setMinimumUploadThrottleSettings();
}

StandardClient::~StandardClient()
{
    LOG_debug << "StandardClient exiting";

    // Make sure logout completes before we escape.
    logout(false);

    LOG_debug << "~StandardClient final logout complete";

    clientthreadexit = true;
    waiter->notify();
    clientthread.join();
    LOG_debug << "~StandardClient end of function (work thread joined)";
}

void StandardClient::localLogout()
{
    auto result =
        thread_do<bool>([](MegaClient& mc, PromiseBoolSP result)
                        {
                            mc.locallogout(false, true);
                            result->set_value(true);
                        },
                        __FILE__, __LINE__);

    // Make sure logout completes before we escape.
    result.get();
}

bool StandardClient::logout(bool keepSyncsConfigFile)
{
    auto result = thread_do<bool>([=](MegaClient& client, PromiseBoolSP result) {
        client.logout(keepSyncsConfigFile, [=](error e) {
            result->set_value(e == API_OK);
        });
    }, __FILE__, __LINE__);

    if (result.wait_for(DEFAULTWAIT) == future_status::timeout)
        return false;

    return result.get();
}

string StandardClient::lp(LocalNode* ln) { return ln->getLocalPath().toName(*client.fsaccess); }

void StandardClient::onCallback() { lastcb = chrono::steady_clock::now(); };

void StandardClient::sync_added(const SyncConfig& config)
{
    onCallback();

    if (logcb)
    {
        lock_guard<mutex> guard(om);

        out() << clientname
                << "sync_added(): id: "
                << toHandle(config.mBackupId);
    }

    if (onAutoResumeResult)
    {
        onAutoResumeResult(config);
    }
}

void StandardClient::sync_removed(const SyncConfig& config)
{
    onCallback();

    if (logcb)
    {
        lock_guard<mutex> guard(om);

        out() << clientname << "sync_removed(): id: " << toHandle(config.mBackupId);
    }

    if (onRemovedSync)
    {
        onRemovedSync(config);
    }
}

void StandardClient::syncs_restored(SyncError syncError)
{
    lock_guard<mutex> g(om);

    out() << clientname
            << "sync restore complete: "
            << SyncConfig::syncErrorToStr(syncError);

    received_syncs_restored = true;
}

void StandardClient::nodes_updated(sharedNode_vector* nodes, int numNodes)
{
    if (!nodes)
    {
        out() << clientname << "nodes_updated: total reset.  total node count now: " << numNodes;
        return;
    }
    if (logcb)
    {
        lock_guard<mutex> g(om);
        if (numNodes > 1) // output root of sync (the second node) for tracing
        {
            out() << clientname << "nodes_updated: received " << numNodes << " including " << nodes->at(0)->displaypath() << " " << nodes->at(1)->displaypath();
        }
        else
        {
            out() << clientname << "nodes_updated: received " << numNodes << " including " << nodes->at(0)->displaypath();
        }
    }
    received_node_actionpackets = true;
    nodes_updated_cv.notify_all();
}

bool StandardClient::waitForNodesUpdated(unsigned numSeconds)
{
    mutex nodes_updated_cv_mutex;
    std::unique_lock<mutex> g(nodes_updated_cv_mutex);
    nodes_updated_cv.wait_for(g, std::chrono::seconds(numSeconds),
                                [&](){ return received_node_actionpackets.load(); });
    return received_node_actionpackets;
}

void StandardClient::syncupdate_stateconfig(const SyncConfig& config)
{
    onCallback();

    if (logcb)
    {
        lock_guard<mutex> g(om);

        out() << clientname << "syncupdate_stateconfig() " << toHandle(config.mBackupId);
    }

    if (mOnSyncStateConfig)
        mOnSyncStateConfig(config);
}

void StandardClient::syncupdate_treestate(const SyncConfig& config,
                                          const LocalPath& localPath,
                                          treestate_t treeState,
                                          nodetype_t type)
{
    onCallback();

    if (logcb)
    {
        lock_guard<mutex> g(om);

        out() << clientname << "syncupdate_stateconfig() " << toHandle(config.mBackupId);
    }

    if (mOnSyncTreeState)
        mOnSyncTreeState(config, localPath, treeState, type);
}

void StandardClient::useralerts_updated(UserAlert::Base** /*alerts*/, int numAlerts)
{
    if (logcb)
    {
        lock_guard<mutex> guard(om);

        out() << clientname
              << "useralerts_updated: received "
              << numAlerts;
    }

    received_user_alerts = true;
    user_alerts_updated_cv.notify_all();
}

bool StandardClient::waitForUserAlertsUpdated(unsigned numSeconds)
{
    std::mutex mutex;
    std::unique_lock<std::mutex> guard(mutex);

    user_alerts_updated_cv.wait_for(guard, std::chrono::seconds(numSeconds), [&] {
        return received_user_alerts.load();
    });

    return received_user_alerts;
}

void StandardClient::users_updated(User** users , int size)
{
    if (!users) // All users have changed, notification just after fetchnodes
    {
        return;
    }

    //  If none lambda is register with createsOnUserUpdateLamda, any user action package generate and event for stop waiting period
    if (!mCheckUserChange)
    {
        lock_guard<mutex> g(user_actionpackets_mutex);
        received_user_actionpackets = true;
        user_updated_cv.notify_all();
    }
    else
    {
        std::lock_guard<std::mutex> g(mUserActionPackageMutex);
        for (int i = 0; i < size; i++)
        {
            if (mCheckUserChange(users[i]))
            {
                lock_guard<mutex> g(user_actionpackets_mutex);
                received_user_actionpackets = true;
                user_updated_cv.notify_all();
            }
        }
    }

}

bool StandardClient::waitForUserUpdated(unsigned int numSeconds)
{
    std::unique_lock<std::mutex> guard(user_actionpackets_mutex);

    user_updated_cv.wait_for(guard, std::chrono::seconds(numSeconds), [&] {
        return received_user_actionpackets.load();
    });

    return received_user_actionpackets;
}

void StandardClient::createsOnUserUpdateLamda(std::function<bool(User*)> onUserUpdateLambda)
{
    std::lock_guard<std::mutex> g(mUserActionPackageMutex);
    mCheckUserChange = onUserUpdateLambda;
    received_user_actionpackets = false;
}

void StandardClient::removeOnUserUpdateLamda()
{
    std::lock_guard<std::mutex> g(mUserActionPackageMutex);
    mCheckUserChange = nullptr;
    received_user_actionpackets = false;
}

void StandardClient::syncupdate_scanning(bool b)
{
    if (logcb)
    {
        onCallback();

        lock_guard<mutex> g(om);

        out() << clientname << "syncupdate_scanning()" << b;
    }
}

void StandardClient::syncupdate_conflicts(bool state)
{
    if (logcb)
    {
        onCallback();

        lock_guard<mutex> guard(om);

        out() << clientname << "syncupdate_conflicts()" << state;
    }

    mConflictsDetected.store(state);

    if (mOnConflictsDetected)
        mOnConflictsDetected(state);
}

void StandardClient::syncupdate_stalled(bool state)
{
    if (logcb)
    {
        onCallback();

        lock_guard<mutex> g(om);

        out() << clientname << "syncupdate_stalled()" << state;
    }

    mStallDetected.store(state);

    if (mOnStall)
        mOnStall(state);
}

void StandardClient::syncupdate_totalconflicts(bool state)
{
    if (logcb)
    {
        onCallback();

        lock_guard<mutex> guard(om);

        out() << clientname << "syncupdate_totalconflicts()" << state;
    }

    mTotalConflictsUpdated.store(state);

    if (mOnTotalConflictsUpdate)
        mOnTotalConflictsUpdate(state);
}

void StandardClient::syncupdate_totalstalls(bool state)
{
    if (logcb)
    {
        onCallback();

        lock_guard<mutex> g(om);

        out() << clientname << "syncupdate_totalstalls()" << state;
    }

    mTotalStallsUpdated.store(state);

    if (mOnTotalStallsUpdate)
        mOnTotalStallsUpdate(state);
}

bool StandardClient::isUserAttributeSet(attr_t attr, unsigned int numSeconds, error& err)
{
    std::recursive_mutex attr_cv_mutex;
    std::condition_variable_any user_attribute_updated_cv;
    bool attrIsSet = false;
    std::atomic_bool replyReceived{false};
    auto  completionErr = [&](error e)
    {
        std::lock_guard<std::recursive_mutex> g(attr_cv_mutex);
        err = e;
        LOG_debug << "attr: " << attr << " error: " << err;
        replyReceived = true;
        user_attribute_updated_cv.notify_one();
    };

    auto completionBytes = [&](::mega::byte*, unsigned, attr_t)
    {
        std::lock_guard<std::recursive_mutex> g(attr_cv_mutex);
        err = API_OK;
        LOG_debug << "attr: " << attr << " is set";
        replyReceived = true;
        attrIsSet = true;
        user_attribute_updated_cv.notify_one();
    };

    auto completionTLV = [&](unique_ptr<string_map>, attr_t)
    {
        std::lock_guard<std::recursive_mutex> g(attr_cv_mutex);
        err = API_OK;
        LOG_debug << "attr: " << attr << " is set";
        replyReceived = true;
        attrIsSet = true;
        user_attribute_updated_cv.notify_one();
    };

    std::unique_lock<std::recursive_mutex> g(attr_cv_mutex);
    resultproc.prepresult(COMPLETION, ++next_request_tag,
        [&](){
            client.getua(client.ownuser(), attr, -1, completionErr, completionBytes, completionTLV);
        }, nullptr);


    user_attribute_updated_cv.wait_for(g, std::chrono::seconds(numSeconds), [&replyReceived](){ return replyReceived.load(); });

    return attrIsSet;
}

bool StandardClient::waitForAttrMyBackupIsSet(unsigned int numSeconds, bool& newBackupIsSet)
{
    error err  = API_EINTERNAL;
    bool attrMyBackupFolderIsSet = isUserAttributeSet(attr_t::ATTR_MY_BACKUPS_FOLDER, numSeconds, err);

    if (err != API_ENOENT)
    {
        return attrMyBackupFolderIsSet;
    }

    // If attribute is not set, it's going to established
    const char* folderName = "My Backups";
    attrMyBackupFolderIsSet = false;
    std::recursive_mutex attrMyBackup_cv_mutex;
    std::condition_variable_any user_attribute_backup_updated_cv;
    std::atomic_bool replyReceived{false};
    std::unique_lock<std::recursive_mutex> g(attrMyBackup_cv_mutex);

    resultproc.prepresult(COMPLETION, ++next_request_tag,
        [&](){
            client.setbackupfolder(folderName, client.reqtag, [&](Error e)
            {
                std::lock_guard<std::recursive_mutex> g(attrMyBackup_cv_mutex);
                if (e == API_OK)
                {
                    attrMyBackupFolderIsSet = true;
                    newBackupIsSet = true;
                }
                else
                {
                    LOG_err << "Error setting backup folder user attribute";
                }

                replyReceived = true;
                user_attribute_backup_updated_cv.notify_one();
            });
        }, nullptr);


    user_attribute_backup_updated_cv.wait_for(g, std::chrono::seconds(numSeconds), [&replyReceived](){ return replyReceived.load(); });

    if (!attrMyBackupFolderIsSet) // Error setting backup folder
    {
        return false;
    }

    // Check if attribute has been established properly
    return isUserAttributeSet(attr_t::ATTR_MY_BACKUPS_FOLDER, numSeconds, err);
}

void StandardClient::file_added(File* file)
{
    if (mOnFileAdded)
    {
        mOnFileAdded(*file);
    }
}

void StandardClient::file_complete(File* file)
{
    if (mOnFileComplete)
    {
        mOnFileComplete(*file);
    }
}

void StandardClient::notify_retry(dstime /*when*/, retryreason_t reason)
{
    onCallback();

    lock_guard<mutex> guard(om);

    mRetryTracker.track(clientname, reason);
}

void StandardClient::request_error(error e)
{
    onCallback();

    if (!logcb) return;

    lock_guard<mutex> guard(om);

    out() << clientname << " request_error: " << e;
}

void StandardClient::request_response_progress(m_off_t a, m_off_t b)
{
    onCallback();

    if (!logcb) return;

    lock_guard<mutex> guard(om);

    out() << clientname << " request_response_progress: " << a << " " << b;
}

void StandardClient::updateClientDowaitDs(const dstime lastClientDoWait)
{
    if (lastClientDoWait <= 0)
        return;
    lock_guard<mutex> guard(om);
    mClientDowaitDs += lastClientDoWait;
}

dstime StandardClient::consumeClientDowaitDs(const dstime timeGranularity)
{
    if (timeGranularity <= 0)
    {
        LOG_err << "[StandardClient::consumeClientDowaitDs] timeGranularity (" << timeGranularity
                << ") should be above 0";
        assert(false &&
               "[StandardClient::consumeClientDowaitDs] timeGranularity should be above 0");
        return 0;
    }
    lock_guard<mutex> guard(om);
    const auto clientDowaitDsToReturn = mClientDowaitDs / timeGranularity;
    mClientDowaitDs -= clientDowaitDsToReturn;
    return clientDowaitDsToReturn;
}

void StandardClient::resetClientDowaitDs()
{
    lock_guard<mutex> guard(om);
    mClientDowaitDs = 0;
}

void StandardClient::threadloop()
    try
{
    while (!clientthreadexit)
    {
        int r;

        client.waiter->bumpds();
        dstime t1 = client.waiter->ds.load();

        {
            std::lock_guard<std::recursive_mutex> lg(clientMutex);

            client.waiter->bumpds();
            dstime t1a = client.waiter->ds.load();
            if (t1a - t1 > 20) LOG_debug << "lock for preparewait took ds: " << t1a - t1;

            r = client.preparewait();
        }
        assert(r == 0 || r == Waiter::NEEDEXEC);

        client.waiter->bumpds();
        dstime t2 = client.waiter->ds.load();
        if (t2 - t1 > 20) LOG_debug << "lock and preparewait took ds: " << t2 - t1;


        if (!r)
        {
            r |= client.dowait();
            assert(r == 0 || r == Waiter::NEEDEXEC);
        }

        client.waiter->bumpds();
        dstime t3 = client.waiter->ds.load();
        const auto doWaitTimeDs = t3 - t2;
        updateClientDowaitDs(doWaitTimeDs);
        if (doWaitTimeDs >= 10)
            LOG_debug << "dowait took ds: " << doWaitTimeDs;

        std::lock_guard<std::recursive_mutex> lg(clientMutex);

        client.waiter->bumpds();
        dstime t3a = client.waiter->ds.load();
        if (t3a - t3 > 20) LOG_debug << "lock for exec took ds: " << t3a - t3;

        r |= client.checkevents();
        assert(r == 0 || r == Waiter::NEEDEXEC);

        client.waiter->bumpds();
        dstime t4 = client.waiter->ds.load();
        if (t4 - t3a > 20) LOG_debug << "checkevents took ds: " << t4 - t3a;

        {
            client.waiter->bumpds();
            auto start = client.waiter->ds.load();
            std::lock_guard<mutex> g(functionDoneMutex);
            string sourcefile;
            int sourceline = -1;
            if (nextfunctionMC)
            {
                sourcefile = nextfunctionMC_sourcefile;
                sourceline = nextfunctionMC_sourceline;
                nextfunctionMC_sourcefile = "";
                nextfunctionMC_sourceline = -1;
                nextfunctionMC();
                nextfunctionMC = nullptr;
                functionDone.notify_all();
                r |= Waiter::NEEDEXEC;
            }
            if (nextfunctionSC)
            {
                sourcefile = nextfunctionSC_sourcefile;
                sourceline = nextfunctionSC_sourceline;
                nextfunctionSC_sourcefile = "";
                nextfunctionSC_sourceline = -1;
                nextfunctionSC();
                nextfunctionSC = nullptr;
                functionDone.notify_all();
                r |= Waiter::NEEDEXEC;
            }
            client.waiter->bumpds();
            auto end = client.waiter->ds.load();
            if (end - start > 200)
            {
                // note that in Debug builds (for windows at least), prep for logging in can take 15 seconds in pbkdf2.DeriveKey
                LOG_err << "test functions passed to be executed on the client thread should queue work but not wait for the results themselves. Waited ms: "
                        << end-start << " in " << sourcefile << " line " << sourceline;
                //assert(false);
            }
        }

        client.waiter->bumpds();
        dstime t5 = client.waiter->ds.load();
        if (t5 - t4 > 20) LOG_debug << "injected functions took ds: " << t5 - t4;

        if ((r & Waiter::NEEDEXEC))
        {
            client.exec();
        }

        client.waiter->bumpds();
        dstime t6 = client.waiter->ds.load();
        if (t6 - t5 > 20) LOG_debug << "exec took ds: " << t6 - t5;

    }

    // shut down on the same thread, otherwise any ongoing async I/O fails to complete (on windows)
    client.locallogout(false, true);

    out() << clientname << " thread exiting naturally";
}
catch (std::exception& e)
{
    out() << clientname << " thread exception, StandardClient " << clientname << " terminated: " << e.what();
}
catch (...)
{
    out() << clientname << " thread exception, StandardClient " << clientname << " terminated";
}

void StandardClient::preloginFromEnv(const string& userenv, PromiseBoolSP pb)
{
    const string user = Utils::getenv(userenv, "");

    ASSERT_FALSE(user.empty());

    resultproc.prepresult(PRELOGIN, ++next_request_tag,
        [&](){ client.prelogin(user.c_str()); },
        [pb](error e) { pb->set_value(!e); return true; });

}

void StandardClient::loginFromEnv(const string& userenv, const string& pwdenv, PromiseBoolSP pb)
{
    const string user = Utils::getenv(userenv, "");
    const string pwd = Utils::getenv(pwdenv, "");

    ASSERT_FALSE(user.empty());
    ASSERT_FALSE(pwd.empty());

    ::mega::byte pwkey[SymmCipher::KEYLENGTH];

    resultproc.prepresult(LOGIN, ++next_request_tag,
        [&](){
            if (client.accountversion == 1)
            {
                if (error e = client.pw_key(pwd.c_str(), pwkey))
                {
                    ASSERT_TRUE(false) << "login error: " << e;
                }
                else
                {
                    client.login(user.c_str(), pwkey);
                }
            }
            else if (client.accountversion == 2 && !salt.empty())
            {
                client.login2(user.c_str(), pwd.c_str(), &salt);
            }
            else
            {
                ASSERT_TRUE(false) << "Login unexpected error";
            }
        },
        [pb](error e) { pb->set_value(!e); return true; });

}

void StandardClient::loginFromSession(const string& session, PromiseBoolSP pb)
{
    resultproc.prepresult(LOGIN, ++next_request_tag,
        [&](){ client.login(session); },
        [pb](error e) { pb->set_value(!e);  return true; });
}

#if defined(MEGA_MEASURE_CODE) || defined(DEBUG)
void StandardClient::sendDeferredAndReset()
{
    auto futureResult = thread_do<bool>(
        [&](StandardClient&, PromiseBoolSP pb)
        {
            client.reqs.deferRequests = nullptr;
            client.reqs.sendDeferred();
            pb->set_value(true);
        },
        __FILE__,
        __LINE__);
    futureResult.get();
}
#endif

bool StandardClient::copy(const CloudItem& source,
                          const CloudItem& target,
                          const string& name,
                          VersioningOption versioningPolicy)
{
    auto result = thread_do<bool>([&](StandardClient& client, PromiseBoolSP result) {
        client.copy(source, target, name, std::move(result), versioningPolicy);
    }, __FILE__, __LINE__);

    auto status = result.wait_for(std::chrono::minutes(2));

    EXPECT_NE(status, future_status::timeout);

    if (status == future_status::timeout)
        return false;

    return result.get();
}

bool StandardClient::copy(const CloudItem& source,
                          const CloudItem& target,
                          VersioningOption versioningPolicy)
{
    return copy(source, target, string(), versioningPolicy);
}

void StandardClient::copy(const CloudItem& source,
                          const CloudItem& target,
                          string name,
                          PromiseBoolSP result,
                          VersioningOption versioningPolicy)
{
    auto sourceNode = source.resolve(*this);
    EXPECT_TRUE(sourceNode);

    if (!sourceNode)
        return result->set_value(false);

    auto targetNode = target.resolve(*this);
    EXPECT_TRUE(targetNode);

    if (!targetNode || targetNode->type == FILENODE)
        return result->set_value(false);

    // Make sure name always contains something valid.
    if (name.empty())
        name = sourceNode->displayname();

    // Make sure name is normalized.
    LocalPath::utf8_normalize(&name);

    TreeProcCopy proc;

    // Figure out how many nodes we need to copy.
    client.proctree(sourceNode, &proc, false, true);

    // Allocate and populate nodes.
    proc.allocnodes();

    client.proctree(sourceNode, &proc, false, true);

    // We need the original node's handle if we're using versioning.
    std::shared_ptr<Node> victimNode;

    if (versioningPolicy != NoVersioning)
        victimNode = client.childnodebyname(targetNode.get(), name.c_str(), true);

    if (victimNode)
        proc.nn[0].ovhandle = victimNode->nodeHandle();

    proc.nn[0].parenthandle = UNDEF;

    // Populate attributes of copied node.
    {
        SymmCipher key;

        // Load key.
        key.setkey((const ::mega::byte*)proc.nn[0].nodekey.data(), sourceNode->type);

        // Copy existing attributes.
        AttrMap attrs = sourceNode->attrs;

        // Upate the node's name.
        attrs.map['n'] = std::move(name);

        // Generate attribute string.
        string attrstring;

        attrs.getjson(&attrstring);

        // Update node's attribute string.
        client.makeattr(&key, proc.nn[0].attrstring, attrstring.c_str());
    }

    auto completion = [=](const Error& error) {
        LOG_debug << "Putnodes request completed: "
                  << error;

        EXPECT_EQ(error, API_OK);
        result->set_value(error == API_OK);
    };

    LOG_debug << "Scheduling putnodes request now...";

    client.putnodes(targetNode->nodeHandle(),
                    versioningPolicy,
                    std::move(proc.nn),
                    nullptr,
                    0,
                    false,
                    {}, // customerIpPort
                    BasicPutNodesCompletion(std::move(completion)));
}

bool StandardClient::putnodes(const CloudItem& parent,
                              VersioningOption versioningPolicy,
                              std::vector<NewNode>&& nodes)
{
    auto result = thread_do<bool>([&](StandardClient& client, PromiseBoolSP result) {
        client.putnodes(parent,
                        versioningPolicy,
                        std::move(nodes),
                        std::move(result));
    }, __FILE__, __LINE__);

    auto status = result.wait_for(std::chrono::seconds(40));

    EXPECT_NE(status, future_status::timeout);

    if (status == future_status::timeout)
        return false;

    return result.get();
}

void StandardClient::putnodes(const CloudItem& parent,
                              VersioningOption versioningPolicy,
                              std::vector<NewNode>&& nodes,
                              PromiseBoolSP result)
{
    auto node = parent.resolve(*this);
    EXPECT_TRUE(node);

    if (!node)
        return result->set_value(false);

    auto completion = BasicPutNodesCompletion([result](const Error& e) {
        LOG_debug << "Putnodes request completed: "
                  << e;

        EXPECT_EQ(e, API_OK);
        result->set_value(e == API_OK);
    });

    LOG_debug << "Scheduling putnodes request now...";

    client.putnodes(node->nodeHandle(),
                    versioningPolicy,
                    std::move(nodes),
                    nullptr,
                    0,
                    false,
                    {}, // customerIpPort
                    std::move(completion));
}

void StandardClient::uploadFolderTree_recurse(handle parent, handle& h, const fs::path& p, vector<NewNode>& newnodes)
{
    NewNode n;
    client.putnodes_prepareOneFolder(&n, path_u8string(p.filename()), false);
    handle thishandle = n.nodehandle = h++;
    n.parenthandle = parent;
    newnodes.emplace_back(std::move(n));

    for (fs::directory_iterator i(p); i != fs::directory_iterator(); ++i)
    {
        if (fs::is_directory(*i))
        {
            uploadFolderTree_recurse(thishandle, h, *i, newnodes);
        }
    }
}

void StandardClient::uploadFolderTree(fs::path p, CloudItem item, PromiseBoolSP pb)
{
    auto completion = BasicPutNodesCompletion([pb](const Error& e) {
        pb->set_value(!e);
    });

    resultproc.prepresult(COMPLETION, ++next_request_tag,
        [&](){
            // Resolve target node.
            auto target = item.resolve(*this);

            // Couldn't locate target node.
            if (!target)
                return pb->set_value(false);

            vector<NewNode> newnodes;
            handle h = 1;
            uploadFolderTree_recurse(UNDEF, h, p, newnodes);
            client.putnodes(target->nodeHandle(),
                            NoVersioning,
                            std::move(newnodes),
                            nullptr,
                            0,
                            false,
                            {}, // customerIpPort
                            std::move(completion));
        },
        nullptr);
}

void StandardClient::downloadFile(const CloudItem& item, const fs::path& destination, PromiseBoolSP result)
{
    auto node = item.resolve(*this);
    if (!node)
        return result->set_value(false);

    unique_ptr<FileGet> file(new FileGet());

    file->h = node->nodeHandle();
    file->hprivate = true;
    file->setLocalname(LocalPath::fromAbsolutePath(path_u8string(destination)));
    file->name = node->displayname();
    file->result = std::move(result);

    reinterpret_cast<FileFingerprint&>(*file) = *node;

    TransferDbCommitter committer(client.tctable);

    error r = API_OK;

    client.startxfer(GET, file.get(), committer, false, false, false, NoVersioning, &r, client.nextreqtag());
    EXPECT_EQ(r , API_OK);

    if (r != API_OK)
        return file->result->set_value(false);

    file.release();
}

bool StandardClient::downloadFile(const CloudItem& item, const fs::path& destination)
{
    auto result =
        thread_do<bool>([&](StandardClient& client, PromiseBoolSP result)
                        {
                            client.downloadFile(item, destination, result);
                        }, __FILE__, __LINE__);

    auto status = result.wait_for(DEFAULTWAIT);

    EXPECT_NE(status, future_status::timeout);

    if (status == future_status::timeout)
        return false;

    return result.get();
}

bool StandardClient::uploadFolderTree(fs::path p, const CloudItem& item)
{
    auto promise = makeSharedPromise<bool>();
    auto future = promise->get_future();

    uploadFolderTree(p, item, std::move(promise));

    return future.get();
}

void StandardClient::uploadFile(const fs::path& path, const string& name, const Node* parent, TransferDbCommitter& committer, std::function<void(bool)>&& completion, VersioningOption vo)
{
    unique_ptr<File> file(new FilePut(std::move(completion)));

    file->h = parent->nodeHandle();
    file->setLocalname(LocalPath::fromAbsolutePath(path_u8string(path)));
    file->name = name;

    error result = API_OK;
    client.startxfer(PUT, file.release(), committer, false, false, false, vo, &result, client.nextreqtag());
    EXPECT_EQ(result, API_OK);
}

void StandardClient::uploadFile(const fs::path& path, const string& name, const Node* parent, std::function<void(bool)>&& completion, VersioningOption vo)
{
    resultproc.prepresult(COMPLETION,
                            ++next_request_tag,
                            [&]()
                            {
                                TransferDbCommitter committer(client.tctable);
                                uploadFile(path, name, parent, committer, std::move(completion), vo);
                            },
                            nullptr);
}

bool StandardClient::uploadFile(const fs::path& path, const string& name, const CloudItem& parent, int timeoutSeconds, VersioningOption vo)
{
    auto result = thread_do<bool>([&](StandardClient& client, PromiseBoolSP pb) {
        auto parentNode = parent.resolve(client);
        if (!parentNode)
            return pb->set_value(false);

        client.uploadFile(path, name, parentNode.get(), [pb](bool b){ pb->set_value(b); }, vo);
    }, __FILE__, __LINE__);

    auto status = result.wait_for(std::chrono::seconds(timeoutSeconds));
    EXPECT_NE(status, future_status::timeout);

    if (status == future_status::timeout)
        return false;

    return result.get();
}

bool StandardClient::uploadFile(const fs::path& path, const CloudItem& parent, int timeoutSeconds, VersioningOption vo)
{
    return uploadFile(path, path_u8string(path.filename()), parent, timeoutSeconds, vo);
}

void StandardClient::uploadFilesInTree_recurse(const Node* target, const fs::path& p, std::atomic<int>& inprogress, TransferDbCommitter& committer, VersioningOption vo)
{
    if (fs::is_regular_file(p))
    {
        ++inprogress;
        uploadFile(
            p,
            path_u8string(p.filename()),
            target,
            committer,
            [&inprogress](bool)
            {
                --inprogress;
            },
            vo);
    }
    else if (fs::is_directory(p))
    {
        if (auto newtarget = client.childnodebyname(target, path_u8string(p.filename()).c_str()))
        {
            for (fs::directory_iterator i(p); i != fs::directory_iterator(); ++i)
            {
                uploadFilesInTree_recurse(newtarget.get(), *i, inprogress, committer, vo);
            }
        }
    }
}

bool StandardClient::uploadFilesInTree(fs::path p, const CloudItem& n2, VersioningOption vo)
{
    std::atomic_int inprogress(0);

    std::shared_ptr<Node> targetNode = nullptr;
    {
        lock_guard<recursive_mutex> guard(clientMutex);
        targetNode = n2.resolve(*this);
    }

    // The target node should always exist.
    EXPECT_TRUE(targetNode);

    if (!targetNode && !inprogress)
        return false;

    auto startedFlag =
        thread_do<bool>([&inprogress, this, targetNode, p, vo](StandardClient& client, PromiseBoolSP result)
                        {
                            TransferDbCommitter committer(client.client.tctable);
                            uploadFilesInTree_recurse(targetNode.get(), p, inprogress, committer, vo);
                            result->set_value(true);
                        }, __FILE__, __LINE__);

    startedFlag.get();

    // 30 seconds, that doesn't immediately time out if you stop in the debugger for a while
    for (int i = 0; i < 300 && inprogress.load(); ++i)
    {
        WaitMillisec(100);
    }

    EXPECT_EQ(inprogress.load(), 0) << "Failed to uploadFilesInTree within 30 seconds";
    return inprogress.load() == 0;
}

void StandardClient::uploadFile(const fs::path& sourcePath,
                                const string& targetName,
                                const CloudItem& parent,
                                std::function<void(error)> completion,
                                const VersioningOption versioningPolicy)
{
    struct Put : public File {
        void completed(Transfer* transfer, putsource_t source)
        {
            // Sanity.
            assert(source == PUTNODES_APP);

            // For purposes of capturing.
            std::function<void(error)> completion = std::move(mCompletion);

            // So we can hook the result of putnodes.
            auto trampoline = [completion](const Error& result,
                                           targettype_t,
                                           vector<NewNode>&,
                                           bool,
                                           int /*tag*/,
                                           const map<string, string>& /*fileHandles*/)
            {
                EXPECT_EQ(result, API_OK);
                completion(result);
            };

            // Kick off the putnodes request.
            sendPutnodesOfUpload(transfer->client,
                                 transfer->uploadhandle,
                                 "",
                                 *transfer->ultoken,
                                 transfer->filekey,
                                 source,
                                 NodeHandle(),
                                 std::move(trampoline),
                                 nullptr,
                                 false); // it's a putnodes from app, not from a sync

            // Destroy ourselves.
            delete this;
        }

        void terminated(error result)
        {
            EXPECT_FALSE(true);

            // Let the completion function know we've failed.
            mCompletion(result);

            // Destroy ourselves.
            delete this;
        }

        // Who to call when the upload completes.
        std::function<void(error)> mCompletion;
    }; // Put

    // Make sure we have exclusive access to the client.
    lock_guard<recursive_mutex> guard(clientMutex);

    auto parentNode = parent.resolve(*this);
    if (!parentNode)
        return completion(API_ENOENT);

    // Create a file to represent and track our upload.
    auto file = std::make_unique<Put>();

    // Populate necessary fields.
    file->h = parentNode->nodeHandle();
    file->mCompletion = std::move(completion);
    file->name = targetName;
    file->setLocalname(LocalPath::fromAbsolutePath(path_u8string(sourcePath)));

    // Kick off the upload. Client takes ownership of file.
    TransferDbCommitter committer(client.tctable);

    error result = API_OK;

    client.startxfer(PUT,
                     file.get(),
                     committer,
                     false,
                     false,
                     false,
                     versioningPolicy,
                     &result, client.nextreqtag());

    EXPECT_EQ(result, API_OK);

    if (result != API_OK)
        return file->mCompletion(result);

    file.release();
}

void StandardClient::uploadFile(const fs::path& sourcePath,
                                const CloudItem& parent,
                                std::function<void(error)> completion,
                                const VersioningOption versioningPolicy)
{
    uploadFile(sourcePath,
               path_u8string(sourcePath.filename()),
               parent,
               std::move(completion),
               versioningPolicy);
}

void StandardClient::fetchnodes(bool noCache, bool loadSyncs, bool reloadingMidSession, PromiseBoolSP pb)
{
    resultproc.prepresult(FETCHNODES, ++next_request_tag,
        [&](){ client.fetchnodes(noCache, loadSyncs, reloadingMidSession); },
        [this, pb](error e)
        {
            if (e)
            {
                pb->set_value(false);
            }
            else
            {
                TreeProcPrintTree tppt;
                client.proctree(client.nodeByHandle(client.mNodeManager.getRootNodeFiles()), &tppt);

                if (onFetchNodes)
                {
                    onFetchNodes(*this, pb);
                }
                else
                {
                    pb->set_value(true);
                }
            }
            onFetchNodes = nullptr;
            return true;
        });
}

bool StandardClient::fetchnodes(bool noCache, bool loadSyncs, bool reloadingMidSession)
{
    auto result =
        thread_do<bool>([=](StandardClient& client, PromiseBoolSP result)
                        {
                            client.fetchnodes(noCache, loadSyncs, reloadingMidSession, result);
                        }, __FILE__, __LINE__);

    auto status = result.wait_for(std::chrono::seconds(180));
    EXPECT_NE(status, future_status::timeout);

    if (status == future_status::timeout)
    {
        LOG_warn << "Timed out waiting for fetchnodes";
        return false;
    }

    return result.get();
}

NewNode StandardClient::makeSubfolder(const string& utf8Name)
{
    NewNode newnode;
    client.putnodes_prepareOneFolder(&newnode, utf8Name, false);
    return newnode;
}

void StandardClient::catchup(std::function<void(error)> completion)
{
    auto init = std::bind(&MegaClient::catchup, &client);

    auto fini = [completion](error e) {
        LOG_debug << "catchup(...) request completed: "
                  << e;

        EXPECT_EQ(e, API_OK);
        if (e)
            out() << "catchup reports: " << e;

        LOG_debug << "Calling catchup(...) completion function...";

        completion(e);

        return true;
    };

    LOG_debug << "Sending catchup(...) request...";

    resultproc.prepresult(CATCHUP,
                          ++next_request_tag,
                          std::move(init),
                          std::move(fini));
}

void StandardClient::catchup(PromiseBoolSP pb)
{
    catchup([pb](error e) { pb->set_value(!e); });
}

unsigned StandardClient::deleteTestBaseFolder(bool mayNeedDeleting)
{
    auto result = thread_do<unsigned>([=](StandardClient& client, PromiseUnsignedSP result) {
        client.deleteTestBaseFolder(mayNeedDeleting, false, std::move(result));
    }, __FILE__, __LINE__);

    return result.get();
}

void StandardClient::deleteTestBaseFolder(bool mayNeedDeleting,
                                          bool deleted,
                                          PromiseUnsignedSP result)
{
    std::shared_ptr<Node> root = client.nodeByHandle(client.mNodeManager.getRootNodeFiles());
    if (!root)
    {
        out() << "err: deleteTestBaseFolder. base folder not found, as root was not found!";
        result->set_value(0);
        return;
    }

    if (std::shared_ptr<Node> basenode =
            client.childnodebyname(root.get(), "mega_test_sync", false);
        basenode && !basenode->changed.removed) // ensure it isn't already marked as removed
    {
        if (mayNeedDeleting)
        {
            auto completion = [this, result](NodeHandle, Error e)
            {
                EXPECT_EQ(e, API_OK);
                if (e)
                    out()
                        << "debug: deleteTestBaseFolder. delete of test base folder reply reports: "
                        << e;
                deleteTestBaseFolder(false /*mayNeedDeleting*/, true /*deleted*/, result);
            };

            resultproc.prepresult(
                COMPLETION,
                ++next_request_tag,
                [=, this]()
                {
                    client.unlink(basenode.get(), false, 0, false, std::move(completion));
                },
                nullptr);
            return;
        }

        out() << "err: deleteTestBaseFolder. base folder found, but not expected, failing";
        result->set_value(0);
        return;
    }

    out() << "debug: deleteTestBaseFolder. base folder not found, wasn't present or delete "
             "successful";
    result->set_value(deleted ? 2 : 1);
}

void StandardClient::ensureTestBaseFolder(bool mayneedmaking, PromiseBoolSP pb)
{
    if (std::shared_ptr<Node> root = client.nodeByHandle(client.mNodeManager.getRootNodeFiles()))
    {
        if (std::shared_ptr<Node> basenode = client.childnodebyname(root.get(), "mega_test_sync", false))
        {
            out() << clientname << "ensureTestBaseFolder node found";
            if (basenode->type == FOLDERNODE)
            {
                basefolderhandle = basenode->nodehandle;
                //out() << clientname << " Base folder: " << Base64Str<MegaClient::NODEHANDLE>(basefolderhandle);
                //parentofinterest = Base64Str<MegaClient::NODEHANDLE>(basefolderhandle);
                out() << clientname << "ensureTestBaseFolder ok";
                pb->set_value(true);
                return;
            }
        }
        else if (mayneedmaking)
        {
            vector<NewNode> nn(1);
            nn[0] = makeSubfolder("mega_test_sync");

            resultproc.prepresult(PUTNODES, ++next_request_tag,
                [&](){
                    client.putnodes(root->nodeHandle(), NoVersioning, std::move(nn), nullptr, client.reqtag, false);
                },
                [pb, this](error e){
                    out() << clientname << "ensureTestBaseFolder putnodes completed with: " << e;
                    ensureTestBaseFolder(false, pb);
                    return true;
                });
            out() << clientname << "ensureTestBaseFolder sending putnodes";
            return;
        }
        out() << clientname << "ensureTestBaseFolder unexpected case"; // but can occur if we look too early because a late actionpacket from prior tests made us think it was time to check
    }
    else {
        out() << clientname << "no file root handle";
    }
    pb->set_value(false);
}

NewNode* StandardClient::buildSubdirs(list<NewNode>& nodes, const string& prefix, int n, int recurselevel)
{
    nodes.emplace_back(makeSubfolder(prefix));
    auto& nn = nodes.back();
    nn.nodehandle = nodes.size();

    if (recurselevel > 0)
    {
        for (int i = 0; i < n; ++i)
        {
            buildSubdirs(nodes, prefix + "_" + to_string(i), n, recurselevel - 1)->parenthandle = nn.nodehandle;
        }
    }

    return &nn;
}

bool StandardClient::makeCloudSubdirs(const string& prefix, int depth, int fanout)
{
    auto result =
        thread_do<bool>([=](StandardClient& client, PromiseBoolSP result)
                        {
                            client.makeCloudSubdirs(prefix, depth, fanout, result);
                        }, __FILE__, __LINE__);

    return result.get();
}

void StandardClient::makeCloudSubdirs(const string& prefix, int depth, int fanout, PromiseBoolSP pb, const string& atpath)
{
    assert(basefolderhandle != UNDEF);

    std::list<NewNode> nodes;
    NewNode* nn = buildSubdirs(nodes, prefix, fanout, depth);
    nn->parenthandle = UNDEF;
    nn->ovhandle = NodeHandle();

    std::shared_ptr<Node> atnode = client.nodebyhandle(basefolderhandle);
    if (atnode && !atpath.empty())
    {
        atnode = drillchildnodebyname(atnode, atpath);
    }
    if (!atnode)
    {
        out() << "path not found: " << atpath;
        pb->set_value(false);
    }
    else
    {
        auto nodearray = vector<NewNode>(nodes.size());
        size_t i = 0;
        for (auto n = nodes.begin(); n != nodes.end(); ++n, ++i)
        {
            nodearray[i] = std::move(*n);
        }

        auto completion = [pb, this](const Error& e,
                                     targettype_t,
                                     vector<NewNode>& nodes,
                                     bool,
                                     int /*tag*/,
                                     const map<string, string>& /*fileHandles*/)
        {
            lastPutnodesResultFirstHandle = nodes.empty() ? UNDEF : nodes[0].mAddedHandle;
            pb->set_value(!e);
        };

        int tag = ++next_request_tag;
        resultproc.prepresult(
            COMPLETION,
            tag,
            [&]()
            {
                client.putnodes(atnode->nodeHandle(),
                                NoVersioning,
                                std::move(nodearray),
                                nullptr,
                                tag,
                                false,
                                {}, // customerIpPort
                                std::move(completion));
            },
            nullptr);
    }
}

SyncConfig StandardClient::syncConfigByBackupID(handle backupID) const
{
    SyncConfig c;
    bool found = client.syncs.syncConfigByBackupId(backupID, c);
    if (!found)
        assert(found);

    return c;
}

bool StandardClient::syncSet(handle backupId, SyncInfo& info) const
{
    SyncConfig c;

    auto found = client.syncs.syncConfigByBackupId(backupId, c);
    EXPECT_TRUE(found)
      << "Unable to find sync with backup ID: "
      << toHandle(backupId);

    if (found)
    {
        info.h = c.mRemoteNode;
        info.localpath = c.getLocalPath().toPath(false);
        info.remotepath = c.mOriginalPathOfRemoteRootNode; // bit of a hack

        return true;
    }

    return false;
}

StandardClient::SyncInfo StandardClient::syncSet(handle backupId)
{
    SyncInfo result;

    out() << "looking up BackupId " << toHandle(backupId);

    bool found = syncSet(backupId, result);
    if (!found)
        assert(found);

    return result;
}

StandardClient::SyncInfo StandardClient::syncSet(handle backupId) const
{
    return const_cast<StandardClient&>(*this).syncSet(backupId);
}

std::shared_ptr<Node> StandardClient::getcloudrootnode()
{
    return client.nodeByHandle(client.mNodeManager.getRootNodeFiles());
}

std::shared_ptr<Node> StandardClient::gettestbasenode()
{
    return client.childnodebyname(getcloudrootnode().get(), "mega_test_sync", false);
}

std::shared_ptr<Node> StandardClient::getcloudrubbishnode()
{
    return client.nodeByHandle(client.mNodeManager.getRootNodeRubbish());
}

std::shared_ptr<Node> StandardClient::getsyncdebrisnode()
{
    return drillchildnodebyname(getcloudrubbishnode(), "SyncDebris");
}

std::shared_ptr<Node> StandardClient::drillchildnodebyname(std::shared_ptr<Node> n, const string& path)
{
    for (size_t p = 0; n && p < path.size(); )
    {
        auto pos = path.find("/", p);
        if (pos == string::npos) pos = path.size();
        n = client.childnodebyname(n.get(), path.substr(p, pos - p).c_str(), false);
        p = pos == string::npos ? path.size() : pos + 1;
    }
    return n;
}

vector<std::shared_ptr<Node> > StandardClient::drillchildnodesbyname(Node* n, const string& path)
{
    auto pos = path.find("/");
    if (pos == string::npos)
    {
        return client.childnodesbyname(n, path.c_str(), false);
    }
    else
    {
        vector<std::shared_ptr<Node> > results, subnodes = client.childnodesbyname(n, path.c_str(), false);
        for (size_t i = subnodes.size(); i--; )
        {
            if (subnodes[i]->type != FILENODE)
            {
                vector<std::shared_ptr<Node> > v = drillchildnodesbyname(subnodes[i].get(), path.substr(pos + 1));
                results.insert(results.end(), v.begin(), v.end());
            }
        }
        return results;
    }
}

handle StandardClient::setupBackup_mainthread(const string& rootPath)
{
    SyncOptions options;

    options.drivePath = string(1, '\0');
    options.isBackup = true;
    options.uploadIgnoreFile = false;

    return setupBackup_mainthread(rootPath, options);
}

handle StandardClient::setupBackup_mainthread(const string& rootPath,
                                            const SyncOptions& syncOptions)
{
    auto result = thread_do<handle>([&](StandardClient& client, PromiseHandleSP result) {
        client.setupBackup_inThread(rootPath, syncOptions, std::move(result));
    }, __FILE__, __LINE__);

    auto status = result.wait_for(chrono::seconds(45));

    EXPECT_NE(status, future_status::timeout);

    if (status == future_status::timeout)
        return UNDEF;

    return result.get();
}

void StandardClient::setupBackup_inThread(const string& rootPath,
                                        const SyncOptions& syncOptions,
                                        PromiseHandleSP result)
{
    auto ec = std::error_code();
    auto rootPath_ = fsBasePath / u8path_compat(rootPath);

    // Try and create the local sync root.
    fs::create_directories(rootPath_, ec);
    EXPECT_FALSE(ec);

    if (ec)
        return result->set_value(UNDEF);

    fs::path excludePath_;

    // Translate exclude path if necessary.
    if (!syncOptions.excludePath.empty())
    {
        excludePath_ = fsBasePath / u8path_compat(syncOptions.excludePath);
    }

    // Create a suitable sync config.
    SyncConfig config(LocalPath::fromAbsolutePath(path_u8string(rootPath_)),
                      rootPath,
                      NodeHandle(),
                      string(),
                      fsfp_t(),
                      LocalPath(),
                      true,
                      SyncConfig::TYPE_BACKUP);

    client.preparebackup(config, [result, this](Error err, SyncConfig sc, MegaClient::UndoFunction revertOnError){

        if (err != API_OK)
        {
            result->set_value(UNDEF);
        }
        else
        {
            client.addsync(
                std::move(sc),
                [revertOnError, result](error e, SyncError, handle h)
                {
                    if (e && revertOnError)
                        revertOnError(nullptr);
                    result->set_value(e ? UNDEF : h);
                },
                "",
                "");
        }
    });
}

handle StandardClient::setupSync_mainthread(const string& rootPath,
                                            const CloudItem& remoteItem,
                                            const bool isBackup,
                                            const bool uploadIgnoreFile,
                                            const string& drivePath)
{
    SyncOptions options;

    options.drivePath = drivePath;
    options.isBackup = isBackup;
    options.uploadIgnoreFile = uploadIgnoreFile;

    return setupSync_mainthread(rootPath, remoteItem, options);
}

handle StandardClient::setupSync_mainthread(const string& rootPath,
                                            const CloudItem& remoteItem,
                                            const SyncOptions& syncOptions)
{
    auto result = thread_do<handle>([&](StandardClient& client, PromiseHandleSP result) {
        client.setupSync_inThread(rootPath, remoteItem, syncOptions, std::move(result));
    }, __FILE__, __LINE__);

    auto status = result.wait_for(chrono::seconds(45));

    EXPECT_NE(status, future_status::timeout);

    if (status == future_status::timeout)
        return UNDEF;

    return result.get();
}

void StandardClient::setupSync_inThread(const string& rootPath,
                                        const CloudItem& remoteItem,
                                        const SyncOptions& syncOptions,
                                        PromiseHandleSP result)
{
    // Helpful sentinel.
    static const string internalDrive(1, '\0');

    // Check if node is (or is contained by) an in-share.
    auto isShare = [](const Node* node) {
        for ( ; node; node = node->parent.get()) {
            if (node->type != FOLDERNODE)
                continue;

            if (node->inshare)
                return true;
        }

        return false;
    };

    auto remoteNode = remoteItem.resolve(*this);
    EXPECT_TRUE(remoteNode);

    if (!remoteNode)
        return result->set_value(UNDEF);

    auto ec = std::error_code();
    auto rootPath_ = fsBasePath / u8path_compat(rootPath);

    // Try and create the local sync root.
    fs::create_directories(rootPath_, ec);
    EXPECT_FALSE(ec);

    if (ec)
        return result->set_value(UNDEF);

    fs::path drivePath_;

    // Populate drive root if necessary.
    if (syncOptions.drivePath != internalDrive)
    {
        // Path should be valid as syncs must be contained by their drive.
        drivePath_ = fsBasePath / u8path_compat(syncOptions.drivePath);

        // Read drive ID if present...
        auto fsAccess = client.fsaccess.get();
        auto id = UNDEF;
        auto path = path_u8string(drivePath_);
        auto result_ = readDriveId(*fsAccess, path.c_str(), id);

        // Generate one if not...
        if (result_ == API_ENOENT)
        {
            id = generateDriveId(client.rng);
            result_ = writeDriveId(*fsAccess, path.c_str(), id);
        }

        EXPECT_EQ(result_, API_OK);
    }

    fs::path excludePath_;

    // Translate exclude path if necessary.
    if (!syncOptions.excludePath.empty())
    {
        excludePath_ = fsBasePath / u8path_compat(syncOptions.excludePath);
    }

    // For purposes of capturing.
    auto isBackup = syncOptions.isBackup;
    auto remoteHandle = remoteNode->nodeHandle();
    auto remoteIsShare = isShare(remoteNode.get());
    auto remotePath = string(remoteNode->displaypath());

    // Called when it's time to actually add the sync.
    auto completion = [=, this](error e)
    {
        LOG_debug << "Starting to add sync: "
                  << e;

        // Make sure our caller completed successfully.
        EXPECT_EQ(e, API_OK);

        if (e != API_OK)
            return result->set_value(UNDEF);

        // Convenience.
        constexpr auto BACKUP = SyncConfig::TYPE_BACKUP;
        constexpr auto TWOWAY = SyncConfig::TYPE_TWOWAY;

        // Generate config for the new sync.
        auto config = SyncConfig(LocalPath::fromAbsolutePath(path_u8string(rootPath_)),
                                 path_u8string(rootPath_),
                                 remoteHandle,
                                 remotePath,
                                 fsfp_t(),
                                 LocalPath(),
                                 true,
                                 isBackup ? BACKUP : TWOWAY);

        // Sanity check.
        EXPECT_TRUE(remoteIsShare || remotePath.substr(0, 1) == "/")
            << "config.mOriginalPathOfRemoteRootNode: "
            << remotePath;

        // Are we dealing with an external backup sync?
        if (!drivePath_.empty())
        {
            // Then make sure we specify where the external drive can be found.
            config.mExternalDrivePath = LocalPath::fromAbsolutePath(path_u8string(drivePath_));
        }

        if (gScanOnly)
        {
            config.mChangeDetectionMethod = CDM_PERIODIC_SCANNING;
            config.mScanIntervalSec = SCAN_INTERVAL_SEC;
        }

        auto completion = [result](error e, SyncError se, handle id) {
            EXPECT_EQ(e, API_OK);
            EXPECT_NE(id, UNDEF);
            EXPECT_EQ(se, NO_SYNC_ERROR);

            result->set_value(id);
        };

        LOG_debug << "Asking engine to add the sync...";

        LOG_debug << "Local sync root will be: "
                  << config.mLocalPath.toPath(false);

        if (!drivePath_.empty())
        {
            LOG_debug << "External drive will be: "
                      << config.mExternalDrivePath.toPath(false);
        }

        auto logName = syncOptions.logName;

        if (logName.empty())
        {
            logName = rootPath + " ";
        }

        client.addsync(std::move(config),
                       std::move(completion),
                       logName,
                       path_u8string(excludePath_));
    };

    // Do we need to upload an ignore file?
#ifdef SRW_NEEDED_FOR_THIS_ONE
    if (syncOptions.uploadIgnoreFile)
    {
        auto ignorePath = fsBasePath / ".megaignore";

        // Create the ignore file.
        auto created = createFile(ignorePath, "+sync:.megaignore");
        EXPECT_TRUE(created);

        if (!created)
            return result->set_value(UNDEF);

        LOG_debug << "Uploading initial megaignore file...";

        // Upload the ignore file.
        uploadFile(ignorePath, remoteNode.get(), std::move(completion));

        // Completion function will continue the work.
        return;
    }
#endif

    LOG_debug << "Making sure we've received latest cloud changes...";

    // Make sure the client's received all its action packets.
    //catchup(std::move(completion));
    WaitMillisec(1000);
    completion(API_OK);
    WaitMillisec(1000);
}

void StandardClient::importSyncConfigs(string configs, PromiseBoolSP result)
{
    auto completion = [result](error e) { result->set_value(!e); };
    client.importSyncConfigs(configs.c_str(), std::move(completion));
}

bool StandardClient::importSyncConfigs(string configs)
{
    auto result =
        thread_do<bool>([=](StandardClient& client, PromiseBoolSP result)
                        {
                            client.importSyncConfigs(configs, result);
                        }, __FILE__, __LINE__);

    return result.get();
}

string StandardClient::exportSyncConfigs()
{
    auto result =
        thread_do<string>([](MegaClient& client, PromiseStringSP result)
                        {
                            auto configs = client.syncs.exportSyncConfigs();
                            result->set_value(configs);
                        }, __FILE__, __LINE__);

    return result.get();
}

void StandardClient::delSync_inthread(handle backupId, PromiseBoolSP result)
{
    client.syncs.deregisterThenRemoveSyncById(backupId,
                                              [=](Error error)
                                              {
                                                  result->set_value(error == API_OK);
                                              });
}

bool StandardClient::recursiveConfirm(Model::ModelNode* mn, Node* n, int& descendants, const string& identifier, int depth, bool& firstreported, bool expectFail, bool skipIgnoreFile)
{
    // top level names can differ so we don't check those
    if (!mn || !n) return false;

    if (depth)
    {
        if (!CloudNameLess().equal(mn->cloudName(), n->displayname()))
        {
            out() << "Node name mismatch: " << mn->path() << " " << n->displaypath();
            return false;
        }
    }

    if (!mn->typematchesnodetype(n->type))
    {
        out() << "Node type mismatch: " << mn->path() << ":" << mn->type << " " << n->displaypath() << ":" << n->type;
        return false;
    }

    if (n->type == FILENODE)
    {
        // not comparing any file versioning (for now)
        return true;
    }

    multimap<string, Model::ModelNode*, CloudNameLess> ms;
    for (auto& m : mn->kids)
    {
        if (m->fsOnly)
            continue;

        if (skipIgnoreFile && IGNORE_FILE_NAME == m->cloudName())
            continue;

        ms.emplace(m->cloudName(), m.get());
    }

    multimap<string, Node*, CloudNameLess> ns;
    sharedNode_list children = client.getChildren(n);
    for (auto& n2 : children)
    {
        if (skipIgnoreFile && std::string(IGNORE_FILE_NAME) == n2->displayname())
            continue;

        ns.emplace(n2->displayname(), n2.get());
    }

    int matched = 0;
    vector<string> matchedlist;
    for (auto m_iter = ms.begin(); m_iter != ms.end(); )
    {
        if (!depth && m_iter->first == DEBRISFOLDER)
        {
            m_iter = ms.erase(m_iter); // todo: add checks of the remote debris folder later
            continue;
        }

        auto er = ns.equal_range(m_iter->first);
        auto next_m = m_iter;
        ++next_m;
        bool any_equal_matched = false;
        for (auto i = er.first; i != er.second; ++i)
        {
            int rdescendants = 0;
            if (recursiveConfirm(m_iter->second, i->second, rdescendants, identifier, depth+1, firstreported, expectFail, skipIgnoreFile))
            {
                ++matched;
                matchedlist.push_back(m_iter->first);
                ns.erase(i);
                ms.erase(m_iter);
                descendants += rdescendants;
                any_equal_matched = true;
                break;
            }
        }
        if (!any_equal_matched)
        {
            break;
        }
        m_iter = next_m;
    }
    if (ns.empty() && ms.empty())
    {
        descendants += matched;
        return true;
    }
    else if (!firstreported && !expectFail)
    {
        ostringstream ostream;
        firstreported = true;
        ostream << clientname << " " << identifier << " after matching " << matched << " child nodes [";
        for (auto& ml : matchedlist) ostream << ml << " ";
        ostream << "](with " << descendants << " descendants) in " << mn->path() << ", ended up with unmatched model nodes:";
        for (auto& m : ms) ostream << " " << m.first;
        ostream << " and unmatched remote nodes:";
        for (auto& i : ns) ostream << " " << i.first;
        out() << ostream.str();
        EXPECT_TRUE(false) << ostream.str();
    };
    return false;
}

auto StandardClient::equal_range_utf8EscapingCompare(multimap<string, LocalNode*, CloudNameLess>& ns, const string& cmpValue, bool unescapeValue, bool unescapeMap, bool caseInsensitive) -> std::pair<multimap<string, LocalNode*>::iterator, multimap<string, LocalNode*>::iterator>
{
    // first iter not less than cmpValue
    auto iter1 = ns.begin();
    while (iter1 != ns.end() && compareUtf(iter1->first, unescapeMap, cmpValue, unescapeValue, caseInsensitive) < 0) ++iter1;

    // second iter greater then cmpValue
    auto iter2 = iter1;
    while (iter2 != ns.end() && compareUtf(iter2->first, unescapeMap, cmpValue, unescapeValue, caseInsensitive) <= 0) ++iter2;

    return {iter1, iter2};
}

bool StandardClient::recursiveConfirm(Model::ModelNode* mn, LocalNode* n, int& descendants, const string& identifier, int depth, bool& firstreported, bool expectFail, bool skipIgnoreFile)
{
    // top level names can differ so we don't check those
    if (!mn || !n) return false;

    if (depth)
    {
        if (0 != compareUtf(mn->fsName(), true, n->localname, true, false))
        {
            out() << "LocalNode name mismatch: " << mn->fsPath() << " " << n->localname.toPath(false);
            return false;
        }
    }

    if (!mn->typematchesnodetype(n->type))
    {
        out() << "LocalNode type mismatch: " << mn->fsPath() << ":" << mn->type << " " << n->localname.toPath(false) << ":" << n->type;
        return false;
    }

    auto localpath = n->getLocalPath().toName(*client.fsaccess);
    string n_localname = n->localname.toName(*client.fsaccess);
    if (n_localname.size() && n->parent)
    {
        EXPECT_EQ(compareUtf(mn->fsName(), true, n->localname, true, false), 0)
            << "Localnode's localname vs model node fsname mismatch: '"
            << n->localname.toPath(false)
            << "', '"
            << mn->fsName()
            << "'";
    }
    if (localNodesMustHaveNodes)
    {
        if (n->syncedCloudNodeHandle.isUndef())
        {
            EXPECT_TRUE(!n->syncedCloudNodeHandle.isUndef()) << "expected synced non-undef handle at localnode: " << n->getLocalPath().toPath(false);
            return false;
        }
        if (!client.nodeByHandle(n->syncedCloudNodeHandle))
        {
            EXPECT_TRUE(!!client.nodeByHandle(n->syncedCloudNodeHandle)) << "expected synced handle that looks up node at localnode: " << n->getLocalPath().toPath(false);
            return false;
        }
    }
    std::shared_ptr<Node> syncedNode = client.nodeByHandle(n->syncedCloudNodeHandle);
    if (depth && syncedNode)
    {
        EXPECT_EQ(compareUtf(mn->cloudName(), false, syncedNode->displayname(), false, false), 0)
            << "Localnode's associated Node vs model node name mismatch: '"
            << syncedNode->displayname()
            << "', '"
            << mn->cloudName()
            << "'";
    }
    if (depth && mn->parent)
    {
        EXPECT_EQ(mn->parent->type, Model::ModelNode::folder);
        EXPECT_EQ(n->parent->type, FOLDERNODE);

        string parentpath = n->parent->getLocalPath().toName(*client.fsaccess);
        EXPECT_EQ(localpath.substr(0, parentpath.size()), parentpath);
    }
    std::shared_ptr<Node> parentSyncedNode = n->parent ? client.nodeByHandle(n->parent->syncedCloudNodeHandle) : nullptr;
    if (syncedNode && n->parent && parentSyncedNode)
    {
        string p = syncedNode->displaypath();
        string pp = parentSyncedNode->displaypath();
        EXPECT_EQ(p.substr(0, pp.size()), pp);
        EXPECT_EQ(parentSyncedNode, syncedNode->parent);
    }

    multimap<string, Model::ModelNode*, CloudNameLess> ms;
    multimap<string, LocalNode*, CloudNameLess> ns;
    for (auto& m : mn->kids)
    {
        if (m->fsOnly)
            continue;

        if (skipIgnoreFile && m->fsName() == IGNORE_FILE_NAME)
            continue;

        ms.emplace(m->fsName(), m.get());
    }
    for (auto& n2 : n->children)
    {
        if (skipIgnoreFile && n2.second->isIgnoreFile())
            continue;

        ns.emplace(n2.second->localname.toPath(false), n2.second); // todo: should LocalNodes marked as deleted actually have been removed by now?
    }

    int matched = 0;
    vector<string> matchedlist;
    for (auto m_iter = ms.begin(); m_iter != ms.end(); )
    {
        if (!depth && m_iter->first == DEBRISFOLDER)
        {
            m_iter = ms.erase(m_iter); // todo: are there LocalNodes representing the trash?
            continue;
        }

        auto er = equal_range_utf8EscapingCompare(ns, m_iter->first, true, true, n->sync->mCaseInsensitive);
        //auto er = ns.equal_range(m_iter->first);
        auto next_m = m_iter;
        ++next_m;
        bool any_equal_matched = false;
        for (auto i = er.first; i != er.second; ++i)
        {
            int rdescendants = 0;
            if (recursiveConfirm(m_iter->second, i->second, rdescendants, identifier, depth+1, firstreported, expectFail, skipIgnoreFile))
            {
                ++matched;
                matchedlist.push_back(m_iter->first);
                ns.erase(i);
                ms.erase(m_iter);
                descendants += rdescendants;
                any_equal_matched = true;
                break;
            }
        }
        if (!any_equal_matched)
        {
            break;
        }
        m_iter = next_m;
    }
    if (ns.empty() && ms.empty())
    {
        return true;
    }
    else if (!firstreported && !expectFail)
    {
        ostringstream ostream;
        firstreported = true;
        ostream << clientname << " " << identifier << " after matching " << matched << " child nodes [";
        for (auto& ml : matchedlist) ostream << ml << " ";
        ostream << "](with " << descendants << " descendants) in " << mn->path() << ", ended up with unmatched model nodes:";
        for (auto& m : ms) ostream << " " << m.first;
        ostream << " and unmatched LocalNodes:";
        for (auto& i : ns) ostream << " " << i.first;
        out() << ostream.str();
        EXPECT_TRUE(false) << ostream.str();
    };
    return false;
}


bool StandardClient::recursiveConfirm(Model::ModelNode* mn, fs::path p, int& descendants, const string& identifier, int depth, bool ignoreDebris, bool& firstreported, bool expectFail, bool skipIgnoreFile)
{
    struct Comparator
    {
        bool operator()(const string& lhs, const string& rhs) const
        {
            return compare(lhs, rhs) < 0;
        }

        int compare(const string& lhs, const string& rhs) const
        {
            return compareUtf(lhs, true, rhs, true, false);
        }
    }; // Comparator

    static Comparator comparator;

    if (!mn) return false;

    if (depth)
    {
        if (comparator.compare(path_u8string(p.filename()), mn->fsName()))
        {
            out() << "filesystem name mismatch: " << mn->path() << " " << p;
            return false;
        }
    }

    nodetype_t pathtype = fs::is_directory(p) ? FOLDERNODE : fs::is_regular_file(p) ? FILENODE : TYPE_UNKNOWN;
    if (!mn->typematchesnodetype(pathtype))
    {
        out() << "Path type mismatch: " << mn->path() << ":" << mn->type << " " << path_u8string(p)
              << ":" << pathtype;
        return false;
    }

    if (pathtype == FILENODE && path_u8string(p.filename()) != "lock")
    {
        if (localFSFilesThatMayDiffer.find(p) == localFSFilesThatMayDiffer.end())
        {
            ifstream fs(p, ios::binary);
            std::vector<char> buffer;
            buffer.resize(mn->content.size() + 1024);
            fs.read(reinterpret_cast<char*>(buffer.data()),
                    static_cast<std::streamsize>(buffer.size()));
            EXPECT_EQ(size_t(fs.gcount()), mn->content.size()) << " file is not expected size " << p;
            EXPECT_TRUE(!memcmp(buffer.data(), mn->content.data(), mn->content.size())) << " file data mismatch " << p;
        }
    }

    if (pathtype != FOLDERNODE)
    {
        return true;
    }

    multimap<string, Model::ModelNode*, Comparator> ms;
    multimap<string, fs::path, Comparator> ps;

    for (auto& m : mn->kids)
    {
        if (skipIgnoreFile && m->fsName() == IGNORE_FILE_NAME)
            continue;

        ms.emplace(m->fsName(), m.get());
    }

    for (fs::directory_iterator pi(p); pi != fs::directory_iterator(); ++pi)
    {
        auto name = path_u8string(pi->path().filename());

        if (skipIgnoreFile && name == IGNORE_FILE_NAME)
            continue;

        ps.emplace(std::move(name), pi->path());
    }

    if (ignoreDebris && depth == 0)
    {
        ms.erase(DEBRISFOLDER);
        ps.erase(DEBRISFOLDER);
    }
    else if (depth == 1 && mn->name == DEBRISFOLDER)
    {
        ms.erase("tmp");
        ps.erase("tmp");
    }
    else if (depth == 0)
    {
        // with ignore files, most tests now involve a download somewhere which means debris/tmp is created.
        // it only matters if the content of these differs, absence or empty is effectively the same
        if (ms.find(DEBRISFOLDER) == ms.end())
        {
            auto d = mn->addkid();
            d->name = DEBRISFOLDER;
            d->type = Model::ModelNode::folder;
            ms.emplace(DEBRISFOLDER, d);
        }
        if (ps.find(DEBRISFOLDER) == ps.end())
        {
            auto pdeb = p / fs::path(DEBRISFOLDER);
            fs::create_directory(pdeb);
            ps.emplace(DEBRISFOLDER, pdeb);
        }
    }

    int matched = 0;
    vector<string> matchedlist;
    for (auto m_iter = ms.begin(); m_iter != ms.end(); )
    {
        auto er = ps.equal_range(m_iter->first);
        auto next_m = m_iter;
        ++next_m;
        bool any_equal_matched = false;
        for (auto i = er.first; i != er.second; ++i)
        {
            int rdescendants = 0;
            if (recursiveConfirm(m_iter->second, i->second, rdescendants, identifier, depth+1, ignoreDebris, firstreported, expectFail, skipIgnoreFile))
            {
                ++matched;
                matchedlist.push_back(m_iter->first);
                ps.erase(i);
                ms.erase(m_iter);
                descendants += rdescendants;
                any_equal_matched = true;
                break;
            }
        }
        if (!any_equal_matched)
        {
            break;
        }
        m_iter = next_m;
    }
    //if (ps.size() == 1 && !mn->parent && ps.begin()->first == DEBRISFOLDER)
    //{
    //    ps.clear();
    //}
    if (ps.empty() && ms.empty())
    {
        return true;
    }
    else if (!firstreported && !expectFail)
    {
        ostringstream ostream;
        firstreported = true;
        ostream << clientname << " " << identifier << " after matching " << matched << " child nodes [";
        for (auto& ml : matchedlist) ostream << ml << " ";
        ostream << "](with " << descendants << " descendants) in " << mn->path() << ", ended up with unmatched model nodes:";
        for (auto& m : ms) ostream << " " << m.first;
        ostream << " and unmatched filesystem paths:";
        for (auto& i : ps) ostream << " " << i.second.filename();
        ostream << " in " << p;
        out() << ostream.str();
        EXPECT_TRUE(false) << ostream.str();
    };
    return false;
}

Sync* StandardClient::syncByBackupId(handle backupId)
{
    return client.syncs.runningSyncByBackupIdForTests(backupId);
}

bool StandardClient::setSyncPausedByBackupId(handle id, bool pause)
{
    PromiseBoolSP result = makeSharedPromise<bool>();

    if (pause)
    {
        disableSync(id, NO_SYNC_ERROR, false /* enabled */, true /* keepSyncDB */, result);
    }
    else
    {
        client.syncs.enableSyncByBackupId(
            id,
            false,
            [result](error e, SyncError, handle)
            {
                result->set_value(!e);
            },
            id > 0,
            "");
    }

    return debugTolerantWaitOnFuture(result->get_future(), 45);
}

void StandardClient::enableSyncByBackupId(handle id, PromiseBoolSP result, const string& logname)
{
    client.syncs.enableSyncByBackupId(
        id,
        true,
        [result](error e, SyncError, handle)
        {
            result->set_value(!e);
        },
        id > 0,
        logname);
}

bool StandardClient::enableSyncByBackupId(handle id, const string& logname)
{
    auto result =
        thread_do<bool>([=](StandardClient& client, PromiseBoolSP result)
                        {
                            client.enableSyncByBackupId(id, result, logname);
                        }, __FILE__, __LINE__);

    return result.get();
}

handle StandardClient::backupIdForSyncPath(fs::path path)
{
    auto localPath = LocalPath::fromAbsolutePath(path_u8string(path));

    auto configs = client.syncs.getConfigs(false);
    for (auto& sc : configs)
    {
        if (sc.mLocalPath == localPath) return sc.mBackupId;
    }
    return UNDEF;
}

bool StandardClient::confirmModel_mainthread(handle id, Model::ModelNode* mRoot, Node* rRoot, bool expectFail, bool skipIgnoreFile)
{
    auto result =
        thread_do<bool>(
        [=](StandardClient& client, PromiseBoolSP result)
        {
            result->set_value(client.confirmModel(id, mRoot, rRoot, expectFail, skipIgnoreFile));
        }, __FILE__, __LINE__);

    return result.get();
}

bool StandardClient::confirmModel_mainthread(handle id, Model::ModelNode* mRoot, LocalNode* lRoot, bool expectFail, bool skipIgnoreFile)
{
    auto result =
        thread_do<bool>(
        [=](StandardClient& client, PromiseBoolSP result)
        {
            result->set_value(client.confirmModel(id, mRoot, lRoot, expectFail, skipIgnoreFile));
        }, __FILE__, __LINE__);

    return result.get();
}

bool StandardClient::confirmModel_mainthread(handle id, Model::ModelNode* mRoot, fs::path lRoot, bool ignoreDebris, bool expectFail, bool skipIgnoreFile)
{
    auto result =
        thread_do<bool>(
        [=](StandardClient& client, PromiseBoolSP result)
        {
            result->set_value(client.confirmModel(id, mRoot, lRoot, ignoreDebris, expectFail, skipIgnoreFile));
        }, __FILE__, __LINE__);

    return result.get();
}

bool StandardClient::confirmModel(handle id, Model::ModelNode* mRoot, Node* rRoot, bool expectFail, bool skipIgnoreFile)
{
    string name = "Sync " + toHandle(id);
    int descendents = 0;
    bool reported = false;

    if (!recursiveConfirm(mRoot, rRoot, descendents, name, 0, reported, expectFail, skipIgnoreFile))
    {
        out() << clientname << " syncid " << toHandle(id) << " comparison against remote nodes failed";
        return false;
    }

    return true;
}

bool StandardClient::confirmModel(handle id, Model::ModelNode* mRoot, LocalNode* lRoot, bool expectFail, bool skipIgnoreFile)
{
    string name = "Sync " + toHandle(id);
    int descendents = 0;
    bool reported = false;

    if (!recursiveConfirm(mRoot, lRoot, descendents, name, 0, reported, expectFail, skipIgnoreFile))
    {
        out() << clientname << " syncid " << toHandle(id) << " comparison against LocalNodes failed";
        return false;
    }

    return true;
}

bool StandardClient::confirmModel(handle id, Model::ModelNode* mRoot, fs::path lRoot, bool ignoreDebris, bool expectFail, bool skipIgnoreFile)
{
    string name = "Sync " + toHandle(id);
    int descendents = 0;
    bool reported = false;

    if (!recursiveConfirm(mRoot, lRoot, descendents, name, 0, ignoreDebris, reported, expectFail, skipIgnoreFile))
    {
        out() << clientname << " syncid " << toHandle(id) << " comparison against local filesystem failed";
        return false;
    }

    return true;
}

bool StandardClient::confirmModel(handle backupId, Model::ModelNode* mnode, const int confirm, const bool ignoreDebris, bool expectFail, bool skipIgnoreFile)
{
    SyncInfo si;

    if (!syncSet(backupId, si))
    {
        out() << clientname << " backupId " << toHandle(backupId) << " not found ";
        return false;
    }

    // compare model against nodes representing remote state
    if ((confirm & CONFIRM_REMOTE) && !confirmModel(backupId, mnode, client.nodeByHandle(si.h).get(), expectFail, skipIgnoreFile))
    {
        return false;
    }

    // Get our hands on the sync.
    auto* sync = syncByBackupId(backupId);

    // compare model against LocalNodes
    if (sync)
    {
        if ((confirm & CONFIRM_LOCALNODE) && !confirmModel(backupId, mnode, sync->localroot.get(), expectFail, skipIgnoreFile))
        {
            return false;
        }
    }

    // compare model against local filesystem
    if ((confirm & CONFIRM_LOCALFS) && !confirmModel(backupId, mnode, si.localpath, ignoreDebris, expectFail, skipIgnoreFile))
    {
        return false;
    }

#ifdef SRW_NEEDED_FOR_THIS_ONE

    // Does this sync have a state cache?
    if (!sync)
        return true;

    string statecachename = sync->getConfig().getSyncDbStateCacheName(sync->localroot->fsid_lastSynced, sync->getConfig().mRemoteNode, client.me);

    StateCacheValidator validator;

    // Try and load the state cache.
    EXPECT_TRUE(validator.load(client, statecachename))
        << "Sync "
        << toHandle(backupId)
        << ": Unable to load state cache: "
        << statecachename;

    // Does the state cache accurately reflect the LNT in memory?
    EXPECT_TRUE(validator.compare(*sync->localroot))
        << "Sync "
        << toHandle(backupId)
        << ": State cache mismatch.";
#endif
    return true;
}

void StandardClient::prelogin_result(int, string*, string* salt, error e)
{
    out() << clientname << " Prelogin: " << e;
    if (!e)
    {
        this->salt = *salt;
    }
    resultproc.processresult(PRELOGIN, e, UNDEF, client.restag);
}

void StandardClient::login_result(error e)
{
    out() << clientname << " Login: " << e;
    resultproc.processresult(LOGIN, e, UNDEF, client.restag);
}

void StandardClient::fetchnodes_result(const Error& e)
{
    out() << clientname << " Fetchnodes: " << e;
    resultproc.processresult(FETCHNODES, e, UNDEF, client.restag);
}

bool StandardClient::setattr(const CloudItem& item, attr_map&& updates)
{
    auto result =
        thread_do<bool>([=](StandardClient& client, PromiseBoolSP result) mutable
        {
            client.setattr(std::move(item), std::move(updates), result);
        }, __FILE__, __LINE__);

    auto status = result.wait_for(std::chrono::seconds(90));   // allow for up to 60 seconds of unexpected -3s on all channels
    EXPECT_NE(status, future_status::timeout);

    if (status == future_status::timeout)
        return false;

    return result.get();
}

void StandardClient::setattr(const CloudItem& item, attr_map&& updates, PromiseBoolSP result)
{
    resultproc.prepresult(
        COMPLETION,
        ++next_request_tag,
        [=, this]()
        {
            auto node = item.resolve(*this);
            if (!node)
                return result->set_value(false);

            client.setattr(
                node,
                attr_map(updates),
                [result](NodeHandle, error e)
                {
                    result->set_value(!e);
                },
                false);
        },
        nullptr);
}

bool StandardClient::rename(const CloudItem& item, const string& newName)
{
    return setattr(item, attr_map('n', newName));
}

void StandardClient::unlink_result(handle h, error e)
{
    resultproc.processresult(UNLINK, e, h, client.restag);
}

void StandardClient::putnodes_result(const Error& e,
                                     targettype_t,
                                     vector<NewNode>& nn,
                                     bool /*targetOverride*/,
                                     int tag,
                                     const map<string, string>& /*fileHandles*/)
{
    resultproc.processresult(PUTNODES, e, nn.empty() ? UNDEF : nn[0].mAddedHandle, tag);
}

void StandardClient::catchup_result()
{
    resultproc.processresult(CATCHUP, error(API_OK), UNDEF, client.restag);
}

void StandardClient::disableSync(handle id, SyncError error, bool enabled, bool keepSyncDB, PromiseBoolSP result)
{
    client.syncs.disableSyncByBackupId(id,
        error,
        enabled,
        keepSyncDB,
        [result](){
            result->set_value(true);
        });
}

bool StandardClient::disableSync(handle id, SyncError error, bool enabled, bool keepSyncDB)
{
    auto result =
        thread_do<bool>([=](StandardClient& client, PromiseBoolSP result)
                        {
                            client.disableSync(id, error, enabled, keepSyncDB, result);
                        }, __FILE__, __LINE__);

    return result.get();
}

void StandardClient::deleteremote(const CloudItem& item, PromiseBoolSP result)
{
    auto node = item.resolve(*this);
    if (!node)
        return result->set_value(false);

    client.unlink(node.get(), false, 0, false, [result](NodeHandle, Error e) {
        result->set_value(e == API_OK);
    });
}

bool StandardClient::deleteremote(const CloudItem& item)
{
    auto result = thread_do<bool>([&](StandardClient& client, PromiseBoolSP result) {
        client.deleteremote(item, std::move(result));
    }, __FILE__, __LINE__);

    auto status = result.wait_for(std::chrono::seconds(45));
    EXPECT_NE(status, future_status::timeout);

    if (status == future_status::timeout)
        return false;

    return result.get();
}

bool StandardClient::deleteremotedebris()
{
    return withWait<bool>([&](PromiseBoolSP result) {
        deleteremotedebris(result);
    });
}

void StandardClient::deleteremotedebris(PromiseBoolSP result)
{
    if (auto debris = getsyncdebrisnode())
    {
        deleteremotenodes({debris}, std::move(result));
    }
    else
    {
        result->set_value(true);
    }
}

void StandardClient::deleteremotenodes(vector<std::shared_ptr<Node> > ns, PromiseBoolSP pb)
{
    if (ns.empty())
    {
        pb->set_value(true);
    }
    else
    {
        for (size_t i = ns.size(); i--; )
        {
            auto completion = [i, pb](NodeHandle, Error e) {
                if (!i) pb->set_value(!e);
            };

            resultproc.prepresult(COMPLETION, ++next_request_tag,
                [&](){ client.unlink(ns[i].get(), false, 0, false, std::move(completion)); },
                nullptr);
        }
    }
}

bool StandardClient::movenode(const CloudItem& source,
                              const CloudItem& target,
                              const string& newName)
{
    auto result = thread_do<bool>([&](StandardClient& client, PromiseBoolSP result) {
        client.movenode(source, target, newName, std::move(result));
    }, __FILE__, __LINE__);

    auto status = result.wait_for(DEFAULTWAIT);
    EXPECT_NE(status, future_status::timeout);

    if (status == future_status::timeout)
        return false;

    return result.get();
}

void StandardClient::movenode(const CloudItem& source,
                              const CloudItem& target,
                              const string& newName,
                              PromiseBoolSP result)
{
    auto sourceNode = source.resolve(*this);
    if (!sourceNode)
        return result->set_value(false);

    auto targetNode = target.resolve(*this);
    if (!targetNode)
        return result->set_value(false);

    auto completion = [result](NodeHandle, Error e) {
        result->set_value(e == API_OK);
    };

    client.rename(sourceNode,
                  targetNode,
                  SYNCDEL_NONE,
                  NodeHandle(),
                  newName.empty() ? nullptr : newName.c_str(),
                  false,
                  std::move(completion));
}

void StandardClient::movenodetotrash(string path, PromiseBoolSP pb)
{
    std::shared_ptr<Node> n = drillchildnodebyname(gettestbasenode(), path);
    std::shared_ptr<Node> p = getcloudrubbishnode();
    if (n && p && n->parent)
    {
        resultproc.prepresult(
            COMPLETION,
            ++next_request_tag,
            [pb, n, p, this]()
            {
                client.rename(n,
                              p,
                              SYNCDEL_NONE,
                              NodeHandle(),
                              nullptr,
                              false,
                              [pb](NodeHandle, Error e)
                              {
                                  pb->set_value(!e);
                              });
            },
            nullptr);
        return;
    }
    out() << "node or rubbish or node parent not found";
    pb->set_value(false);
}

void StandardClient::exportnode(std::shared_ptr<Node> n, int del, m_time_t expiry, bool writable, bool megaHosted, promise<Error>& pb)
{
    resultproc.prepresult(
        COMPLETION,
        ++next_request_tag,
        [&]()
        {
            error e = client.exportnode(n,
                                        del,
                                        expiry,
                                        writable,
                                        megaHosted,
                                        client.reqtag,
                                        [&](Error e, handle, handle, string&&)
                                        {
                                            pb.set_value(e);
                                        });
            if (e)
            {
                pb.set_value(e);
            }
        },
        nullptr); // no need to match callbacks with requests when we use completion functions
}

void StandardClient::getpubliclink(Node* n, int del, m_time_t expiry, bool writable, bool megaHosted, promise<Error>& pb)
{
    resultproc.prepresult(
        COMPLETION,
        ++next_request_tag,
        [&]()
        {
            client.requestPublicLink(n,
                                     del,
                                     expiry,
                                     writable,
                                     megaHosted,
                                     client.reqtag,
                                     [&](Error e, handle, handle, string&&)
                                     {
                                         pb.set_value(e);
                                     });
        },
        nullptr);
}

void StandardClient::waitonsyncs(chrono::seconds d)
{
    auto start = chrono::steady_clock::now();
    for (;;)
    {
        bool any_add_del = client.syncs.syncBusyState;

        thread_do<bool>(
            [&any_add_del, this](StandardClient&, PromiseBoolSP pb)
            {
                if (!client.multi_transfers[GET].empty() || !client.multi_transfers[PUT].empty())
                {
                    any_add_del = true;
                }
                pb->set_value(true);
            },
            __FILE__,
            __LINE__)
            .get();

        if (any_add_del || debugging)
        {
            start = chrono::steady_clock::now();
        }

        if (((chrono::steady_clock::now() - start) > d) && ((chrono::steady_clock::now() - lastcb) > d))
        {
            break;
        }
        WaitMillisec(500);
    }

}

void StandardClient::syncproblemsDetected(SyncProblems& problems)
{
    PromiseBoolSP pb(new promise<bool>());
    client.syncs.syncRun(
        [&]()
        {
            problems.mStallsDetected = client.syncs.stallsDetected(problems.mStalls);
            problems.mConflictsDetected = client.syncs.conflictsDetected(problems.mConflictsMap);
            pb->set_value(true);
        },
        "StandardClient::syncproblemsDetected");
    EXPECT_TRUE(debugTolerantWaitOnFuture(pb->get_future(), 45));
}

bool StandardClient::conflictsDetected(list<NameConflict>& conflicts)
{
    PromiseBoolSP pb(new promise<bool>());
    bool result = false;

    client.syncs.syncRun(
        [&]()
        {
            SyncIDtoConflictInfoMap auxconflicts;
            result = client.syncs.conflictsDetected(auxconflicts);
            for (auto& conflict: auxconflicts)
            {
                conflicts.insert(conflicts.end(), conflict.second.begin(), conflict.second.end());
            }

            pb->set_value(true);
        },
        "StandardClient::conflictsDetected");

    EXPECT_TRUE(debugTolerantWaitOnFuture(pb->get_future(), 45));

    return result;
}

bool StandardClient::stallsDetected(SyncStallInfoTests& stalls)
{
    PromiseBoolSP pb(new promise<bool>());

    bool result = false;

    client.syncs.syncRun([&](){
        SyncStallInfo syncStalls;
        result = client.syncs.stallsDetected(syncStalls);
        result |= !stalls.empty();
        if (result)
        {
            stalls.extractFrom(syncStalls);
        }
        pb->set_value(true);
    }, "StandardClient::stallsDetected");

    EXPECT_TRUE(debugTolerantWaitOnFuture(pb->get_future(), 45));

    return result;
}

bool StandardClient::syncStallDetected(SyncStallInfoTests& si) const
{
    si.clear();
    SyncStallInfo syncStalls;
    if (client.syncs.syncStallDetected(syncStalls))
    {
        si.extractFrom(syncStalls);
        return true;
    }
    return false;
}

bool StandardClient::login_reset(bool noCache)
{
    return login_reset("MEGA_EMAIL", "MEGA_PWD", noCache);
}

bool StandardClient::login_reset(const string& user, const string& pw, bool noCache, bool resetBaseCloudFolder)
{
    received_user_alerts = false;

    future<bool> p1;
    p1 = thread_do<bool>([=](StandardClient& sc, PromiseBoolSP pb) { sc.preloginFromEnv(user, pb); }, __FILE__, __LINE__);
    if (!waitonresults(&p1))
    {
        out() << "preloginFromEnv failed";
        return false;
    }
    p1 = thread_do<bool>([=](StandardClient& sc, PromiseBoolSP pb) { sc.loginFromEnv(user, pw, pb); }, __FILE__, __LINE__);
    if (!waitonresults(&p1))
    {
        out() << "loginFromEnv failed";
        return false;
    }
    p1 = thread_do<bool>([=](StandardClient& sc, PromiseBoolSP pb) { sc.fetchnodes(noCache, true, false, pb); }, __FILE__, __LINE__);
    if (!waitonresults(&p1)) {
        out() << "fetchnodes failed";
        return false;
    }

    EXPECT_TRUE(waitForUserAlertsUpdated(30));

    p1 = thread_do<bool>([=](StandardClient& sc, PromiseBoolSP pb) { sc.upgradeSecurity(pb); }, __FILE__, __LINE__);
    if (!waitonresults(&p1))
    {
        out() << "upgrading security failed";
        return false;
    }

    if (resetBaseCloudFolder)
    {
        if (deleteTestBaseFolder(true) == 0)
        {
            out() << "deleteTestBaseFolder failed";
            return false;
        }

        p1 = thread_do<bool>([](StandardClient& sc, PromiseBoolSP pb) { sc.ensureTestBaseFolder(true, pb); }, __FILE__, __LINE__);
        if (!waitonresults(&p1)) {
            out() << "ensureTestBaseFolder failed";
            return false;
        }
    }
    return true;
}

bool StandardClient::resetBaseFolderMulticlient(StandardClient* c2, StandardClient* c3, StandardClient* c4)
{
    auto resetActionPacketFlags = [this, c2, c3, c4]() {
        received_node_actionpackets = false;
        if (c2) c2->received_node_actionpackets = false;
        if (c3) c3->received_node_actionpackets = false;
        if (c4) c4->received_node_actionpackets = false;
    };

    auto waitForActionPackets = [this, c2, c3, c4]() {
        if (!waitForNodesUpdated(45))
            return false;

        if (c2 && !c2->waitForNodesUpdated(45))
            return false;

        if (c3 && !c3->waitForNodesUpdated(45))
            return false;

        if (c4 && !c4->waitForNodesUpdated(45))
            return false;

        return true;
    };

    resetActionPacketFlags();

    switch (deleteTestBaseFolder(true))
    {
    case 0:
        out() << "deleteTestBaseFolder failed";
        return false;
    case 2:
        if (!waitForActionPackets())
        {
            out() << "No actionpacket received in at least one client for base folder deletion.";
            return false;
        }
        break;
    default:
        break;
    }

    resetActionPacketFlags();

    auto p1 = thread_do<bool>([](StandardClient& sc, PromiseBoolSP pb) { sc.ensureTestBaseFolder(true, pb); }, __FILE__, __LINE__);
    if (!waitonresults(&p1)) {
        out() << "ensureTestBaseFolder failed";
        return false;
    }

    if (!waitForActionPackets())
    {
        out() << "No actionpacket received in at least one client for base folder creation";
        return false;
    }

    auto checkOtherClient = [this](StandardClient* c, bool finalcheck) {
        if (c)
        {
            auto p1 = c->thread_do<bool>([](StandardClient& sc, PromiseBoolSP pb) { sc.ensureTestBaseFolder(false, pb); }, __FILE__, __LINE__);
            if (!waitonresults(&p1)) {
                if (finalcheck) { out() << "ensureTestBaseFolder c2 failed"; }
                return false;
            }
            if (c->basefolderhandle != basefolderhandle)
            {
                if (finalcheck) { out() << "base folder handle mismatch with c2"; }
                return false;
            }
        }
        return true;
    };

    // although we waited for actionpackets, it's possible that wait was satisfied by some late actionpacket from a prior test.
    // wait a bit longer if it's not there already
    for (int i = 60; i--; )
    {
        if (checkOtherClient(c2, false) &&
            checkOtherClient(c3, false) &&
            checkOtherClient(c4, false))
            return true;
        WaitMillisec(1000);
    }

    if (!checkOtherClient(c2, true)) return false;
    if (!checkOtherClient(c3, true)) return false;
    if (!checkOtherClient(c4, true)) return false;
    return true;
}

std::function<bool(StandardClient&)> RequestsCompleted()
{
    return [](StandardClient& client) {
        return client.requestsCompleted();
    };
}

std::function<bool(StandardClient&)> TransfersCompleted(direction_t type)
{
    return [type](StandardClient& client) {
        return client.transfersCompleted(type);
    };
}

void StandardClient::cleanupForTestReuse(int loginIndex)
{
    // remove .megaignore.default in case other tests left one lying around
    auto defaultignorepath = client.dbaccess->rootPath();
    defaultignorepath.appendWithSeparator(LocalPath::fromRelativePath(".megaignore.default"), false);
    std::error_code ec;
    fs::remove(defaultignorepath.toPath(false), ec);

    if (client.nodeByPath("/abort_jenkins_test_run"))
    {
        [[maybe_unused]] const auto [user, _] =
            getEnvVarAccounts().getVarValues(static_cast<size_t>(loginIndex));
        cout << "Detected node /abort_jenkins_test_run in account " << user << ", aborting test run" << endl;
        out() << "Detected node /abort_jenkins_test_run in account " << user << ", aborting test run";
        WaitMillisec(100);
        exit(1);
    }

    LOG_debug << clientname << "cleaning syncs for client reuse";
    future<bool> p1;
    p1 = thread_do<bool>(
        [=, this](StandardClient& sc, PromiseBoolSP pb)
        {
            sc.client.syncs.prepareForLogout(false,
                                             [this, pb]()
                                             {
                                                 // 3rd param true to "load" (zero) syncs again so
                                                 // store is ready for the test
                                                 client.syncs.locallogout(true, false, true);
                                                 pb->set_value(true);
                                             });
        },
        __FILE__,
        __LINE__);
    if (!waitonresults(&p1))
    {
        out() << "removeSelectedSyncs failed";
    }
    assert(client.syncs.getConfigs(false).empty());

    // delete everything from Vault
    std::atomic<int> requestcount{0};
    p1 = thread_do<bool>(
        [=, &requestcount](StandardClient& sc, PromiseBoolSP)
        {
            if (auto vault = sc.client.nodeByHandle(sc.client.mNodeManager.getRootNodeVault()))
            {
                for (auto n: sc.client.mNodeManager.getChildren(vault.get()))
                {
                    LOG_debug << "vault child: " << n->displaypath();
                    for (auto& n2: sc.client.mNodeManager.getChildren(n.get()))
                    {
                        LOG_debug << "Unlinking: " << n2->displaypath();
                        ++requestcount;
                        sc.client.unlink(n2.get(),
                                         false,
                                         0,
                                         true,
                                         [&requestcount](NodeHandle, Error)
                                         {
                                             --requestcount;
                                         });
                    }
                }
            }
        },
        __FILE__,
        __LINE__);

    // delete everything from //bin
    p1 = thread_do<bool>(
        [=, &requestcount](StandardClient& sc, PromiseBoolSP)
        {
            if (auto bin = sc.client.nodeByHandle(sc.client.mNodeManager.getRootNodeRubbish()))
            {
                for (auto n: sc.client.mNodeManager.getChildren(bin.get()))
                {
                    LOG_debug << "Unlinking from bin: " << n->displaypath();
                    ++requestcount;
                    sc.client.unlink(n.get(),
                                     false,
                                     0,
                                     false,
                                     [&requestcount](NodeHandle, Error)
                                     {
                                         --requestcount;
                                     });
                }
            }
        },
        __FILE__,
        __LINE__);

    int limit = 100;
    while (requestcount.load() > 0 && --limit)
    {
        WaitMillisec(100);
    }

    mStallDetected.store(false);
    mConflictsDetected.store(false);
    mTotalStallsUpdated.store(false);
    mTotalConflictsUpdated.store(false);

    // Nuke any custom exclusion rules.
    client.syncs.mNewSyncFilterChain.reset();

    // Make sure any throttles are reset.
    setDownloadSpeed(0);
    setUploadSpeed(0);

    // Make sure any event handlers are released.
    // TODO: May require synchronization?
    mOnConflictsDetected = nullptr;
    mOnFileAdded = nullptr;
    mOnFileComplete = nullptr;
    mOnStall = nullptr;
    mOnSyncStateConfig = nullptr;
    mOnTransferAdded = nullptr;
    onTransferCompleted = nullptr;
    mOnTotalConflictsUpdate = nullptr;
    mOnTotalStallsUpdate = nullptr;

#ifndef NDEBUG // match the conditon in the header
    mOnMoveBegin = nullptr;
#endif

    LOG_debug << clientname << "cleaning transfers for client reuse";

    future<bool> p2 = thread_do<bool>([=](StandardClient& sc, PromiseBoolSP pb) {

        CancelToken cancelled(true);
        int direction[] = { PUT, GET };
        for (int d = 0; d < 2; ++d)
        {
            for (auto& it : sc.client.multi_transfers[direction[d]])
            {
                for (auto& it2 : it.second->files)
                {
                    if (!it2->syncxfer)
                    {
                        it2->cancelToken = cancelled;
                    }
                }
            }
        }

        pb->set_value(true);
    }, __FILE__, __LINE__);
    if (!waitonresults(&p2))
    {
        out() << "transfer removal failed";
    }

    // wait for completion of ongoing transfers, up to 30s
    waitFor(TransfersCompleted(GET), std::chrono::seconds(30));
    waitFor(TransfersCompleted(PUT), std::chrono::seconds(30));

    LOG_debug << clientname << "transfers cleaned";

    // wait further for reqs to finish if any are queued, up to 30s
    waitFor(TransfersCompleted(PUT), std::chrono::seconds(30));

    // check transfers were canceled successfully
    if (transfersCompleted(GET) && transfersCompleted(PUT))
    {
        LOG_debug << clientname << "transfers cleaned successfully";
    }
    else
    {
        LOG_err << clientname << "Failed to clean transfers at cleanupForTestReuse():"
                   << " put: " << client.multi_transfers[PUT].size()
                   << " get: " << client.multi_transfers[GET].size();
    }

    // wait for cmds in flight and queued, up to 120s
    if (!requestsCompleted())
    {
        LOG_debug << clientname << "waiting for requests to finish";
        waitFor(RequestsCompleted(), std::chrono::seconds(120));
    }

    // check any pending command was completed
    if (requestsCompleted())
    {
        LOG_debug << clientname << "requests cleaned successfully";
    }
    else
    {
        LOG_err << clientname << "Failed to clean pending commands at cleanupForTestReuse():"
                << " pending: " << client.reqs.readyToSend()
                << " inflight: " << client.reqs.cmdsInflight();
    }

}

bool StandardClient::login_reset_makeremotenodes(const string& prefix, int depth, int fanout, bool noCache)
{
    return login_reset_makeremotenodes("MEGA_EMAIL", "MEGA_PWD", prefix, depth, fanout, noCache);
}

bool StandardClient::login_reset_makeremotenodes(const string& user, const string& pw, const string& prefix, int depth, int fanout, bool noCache)
{
    if (!login_reset(user, pw, noCache))
    {
        out() << "login_reset failed";
        return false;
    }
    future<bool> p1 = thread_do<bool>([=](StandardClient& sc, PromiseBoolSP pb) { sc.makeCloudSubdirs(prefix, depth, fanout, pb); }, __FILE__, __LINE__);
    if (!waitonresults(&p1))
    {
        out() << "makeCloudSubdirs failed";
        return false;
    }
    return true;
}

bool StandardClient::login(const string& user, const string& pw)
{
    future<bool> p;
    p = thread_do<bool>([=](StandardClient& sc, PromiseBoolSP pb) { sc.preloginFromEnv(user, pb); }, __FILE__, __LINE__);
    if (!waitonresults(&p)) return false;
    p = thread_do<bool>([=](StandardClient& sc, PromiseBoolSP pb) { sc.loginFromEnv(user, pw, pb); }, __FILE__, __LINE__);
    return waitonresults(&p);
}

bool StandardClient::login_fetchnodes(const string& user, const string& pw, bool makeBaseFolder, bool noCache)
{
    received_user_alerts = false;

    future<bool> p2;
    p2 = thread_do<bool>([=](StandardClient& sc, PromiseBoolSP pb) { sc.preloginFromEnv(user, pb); }, __FILE__, __LINE__);
    if (!waitonresults(&p2)) return false;
    p2 = thread_do<bool>([=](StandardClient& sc, PromiseBoolSP pb) { sc.loginFromEnv(user, pw, pb); }, __FILE__, __LINE__);
    if (!waitonresults(&p2)) return false;
    p2 = thread_do<bool>([=](StandardClient& sc, PromiseBoolSP pb) { sc.fetchnodes(noCache, true, false, pb); }, __FILE__, __LINE__);
    if (!waitonresults(&p2)) return false;

    EXPECT_TRUE(waitForUserAlertsUpdated(30));

    p2 = thread_do<bool>([=](StandardClient& sc, PromiseBoolSP pb) { sc.upgradeSecurity(pb); }, __FILE__, __LINE__);
    if (!waitonresults(&p2)) return false;

    p2 = thread_do<bool>([makeBaseFolder](StandardClient& sc, PromiseBoolSP pb) { sc.ensureTestBaseFolder(makeBaseFolder, pb); }, __FILE__, __LINE__);
    if (!waitonresults(&p2)) return false;
    return true;
}

bool StandardClient::login_fetchnodesFromSession(const string& session)
{
    future<bool> p2;
    p2 = thread_do<bool>([=](StandardClient& sc, PromiseBoolSP pb) { sc.loginFromSession(session, pb); }, __FILE__, __LINE__);
    if (!waitonresults(&p2)) return false;
    p2 = thread_do<bool>([](StandardClient& sc, PromiseBoolSP pb) { sc.fetchnodes(false, true, false, pb); }, __FILE__, __LINE__);
    if (!waitonresults(&p2)) return false;

    p2 = thread_do<bool>([](StandardClient& sc, PromiseBoolSP pb) { sc.ensureTestBaseFolder(false, pb); }, __FILE__, __LINE__);
    if (!waitonresults(&p2)) return false;
    return true;
}

bool StandardClient::delSync_mainthread(handle backupId)
{
    future<bool> fb = thread_do<bool>([=](StandardClient& mc, PromiseBoolSP pb) { mc.delSync_inthread(backupId, pb); }, __FILE__, __LINE__);
    return fb.get();
}

bool StandardClient::confirmModel_mainthread(Model::ModelNode* mnode, handle backupId, bool ignoreDebris, int confirm, bool expectFail, bool skipIgnoreFile)
{
    return thread_do<bool>([=](StandardClient& sc, PromiseBoolSP pb) {
        pb->set_value(sc.confirmModel(backupId, mnode, confirm, ignoreDebris, expectFail, skipIgnoreFile));
    }, __FILE__, __LINE__).get();
}

bool StandardClient::match(handle id, const Model::ModelNode* source)
{
    if (!source) return false;

    auto result = thread_do<bool>([=](StandardClient& client, PromiseBoolSP result) {
        client.match(id, source, std::move(result));
    }, __FILE__, __LINE__);

    auto status = result.wait_for(DEFAULTWAIT);

    EXPECT_NE(status, future_status::timeout);

    if (status == future_status::timeout)
        return false;

    return result.get();
}

void StandardClient::match(handle id, const Model::ModelNode* source, PromiseBoolSP result)
{
    SyncInfo info;

    auto found = syncSet(id, info);
    EXPECT_TRUE(found);

    if (!found)
        return result->set_value(false);

    const auto destination = client.nodeByHandle(info.h);
    EXPECT_TRUE(destination);

    result->set_value(destination && match(*destination, *source));
}

bool StandardClient::match(NodeHandle handle, const Model::ModelNode* source)
{
    auto result = thread_do<bool>([&](StandardClient& client, PromiseBoolSP result) {
        client.match(handle, source, std::move(result));
    }, __FILE__, __LINE__);

    auto status = result.wait_for(DEFAULTWAIT);
    EXPECT_NE(status, future_status::timeout);

    if (status == future_status::timeout)
        return false;

    return result.get();
}

void StandardClient::match(NodeHandle handle, const Model::ModelNode* source, PromiseBoolSP result)
{
    EXPECT_TRUE(source);
    if (!source)
        return result->set_value(false);

    auto node = client.nodeByHandle(handle);
    EXPECT_TRUE(node);

    result->set_value(node && match(*node, *source));
}

bool StandardClient::waitFor(std::function<bool(StandardClient&)> predicate,
                             std::chrono::seconds timeout,
                             std::chrono::milliseconds sleepIncrement)
{
    resetClientDowaitDs();
    auto total = std::chrono::milliseconds(0);

    out() << "Waiting for predicate to match...";

    for (;;)
    {
        if (predicate(*this))
        {
            out() << "Predicate has matched!";

            return true;
        }

        if (const auto clientDowaitSecs = consumeClientDowaitDs(10);
            clientDowaitSecs > 0 && timeout < std::chrono::seconds(300))
        {
            LOG_debug << "Adding " << clientDowaitSecs << " secs to timeout";
            timeout += std::chrono::seconds(clientDowaitSecs);
        }

        if (total >= timeout)
        {
            out() << "Timed out waiting for predicate to match.";
            return false;
        }

        std::this_thread::sleep_for(sleepIncrement);
        total += sleepIncrement;
    }
}

bool StandardClient::match(const Node& destination, const Model::ModelNode& source) const
{
    list<pair<const Node*, decltype(&source)>> pending;
    auto matched = true;

    pending.emplace_back(&destination, &source);

    for ( ; !pending.empty(); pending.pop_front())
    {
        const auto& dn = *pending.front().first;
        const auto& sn = *pending.front().second;

        // Nodes must have matching types.
        if (!sn.typematchesnodetype(dn.type))
        {
            LOG_debug << "Cloud model/type mismatch: "
                      << dn.displaypath()
                      << "("
                      << dn.type
                      << ")"
                      << " vs. "
                      << sn.path()
                      << "("
                      << sn.type
                      << ")";

            matched = false;
            continue;
        }

        // Files require no further processing.
        if (dn.type == FILENODE) continue;

        map<string, decltype(&dn), CloudNameLess> dc;
        map<string, decltype(&sn), CloudNameLess> sc;
        set<string, CloudNameLess> dd;
        set<string, CloudNameLess> sd;

        // Index children for pairing.
        sharedNode_list children = dn.client->getChildren(&dn);
        for (auto& child : children)
        {
            string name = child->displayname();

            // Duplicate already reported?
            if (dd.count(name))
            {
                LOG_debug << "Cloud name conflict: "
                          << child->displaypath();
                continue;
            }

            auto result = dc.emplace(child->displayname(), child.get());

            // Didn't exist? No duplicate.
            if (result.second)
                continue;

            LOG_debug << "Cloud name conflict: "
                      << child->displaypath();

            // Remmber the duplicate (name conflict.)
            dc.erase(result.first);
            dd.emplace(name);

            matched = false;
        }

        for (const auto& child : sn.kids)
        {
            auto name = child->cloudName();

            // Duplicate already reported?
            if (dd.count(name))
            {
                LOG_debug << "Model node excluded due to cloud duplicates: "
                          << child->path();
                continue;
            }

            if (sd.count(name))
            {
                LOG_debug << "Model name conflict: "
                          << child->path();
                continue;
            }

            auto result = sc.emplace(child->cloudName(), child.get());

            // Didn't exist? No duplicate.
            if (result.second)
                continue;

            LOG_debug << "Model name conflict: "
                      << child->path();

            // Remember the duplicate.
            dc.erase(name);
            sc.erase(result.first);
            sd.emplace(name);

            matched = false;
        }

        // Pair children.
        for (const auto& s : sc)
        {
            // Skip the debris folder if it appears in the root.
            if (&sn == &source)
            {
                if (CloudNameLess::equal(s.first, DEBRISFOLDER))
                {
                    continue;
                }
            }

            // Does this node have a pair in the destination?
            auto d = dc.find(s.first);

            matched &= d != dc.end();

            // If not then there can be no match.
            if (d == dc.end())
            {
                LOG_debug << "Model node has no pair in cloud: "
                          << s.second->path();
                continue;
            }

            // Queue pair for more detailed matching.
            pending.emplace_back(d->second, s.second);

            // Consider the destination node paired.
            dc.erase(d);
        }

        // Can't have a match if we couldn't pair all destination nodes.
        matched &= dc.empty();

        // Log which nodes we couldn't match.
        for (const auto& d : dc)
        {
            LOG_debug << "Cloud node has no pair in the model: "
                      << d.second->displaypath();
        }

    }

    return matched;
}

bool StandardClient::backupOpenDrive(const fs::path& drivePath)
{
    auto result = thread_do<bool>([=](StandardClient& client, PromiseBoolSP result) {
        client.backupOpenDrive(drivePath, std::move(result));
    }, __FILE__, __LINE__);

    return result.get();
}

void StandardClient::backupOpenDrive(const fs::path& drivePath, PromiseBoolSP result)
{
    auto localDrivePath = LocalPath::fromAbsolutePath(path_u8string(drivePath));
    client.syncs.backupOpenDrive(localDrivePath, [result](Error e){
        result->set_value(e == API_OK);
    });
}

void StandardClient::triggerPeriodicScanEarly(handle backupID)
{
    client.syncs.triggerPeriodicScanEarly(backupID).get();
}

void StandardClient::checkSyncProblems(const handle backupId,
                                       const int /*backupIdsCount*/,
                                       const unsigned int totalExpectedConflicts,
                                       const LocalPath& localPath,
                                       const std::string& f1,
                                       const std::string& f2)
{
    SyncProblems problems;
    syncproblemsDetected(problems);
    auto itCn = problems.mConflictsMap.find(backupId);
    ASSERT_NE(itCn, problems.mConflictsMap.end())
        << "BackupId (" << toHandle(backupId) << ") not found in ConflictsMap";
    auto& conflicts = itCn->second;
    ASSERT_EQ(conflicts.size(), totalExpectedConflicts) << "Unexpected ConflictsMap size";

    const auto isExpectedConflict = [&localPath, &f1, &f2](const NameConflict& nc)
    {
        return nc.localPath == localPath &&
               std::find(nc.clashingLocalNames.begin(),
                         nc.clashingLocalNames.end(),
                         LocalPath::fromRelativePath(f1)) != nc.clashingLocalNames.end() &&
               std::find(nc.clashingLocalNames.begin(),
                         nc.clashingLocalNames.end(),
                         LocalPath::fromRelativePath(f2)) != nc.clashingLocalNames.end();
    };

    using namespace testing;
    EXPECT_THAT(conflicts, Contains(Truly(isExpectedConflict)));
}

void StandardClient::createHardLink(const fs::path& src,
                                    const fs::path& dst,
                                    LocalPath& sourcePath,
                                    LocalPath& targetPath)
{
    auto fsAccess = client.fsaccess.get();
    sourcePath = LocalPath::fromAbsolutePath(path_u8string(src));
    targetPath = LocalPath::fromAbsolutePath(path_u8string(dst));
    ASSERT_TRUE(fsAccess->hardLink(sourcePath, targetPath));
}

void StandardClient::unlinklocal(const LocalPath& localPath)
{
    bool nonTransientErrorFound{false};
    const auto result = waitFor(
        [&](StandardClient& sc)
        {
            if (!sc.client.fsaccess->unlinklocal(localPath))
            {
                nonTransientErrorFound = !sc.client.fsaccess->transient_error;
                return nonTransientErrorFound;
            }

            return true;
        },
        DEFAULTWAIT);
    ASSERT_TRUE(result && !nonTransientErrorFound);
}

void StandardClient::checkStallIssues(const handle /*backupId*/,
                                      const unsigned int expectedStalls,
                                      LocalPath& sourcePath,
                                      LocalPath& targetPath)
{
    SyncProblems problems;
    syncproblemsDetected(problems);
    ASSERT_EQ(problems.mStalls.syncStallInfoMaps.size(), expectedStalls)
        << "Unexpected syncStallInfoMaps size";

    SyncStallInfoTests stalls;
    stalls.extractFrom(problems.mStalls);
    ASSERT_FALSE(stalls.local.empty()) << "No stall issues detected";

    const auto isExpectedStall = [&sourcePath, &targetPath](const SyncStallEntry& sr) -> bool
    {
        return sr.localPath1.localPath == sourcePath && sr.localPath2.localPath == targetPath &&
               sr.reason == SyncWaitReason::FileIssue &&
               sr.localPath1.problem == PathProblem::DetectedHardLink &&
               sr.localPath2.problem == PathProblem::DetectedHardLink;
    };
    using namespace testing;
    EXPECT_THAT(stalls.local, Contains(Pair(_, Truly(isExpectedStall))))
        << "Expected stall issue could not be found";
}

handle StandardClient::getNodeHandle(const CloudItem& item)
{
    auto result = thread_do<handle>([&](StandardClient& client, PromiseHandleSP result) {
        client.getNodeHandle(item, std::move(result));
    }, __FILE__, __LINE__);

    auto status = result.wait_for(DEFAULTWAIT);
    EXPECT_NE(status, future_status::timeout);

    if (status == future_status::timeout)
        return false;

    return result.get();
}

void StandardClient::getNodeHandle(const CloudItem& item, PromiseHandleSP result)
{
    if (auto node = item.resolve(*this))
        return result->set_value(node->nodehandle);

    result->set_value(UNDEF);
}

FileFingerprint StandardClient::fingerprint(const fs::path& fsPath)
{
    // Convenience.
    auto& fsAccess = *client.fsaccess;

    // Needed so we can access the filesystem.
    auto fileAccess = fsAccess.newfileaccess(false);

    // Translate input path into something useful.
    auto path = LocalPath::fromAbsolutePath(path_u8string(fsPath));

    FileFingerprint fingerprint;

    // Try and open file for reading.
    if (fileAccess->fopen(path, OPEN_RDONLY, FSLogging::logOnError))
    {
        // Generate fingerprint.
        fingerprint.genfingerprint(fileAccess.get());
    }

    return fingerprint;
}

vector<FileFingerprint> StandardClient::fingerprints(const string& path)
{
    vector<FileFingerprint> results;

    // Get our hands on the root node.
    auto root = gettestbasenode();

    if (!root)
        return results;

    // Locate the specified node.
    auto node = drillchildnodebyname(root, path);

    if (!node)
        return results;

    // Directories have no fingerprints.
    if (node->type != FILENODE)
        return results;

    // Extract the fingerprints from the version chain.
    results.emplace_back(*node);

    auto nodes = client.mNodeManager.getChildren(node.get());

    while (!nodes.empty())
    {
        node = nodes.front();
        results.emplace_back(*node);
        nodes = client.mNodeManager.getChildren(node.get());
    }

    // Pass fingerprints to caller.
    return results;
}

void StandardClient::ipcr(handle id, ipcactions_t action, PromiseBoolSP result)
{
    client.updatepcr(id, action, [=](error e, ipcactions_t) {
        result->set_value(!e);
    });
}

bool StandardClient::ipcr(handle id, ipcactions_t action)
{
    auto result = thread_do<bool>([=](StandardClient& client, PromiseBoolSP result) {
        client.ipcr(id, action, std::move(result));
    }, __FILE__, __LINE__);

    auto status = result.wait_for(std::chrono::seconds(45));
    EXPECT_NE(status, future_status::timeout);

    if (status == future_status::timeout)
        return false;

    return result.get();
}

bool StandardClient::ipcr(handle id)
{
    auto result = thread_do<bool>([=](StandardClient& client, PromiseBoolSP result) {
        auto i = client.client.pcrindex.find(id);
        auto j = client.client.pcrindex.end();

        result->set_value(i != j && !i->second->isoutgoing);
    }, __FILE__, __LINE__);

    auto status = result.wait_for(std::chrono::seconds(45));
    EXPECT_NE(status, future_status::timeout);

    if (status == future_status::timeout)
        return false;

    return result.get();
}

void StandardClient::opcr(const string& email, opcactions_t action, PromiseHandleSP result)
{
    auto completion = [=](handle h, error e, opcactions_t) {
        result->set_value(!e ? h : UNDEF);
    };

    client.setpcr(email.c_str(),
                  action,
                  nullptr,
                  nullptr,
                  UNDEF,
                  std::move(completion));
}

handle StandardClient::opcr(const string& email, opcactions_t action)
{
    auto result = thread_do<handle>([&](StandardClient& client, PromiseHandleSP result) {
        client.opcr(email, action, std::move(result));
    }, __FILE__, __LINE__);

    auto status = result.wait_for(std::chrono::seconds(45));
    EXPECT_NE(status, future_status::timeout);

    if (status == future_status::timeout)
        return false;

    return result.get();
}

bool StandardClient::opcr(const string& email)
{
    auto result = thread_do<bool>([&](StandardClient& client, PromiseBoolSP result) {
        for (auto& i : client.client.pcrindex)
        {
            if (i.second->targetemail == email)
                return result->set_value(i.second->isoutgoing);
        }

        result->set_value(false);
    }, __FILE__, __LINE__);

    auto status = result.wait_for(std::chrono::seconds(45));
    EXPECT_NE(status, future_status::timeout);

    if (status == future_status::timeout)
        return false;

    return result.get();
}

bool StandardClient::iscontact(const string& email)
{
    auto result = thread_do<bool>([&](StandardClient& client, PromiseBoolSP result) {
        for (auto &i : client.client.users)
        {
            if (i.second.email == email)
                return result->set_value(i.second.show == VISIBLE);
        }

        result->set_value(false);
    }, __FILE__, __LINE__);

    auto status = result.wait_for(std::chrono::seconds(45));
    EXPECT_NE(status, future_status::timeout);

    if (status == future_status::timeout)
        return false;

    return result.get();
}

bool StandardClient::isverified(const string& email)
{
    auto result = thread_do<bool>([&](StandardClient& client, PromiseBoolSP result) {
        User* u = client.client.finduser(email.c_str());
        if (u) {
            result->set_value(client.client.areCredentialsVerified(u->userhandle));
        }
        else
        {
            result->set_value(false);
        }
    }, __FILE__, __LINE__);

    auto status = result.wait_for(DEFAULTWAIT);
    EXPECT_NE(status, future_status::timeout);

    if (status == future_status::timeout)
        return false;

    return result.get();
}

bool StandardClient::verifyCredentials(const string& email)
{
    auto result = thread_do<bool>([&](StandardClient& client, PromiseBoolSP result) {
        User* u = client.client.finduser(email.c_str());
        if (u) {
            result->set_value(client.client.verifyCredentials(u->userhandle, nullptr) == API_OK);
        }
        else
        {
            result->set_value(false);
        }
    }, __FILE__, __LINE__);

    auto status = result.wait_for(DEFAULTWAIT);
    EXPECT_NE(status, future_status::timeout);

    if (status == future_status::timeout)
        return false;

    return result.get();
}

bool StandardClient::resetCredentials(const string& email)
{
    auto result = thread_do<bool>([&](StandardClient& client, PromiseBoolSP result) {
        User* u = client.client.finduser(email.c_str());
        if (u) {
            result->set_value(client.client.resetCredentials(u->userhandle, nullptr) == API_OK);
        }
        else
        {
            result->set_value(false);
        }
    }, __FILE__, __LINE__);

    auto status = result.wait_for(DEFAULTWAIT);
    EXPECT_NE(status, future_status::timeout);

    if (status == future_status::timeout)
        return false;

    return result.get();
}

void StandardClient::rmcontact(const string& email, PromiseBoolSP result)
{
    client.removecontact(email.c_str(), HIDDEN, [=](error e) {
        result->set_value(!e);
    });
}

bool StandardClient::rmcontact(const string& email)
{
    auto result = thread_do<bool>([&](StandardClient& client, PromiseBoolSP result) {
        client.rmcontact(email, std::move(result));
    }, __FILE__, __LINE__);

    auto status = result.wait_for(std::chrono::seconds(45));
    EXPECT_NE(status, future_status::timeout);

    if (status == future_status::timeout)
        return false;

    return result.get();
}

void StandardClient::opensharedialog(const CloudItem& item, PromiseErrorSP result)
{
    auto node = item.resolve(*this);

    if (!node)
        return result->set_value(API_ENOENT);

    client.openShareDialog(node.get(), [result](Error e) {
        result->set_value(e);
    });
}

Error StandardClient::opensharedialog(const CloudItem& item)
{
    auto result = thread_do<Error>([&](StandardClient& client, PromiseErrorSP result) {
        client.opensharedialog(item, std::move(result));
    }, __FILE__, __LINE__);

    auto status = result.wait_for(DEFAULTWAIT);
    EXPECT_NE(status, future_status::timeout);

    if (status == future_status::timeout)
        return LOCAL_ETIMEOUT;

    return result.get();
}

void StandardClient::share(const CloudItem& item, const string& email, accesslevel_t permissions, PromiseErrorSP result)
{
    auto node = item.resolve(*this);

    if (!node)
        return result->set_value(API_ENOENT);

    auto completion = [result](Error e, bool) {
        result->set_value(e);
    }; // completion

    client.setshare(node,
                    email.c_str(),
                    permissions,
                    false,
                    nullptr,
                    ++next_request_tag,
                    std::move(completion));
}

Error StandardClient::share(const CloudItem& item,
                            const string& email,
                            accesslevel_t permissions)
{
    auto result = thread_do<Error>([&](StandardClient& client, PromiseErrorSP result) {
        client.share(item, email, permissions, std::move(result));
    }, __FILE__, __LINE__);

    auto status = result.wait_for(DEFAULTWAIT);
    EXPECT_NE(status, future_status::timeout);

    if (status == future_status::timeout)
        return LOCAL_ETIMEOUT;

    return result.get();
}

void StandardClient::upgradeSecurity(PromiseBoolSP result)
{
    client.upgradeSecurity([=](error e) {
        result->set_value(!e);
    });
}

void StandardClient::setHasImmediateStall(HasImmediateStallPredicate predicate)
{
    std::lock_guard<std::recursive_mutex> guard(clientMutex);

    client.syncs.setHasImmediateStall(std::move(predicate));
}

void StandardClient::setIsImmediateStall(IsImmediateStallPredicate predicate)
{
    std::lock_guard<std::recursive_mutex> guard(clientMutex);

    client.syncs.setIsImmediateStall(std::move(predicate));
}

void StandardClient::setSyncController(SyncControllerPtr controller)
{
    std::lock_guard<std::recursive_mutex> guard(clientMutex);

    client.syncs.setSyncController(std::move(controller));
}

void StandardClient::setDownloadSpeed(m_off_t downloadSpeed)
{
    std::lock_guard<std::recursive_mutex> guard(clientMutex);

    client.setmaxdownloadspeed(downloadSpeed);
}

void StandardClient::setUploadSpeed(m_off_t uploadSpeed)
{
    std::lock_guard<std::recursive_mutex> guard(clientMutex);

    client.setmaxuploadspeed(uploadSpeed);
}

void StandardClient::prepareOneFolder(NewNode* node, const std::string& name, bool canChangeVault)
{
    prepareOneFolder(node, name.c_str(), canChangeVault);
}

void StandardClient::prepareOneFolder(NewNode* node, const char* name, bool canChangeVault)
{
    std::lock_guard<std::recursive_mutex> guard(clientMutex);
    client.putnodes_prepareOneFolder(node, name, canChangeVault);
}

bool StandardClient::requestsCompleted() const
{
    // Acquire client mutex.
    std::lock_guard guard(clientMutex);

    // Check if any requests are inflight or queued.
    return !(client.reqs.cmdsInflight() || client.reqs.readyToSend());
}

bool StandardClient::transfersCompleted(direction_t type) const
{
    // Acquire client mutex.
    std::lock_guard guard(clientMutex);

    // Check if transfers have completed.
    return client.multi_transfers[type].empty();
}

using SyncWaitPredicate = std::function<bool(StandardClient&)>;

// Useful predicates.
SyncWaitPredicate SyncDisabled(handle id)
{
    return [id](StandardClient& client) {
        return client.syncByBackupId(id) == nullptr;
    };
}

SyncWaitPredicate SyncMonitoring(handle id)
{
    return [id](StandardClient& client) {
        const auto* sync = client.syncByBackupId(id);
        return sync && sync->isBackupMonitoring();
    };
}

SyncWaitPredicate SyncStallState(bool state)
{
    return [state](StandardClient& client) {
        return client.mStallDetected == state;
    };
}

SyncWaitPredicate SyncConflictState(bool state)
{
    return [state](StandardClient& client) {
        return client.mConflictsDetected == state;
    };
}

SyncWaitPredicate SyncTotalStallsStateUpdate(bool state)
{
    return [state](StandardClient& client) {
        return client.mTotalStallsUpdated == state;
    };
}

SyncWaitPredicate SyncTotalConflictsStateUpdate(bool state)
{
    return [state](StandardClient& client) {
        return client.mTotalConflictsUpdated == state;
    };
}

SyncWaitPredicate SyncRemoteMatch(const CloudItem& item, const Model::ModelNode* source)
{
    return [=](StandardClient& client) {
        return client.thread_do<bool>([&](StandardClient& client, PromiseBoolSP result) {
            if (auto node = item.resolve(client))
                return client.match(node->nodeHandle(), source, std::move(result));
            result->set_value(false);
        }, __FILE__, __LINE__).get();
    };
}

SyncWaitPredicate SyncRemoteMatch(const CloudItem& item, const Model& source)
{
    return SyncRemoteMatch(item, source.root.get());
}

SyncWaitPredicate SyncRemoteNodePresent(const CloudItem& item)
{
    return [item](StandardClient& client)
    {
        return client
            .thread_do<bool>(
                [&](StandardClient& client, PromiseBoolSP result)
                {
                    result->set_value(item.resolve(client) != nullptr);
                },
                __FILE__,
                __LINE__)
            .get();
    };
}

SyncWaitPredicate SyncScanState(bool expected)
{
    return [=](StandardClient& client) {
        return client.client.syncs.syncscanstate == expected;
    };
}

struct SyncWaitResult
{
    bool syncStalled = false;
    SyncStallInfoTests stall;
};

bool noSyncStalled(vector<SyncWaitResult>& v)
{
    for (auto& e : v)
    {
        if (e.syncStalled) return false;
    }
    return true;
}

using WaitOnSyncsEndCondition =
    std::function<bool(const std::chrono::milliseconds noActivityTime,
                       const std::chrono::milliseconds noSyncingTime,
                       const std::chrono::seconds noActivityExtraTimeForTimeout)>;

vector<SyncWaitResult> waitonsyncs(WaitOnSyncsEndCondition&& endCondition,
                                   StandardClient* c1 = nullptr,
                                   StandardClient* c2 = nullptr,
                                   StandardClient* c3 = nullptr,
                                   StandardClient* c4 = nullptr)
{
    LOG_debug << "waitonsyncs starts";
    auto totalTimeoutStart = chrono::steady_clock::now();
    auto startNoActivity = chrono::steady_clock::now();
    auto startNoSyncing = chrono::steady_clock::now();

    auto startStalled = chrono::steady_clock::now();
    bool stallStarted = false;

    vector<StandardClient*> v{ c1, c2, c3, c4 };
    vector<SyncWaitResult> result{SyncWaitResult(), SyncWaitResult(), SyncWaitResult(), SyncWaitResult()};

    for (auto sClient: v)
    {
        if (sClient)
            sClient->resetClientDowaitDs();
    }

    for (;;)
    {
        bool any_activity = false;
        bool any_still_syncing = false;
        bool any_running_at_all = false;
        bool any_stalled = false;
        bool any_stalled_with_pending_reqs_or_scanning = false;

        for (const auto i: range(v.size()))
        {
            if (!v[i])
                continue;

            v[i]->thread_do<bool>(
                    [&](StandardClient& mc, PromiseBoolSP pb)
                    {
                        const auto anyTransfersOrCmds =
                            !mc.client.transferlist.transfers[GET].empty() ||
                            !mc.client.transferlist.transfers[PUT].empty() ||
                            mc.client.reqs.cmdsInflight() ||
                            mc.client.syncs.anySyncHasPendingTransfersThreadSafeState();

                        if (result[i].syncStalled = mc.syncStallDetected(result[i].stall) ||
                                                    mc.client.syncs.syncConflictState;
                            result[i].syncStalled)
                        {
                            any_stalled = true;
                            any_stalled_with_pending_reqs_or_scanning |=
                                (anyTransfersOrCmds || mc.client.syncs.syncscanstate);
                            if (!stallStarted)
                            {
                                stallStarted = true;
                                startStalled = chrono::steady_clock::now();
                            }
                        }
                        else
                        {
                            any_running_at_all |= mc.client.syncs.mNumSyncsActive > 0;
                            any_activity |= (anyTransfersOrCmds || mc.client.syncs.syncBusyState);
                            any_still_syncing |= mc.client.syncs.syncBusyState;
                        }

                        pb->set_value(true);
                    },
                    __FILE__,
                    __LINE__)
                .get();
        }

        if (!any_stalled)
        {
            stallStarted = false;
        }

        if (!any_running_at_all)
        {
            const auto millisecsToWait = any_stalled_with_pending_reqs_or_scanning ?
                                             std::chrono::milliseconds(20000) :
                                             std::chrono::milliseconds(3500);
            const auto stallexit =
                stallStarted && chrono::steady_clock::now() - startStalled > millisecsToWait;
            if (stallexit)
            {
                // don't drop out of the wait if we are only stalled briefly.
                // we've seen this happen if a .megaignore is not read properly -
                // size is known, but read operations returns too few bytes, without error (in RenameReplaceIgnoreFile, on windows)
                LOG_debug << " waitonsyncs detected syncs stalled for " << millisecsToWait.count()
                          << " ms";
            }
            if (!stallStarted || stallexit)
            {
                LOG_debug
                    << " waitonsyncs finished since no non-stalled clients have any running syncs";
                return result;
            }
        }

        if (any_activity || StandardClient::debugging)
        {
            startNoActivity = chrono::steady_clock::now();
        }
        if (any_still_syncing || StandardClient::debugging)
        {
            startNoSyncing = chrono::steady_clock::now();
        }

        auto noActivityExtraTimeForTimeout = std::chrono::seconds(0);
        auto minNoActivityTime = std::chrono::milliseconds(6 * 60 * 1000);
        auto minNoSyncingTime = std::chrono::milliseconds(6 * 60 * 1000);
        for (auto vn : v) if (vn)
        {
            auto t1 = chrono::duration_cast<chrono::milliseconds>(chrono::steady_clock::now() - startNoActivity);
            auto t2 = chrono::duration_cast<chrono::milliseconds>(chrono::steady_clock::now() - vn->lastcb);
            if (t1 < minNoActivityTime) minNoActivityTime = t1;
            if (t2 < minNoActivityTime) minNoActivityTime = t2;

            auto t3 = chrono::duration_cast<chrono::milliseconds>(chrono::steady_clock::now() - startNoSyncing);
            if (t3 < minNoSyncingTime) minNoSyncingTime = t3;

            noActivityExtraTimeForTimeout += std::chrono::seconds(vn->consumeClientDowaitDs(10));
        }
        if (endCondition(minNoActivityTime, minNoSyncingTime, noActivityExtraTimeForTimeout))
        {
            return result;
        }

        WaitMillisec(400);

        if ((chrono::steady_clock::now() - totalTimeoutStart) > std::chrono::minutes(5))
        {
            out() << "waitonsyncs waiting for syncing to stop timed out at 5 minutes";
            return result;
        }
    }
}

void printStallIssues(StandardClient& sc)
{
    SyncStallInfoTests stalls;
    sc.stallsDetected(stalls);
    auto printStallIssue = [](const bool local, const std::string& pathstr, SyncStallEntry& stall)
    {
        LOG_debug << "[Stall issue - " << (local ? "waitingForLocal" : "waitingForCloud")
                  << "]: " << pathstr << "\n\t\t- Reason (" << static_cast<unsigned>(stall.reason)
                  << ")"
                  << "\n\t\t- cloudPath1 (" << stall.cloudPath1.debugReport() << ")"
                  << "\n\t\t- cloudPath2 (" << stall.cloudPath2.debugReport() << ")"
                  << "\n\t\t- localPath1 (" << stall.localPath1.debugReport() << ")"
                  << "\n\t\t- localPath2 (" << stall.localPath2.debugReport() << ")";
    };

    LOG_debug << "Printing cloud stall issues:";
    std::for_each(stalls.cloud.begin(),
                  stalls.cloud.end(),
                  [&printStallIssue](auto& s)
                  {
                      printStallIssue(true, s.first, s.second);
                  });

    LOG_debug << "Printing local stall issues:";
    std::for_each(stalls.local.begin(),
                  stalls.local.end(),
                  [&printStallIssue](auto& s)
                  {
                      printStallIssue(true, s.first.toPath(false), s.second);
                  });
}

vector<SyncWaitResult> waitonsyncs(const std::chrono::seconds timeout = std::chrono::seconds(4),
                                   StandardClient* c1 = nullptr,
                                   StandardClient* c2 = nullptr,
                                   StandardClient* c3 = nullptr,
                                   StandardClient* c4 = nullptr)
{
    auto endCondition = [&timeout](const std::chrono::milliseconds noActivityTime,
                                   const std::chrono::milliseconds noSyncingTime,
                                   const std::chrono::seconds noActivityExtraTimeForTimeout)
    {
        const auto noActivityTimeout =
            std::min<std::chrono::seconds>(timeout + noActivityExtraTimeForTimeout,
                                           std::chrono::minutes(4));
        const auto result = noActivityTime >= noActivityTimeout && noSyncingTime >= timeout;
        if (result)
        {
            LOG_debug << "waitonsyncs complete after " << noActivityTime.count()
                      << " ms of no activity and " << noSyncingTime.count()
                      << " ms of no syncing [timeout = " << timeout.count()
                      << " secs, noActivityExtraTimeForTimeout = "
                      << noActivityExtraTimeForTimeout.count() << " secs]";
        }
        return result;
    };

    return waitonsyncs(std::move(endCondition), c1, c2, c3, c4);
}

bool StandardClient::waitForSyncTotalStallsStateUpdateTrue(const std::chrono::seconds timeout)
{
    if (const auto totalStallsStateUpdateResult =
            waitFor(SyncTotalStallsStateUpdate(true), timeout);
        !totalStallsStateUpdateResult)
    {
        LOG_warn << "SyncTotalStallsStateUpdate(true) was false, it could be due to a change of "
                    "stall state that was temporary false due to pending scans, and then set to "
                    "true again when there only was 1 stall. Checking we are in stall state...";
        return mStallDetected;
    }
    return true;
}

mutex StandardClient::om;
bool StandardClient::debugging = false;



//std::atomic<int> fileSizeCount = 20;

bool createNameFile(const fs::path &p, const string &filename)
{
    return createFile(p / u8path_compat(filename), filename.data(), filename.size());
}

bool createFileWithTimestamp(const fs::path &path,
                             const std::string &data,
                             const fs::path& tmpCreationLocation,
                             const fs::file_time_type &timestamp)
{
    // Create the file at a neutral location first so we can set the timestamp without a sync noticing the wrong timestamp first
    bool result = createFile(tmpCreationLocation / path.filename(), data);

    if (result)
    {
        fs::last_write_time(tmpCreationLocation / path.filename(), timestamp);

        // Now that it has the proper mtime, move it to the correct location
        error_code rename_error;
        fs::rename(tmpCreationLocation / path.filename(), path, rename_error);
        EXPECT_TRUE(!rename_error) << rename_error;
        result = !rename_error;
    }

    return result;
}

bool buildLocalFolders(fs::path targetfolder, const string& prefix, int n, int recurselevel, int filesperfolder)
{
    if (suppressfiles) filesperfolder = 0;

    fs::path p = targetfolder / u8path_compat(prefix);
    if (!fs::create_directory(p))
        return false;

    for (int i = 0; i < filesperfolder; ++i)
    {
        string filename = "file" + to_string(i) + "_" + prefix;
        createNameFile(p, filename);
        //int thisSize = (++fileSizeCount)/2;
        //for (int j = 0; j < thisSize; ++j) fs << ('0' + j % 10);
    }

    if (recurselevel > 0)
    {
        for (int i = 0; i < n; ++i)
        {
            if (!buildLocalFolders(p, prefix + "_" + to_string(i), n, recurselevel - 1, filesperfolder))
                return false;
        }
    }

    return true;
}

void renameLocalFolders(fs::path targetfolder, const string& newprefix)
{
    std::list<fs::path> toRename;
    for (fs::directory_iterator i(targetfolder); i != fs::directory_iterator(); ++i)
    {
        if (fs::is_directory(i->path()))
        {
            renameLocalFolders(i->path(), newprefix);
        }
        toRename.push_back(i->path());
    }

    for (auto p : toRename)
    {
        auto newpath =
            path_u8string(p.parent_path() / u8path_compat(newprefix + path_u8string(p.filename())));
        fs::rename(p, newpath);
    }
}


#ifdef __linux__
bool createSpecialFiles(fs::path targetfolder, const string& prefix, int n = 1)
{
    fs::path p = targetfolder;
    for (int i = 0; i < n; ++i)
    {
        string filename = "file" + to_string(i) + "_" + prefix;
        fs::path fp = p / u8path_compat(filename);

        int fdtmp = openat(AT_FDCWD, p.c_str(), O_RDWR|O_CLOEXEC|O_TMPFILE, 0600);
        if (const auto wrBytes = write(fdtmp, filename.data(), filename.size()); wrBytes < 0)
        {
            cerr << " Error writing file " << filename;
            return false;
        }

        stringstream fdproc;
        fdproc << "/proc/self/fd/";
        fdproc << fdtmp;

        int r = linkat(AT_FDCWD, fdproc.str().c_str() , AT_FDCWD, fp.c_str(), AT_SYMLINK_FOLLOW);
        if (r)
        {
            cerr << " errno =" << errno;
            return false;
        }
        close(fdtmp);
    }
    return true;
}
#endif

class SyncFingerprintCollisionTest
  : public SdkTestBase
{
public:

    fs::path testRootFolder;

    SyncFingerprintCollisionTest()
      : client0()
      , client1()
      , model0()
      , model1()
      , arbitraryFileLength(16384)
    {
        testRootFolder = makeNewTestRoot();

        client0 = std::make_unique<StandardClient>(testRootFolder, "c0");
        client1 = std::make_unique<StandardClient>(testRootFolder, "c1");

        client0->logcb = true;
        client1->logcb = true;
    }

    ~SyncFingerprintCollisionTest()
    {
    }

    void SetUp() override
    {
        SdkTestBase::SetUp();

        SimpleLogger::setLogLevel(logVerbose);

        ASSERT_TRUE(client0->login_reset_makeremotenodes("MEGA_EMAIL", "MEGA_PWD", "d", 1, 2));
        ASSERT_TRUE(client1->login_fetchnodes("MEGA_EMAIL", "MEGA_PWD"));
        ASSERT_EQ(client0->basefolderhandle, client1->basefolderhandle);

        model0.root->addkid(model0.buildModelSubdirs("d", 2, 1, 0));
        model1.root->addkid(model1.buildModelSubdirs("d", 2, 1, 0));

        // Make sure the client's agree on the cloud's state before proceeding.
        {
            auto root = client0->gettestbasenode();
            ASSERT_NE(root, nullptr);

            auto predicate = SyncRemoteMatch(*root, model0.root.get());
            ASSERT_TRUE(client0->waitFor(predicate, DEFAULTWAIT));
            ASSERT_TRUE(client1->waitFor(predicate, DEFAULTWAIT));
        }

        startSyncs();
        waitOnSyncs();
        confirmModels();
    }

    void addModelFile(Model &model,
                      const std::string &directory,
                      const std::string &file,
                      const std::string &content)
    {
        auto *node = model.findnode(directory);
        ASSERT_NE(node, nullptr);

        node->addkid(model.makeModelSubfile(file, content));
    }

    void confirmModel(StandardClient &client, Model &model, handle backupId)
    {
        ASSERT_TRUE(client.confirmModel_mainthread(model.findnode("d"), backupId));
    }

    void confirmModels()
    {
        LOG_debug << "Confirm model client 0...";
        confirmModel(*client0, model0, backupId0);
        LOG_debug << "Confirm model client 1...";
        confirmModel(*client1, model1, backupId1);
        LOG_debug << "After confirming models...";
    }

    const fs::path localRoot0() const
    {
        return client0->syncSet(backupId0).localpath;
    }

    const fs::path localRoot1() const
    {
        return client1->syncSet(backupId1).localpath;
    }

    void prepareForNodeUpdates()
    {
        client0->received_node_actionpackets = false;
        client1->received_node_actionpackets = false;
    }

    void startSyncs()
    {
        backupId0 = client0->setupSync_mainthread("s0", "d", false, true);
        ASSERT_NE(backupId0, UNDEF);
        backupId1 = client1->setupSync_mainthread("s1", "d", false, false);
        ASSERT_NE(backupId1, UNDEF);
    }

    void waitForNodeUpdates()
    {
        ASSERT_TRUE(client0->waitForNodesUpdated(30));
        ASSERT_TRUE(client1->waitForNodesUpdated(30));
    }

    void waitOnSyncs()
    {
        waitonsyncs(chrono::seconds(4), client0.get(), client1.get());
    }

    handle backupId0 = UNDEF;
    handle backupId1 = UNDEF;

    std::unique_ptr<StandardClient> client0;
    std::unique_ptr<StandardClient> client1;
    Model model0;
    Model model1;
    const std::size_t arbitraryFileLength;
}; /* SyncFingerprintCollision */

TEST_F(SyncFingerprintCollisionTest, DifferentMacSameName)
{
    static const std::string logPre{"SyncFingerprintCollisionTest.DifferentMacSameName : "};

    auto data0 = randomData(arbitraryFileLength);
    auto data1 = data0;
    const auto path0 = localRoot0() / "d_0" / "a";
    const auto path1 = localRoot0() / "d_1" / "a";

    prepareForNodeUpdates();
    ASSERT_TRUE(createFile(path0, data0));
    client0->triggerPeriodicScanEarly(backupId0);
    waitForNodeUpdates();

    waitOnSyncs();

    LOG_debug << logPre << "0. Alter MAC but leave fp untouched";
    data1[0x41] = static_cast<char>(~data1[0x41]);

    // Prepare the file outside of the sync's view.
    auto stamp = fs::last_write_time(path0);
    ASSERT_TRUE(
        createFileWithTimestamp(client0->fsBasePath / "a", data1, client0->fsBasePath, stamp));

    LOG_debug << logPre << "0. Move file after altering MAC";
    prepareForNodeUpdates();
    fs::rename(client0->fsBasePath / "a", path1);
    LOG_debug << logPre << "0. File moved after altering MAC";

    client0->triggerPeriodicScanEarly(backupId0);
    waitForNodeUpdates();
    waitOnSyncs();

    LOG_debug << logPre << "0. Adding model files and confirming models";
    addModelFile(model0, "d/d_0", "a", data0);
    addModelFile(model0, "d/d_1", "a", data1);
    addModelFile(model1, "d/d_0", "a", data0);
    addModelFile(model1, "d/d_1", "a", data1);
    model1.ensureLocalDebrisTmpLock("d");
    confirmModels();
    LOG_debug << logPre << "0. Models confirmed after adding model files";

    LOG_debug << logPre << "1. Data change keeping mtime";

    data1[0x41] = static_cast<char>(~data1[0x42]);
    {
        std::unique_ptr<FSACCESS_CLASS> fa(std::make_unique<FSACCESS_CLASS>());
        auto [succeed, oldMtime] =
            fa->getmtimelocal(LocalPath::fromAbsolutePath(path_u8string(path1)));
        ASSERT_TRUE(succeed);

        std::ofstream file(path1, std::ios::binary);
        file.write(data1.data(), static_cast<std::streamsize>(data1.size()));
        file.close();

        ASSERT_TRUE(fa->setmtimelocal(LocalPath::fromAbsolutePath(path_u8string(path1)), oldMtime));
        auto [succeed2, newMtime] =
            fa->getmtimelocal(LocalPath::fromAbsolutePath(path_u8string(path1)));
        ASSERT_TRUE(succeed2);
        ASSERT_EQ(oldMtime, newMtime);
    }
    waitOnSyncs();

    // Update model0 data to data1 so local content matches
    // Do not update model1 because we expect the previous change NOT to be reflected in the cloud,
    // so model1 shouldn't have synced it

    LOG_debug << logPre << "1. Confirm models after data change";
    model0.findnode("d/d_1/a")->content = data1;
    confirmModels();
    LOG_debug << logPre << "1. Models confirmed after data change keeping mtime";

    LOG_debug << logPre << "2. Change mtime local";
    prepareForNodeUpdates();
    std::unique_ptr<FSACCESS_CLASS> mFsAccess;
    mFsAccess = std::make_unique<FSACCESS_CLASS>();
    mFsAccess->setmtimelocal(LocalPath::fromAbsolutePath(path_u8string(path1)), m_time(nullptr));
    client0->triggerPeriodicScanEarly(backupId0);
    waitForNodeUpdates();
    waitOnSyncs();

    // Now we expect this change to have been reflected in the cloud and c1 should have reflected
    // the change
    LOG_debug << logPre << "2. Confirm models after changing mtime local";
    model1.movetosynctrash("d/d_1/a", "d");
    addModelFile(model1, "d/d_1", "a", data1);
    confirmModels();
    LOG_debug << logPre << "2. Models confirmed after changing mtime local";

    LOG_debug << logPre
              << "3. Change mtime local again, this time fp differs in mtime and MACs are equals, "
                 "there shall be no download but a setmtime change";
    prepareForNodeUpdates();
    mFsAccess->setmtimelocal(LocalPath::fromAbsolutePath(path_u8string(path1)), m_time(nullptr));
    client0->triggerPeriodicScanEarly(backupId0);
    waitForNodeUpdates();
    waitOnSyncs();

    LOG_debug << logPre << "3. Confirm models after changing mtime keeping same MAC";
    confirmModels();

    LOG_debug << logPre << "3. Models confirmed after changing mtime keeping same MAC";
}

TEST_F(SyncFingerprintCollisionTest, DifferentMacDifferentName)
{
    auto data0 = randomData(arbitraryFileLength);
    auto data1 = data0;
    const auto path0 = localRoot0() / "d_0" / "a";
    const auto path1 = localRoot0() / "d_0" / "b";

    prepareForNodeUpdates();
    ASSERT_TRUE(createFile(path0, data0));
    client0->triggerPeriodicScanEarly(backupId0);
    waitForNodeUpdates();

    // Process any further changes.
    waitOnSyncs();

    // Alter MAC but leave fingerprint untouched.
    data1[0x41] = static_cast<char>(~data1[0x41]);

    // Prepare the file outside of the engine's view.
    auto stamp = fs::last_write_time(path0);

    ASSERT_TRUE(createFileWithTimestamp(client0->fsBasePath / "a", data1, client0->fsBasePath, stamp));

    prepareForNodeUpdates();
    fs::rename(client0->fsBasePath / "a", path1);
    client0->triggerPeriodicScanEarly(backupId0);
    waitForNodeUpdates();

    // Wait for the engine to process our change.
    waitOnSyncs();

    addModelFile(model0, "d/d_0", "a", data0);
    addModelFile(model0, "d/d_0", "b", data1);
    addModelFile(model1, "d/d_0", "a", data0);
    addModelFile(model1, "d/d_0", "b", data1);
    model1.ensureLocalDebrisTmpLock("d");

    confirmModels();
}

TEST_F(SyncFingerprintCollisionTest, SameMacDifferentName)
{
    auto data0 = randomData(arbitraryFileLength);
    const auto path0 = localRoot0() / "d_0" / "a";
    const auto path1 = localRoot0() / "d_0" / "b";

    prepareForNodeUpdates();
    ASSERT_TRUE(createFile(path0, data0));
    client0->triggerPeriodicScanEarly(backupId0);
    waitForNodeUpdates();

    waitOnSyncs();

    // Build the file somewhere the sync won't notice.
    auto stamp = fs::last_write_time(path0);

    ASSERT_TRUE(createFileWithTimestamp(client0->fsBasePath / "b", data0, client0->fsBasePath, stamp));

    // Move file into place.
    prepareForNodeUpdates();
    fs::rename(client0->fsBasePath / "b", path1);
    client0->triggerPeriodicScanEarly(backupId0);
    waitForNodeUpdates();

    // Wait for the engine to process our changes.
    waitOnSyncs();

    addModelFile(model0, "d/d_0", "a", data0);
    addModelFile(model0, "d/d_0", "b", data0);
    addModelFile(model1, "d/d_0", "a", data0);
    addModelFile(model1, "d/d_0", "b", data0);
    model1.ensureLocalDebrisTmpLock("d");

    confirmModels();
}

class SyncTest
    : public SdkTestBase
{
public:

    // Sets up the test case.
    void SetUp() override
    {
        SdkTestBase::SetUp();

        LOG_info << "____TEST SetUp: " << ::testing::UnitTest::GetInstance()->current_test_info()->name();

        SimpleLogger::setLogLevel(logVerbose);
    }

    // Tears down the test case.
    void TearDown() override
    {
        LOG_info << "____TEST TearDown: " << ::testing::UnitTest::GetInstance()->current_test_info()->name();
    }

}; // SqliteDBTest

TEST_F(SyncTest, BasicSync_DelRemoteFolder)
{
    // delete a remote folder and confirm the client sending the request and another also synced both correctly update the disk
    fs::path localtestroot = makeNewTestRoot();
    auto clientA1 = g_clientManager->getCleanStandardClient(0, localtestroot); // user 1 client 1
    auto clientA2 = g_clientManager->getCleanStandardClient(0, localtestroot); // user 1 client 2
    ASSERT_TRUE(clientA1->resetBaseFolderMulticlient(clientA2));

    ASSERT_TRUE(clientA1->makeCloudSubdirs("f", 3, 3));
    ASSERT_TRUE(CatchupClients(clientA1, clientA2));

    handle backupId1 = clientA1->setupSync_mainthread("sync1", "f", false, true);
    ASSERT_NE(backupId1, UNDEF);
    handle backupId2 = clientA2->setupSync_mainthread("sync2", "f", false, false);
    ASSERT_NE(backupId2, UNDEF);
    waitonsyncs(std::chrono::seconds(4), clientA1, clientA2);
    clientA1->logcb = clientA2->logcb = true;

    Model model;
    model.root->addkid(model.buildModelSubdirs("f", 3, 3, 0));

    // check everything matches (model has expected state of remote and local)
    ASSERT_TRUE(clientA1->confirmModel_mainthread(model.findnode("f"), backupId1));
    ASSERT_TRUE(clientA2->confirmModel_mainthread(model.findnode("f"), backupId2));

    // delete something remotely and let sync catch up
    clientA1->received_node_actionpackets = false;
    clientA2->received_node_actionpackets = false;

    ASSERT_TRUE(clientA1->deleteremote("f/f_2/f_2_1"));

    ASSERT_TRUE(clientA1->waitForNodesUpdated(60));
    ASSERT_TRUE(clientA2->waitForNodesUpdated(60));

    waitonsyncs(std::chrono::seconds(4), clientA1, clientA2);

    // check everything matches in both syncs (model has expected state of remote and local)
    ASSERT_TRUE(model.movetosynctrash("f/f_2/f_2_1", "f"));
    ASSERT_TRUE(clientA1->confirmModel_mainthread(model.findnode("f"), backupId1));
    ASSERT_TRUE(clientA2->confirmModel_mainthread(model.findnode("f"), backupId2));
}

TEST_F(SyncTest, BasicSync_DelLocalFolder)
{
    // confirm change is synced to remote, and also seen and applied in a second client that syncs the same folder
    fs::path localtestroot = makeNewTestRoot();
    auto clientA1 = g_clientManager->getCleanStandardClient(0, localtestroot); // user 1 client 1
    auto clientA2 = g_clientManager->getCleanStandardClient(0, localtestroot); // user 1 client 2
    ASSERT_TRUE(clientA1->resetBaseFolderMulticlient(clientA2));

    ASSERT_TRUE(clientA1->makeCloudSubdirs("f", 3, 3));
    ASSERT_TRUE(CatchupClients(clientA1, clientA2));

    // set up sync for A1, it should build matching local folders
    handle backupId1 = clientA1->setupSync_mainthread("sync1", "f", false, true);
    ASSERT_NE(backupId1, UNDEF);
    handle backupId2 = clientA2->setupSync_mainthread("sync2", "f", false, false);
    ASSERT_NE(backupId2, UNDEF);
    waitonsyncs(std::chrono::seconds(4), clientA1, clientA2);
    clientA1->logcb = clientA2->logcb = true;

    // check everything matches (model has expected state of remote and local)
    Model model;
    model.root->addkid(model.buildModelSubdirs("f", 3, 3, 0));
    ASSERT_TRUE(clientA1->confirmModel_mainthread(model.findnode("f"), backupId1));
    ASSERT_TRUE(clientA2->confirmModel_mainthread(model.findnode("f"), backupId2));

    auto checkpath = path_u8string(clientA1->syncSet(backupId1).localpath);
    out() << "checking paths " << checkpath;
    for(auto& p: fs::recursive_directory_iterator(TestFS::GetTestFolder()))
    {
        out() << "checking path is present: " << path_u8string(p.path());
    }
    // delete something in the local filesystem and see if we catch up in A1 and A2 (deleter and observer syncs)
    error_code e;
    auto nRemoved = fs::remove_all(clientA1->syncSet(backupId1).localpath / "f_2" / "f_2_1", e);
    ASSERT_TRUE(!e) << "remove failed "
                    << path_u8string((clientA1->syncSet(backupId1).localpath / "f_2" / "f_2_1"))
                    << " error " << e;
    ASSERT_GT(static_cast<unsigned>(nRemoved), 0u) << e;

    clientA1->triggerPeriodicScanEarly(backupId1);

    // let them catch up
    waitonsyncs(std::chrono::seconds(4), clientA1, clientA2);

    // check everything matches (model has expected state of remote and local)
    ASSERT_TRUE(model.movetosynctrash("f/f_2/f_2_1", "f"));
    ASSERT_TRUE(clientA2->confirmModel_mainthread(model.findnode("f"), backupId2));
    ASSERT_TRUE(model.removesynctrash("f"));
    ASSERT_TRUE(clientA1->confirmModel_mainthread(model.findnode("f"), backupId1));
}

TEST_F(SyncTest, BasicSync_MoveLocalFolderPlain)
{
    // confirm change is synced to remote, and also seen and applied in a second client that syncs the same folder
    fs::path localtestroot = makeNewTestRoot();
    auto clientA1 = g_clientManager->getCleanStandardClient(0, localtestroot); // user 1 client 1
    auto clientA2 = g_clientManager->getCleanStandardClient(0, localtestroot); // user 1 client 2
    ASSERT_TRUE(clientA1->resetBaseFolderMulticlient(clientA2));

    ASSERT_TRUE(clientA1->makeCloudSubdirs("f", 3, 3));
    ASSERT_TRUE(CatchupClients(clientA1, clientA2));

    Model model;
    model.root->addkid(model.buildModelSubdirs("f", 3, 3, 0));

    // set up sync for A1, it should build matching local folders
    handle backupId1 = clientA1->setupSync_mainthread("sync1", "f", false, true);
    ASSERT_NE(backupId1, UNDEF);
    handle backupId2 = clientA2->setupSync_mainthread("sync2", "f", false, false);
    ASSERT_NE(backupId2, UNDEF);
    waitonsyncs(std::chrono::seconds(8), clientA1, clientA2);
    clientA1->logcb = clientA2->logcb = true;

    // check everything matches (model has expected state of remote and local)
    ASSERT_TRUE(clientA1->confirmModel_mainthread(model.findnode("f"), backupId1));
    ASSERT_TRUE(clientA2->confirmModel_mainthread(model.findnode("f"), backupId2));

    // reload the Nodes from server, similar to an ETOOMANY error,
    // just so we are exercising most of that code path somewhere
    clientA1->fetchnodes(false, false, true);

    clientA1->waitFor([&](StandardClient& sc) { return sc.client.actionpacketsCurrent.load(); }, std::chrono::seconds(60));

    ASSERT_TRUE(CatchupClients(clientA1, clientA2));

    // check everything matches (model has expected state of remote and local)
    ASSERT_TRUE(clientA1->confirmModel_mainthread(model.findnode("f"), backupId1));
    ASSERT_TRUE(clientA2->confirmModel_mainthread(model.findnode("f"), backupId2));



    out() << "----- making sync change to test, now -----";
    clientA1->received_node_actionpackets = false;
    clientA2->received_node_actionpackets = false;

    // move something in the local filesystem and see if we catch up in A1 and A2 (deleter and observer syncs)
    error_code rename_error;
    fs::rename(clientA1->syncSet(backupId1).localpath / "f_2" / "f_2_1", clientA1->syncSet(backupId1).localpath / "f_2_1", rename_error);
    ASSERT_TRUE(!rename_error) << rename_error;

    clientA1->triggerPeriodicScanEarly(backupId1);

    // client1 should send a rename command to the API
    // both client1 and client2 should receive the corresponding actionpacket
    ASSERT_TRUE(clientA1->waitForNodesUpdated(60)) << " no actionpacket received in clientA1 for rename";
    ASSERT_TRUE(clientA2->waitForNodesUpdated(60)) << " no actionpacket received in clientA2 for rename";

    out() << "----- wait for actionpackets ended -----";

    // sync activity should not take much longer after that.
    waitonsyncs(std::chrono::seconds(4), clientA1, clientA2);

    // check everything matches (model has expected state of remote and local)
    ASSERT_TRUE(model.movenode("f/f_2/f_2_1", "f"));
    ASSERT_TRUE(clientA1->confirmModel_mainthread(model.findnode("f"), backupId1));
    ASSERT_TRUE(clientA2->confirmModel_mainthread(model.findnode("f"), backupId2));
}

TEST_F(SyncTest, BasicSync_MoveLocalFolderBetweenSyncs)
{
    // confirm change is synced to remote, and also seen and applied in a second client that syncs the same folder
    fs::path localtestroot = makeNewTestRoot();

    auto clientA1 = g_clientManager->getCleanStandardClient(0, localtestroot); // user 1 client 1
    auto clientA2 = g_clientManager->getCleanStandardClient(0, localtestroot); // user 1 client 2
    auto clientA3 = g_clientManager->getCleanStandardClient(0, localtestroot); // user 1 client 2

    auto receivedDeviceIdName = [](User* actionPackageUser, User* ownUser)
    {
        assert(actionPackageUser && ownUser);
        if (actionPackageUser->userhandle == ownUser->userhandle && actionPackageUser->changed.devicenames)
        {
            return true;
        }

        return false;
    };

    User* ownUserClient2 = clientA2->client.ownuser();
    // Register a callback to be used when users_updated is called. This callBack is used to stop waiting period at waitForUserUpdated
    // removeOnUserUpdateLamda should be called to unregister
    clientA2->createsOnUserUpdateLamda([ownUserClient2, receivedDeviceIdName](User* user)
    {
        return receivedDeviceIdName(user, ownUserClient2);
    });

    User* ownUserClient3 = clientA3->client.ownuser();
    // Register a callback to be used when users_updated is called. This callBack is used to stop waiting period at waitForUserUpdated
    // removeOnUserUpdateLamda should be called to unregister
    clientA3->createsOnUserUpdateLamda([ownUserClient3, receivedDeviceIdName](User* user)
    {
       return receivedDeviceIdName(user, ownUserClient3);
    });

    clientA2->removeOnUserUpdateLamda();
    clientA3->removeOnUserUpdateLamda();

    // ATTR_MY_BACKUPS_FOLDER is only set once, if it exists, it shouldn't be set again
    bool backUpIsSet = false;
    ASSERT_TRUE(clientA1->waitForAttrMyBackupIsSet(60, backUpIsSet)) << "Error User attr My Back Folder isn't establised client1";
    if (backUpIsSet) // only wait for action package if atribute has been set
    {
        auto receivedBackUpId = [](User* actionPackageUser, User* ownUser)
        {
            assert(actionPackageUser && ownUser);
            if (actionPackageUser->userhandle == ownUser->userhandle && actionPackageUser->changed.myBackupsFolder)
            {
                return true;
            }

            return false;
        };

        User* ownUserClient2 = clientA2->client.ownuser();
        // Register a callback to be used when users_updated is called. This callBack is used to stop waiting period at waitForUserUpdated
        // removeOnUserUpdateLamda should be called to unregister
        clientA2->createsOnUserUpdateLamda([ownUserClient2, receivedBackUpId](User* user)
        {
            return receivedBackUpId(user, ownUserClient2);
        });

        User* ownUserClient3 = clientA3->client.ownuser();
        // Register a callback to be used when users_updated is called. This callBack is used to stop waiting period at waitForUserUpdated
        // removeOnUserUpdateLamda should be called to unregister
        clientA3->createsOnUserUpdateLamda([ownUserClient3, receivedBackUpId](User* user)
        {
            return receivedBackUpId(user, ownUserClient3);
        });

        ASSERT_TRUE(clientA2->waitForUserUpdated(60)) << "User update doesn't arrive at client2 (backup folder)";
        ASSERT_TRUE(clientA3->waitForUserUpdated(60)) << "User update doesn't arrive at client3 (backup folder)";
        clientA2->removeOnUserUpdateLamda();
        clientA3->removeOnUserUpdateLamda();

        // Check attribute has been set correctly
        backUpIsSet = false;
        ASSERT_TRUE(clientA2->waitForAttrMyBackupIsSet(60, backUpIsSet)) << "Error User attr My Back Folder isn't establised client2";
        ASSERT_EQ(backUpIsSet, false); // It has already set
        backUpIsSet = false;
        ASSERT_TRUE(clientA3->waitForAttrMyBackupIsSet(60, backUpIsSet)) << "Error User attr My Back Folder isn't establised client3";
        ASSERT_EQ(backUpIsSet, false); // It has already set
    }

    ASSERT_TRUE(clientA1->resetBaseFolderMulticlient(clientA2, clientA3));
    ASSERT_TRUE(clientA1->makeCloudSubdirs("f", 3, 3));
    ASSERT_TRUE(CatchupClients(clientA1, clientA2, clientA3));

    // Avoid races between clients.
    {
        auto path = clientA1->fsBasePath / ".megaignore";

        // Create bare ignore file.
        ASSERT_TRUE(createFile(path, "+sync:.megaignore"));

        // Upload ignore file to each sync root.
        ASSERT_TRUE(clientA1->uploadFile(path, "f"));
        ASSERT_TRUE(clientA1->uploadFile(path, "f/f_0"));
        ASSERT_TRUE(clientA1->uploadFile(path, "f/f_2"));
    }

    // set up sync for A1 and A2, it should build matching local folders
    handle backupId11 = clientA1->setupSync_mainthread("sync1", "f/f_0", false, false);
    ASSERT_NE(backupId11, UNDEF);
    handle backupId12 = clientA1->setupSync_mainthread("sync2", "f/f_2", false, false);
    ASSERT_NE(backupId12, UNDEF);
    handle backupId21 = clientA2->setupSync_mainthread("syncA2_1", "f/f_0", false, false);
    ASSERT_NE(backupId21, UNDEF);
    handle backupId22 = clientA2->setupSync_mainthread("syncA2_2", "f/f_2", false, false);
    ASSERT_NE(backupId22, UNDEF);
    handle backupId31 = clientA3->setupSync_mainthread("syncA3", "f", false, false);
    ASSERT_NE(backupId31, UNDEF);
    waitonsyncs(std::chrono::seconds(4), clientA1, clientA2, clientA3);
    clientA1->logcb = clientA2->logcb = clientA3->logcb = true;

    // also set up backups and move between backup/sync  (to check vw:1 flag is set appropriately both ways)
    handle backupId3b1 = clientA3->setupBackup_mainthread("backup1");
    ASSERT_NE(backupId3b1, UNDEF);
    handle backupId3b2 = clientA3->setupBackup_mainthread("backup2");
    ASSERT_NE(backupId3b2, UNDEF);

    std::error_code fs_error;
    fs::create_directory(clientA3->syncSet(backupId3b1).localpath / "backup1subfolder", fs_error);
    ASSERT_TRUE(!fs_error) << fs_error;
    fs::create_directory(clientA3->syncSet(backupId3b2).localpath / "backup2subfolder", fs_error);
    ASSERT_TRUE(!fs_error) << fs_error;
    waitonsyncs(std::chrono::seconds(4), clientA1, clientA2, clientA3);

    // Create models.
    Model backup1model;
    Model backup2model;
    backup1model.addfolder("backup1subfolder");
    backup2model.addfolder("backup2subfolder");
    ASSERT_TRUE(clientA3->confirmModel_mainthread(backup1model.root.get(), backupId3b1));
    ASSERT_TRUE(clientA3->confirmModel_mainthread(backup2model.root.get(), backupId3b2));

    // Create Sync models.
    Model modelF;
    Model modelF0;
    Model modelF2;

    // f
    modelF.root->addkid(modelF.buildModelSubdirs("f", 3, 3, 0));
    modelF.ensureLocalDebrisTmpLock("f");

    // f_0
    modelF0.root->addkid(modelF.findnode("f/f_0")->clone());
    modelF0.ensureLocalDebrisTmpLock("f_0");

    // f_2
    modelF2.root->addkid(modelF.findnode("f/f_2")->clone());
    modelF2.ensureLocalDebrisTmpLock("f_2");

    // check everything matches (model has expected state of remote and local)
    ASSERT_TRUE(clientA1->confirmModel_mainthread(modelF0.findnode("f_0"), backupId11));
    ASSERT_TRUE(clientA1->confirmModel_mainthread(modelF2.findnode("f_2"), backupId12));
    ASSERT_TRUE(clientA2->confirmModel_mainthread(modelF0.findnode("f_0"), backupId21));
    ASSERT_TRUE(clientA2->confirmModel_mainthread(modelF2.findnode("f_2"), backupId22));
    ASSERT_TRUE(clientA3->confirmModel_mainthread(modelF.findnode("f"), backupId31));

    LOG_debug << "----- making sync change to test, now -----";
    clientA1->received_node_actionpackets = false;
    clientA2->received_node_actionpackets = false;
    clientA3->received_node_actionpackets = false;

    // move a folder form one local synced folder to another local synced folder and see if we sync correctly and catch up in A2 and A3 (mover and observer syncs)
    error_code rename_error;
    fs::path path1 = clientA1->syncSet(backupId11).localpath / "f_0_1";
    fs::path path2 = clientA1->syncSet(backupId12).localpath / "f_2_1" / "f_2_1_0" / "f_0_1";
    fs::rename(path1, path2, rename_error);
    ASSERT_TRUE(!rename_error) << rename_error;

    clientA1->triggerPeriodicScanEarly(backupId11);
    clientA1->triggerPeriodicScanEarly(backupId12);

    // client1 should send a rename command to the API
    // both client1 and client2 should receive the corresponding actionpacket
    ASSERT_TRUE(clientA1->waitForNodesUpdated(30)) << " no actionpacket received in clientA1 for rename";
    ASSERT_TRUE(clientA2->waitForNodesUpdated(30)) << " no actionpacket received in clientA2 for rename";
    ASSERT_TRUE(clientA3->waitForNodesUpdated(30)) << " no actionpacket received in clientA3 for rename";

    // let them catch up
    waitonsyncs(std::chrono::seconds(4), clientA1, clientA2, clientA3);

    // Update models.
    modelF.movenode("f/f_0/f_0_1", "f/f_2/f_2_1/f_2_1_0");
    modelF2.findnode("f_2/f_2_1/f_2_1_0")->addkid(modelF0.removenode("f_0/f_0_1"));

    // check everything matches (model has expected state of remote and local)
    ASSERT_TRUE(clientA1->confirmModel_mainthread(modelF0.findnode("f_0"), backupId11));
    ASSERT_TRUE(clientA1->confirmModel_mainthread(modelF2.findnode("f_2"), backupId12));
    ASSERT_TRUE(clientA2->confirmModel_mainthread(modelF0.findnode("f_0"), backupId21));
    ASSERT_TRUE(clientA2->confirmModel_mainthread(modelF2.findnode("f_2"), backupId22));
    ASSERT_TRUE(clientA3->confirmModel_mainthread(modelF.findnode("f"), backupId31));

    // now try moving between syncs and backups

    fs::rename(clientA3->syncSet(backupId3b1).localpath / "backup1subfolder",
               clientA3->syncSet(backupId31).localpath / "backup1subfolder", fs_error);
    ASSERT_TRUE(!fs_error) << fs_error;
    fs::rename(clientA3->syncSet(backupId31).localpath / "f_2",
               clientA3->syncSet(backupId3b1).localpath / "f_2", fs_error);
    ASSERT_TRUE(!fs_error) << fs_error;

    waitonsyncs(std::chrono::seconds(4), clientA1, clientA2, clientA3);

    backup1model.root->addkid(modelF.removenode("f/f_2"));
    modelF.findnode("f")->addkid(backup1model.removenode("backup1subfolder"));

    ASSERT_TRUE(clientA3->confirmModel_mainthread(backup1model.root.get(), backupId3b1));
    ASSERT_TRUE(clientA3->confirmModel_mainthread(modelF.findnode("f"), backupId31));

}

TEST_F(SyncTest, BasicSync_RenameLocalFile)
{
    static auto TIMEOUT = std::chrono::seconds(4);

    const fs::path root = makeNewTestRoot();

    auto client0 = g_clientManager->getCleanStandardClient(0, root); // user 1 client 1
    auto client1 = g_clientManager->getCleanStandardClient(0, root); // user 1 client 2
    ASSERT_TRUE(client0->resetBaseFolderMulticlient(client1));
    ASSERT_TRUE(client0->makeCloudSubdirs("x", 0, 0));
    ASSERT_TRUE(CatchupClients(client0, client1));

    // Log callbacks.
    client0->logcb = true;
    client1->logcb = true;

    // Log clients in.
    ///ASSERT_TRUE(client0.login_reset_makeremotenodes("MEGA_EMAIL", "MEGA_PWD", "x", 0, 0));
    ///ASSERT_TRUE(client1.login_fetchnodes("MEGA_EMAIL", "MEGA_PWD"));
    ASSERT_EQ(client0->basefolderhandle, client1->basefolderhandle);

    // Set up syncs.
    handle backupId0 = client0->setupSync_mainthread("s0", "x", false, true);
    ASSERT_NE(backupId0, UNDEF);
    handle backupId1 = client1->setupSync_mainthread("s1", "x", false, false);
    ASSERT_NE(backupId1, UNDEF);

    // Wait for initial sync to complete.
    waitonsyncs(TIMEOUT, client0, client1);

    // Add x/f.
    ASSERT_TRUE(createNameFile(client0->syncSet(backupId0).localpath, "f"));

    client0->triggerPeriodicScanEarly(backupId0);

    // Wait for sync to complete.
    waitonsyncs(TIMEOUT, client0, client1);

    // Confirm model.
    Model model1, model2;
    model1.root->addkid(model1.makeModelSubfolder("x"));
    model1.findnode("x")->addkid(model1.makeModelSubfile("f"));
    model2.root->addkid(model2.makeModelSubfolder("x"));
    model2.findnode("x")->addkid(model2.makeModelSubfile("f"));
    model2.ensureLocalDebrisTmpLock("x"); // since it downloaded f (uploaded by sync 1)

    ASSERT_TRUE(client0->confirmModel_mainthread(model1.findnode("x"), backupId0));
    ASSERT_TRUE(client1->confirmModel_mainthread(model2.findnode("x"), backupId1, true));

    // Rename x/f to x/g.
    fs::rename(client0->syncSet(backupId0).localpath / "f",
               client0->syncSet(backupId0).localpath / "g");

    client0->triggerPeriodicScanEarly(backupId0);

    // Wait for sync to complete.
    waitonsyncs(TIMEOUT, client0, client1);

    // Update and confirm model.
    model1.findnode("x/f")->name = "g";
    model2.findnode("x/f")->name = "g";

    ASSERT_TRUE(client0->confirmModel_mainthread(model1.findnode("x"), backupId0));
    ASSERT_TRUE(client1->confirmModel_mainthread(model2.findnode("x"), backupId1, true));
}

#ifdef MEGASDK_DEBUG_TEST_HOOKS_ENABLED
TEST_F(SyncTest, TransferCountProgress)
{
    const std::string logPre = "SyncTest.TransferCountProgress: ";
    LOG_debug << logPre + "#### Test preparation ####";
    auto clientA1 = g_clientManager->getCleanStandardClient(0, makeNewTestRoot());
    clientA1->logcb = true;
    ASSERT_TRUE(clientA1->resetBaseFolderMulticlient());
    ASSERT_TRUE(clientA1->makeCloudSubdirs("sync1", 0, 0));
    ASSERT_TRUE(CatchupClients(clientA1));

    std::atomic<bool> transferReportFlag{false};
    std::atomic<bool> transferReportProgressFlag{false};
    m_off_t transferReportInflightProgress{0};
    m_off_t transferReportPendingBytes{0};
    double transferReportProgress{0};
    double targetProgressAux{0};
    unsigned transferFinished{0};
    unsigned targetTransferFinishedCount{3};

    globalMegaTestHooks.onTransferReportProgress =
        [&](const double p, const m_off_t fp, const m_off_t pb)
    {
        transferReportProgress = p;
        transferReportInflightProgress = fp;
        transferReportPendingBytes = pb;
        transferReportProgressFlag = true;
    };

    clientA1->onTransferCompleted = [&](Transfer*)
    {
        if (++transferFinished == targetTransferFinishedCount)
        {
            clientA1->onTransferCompleted = nullptr;
            targetProgressAux = transferReportProgress;
            transferReportProgressFlag = false;
            transferReportFlag = true;
        }
    };

    LOG_debug << logPre + "#### Add and start sync ####";
    const auto backupId1 = clientA1->setupSync_mainthread("sync1", "sync1", false, false);
    ASSERT_NE(backupId1, UNDEF) << "Cannot add sync";
    const auto SYNCROOT = clientA1->syncSet(backupId1).localpath;

    LOG_debug << logPre + "#### Build model. ####";
    Model model1;
    model1.addfolder("A");
    model1.generate(SYNCROOT);
    clientA1->triggerPeriodicScanEarly(backupId1);
    constexpr auto TIMEOUT = chrono::seconds(30);
    waitonsyncs(TIMEOUT, clientA1);

    LOG_debug << logPre + "#### Set max upload speed to 100Kb/s ####";
    clientA1->client.setmaxuploadspeed(100000);

    LOG_debug << logPre + "#### Add some files in local FS. ####";
    constexpr size_t KB_IN_BYTES{104857u};
    constexpr size_t MB_IN_BYTES{1048576u};
    unsigned totalFilesAdded{0};
    auto addFile = [SYNCROOT, &totalFilesAdded](Model& model, const string& path, const size_t s)
    {
        auto data = randomData(s);
        model.addfile(path, data);
        ASSERT_TRUE(createFile(SYNCROOT / path, data));
        totalFilesAdded++;
    };
    addFile(model1, "A/fxya1", KB_IN_BYTES);
    addFile(model1, "A/fxya2", KB_IN_BYTES);
    addFile(model1, "A/fxya3", KB_IN_BYTES);
    addFile(model1, "A/fxya4", MB_IN_BYTES);
    addFile(model1, "A/fxya5", MB_IN_BYTES);
    addFile(model1, "A/fxya6", MB_IN_BYTES);

    auto checkTransferProgress = [&]()
    {
        LOG_debug << logPre + "#### Wait until first " << targetTransferFinishedCount
                  << " transfers finish ####";
        clientA1->waitFor(
            [&transferReportFlag](StandardClient&)
            {
                return transferReportFlag.load();
            },
            std::chrono::seconds(30));
        ASSERT_EQ(transferFinished, targetTransferFinishedCount);
        auto numPendingTransfers = totalFilesAdded - transferFinished;

        LOG_debug << logPre + "#### Wait until next reportCounts progress is received ####";
        clientA1->waitFor(
            [&transferReportProgressFlag](StandardClient&)
            {
                return transferReportProgressFlag.load();
            },
            std::chrono::seconds(6));
        const auto initialPending = static_cast<m_off_t>(MB_IN_BYTES * numPendingTransfers);
        ASSERT_GE(initialPending, transferReportPendingBytes);

        const auto initialCompleted = static_cast<m_off_t>(KB_IN_BYTES * transferFinished);
        const auto newCompleted = initialPending - transferReportPendingBytes;
        const auto completed = initialCompleted + newCompleted;

        const auto pending = initialPending - newCompleted;
        ASSERT_EQ(pending, transferReportPendingBytes);
        ASSERT_EQ((completed + pending), (initialPending + initialCompleted));

        const auto currentProgress =
            static_cast<double>(completed + transferReportInflightProgress) /
            static_cast<double>(completed + pending);
        ASSERT_EQ(transferReportProgress, currentProgress)
            << ". Unexpected value for reportCounts progress";

        LOG_debug << logPre + "#### Set max upload speed unlimited ####";
        clientA1->client.setmaxuploadspeed(-1);
    };
    checkTransferProgress();

    LOG_debug << logPre + "#### Wait on sync. ####";
    waitonsyncs(TIMEOUT, clientA1);

    LOG_debug << logPre + "#### Confirm model. ####";
    ASSERT_TRUE(clientA1->confirmModel_mainthread(model1.findnode("" /*root*/), backupId1));
}
#endif

TEST_F(SyncTest, BasicSync_AddLocalFolder)
{
    // confirm change is synced to remote, and also seen and applied in a second client that syncs the same folder
    fs::path localtestroot = makeNewTestRoot();
    StandardClientInUse clientA1 = g_clientManager->getCleanStandardClient(0, localtestroot); // user 1 client 1
    StandardClientInUse clientA2 = g_clientManager->getCleanStandardClient(0, localtestroot); // user 1 client 2
    ASSERT_TRUE(clientA1->resetBaseFolderMulticlient(clientA2));
    ASSERT_TRUE(clientA2->makeCloudSubdirs("f", 3, 3));
    ASSERT_TRUE(CatchupClients(clientA1, clientA2));

    ASSERT_EQ(clientA1->basefolderhandle, clientA2->basefolderhandle);

    Model model1, model2;
    model1.root->addkid(model1.buildModelSubdirs("f", 3, 3, 0));
    model2.root->addkid(model2.buildModelSubdirs("f", 3, 3, 0));

    // set up sync for A1, it should build matching local folders
    handle backupId1 = clientA1->setupSync_mainthread("sync1", "f", false, true);
    ASSERT_NE(backupId1, UNDEF);
    handle backupId2 = clientA2->setupSync_mainthread("sync2", "f", false, false);
    ASSERT_NE(backupId2, UNDEF);
    waitonsyncs(std::chrono::seconds(4), clientA1, clientA2);
    clientA1->logcb = clientA2->logcb = true;

    // check everything matches (model has expected state of remote and local)
    ASSERT_TRUE(clientA1->confirmModel_mainthread(model1.findnode("f"), backupId1));
    ASSERT_TRUE(clientA2->confirmModel_mainthread(model2.findnode("f"), backupId2));

    // make new folders (and files) in the local filesystem and see if we catch up in A1 and A2 (adder and observer syncs)
    ASSERT_TRUE(buildLocalFolders(clientA1->syncSet(backupId1).localpath / "f_2", "newkid", 2, 2, 2));

    clientA1->triggerPeriodicScanEarly(backupId1);

    // let them catch up
    // two minutes should be long enough to get past API_ETEMPUNAVAIL == -18 for sync2 downloading the files uploaded by sync1
    // 4 seconds was too short sometimes, sync2 not caught up yet, due to a few consecutive -3 for `g`
    waitonsyncs(DEFAULTWAIT, clientA1, clientA2);

    // check everything matches (model has expected state of remote and local)
    model1.findnode("f/f_2")->addkid(model1.buildModelSubdirs("newkid", 2, 2, 2));
    model2.findnode("f/f_2")->addkid(model2.buildModelSubdirs("newkid", 2, 2, 2));
    model2.ensureLocalDebrisTmpLock("f"); // since we downloaded files

    ASSERT_TRUE(clientA1->confirmModel_mainthread(model1.findnode("f"), backupId1));
    ASSERT_TRUE(clientA2->confirmModel_mainthread(model2.findnode("f"), backupId2));
}

// todo: add this test once the sync can keep up with file system notifications - at the moment
// it's too slow because we wait for the cloud before processing the next layer of files+folders.
// So if we add enough changes to exercise the notification queue, we can't check the results because
// it's far too slow at the syncing stage.
TEST_F(SyncTest, BasicSync_MassNotifyFromLocalFolderTree)
{
    // confirm change is synced to remote, and also seen and applied in a second client that syncs the same folder
    fs::path localtestroot = makeNewTestRoot();
    StandardClientInUse clientA1 = g_clientManager->getCleanStandardClient(0, localtestroot); // user 1 client 1
    ASSERT_TRUE(clientA1->resetBaseFolderMulticlient());
    ASSERT_TRUE(clientA1->makeCloudSubdirs("f", 0, 0));
    ASSERT_TRUE(CatchupClients(clientA1));

    //ASSERT_TRUE(clientA1.login_reset_makeremotenodes("MEGA_EMAIL", "MEGA_PWD", "f", 0, 0));
    //ASSERT_TRUE(clientA2.login_fetchnodes("MEGA_EMAIL", "MEGA_PWD"));
    //ASSERT_EQ(clientA1.basefolderhandle, clientA2.basefolderhandle);

    // set up sync for A1, it should build matching local folders
    handle backupId1 = clientA1->setupSync_mainthread("sync1", "f", false, true);
    ASSERT_NE(backupId1, UNDEF);
    //ASSERT_TRUE(clientA2.setupSync_mainthread("sync2", "f", 2));
    waitonsyncs(std::chrono::seconds(4), clientA1/*, &clientA2*/);
    //clientA1.logcb = clientA2.logcb = true;

    // Create a directory tree in one sync, it should be synced to the cloud and back to the other
    // Create enough files and folders that we put a strain on the notification logic: 3k entries
    ASSERT_TRUE(buildLocalFolders(clientA1->syncSet(backupId1).localpath, "initial", 0, 0, 16000));

    clientA1->triggerPeriodicScanEarly(backupId1);

    //waitonsyncs(std::chrono::seconds(10), &clientA1 /*, &clientA2*/);
    std::this_thread::sleep_for(std::chrono::seconds(5));

    // wait until the notify queues subside, it shouldn't take too long.  Limit of 5 minutes
    auto startTime = std::chrono::steady_clock::now();
    while (std::chrono::steady_clock::now() - startTime < std::chrono::seconds(5 * 60))
    {
        size_t remaining = 0;
        auto result0 = clientA1->thread_do<bool>([&](StandardClient &sc, PromiseBoolSP p)
        {
            remaining += sc.client.syncs.syncscanstate ? 1 : 0;

            p->set_value(true);
        }, __FILE__, __LINE__);
        result0.get();
        if (!remaining) break;
        std::this_thread::sleep_for(std::chrono::seconds(1));
    }

    Model model;
    model.root->addkid(model.buildModelSubdirs("initial", 0, 0, 16000));

    clientA1->waitFor([&](StandardClient&){ return clientA1->transfersAdded.load() > 0; }, std::chrono::seconds(60));  // give it a chance to create all the nodes.

    // check everything matches (just local since it'll still be uploading files)
    clientA1->localNodesMustHaveNodes = false;
    ASSERT_TRUE(clientA1->confirmModel_mainthread(model.root.get(), backupId1, false, StandardClient::CONFIRM_LOCAL));
    //ASSERT_TRUE(clientA2.confirmModel_mainthread(model.findnode("f"), 2));

    ASSERT_GT(clientA1->transfersAdded.load(), 0u);
    clientA1->transfersAdded = 0;

    // rename all those files and folders, put a strain on the notify system again.
    // Also, no downloads (or uploads) should occur as a result of this.
 //   renameLocalFolders(clientA1.syncSet(backupId1).localpath, "renamed_");

    // let them catch up
    //waitonsyncs(std::chrono::seconds(10), &clientA1 /*, &clientA2*/);

    // rename is too slow to check, even just in localnodes, for now.

    //ASSERT_EQ(clientA1.transfersAdded.load(), 0u);

    //Model model2;
    //model2.root->addkid(model.buildModelSubdirs("renamed_initial", 0, 0, 100));

    //// check everything matches (model has expected state of remote and local)
    //ASSERT_TRUE(clientA1.confirmModel_mainthread(model2.root.get(), 1));
    ////ASSERT_TRUE(clientA2.confirmModel_mainthread(model2.findnode("f"), 2));
}



/* this one is too slow for regular testing with the current algorithm
TEST_F(SyncTest, BasicSync_MAX_NEWNODES1)
{
    // create more nodes than we can upload in one putnodes.
    // this tree is 5x5 and the algorithm ends up creating nodes one at a time so it's pretty slow (and doesn't hit MAX_NEWNODES as a result)
    fs::path localtestroot = makeNewTestRoot();
    StandardClient clientA1(localtestroot, "clientA1");   // user 1 client 1
    StandardClient clientA2(localtestroot, "clientA2");   // user 1 client 2

    ASSERT_TRUE(clientA1.login_reset_makeremotenodes("MEGA_EMAIL", "MEGA_PWD", "f", 3, 3));
    ASSERT_TRUE(clientA2.login_fetchnodes("MEGA_EMAIL", "MEGA_PWD"));
    ASSERT_EQ(clientA1.basefolderhandle, clientA2.basefolderhandle);

    Model model;
    model.root->addkid(model.buildModelSubdirs("f", 3, 3, 0));

    // set up sync for A1, it should build matching local folders
    ASSERT_TRUE(clientA1.setupSync_mainthread("sync1", "f", 1));
    ASSERT_TRUE(clientA2.setupSync_mainthread("sync2", "f", 2));
    waitonsyncs(std::chrono::seconds(4), &clientA1, &clientA2);
    clientA1.logcb = clientA2.logcb = true;

    // check everything matches (model has expected state of remote and local)
    ASSERT_TRUE(clientA1.confirmModel_mainthread(model.findnode("f"), 1));
    ASSERT_TRUE(clientA2.confirmModel_mainthread(model.findnode("f"), 2));

    // make new folders in the local filesystem and see if we catch up in A1 and A2 (adder and observer syncs)
    assert(MegaClient::MAX_NEWNODES < 3125);
    ASSERT_TRUE(buildLocalFolders(clientA1.syncSet(backupId1).localpath, "g", 5, 5, 0));  // 5^5=3125 leaf folders, 625 pre-leaf etc

    // let them catch up
    waitonsyncs(std::chrono::seconds(30), &clientA1, &clientA2);

    // check everything matches (model has expected state of remote and local)
    model.findnode("f")->addkid(model.buildModelSubdirs("g", 5, 5, 0));
    ASSERT_TRUE(clientA1.confirmModel_mainthread(model.findnode("f"), 1));
    ASSERT_TRUE(clientA2.confirmModel_mainthread(model.findnode("f"), 2));
}
*/

/* this one is too slow for regular testing with the current algorithm
TEST_F(SyncTest, BasicSync_MAX_NEWNODES2)
{
    // create more nodes than we can upload in one putnodes.
    // this tree is 5x5 and the algorithm ends up creating nodes one at a time so it's pretty slow (and doesn't hit MAX_NEWNODES as a result)
    fs::path localtestroot = makeNewTestRoot();
    StandardClient clientA1(localtestroot, "clientA1");   // user 1 client 1
    StandardClient clientA2(localtestroot, "clientA2");   // user 1 client 2

    ASSERT_TRUE(clientA1.login_reset_makeremotenodes("MEGA_EMAIL", "MEGA_PWD", "f", 3, 3));
    ASSERT_TRUE(clientA2.login_fetchnodes("MEGA_EMAIL", "MEGA_PWD"));
    ASSERT_EQ(clientA1.basefolderhandle, clientA2.basefolderhandle);

    Model model;
    model.root->addkid(model.buildModelSubdirs("f", 3, 3, 0));

    // set up sync for A1, it should build matching local folders
    ASSERT_TRUE(clientA1.setupSync_mainthread("sync1", "f", 1));
    ASSERT_TRUE(clientA2.setupSync_mainthread("sync2", "f", 2));
    waitonsyncs(std::chrono::seconds(4), &clientA1, &clientA2);
    clientA1.logcb = clientA2.logcb = true;

    // check everything matches (model has expected state of remote and local)
    ASSERT_TRUE(clientA1.confirmModel_mainthread(model.findnode("f"), 1));
    ASSERT_TRUE(clientA2.confirmModel_mainthread(model.findnode("f"), 2));

    // make new folders in the local filesystem and see if we catch up in A1 and A2 (adder and observer syncs)
    assert(MegaClient::MAX_NEWNODES < 3000);
    ASSERT_TRUE(buildLocalFolders(clientA1.syncSet(backupId1).localpath, "g", 3000, 1, 0));

    // let them catch up
    waitonsyncs(std::chrono::seconds(30), &clientA1, &clientA2);

    // check everything matches (model has expected state of remote and local)
    model.findnode("f")->addkid(model.buildModelSubdirs("g", 3000, 1, 0));
    ASSERT_TRUE(clientA1.confirmModel_mainthread(model.findnode("f"), 1));
    ASSERT_TRUE(clientA2.confirmModel_mainthread(model.findnode("f"), 2));
}
*/

TEST_F(SyncTest, BasicSync_MoveExistingIntoNewLocalFolder)
{
    // historic case:  in the local filesystem, create a new folder then move an existing file/folder into it
    fs::path localtestroot = makeNewTestRoot();
    StandardClientInUse clientA1 = g_clientManager->getCleanStandardClient(0, localtestroot); // user 1 client 1
    StandardClientInUse clientA2 = g_clientManager->getCleanStandardClient(0, localtestroot); // user 1 client 1
    ASSERT_TRUE(clientA1->resetBaseFolderMulticlient(clientA2));
    ASSERT_TRUE(clientA1->makeCloudSubdirs("f", 3, 3));
    ASSERT_TRUE(CatchupClients(clientA1, clientA2));

    ASSERT_EQ(clientA1->basefolderhandle, clientA2->basefolderhandle);

    Model model;
    model.root->addkid(model.buildModelSubdirs("f", 3, 3, 0));

    // set up sync for A1, it should build matching local folders
    handle backupId1 = clientA1->setupSync_mainthread("sync1", "f", false, true);
    ASSERT_NE(backupId1, UNDEF);
    handle backupId2 = clientA2->setupSync_mainthread("sync2", "f", false, false);
    ASSERT_NE(backupId2, UNDEF);
    waitonsyncs(DEFAULTWAIT, clientA1, clientA2);
    clientA1->logcb = clientA2->logcb = true;

    // check everything matches (model has expected state of remote and local)
    ASSERT_TRUE(clientA1->confirmModel_mainthread(model.findnode("f"), backupId1));
    ASSERT_TRUE(clientA2->confirmModel_mainthread(model.findnode("f"), backupId2));

    // make new folder in the local filesystem
    ASSERT_TRUE(buildLocalFolders(clientA1->syncSet(backupId1).localpath, "new", 1, 0, 0));
    // move an already synced folder into it
    error_code rename_error;
    fs::path path1 = clientA1->syncSet(backupId1).localpath / "f_2"; // / "f_2_0" / "f_2_0_0";
    fs::path path2 = clientA1->syncSet(backupId1).localpath / "new" / "f_2"; // "f_2_0_0";
    fs::rename(path1, path2, rename_error);
    ASSERT_TRUE(!rename_error) << rename_error;

    clientA1->triggerPeriodicScanEarly(backupId1);

    // let them catch up
    waitonsyncs(DEFAULTWAIT, clientA1, clientA2);

    // check everything matches (model has expected state of remote and local)
    auto f = model.makeModelSubfolder("new");
    f->addkid(model.removenode("f/f_2")); // / f_2_0 / f_2_0_0"));
    model.findnode("f")->addkid(std::move(f));
    ASSERT_TRUE(clientA1->confirmModel_mainthread(model.findnode("f"), backupId1));
    ASSERT_TRUE(clientA2->confirmModel_mainthread(model.findnode("f"), backupId2));
}

TEST_F(SyncTest, BasicSync_MoveSeveralExistingIntoDeepNewLocalFolders)
{
    // historic case:  in the local filesystem, create a new folder then move an existing file/folder into it
    fs::path localtestroot = makeNewTestRoot();
    StandardClientInUse clientA1 = g_clientManager->getCleanStandardClient(0, localtestroot); // user 1 client 1
    StandardClientInUse clientA2 = g_clientManager->getCleanStandardClient(0, localtestroot); // user 1 client 1
    ASSERT_TRUE(clientA1->resetBaseFolderMulticlient(clientA2));
    ASSERT_TRUE(clientA1->makeCloudSubdirs("f", 3, 3));
    ASSERT_TRUE(CatchupClients(clientA1, clientA2));

    ASSERT_EQ(clientA1->basefolderhandle, clientA2->basefolderhandle);

    Model model;
    model.root->addkid(model.buildModelSubdirs("f", 3, 3, 0));

    // set up sync for A1, it should build matching local folders
    handle backupId1 = clientA1->setupSync_mainthread("sync1", "f", false, true);
    ASSERT_NE(backupId1, UNDEF);
    handle backupId2 = clientA2->setupSync_mainthread("sync2", "f", false, false);
    ASSERT_NE(backupId2, UNDEF);
    waitonsyncs(DEFAULTWAIT, clientA1, clientA2);
    clientA1->logcb = clientA2->logcb = true;

    // check everything matches (model has expected state of remote and local)
    ASSERT_TRUE(clientA1->confirmModel_mainthread(model.findnode("f"), backupId1));
    ASSERT_TRUE(clientA2->confirmModel_mainthread(model.findnode("f"), backupId2));

    // make new folder tree in the local filesystem
    ASSERT_TRUE(buildLocalFolders(clientA1->syncSet(backupId1).localpath, "new", 3, 3, 3));
    model.findnode("f")->addkid(model.buildModelSubdirs("new", 3, 3, 3));

    clientA1->triggerPeriodicScanEarly(backupId1);

    // let them catch up
    waitonsyncs(DEFAULTWAIT, clientA1, clientA2);

    // check everything matches (model has expected state of remote and local)
    ASSERT_TRUE(clientA1->confirmModel_mainthread(model.findnode("f"), backupId1));
    ASSERT_TRUE(clientA2->confirmModel_mainthread(model.findnode("f"), backupId2));

    // move already synced folders to serveral parts of it - one under another moved folder too
    error_code rename_error;
    fs::rename(clientA1->syncSet(backupId1).localpath / "f_0", clientA1->syncSet(backupId1).localpath / "new" / "new_0" / "new_0_1" / "new_0_1_2" / "f_0", rename_error);
    ASSERT_TRUE(!rename_error) << rename_error;
    fs::rename(clientA1->syncSet(backupId1).localpath / "f_1", clientA1->syncSet(backupId1).localpath / "new" / "new_1" / "new_1_2" / "f_1", rename_error);
    ASSERT_TRUE(!rename_error) << rename_error;
    fs::rename(clientA1->syncSet(backupId1).localpath / "f_2", clientA1->syncSet(backupId1).localpath / "new" / "new_1" / "new_1_2" / "f_1" / "f_1_2" / "f_2", rename_error);
    ASSERT_TRUE(!rename_error) << rename_error;

    clientA1->triggerPeriodicScanEarly(backupId1);

    // let them catch up
    waitonsyncs(DEFAULTWAIT, clientA1, clientA2);

    // check everything matches (model has expected state of remote and local)
    model.findnode("f/new/new_0/new_0_1/new_0_1_2")->addkid(model.removenode("f/f_0"));
    model.findnode("f/new/new_1/new_1_2")->addkid(model.removenode("f/f_1"));
    model.findnode("f/new/new_1/new_1_2/f_1/f_1_2")->addkid(model.removenode("f/f_2"));
    ASSERT_TRUE(clientA1->confirmModel_mainthread(model.findnode("f"), backupId1));
    model.ensureLocalDebrisTmpLock("f"); // since we downloaded files
    ASSERT_TRUE(clientA2->confirmModel_mainthread(model.findnode("f"), backupId2));
}


#if defined(MEGA_MEASURE_CODE) || defined(DEBUG) // for sendDeferred()
TEST_F(SyncTest, BasicSync_MoveTwiceLocallyButCloudMoveRequestDelayed)
{
    fs::path localtestroot = makeNewTestRoot();
    StandardClientInUse c = g_clientManager->getCleanStandardClient(0, localtestroot); // user 1 client 1
    ASSERT_TRUE(c->resetBaseFolderMulticlient());

    ASSERT_TRUE(c->makeCloudSubdirs("s", 0, 0));

    Model m;
    m.addfolder("a");
    m.addfolder("b");
    m.addfolder("c");
    m.generate(c->fsBasePath / "s");

    handle backupId = c->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(backupId, UNDEF);

    waitonsyncs(std::chrono::seconds(4), c);
    ASSERT_TRUE(c->confirmModel_mainthread(m.root.get(), backupId));
    c->logcb = true;

    fs::path path1 = c->syncSet(backupId).localpath;

    LOG_info << "Preventing move reqs being sent, then making local move for sync code to upsync";

    // nothing can be sent, same as network disconnected
    c->thread_do<bool>([](StandardClient& client, PromiseBoolSP result) {
        client.client.reqs.deferRequests = [](Command*) { return true; };
        result->set_value(true);
    }, __FILE__, __LINE__).get();

    error_code fs_error;
    fs::rename(path1 / "a", path1 / "b" / "a", fs_error);
    ASSERT_TRUE(!fs_error) << fs_error;

    WaitMillisec(2000);

    fs::create_directory(path1 / "new", fs_error);
    ASSERT_TRUE(!fs_error) << fs_error;

    LOG_info << "Moving folder `a` a second time, into a new folder, while the first move has not yet completed";
    fs::rename(path1 / "b" / "a", path1 / "new" / "a", fs_error);
    ASSERT_TRUE(!fs_error) << fs_error;

    WaitMillisec(2000);

    LOG_info << "Allowing move reqs to continue";

    c->sendDeferredAndReset();

    waitonsyncs(std::chrono::seconds(4), c);

    m.addfolder("new");
    m.addfolder("new/a");
    m.removenode("a");
    ASSERT_TRUE(c->confirmModel_mainthread(m.root.get(), backupId));
}
#endif

/* not expected to work yet
TEST_F(SyncTest, BasicSync_SyncDuplicateNames)
{
    fs::path localtestroot = makeNewTestRoot();
    StandardClient clientA1(localtestroot, "clientA1");   // user 1 client 1
    StandardClient clientA2(localtestroot, "clientA2");   // user 1 client 2

    ASSERT_TRUE(clientA1.login_reset("MEGA_EMAIL", "MEGA_PWD"));
    ASSERT_TRUE(clientA2.login_fetchnodes("MEGA_EMAIL", "MEGA_PWD"));
    ASSERT_EQ(clientA1.basefolderhandle, clientA2.basefolderhandle);


    NewNode* nodearray = new NewNode[3];
    nodearray[0] = *clientA1.makeSubfolder("samename");
    nodearray[1] = *clientA1.makeSubfolder("samename");
    nodearray[2] = *clientA1.makeSubfolder("Samename");
    clientA1.resultproc.prepresult(StandardClient::PUTNODES, [this](error e) {
    });
    clientA1.client.putnodes(clientA1.basefolderhandle, nodearray, 3);

    // set up syncs, they should build matching local folders
    ASSERT_TRUE(clientA1.setupSync_mainthread("sync1", "", 1));
    ASSERT_TRUE(clientA2.setupSync_mainthread("sync2", "", 2));
    waitonsyncs(std::chrono::seconds(4), &clientA1, &clientA2);
    clientA1.logcb = clientA2.logcb = true;

    // check everything matches (model has expected state of remote and local)
    Model model;
    model.root->addkid(model.makeModelSubfolder("samename"));
    model.root->addkid(model.makeModelSubfolder("samename"));
    model.root->addkid(model.makeModelSubfolder("Samename"));
    ASSERT_TRUE(clientA1.confirmModel_mainthread(model.root.get(), 1));
    ASSERT_TRUE(clientA2.confirmModel_mainthread(model.root.get(), 2));
}*/

TEST_F(SyncTest, BasicSync_RemoveLocalNodeBeforeSessionResume)
{
    fs::path localtestroot = makeNewTestRoot();
    auto pclientA1 = std::make_unique<StandardClient>(localtestroot, "clientA1");   // user 1 client 1
    // don't use client manager as this client gets replaced
    StandardClient clientA2(localtestroot, "clientA2");   // user 1 client 2

    ASSERT_TRUE(pclientA1->login_reset_makeremotenodes("MEGA_EMAIL", "MEGA_PWD", "f", 3, 3));
    ASSERT_TRUE(clientA2.login_fetchnodes("MEGA_EMAIL", "MEGA_PWD"));
    ASSERT_EQ(pclientA1->basefolderhandle, clientA2.basefolderhandle);

    Model model;
    model.root->addkid(model.buildModelSubdirs("f", 3, 3, 0));

    pclientA1->received_node_actionpackets = false;
    clientA2.received_node_actionpackets = false;

    // set up sync for A1, it should build matching local folders
    handle backupId1 = pclientA1->setupSync_mainthread("sync1", "f", false, true);
    ASSERT_NE(backupId1, UNDEF);
    handle backupId2 = clientA2.setupSync_mainthread("sync2", "f", false, false);
    ASSERT_NE(backupId2, UNDEF);

    // actually for this one, we don't expect actionpackets because all the cloud nodes are already present before the sync starts
    // ASSERT_TRUE(pclientA1->waitForNodesUpdated(30)) << " no actionpacket received in clientA1";
    // ASSERT_TRUE(clientA2.waitForNodesUpdated(30)) << " no actionpacket received in clientA2";

    waitonsyncs(std::chrono::seconds(4), pclientA1.get(), &clientA2);
    pclientA1->logcb = clientA2.logcb = true;

    // check everything matches (model has expected state of remote and local)
    ASSERT_TRUE(pclientA1->confirmModel_mainthread(model.findnode("f"), backupId1));
    ASSERT_TRUE(clientA2.confirmModel_mainthread(model.findnode("f"), backupId2));

    // save session
    string session;
    pclientA1->client.dumpsession(session);

    // logout (but keep caches)
    fs::path sync1path = pclientA1->syncSet(backupId1).localpath;
    pclientA1->localLogout();

    pclientA1->received_syncs_restored = false;

    // remove local folders
    error_code e;
    ASSERT_TRUE(fs::remove_all(sync1path / "f_2", e) != static_cast<std::uintmax_t>(-1)) << e;

    // resume session, see if nodes and localnodes get in sync
    pclientA1.reset(new StandardClient(localtestroot, "clientA1"));
    ASSERT_TRUE(pclientA1->login_fetchnodesFromSession(session));

    // wait for normal sync resumes to complete
    pclientA1->waitFor([&](StandardClient& sc){ return sc.received_syncs_restored.load(); }, std::chrono::seconds(30));

    waitonsyncs(std::chrono::seconds(4), pclientA1.get(), &clientA2);

    // check everything matches (model has expected state of remote and local)
    ASSERT_TRUE(model.movetosynctrash("f/f_2", "f"));
    ASSERT_TRUE(clientA2.confirmModel_mainthread(model.findnode("f"), backupId2));
    ASSERT_TRUE(model.removesynctrash("f"));
    ASSERT_TRUE(pclientA1->confirmModel_mainthread(model.findnode("f"), backupId1));
}

/* not expected to work yet
TEST_F(SyncTest, BasicSync_RemoteFolderCreationRaceSamename)
{
    // confirm change is synced to remote, and also seen and applied in a second client that syncs the same folder
    // SN tagging needed for this one
    fs::path localtestroot = makeNewTestRoot();
    StandardClient clientA1(localtestroot, "clientA1");   // user 1 client 1
    StandardClient clientA2(localtestroot, "clientA2");   // user 1 client 2

    ASSERT_TRUE(clientA1.login_reset("MEGA_EMAIL", "MEGA_PWD"));
    ASSERT_TRUE(clientA2.login_fetchnodes("MEGA_EMAIL", "MEGA_PWD"));
    ASSERT_EQ(clientA1.basefolderhandle, clientA2.basefolderhandle);

    // set up sync for both, it should build matching local folders (empty initially)
    ASSERT_TRUE(clientA1.setupSync_mainthread("sync1", "", 1));
    ASSERT_TRUE(clientA2.setupSync_mainthread("sync2", "", 2));
    waitonsyncs(std::chrono::seconds(4), &clientA1, &clientA2);
    clientA1.logcb = clientA2.logcb = true;

    // now have both clients create the same remote folder structure simultaneously.  We should end up with just one copy of it on the server and in both syncs
    future<bool> p1 = clientA1.thread_do<bool>([=](StandardClient& sc, PromiseBoolSP pb) { sc.makeCloudSubdirs("f", 3, 3, pb); });
    future<bool> p2 = clientA2.thread_do<bool>([=](StandardClient& sc, PromiseBoolSP pb) { sc.makeCloudSubdirs("f", 3, 3, pb); });
    ASSERT_TRUE(waitonresults(&p1, &p2));

    // let them catch up
    waitonsyncs(std::chrono::seconds(4), &clientA1, &clientA2);

    // check everything matches (model has expected state of remote and local)
    Model model;
    model.root->addkid(model.buildModelSubdirs("f", 3, 3, 0));
    ASSERT_TRUE(clientA1.confirmModel_mainthread(model.root.get(), 1));
    ASSERT_TRUE(clientA2.confirmModel_mainthread(model.root.get(), 2));
}*/

/* not expected to work yet
TEST_F(SyncTest, BasicSync_LocalFolderCreationRaceSamename)
{
    // confirm change is synced to remote, and also seen and applied in a second client that syncs the same folder
    // SN tagging needed for this one
    fs::path localtestroot = makeNewTestRoot();
    StandardClient clientA1(localtestroot, "clientA1");   // user 1 client 1
    StandardClient clientA2(localtestroot, "clientA2");   // user 1 client 2

    ASSERT_TRUE(clientA1.login_reset("MEGA_EMAIL", "MEGA_PWD"));
    ASSERT_TRUE(clientA2.login_fetchnodes("MEGA_EMAIL", "MEGA_PWD"));
    ASSERT_EQ(clientA1.basefolderhandle, clientA2.basefolderhandle);

    // set up sync for both, it should build matching local folders (empty initially)
    ASSERT_TRUE(clientA1.setupSync_mainthread("sync1", "", 1));
    ASSERT_TRUE(clientA2.setupSync_mainthread("sync2", "", 2));
    waitonsyncs(std::chrono::seconds(4), &clientA1, &clientA2);
    clientA1.logcb = clientA2.logcb = true;

    // now have both clients create the same folder structure simultaneously.  We should end up with just one copy of it on the server and in both syncs
    future<bool> p1 = clientA1.thread_do<bool>([=](StandardClient& sc, PromiseBoolSP pb) { buildLocalFolders(sc.syncSet(backupId1).localpath, "f", 3, 3, 0); pb->set_value(true); });
    future<bool> p2 = clientA2.thread_do<bool>([=](StandardClient& sc, PromiseBoolSP pb) { buildLocalFolders(sc.syncSet(backupId2).localpath, "f", 3, 3, 0); pb->set_value(true); });
    ASSERT_TRUE(waitonresults(&p1, &p2));

    // let them catch up
    waitonsyncs(std::chrono::seconds(30), &clientA1, &clientA2);

    // check everything matches (model has expected state of remote and local)
    Model model;
    model.root->addkid(model.buildModelSubdirs("f", 3, 3, 0));
    ASSERT_TRUE(clientA1.confirmModel_mainthread(model.root.get(), 1));
    ASSERT_TRUE(clientA2.confirmModel_mainthread(model.root.get(), 2));
}*/


TEST_F(SyncTest, BasicSync_ResumeSyncFromSessionAfterNonclashingLocalAndRemoteChanges )
{
    fs::path localtestroot = makeNewTestRoot();
    unique_ptr<StandardClient> pclientA1(new StandardClient(localtestroot, "clientA1"));   // user 1 client 1
    // don't use client manager as this client gets replaced
    StandardClient clientA2(localtestroot, "clientA2");   // user 1 client 2

    ASSERT_TRUE(pclientA1->login_reset_makeremotenodes("MEGA_EMAIL", "MEGA_PWD", "f", 3, 3));
    ASSERT_TRUE(clientA2.login_fetchnodes("MEGA_EMAIL", "MEGA_PWD"));
    ASSERT_EQ(pclientA1->basefolderhandle, clientA2.basefolderhandle);

    // set up sync for A1, it should build matching local folders
    handle backupId1 = pclientA1->setupSync_mainthread("sync1", "f", false, true);
    ASSERT_NE(backupId1, UNDEF);
    handle backupId2 = clientA2.setupSync_mainthread("sync2", "f", false, false);
    ASSERT_NE(backupId2, UNDEF);
    waitonsyncs(std::chrono::seconds(4), pclientA1.get(), &clientA2);
    pclientA1->logcb = clientA2.logcb = true;

    // check everything matches (model has expected state of remote and local)
    Model model1, model2;
    model1.root->addkid(model1.buildModelSubdirs("f", 3, 3, 0));
    model2.root->addkid(model2.buildModelSubdirs("f", 3, 3, 0));
    ASSERT_TRUE(pclientA1->confirmModel_mainthread(model1.findnode("f"), backupId1));
    ASSERT_TRUE(clientA2.confirmModel_mainthread(model2.findnode("f"), backupId2));

    out() << "********************* save session A1";
    string session;
    pclientA1->client.dumpsession(session);

    out() << "*********************  logout A1 (but keep caches on disk)";
    fs::path sync1path = pclientA1->syncSet(backupId1).localpath;
    pclientA1->localLogout();

    out() << "*********************  add remote folders via A2";
    future<bool> p1 = clientA2.thread_do<bool>([](StandardClient& sc, PromiseBoolSP pb) { sc.makeCloudSubdirs("newremote", 2, 2, pb, "f/f_1/f_1_0"); }, __FILE__, __LINE__);
    model1.findnode("f/f_1/f_1_0")->addkid(model1.buildModelSubdirs("newremote", 2, 2, 0));
    model2.findnode("f/f_1/f_1_0")->addkid(model2.buildModelSubdirs("newremote", 2, 2, 0));
    ASSERT_TRUE(waitonresults(&p1));

    out() << "*********************  remove remote folders via A2";
    ASSERT_TRUE(clientA2.deleteremote("f/f_0"));
    model1.movetosynctrash("f/f_0", "f");
    model2.movetosynctrash("f/f_0", "f");

    out() << "*********************  add local folders in A1";
    ASSERT_TRUE(buildLocalFolders(sync1path / "f_1/f_1_2", "newlocal", 2, 2, 2));
    model1.findnode("f/f_1/f_1_2")->addkid(model1.buildModelSubdirs("newlocal", 2, 2, 2));
    model2.findnode("f/f_1/f_1_2")->addkid(model2.buildModelSubdirs("newlocal", 2, 2, 2));

    out() << "*********************  remove local folders in A1";
    error_code e;
    ASSERT_TRUE(fs::remove_all(sync1path / "f_2", e) != static_cast<std::uintmax_t>(-1)) << e;
    model1.removenode("f/f_2");
    model2.movetosynctrash("f/f_2", "f");

    out() << "*********************  get sync2 activity out of the way";
    waitonsyncs(std::chrono::seconds(4), &clientA2);

    out() << "*********************  resume A1 session (with sync), see if A2 nodes and localnodes get in sync again";
    pclientA1.reset(new StandardClient(localtestroot, "clientA1"));
    ASSERT_TRUE(pclientA1->login_fetchnodesFromSession(session));
    ASSERT_EQ(pclientA1->basefolderhandle, clientA2.basefolderhandle);

    // wait for normal sync resumes to complete
    // wait bumped to 40 seconds here because we've seen a case where the 2nd client didn't receive actionpackets for 30 seconds
    pclientA1->waitFor([&](StandardClient& sc){ return sc.received_syncs_restored.load(); }, std::chrono::seconds(40));

    waitonsyncs(std::chrono::seconds(4), pclientA1.get(), &clientA2);

    out() << "*********************  check everything matches (model has expected state of remote and local)";
    ASSERT_TRUE(pclientA1->confirmModel_mainthread(model1.findnode("f"), backupId1));
    model2.ensureLocalDebrisTmpLock("f"); // since we downloaded files
    ASSERT_TRUE(clientA2.confirmModel_mainthread(model2.findnode("f"), backupId2));
}

TEST_F(SyncTest, BasicSync_ResumeSyncFromSessionAfterClashingLocalAddRemoteDelete)
{
    fs::path localtestroot = makeNewTestRoot();
    unique_ptr<StandardClient> pclientA1(new StandardClient(localtestroot, "clientA1"));   // user 1 client 1
    // don't use client manager as this client gets replaced
    StandardClient clientA2(localtestroot, "clientA2");   // user 1 client 2

    ASSERT_TRUE(pclientA1->login_reset_makeremotenodes("MEGA_EMAIL", "MEGA_PWD", "f", 3, 3));
    ASSERT_TRUE(clientA2.login_fetchnodes("MEGA_EMAIL", "MEGA_PWD"));
    ASSERT_EQ(pclientA1->basefolderhandle, clientA2.basefolderhandle);

    Model model;
    model.root->addkid(model.buildModelSubdirs("f", 3, 3, 0));

    // set up sync for A1, it should build matching local folders
    handle backupId1 = pclientA1->setupSync_mainthread("sync1", "f", false, true);
    ASSERT_NE(backupId1, UNDEF);
    handle backupId2 = clientA2.setupSync_mainthread("sync2", "f", false, false);
    ASSERT_NE(backupId2, UNDEF);
    waitonsyncs(std::chrono::seconds(4), pclientA1.get(), &clientA2);
    pclientA1->logcb = clientA2.logcb = true;

    // check everything matches (model has expected state of remote and local)
    ASSERT_TRUE(pclientA1->confirmModel_mainthread(model.findnode("f"), backupId1));
    ASSERT_TRUE(clientA2.confirmModel_mainthread(model.findnode("f"), backupId2));

    // save session A1
    string session;
    pclientA1->client.dumpsession(session);
    fs::path sync1path = pclientA1->syncSet(backupId1).localpath;

    // logout A1 (but keep caches on disk)
    pclientA1->localLogout();

    // remove remote folder via A2
    ASSERT_TRUE(clientA2.deleteremote("f/f_1"));

    // add local folders in A1 on disk folder
    ASSERT_TRUE(buildLocalFolders(sync1path / "f_1/f_1_2", "newlocal", 2, 2, 2));

    // get sync2 activity out of the way
    waitonsyncs(std::chrono::seconds(4), &clientA2);

    // resume A1 session (with sync), see if A2 nodes and localnodes get in sync again
    pclientA1.reset(new StandardClient(localtestroot, "clientA1"));
    ASSERT_TRUE(pclientA1->login_fetchnodesFromSession(session));
    ASSERT_EQ(pclientA1->basefolderhandle, clientA2.basefolderhandle);

    // wait for normal sync resumes to complete
    pclientA1->waitFor([&](StandardClient& sc){ return sc.received_syncs_restored.load(); }, std::chrono::seconds(30));

    waitonsyncs(chrono::seconds(4), pclientA1.get(), &clientA2);

    // Sync rework update:  for now at least, delete wins in this case

    //ASSERT_EQ(waitResult[0].syncStalled, true);
    //ASSERT_EQ(1, waitResult[0].stalledNodePaths.size());
    //ASSERT_EQ(1, waitResult[0].stalledLocalPaths.size());

    Model modelLocal1;
    modelLocal1.root->addkid(model.buildModelSubdirs("f", 3, 3, 0));
    modelLocal1.findnode("f/f_1/f_1_2")->addkid(model.buildModelSubdirs("newlocal", 2, 2, 2));
    //pclientA1->localNodesMustHaveNodes = false;
    ASSERT_TRUE(modelLocal1.movetosynctrash("f/f_1", "f"));

    Model modelRemote1;
    modelRemote1.root->addkid(model.buildModelSubdirs("f", 3, 3, 0));
    ASSERT_TRUE(modelRemote1.movetosynctrash("f/f_1", "f"));

    ASSERT_TRUE(pclientA1->confirmModel_mainthread(modelLocal1.findnode("f"), backupId1, false, StandardClient::CONFIRM_LOCAL));
    ASSERT_TRUE(pclientA1->confirmModel_mainthread(modelRemote1.findnode("f"), backupId1, false, StandardClient::CONFIRM_REMOTE));
    //ASSERT_TRUE(modelRemote1.removesynctrash("f", "f_1/f_1_2/newlocal"));
    ASSERT_TRUE(clientA2.confirmModel_mainthread(modelRemote1.findnode("f"), backupId2));
}

#ifdef SRW_NEEDED_FOR_THIS_ONE
TEST_F(SyncTest, BasicSync_ResumeSyncFromSessionAfterContractoryLocalAndRemoteMoves)
{
    fs::path localtestroot = makeNewTestRoot();
    unique_ptr<StandardClient> pclientA1(new StandardClient(localtestroot, "clientA1"));   // user 1 client 1
    StandardClient clientA2(localtestroot, "clientA2");   // user 1 client 2

    ASSERT_TRUE(pclientA1->login_reset_makeremotenodes("MEGA_EMAIL", "MEGA_PWD", "f", 3, 3));
    ASSERT_TRUE(clientA2.login_fetchnodes("MEGA_EMAIL", "MEGA_PWD"));
    ASSERT_EQ(pclientA1->basefolderhandle, clientA2.basefolderhandle);

    Model model;
    model.root->addkid(model.buildModelSubdirs("f", 3, 3, 0));

    // set up sync for A1, it should build matching local folders
    handle backupId1 = pclientA1->setupSync_mainthread("sync1", "f", false, true);
    ASSERT_NE(backupId1, UNDEF);
    handle backupId2 = clientA2.setupSync_mainthread("sync2", "f", false, false);
    ASSERT_NE(backupId2, UNDEF);
    waitonsyncs(std::chrono::seconds(4), pclientA1.get(), &clientA2);
    pclientA1->logcb = clientA2.logcb = true;

    auto client1LocalSyncRoot = pclientA1->syncSet(backupId1).localpath;

    // check everything matches (model has expected state of remote and local)
    ASSERT_TRUE(pclientA1->confirmModel_mainthread(model.findnode("f"), backupId1));
    ASSERT_TRUE(clientA2.confirmModel_mainthread(model.findnode("f"), backupId2, true));

    // save session A1
    string session;
    pclientA1->client.dumpsession(session);
    fs::path sync1path = pclientA1->syncSet(backupId1).localpath;

    // logout A1 (but keep caches on disk)
    pclientA1->localLogout();

    // move f_0 into f_1 remote
    ASSERT_TRUE(clientA2.movenode("f/f_0", "f/f_1"));

    // move f_1 into f_0 locally
    error_code rename_error;
    fs::rename(client1LocalSyncRoot / "f_1", client1LocalSyncRoot / "f_0" / "f_1", rename_error);
    ASSERT_TRUE(!rename_error) << rename_error;

    // get sync2 activity out of the way
    waitonsyncs(std::chrono::seconds(4), &clientA2);

    // resume A1 session (with sync), see if A2 nodes and localnodes get in sync again
    pclientA1.reset(new StandardClient(localtestroot, "clientA1"));
    ASSERT_TRUE(pclientA1->login_fetchnodesFromSession(session));
    ASSERT_EQ(pclientA1->basefolderhandle, clientA2.basefolderhandle);
    vector<SyncWaitResult> waitResult = waitonsyncs(chrono::seconds(4), pclientA1.get(), &clientA2);

    ASSERT_EQ(waitResult[0].syncStalled, true);
    ASSERT_EQ(2u, waitResult[0].stall.cloud.size());  // for now at least, reporting source and destination nodes for each move
    ASSERT_EQ(2u, waitResult[0].stall.local.size());
    ASSERT_EQ(waitResult[0].stall.cloud.begin()->first, "/mega_test_sync/f/f_0");
    ASSERT_EQ(waitResult[0].stall.cloud.rbegin()->first, "/mega_test_sync/f/f_1/f_0");
    ASSERT_EQ(waitResult[0].stall.local.begin()->first.toPath(false),
              path_u8string((client1LocalSyncRoot / "f_0" / "f_1")));
    ASSERT_EQ(waitResult[0].stall.local.rbegin()->first.toPath(false),
              path_u8string((client1LocalSyncRoot / "f_1")));
}
#endif

TEST_F(SyncTest, CmdChecks_RRAttributeAfterMoveNode)
{
    fs::path localtestroot = makeNewTestRoot();
    unique_ptr<StandardClient> pclientA1(new StandardClient(localtestroot, "clientA1"));   // user 1 client 1
    // don't use client manager as this client gets replaced

    ASSERT_TRUE(pclientA1->login_reset_makeremotenodes("MEGA_EMAIL", "MEGA_PWD", "f", 3, 3));

    std::shared_ptr<Node> f = pclientA1->drillchildnodebyname(pclientA1->gettestbasenode(), "f");
    handle original_f_handle = f->nodehandle;
    handle original_f_parent_handle = f->parent->nodehandle;

    // make sure there are no 'f' in the rubbish
    auto fv = pclientA1->drillchildnodesbyname(pclientA1->getcloudrubbishnode().get(), "f");
    future<bool> fb = pclientA1->thread_do<bool>([fv](StandardClient& sc, PromiseBoolSP pb) { sc.deleteremotenodes(fv, pb); }, __FILE__, __LINE__);
    ASSERT_TRUE(waitonresults(&fb));

    f = pclientA1->drillchildnodebyname(pclientA1->getcloudrubbishnode(), "f");
    ASSERT_TRUE(f == nullptr || f->changed.removed);


    // remove remote folder via A2
    future<bool> p1 = pclientA1->thread_do<bool>([](StandardClient& sc, PromiseBoolSP pb)
        {
            sc.movenodetotrash("f", pb);
        }, __FILE__, __LINE__);
    ASSERT_TRUE(waitonresults(&p1));

    WaitMillisec(3000);  // allow for attribute delivery too

    f = pclientA1->drillchildnodebyname(pclientA1->getcloudrubbishnode(), "f");
    ASSERT_TRUE(f != nullptr);

    // check the restore-from-trash handle got set, and correctly
    nameid rrname = AttrMap::string2nameid("rr");
    ASSERT_EQ(f->nodehandle, original_f_handle);
    ASSERT_EQ(f->attrs.map[rrname], string(Base64Str<MegaClient::NODEHANDLE>(original_f_parent_handle)));
    ASSERT_EQ(f->attrs.map[rrname], string(Base64Str<MegaClient::NODEHANDLE>(pclientA1->gettestbasenode()->nodehandle)));

    // move it back
    ASSERT_TRUE(pclientA1->movenode(f->nodehandle, pclientA1->basefolderhandle));
    WaitMillisec(3000);  // allow for attribute delivery too

    // check it's back and the rr attribute is gone
    f = pclientA1->drillchildnodebyname(pclientA1->gettestbasenode(), "f");
    ASSERT_TRUE(f != nullptr);
    ASSERT_EQ(f->attrs.map[rrname], string());
}


#ifdef __linux__
TEST_F(SyncTest, BasicSync_SpecialCreateFile)
{
    // confirm change is synced to remote, and also seen and applied in a second client that syncs the same folder
    fs::path localtestroot = makeNewTestRoot();
    StandardClient clientA1(localtestroot, "clientA1");   // user 1 client 1
    StandardClient clientA2(localtestroot, "clientA2");   // user 1 client 2

    ASSERT_TRUE(clientA1.login_reset_makeremotenodes("MEGA_EMAIL", "MEGA_PWD", "f", 2, 2));
    ASSERT_TRUE(clientA2.login_fetchnodes("MEGA_EMAIL", "MEGA_PWD"));
    ASSERT_EQ(clientA1.basefolderhandle, clientA2.basefolderhandle);

    Model model;
    model.root->addkid(model.buildModelSubdirs("f", 2, 2, 0));

    // set up sync for A1, it should build matching local folders
    handle backupId1 = clientA1.setupSync_mainthread("sync1", "f", false, true);
    ASSERT_NE(backupId1, UNDEF);
    handle backupId2 = clientA2.setupSync_mainthread("sync2", "f", false, false);
    ASSERT_NE(backupId2, UNDEF);

    waitonsyncs(std::chrono::seconds(4), &clientA1, &clientA2);
    clientA1.logcb = clientA2.logcb = true;
    // check everything matches (model has expected state of remote and local)
    ASSERT_TRUE(clientA1.confirmModel_mainthread(model.findnode("f"), backupId1));
    ASSERT_TRUE(clientA2.confirmModel_mainthread(model.findnode("f"), backupId2));

    // make new folders (and files) in the local filesystem and see if we catch up in A1 and A2 (adder and observer syncs)
    ASSERT_TRUE(createSpecialFiles(clientA1.syncSet(backupId1).localpath / "f_0", "newkid", 2));

    for (int i = 0; i < 2; ++i)
    {
        string filename = "file" + to_string(i) + "_" + "newkid";
        model.findnode("f/f_0")->addkid(model.makeModelSubfile(filename));
    }

    clientA1.triggerPeriodicScanEarly(backupId1);

    // let them catch up
    waitonsyncs(DEFAULTWAIT, &clientA1, &clientA2);

    // check everything matches (model has expected state of remote and local)
    ASSERT_TRUE(clientA1.confirmModel_mainthread(model.findnode("f"), backupId1));
    model.ensureLocalDebrisTmpLock("f"); // since we downloaded files
    ASSERT_TRUE(clientA2.confirmModel_mainthread(model.findnode("f"), backupId2));
}
#endif

#ifdef SRW_NEEDED_FOR_THIS_ONE
TEST_F(SyncTest, BasicSync_moveAndDeleteLocalFile)
{
    // confirm change is synced to remote, and also seen and applied in a second client that syncs the same folder
    fs::path localtestroot = makeNewTestRoot();
    StandardClientInUse clientA1 = g_clientManager->getCleanStandardClient(0, localtestroot); // user 1 client 1
    StandardClientInUse clientA2 = g_clientManager->getCleanStandardClient(0, localtestroot); // user 1 client 1
    ASSERT_TRUE(clientA1->resetBaseFolderMulticlient(clientA2));
    ASSERT_TRUE(clientA1->makeCloudSubdirs("f", 1, 1));
    ASSERT_TRUE(CatchupClients(clientA1, clientA2));
    ASSERT_EQ(clientA1->basefolderhandle, clientA2->basefolderhandle);

    Model model;
    model.root->addkid(model.buildModelSubdirs("f", 1, 1, 0));

    // set up sync for A1, it should build matching local folders
    handle backupId1 = clientA1->setupSync_mainthread("sync1", "f", false, true);
    ASSERT_NE(backupId1, UNDEF);
    handle backupId2 = clientA2->setupSync_mainthread("sync2", "f", false, false);
    ASSERT_NE(backupId2, UNDEF);

    waitonsyncs(std::chrono::seconds(4), clientA1, clientA2);
    clientA1->logcb = clientA2->logcb = true;
    // check everything matches (model has expected state of remote and local)
    ASSERT_TRUE(clientA1->confirmModel_mainthread(model.findnode("f"), backupId1));
    ASSERT_TRUE(clientA2->confirmModel_mainthread(model.findnode("f"), backupId2));


    // move something in the local filesystem and see if we catch up in A1 and A2 (deleter and observer syncs)
    error_code rename_error;
    fs::rename(clientA1->syncSet(backupId1).localpath / "f_0", clientA1->syncSet(backupId1).localpath / "renamed", rename_error);
    ASSERT_TRUE(!rename_error) << rename_error;
    fs::remove(clientA1->syncSet(backupId1).localpath / "renamed");

    clientA1->triggerPeriodicScanEarly(backupId1);

    // let them catch up
    waitonsyncs(DEFAULTWAIT, clientA1, clientA2);

    // check everything matches (model has expected state of remote and local)
    ASSERT_TRUE(model.movetosynctrash("f/f_0", "f"));
    ASSERT_TRUE(clientA2->confirmModel_mainthread(model.findnode("f"), backupId2));
    ASSERT_TRUE(model.removesynctrash("f"));
    ASSERT_TRUE(clientA1->confirmModel_mainthread(model.findnode("f"), backupId1));
}
#endif

namespace {

string makefa(const string& name, int fakecrc, int mtime)
{
    AttrMap attrs;
    attrs.map['n'] = name;

    FileFingerprint ff;
    ff.crc[0] = ff.crc[1] = ff.crc[2] = ff.crc[3] = fakecrc;
    ff.mtime = mtime;
    ff.serializefingerprint(&attrs.map['c']);

    string attrjson;
    attrs.getjson(&attrjson);
    return attrjson;
}

Node* makenode(MegaClient& mc, NodeHandle parent, ::mega::nodetype_t type, m_off_t size, handle owner, const string& attrs, ::mega::byte* key)
{
    static handle handlegenerator = 10;
    auto newnode = new Node(mc, NodeHandle().set6byte(++handlegenerator), parent, type, size, owner, nullptr, 1);

    newnode->setkey(key);
    newnode->attrstring.reset(new string);

    SymmCipher sc;
    sc.setkey(key, type);
    mc.makeattr(&sc, newnode->attrstring, attrs.c_str());

    int attrlen = int(newnode->attrstring->size());
    string base64attrstring;
    base64attrstring.resize(static_cast<size_t>(attrlen * 4 / 3 + 4));
    base64attrstring.resize(static_cast<size_t>(Base64::btoa((::mega::byte *)newnode->attrstring->data(), int(newnode->attrstring->size()), (char *)base64attrstring.data())));

    *newnode->attrstring = base64attrstring;

    return newnode;
}

} // anonymous

TEST_F(SyncTest, PutnodesForMultipleFolders)
{
    fs::path localtestroot = makeNewTestRoot();

    auto standardclient = g_clientManager->getCleanStandardClient(0, localtestroot); // user 1 client 2

    ASSERT_TRUE(standardclient->resetBaseFolderMulticlient());
    ASSERT_TRUE(CatchupClients(standardclient));

    vector<NewNode> newnodes(4);
    standardclient->prepareOneFolder(&newnodes[0], "folder1", false);
    standardclient->prepareOneFolder(&newnodes[1], "folder2", false);
    standardclient->prepareOneFolder(&newnodes[2], "folder2.1", false);
    standardclient->prepareOneFolder(&newnodes[3], "folder2.2", false);

    newnodes[1].nodehandle = newnodes[2].parenthandle = newnodes[3].parenthandle = 2;

    auto targethandle = standardclient->client.mNodeManager.getRootNodeFiles();

    std::atomic<bool> putnodesDone{false};
    standardclient->resultproc.prepresult(
        StandardClient::PUTNODES,
        ++next_request_tag,
        [&]()
        {
            standardclient->client.putnodes(targethandle,
                                            NoVersioning,
                                            std::move(newnodes),
                                            nullptr,
                                            standardclient->client.reqtag,
                                            false);
        },
        [&putnodesDone](error)
        {
            putnodesDone = true;
            return true;
        });

    while (!putnodesDone)
    {
        WaitMillisec(100);
    }

    std::shared_ptr<Node> cloudRoot = standardclient->client.nodeByHandle(targethandle);

    ASSERT_TRUE(nullptr != standardclient->drillchildnodebyname(cloudRoot, "folder1"));
    ASSERT_TRUE(nullptr != standardclient->drillchildnodebyname(cloudRoot, "folder2"));
    ASSERT_TRUE(nullptr != standardclient->drillchildnodebyname(cloudRoot, "folder2/folder2.1"));
    ASSERT_TRUE(nullptr != standardclient->drillchildnodebyname(cloudRoot, "folder2/folder2.2"));
}

// this test fails frequently on develop due to race conditions with commands vs actionpackets on develop, re-enable after merging sync rework (which has SIC removed)
TEST_F(SyncTest, DISABLED_ExerciseCommands)
{
    fs::path localtestroot = makeNewTestRoot();
    StandardClient standardclient(localtestroot, "ExerciseCommands");
    ASSERT_TRUE(standardclient.login_fetchnodes("MEGA_EMAIL", "MEGA_PWD", true));

    // Using this set setup to execute commands direct in the SDK Core
    // so that we can test things that the MegaApi interface would
    // disallow or shortcut.

    // make sure it's a brand new folder
    future<bool> p1 = standardclient.thread_do<bool>([=](StandardClient& sc, PromiseBoolSP pb) { sc.makeCloudSubdirs("testlinkfolder_brandnew3", 1, 1, pb); }, __FILE__, __LINE__);
    ASSERT_TRUE(waitonresults(&p1));

    assert(standardclient.lastPutnodesResultFirstHandle != UNDEF);
    std::shared_ptr<Node> n2 = standardclient.client.nodebyhandle(standardclient.lastPutnodesResultFirstHandle);

    out() << "Testing make public link for node: " << n2->displaypath();

    // try to get a link on an existing unshared folder
    promise<Error> pe1, pe1a, pe2, pe3, pe4;
    standardclient.getpubliclink(n2.get(), 0, 0, false, false, pe1);
    ASSERT_TRUE(debugTolerantWaitOnFuture(pe1.get_future(), 45));
    ASSERT_EQ(API_EACCESS, pe1.get_future().get());

    // create on existing node
    standardclient.exportnode(n2, 0, 0, false, false, pe1a);
    ASSERT_TRUE(debugTolerantWaitOnFuture(pe1a.get_future(), 45));
    ASSERT_EQ(API_OK, pe1a.get_future().get());

    // get link on existing shared folder node, with link already  (different command response)
    standardclient.getpubliclink(n2.get(), 0, 0, false, false, pe2);
    ASSERT_TRUE(debugTolerantWaitOnFuture(pe2.get_future(), 45));
    ASSERT_EQ(API_OK, pe2.get_future().get());

    // delete existing link on node
    standardclient.getpubliclink(n2.get(), 1, 0, false, false, pe3);
    ASSERT_TRUE(debugTolerantWaitOnFuture(pe3.get_future(), 45));
    ASSERT_EQ(API_OK, pe3.get_future().get());

    // create on non existent node
    n2->nodehandle = UNDEF;
    standardclient.getpubliclink(n2.get(), 0, 0, false, false, pe4);
    ASSERT_TRUE(debugTolerantWaitOnFuture(pe4.get_future(), 45));
    ASSERT_EQ(API_EACCESS, pe4.get_future().get());
}

#ifndef _WIN32_SUPPORTS_SYMLINKS_IT_JUST_NEEDS_TURNING_ON
TEST_F(SyncTest, BasicSync_CreateAndDeleteLink)
{
    // confirm change is synced to remote, and also seen and applied in a second client that syncs the same folder
    fs::path localtestroot = makeNewTestRoot();
    StandardClient clientA1(localtestroot, "clientA1");   // user 1 client 1
    StandardClient clientA2(localtestroot, "clientA2");   // user 1 client 2

    ASSERT_TRUE(clientA1.login_reset_makeremotenodes("MEGA_EMAIL", "MEGA_PWD", "f", 1, 1));
    ASSERT_TRUE(clientA2.login_fetchnodes("MEGA_EMAIL", "MEGA_PWD"));
    ASSERT_EQ(clientA1.basefolderhandle, clientA2.basefolderhandle);

    Model model;
    model.root->addkid(model.buildModelSubdirs("f", 1, 1, 0));

    // set up sync for A1, it should build matching local folders
    handle backupId1 = clientA1.setupSync_mainthread("sync1", "f", false, true);
    ASSERT_NE(backupId1, UNDEF);
    handle backupId2 = clientA2.setupSync_mainthread("sync2", "f", false, false);
    ASSERT_NE(backupId2, UNDEF);

    waitonsyncs(std::chrono::seconds(4), &clientA1, &clientA2);
    clientA1.logcb = clientA2.logcb = true;
    // check everything matches (model has expected state of remote and local)
    ASSERT_TRUE(clientA1.confirmModel_mainthread(model.findnode("f"), backupId1));
    ASSERT_TRUE(clientA2.confirmModel_mainthread(model.findnode("f"), backupId2));


    // move something in the local filesystem and see if we catch up in A1 and A2 (deleter and observer syncs)
    error_code linkage_error;
    fs::create_symlink(clientA1.syncSet(backupId1).localpath / "f_0", clientA1.syncSet(backupId1).localpath / "linked", linkage_error);
    ASSERT_TRUE(!linkage_error) << linkage_error;

    // let them catch up
    waitonsyncs(DEFAULTWAIT, &clientA1, &clientA2);

    // Wait for the engine to signal a stall as symlinks are unsupported.
    ASSERT_TRUE(clientA1.waitFor(SyncStallState(true), DEFAULTWAIT));

    // Make sure the engine stalled for the right reason.
    {
        SyncStallInfoTests stalls;

        auto reason = SyncWaitReason::FileIssue;
        auto problem = PathProblem::DetectedSymlink;

        ASSERT_TRUE(clientA1.syncStallDetected(stalls));
        ASSERT_FALSE(stalls.empty());
        ASSERT_FALSE(stalls.local.empty());
        ASSERT_EQ(stalls.local.begin()->second.reason, reason);
        ASSERT_EQ(stalls.local.begin()->second.localPath1.problem, problem);
    }

    // Check client 2 is unaffected
    ASSERT_TRUE(clientA2.confirmModel_mainthread(model.findnode("f"), backupId2));

    // Resolve the stall by removing the symlink.
    fs::remove(clientA1.syncSet(backupId1).localpath / "linked");

    // Wait for the stall to resolve.
    ASSERT_TRUE(clientA1.waitFor(SyncStallState(false), DEFAULTWAIT));

    // Wait for the syncs to process any changes.
    waitonsyncs(DEFAULTWAIT, &clientA1, &clientA2);

    // Check client 2 is unaffected
    ASSERT_TRUE(clientA2.confirmModel_mainthread(model.findnode("f"), backupId2));
}

TEST_F(SyncTest, BasicSync_CreateRenameAndDeleteLink)
{
    // confirm change is synced to remote, and also seen and applied in a second client that syncs the same folder
    fs::path localtestroot = makeNewTestRoot();

    auto clientA1 = g_clientManager->getCleanStandardClient(0, localtestroot); // user 1 client 2
    auto clientA2 = g_clientManager->getCleanStandardClient(0, localtestroot); // user 1 client 2
    ASSERT_TRUE(clientA1->resetBaseFolderMulticlient(clientA2));
    ASSERT_TRUE(clientA1->makeCloudSubdirs("f", 1, 1));
    ASSERT_TRUE(CatchupClients(clientA1, clientA2));

    ASSERT_EQ(clientA1->basefolderhandle, clientA2->basefolderhandle);

    Model model;
    model.root->addkid(model.buildModelSubdirs("f", 1, 1, 0));

    // set up sync for A1, it should build matching local folders
    handle backupId1 = clientA1->setupSync_mainthread("sync1", "f", false, true);
    ASSERT_NE(backupId1, UNDEF);
    handle backupId2 = clientA2->setupSync_mainthread("sync2", "f", false, false);
    ASSERT_NE(backupId2, UNDEF);

    waitonsyncs(std::chrono::seconds(4), clientA1, clientA2);
    clientA1->logcb = clientA2->logcb = true;
    // check everything matches (model has expected state of remote and local)
    ASSERT_TRUE(clientA1->confirmModel_mainthread(model.findnode("f"), backupId1));
    ASSERT_TRUE(clientA2->confirmModel_mainthread(model.findnode("f"), backupId2));


    // move something in the local filesystem and see if we catch up in A1 and A2 (deleter and observer syncs)
    error_code linkage_error;
    fs::create_symlink(clientA1->syncSet(backupId1).localpath / "f_0", clientA1->syncSet(backupId1).localpath / "linked", linkage_error);
    ASSERT_TRUE(!linkage_error) << linkage_error;

    // let them catch up
    waitonsyncs(DEFAULTWAIT, clientA1, clientA2);

    // Wait for the engine to detect a stall.
    ASSERT_TRUE(clientA1->waitFor(SyncStallState(true), DEFAULTWAIT));

    // Make sure we're stalling for the right reason.
    {
        SyncStallInfoTests info;

        auto reason = SyncWaitReason::FileIssue;
        auto problem = PathProblem::DetectedSymlink;

        ASSERT_TRUE(clientA1->syncStallDetected(info));
        ASSERT_FALSE(info.empty());
        ASSERT_FALSE(info.local.empty());
        ASSERT_EQ(info.local.begin()->second.reason, reason);
        ASSERT_EQ(info.local.begin()->second.localPath1.problem, problem);
    }

    //check client 2 is unaffected
    ASSERT_TRUE(clientA2->confirmModel_mainthread(model.findnode("f"), backupId2));

    // Rename the link.
    fs::rename(clientA1->syncSet(backupId1).localpath / "linked", clientA1->syncSet(backupId1).localpath / "linkrenamed", linkage_error);

    // let them catch up
    waitonsyncs(DEFAULTWAIT, clientA1, clientA2);

    // Make sure we don't recover from the stall.
    ASSERT_FALSE(clientA1->waitFor(SyncStallState(false), chrono::seconds(4)));

    // Make sure we're only reporting one symlink stall.
    {
        SyncStallInfoTests info;

        auto reason = SyncWaitReason::FileIssue;
        auto problem = PathProblem::DetectedSymlink;

        ASSERT_TRUE(clientA1->syncStallDetected(info));
        ASSERT_FALSE(info.empty());
        ASSERT_EQ(info.local.size(), 1u);
        ASSERT_EQ(info.local.begin()->second.reason, reason);
        ASSERT_EQ(info.local.begin()->second.localPath1.problem, problem);
    }

    //check client 2 is unaffected
    ASSERT_TRUE(clientA2->confirmModel_mainthread(model.findnode("f"), backupId2));

    // Resolve the stall by removing the symlink.
    fs::remove(clientA1->syncSet(backupId1).localpath / "linkrenamed");

    // Wait for the stall to resolve.
    ASSERT_TRUE(clientA1->waitFor(SyncStallState(false), DEFAULTWAIT));

    // let them catch up
    waitonsyncs(DEFAULTWAIT, clientA1, clientA2);

    //check client 2 is unaffected
    ASSERT_TRUE(clientA2->confirmModel_mainthread(model.findnode("f"), backupId2));
}

// what is supposed to happen for this one?  It seems that the `linked` symlink is no longer ignored on windows?  client2 is affected!

TEST_F(SyncTest, BasicSync_CreateAndReplaceLinkLocally)
{
    // confirm change is synced to remote, and also seen and applied in a second client that syncs the same folder
    fs::path localtestroot = makeNewTestRoot();

    auto clientA1 = g_clientManager->getCleanStandardClient(0, localtestroot); // user 1 client 2
    auto clientA2 = g_clientManager->getCleanStandardClient(0, localtestroot); // user 1 client 2
    ASSERT_TRUE(clientA1->resetBaseFolderMulticlient(clientA2));
    ASSERT_TRUE(clientA1->makeCloudSubdirs("f", 1, 2));
    ASSERT_TRUE(CatchupClients(clientA1, clientA2));

    ASSERT_EQ(clientA1->basefolderhandle, clientA2->basefolderhandle);

    Model model;
    model.root->addkid(model.buildModelSubdirs("f", 2, 1, 0));

    // set up sync for A1, it should build matching local folders
    handle backupId1 = clientA1->setupSync_mainthread("sync1", "f", false, true);
    ASSERT_NE(backupId1, UNDEF);
    handle backupId2 = clientA2->setupSync_mainthread("sync2", "f", false, false);
    ASSERT_NE(backupId2, UNDEF);

    waitonsyncs(std::chrono::seconds(4), clientA1, clientA2);
    clientA1->logcb = clientA2->logcb = true;

    // check everything matches (model has expected state of remote and local)
    ASSERT_TRUE(clientA1->confirmModel_mainthread(model.findnode("f"), backupId1));
    ASSERT_TRUE(clientA2->confirmModel_mainthread(model.findnode("f"), backupId2));

    // move something in the local filesystem and see if we catch up in A1 and A2 (deleter and observer syncs)
    error_code linkage_error;
    fs::create_symlink(clientA1->syncSet(backupId1).localpath / "f_0", clientA1->syncSet(backupId1).localpath / "linked", linkage_error);
    ASSERT_TRUE(!linkage_error) << linkage_error;

    clientA1->triggerPeriodicScanEarly(backupId1);

    // let them catch up
    waitonsyncs(std::chrono::seconds(4), clientA1, clientA2);

    // Wait for the engine to detect a stall.
    ASSERT_TRUE(clientA1->waitFor(SyncStallState(true), std::chrono::seconds(4)));

    // Make sure the client stalled for the reason we think.
    {
        SyncStallInfoTests info;

        ASSERT_TRUE(clientA1->syncStallDetected(info));
        ASSERT_FALSE(info.empty());
        ASSERT_FALSE(info.local.empty());
        ASSERT_EQ(info.local.begin()->second.reason, SyncWaitReason::FileIssue);
    }

    //check client 2 is unaffected
    ASSERT_TRUE(clientA2->confirmModel_mainthread(model.findnode("f"), backupId2));

    // Replace the link with a directory.
    fs::remove(clientA1->syncSet(backupId1).localpath / "linked");
    fs::rename(clientA1->syncSet(backupId1).localpath / "f_1", clientA1->syncSet(backupId1).localpath / "linked", linkage_error);
    ASSERT_TRUE(!linkage_error) << linkage_error;

    // Let the engine synchronize any changes.
    waitonsyncs(DEFAULTWAIT, clientA1, clientA2);

    // Update the model.
    model.findnode("f/f_1")->name = "linked";

    // Check that the directory has been uploaded.
    ASSERT_TRUE(clientA1->confirmModel_mainthread(model.findnode("f"), backupId1));
    ASSERT_TRUE(clientA2->confirmModel_mainthread(model.findnode("f"), backupId2));

    // Replace the directory with a file.
    fs::remove(clientA1->syncSet(backupId1).localpath / "linked");

    clientA1->triggerPeriodicScanEarly(backupId1);

    // Wait for the engine to synchronize changes.
    waitonsyncs(DEFAULTWAIT, clientA1, clientA2);

    ASSERT_TRUE(createNameFile(clientA1->syncSet(backupId1).localpath, "linked"));

    clientA1->triggerPeriodicScanEarly(backupId1);

    // Wait for the engine to synchronize changes.
    waitonsyncs(DEFAULTWAIT, clientA1, clientA2);

    // Update the model.
    auto linkedNode = model.removenode("f/linked");
    model.findnode("f")->addkid(model.makeModelSubfile("linked"));

    // Check that the changes have been synchronized.
    ASSERT_TRUE(clientA1->confirmModel_mainthread(model.findnode("f"), backupId1));

    // Necessary as clientA2 has downloaded files.
    model.movetosynctrash(std::move(linkedNode), "f");
    model.ensureLocalDebrisTmpLock("f");

    ASSERT_TRUE(clientA2->confirmModel_mainthread(model.findnode("f"), backupId2));
}

TEST_F(SyncTest, BasicSync_CreateAndReplaceLinkUponSyncDown)
{
    // confirm change is synced to remote, and also seen and applied in a second client that syncs the same folder
    fs::path localtestroot = makeNewTestRoot();

    auto clientA1 = g_clientManager->getCleanStandardClient(0, localtestroot); // user 1 client 2
    auto clientA2 = g_clientManager->getCleanStandardClient(0, localtestroot); // user 1 client 2
    ASSERT_TRUE(clientA1->resetBaseFolderMulticlient(clientA2));
    ASSERT_TRUE(clientA1->makeCloudSubdirs("f", 1, 1));
    ASSERT_TRUE(CatchupClients(clientA1, clientA2));
    ASSERT_EQ(clientA1->basefolderhandle, clientA2->basefolderhandle);

    Model model;
    model.root->addkid(model.buildModelSubdirs("f", 1, 1, 0));

    // set up sync for A1, it should build matching local folders
    handle backupId1 = clientA1->setupSync_mainthread("sync1", "f", false, true);
    ASSERT_NE(backupId1, UNDEF);
    handle backupId2 = clientA2->setupSync_mainthread("sync2", "f", false, false);
    ASSERT_NE(backupId2, UNDEF);

    waitonsyncs(std::chrono::seconds(4), clientA1, clientA2);
    clientA1->logcb = clientA2->logcb = true;
    // check everything matches (model has expected state of remote and local)
    ASSERT_TRUE(clientA1->confirmModel_mainthread(model.findnode("f"), backupId1));
    ASSERT_TRUE(clientA2->confirmModel_mainthread(model.findnode("f"), backupId2));

    // move something in the local filesystem and see if we catch up in A1 and A2 (deleter and observer syncs)
    error_code linkage_error;
    fs::create_symlink(clientA1->syncSet(backupId1).localpath / "f_0", clientA1->syncSet(backupId1).localpath / "linked", linkage_error);
    ASSERT_TRUE(!linkage_error) << linkage_error;

    clientA1->triggerPeriodicScanEarly(backupId1);

    // let them catch up
    waitonsyncs(DEFAULTWAIT, clientA1, clientA2);

    // Wait for the engine to stall.
    ASSERT_TRUE(clientA1->waitFor(SyncStallState(true), DEFAULTWAIT));

    // Check client 2 is unaffected
    ASSERT_TRUE(clientA2->confirmModel_mainthread(model.findnode("f"), backupId2));

    // Upload a file to the web via A2.
    ASSERT_TRUE(createFile(clientA2->syncSet(backupId2).localpath / "linked", "linked"));
    model.addfile("f/linked", "linked");

    clientA2->triggerPeriodicScanEarly(backupId2);

    // Wait for A2's file to hit the cloud.
    ASSERT_TRUE(clientA2->waitFor(SyncRemoteNodePresent("f/linked"), DEFAULTWAIT));

    // Remove the symlink from A1.
    fs::remove(clientA1->syncSet(backupId1).localpath / "linked");

    clientA1->triggerPeriodicScanEarly(backupId1);

    // Wait for the stall to resolve.
    ASSERT_TRUE(clientA1->waitFor(SyncStallState(false), DEFAULTWAIT));

    // Wait for the engine to process changes.
    waitonsyncs(DEFAULTWAIT, clientA1, clientA2);

    // Confirm models.
    ASSERT_TRUE(clientA2->confirmModel_mainthread(model.findnode("f"), backupId2));

    // Needed as A1 has downloaded files.
    model.ensureLocalDebrisTmpLock("f");

    // Check A1 has downloaded A2's upload.
    ASSERT_TRUE(clientA1->confirmModel_mainthread(model.findnode("f"), backupId1));
}
#endif

TEST_F(SyncTest, BasicSync_NewVersionsCreatedWhenFilesModified)
{
    const auto TESTROOT = makeNewTestRoot();
    const auto TIMEOUT = std::chrono::seconds(4);

    auto c = g_clientManager->getCleanStandardClient(0, TESTROOT);
    CatchupClients(c);

    // Log callbacks.
    c->logcb = true;

    // Fingerprints for each revision.
    vector<FileFingerprint> fingerprints;

    // Log client in.
    //ASSERT_TRUE(c.login_reset_makeremotenodes("MEGA_EMAIL", "MEGA_PWD", "x", 0, 0));
    ASSERT_TRUE(c->resetBaseFolderMulticlient());
    ASSERT_TRUE(c->makeCloudSubdirs("x", 0, 0));
    ASSERT_TRUE(CatchupClients(c));

    // Add and start sync.
    const auto id = c->setupSync_mainthread("s", "x", false, true);
    ASSERT_NE(id, UNDEF);

    const auto SYNCROOT = c->syncSet(id).localpath;

    // Create and populate model.
    Model model;

    model.addfile("f", "a");
    model.generate(SYNCROOT);

    // Keep track of fingerprint.
    fingerprints.emplace_back(c->fingerprint(SYNCROOT / "f"));
    ASSERT_TRUE(fingerprints.back().isvalid);

    c->triggerPeriodicScanEarly(id);

    // Wait for initial sync to complete.
    waitonsyncs(TIMEOUT, c);

    // Check that the file made it to the cloud.
    ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));

    // Create a new revision of f.
    model.addfile("f", "b");
    model.generate(SYNCROOT);

    // Update fingerprint.
    fingerprints.emplace_back(c->fingerprint(SYNCROOT / "f"));
    ASSERT_TRUE(fingerprints.back().isvalid);

    c->triggerPeriodicScanEarly(id);

    // Wait for change to propagate.
    waitonsyncs(TIMEOUT, c);

    // Validate model.
    ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));

    // Create yet anothet revision of f.
    model.addfile("f", "c");
    model.generate(SYNCROOT);

    // Update fingerprint.
    fingerprints.emplace_back(c->fingerprint(SYNCROOT / "f"));
    ASSERT_TRUE(fingerprints.back().isvalid);

    c->triggerPeriodicScanEarly(id);

    // Wait for change to propagate.
    waitonsyncs(TIMEOUT, c);

    // Validate model.
    ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));

    // Get our hands on f's node.
    auto f = c->drillchildnodebyname(c->gettestbasenode(), "x/f");
    ASSERT_TRUE(f);

    // Validate the version chain.
    auto i = fingerprints.crbegin();
    auto matched = true;

    while (f && i != fingerprints.crend())
    {
        matched &= *f == *i++;

        sharedNode_list children = c->client.getChildren(f.get());
        f = children.empty() ? nullptr : children.front();
    }

    matched &= !f && i == fingerprints.crend();
    ASSERT_TRUE(matched);
}

#ifdef SRW_NEEDED_FOR_THIS_ONE
TEST_F(SyncTest, DetectsAndReportsNameClashes)
{
    const auto TESTFOLDER = makeNewTestRoot();
    const auto TIMEOUT = chrono::seconds(4);

    StandardClientInUse client = g_clientManager->getCleanStandardClient(0, TESTFOLDER);
    ASSERT_TRUE(client->resetBaseFolderMulticlient());
    ASSERT_TRUE(client->makeCloudSubdirs("x", 0, 0));
    ASSERT_TRUE(CatchupClients(client));

    // Needed so that we can create files with the same name.
    client->client.versions_disabled = true;

    // Populate local filesystem.
    const auto root = client->fsBasePath / "s";

    fs::create_directories(root / "d" / "e");

    createNameFile(root / "d", "f0");
    createNameFile(root / "d", "f%30");

    // Start the sync.
    handle backupId1 = client->setupSync_mainthread("s", "x", false, true);
    ASSERT_NE(backupId1, UNDEF);

    // Give the client time to synchronize.
    waitonsyncs(TIMEOUT, client);

    // Were any conflicts detected?
    ASSERT_TRUE(client->waitFor(SyncConflictState(true), TIMEOUT));
    ASSERT_TRUE(client->waitFor(SyncTotalConflictsStateUpdate(false), TIMEOUT)); // First state change - not new updates should be notified

    // Can we obtain a list of the conflicts?
    list<NameConflict> conflicts;
    ASSERT_TRUE(client->conflictsDetected(conflicts));
    ASSERT_EQ(conflicts.size(), 1u);

    // Create another name clashing conflict.
    createNameFile(root / "d" / "e", "g0");
    createNameFile(root / "d" / "e", "g%30");

    // Give the client time to synchronize.
    waitonsyncs(TIMEOUT, client);

    // Were the new conflicts detected?
    ASSERT_TRUE(client->waitFor(SyncTotalConflictsStateUpdate(true), TIMEOUT));

    // Has the list of conflicts changed?
    conflicts.clear();
    ASSERT_TRUE(client->conflictsDetected(conflicts));
    ASSERT_EQ(conflicts.size(), 2u);
    ASSERT_EQ(conflicts.back().localPath, LocalPath::fromRelativePath("d").prependNewWithSeparator(client->syncByBackupId(backupId1)->localroot->localname));
    ASSERT_EQ(conflicts.back().clashingLocalNames.size(), 2u);
    // Helpers.
    auto localConflictDetected = [](const NameConflict& nc, const LocalPath& name)
    {
        auto i = nc.clashingLocalNames.begin();
        auto j = nc.clashingLocalNames.end();

        return std::find(i, j, name) != j;
    };
    ASSERT_TRUE(localConflictDetected(conflicts.back(), LocalPath::fromRelativePath("f%30")));
    ASSERT_TRUE(localConflictDetected(conflicts.back(), LocalPath::fromRelativePath("f0")));
    ASSERT_EQ(conflicts.back().clashingCloud.size(), 0u);

    // Conflicts Update flag should be disabled now
    ASSERT_TRUE(client->waitFor(SyncTotalConflictsStateUpdate(false), TIMEOUT));

    client->triggerPeriodicScanEarly(backupId1);

    // Resolve the f0 / f%30 conflict.
    ASSERT_TRUE(fs::remove(root / "d" / "f%30"));

    // Give the sync some time to think.
    waitonsyncs(TIMEOUT, client);

    // We should still detect conflicts, and get an update due for having 1 conflict instead of the previous 2.
    ASSERT_TRUE(client->waitFor(SyncTotalConflictsStateUpdate(true), TIMEOUT));

    // Has the list of conflicts changed?
    conflicts.clear();
    ASSERT_TRUE(client->conflictsDetected(conflicts));
    ASSERT_GE(conflicts.size(), 1u);
    ASSERT_EQ(conflicts.front().localPath, LocalPath::fromRelativePath("e")
        .prependNewWithSeparator(LocalPath::fromRelativePath("d"))
        .prependNewWithSeparator(client->syncByBackupId(backupId1)->localroot->localname));
    ASSERT_EQ(conflicts.front().clashingLocalNames.size(), 2u);
    ASSERT_TRUE(localConflictDetected(conflicts.front(), LocalPath::fromRelativePath("g%30")));
    ASSERT_TRUE(localConflictDetected(conflicts.front(), LocalPath::fromRelativePath("g0")));
    ASSERT_EQ(conflicts.front().clashingCloud.size(), 0u);

    // Conflicts Update flag should be disabled now
    ASSERT_TRUE(client->waitFor(SyncTotalConflictsStateUpdate(false), TIMEOUT));

    // Resolve the g / g%30 conflict.
    ASSERT_TRUE(fs::remove(root / "d" / "e" / "g%30"));

    client->triggerPeriodicScanEarly(backupId1);

    // Give the sync some time to think.
    waitonsyncs(TIMEOUT, client);

    // No conflicts should be reported.
    ASSERT_TRUE(client->waitFor(SyncConflictState(false), TIMEOUT));

    // Is the list of conflicts empty?
    conflicts.clear();
    ASSERT_FALSE(client->conflictsDetected(conflicts));
    ASSERT_EQ(conflicts.size(), 0u);

    // Create a remote name clash.
    auto node = client->drillchildnodebyname(client->gettestbasenode(), "x/d");
    ASSERT_TRUE(!!node);
    ASSERT_TRUE(client->uploadFile(root / "d" / "f0", "h", node.get()));
    ASSERT_TRUE(client->uploadFile(root / "d" / "f0", "h", node.get()));

    // Let the client attempt to synchronize.
    waitonsyncs(TIMEOUT, client);

    // Have we detected any conflicts?
    ASSERT_TRUE(client->waitFor(SyncConflictState(true), TIMEOUT));
    conflicts.clear();
    ASSERT_TRUE(client->conflictsDetected(conflicts));

    // Does our list of conflicts include remotes?
    ASSERT_GE(conflicts.size(), 1u);
    ASSERT_EQ(conflicts.front().cloudPath, string("/mega_test_sync/x/d"));
    ASSERT_EQ(conflicts.front().clashingCloud.size(), 2u);
    ASSERT_EQ(conflicts.front().clashingCloud[0].name, string("h"));
    ASSERT_EQ(conflicts.front().clashingCloud[1].name, string("h"));
    ASSERT_EQ(conflicts.front().clashingLocalNames.size(), 0u);

    // Conflicts Update flag should be disabled now
    ASSERT_TRUE(client->waitFor(SyncTotalConflictsStateUpdate(false), TIMEOUT));

    // Resolve the remote conflict.
    ASSERT_TRUE(client->deleteremote("x/d/h"));

    // Wait for the client to process our changes.
    waitonsyncs(TIMEOUT, client);

    conflicts.clear();
    client->conflictsDetected(conflicts);
    ASSERT_EQ(0u, conflicts.size());

    // Conflicts should be resolved.
    ASSERT_TRUE(client->waitFor(SyncConflictState(false), TIMEOUT));
    conflicts.clear();
    ASSERT_FALSE(client->conflictsDetected(conflicts));
}

/**
 * @brief TEST_F DetectsAndReportsSyncProblems
 *
 * Tests Synchronization when there are sync problems (name conflicts and stall issues).
 *
 * # Test1: generate two name conflicts in sync folder 1
 * - U1: creates a directory tree in cloud drive (/x1)
 * - U1: creates a tree in local FS (root/s/d1)
 * - U1: creates a local file (root/s/d1/f0)
 * - U1: creates a local file (root/s/d1/f%30)
 * - U1: synchronizes d1 with x1
 * - U1: wait for syncs
 * - U1 checks if name conflict has been detected and it's the expected one
 * - U1: creates a local file (root/s/d/f10)
 * - U1: creates a local file (root/s/d/f1%30)
 * - U1: synchronizes d1 with x1
 * - U1: wait for syncs
 * - U1 checks if name conflict has been detected and it's the expected one
 *
 * # Test2: generate two name conflicts in sync folder 2
 * - U1: creates a directory tree in cloud drive (/x2)
 * - U1: creates a tree in local FS (root/s/d2)
 * - U1: creates a local file (root/s/d2/f0)
 * - U1: creates a local file (root/s/d2/f%30)
 * - U1: synchronizes d2 with x2
 * - U1: wait for syncs
 * - U1 checks if name conflict has been detected and it's the expected one
 * - U1: creates a local file (root/s/d2/f10)
 * - U1: creates a local file (root/s/d2/f1%30)
 * - U1: synchronizes d2 with x2
 * - U1: wait for syncs
 * - U1 checks if name conflict has been detected and it's the expected one
 *
 * # Test3: generate a stall issue in sync folder 3
 * - U1: creates a directory tree in cloud drive (/x3)
 * - U1: creates a tree in local FS (root/s/d3)
 * - U1: creates a local file (root/s/d3/n0)
 * - U1: creates a hardlink from n1 into path (root/s/d3/e/n5)
 * - U1: wait for syncs and check if stall issue has been detected and it's the expected one
 *
 * # Test4: generate a stall issue in sync folder 4
 * - U1: creates a directory tree in cloud drive (/x4)
 * - U1: creates a tree in local FS (root/s/d4)
 * - U1: creates a local file (root/s/d4/n0)
 * - U1: creates a hardlink from n1 into path (root/s/d4/e/n5)
 * - U1: wait for syncs and check if stall issue has been detected and it's the expected one
 */
TEST_F(SyncTest, DetectsAndReportsSyncProblems)
{
    const auto TESTFOLDER = makeNewTestRoot();
    const auto TIMEOUT = chrono::seconds(8);
    StandardClientInUse client = g_clientManager->getCleanStandardClient(0, TESTFOLDER);
    client->client.versions_disabled = true; // allowing creating files with the same name.
    ASSERT_TRUE(client->resetBaseFolderMulticlient());
    const std::string rootdir = "s";
    const auto root = client->fsBasePath / rootdir;

    LOG_debug << "#### Test1(DetectsAndReportsSyncProblems): generate two name conflicts in sync "
                 "folder 1 ####";
    const std::string ldir1 = "d1";
    const std::string rdir1 = "x1";
    fs::create_directories(root / ldir1);
    ASSERT_TRUE(client->makeCloudSubdirs(rdir1, 0, 0));
    ASSERT_TRUE(CatchupClients(client));
    const handle backupId1 =
        client->setupSync_mainthread(path_u8string((root / ldir1)), rdir1, false, true);
    ASSERT_NE(backupId1, UNDEF) << "Invalid BackupId";

    const std::string f11 = "f0";
    const std::string f12 = "f%30";
    createNameFile(root / ldir1, f11);
    createNameFile(root / ldir1, f12);
    waitonsyncs(TIMEOUT, client);
    ASSERT_TRUE(client->waitFor(SyncConflictState(true), TIMEOUT))
        << "Name conflicts were not detected";
    ASSERT_TRUE(
        client->waitFor(SyncTotalConflictsStateUpdate(false),
                        TIMEOUT)); // First state change - not new updates should be notified
    auto& ln1 = client->syncByBackupId(backupId1)->localroot->localname;
    ASSERT_NO_FATAL_FAILURE(client->checkSyncProblems(backupId1, 1u, 1u, ln1, f11, f12));

    const std::string f13 = "f10";
    const std::string f14 = "f1%30";
    createNameFile(root / ldir1, f13);
    createNameFile(root / ldir1, f14);
    waitonsyncs(TIMEOUT, client);
    ASSERT_TRUE(client->waitFor(SyncTotalConflictsStateUpdate(true), TIMEOUT));
    ASSERT_NO_FATAL_FAILURE(client->checkSyncProblems(backupId1, 1u, 2u, ln1, f13, f14));

    LOG_debug << "#### Test2(DetectsAndReportsSyncProblems): generate two name conflicts in sync "
                 "folder 2 ####";
    // Create directory tree required for test
    const std::string ldir2 = "d2";
    const std::string rdir2 = "x2";
    fs::create_directories(root / ldir2);
    ASSERT_TRUE(client->makeCloudSubdirs(rdir2, 0, 0));
    ASSERT_TRUE(CatchupClients(client));
    const handle backupId2 =
        client->setupSync_mainthread(path_u8string((root / ldir2)), rdir2, false, true);
    ASSERT_NE(backupId2, UNDEF) << "Invalid BackupId";

    const std::string f21 = "f0";
    const std::string f22 = "f%30";
    createNameFile(root / ldir2, f21);
    createNameFile(root / ldir2, f22);
    waitonsyncs(TIMEOUT, client);
    ASSERT_TRUE(client->waitFor(SyncTotalConflictsStateUpdate(true), TIMEOUT));
    auto& ln2 = client->syncByBackupId(backupId2)->localroot->localname;
    ASSERT_NO_FATAL_FAILURE(client->checkSyncProblems(backupId2, 2u, 1u, ln2, f21, f22));

    const std::string f23 = "f10";
    const std::string f24 = "f1%30";
    createNameFile(root / ldir2, f23);
    createNameFile(root / ldir2, f24);
    waitonsyncs(TIMEOUT, client);
    ASSERT_TRUE(client->waitFor(SyncTotalConflictsStateUpdate(true), TIMEOUT));
    ASSERT_NO_FATAL_FAILURE(client->checkSyncProblems(backupId2, 2u, 2u, ln2, f23, f24));

    LOG_debug << "#### Test3(DetectsAndReportsSyncProblems): generate a stall issue in sync folder "
                 "1 ####";
    const std::string ldir3 = "d3";
    const std::string rdir3 = "x3";
    fs::create_directories(root / ldir3);
    ASSERT_TRUE(client->makeCloudSubdirs(rdir3, 0, 0));
    ASSERT_TRUE(CatchupClients(client));
    const handle backupId3 =
        client->setupSync_mainthread(path_u8string((root / ldir3)), rdir3, false, true);
    ASSERT_NE(backupId3, UNDEF) << "Invalid BackupId";
    fs::create_directories(root / ldir3 / "e");

    constexpr auto transferTimeout{30s};

    auto createFileAndWaitForUploadOf =
        [&](const fs::path& path, const std::string& name, std::chrono::seconds timeout)
    {
        std::promise<void> p;
        auto f = p.get_future();
        std::atomic_bool done{false};

        auto filePath = path / name;
        client->mOnSyncTreeState = [&p, &done, filePath](const SyncConfig&,
                                                         const LocalPath& localPath,
                                                         treestate_t treeState,
                                                         nodetype_t)
        {
            if (localPath.toPath(false) != path_u8string(filePath) ||
                treeState != treestate_t::TREESTATE_SYNCED)
            {
                return;
            }

            if (done.exchange(true))
            {
                LOG_err << "Promise has been already resolved";
                return;
            }

            p.set_value();
        };

        EXPECT_TRUE(createFile(filePath, name));
        auto status = f.wait_for(timeout);
        client->mOnSyncTreeState = nullptr;
        return status == std::future_status::ready;
    };

    std::string fileNameTest3{"n0"};

    ASSERT_TRUE(createFileAndWaitForUploadOf(root / ldir3, fileNameTest3, transferTimeout));
    waitonsyncs(TIMEOUT, client);

    LocalPath sPath1;
    LocalPath tPath1;
    client->createHardLink(root / ldir3 / fileNameTest3, root / ldir3 / "e" / "n5", sPath1, tPath1);

    waitonsyncs(TIMEOUT, client);
    ASSERT_TRUE(client->waitFor(SyncStallState(true), TIMEOUT));
    ASSERT_TRUE(
        client->waitFor(SyncTotalStallsStateUpdate(false),
                        TIMEOUT)); // First time stall state, the update flag should be unset
    ASSERT_NO_FATAL_FAILURE(client->checkStallIssues(backupId3, 1u, sPath1, tPath1));

    LOG_debug << "#### Test4(DetectsAndReportsSyncProblems): generate a stall issue in sync folder "
                 "2 ####";
    const std::string ldir4 = "d4";
    const std::string rdir4 = "x4";
    fs::create_directories(root / ldir4);
    ASSERT_TRUE(client->makeCloudSubdirs(rdir4, 0, 0));
    ASSERT_TRUE(CatchupClients(client));
    const handle backupId4 =
        client->setupSync_mainthread(path_u8string((root / ldir4)), rdir4, false, true);
    ASSERT_NE(backupId4, UNDEF) << "Invalid BackupId";
    fs::create_directories(root / ldir4 / "e");
    std::string fileNameTest4{"n0"};
    ASSERT_TRUE(createFileAndWaitForUploadOf(root / ldir4, fileNameTest4, transferTimeout));
    waitonsyncs(TIMEOUT, client);

    LocalPath sPath2;
    LocalPath tPath2;
    client->createHardLink(root / ldir4 / fileNameTest4, root / ldir4 / "e" / "n5", sPath2, tPath2);

    waitonsyncs(TIMEOUT, client);
    ASSERT_TRUE(client->waitForSyncTotalStallsStateUpdateTrue(TIMEOUT));
    ASSERT_NO_FATAL_FAILURE(client->checkStallIssues(backupId4, 2u, sPath2, tPath2));
}
#endif

#ifdef SRW_NEEDED_FOR_THIS_ONE
TEST_F(SyncTest, DoesntDownloadFilesWithClashingNames)
{
    const auto TESTFOLDER = makeNewTestRoot();
    const auto TIMEOUT = chrono::seconds(4);

    StandardClientInUse cu = g_clientManager->getCleanStandardClient(0, TESTFOLDER);
    StandardClientInUse cd = g_clientManager->getCleanStandardClient(0, TESTFOLDER);
    // Log callbacks.
    cu->logcb = true;
    cd->logcb = true;
    ASSERT_TRUE(cd->resetBaseFolderMulticlient(cu));
    ASSERT_TRUE(cd->makeCloudSubdirs("x", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cu));

    // Populate cloud.
    {
        // Needed so that we can create files with the same name.
        cu->client.versions_disabled = true;

        // Create local test hierarchy.
        const auto root = cu->fsBasePath / "x";

        // d will be duplicated and generate a clash.
        fs::create_directories(root / "d");

        // dd will be singular, no clash.
        fs::create_directories(root / "dd");

        // f will be duplicated and generate a clash.
        ASSERT_TRUE(createNameFile(root, "f"));

        // ff will be singular, no clash.
        ASSERT_TRUE(createNameFile(root, "ff"));

        auto node = cu->drillchildnodebyname(cu->gettestbasenode(), "x");
        ASSERT_TRUE(!!node);

        // Upload d twice, generate clash.
        ASSERT_TRUE(cu->uploadFolderTree(root / "d", node.get()));
        ASSERT_TRUE(cu->uploadFolderTree(root / "d", node.get()));

        // Upload dd once.
        ASSERT_TRUE(cu->uploadFolderTree(root / "dd", node.get()));

        // Upload f twice, generate clash.
        ASSERT_TRUE(cu->uploadFile(root / "f", node.get()));
        ASSERT_TRUE(cu->uploadFile(root / "f", node.get()));

        // Upload ff once.
        ASSERT_TRUE(cu->uploadFile(root / "ff", node.get()));
    }
    ASSERT_TRUE(CatchupClients(cd, cu));

    // Add and start sync.
    handle backupId1 = cd->setupSync_mainthread("sd", "x", false, false);
    ASSERT_NE(backupId1, UNDEF);

    // Wait for initial sync to complete.
    waitonsyncs(TIMEOUT, cd);

    // Populate and confirm model.
    Model model;

    // d and f are missing due to name collisions in the cloud.
    model.root->addkid(model.makeModelSubfolder("x"));
    model.findnode("x")->addkid(model.makeModelSubfolder("dd"));
    model.findnode("x")->addkid(model.makeModelSubfile("ff"));

    // Needed because we've downloaded files.
    model.ensureLocalDebrisTmpLock("x");

    // Confirm the model.
    ASSERT_TRUE(cd->confirmModel_mainthread(
                  model.findnode("x"),
                  backupId1,
                  false,
                  StandardClient::CONFIRM_LOCAL));

    // Resolve the name collisions.
    ASSERT_TRUE(cd->deleteremote("x/d"));
    ASSERT_TRUE(cd->deleteremote("x/f"));

    // Wait for the sync to update.
    waitonsyncs(TIMEOUT, cd);

    // Confirm that d and f have now been downloaded.
    model.findnode("x")->addkid(model.makeModelSubfolder("d"));
    model.findnode("x")->addkid(model.makeModelSubfile("f"));

    // Local FS, Local Tree and Remote Tree should now be consistent.
    ASSERT_TRUE(cd->confirmModel_mainthread(model.findnode("x"), backupId1));
}

// TODO: re-enable after sync rework is merged
TEST_F(SyncTest, DoesntUploadFilesWithClashingNames)
{
    const auto TESTFOLDER = makeNewTestRoot();
    const auto TIMEOUT = chrono::seconds(4);

    StandardClientInUse cd = g_clientManager->getCleanStandardClient(0, TESTFOLDER);
    StandardClientInUse cu = g_clientManager->getCleanStandardClient(0, TESTFOLDER);

    // Log callbacks.
    cd->logcb = true;
    cu->logcb = true;

    // Log in client.
    ASSERT_TRUE(cd->resetBaseFolderMulticlient(cu));
    ASSERT_TRUE(cd->makeCloudSubdirs("x", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cu));

    ASSERT_EQ(cd->basefolderhandle, cu->basefolderhandle);

    // Populate the local filesystem.
    const auto root = cu->fsBasePath / "su";

    // Make sure clashing directories are skipped.
    fs::create_directories(root / "d0");
    fs::create_directories(root / "d%30");

    // Make sure other directories are uploaded.
    fs::create_directories(root / "d1");

    // Make sure clashing files are skipped.
    createNameFile(root, "f0");
    createNameFile(root, "f%30");

    // Make sure other files are uploaded.
    createNameFile(root, "f1");
    createNameFile(root / "d1", "f0");

    // Start the syncs.
    handle backupId1 = cd->setupSync_mainthread("sd", "x", false, true);
    handle backupId2 = cu->setupSync_mainthread("su", "x", false, false);
    ASSERT_NE(backupId1, UNDEF);
    ASSERT_NE(backupId2, UNDEF);

    // Wait for the initial sync to complete.
    waitonsyncs(TIMEOUT, cu, cd);

    // Populate and confirm model.
    Model model;

    model.root->addkid(model.makeModelSubfolder("root"));
    model.findnode("root")->addkid(model.makeModelSubfolder("d1"));
    model.findnode("root")->addkid(model.makeModelSubfile("f1"));
    model.findnode("root/d1")->addkid(model.makeModelSubfile("f0"));

    model.ensureLocalDebrisTmpLock("root");

    ASSERT_TRUE(cd->confirmModel_mainthread(model.findnode("root"), backupId1));

    // Remove the clashing nodes.
    fs::remove_all(root / "d0");
    fs::remove_all(root / "f0");

    cu->triggerPeriodicScanEarly(backupId2);

    // Wait for the sync to complete.
    waitonsyncs(TIMEOUT, cd, cu);

    // Confirm that d0 and f0 have been downloaded.
    model.findnode("root")->addkid(model.makeModelSubfolder("d0"));
    model.findnode("root")->addkid(model.makeModelSubfile("f0", "f%30"));

    ASSERT_TRUE(cu->confirmModel_mainthread(model.findnode("root"), backupId2, true));
}
#endif

TEST_F(SyncTest, RemotesWithControlCharactersSynchronizeCorrectly)
{
    const auto TESTROOT = makeNewTestRoot();
    const auto TIMEOUT = chrono::seconds(4);

    StandardClientInUse cd = g_clientManager->getCleanStandardClient(0, TESTROOT);
    StandardClientInUse cu = g_clientManager->getCleanStandardClient(0, TESTROOT);

    // Log callbacks.
    cd->logcb = true;
    cu->logcb = true;

    // Log in client.
    ASSERT_TRUE(cu->resetBaseFolderMulticlient(cd));
    ASSERT_TRUE(cu->makeCloudSubdirs("x", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cu));

    // Populate cloud.
    {
        // Log in client and clear remote contents.

        auto node = cu->drillchildnodebyname(cu->gettestbasenode(), "x");
        ASSERT_TRUE(!!node);

        // Create some directories containing control characters.
        vector<NewNode> nodes(2);

        // Only some platforms will escape BEL.
        cu->prepareOneFolder(&nodes[0], "d\7", false);
        cu->prepareOneFolder(&nodes[1], "d", false);

        ASSERT_TRUE(cu->putnodes(node->nodeHandle(), NoVersioning, std::move(nodes)));

        // Do the same but with some files.
        auto root = cu->fsBasePath / "x";
        fs::create_directories(root);

        // Placeholder name.
        ASSERT_TRUE(createNameFile(root, "f"));

        // Upload files.
        ASSERT_TRUE(cu->uploadFile(root / "f", "f\7", node.get()));
        ASSERT_TRUE(cu->uploadFile(root / "f", node.get()));
    }

    // Add and start sync.
    handle backupId1 = cd->setupSync_mainthread("sd", "x", false, false);
    ASSERT_NE(backupId1, UNDEF);

    // Wait for initial sync to complete.
    waitonsyncs(TIMEOUT, cd);

    // Populate and confirm model.
    Model model;

    model.addfolder("x/d\7")->mFsName = "d%07";
    model.addfolder("x/d");
    model.addfile("x/f\7", "f")->mFsName = "f%07";
    model.addfile("x/f", "f");

    // Needed because we've downloaded files.
    model.ensureLocalDebrisTmpLock("x");

    ASSERT_TRUE(cd->confirmModel_mainthread(model.findnode("x"), backupId1));

    // Remotely remove d\7.
    ASSERT_TRUE(cd->deleteremote("x/d\7"));
    ASSERT_TRUE(model.movetosynctrash("x/d\7", "x"));

    // Locally remove f\7.
    auto syncRoot = cd->fsBasePath / "sd";
#ifdef _WIN32
    ASSERT_TRUE(fs::remove(syncRoot / "f%07"));
#else /* _WIN32 */
    ASSERT_TRUE(fs::remove(syncRoot / "f\7"));
#endif /* ! _WIN32 */
    ASSERT_TRUE(!!model.removenode("x/f\7"));

    cd->triggerPeriodicScanEarly(backupId1);

    // Wait for synchronization to complete.
    waitonsyncs(TIMEOUT, cd);

    // Confirm models.
    ASSERT_TRUE(cd->confirmModel_mainthread(model.findnode("x"), backupId1));

    // Locally create some files with control escapes in their names.
#ifdef _WIN32
    ASSERT_TRUE(fs::create_directories(syncRoot / "dd%07"));
    ASSERT_TRUE(createFile(syncRoot / "ff%07", "ff"));
#else
    ASSERT_TRUE(fs::create_directories(syncRoot / "dd\7"));
    ASSERT_TRUE(createFile(syncRoot / "ff\7", "ff"));
#endif /* ! _WIN32 */

    // Wait for synchronization to complete.
    waitonsyncs(TIMEOUT, cd);

    // Update and confirm models.
    model.addfolder("x/dd\7")->fsName("dd%07");
    model.addfile("x/ff\7", "ff")->fsName("ff%07");

    ASSERT_TRUE(cd->confirmModel_mainthread(model.findnode("x"), backupId1));
}

// this test contains tests for % being escaped from cloud->local which we are undoing for now on this branch
TEST_F(SyncTest, DISABLED_RemotesWithEscapesSynchronizeCorrectly)
{
    const auto TESTROOT = makeNewTestRoot();
    const auto TIMEOUT = chrono::seconds(4);

    StandardClientInUse cu = g_clientManager->getCleanStandardClient(0, TESTROOT);
    StandardClientInUse cd = g_clientManager->getCleanStandardClient(0, TESTROOT);

    // Log callbacks.
    cd->logcb = true;
    cu->logcb = true;

    // Log in client.
    ASSERT_TRUE(cu->resetBaseFolderMulticlient(cd));
    ASSERT_TRUE(cu->makeCloudSubdirs("x", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cu));

    // Populate cloud.
    {
        // Build test hierarchy.
        const auto root = cu->fsBasePath / "x";

        // Escapes will not be decoded as we're uploading directly.
        fs::create_directories(root / "d0");
        fs::create_directories(root / "d%30");

        ASSERT_TRUE(createNameFile(root, "f0"));
        ASSERT_TRUE(createNameFile(root, "f%30"));

        auto node = cu->drillchildnodebyname(cu->gettestbasenode(), "x");
        ASSERT_TRUE(!!node);

        // Upload directories.
        ASSERT_TRUE(cu->uploadFolderTree(root / "d0", node.get()));
        ASSERT_TRUE(cu->uploadFolderTree(root / "d%30", node.get()));

        // Upload files.
        ASSERT_TRUE(cu->uploadFile(root / "f0", node.get()));
        ASSERT_TRUE(cu->uploadFile(root / "f%30", node.get()));
    }

    // Add and start sync.
    handle backupId1 = cd->setupSync_mainthread("sd", "x", false, false);

    // Wait for initial sync to complete.
    waitonsyncs(TIMEOUT, cd);

    // Populate and confirm local fs.
    Model model;

    model.addfolder("x/d0");
    model.addfolder("x/d%30")->fsName("d%2530");
    model.addfile("x/f0", "f0");
    model.addfile("x/f%30", "f%30")->fsName("f%2530");

    // Needed as we've downloaded files.
    model.ensureLocalDebrisTmpLock("x");

    ASSERT_TRUE(cd->confirmModel_mainthread(model.findnode("x"), backupId1));

    // Locally remove an escaped node.
    const auto syncRoot = cd->syncSet(backupId1).localpath;

    fs::remove_all(syncRoot / "d%2530");
    ASSERT_TRUE(!!model.removenode("x/d%30"));

    // Remotely remove an escaped file.
    ASSERT_TRUE(cd->deleteremote("x/f%30"));
    ASSERT_TRUE(model.movetosynctrash("x/f%30", "x"));

    // Wait for sync up to complete.
    waitonsyncs(TIMEOUT, cd);

    // Confirm models.
    ASSERT_TRUE(cd->confirmModel_mainthread(model.findnode("x"), backupId1));
}

// this test contains tests for % being escaped with %25 from cloud->local
TEST_F(SyncTest, RemotesWithEscapedEscapesSynchronizeCorrectly)
{
    const auto TESTROOT = makeNewTestRoot();
    const auto TIMEOUT = chrono::seconds(4);

    StandardClientInUse cu = g_clientManager->getCleanStandardClient(0, TESTROOT);
    StandardClientInUse cd = g_clientManager->getCleanStandardClient(0, TESTROOT);

    // Log callbacks.
    cd->logcb = true;
    cu->logcb = true;

    // Log in client.
    ASSERT_TRUE(cu->resetBaseFolderMulticlient(cd));
    ASSERT_TRUE(cu->makeCloudSubdirs("x", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cu));

    // Populate cloud.
    {
        // Build test hierarchy.
        const auto root = cu->fsBasePath / "x";

        // Escapes will not be decoded as we're uploading directly.
        fs::create_directories(root / "d0");
        fs::create_directories(root / "d%2530");

        ASSERT_TRUE(createNameFile(root, "f0"));
        ASSERT_TRUE(createNameFile(root, "f%2530"));

        auto node = cu->drillchildnodebyname(cu->gettestbasenode(), "x");
        ASSERT_TRUE(!!node);

        // Upload directories.
        ASSERT_TRUE(cu->uploadFolderTree(root / "d0", node.get()));
        ASSERT_TRUE(cu->uploadFolderTree(root / "d%2530", node.get()));

        // Upload files.
        ASSERT_TRUE(cu->uploadFile(root / "f0", node.get()));
        ASSERT_TRUE(cu->uploadFile(root / "f%2530", node.get()));
    }

    // Add and start sync.
    handle backupId1 = cd->setupSync_mainthread("sd", "x", false, false);

    // Wait for initial sync to complete.
    waitonsyncs(TIMEOUT, cd);

    // Populate and confirm local fs.
    Model model;

    model.addfolder("x/d0");
    model.addfolder("x/d%2530");
    model.addfile("x/f0", "f0");
    model.addfile("x/f%2530", "f%2530");

    // Needed as we've downloaded files.
    model.ensureLocalDebrisTmpLock("x");

    ASSERT_TRUE(cd->confirmModel_mainthread(model.findnode("x"), backupId1));

    // Locally remove an escaped node.
    const auto syncRoot = cd->syncSet(backupId1).localpath;

    fs::remove_all(syncRoot / "d%2530");
    ASSERT_TRUE(!!model.removenode("x/d%2530"));

    // Remotely remove an escaped file.
    ASSERT_TRUE(cd->deleteremote("x/f%2530"));
    ASSERT_TRUE(model.movetosynctrash("x/f%2530", "x"));

    // Wait for sync up to complete.
    waitonsyncs(TIMEOUT, cd);

    // Confirm models.
    ASSERT_TRUE(cd->confirmModel_mainthread(model.findnode("x"), backupId1));

    // Locally create some files with escapes in their names.
    {
        // Bogus escapes.
        ASSERT_TRUE(fs::create_directories(syncRoot / "dd%"));
        model.addfolder("x/dd%");

        ASSERT_TRUE(createNameFile(syncRoot, "ff%"));
        model.addfile("x/ff%", "ff%");

        // Sane character escapes.
        ASSERT_TRUE(fs::create_directories(syncRoot / "dd%31"));
        model.addfolder("x/dd1")->fsName("dd%31");

        ASSERT_TRUE(createNameFile(syncRoot, "ff%31"));
        model.addfile("x/ff1", "ff%31")->fsName("ff%31");

    }

    // Wait for synchronization to complete.
    waitonsyncs(TIMEOUT, cd);

    // Confirm model.
    ASSERT_TRUE(cd->confirmModel_mainthread(model.findnode("x"), backupId1));

    // Let's try with escaped control sequences.
    ASSERT_TRUE(fs::create_directories(syncRoot / "dd%250a"));
    model.addfolder("x/dd%0a")->fsName("dd%250a");

    ASSERT_TRUE(createNameFile(syncRoot, "ff%250a"));
    model.addfile("x/ff%0a", "ff%250a")->fsName("ff%250a");

    // Wait for sync and confirm model.
    waitonsyncs(TIMEOUT, cd);
    ASSERT_TRUE(cd->confirmModel_mainthread(model.findnode("x"), backupId1));

    // Remotely delete the nodes with control sequences.
    ASSERT_TRUE(cd->deleteremote("x/dd%0a"));
    model.movetosynctrash("x/dd%0a", "x");

    ASSERT_TRUE(cd->deleteremote("x/ff%0a"));
    model.movetosynctrash("x/ff%0a", "x");

    // Wait for sync and confirm model.
    waitonsyncs(TIMEOUT, cd);
    ASSERT_TRUE(cd->confirmModel_mainthread(model.findnode("x"), backupId1));
}

TEST_F(SyncTest, BasicSyncExportImport)
{
    auto TESTROOT = makeNewTestRoot();
    auto TIMEOUT  = chrono::seconds(4);

    // Sync client.
    unique_ptr<StandardClient> cx(new StandardClient(TESTROOT, "cx"));

    // Log callbacks.
    cx->logcb = true;

    // Log in client.
    ASSERT_TRUE(cx->login_reset_makeremotenodes("MEGA_EMAIL", "MEGA_PWD", "s", 1, 3));

    // Create and start syncs.
    auto id0 = cx->setupSync_mainthread("s0", "s/s_0", false, false);
    ASSERT_NE(id0, UNDEF);

    auto id1 = cx->setupSync_mainthread("s1", "s/s_1", false, false);
    ASSERT_NE(id1, UNDEF);

    auto id2 = cx->setupSync_mainthread("s2", "s/s_2", false, false);
    ASSERT_NE(id2, UNDEF);

    // Get our hands on the sync's local root.
    auto root0 = cx->syncSet(id0).localpath;
    auto root1 = cx->syncSet(id1).localpath;
    auto root2 = cx->syncSet(id2).localpath;

    // Give the syncs something to synchronize.
    Model model0;
    Model model1;
    Model model2;

    model0.addfile("d0/f0");
    model0.addfile("f0");
    model0.generate(root0);

    model1.addfile("d0/f0");
    model1.addfile("d0/f1");
    model1.addfile("d1/f0");
    model1.addfile("d1/f1");
    model1.generate(root1);

    model2.addfile("f0");
    model2.addfile("f1");
    model2.generate(root2);

    cx->triggerPeriodicScanEarly(id0);
    cx->triggerPeriodicScanEarly(id1);
    cx->triggerPeriodicScanEarly(id2);

    // Wait for synchronization to complete.
    waitonsyncs(TIMEOUT, cx.get());

    // Make sure everything was uploaded okay.
    ASSERT_TRUE(cx->confirmModel_mainthread(model0.root.get(), id0));
    ASSERT_TRUE(cx->confirmModel_mainthread(model1.root.get(), id1));
    ASSERT_TRUE(cx->confirmModel_mainthread(model2.root.get(), id2));

    // Export the syncs.
    auto configs = cx->exportSyncConfigs();
    ASSERT_FALSE(configs.empty());

    // Log out client, don't keep caches.
    cx.reset();

    // Recreate client.
    cx.reset(new StandardClient(TESTROOT, "cx"));

    // Log client back in.
    ASSERT_TRUE(cx->login_fetchnodes("MEGA_EMAIL", "MEGA_PWD"));

    // Import the syncs.
    ASSERT_TRUE(cx->importSyncConfigs(std::move(configs)));

    // Determine the imported sync's backup IDs.
    id0 = cx->backupIdForSyncPath(root0);
    ASSERT_NE(id0, UNDEF);

    id1 = cx->backupIdForSyncPath(root1);
    ASSERT_NE(id1, UNDEF);

    id2 = cx->backupIdForSyncPath(root2);
    ASSERT_NE(id2, UNDEF);

    // Make sure nothing's changed since we exported the syncs.
    ASSERT_TRUE(cx->confirmModel_mainthread(model0.root.get(), id0));
    ASSERT_TRUE(cx->confirmModel_mainthread(model1.root.get(), id1));
    ASSERT_TRUE(cx->confirmModel_mainthread(model2.root.get(), id2));

    // Make some changes.
    model0.addfile("d0/f1");
    model0.generate(root0);

    model1.addfile("f0");
    model1.generate(root1);

    model2.addfile("d0/d0f0");
    model2.generate(root2);

    // Imported syncs should be disabled.
    // So, we're waiting for the syncs to do precisely nothing.
    waitonsyncs(TIMEOUT, cx.get());

    // Confirm should fail.
    ASSERT_FALSE(cx->confirmModel_mainthread(model0.root.get(), id0, false, StandardClient::Confirm::CONFIRM_ALL, true));
    ASSERT_FALSE(cx->confirmModel_mainthread(model1.root.get(), id1, false, StandardClient::Confirm::CONFIRM_ALL, true));
    ASSERT_FALSE(cx->confirmModel_mainthread(model2.root.get(), id2, false, StandardClient::Confirm::CONFIRM_ALL, true));

    // Enable the imported syncs.
    ASSERT_TRUE(cx->enableSyncByBackupId(id0, "sync0 "));
    ASSERT_TRUE(cx->enableSyncByBackupId(id1, "sync1 "));
    ASSERT_TRUE(cx->enableSyncByBackupId(id2, "sync2 "));

    // Wait for sync to complete.
    waitonsyncs(TIMEOUT, cx.get());

    // Changes should now be in the cloud.
    ASSERT_TRUE(cx->confirmModel_mainthread(model0.root.get(), id0));
    ASSERT_TRUE(cx->confirmModel_mainthread(model1.root.get(), id1));
    ASSERT_TRUE(cx->confirmModel_mainthread(model2.root.get(), id2));
}

TEST_F(SyncTest, RenameReplaceFileBetweenSyncs)
{
    const auto TESTROOT = makeNewTestRoot();
    const auto TIMEOUT  = chrono::seconds(4);

    StandardClientInUse c0 = g_clientManager->getCleanStandardClient(0, TESTROOT);

    // Log callbacks.
    c0->logcb = true;

    // Log in client.
    ASSERT_TRUE(c0->resetBaseFolderMulticlient());
    ASSERT_TRUE(c0->makeCloudSubdirs("s0", 0, 0));
    ASSERT_TRUE(c0->makeCloudSubdirs("s1", 0, 0));
    ASSERT_TRUE(CatchupClients(c0));
    //ASSERT_TRUE(c0->login_reset_makeremotenodes("MEGA_EMAIL", "MEGA_PWD", "s0", 0, 0));

    // Set up syncs.
    const auto id0 = c0->setupSync_mainthread("s0", "s0", false, false);
    ASSERT_NE(id0, UNDEF);

    const auto id1 = c0->setupSync_mainthread("s1", "s1", false, false);
    ASSERT_NE(id1, UNDEF);

    // Convenience.
    const auto SYNCROOT0 = c0->fsBasePath / "s0";
    const auto SYNCROOT1 = c0->fsBasePath / "s1";

    // Set up models.
    Model model0;
    Model model1;

    model0.addfile("f0", "x");
    model0.generate(SYNCROOT0);

    c0->triggerPeriodicScanEarly(id0);

    // Wait for synchronization to complete.
    waitonsyncs(TIMEOUT, c0);

    // Confirm models.
    ASSERT_TRUE(c0->confirmModel_mainthread(model0.root.get(), id0));
    ASSERT_TRUE(c0->confirmModel_mainthread(model1.root.get(), id1));

    // Move s0/f0 to s1/f0.
    model1 = model0;

    fs::rename(SYNCROOT0 / "f0", SYNCROOT1 / "f0");

    // Replace s0/f0.
    model0.removenode("f0");
    model0.addfile("f0", "y");

    ASSERT_TRUE(createFile(SYNCROOT0 / "f0", "y"));

    c0->triggerPeriodicScanEarly(id0);
    c0->triggerPeriodicScanEarly(id1);

    // Wait for synchronization to complete.
    waitonsyncs(TIMEOUT, c0);

    // Confirm models.
    ASSERT_TRUE(c0->confirmModel_mainthread(model0.root.get(), id0));
    ASSERT_TRUE(c0->confirmModel_mainthread(model1.root.get(), id1));

    // Disable s0.
    ASSERT_TRUE(c0->disableSync(id0, NO_SYNC_ERROR, false, true));

    // Make sure s0 is disabled.
    ASSERT_TRUE(createFile(SYNCROOT0 / "f1", "z"));

    c0->triggerPeriodicScanEarly(id0);

    // Wait for synchronization to complete.
    waitonsyncs(TIMEOUT, c0);

    // Confirm models.
    ASSERT_TRUE(c0->confirmModel_mainthread(
                  model0.root.get(),
                  id0,
                  false,
                  StandardClient::CONFIRM_REMOTE));

    // Move s1/f0 to s0/f2.
    model1.removenode("f0");

    fs::rename(SYNCROOT1 / "f0", SYNCROOT0 / "f2");

    // Replace s1/f0.
    model1.addfile("f0", "q");

    ASSERT_TRUE(createFile(SYNCROOT1 / "f0", "q"));

    c0->triggerPeriodicScanEarly(id0);
    c0->triggerPeriodicScanEarly(id1);

    // Wait for synchronization to complete.
    waitonsyncs(TIMEOUT, c0);

    // Confirm models.
    ASSERT_TRUE(c0->confirmModel_mainthread(
                  model0.root.get(),
                  id0,
                  false,
                  StandardClient::CONFIRM_REMOTE));

    ASSERT_TRUE(c0->confirmModel_mainthread(model1.root.get(), id1));
}

TEST_F(SyncTest, RenameReplaceFileWithinSync)
{
    auto TESTROOT = makeNewTestRoot();
    auto TIMEOUT = std::chrono::seconds(8);

    StandardClientInUse c = g_clientManager->getCleanStandardClient(0, TESTROOT);

    // Log callbacks.
    c->logcb = true;

    // Log in client.
    ASSERT_TRUE(c->resetBaseFolderMulticlient());
    ASSERT_TRUE(c->makeCloudSubdirs("s", 0, 0));
    ASSERT_TRUE(CatchupClients(c));

    // Populate model.
    Model m;

    // Will be rename-replaced to /ft.
    m.addfile("fs");

    // Will be rename-replaced down to /dd/dt/ft.
    m.addfile("dd/fs");
    m.addfolder("dd/dt");

    // Will be rename-replaced up to /du/ft.
    m.addfile("du/ds/fs");

    // Populate local filesystem.
    m.generate(c->fsBasePath / "s");

    // Add and start sync.
    auto id = c->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    // Wait for the initial sync to complete.
    waitonsyncs(TIMEOUT, c);

    // Make sure the initial sync was successful.
    ASSERT_TRUE(c->confirmModel_mainthread(m.root.get(), id));

    // Rename/replace across siblings.
    //
    // Models this case:
    //   echo fs > fs
    //   <synchronize>
    //   mv fs ft && echo x > fs
    //   <synchronize>
    {
        // Locally move fs to ft.
        fs::rename(c->fsBasePath / "s" / "fs",
                   c->fsBasePath / "s" / "ft");

        m.findnode("fs")->name = "ft";

        // Replace fs.
        ASSERT_TRUE(createFile(c->fsBasePath / "s" / "fs", "x"));

        m.addfile("fs", "x");

        // For periodic scanning.
        c->triggerPeriodicScanEarly(id);

        // Wait for the change to be synchronized.
        waitonsyncs(TIMEOUT, c);

        // Was the change correctly synchronized?
        ASSERT_TRUE(c->confirmModel_mainthread(m.root.get(), id));
    }

    // Rename/replace down the hierarchy.
    //
    // Models this case:
    //   mkdir -p dd/dt
    //   echo dd/fs > dd/fs
    //   <synchronize>
    //   mv dd/fs dd/dt/ft && echo x > dd/fs
    //   <synchronize>
    {
        // Move /dd/fs to /dd/dt/ft.
        fs::rename(c->fsBasePath / "s" / "dd" / "fs",
                   c->fsBasePath / "s" / "dd" / "dt" / "ft");

        m.movenode("dd/fs", "dd/dt");
        m.findnode("dd/dt/fs")->name = "ft";

        // Replace /dd/fs.
        ASSERT_TRUE(createFile(c->fsBasePath / "s" / "dd" / "fs", "x"));

        m.addfile("dd/fs", "x");

        // For periodic scanning.
        c->triggerPeriodicScanEarly(id);

        // Wait for the change to be synchronized.
        waitonsyncs(TIMEOUT, c);

        // Was the change correctly synchronized?
        ASSERT_TRUE(c->confirmModel_mainthread(m.root.get(), id));
    }

    // Rename/replace up the hierarchy.
    //
    // Models this case:
    //   mkdir -p du/ds
    //   echo du/ds/fs > du/ds/fs
    //   <synchronize>
    //   mv du/ds/fs du/fs && echo x > du/ds/fs
    //   <synchronize>
    {
        // Move du/ds/fs to du/ft.
        fs::rename(c->fsBasePath / "s" / "du" / "ds" / "fs",
                   c->fsBasePath / "s" / "du" / "ft");

        m.movenode("du/ds/fs", "du");
        m.findnode("du/fs")->name = "ft";

        // Replace du/ds/fs.
        ASSERT_TRUE(createFile(c->fsBasePath / "s" / "du" / "ds" / "fs", "x"));

        m.addfile("du/ds/fs", "x");

        // For periodic scanning.
        c->triggerPeriodicScanEarly(id);

        // Wait for the change to be synchronized.
        waitonsyncs(TIMEOUT, c);

        // Was the change correctly synchronized?
        ASSERT_TRUE(c->confirmModel_mainthread(m.root.get(), id));
    }
}

// TODO: re-enable after sync rework is merged
TEST_F(SyncTest, RenameReplaceFolderBetweenSyncs)
{
    const auto TESTROOT = makeNewTestRoot();
    const auto TIMEOUT  = chrono::seconds(4);

    StandardClientInUse c0 = g_clientManager->getCleanStandardClient(0, TESTROOT);

    // Log callbacks.
    c0->logcb = true;

    // Log in client.
    ASSERT_TRUE(c0->resetBaseFolderMulticlient());
    ASSERT_TRUE(c0->makeCloudSubdirs("s0", 0, 0));
    ASSERT_TRUE(c0->makeCloudSubdirs("s1", 0, 0));
    ASSERT_TRUE(CatchupClients(c0));

    // Set up syncs.
    const auto id0 = c0->setupSync_mainthread("s0", "s0", false, false);
    ASSERT_NE(id0, UNDEF);

    const auto id1 = c0->setupSync_mainthread("s1", "s1", false, false);
    ASSERT_NE(id1, UNDEF);

    // Convenience.
    const auto SYNCROOT0 = c0->fsBasePath / "s0";
    const auto SYNCROOT1 = c0->fsBasePath / "s1";

    // Set up models.
    Model model0;
    Model model1;

    model0.addfile("d0/f0");
    model0.generate(SYNCROOT0);

    c0->triggerPeriodicScanEarly(id0);

    // Wait for synchronization to complete.
    waitonsyncs(TIMEOUT, c0);

    // Confirm models.
    ASSERT_TRUE(c0->confirmModel_mainthread(model0.root.get(), id0));
    ASSERT_TRUE(c0->confirmModel_mainthread(model1.root.get(), id1));

    // Move s0/d0 to s1/d0. (and replace)
    model1 = model0;

    fs::rename(SYNCROOT0 / "d0", SYNCROOT1 / "d0");

    // Replace s0/d0.
    model0.removenode("d0/f0");

    fs::create_directories(SYNCROOT0 / "d0");

    c0->triggerPeriodicScanEarly(id0);
    c0->triggerPeriodicScanEarly(id1);

    // Wait for synchronization to complete.
    waitonsyncs(TIMEOUT, c0);

    // Confirm models.
    ASSERT_TRUE(c0->confirmModel_mainthread(model0.root.get(), id0));
    ASSERT_TRUE(c0->confirmModel_mainthread(model1.root.get(), id1));

    // Disable s0.
    ASSERT_TRUE(c0->disableSync(id0, NO_SYNC_ERROR, false, true));

    // Make sure s0 is disabled.
    fs::create_directories(SYNCROOT0 / "d1");

    // Wait for synchronization to complete.
    waitonsyncs(TIMEOUT, c0);

    // Confirm models.
    ASSERT_TRUE(c0->confirmModel_mainthread(
                  model0.root.get(),
                  id0,
                  false,
                  StandardClient::CONFIRM_REMOTE));

    // Move s1/d0 to s0/d2.
    model1.removenode("d0/f0");

    fs::rename(SYNCROOT1 / "d0", SYNCROOT0 / "d2");

    // Replace s1/d0.
    fs::create_directories(SYNCROOT1 / "d0");

    c0->triggerPeriodicScanEarly(id0);
    c0->triggerPeriodicScanEarly(id1);

    // Wait for synchronization to complete.
    waitonsyncs(TIMEOUT, c0);

    // Confirm models.
    ASSERT_TRUE(c0->confirmModel_mainthread(
                  model0.root.get(),
                  id0,
                  false,
                  StandardClient::CONFIRM_REMOTE));

    ASSERT_TRUE(c0->confirmModel_mainthread(model1.root.get(), id1));
}

TEST_F(SyncTest, RenameReplaceFolderWithinSync)
{
    const auto TESTROOT = makeNewTestRoot();
    const auto TIMEOUT  = chrono::seconds(4);

    StandardClientInUse c0 = g_clientManager->getCleanStandardClient(0, TESTROOT);

    // Log callbacks.
    c0->logcb = true;

    // Log in client.
    ASSERT_TRUE(c0->resetBaseFolderMulticlient());
    ASSERT_TRUE(c0->makeCloudSubdirs("s0", 0, 0));
    ASSERT_TRUE(CatchupClients(c0));

    // Set up sync.
    const auto id = c0->setupSync_mainthread("s0", "s0", false, false);
    ASSERT_NE(id, UNDEF);

    // Populate local FS.
    const auto SYNCROOT = c0->fsBasePath / "s0";

    Model model;

    model.addfile("d1/f0");
    model.generate(SYNCROOT);

    c0->triggerPeriodicScanEarly(id);

    // Wait for synchronization to complete.
    waitonsyncs(DEFAULTWAIT, c0);

    // Confirm model.
    ASSERT_TRUE(c0->confirmModel_mainthread(model.root.get(), id));

    // Rename /d1 to /d2.
    // This tests the case where the target is processed after the source.
    model.addfolder("d2");
    model.movenode("d1/f0", "d2");

    fs::rename(SYNCROOT / "d1", SYNCROOT / "d2");

    // Replace /d1.
    fs::create_directories(SYNCROOT / "d1");

    c0->triggerPeriodicScanEarly(id);

    // Wait for synchronization to complete.
    waitonsyncs(TIMEOUT, c0);

    // Confirm model.
    ASSERT_TRUE(c0->confirmModel_mainthread(model.root.get(), id));

    // Rename /d2 to /d0.
    // This tests the case where the target is processed before the source.
    model.addfolder("d0");
    model.movenode("d2/f0", "d0");

    fs::rename(SYNCROOT / "d2", SYNCROOT / "d0");

    // Replace /d2.
    fs::create_directories(SYNCROOT / "d2");

    c0->triggerPeriodicScanEarly(id);

    // Wait for synchronization to complete.
    waitonsyncs(TIMEOUT, c0);

    // Confirm model.
    ASSERT_TRUE(c0->confirmModel_mainthread(model.root.get(), id));
}

TEST_F(SyncTest, SyncIncompatibleMoveStallsAndResolutions)
{
    const auto TESTROOT = makeNewTestRoot();
    const auto TIMEOUT  = chrono::seconds(4);

    StandardClientInUse c = g_clientManager->getCleanStandardClient(0, TESTROOT);

    // Log callbacks.
    c->logcb = true;

    // Log in client.
    ASSERT_TRUE(c->resetBaseFolderMulticlient());
    ASSERT_TRUE(c->makeCloudSubdirs("x", 1, 3));
    ASSERT_TRUE(CatchupClients(c));

    // Add and start syncs.
    auto id0 = c->setupSync_mainthread("s0", "x/x_0", false, false);
    ASSERT_NE(id0, UNDEF);
    auto SYNC0 = c->syncSet(id0);

    auto id1 = c->setupSync_mainthread("s1", "x/x_1", false, false);
    ASSERT_NE(id1, UNDEF);
    auto SYNC1 = c->syncSet(id1);

    auto id2 = c->setupSync_mainthread("s2", "x/x_2", false, false);
    ASSERT_NE(id2, UNDEF);
    auto SYNC2 = c->syncSet(id2);

    // Create and populate models.
    Model model0;
    model0.root->addkid(model0.buildModelSubdirs("d", 8, 2, 0));
    model0.generate(SYNC0.localpath, true);

    Model model1;
    model1.root->addkid(model1.buildModelSubdirs("d", 1, 1, 2));
    model1.generate(SYNC1.localpath, true);

    Model model2;
    model2.root->addkid(model2.buildModelSubdirs("d", 1, 1, 2));
    model2.generate(SYNC2.localpath, true);

    c->triggerPeriodicScanEarly(id0);
    c->triggerPeriodicScanEarly(id1);
    c->triggerPeriodicScanEarly(id2);

    // Wait for the engine to process changes.
    auto waitResult = waitonsyncs(TIMEOUT, c);

    // Wait for the engine to signal a stall.
    ASSERT_TRUE(noSyncStalled(waitResult));

    c->setSyncPausedByBackupId(id0, true);
    c->setSyncPausedByBackupId(id1, true);
    c->setSyncPausedByBackupId(id2, true);

    std::ofstream remoteFile("remoteFile");
    remoteFile << "remoteFile";
    remoteFile.close();

    // case 0: make some crossed-over moves
    fs::rename(SYNC0.localpath / "d" / "d_0",
               SYNC0.localpath / "d" / "d_1" / "d_0");
    c->movenode("x/x_0/d/d_1", "x/x_0/d/d_0");


    // case 1: update the local and remote file differently while paused (to resolve remotely)
    std::ofstream fstream1(SYNC1.localpath / "d" / "file0_d", ios_base::app);
    fstream1 << " plus local change";
    fstream1.close();
    ASSERT_TRUE(c->uploadFile("remoteFile", "file0_d", "x/x_1/d", 30, ClaimOldVersion));

    // case 2: update the local and remote file differently while paused (to resolve locally)
    std::ofstream fstream2(SYNC2.localpath / "d" / "file0_d", ios_base::app);
    fstream2 << " plus local change";
    fstream2.close();
    ASSERT_TRUE(c->uploadFile("remoteFile", "file0_d", "x/x_2/d", 30, ClaimOldVersion));

    c->setSyncPausedByBackupId(id0, false);
    c->setSyncPausedByBackupId(id1, false);
    c->setSyncPausedByBackupId(id2, false);

    c->triggerPeriodicScanEarly(id0);
    c->triggerPeriodicScanEarly(id1);
    c->triggerPeriodicScanEarly(id2);

    // Be absolutely sure we've stalled. (stall is across all syncs - todo: figure out if each one contains a stall)
    ASSERT_TRUE(c->waitFor(SyncStallState(true), DEFAULTWAIT));

    // resolve case 0: Make it possible for the sync to resolve the stall.
    fs::rename(
        SYNC0.localpath / "d" / "d_1" / "d_0",
        SYNC0.localpath / "d" / "d_0");
    model0.movenode("d/d_1", "d/d_0");

    // resolve case 1: remove remote, local should replace it
    LOG_info << "test removes x/x_1/d/file0_d to resolve stall in sync1";
    c->deleteremote("x/x_1/d/file0_d");
    model1.findnode("d/file0_d")->content = "file0_d plus local change";

    // resolve case 2: remove local, remote should replace it
    fs::remove(SYNC2.localpath / "d" / "file0_d");
    model2.findnode("d/file0_d")->content = "remoteFile";
    model2.ensureLocalDebrisTmpLock(""); // due to download temp location

    c->triggerPeriodicScanEarly(id0);
    c->triggerPeriodicScanEarly(id2);

    LOG_debug << "Wait for the sync to exit the stall state.";
    ASSERT_TRUE(c->waitFor(SyncStallState(false), chrono::seconds(40)));

    LOG_debug << "Make sure the sync's completed its processing.";
    waitResult = waitonsyncs(chrono::seconds(5), c);
    ASSERT_TRUE(noSyncStalled(waitResult));

    LOG_debug << "now the sync should have unstalled and resolved the stalled cases";

    // Confirm state
    ASSERT_TRUE(c->confirmModel_mainthread(model0.root.get(), id0));
    ASSERT_TRUE(c->confirmModel_mainthread(model1.root.get(), id1));
    ASSERT_TRUE(c->confirmModel_mainthread(model2.root.get(), id2));
}


TEST_F(SyncTest, DownloadedDirectoriesHaveFilesystemWatch)
{
    const auto TESTROOT = makeNewTestRoot();
    const auto TIMEOUT  = chrono::seconds(4);

    StandardClientInUse c = g_clientManager->getCleanStandardClient(0, TESTROOT);

    // Log callbacks.
    c->logcb = true;

    // Log in client.
    ASSERT_TRUE(c->resetBaseFolderMulticlient());
    ASSERT_TRUE(c->makeCloudSubdirs("s", 0, 0));
    ASSERT_TRUE(CatchupClients(c));

    // Create /d in the cloud.
    {
        vector<NewNode> nodes(1);

        // Initialize new node.
        c->prepareOneFolder(&nodes[0], "d", false);

        // Get our hands on the sync root.
        auto root = c->drillchildnodebyname(c->gettestbasenode(), "s");
        ASSERT_TRUE(root);

        // Create new node in the cloud.
        ASSERT_TRUE(c->putnodes(root->nodeHandle(), NoVersioning, std::move(nodes)));
    }

    // Add and start sync.
    const auto id = c->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    const auto SYNCROOT = c->syncSet(id).localpath;

    // Wait for synchronization to complete.
    waitonsyncs(TIMEOUT, c);

    // Confirm /d has made it to disk.
    Model model;

    model.addfolder("d");

    ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));

    // Trigger a filesystem notification.
    model.addfile("d/f", "x");

    ASSERT_TRUE(createFile(SYNCROOT / "d" / "f", "x"));

    c->triggerPeriodicScanEarly(id);

    // Wait for synchronization to complete.
    waitonsyncs(TIMEOUT, c);

    // Confirm /d/f made it to the cloud.
    ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));
}

TEST_F(SyncTest, FilesystemWatchesPresentAfterResume)
{
    const auto TESTROOT = makeNewTestRoot();
    const auto TIMEOUT  = chrono::seconds(4);

    auto c = std::make_unique<StandardClient>(TESTROOT, "c");

    // Log callbacks.
    c->logcb = true;

    // Log in client.
    ASSERT_TRUE(c->login_reset_makeremotenodes("MEGA_EMAIL", "MEGA_PWD", "s", 0, 0));

    // Add and start sync.
    const auto id = c->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    const auto SYNCROOT = c->syncSet(id).localpath;

    // Build model and populate filesystem.
    Model model;

    model.addfolder("d0/d0d0");
    model.generate(SYNCROOT);

    c->triggerPeriodicScanEarly(id);

    // Wait for initial sync to complete.
    waitonsyncs(TIMEOUT, c.get());

    // Make sure directories made it to the cloud.
    ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));

    // Logout / Resume.
    {
        string session;

        // Save session.
        c->client.dumpsession(session);

        // Logout (taking care to preserve the caches.)
        c->localLogout();

        // Recreate client.
        c.reset(new StandardClient(TESTROOT, "c"));

        // Hook onAutoResumeResult callback.
        promise<void> notify;

        c->onAutoResumeResult = [&](const SyncConfig&) {
            notify.set_value();
        };

        // Resume session.
        ASSERT_TRUE(c->login_fetchnodesFromSession(session));

        // Wait for the sync to be resumed.
        ASSERT_TRUE(debugTolerantWaitOnFuture(notify.get_future(), 45));

        c->triggerPeriodicScanEarly(id);

        // Wait for sync to complete.
        waitonsyncs(TIMEOUT, c.get());

        // Make sure everything's as we left it.
        ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));
    }

    c->received_node_actionpackets = false;

    // Trigger some filesystem notifications.
    {
        model.addfile("f", "f");
        ASSERT_TRUE(createFile(SYNCROOT / "f", "f"));

        model.addfile("d0/d0f", "d0f");
        ASSERT_TRUE(createFile(SYNCROOT / "d0" / "d0f", "d0f"));

        model.addfile("d0/d0d0/d0d0f", "d0d0f");
        ASSERT_TRUE(createFile(SYNCROOT / "d0" / "d0d0" / "d0d0f", "d0d0f"));
    }

    ASSERT_TRUE(c->waitForNodesUpdated(30)) << " no actionpacket received";

    c->triggerPeriodicScanEarly(id);

    // Wait for synchronization to complete.
    waitonsyncs(TIMEOUT, c.get());

    // Did the new files make it to the cloud?
    ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));
}

TEST_F(SyncTest, MoveTargetHasFilesystemWatch)
{
    const auto TESTROOT = makeNewTestRoot();
    const auto TIMEOUT  = chrono::seconds(4);

    auto c = g_clientManager->getCleanStandardClient(0, TESTROOT);

    // Log callbacks.
    c->logcb = true;

    // Log in client.
    ASSERT_TRUE(c->resetBaseFolderMulticlient());
    ASSERT_TRUE(c->makeCloudSubdirs("s", 0, 0));
    ASSERT_TRUE(CatchupClients(c));

    // Set up sync.
    const auto id = c->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    const auto SYNCROOT = c->syncSet(id).localpath;

    // Build model and populate filesystem.
    Model model;

    model.addfile(".megaignore", "+sync:.megaignore");
    model.addfolder("d0/dq");
    model.addfolder("d1");
    model.addfolder("d2/dx");
    model.generate(SYNCROOT);

    c->triggerPeriodicScanEarly(id);

    // Wait for initial sync to complete.
    waitonsyncs(TIMEOUT, c);

    // Wait for everything to reach the cloud.
    {
        auto root = c->gettestbasenode();
        ASSERT_NE(root, nullptr);

        root = c->drillchildnodebyname(root, "s");
        ASSERT_NE(root, nullptr);

        auto predicate = SyncRemoteMatch(root.get(), model.root.get());
        ASSERT_TRUE(c->waitFor(std::move(predicate), DEFAULTWAIT));
    }

    // Confirm directories have hit the cloud.
    ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));

    // Local move.
    {
        // d0/dq -> d1/dq (ascending.)
        model.movenode("d0/dq", "d1");

        fs::rename(SYNCROOT / "d0" / "dq",
                   SYNCROOT / "d1" / "dq");

        // d2/dx -> d1/dx (descending.)
        model.movenode("d2/dx", "d1");

        fs::rename(SYNCROOT / "d2" / "dx",
                   SYNCROOT / "d1" / "dx");
    }

    c->triggerPeriodicScanEarly(id);

    // Wait for sync to complete.
    waitonsyncs(TIMEOUT, c);

    // Make sure movement has propagated to the cloud.
    ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));

    // Trigger some filesystem notifications.
    model.addfile("d1/dq/fq", "q");
    model.addfile("d1/dx/fx", "x");

    ASSERT_TRUE(createFile(SYNCROOT / "d1" / "dq" / "fq", "q"));
    ASSERT_TRUE(createFile(SYNCROOT / "d1" / "dx" / "fx", "x"));

    c->triggerPeriodicScanEarly(id);

    // Wait for sync to complete.
    waitonsyncs(TIMEOUT, c);

    // Have the files made it up to the cloud?
    ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));

    // So we can detect whether we've received packets for the below.
    c->received_node_actionpackets = false;

    // Remotely move.
    {
        StandardClient cr(TESTROOT, "cr");

        // Log in client.
        ASSERT_TRUE(cr.login_fetchnodes("MEGA_EMAIL", "MEGA_PWD"));

        // d1/dq -> d2/dq (ascending.)
        model.movenode("d1/dq", "d2");

        ASSERT_TRUE(cr.movenode("s/d1/dq", "s/d2"));

        // d1/dx -> d0/dx (descending.)
        model.movenode("d1/dx", "d0");

        ASSERT_TRUE(cr.movenode("s/d1/dx", "s/d0"));
    }

    // Wait for the client to receive action packets for the above change.
    ASSERT_TRUE(c->waitForNodesUpdated(30));

    // Wait for sync to complete.
    waitonsyncs(TIMEOUT, c);

    // Make sure movements occured on disk.
    ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));

    // Trigger some filesystem notifications.
    model.removenode("d2/dq/fq");
    model.removenode("d0/dx/fx");

    fs::remove(SYNCROOT / "d2" / "dq" / "fq");
    fs::remove(SYNCROOT / "d0" / "dx" / "fx");

    c->triggerPeriodicScanEarly(id);

    // Wait for sync to complete.
    waitonsyncs(TIMEOUT, c);

    // Make sure removes propagated to the cloud.
    ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));
}

// TODO: re-enable after sync rework is merged
TEST_F(SyncTest, DeleteReplaceReplacementHasFilesystemWatch)
{
    const auto TESTROOT = makeNewTestRoot();
    const auto TIMEOUT  = chrono::seconds(4);

    StandardClientInUse c = g_clientManager->getCleanStandardClient(0, TESTROOT);

    // Log callbacks.
    c->logcb = true;

    // Log in client.
    ASSERT_TRUE(c->resetBaseFolderMulticlient());
    ASSERT_TRUE(c->makeCloudSubdirs("s", 0, 0));
    ASSERT_TRUE(CatchupClients(c));

    // Add and start sync.
    const auto id = c->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    const auto ROOT = c->syncSet(id).localpath;

    // Populate filesystem.
    Model model;

    model.addfolder("dx/f");
    model.generate(ROOT);

    c->triggerPeriodicScanEarly(id);

    // Wait for sync to complete.
    waitonsyncs(TIMEOUT, c);

    // Make sure the directory's been uploaded to the cloud.
    ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));

    // Remove/replace the directory.
    fs::remove_all(ROOT / "dx");
    fs::create_directory(ROOT / "dx");

    c->triggerPeriodicScanEarly(id);

    // Wait for all notifications to be processed.
    waitonsyncs(TIMEOUT, c);

    // Make sure the new directory is in the cloud.
    model.removenode("dx/f");

    ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));

    // Add a file in the new directory so we trigger a notification.
    out() << "creating file dx/g";
    model.addfile("dx/g", "g");

    ASSERT_TRUE(createFile(ROOT / "dx" / "g", "g"));

    c->triggerPeriodicScanEarly(id);

    // Wait for notifications to be processed.
    waitonsyncs(TIMEOUT, c);

    // Check if g has been uploaded.
    // If it hasn't, we probably didn't receive a notification from the filesystem.
    ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));
}

TEST_F(SyncTest, RenameReplaceSourceAndTargetHaveFilesystemWatch)
{
    const auto TESTROOT = makeNewTestRoot();
    const auto TIMEOUT = chrono::seconds(8);

    auto c = g_clientManager->getCleanStandardClient(0, TESTROOT);

    // Log callbacks.
    c->logcb = true;

    // Log in client.
    ASSERT_TRUE(c->resetBaseFolderMulticlient());
    ASSERT_TRUE(c->makeCloudSubdirs("s", 0, 0));
    ASSERT_TRUE(CatchupClients(c));

    // Add and start sync.
    const auto id = c->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    const auto SYNCROOT = c->syncSet(id).localpath;

    // Build model and populate filesystem.
    Model model;

    model.addfolder("dq");
    model.addfolder("dz");
    model.generate(SYNCROOT);

    c->triggerPeriodicScanEarly(id);

    // Wait for initial sync to complete.
    waitonsyncs(TIMEOUT, c);

    // Make sure directories have made it to the cloud.
    ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));

    // Rename /dq -> /dr (ascending), replace /dq.
    model.addfolder("dr");

    fs::rename(SYNCROOT / "dq", SYNCROOT / "dr");
    fs::create_directories(SYNCROOT / "dq");

    // Rename /dz -> /dy (descending), replace /dz.
    model.addfolder("dy");

    fs::rename(SYNCROOT / "dz", SYNCROOT / "dy");
    fs::create_directories(SYNCROOT / "dz");

    c->triggerPeriodicScanEarly(id);

    // Wait for sync to complete.
    waitonsyncs(TIMEOUT, c);

    // Make sure moves made it to the cloud.
    ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));

    // Make sure rename targets still receive notifications.
    model.addfile("dr/fr", "r");
    model.addfile("dy/fy", "y");

    ASSERT_TRUE(createFile(SYNCROOT / "dr" / "fr", "r"));
    ASSERT_TRUE(createFile(SYNCROOT / "dy" / "fy", "y"));

    c->triggerPeriodicScanEarly(id);

    // Wait for sync to complete.
    waitonsyncs(TIMEOUT, c);

    // Did the files make it to the cloud?
    ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));

    // Make sure (now replaced) rename sources still receive notifications.
    model.addfile("dq/fq", "q");
    model.addfile("dz/fz", "z");

    LOG_debug << " --- Creating files fq and fz now ----";

    ASSERT_TRUE(createFile(SYNCROOT / "dq" / "fq", "q"));
    ASSERT_TRUE(createFile(SYNCROOT / "dz" / "fz", "z"));

    c->triggerPeriodicScanEarly(id);

    // Wait for sync to complete.
    waitonsyncs(TIMEOUT, c);

    // Did the files make it to the cloud?
    ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));
}

TEST_F(SyncTest, RenameTargetHasFilesystemWatch)
{
    const auto TESTROOT = makeNewTestRoot();
    const auto TIMEOUT = chrono::seconds(4);

    StandardClientInUse c = g_clientManager->getCleanStandardClient(0, TESTROOT);

    // Log callbacks.
    c->logcb = true;

    // Log in client.
    ASSERT_TRUE(c->resetBaseFolderMulticlient());
    ASSERT_TRUE(c->makeCloudSubdirs("s", 0, 0));
    ASSERT_TRUE(CatchupClients(c));

    // Add and start sync.
    const auto id = c->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    const auto SYNCROOT = c->syncSet(id).localpath;

    // Build model and populate filesystem.
    Model model;

    model.addfolder("dq");
    model.addfolder("dz");
    model.generate(SYNCROOT);

    c->triggerPeriodicScanEarly(id);

    // Wait for synchronization to complete.
    waitonsyncs(TIMEOUT, c);

    // Confirm model.
    ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));

    // Locally rename.
    {
        // - dq -> dr (ascending)
        model.removenode("dq");
        model.addfolder("dr");

        fs::rename(SYNCROOT / "dq", SYNCROOT / "dr");

        // - dz -> dy (descending)
        model.removenode("dz");
        model.addfolder("dy");

        fs::rename(SYNCROOT / "dz", SYNCROOT / "dy");
    }

    c->triggerPeriodicScanEarly(id);

    // Wait for synchronization to complete.
    waitonsyncs(TIMEOUT, c);

    // Make sure rename has hit the cloud.
    ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));

    // Make sure rename targets receive notifications.
    model.addfile("dr/f", "x");
    model.addfile("dy/f", "y");

    ASSERT_TRUE(createFile(SYNCROOT / "dr" / "f", "x"));
    ASSERT_TRUE(createFile(SYNCROOT / "dy" / "f", "y"));

    c->triggerPeriodicScanEarly(id);

    // Wait for synchronization to complete.
    waitonsyncs(TIMEOUT, c);

    // Check file has made it to the cloud.
    ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));

    // Remotely rename.
    {
        StandardClientInUse cr = g_clientManager->getCleanStandardClient(0, TESTROOT);

        auto root = cr->gettestbasenode();
        ASSERT_TRUE(root);

        // dr -> ds (ascending.)
        model.removenode("dr");
        model.addfile("ds/f", "x");

        auto dr = cr->drillchildnodebyname(root, "s/dr");
        ASSERT_TRUE(dr);

        ASSERT_TRUE(cr->setattr(dr.get(), attr_map('n', "ds")));

        // dy -> dx (descending.)
        model.removenode("dy");
        model.addfile("dx/f", "y");

        auto dy = cr->drillchildnodebyname(root, "s/dy");
        ASSERT_TRUE(dy);

        ASSERT_TRUE(cr->setattr(dy.get(), attr_map('n', "dx")));
    }

    // it can take a while for APs to arrive (or to be sent)
    WaitMillisec(4000);

    // Wait for synchronization to complete.
    waitonsyncs(TIMEOUT, c);

    // Confirm move has occured locally.
    ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));

    c->received_node_actionpackets = false;

    // Check that /ds and /dx receive notifications.
    model.removenode("ds/f");
    model.removenode("dx/f");
    fs::remove(SYNCROOT / "ds" / "f");
    fs::remove(SYNCROOT / "dx" / "f");

    c->triggerPeriodicScanEarly(id);

    ASSERT_TRUE(c->waitForNodesUpdated(30)) << " no actionpacket received in c";

    // Wait for synchronization to complete.
    waitonsyncs(TIMEOUT, c);

    // Confirm remove has hit the cloud.
    ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));
}

TEST_F(SyncTest, ReplaceParentWithEmptyChild)
{
    const auto TESTROOT = makeNewTestRoot();
    const auto TIMEOUT = chrono::seconds(4);

    handle id;
    Model model;
    string session;

    StandardClient c(TESTROOT, "c");

    // Log callbacks.
    c.logcb = true;

    // Log in client.
    ASSERT_TRUE(c.login_reset_makeremotenodes("MEGA_EMAIL", "MEGA_PWD", "s", 0, 0));

    // Populate initial filesystem.
    {
        // Add and start sync.
        id = c.setupSync_mainthread("s", "s", false, false);
        ASSERT_NE(id, UNDEF);

        // Build model and populate filesystem.
        model.addfolder("0/1/2/3");
        model.addfolder("4/5/6/7");
        model.generate(c.syncSet(id).localpath);

        c.triggerPeriodicScanEarly(id);

        // Wait for the sync to complete.
        waitonsyncs(TIMEOUT, &c);

        // Make sure the tree made it to the cloud.
        ASSERT_TRUE(c.confirmModel_mainthread(model.root.get(), id));

        // Temporarily disable the sync.
        //
        // The rationale for this is that we want to make sure that
        // the cloud changes below are visible to this client before
        // it starts trying synchronize stuff.
        ASSERT_TRUE(c.disableSync(id, NO_SYNC_ERROR, true, true));
    }

    // Remotely replace 4 with 4/5/6/7.
    {
        model.movetosynctrash("4", "");
        model.addfolder("4");

        // New client so we can alter the cloud without resuming syncs.
        StandardClient cr(TESTROOT, "cr");

        // Log callbacks.
        cr.logcb = true;

        // Log in client.
        ASSERT_TRUE(cr.login_fetchnodes("MEGA_EMAIL", "MEGA_PWD"));

        // Replace 4 with 4/5/6/7.
        ASSERT_TRUE(cr.movenode("s/4/5/6/7", "s"));
        ASSERT_TRUE(cr.deleteremote("s/4"));
        ASSERT_TRUE(cr.rename("s/7", "4"));

        // Wait for our primary client to see cr's changes.
        ASSERT_TRUE(c.waitFor(SyncRemoteMatch("s", model.root.get()), TIMEOUT));
    }

    // Locally replace 0 with 0/1/2/3.
    {
        model.removenode("0");
        model.addfolder("0");

        fs::rename(c.fsBasePath / "s" / "0" / "1" / "2" / "3",
                   c.fsBasePath / "s" / "3");

        fs::remove_all(c.fsBasePath / "s" / "0");

        fs::rename(c.fsBasePath / "s" / "3",
                   c.fsBasePath / "s" / "0");
    }

    // Resume our sync.
    ASSERT_TRUE(c.enableSyncByBackupId(id, "c"));

    // Wait for the sync to complete.
    waitonsyncs(TIMEOUT, &c);

    // Is the cloud as we expect?
    ASSERT_TRUE(c.confirmModel_mainthread(model.root.get(), id));
}

TEST_F(SyncTest, RootHasFilesystemWatch)
{
    const auto TESTROOT = makeNewTestRoot();
    const auto TIMEOUT  = chrono::seconds(4);

    StandardClientInUse c = g_clientManager->getCleanStandardClient(0, TESTROOT);

    // Log callbacks.
    c->logcb = true;

    // Log in client.
    ASSERT_TRUE(c->resetBaseFolderMulticlient());
    ASSERT_TRUE(c->makeCloudSubdirs("s", 0, 0));
    ASSERT_TRUE(CatchupClients(c));

    // Set up sync
    const auto id = c->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    // Wait for sync to complete.
    waitonsyncs(TIMEOUT, c);

    // Trigger some filesystem notifications.
    Model model;

    model.addfolder("d0");
    model.addfile("f0");
    model.generate(c->syncSet(id).localpath);

    c->triggerPeriodicScanEarly(id);

    // Wait for sync to complete.
    waitonsyncs(TIMEOUT, c);

    // Confirm models.
    ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));
}

struct TwoWaySyncSymmetryCase
{
    enum SyncType { type_twoWay, type_backupSync, type_numTypes };

    enum Action { action_rename, action_moveWithinSync, action_moveOutOfSync, action_moveIntoSync, action_delete, action_numactions };

    enum MatchState { match_exact,      // the sync destination has the exact same file/folder at the same relative path
                      match_older,      // the sync destination has an older file/folder at the same relative path
                      match_newer,      // the sync destination has a newer file/folder at the same relative path
                      match_absent };   // the sync destination has no node at the same relative path

    SyncType syncType = type_twoWay;
    Action action = action_rename;
    bool selfChange = false; // changed by our own client or another
    bool up = false;  // or down - sync direction
    bool file = false;  // or folder.  Which one this test changes
    bool isExternal = false;
    bool pauseDuringAction = false;
    Model localModel;
    Model remoteModel;
    handle backupId = UNDEF;

    bool printTreesBeforeAndAfter = false;

    struct State
    {
        StandardClient& steadyClient;
        StandardClient& resumeClient;
        StandardClient& nonsyncClient;
        fs::path localBaseFolderSteady;
        fs::path localBaseFolderResume;
        std::string remoteBaseFolder = "twoway";   // leave out initial / so we can drill down from root node
        std::string first_test_name;
        fs::path first_test_initiallocalfolders;

        State(StandardClient& ssc, StandardClient& rsc, StandardClient& sc2) : steadyClient(ssc), resumeClient(rsc), nonsyncClient(sc2) {}
    };

    State& state;
    TwoWaySyncSymmetryCase(State& wholestate) : state(wholestate) {}

    std::string typeName()
    {
        switch (syncType)
        {
        case type_twoWay:
            return "twoWay_";
        case type_backupSync:
            return isExternal ? "external_backup_"
                              : "internal_backup_";
        default:
            assert(false);
            return "";
        }
    }

    std::string actionName()
    {
        switch (action)
        {
        case action_rename: return "rename";
        case action_moveWithinSync: return "move";
        case action_moveOutOfSync: return "moveOut";
        case action_moveIntoSync: return "moveIn";
        case action_delete: return "delete";
        default: assert(false); return "";
        }
    }

    std::string matchName(MatchState m)
    {
        switch (m)
        {
            case match_exact: return "exact";
            case match_older: return "older";
            case match_newer: return "newer";
            case match_absent: return "absent";
        }
        return "bad enum";
    }

    std::string name()
    {
        return  typeName() + actionName() +
                (up?"_up" : "_down") +
                (selfChange?"_self":"_other") +
                (file?"_file":"_folder") +
                (pauseDuringAction?"_resumed":"_steady");
    }

    fs::path localTestBasePathSteady;
    fs::path localTestBasePathResume;
    std::string remoteTestBasePath;

    Model& sourceModel() { return up ? localModel : remoteModel; }
    Model& destinationModel() { return up ? remoteModel : localModel; }

    StandardClient& client1() { return pauseDuringAction ? state.resumeClient : state.steadyClient; }
    StandardClient& changeClient() { return selfChange ? client1() : state.nonsyncClient; }

    fs::path localTestBasePath() { return pauseDuringAction ? localTestBasePathResume : localTestBasePathSteady; }

    bool CopyLocalTree(const fs::path& destination, const fs::path& source) try
    {
        using PathPair = std::pair<fs::path, fs::path>;

        // Assume we've already copied if the destination exists.
        if (fs::exists(destination)) return true;

        std::list<PathPair> pending;

        pending.emplace_back(destination, source);

        for (; !pending.empty(); pending.pop_front())
        {
            const auto& dst = pending.front().first;
            const auto& src = pending.front().second;

            // Assume target directory doesn't exist.
            fs::create_directories(dst);

            // Iterate over source directory's children.
            auto i = fs::directory_iterator(src);
            auto j = fs::directory_iterator();

            for ( ; i != j; ++i)
            {
                auto from = i->path();
                auto to = dst / from.filename();

                // If it's a file, copy it and preserve its modification time.
                if (fs::is_regular_file(from))
                {
                    // Copy the file.
                    fs::copy_file(from, to);

                    // Preserve modification time.
                    fs::last_write_time(to, fs::last_write_time(from));

                    // Process next child.
                    continue;
                }

                // If it's not a file, it must be a directory.
                assert(fs::is_directory(from));

                // So, create it!
                fs::create_directories(to);

                // And copy its content.
                pending.emplace_back(to, from);
            }
        }

        return true;
    }
    catch (...)
    {
        return false;
    }

    void makeMtimeFile(std::string name, int mtime_delta, Model& m1, Model& m2)
    {
        createNameFile(state.first_test_initiallocalfolders, name);
        auto initial_mtime = fs::last_write_time(state.first_test_initiallocalfolders / name);
        fs::last_write_time(localTestBasePath() / name, initial_mtime + std::chrono::seconds(mtime_delta));
        fs::rename(state.first_test_initiallocalfolders / name, state.first_test_initiallocalfolders / "f" / name); // move it after setting the time to be 100% sure the sync sees it with the adjusted mtime only
        m1.findnode("f")->addkid(m1.makeModelSubfile(name));
        m2.findnode("f")->addkid(m2.makeModelSubfile(name));
    }

    PromiseBoolSP cloudCopySetupPromise = makeSharedPromise<bool>();

    // prepares a local folder for testing, which will be two-way synced before the test
    void SetupForSync()
    {
        // Prepare Cloud
        {
            remoteTestBasePath = state.remoteBaseFolder + "/" + name();

            auto& client = changeClient();

            auto root = client.gettestbasenode();
            ASSERT_NE(root, nullptr);

            root = client.drillchildnodebyname(root, state.remoteBaseFolder);
            ASSERT_NE(root, nullptr);

            auto from = client.drillchildnodebyname(root, "initial");
            ASSERT_NE(from, nullptr);

            ASSERT_TRUE(client.copy(from.get(), root.get(), name()));
        }

        // Prepare Local Filesystem
        {
            localTestBasePathSteady = state.localBaseFolderSteady / name();
            localTestBasePathResume = state.localBaseFolderResume / name();

            auto from = state.nonsyncClient.fsBasePath / "twoway" / "initial";
            ASSERT_TRUE(CopyLocalTree(localTestBasePathResume, from));
            ASSERT_TRUE(CopyLocalTree(localTestBasePathSteady, from));

            ASSERT_TRUE(CopyLocalTree(state.localBaseFolderResume / "initial", from));
            ASSERT_TRUE(CopyLocalTree(state.localBaseFolderSteady / "initial", from));
        }

        // Prepare models.
        {
            localModel.root->addkid(localModel.buildModelSubdirs("f", 2, 2, 2));
            localModel.root->addkid(localModel.buildModelSubdirs("outside", 2, 1, 1));
            localModel.addfile("f/.megaignore", "+sync:.megaignore");
            localModel.addfile("f/file_older_1", "file_older_1");
            localModel.addfile("f/file_older_2", "file_older_2");
            localModel.addfile("f/file_newer_1", "file_newer_1");
            localModel.addfile("f/file_newer_2", "file_newer_2");
            remoteModel = localModel;
        }
    }

    bool isBackup() const
    {
        return syncType == type_backupSync;
    }

    bool isExternalBackup() const
    {
        return isExternal && isBackup();
    }

    bool isInternalBackup() const
    {
        return !isExternal && isBackup();
    }

    bool shouldRecreateOnResume() const
    {
        if (pauseDuringAction)
        {
            return isExternalBackup();
        }

        return false;
    }

    bool shouldDisableSync() const
    {
        if (up)
        {
            return false;
        }

        if (pauseDuringAction)
        {
            return isInternalBackup();
        }

        return isBackup();
    }

    bool shouldUpdateDestination() const
    {
        return up || !isBackup();
    }

    bool shouldUpdateModel() const
    {
        return up
               || !pauseDuringAction
               || !isExternalBackup();
    }

    fs::path localSyncRootPath()
    {
        return localTestBasePath() / "f";
    }

    string remoteSyncRootPath()
    {
        return remoteTestBasePath + "/f";
    }

    std::shared_ptr<Node> remoteSyncRoot()
    {
        std::shared_ptr<Node> root = client1().client.nodebyhandle(client1().basefolderhandle);
        std::string remoteRootPath = remoteSyncRootPath();
        if (!root)
        {
            LOG_err << name()
                    << " root is NULL, local sync root:" << path_u8string(localSyncRootPath())
                    << " remote sync root:" << remoteRootPath;
            return nullptr;
        }

        std::shared_ptr<Node> n = client1().drillchildnodebyname(root, remoteRootPath);
        if (!n)
        {
            LOG_err << "remote sync root is NULL, local sync root:"
                    << root->displaypath()
                    << " remote sync root:"
                    << remoteRootPath;
        }
        return n;
    }

    void SetupTwoWaySync()
    {
        ASSERT_NE(remoteSyncRoot(), nullptr);

        string basePath = path_u8string(client1().fsBasePath);
        string drivePath  = string(1, '\0');
        string sourcePath = path_u8string(localSyncRootPath());
        string targetPath = remoteSyncRootPath();

        if (isExternalBackup())
        {
            drivePath = path_u8string(localTestBasePath());
            drivePath.erase(0, basePath.size() + 1);
        }

        sourcePath.erase(0, basePath.size() + 1);

        SyncOptions options;

        options.drivePath = drivePath;
        options.isBackup = isBackup();
        options.logName = sourcePath + "/" + name() + " ";
        options.uploadIgnoreFile = false;

        backupId = client1().setupSync_mainthread(sourcePath, targetPath, options);
        ASSERT_NE(backupId, UNDEF);
    }

    void PauseTwoWaySync()
    {
        if (shouldRecreateOnResume())
        {
            client1().delSync_mainthread(backupId);
        }
    }

    void ResumeTwoWaySync()
    {
        if (shouldRecreateOnResume())
        {
            ASSERT_NO_FATAL_FAILURE(SetupTwoWaySync());
        }
    }

    void remote_rename(std::string nodepath, std::string newname, bool updatemodel, bool reportaction, bool deleteTargetFirst)
    {
        std::lock_guard<std::recursive_mutex> g(changeClient().clientMutex);

        if (deleteTargetFirst) remote_delete(parentpath(nodepath) + "/" + newname, updatemodel, reportaction, true); // in case the target already exists

        if (updatemodel) remoteModel.emulate_rename(nodepath, newname);

        std::shared_ptr<Node> testRoot = changeClient().client.nodebyhandle(client1().basefolderhandle);
        std::shared_ptr<Node> n = changeClient().drillchildnodebyname(testRoot, remoteTestBasePath + "/" + nodepath);
        ASSERT_TRUE(!!n);

        if (reportaction) out() << name() << " action: remote rename " << n->displaypath() << " to " << newname;

        attr_map updates('n', newname);
        auto e = changeClient().client.setattr(n, std::move(updates), nullptr, false);

        ASSERT_EQ(API_OK, error(e));
    }

    void remote_move(std::string nodepath, std::string newparentpath, bool updatemodel, bool reportaction, bool deleteTargetFirst)
    {
        std::lock_guard<std::recursive_mutex> g(changeClient().clientMutex);

        if (deleteTargetFirst) remote_delete(newparentpath + "/" + leafname(nodepath), updatemodel, reportaction, true); // in case the target already exists

        if (updatemodel) remoteModel.emulate_move(nodepath, newparentpath);

        std::shared_ptr<Node> testRoot = changeClient().client.nodebyhandle(changeClient().basefolderhandle);
        std::shared_ptr<Node> n1 = changeClient().drillchildnodebyname(testRoot, remoteTestBasePath + "/" + nodepath);
        std::shared_ptr<Node> n2 = changeClient().drillchildnodebyname(testRoot, remoteTestBasePath + "/" + newparentpath);
        ASSERT_TRUE(!!n1);
        ASSERT_TRUE(!!n2);

        if (reportaction) out() << name() << " action: remote move " << n1->displaypath() << " to " << n2->displaypath();

        auto e = changeClient().client.rename(n1, n2, SYNCDEL_NONE, NodeHandle(), nullptr, false, nullptr);
        ASSERT_EQ(API_OK, e);
    }

    void remote_copy(std::string nodepath, std::string newparentpath, bool updatemodel, bool reportaction)
    {
        std::lock_guard<std::recursive_mutex> g(changeClient().clientMutex);

        if (updatemodel) remoteModel.emulate_copy(nodepath, newparentpath);

        std::shared_ptr<Node> testRoot = changeClient().client.nodebyhandle(changeClient().basefolderhandle);
        std::shared_ptr<Node> n1 = changeClient().drillchildnodebyname(testRoot, remoteTestBasePath + "/" + nodepath);
        std::shared_ptr<Node> n2 = changeClient().drillchildnodebyname(testRoot, remoteTestBasePath + "/" + newparentpath);
        ASSERT_TRUE(!!n1);
        ASSERT_TRUE(!!n2);

        if (reportaction) out() << name() << " action: remote copy " << n1->displaypath() << " to " << n2->displaypath();

        TreeProcCopy tc;
        changeClient().client.proctree(n1, &tc, false, true);
        tc.allocnodes();
        changeClient().client.proctree(n1, &tc, false, true);
        tc.nn[0].parenthandle = UNDEF;

        SymmCipher key;
        AttrMap attrs;
        string attrstring;
        key.setkey((const ::mega::byte*)tc.nn[0].nodekey.data(), n1->type);
        attrs = n1->attrs;
        attrs.getjson(&attrstring);
        client1().client.makeattr(&key, tc.nn[0].attrstring, attrstring.c_str());
        changeClient().client.putnodes(n2->nodeHandle(), NoVersioning, std::move(tc.nn), nullptr, ++next_request_tag, false);
    }

    void remote_renamed_copy(std::string nodepath, std::string newparentpath, string newname, bool updatemodel, bool reportaction)
    {
        std::lock_guard<std::recursive_mutex> g(changeClient().clientMutex);

        if (updatemodel)
        {
            remoteModel.emulate_rename_copy(nodepath, newparentpath, newname);
        }

        std::shared_ptr<Node> testRoot = changeClient().client.nodebyhandle(changeClient().basefolderhandle);
        std::shared_ptr<Node> n1 = changeClient().drillchildnodebyname(testRoot, remoteTestBasePath + "/" + nodepath);
        std::shared_ptr<Node> n2 = changeClient().drillchildnodebyname(testRoot, remoteTestBasePath + "/" + newparentpath);
        ASSERT_TRUE(!!n1);
        ASSERT_TRUE(!!n2);

        if (reportaction) out() << name() << " action: remote rename + copy " << n1->displaypath() << " to " << n2->displaypath() << " as " << newname;

        TreeProcCopy tc;
        changeClient().client.proctree(n1, &tc, false, true);
        tc.allocnodes();
        changeClient().client.proctree(n1, &tc, false, true);
        tc.nn[0].parenthandle = UNDEF;

        SymmCipher key;
        AttrMap attrs;
        string attrstring;
        key.setkey((const ::mega::byte*)tc.nn[0].nodekey.data(), n1->type);
        attrs = n1->attrs;
        LocalPath::utf8_normalize(&newname);
        attrs.map['n'] = newname;
        attrs.getjson(&attrstring);
        client1().client.makeattr(&key, tc.nn[0].attrstring, attrstring.c_str());
        changeClient().client.putnodes(n2->nodeHandle(), NoVersioning, std::move(tc.nn), nullptr, ++next_request_tag, false);
    }

    void remote_renamed_move(std::string nodepath, std::string newparentpath, string newname, bool updatemodel, bool reportaction)
    {
        std::lock_guard<std::recursive_mutex> g(changeClient().clientMutex);

        if (updatemodel)
        {
            remoteModel.emulate_rename_copy(nodepath, newparentpath, newname);
        }

        std::shared_ptr<Node> testRoot = changeClient().client.nodebyhandle(changeClient().basefolderhandle);
        std::shared_ptr<Node> n1 = changeClient().drillchildnodebyname(testRoot, remoteTestBasePath + "/" + nodepath);
        std::shared_ptr<Node> n2 = changeClient().drillchildnodebyname(testRoot, remoteTestBasePath + "/" + newparentpath);
        ASSERT_TRUE(!!n1);
        ASSERT_TRUE(!!n2);

        if (reportaction) out() << name() << " action: remote rename + move " << n1->displaypath() << " to " << n2->displaypath() << " as " << newname;

        error e = changeClient().client.rename(n1, n2, SYNCDEL_NONE, NodeHandle(), newname.c_str(), false, nullptr);
        EXPECT_EQ(e, API_OK);
    }

    void remote_delete(std::string nodepath, bool updatemodel, bool reportaction, bool mightNotExist)
    {
        std::lock_guard<std::recursive_mutex> g(changeClient().clientMutex);

        std::shared_ptr<Node> testRoot = changeClient().client.nodebyhandle(changeClient().basefolderhandle);
        std::shared_ptr<Node> n = changeClient().drillchildnodebyname(testRoot, remoteTestBasePath + "/" + nodepath);
        if (mightNotExist && !n) return;  // eg when checking to remove an item that is a move target but there isn't one

        ASSERT_TRUE(!!n);

        if (reportaction) out() << name() << " action: remote delete " << n->displaypath();

        if (updatemodel) remoteModel.emulate_delete(nodepath);

        auto e = changeClient().client.unlink(n.get(), false, ++next_request_tag, false);
        ASSERT_TRUE(!e);
    }

    fs::path fixSeparators(std::string p)
    {
        for (auto& c : p)
            if (c == '/')
                c = fs::path::preferred_separator;
        return u8path_compat(p);
    }

    void local_rename(std::string path, std::string newname, bool updatemodel, bool reportaction, bool deleteTargetFirst)
    {
        if (deleteTargetFirst) local_delete(parentpath(path) + "/" + newname, updatemodel, reportaction, true); // in case the target already exists

        if (updatemodel) localModel.emulate_rename(path, newname);

        fs::path p1(localTestBasePath());
        p1 /= fixSeparators(path);
        fs::path p2 = p1.parent_path() / newname;

        if (reportaction) out() << name() << " action: local rename " << p1 << " to " << p2;

        std::error_code ec;
        for (int i = 0; i < 5; ++i)
        {
            fs::rename(p1, p2, ec);
            if (!ec) break;
            WaitMillisec(100);
        }

        if (!pauseDuringAction)
            client1().triggerPeriodicScanEarly(backupId);

        ASSERT_TRUE(!ec) << "local_rename " << p1 << " to " << p2 << " failed: " << ec.message();
    }

    void local_move(std::string from, std::string to, bool updatemodel, bool reportaction, bool deleteTargetFirst)
    {
        if (deleteTargetFirst) local_delete(to + "/" + leafname(from), updatemodel, reportaction, true);

        if (updatemodel) localModel.emulate_move(from, to);

        fs::path p1(localTestBasePath());
        fs::path p2(localTestBasePath());
        p1 /= fixSeparators(from);
        p2 /= fixSeparators(to);
        p2 /= p1.filename();  // non-existing file in existing directory case

        if (reportaction) out() << name() << " action: local move " << p1 << " to " << p2;

        std::error_code ec;
        fs::rename(p1, p2, ec);
        if (ec)
        {
            fs::remove_all(p2, ec);
            fs::rename(p1, p2, ec);
        }

        if (!pauseDuringAction)
            client1().triggerPeriodicScanEarly(backupId);

        ASSERT_TRUE(!ec) << "local_move " << p1 << " to " << p2 << " failed: " << ec.message();
    }

    void local_copy(std::string from, std::string to, bool updatemodel, bool reportaction)
    {
        if (updatemodel) localModel.emulate_copy(from, to);

        fs::path p1(localTestBasePath());
        fs::path p2(localTestBasePath());
        p1 /= fixSeparators(from);
        p2 /= fixSeparators(to);

        if (reportaction) out() << name() << " action: local copy " << p1 << " to " << p2;

        std::error_code ec;
        fs::copy(p1, p2, ec);

        if (!pauseDuringAction)
            client1().triggerPeriodicScanEarly(backupId);

        ASSERT_TRUE(!ec) << "local_copy " << p1 << " to " << p2 << " failed: " << ec.message();
    }

    void local_delete(std::string path, bool updatemodel, bool reportaction, bool mightNotExist)
    {
        fs::path p(localTestBasePath());
        p /= fixSeparators(path);

        if (mightNotExist && !fs::exists(p)) return;

        if (reportaction) out() << name() << " action: local_delete " << p;

        std::error_code ec;
        fs::remove_all(p, ec);

        if (!pauseDuringAction)
            client1().triggerPeriodicScanEarly(backupId);

        ASSERT_TRUE(!ec) << "local_delete " << p << " failed: " << ec.message();
        if (updatemodel) localModel.emulate_delete(path);
    }

    void source_rename(std::string nodepath, std::string newname, bool updatemodel, bool reportaction, bool deleteTargetFirst)
    {
        if (up) local_rename(nodepath, newname, updatemodel, reportaction, deleteTargetFirst);
        else remote_rename(nodepath, newname, updatemodel, reportaction, deleteTargetFirst);
    }

    void source_move(std::string nodepath, std::string newparentpath, bool updatemodel, bool reportaction, bool deleteTargetFirst)
    {
        if (up) local_move(nodepath, newparentpath, updatemodel, reportaction, deleteTargetFirst);
        else remote_move(nodepath, newparentpath, updatemodel, reportaction, deleteTargetFirst);
    }

    void source_copy(std::string nodepath, std::string newparentpath, bool updatemodel, bool reportaction)
    {
        if (up) local_copy(nodepath, newparentpath, updatemodel, reportaction);
        else remote_copy(nodepath, newparentpath, updatemodel, reportaction);
    }

    void source_delete(std::string nodepath, bool updatemodel, bool reportaction = false)
    {
        if (up) local_delete(nodepath, updatemodel, reportaction, false);
        else remote_delete(nodepath, updatemodel, reportaction, false);
    }

    void fileMayDiffer(std::string filepath)
    {
        fs::path p(localTestBasePath());
        p /= fixSeparators(filepath);

        client1().localFSFilesThatMayDiffer.insert(p);
        out() << "File may differ: " << p;
    }

    // Two-way sync has been started and is stable.  Now perform the test action

    enum ModifyStage { Prepare, MainAction };

    void PrintLocalTree(fs::path p)
    {
        out() << p;
        if (fs::is_directory(p))
        {
            for (auto i = fs::directory_iterator(p); i != fs::directory_iterator(); ++i)
            {
                PrintLocalTree(*i);
            }
        }
    }

    void PrintLocalTree(const LocalNode& node)
    {
        out() << node.getLocalPath().toPath(false);

        if (node.type == FILENODE) return;

        for (const auto& childIt : node.children)
        {
            PrintLocalTree(*childIt.second);
        }
    }

    void PrintRemoteTree(Node* n, string prefix = "")
    {
        prefix += string("/") + n->displayname();
        out() << prefix;
        if (n->type == FILENODE) return;
        for (auto& c : client1().client.getChildren(n))
        {
            PrintRemoteTree(c.get(), prefix);
        }
    }

    void PrintModelTree(Model::ModelNode* n, string prefix = "")
    {
        prefix += string("/") + n->name;
        out() << prefix;
        if (n->type == Model::ModelNode::file) return;
        for (auto& c : n->kids)
        {
            PrintModelTree(c.get(), prefix);
        }
    }

    void Modify(ModifyStage stage)
    {
        bool prep = stage == Prepare;
        bool act = stage == MainAction;

        if (prep) out() << "Preparing action ";
        if (act) out() << "Executing action ";

        if (prep && printTreesBeforeAndAfter)
        {
            out() << " ---- local filesystem initial state ----";
            PrintLocalTree(fs::path(localTestBasePath()));

            if (auto* sync = client1().syncByBackupId(backupId))
            {
                out() << " ---- local node tree initial state ----";
                PrintLocalTree(*sync->localroot);
            }

            out() << " ---- remote node tree initial state ----";
            std::shared_ptr<Node> testRoot = client1().client.nodebyhandle(changeClient().basefolderhandle);
            if (std::shared_ptr<Node> n = client1().drillchildnodebyname(testRoot, remoteTestBasePath))
            {
                PrintRemoteTree(n.get());
            }
        }

        switch (action)
        {
        case action_rename:
            if (prep)
            {
            }
            else if (act)
            {
                if (file)
                {
                    source_rename("f/f_0/file0_f_0", "file0_f_0_renamed", shouldUpdateModel(), true, true);
                    if (shouldUpdateDestination())
                    {
                        destinationModel().emulate_rename("f/f_0/file0_f_0", "file0_f_0_renamed");
                    }
                }
                else
                {
                    source_rename("f/f_0", "f_0_renamed", shouldUpdateModel(), true, false);
                    if (shouldUpdateDestination())
                    {
                        destinationModel().emulate_rename("f/f_0", "f_0_renamed");
                    }
                }
            }
            break;

        case action_moveWithinSync:
            if (prep)
            {
            }
            else if (act)
            {
                if (file)
                {
                    source_move("f/f_1/file0_f_1", "f/f_0", shouldUpdateModel(), true, false);
                    if (shouldUpdateDestination())
                    {
                        destinationModel().emulate_move("f/f_1/file0_f_1", "f/f_0");
                    }
                }
                else
                {
                    source_move("f/f_1", "f/f_0", shouldUpdateModel(), true, false);
                    if (shouldUpdateDestination())
                    {
                        destinationModel().emulate_move("f/f_1", "f/f_0");
                    }
                }
            }
            break;

        case action_moveOutOfSync:
            if (prep)
            {
            }
            else if (act)
            {
                if (file)
                {
                    source_move("f/f_0/file0_f_0", "outside", shouldUpdateModel(), false, false);
                    if (shouldUpdateDestination())
                    {
                        destinationModel().emulate_delete("f/f_0/file0_f_0");
                    }
                }
                else
                {
                    source_move("f/f_0", "outside", shouldUpdateModel(), false, false);
                    if (shouldUpdateDestination())
                    {
                        destinationModel().emulate_delete("f/f_0");
                    }
                }
            }
            break;

        case action_moveIntoSync:
            if (prep)
            {
            }
            else if (act)
            {
                if (file)
                {
                    source_move("outside/file0_outside", "f/f_0", shouldUpdateModel(), false, false);
                    if (shouldUpdateDestination())
                    {
                        destinationModel().emulate_copy("outside/file0_outside", "f/f_0");
                    }
                }
                else
                {
                    source_move("outside", "f/f_0", shouldUpdateModel(), false, false);
                    if (shouldUpdateDestination())
                    {
                        destinationModel().emulate_delete("f/f_0/outside");
                        destinationModel().emulate_copy("outside", "f/f_0");
                    }
                }
            }
            break;

        case action_delete:
            if (prep)
            {
            }
            else if (act)
            {
                if (file)
                {
                    source_delete("f/f_0/file0_f_0", shouldUpdateModel(), true);
                    if (shouldUpdateDestination())
                    {
                        destinationModel().emulate_delete("f/f_0/file0_f_0");
                    }
                }
                else
                {
                    source_delete("f/f_0", shouldUpdateModel(), true);
                    if (shouldUpdateDestination())
                    {
                        destinationModel().emulate_delete("f/f_0");
                    }
                }
            }
            break;

        default: ASSERT_TRUE(false);
        }
    }

    void CheckSetup(State&, bool initial)
    {
        if (!initial && printTreesBeforeAndAfter)
        {
            out() << " ---- local filesystem before change ----";
            PrintLocalTree(fs::path(localTestBasePath()));

            if (auto* sync = client1().syncByBackupId(backupId))
            {
                out() << " ---- local node tree before change ----";
                PrintLocalTree(*sync->localroot);
            }

            out() << " ---- remote node tree before change ----";
            std::shared_ptr<Node> testRoot = client1().client.nodebyhandle(changeClient().basefolderhandle);
            if (std::shared_ptr<Node> n = client1().drillchildnodebyname(testRoot, remoteTestBasePath))
            {
                PrintRemoteTree(n.get());
            }
        }

        if (!initial) out() << "Checking setup state (should be no changes in twoway sync source): "<< name();

        // confirm source is unchanged after setup  (Two-way is not sending changes to the wrong side)
        bool localfs = client1().confirmModel(backupId, localModel.findnode("f"), StandardClient::CONFIRM_LOCALFS, true, false, false); // todo: later enable debris checks
        bool localnode = client1().confirmModel(backupId, localModel.findnode("f"), StandardClient::CONFIRM_LOCALNODE, true, false, false); // todo: later enable debris checks
        bool remote = client1().confirmModel(backupId, remoteModel.findnode("f"), StandardClient::CONFIRM_REMOTE, true, false, false); // todo: later enable debris checks
        EXPECT_EQ(localfs, localnode);
        EXPECT_EQ(localnode, remote);
        EXPECT_TRUE(localfs && localnode && remote) << " failed in " << name();
    }

    void WaitSetup()
    {
        const std::chrono::seconds maxWaitSeconds(120);
        const std::chrono::milliseconds checkInterval(5000);

        auto remoteIsReady = [this](StandardClient& client){
                int descendents1 = 0, descendents2 = 0;
                bool reported1 = false, reported2 = false;

                return client.recursiveConfirm(remoteModel.findnode("f"), client.drillchildnodebyname(client.gettestbasenode(), remoteTestBasePath + "/f").get(), descendents1, name(), 0, reported1, true, false)
                    && client.recursiveConfirm(remoteModel.findnode("outside"), client.drillchildnodebyname(client.gettestbasenode(), remoteTestBasePath + "/outside").get(), descendents2, name(), 0, reported2, true, false);
        };

        EXPECT_TRUE(state.resumeClient.waitFor(remoteIsReady, maxWaitSeconds, checkInterval));
        EXPECT_TRUE(state.steadyClient.waitFor(remoteIsReady, maxWaitSeconds, checkInterval));
        EXPECT_TRUE(state.nonsyncClient.waitFor(remoteIsReady, maxWaitSeconds, checkInterval));
    }

    // Two-way sync is stable again after the change.  Check the results.
    bool finalResult = false;
    void CheckResult(State&)
    {
        Sync* sync = client1().syncByBackupId(backupId);

        std::function<void()> printTrees = [&]() {
            out() << " ---- local filesystem after sync of change ----";
            PrintLocalTree(fs::path(localTestBasePath()));

            if (sync && sync->localroot)
            {
                out() << " ---- local node tree after sync of change ----";
                PrintLocalTree(*sync->localroot);
            }

            out() << " ---- remote node tree after sync of change ----";
            std::shared_ptr<Node> testRoot = client1().client.nodebyhandle(changeClient().basefolderhandle);
            if (std::shared_ptr<Node> n = client1().drillchildnodebyname(testRoot, remoteTestBasePath))
            {
                PrintRemoteTree(n.get());
            }
            out() << " ---- expected sync destination (model) ----";
            auto n = destinationModel().findnode("f");
            if (n) PrintModelTree(n);
        };

        if (printTreesBeforeAndAfter)
        {
            printTrees();

            // Don't saturate the logs if we're already displaying the trees.
            printTrees = nullptr;
        }

        out() << "Checking twoway sync "<< name();

        auto confirmedOk = true;

        if (shouldDisableSync())
        {
            bool lfs = client1().confirmModel(backupId, localModel.findnode("f"), localSyncRootPath(), true, false, false);
            bool rnt = client1().confirmModel(backupId, remoteModel.findnode("f"), remoteSyncRoot().get(), false, false);

            EXPECT_EQ(sync, nullptr) << "Sync isn't disabled: " << name();
            EXPECT_TRUE(lfs) << "Couldn't confirm LFS: " << name();
            EXPECT_TRUE(rnt) << "Couldn't confirm RNT: " << name();

            confirmedOk &= lfs && rnt;

            finalResult = sync == nullptr;
            finalResult &= confirmedOk;
        }
        else
        {
            EXPECT_NE(sync, (Sync*)nullptr);

            bool localfs = client1().confirmModel(backupId, localModel.findnode("f"), StandardClient::CONFIRM_LOCALFS, true, false, false); // todo: later enable debris checks
            bool localnode = client1().confirmModel(backupId, localModel.findnode("f"), StandardClient::CONFIRM_LOCALNODE, true, false, false); // todo: later enable debris checks
            bool remote = client1().confirmModel(backupId, remoteModel.findnode("f"), StandardClient::CONFIRM_REMOTE, true, false, false); // todo: later enable debris checks
            EXPECT_EQ(localfs, localnode);
            EXPECT_EQ(localnode, remote);
            EXPECT_TRUE(localfs && localnode && remote) << " failed in " << name();

            confirmedOk &= localfs && localnode && remote;

            finalResult = sync && confirmedOk;
        }

        // Show the trees if there's been a mismatch.
        if (printTreesBeforeAndAfter && printTrees && !confirmedOk)
        {
            printTrees();
        }
    }
};

bool CatchupClients(StandardClient* c1, StandardClient* c2, StandardClient* c3)
{
    out() << "Catching up";
    auto pb1 = makeSharedPromise<bool>();
    auto pb2 = makeSharedPromise<bool>();
    auto pb3 = makeSharedPromise<bool>();
    if (c1) c1->catchup(pb1);
    if (c2) c2->catchup(pb2);
    if (c3) c3->catchup(pb3);

    auto f1 = pb1->get_future();
    auto f2 = pb2->get_future();
    auto f3 = pb3->get_future();

    if (c1 && f1.wait_for(DEFAULTWAIT) == future_status::timeout) return false;
    if (c2 && f2.wait_for(DEFAULTWAIT) == future_status::timeout) return false;
    if (c3 && f3.wait_for(DEFAULTWAIT) == future_status::timeout) return false;

    EXPECT_TRUE((!c1 || f1.get()) &&
                (!c2 || f2.get()) &&
                (!c3 || f3.get()));
    out() << "Caught up";
    return true;
}

void PrepareForSync(StandardClient& client)
{
    auto local = client.fsBasePath / "twoway" / "initial";

    fs::create_directories(local);

    ASSERT_TRUE(buildLocalFolders(local, "f", 2, 2, 2));
    ASSERT_TRUE(buildLocalFolders(local, "outside", 2, 1, 1));

    constexpr auto delta = std::chrono::seconds(3600);

    // Initial ignore file.
    auto ignoreFilePath = local / "f" / ".megaignore";

    ASSERT_TRUE(createFile(ignoreFilePath, "+sync:.megaignore"));

    ASSERT_TRUE(createFile(local / "f" / ".megaignore", "+sync:.megaignore"));
    ASSERT_TRUE(createFile(local / "f" / "file_older_1", "file_older_1", -delta));
    ASSERT_TRUE(createFile(local / "f" / "file_older_2", "file_older_2", -delta));
    ASSERT_TRUE(createFile(local / "f" / "file_newer_1", "file_newer_1", delta));
    ASSERT_TRUE(createFile(local / "f" / "file_newer_2", "file_newer_2", delta));

    auto remote = client.drillchildnodebyname(client.gettestbasenode(), "twoway");
    ASSERT_NE(remote, nullptr);

    // Upload initial ignore file.
    ASSERT_TRUE(client.uploadFile(ignoreFilePath, remote.get()));

    // Upload initial sync contents.
    ASSERT_TRUE(client.uploadFolderTree(local, remote.get()));
    ASSERT_TRUE(client.uploadFilesInTree(local, remote.get()));
}

bool WaitForRemoteMatch(map<string, TwoWaySyncSymmetryCase>& testcases,
                        chrono::seconds timeout)
{
    auto check = [&]() {
        auto i = testcases.begin();
        auto j = testcases.end();

        for ( ; i != j; ++i)
        {
            auto& testcase = i->second;

            if (testcase.pauseDuringAction) continue;

            auto& client = testcase.client1();
            auto& id = testcase.backupId;
            auto& model = testcase.remoteModel;

            if (!client.match(id, model.findnode("f")))
            {
                out() << "Cloud/model misatch: "
                      << client.client.clientname
                      << ": "
                      << testcase.name();

                return false;
            }
        }

        return true;
    };

    auto total = std::chrono::milliseconds(0);
    constexpr auto sleepIncrement = std::chrono::milliseconds(500);

    do
    {
        if (check())
        {
            out() << "Cloud/model matched.";
            return true;
        }

        out() << "Waiting for cloud/model match...";

        std::this_thread::sleep_for(sleepIncrement);
        total += sleepIncrement;
    }
    while (total < timeout);

    if (!check())
    {
        out() << "Timed out waiting for cloud/model match.";
        return false;
    }

    return true;
}

TEST_F(SyncTest, TwoWay_Highlevel_Symmetries)
{
    // confirm change is synced to remote, and also seen and applied in a second client that syncs the same folder
    fs::path localtestroot = makeNewTestRoot();

    StandardClient clientA2(localtestroot, "clientA2");

    ASSERT_TRUE(clientA2.login_reset_makeremotenodes("MEGA_EMAIL", "MEGA_PWD", "twoway", 0, 0, true));

    PrepareForSync(clientA2);

    StandardClient clientA1Steady(localtestroot, "clientA1S");
    StandardClient clientA1Resume(localtestroot, "clientA1R");
    ASSERT_TRUE(clientA1Steady.login_fetchnodes("MEGA_EMAIL", "MEGA_PWD", false, true));
    ASSERT_TRUE(clientA1Resume.login_fetchnodes("MEGA_EMAIL", "MEGA_PWD", false, true));
    fs::create_directory(clientA1Steady.fsBasePath / u8path_compat("twoway"));
    fs::create_directory(clientA1Resume.fsBasePath / u8path_compat("twoway"));
    fs::create_directory(clientA2.fsBasePath / u8path_compat("twoway"));

    TwoWaySyncSymmetryCase::State allstate(clientA1Steady, clientA1Resume, clientA2);
    allstate.localBaseFolderSteady = clientA1Steady.fsBasePath / u8path_compat("twoway");
    allstate.localBaseFolderResume = clientA1Resume.fsBasePath / u8path_compat("twoway");

    std::map<std::string, TwoWaySyncSymmetryCase> cases;

    static set<string> tests = {
        // investigating why this one fails sometimes in jenkins MR jobs
        //"internal_backup_delete_down_self_file_steady"
        //"internal_backup_rename_up_self_folder_steady",
        //"twoWay_move_up_other_file_steady",
        //"twoWay_move_up_other_folder_steady",
        //"twoWay_moveIn_up_other_file_steady"
    }; // tests

    for (int syncType = TwoWaySyncSymmetryCase::type_numTypes; syncType--; )
    {
        //if (syncType != TwoWaySyncSymmetryCase::type_backupSync) continue;

        for (int selfChange = 0; selfChange < 2; ++selfChange)
        {
            //if (!selfChange) continue;

            for (int up = 0; up < 2; ++up)
            {
                // if (!up) continue;
                //  We don't allow changes in the cloud for a backup sync
                if (up == 0 && syncType == TwoWaySyncSymmetryCase::type_backupSync)
                    continue;

                for (int action = 0; action < (int)TwoWaySyncSymmetryCase::action_numactions; ++action)
                {
                //if (action != TwoWaySyncSymmetryCase::action_moveIntoSync) continue;
                //if (action != TwoWaySyncSymmetryCase::action_rename) continue;
                //if (action != TwoWaySyncSymmetryCase::action_delete) continue;

                for (int file = 0; file < 2; ++file)
                    {
                        //if (!file) continue;

                        for (int isExternal = 0; isExternal < 2; ++isExternal)
                        {
                            if (isExternal && syncType != TwoWaySyncSymmetryCase::type_backupSync)
                            {
                                continue;
                            }

                            for (int pauseDuringAction = 0; pauseDuringAction < 2; ++pauseDuringAction)
                            {
                                //if (pauseDuringAction) continue;

                                // we can't make changes if the client is not running
                                if (pauseDuringAction && selfChange) continue;

                                TwoWaySyncSymmetryCase testcase(allstate);
                                testcase.syncType = TwoWaySyncSymmetryCase::SyncType(syncType);
                                testcase.selfChange = selfChange != 0;
                                testcase.up = up != 0;
                                testcase.action = TwoWaySyncSymmetryCase::Action(action);
                                testcase.file = file != 0;
                                testcase.isExternal = isExternal != 0;
                                testcase.pauseDuringAction = pauseDuringAction != 0;
                                testcase.printTreesBeforeAndAfter = !tests.empty();

                                if (tests.empty() || tests.count(testcase.name()) > 0)
                                {
                                    auto name = testcase.name();
                                    cases.emplace(name, std::move(testcase));
                                }
                            }
                        }
                    }
                }
            }
        }
    }

    out() << "Creating initial local files/folders for " << cases.size() << " sync test cases";
    for (auto& testcase : cases)
    {
        ASSERT_NO_FATAL_FAILURE(testcase.second.SetupForSync());
    }

    out() << "Waiting intial state to be ready and clients are updated with actionpackets";
    for (auto& testcase : cases)
    {
        ASSERT_NO_FATAL_FAILURE(testcase.second.WaitSetup());
    }

    out() << "Setting up each sub-test's Two-way sync of 'f'";
    for (auto& testcase : cases)
    {
        ASSERT_NO_FATAL_FAILURE(testcase.second.SetupTwoWaySync());
    }

    out() << "Letting all " << cases.size() << " Two-way syncs run";
    waitonsyncs(DEFAULTWAIT, &clientA1Steady, &clientA1Resume);

    CatchupClients(&clientA1Steady, &clientA1Resume, &clientA2);
    waitonsyncs(DEFAULTWAIT, &clientA1Steady, &clientA1Resume);

    out() << "Checking intial state";
    for (auto& testcase : cases)
    {
        ASSERT_NO_FATAL_FAILURE(testcase.second.CheckSetup(allstate, true));
    }

    // make changes in destination to set up test
    for (auto& testcase : cases)
    {
        ASSERT_NO_FATAL_FAILURE(testcase.second.Modify(TwoWaySyncSymmetryCase::Prepare));
    }

    ASSERT_NO_FATAL_FAILURE(CatchupClients(&clientA1Steady, &clientA1Resume, &clientA2));

    out() << "Letting all " << cases.size() << " Two-way syncs run";
    waitonsyncs(std::chrono::seconds(15), &clientA1Steady, &clientA1Resume, &clientA2);

    out() << "Checking Two-way source is unchanged";
    for (auto& testcase : cases)
    {
        ASSERT_NO_FATAL_FAILURE(testcase.second.CheckSetup(allstate, false));
    }

    auto backupsAreMonitoring = [&cases]() {
        for (auto& i : cases)
        {
            // Convenience.
            auto& testcase = i.second;

            // Only check backup syncs.
            if (!testcase.isBackup()) continue;

            // Only check active syncs.
            if (!testcase.client1().syncByBackupId(testcase.backupId)) continue;

            // Get the sync's config so we can determine if it's monitoring.
            auto config = testcase.client1().syncConfigByBackupID(testcase.backupId);

            // Is the sync monitoring as it should be?
            if (config.getBackupState() != SYNC_BACKUP_MONITOR)
            {
                LOG_warn << "Backup state is not SYNC_BACKUP_MONITOR, for test " << testcase.name() << ". actual state: " << config.getBackupState();
                return false;
            }
        }

        // Everyone's monitoring as they should be.
        return true;
    };

    out() << "Checking Backups are Monitoring";
    ASSERT_TRUE(backupsAreMonitoring());

    int paused = 0;
    for (auto& testcase : cases)
    {
        if (testcase.second.pauseDuringAction)
        {
            testcase.second.PauseTwoWaySync();
            ++paused;
        }
    }

    // save session and local log out A1R to set up for resume
    string session;
    clientA1Resume.client.dumpsession(session);
    clientA1Resume.localLogout();

    auto remainingResumeSyncs = clientA1Resume.client.syncs.getConfigs(false);
    ASSERT_EQ(0u, remainingResumeSyncs.size());

    if (paused)
    {
        out() << "Paused " << paused << " Two-way syncs";
        WaitMillisec(1000);
    }

    clientA1Steady.logcb = clientA1Resume.logcb = clientA2.logcb = true;

    out() << "Performing action ";
    for (auto& testcase : cases)
    {
        testcase.second.Modify(TwoWaySyncSymmetryCase::MainAction);
    }
    waitonsyncs(std::chrono::seconds(15), &clientA1Steady, &clientA2);   // leave out clientA1Resume as it's 'paused' (locallogout'd) for now
    ASSERT_NO_FATAL_FAILURE(CatchupClients(&clientA1Steady, &clientA2));
    waitonsyncs(std::chrono::seconds(15), &clientA1Steady, &clientA2);   // leave out clientA1Resume as it's 'paused' (locallogout'd) for now

    // resume A1R session (with sync), see if A2 nodes and localnodes get in sync again
    clientA1Resume.received_syncs_restored = false;
    ASSERT_TRUE(clientA1Resume.login_fetchnodesFromSession(session));
    ASSERT_EQ(clientA1Resume.basefolderhandle, clientA2.basefolderhandle);

    // wait for normal sync resumes to complete
    clientA1Resume.waitFor([&](StandardClient& sc) { return sc.received_syncs_restored.load(); }, std::chrono::seconds(30));

    // now resume remainder - some are external syncs
    int resumed = 0;
    for (auto& testcase : cases)
    {
        if (testcase.second.pauseDuringAction)
        {
            ASSERT_NO_FATAL_FAILURE(testcase.second.ResumeTwoWaySync());
            ++resumed;
        }
    }
    if (resumed)
    {
        out() << "Resumed " << resumed << " Two-way syncs";
        WaitMillisec(3000);
    }

    out() << "Waiting for remote changes to make it to clients...";
    EXPECT_TRUE(WaitForRemoteMatch(cases, chrono::seconds(64)));  // 64 because the jenkins machines can be slow

    out() << "Letting all " << cases.size() << " Two-way syncs run";

    waitonsyncs(std::chrono::seconds(15), &clientA1Steady, &clientA1Resume, &clientA2);

    ASSERT_NO_FATAL_FAILURE(CatchupClients(&clientA1Steady, &clientA1Resume, &clientA2));
    waitonsyncs(std::chrono::seconds(15), &clientA1Steady, &clientA1Resume, &clientA2);

    out() << "Checking Backups are Monitoring";
    ASSERT_TRUE(backupsAreMonitoring());

    out() << "Checking local and remote state in each sub-test";

    for (auto& testcase : cases)
    {
        testcase.second.CheckResult(allstate);
    }
    int succeeded = 0, failed = 0;
    for (auto& testcase : cases)
    {
        if (testcase.second.finalResult) ++succeeded;
        else
        {
            out() << "failed: " << testcase.second.name();
            ++failed;
        }
    }
    out() << "Succeeded: " << succeeded << " Failed: " << failed;

    // Clear tree-state cache.
    {
        StandardClient cC(localtestroot, "cC");
        ASSERT_TRUE(cC.login_fetchnodes("MEGA_EMAIL", "MEGA_PWD", false, true));
    }
}

TEST_F(SyncTest, MoveExistingIntoNewDirectoryWhilePaused)
{
    auto TESTROOT = makeNewTestRoot();
    auto TIMEOUT  = chrono::seconds(4);

    Model model;
    fs::path root;
    string session;
    handle id;

    // Initial setup.
    {
        StandardClient c(TESTROOT, "c");
        // don't use clientManager as we re-use the client "c" for its directory

        // Log in client.
        ASSERT_TRUE(c.login_reset_makeremotenodes("MEGA_EMAIL", "MEGA_PWD", "s", 0, 0));

        // Add and start sync.
        id = c.setupSync_mainthread("s", "s", false, false);
        ASSERT_NE(id, UNDEF);

        // Squirrel away for later use.
        root = path_u8string(c.syncSet(id).localpath);

        // Populate filesystem.
        model.addfolder("a");
        model.addfolder("c");
        model.generate(root);

        c.triggerPeriodicScanEarly(id);

        // Wait for initial sync to complete.
        waitonsyncs(TIMEOUT, &c);

        // Make sure everything arrived safely.
        ASSERT_TRUE(c.confirmModel_mainthread(model.root.get(), id));

        // Save the session so we can resume later.
        c.client.dumpsession(session);

        // Log out client, taking care to keep caches.
        c.localLogout();
    }

    StandardClient c(TESTROOT, "c");

    // Add a new hierarchy to be scanned.
    model.addfolder("b");
    model.generate(root);

    // Move c under b.
    fs::rename(root / "c", root / "b" / "c");

    // Update the model.
    model.movenode("c", "b");

    // Hook onAutoResumeResult callback.
    promise<void> notify;

    c.mOnSyncStateConfig = [&notify](const SyncConfig& config) {
        if (config.mRunState == SyncRunState::Run)
            notify.set_value();
    };

    // Log in client resuming prior session.
    ASSERT_TRUE(c.login_fetchnodesFromSession(session));

    // Wait for the sync to be resumed.
    ASSERT_TRUE(debugTolerantWaitOnFuture(notify.get_future(), 45));

    // Wait for the sync to catch up.
    waitonsyncs(TIMEOUT, &c);

    // Were the changes propagated?
    ASSERT_TRUE(c.confirmModel_mainthread(model.root.get(), id));
}

class BackupClient
  : public StandardClient
{
public:
    BackupClient(const fs::path& basePath, const string& name)
      : StandardClient(basePath, name)
      , mOnFileAdded()
    {
    }

    void file_added(File* file) override
    {
        StandardClient::file_added(file);

        if (mOnFileAdded) mOnFileAdded(*file);
    }

    using FileAddedCallback = std::function<void(File&)>;

    FileAddedCallback mOnFileAdded;
}; // Client

TEST_F(SyncTest, MonitoringExternalBackupRestoresInMirroringMode)
{
    const auto TESTROOT = makeNewTestRoot();
    const auto TIMEOUT  = chrono::seconds(8);

    // Model.
    Model m;

    // Sync Root Handle.
    NodeHandle rootHandle;

    // Session ID.
    string sessionID;

    // Sync Backup ID.
    handle id;

    {
        StandardClient cb(TESTROOT, "cb");
        // can not use ClientManager as both these clients must refer to their filesystem as "cb"
        // even though there are two of them

        // Log callbacks.
        cb.logcb = true;

        // Log in client.
        ASSERT_TRUE(cb.login_reset_makeremotenodes("MEGA_EMAIL", "MEGA_PWD", "s", 0, 0));

        // Create some files to synchronize.
        m.addfile("d/f");
        m.addfile("f");
        m.addfile(".megaignore", "+sync:.megaignore");
        m.generate(cb.fsBasePath / "s");

        // Add and start sync.
        id = cb.setupSync_mainthread("s", "s", true, true, "");
        ASSERT_NE(id, UNDEF);

        // Wait for sync to complete.
        waitonsyncs(TIMEOUT, &cb);

        // Give the engine some time to actually upload the files.
        ASSERT_TRUE(cb.waitFor(SyncRemoteMatch("s", m.root.get()), TIMEOUT));

        // Make sure everything made it to the cloud.
        ASSERT_TRUE(cb.confirmModel_mainthread(m.root.get(), id));

        // Wait for sync to transition to monitoring mode.
        ASSERT_TRUE(cb.waitFor(SyncMonitoring(id), TIMEOUT));

        // Get our hands on the sync's root handle.
        rootHandle = cb.syncSet(id).h;

        // Record this client's session.
        cb.client.dumpsession(sessionID);

        // Log out the client.
        cb.localLogout();
    }

    StandardClient cb(TESTROOT, "cb");

    cb.logcb = true;

    // Log in client.
    ASSERT_TRUE(cb.login_fetchnodesFromSession(sessionID));

    // Make a change in the cloud.
    {
        vector<NewNode> node(1);

        cb.prepareOneFolder(&node[0], "g", false);

        ASSERT_TRUE(cb.putnodes(rootHandle, NoVersioning, std::move(node)));
    }

    // Restore the backup sync.
    ASSERT_TRUE(cb.backupOpenDrive(cb.fsBasePath));

    // Re-enable the sync.
    ASSERT_TRUE(cb.enableSyncByBackupId(id, "cb"));

    // Wait for the mirror to complete.
    waitonsyncs(TIMEOUT, &cb);

    // Cloud should mirror the local disk. (ie, g should be gone in the cloud)
    ASSERT_TRUE(cb.confirmModel_mainthread(m.root.get(), id));
}

TEST_F(SyncTest, MonitoringExternalBackupResumesInMirroringMode)
{
    const auto TESTROOT = makeNewTestRoot();
    const auto TIMEOUT  = chrono::seconds(4);

    StandardClientInUse cb = g_clientManager->getCleanStandardClient(0, TESTROOT);

    // Log callbacks.
    cb->logcb = true;

    // Log in client.
    ASSERT_TRUE(cb->resetBaseFolderMulticlient());
    ASSERT_TRUE(cb->makeCloudSubdirs("s", 0, 0));
    ASSERT_TRUE(CatchupClients(cb));

    // Create some files to be synchronized.
    Model m;

    m.addfile("d/f");
    m.addfile("f");
    m.generate(cb->fsBasePath / "s");

    // Add and start sync.
    auto id = cb->setupSync_mainthread("s", "s", true, true, "");
    ASSERT_NE(id, UNDEF);

    // Wait for the mirror to complete.
    waitonsyncs(TIMEOUT, cb);

    // Make sure everything arrived safe and sound.
    ASSERT_TRUE(cb->confirmModel_mainthread(m.root.get(), id));

    // Wait for transition to monitoring mode.
    ASSERT_TRUE(cb->waitFor(SyncMonitoring(id), TIMEOUT));

    // Disable the sync.
    ASSERT_TRUE(cb->disableSync(id, NO_SYNC_ERROR, true, true));

    // Make sure the sync's config is as we expect.
    {
        auto config = cb->syncConfigByBackupID(id);

        // Backup should remain in monitoring mode.
        ASSERT_EQ(config.mBackupState, SYNC_BACKUP_MONITOR);

        // Disabled external backups are always considered "user-disabled."
        // That is, the user must consciously decide to resume these syncs.
        ASSERT_EQ(config.mEnabled, false);
    }

    // Make a change in the cloud.
    {
        vector<NewNode> node(1);

        cb->prepareOneFolder(&node[0], "g", false);

        auto rootHandle = cb->syncSet(id).h;
        ASSERT_TRUE(cb->putnodes(rootHandle, NoVersioning, std::move(node)));
    }

    // Re-enable the sync.
    ASSERT_TRUE(cb->enableSyncByBackupId(id, ""));

    // Wait for the mirror to complete.
    waitonsyncs(TIMEOUT, cb);

    // Cloud should mirror the disk.
    ASSERT_TRUE(cb->confirmModel_mainthread(m.root.get(), id));
}

TEST_F(SyncTest, MirroringInternalBackupResumesInMirroringMode)
{
    const auto TESTROOT = makeNewTestRoot();
    const auto TIMEOUT  = chrono::seconds(4);

    // Session ID.
    string sessionID;

    // Sync Backup ID.
    handle id{UNDEF};

    // Sync Root Handle.
    NodeHandle rootHandle;

    // Model.
    Model m;

    StandardClientInUse cf = g_clientManager->getCleanStandardClient(0, TESTROOT);

    // Log callbacks.
    cf->logcb = true;

    // Log in client.
    ASSERT_TRUE(cf->resetBaseFolderMulticlient());
    ASSERT_TRUE(cf->makeCloudSubdirs("s", 0, 0));
    ASSERT_TRUE(CatchupClients(cf));

    // Check manual resume.
    {
        BackupClient cb(TESTROOT, "cb");
        // can not use ClientManager as is a BackupClient and
        // "cb" is re-used later

        // Log callbacks.
        cb.logcb = true;

        // Log client in.
        ASSERT_TRUE(cb.login_fetchnodes("MEGA_EMAIL", "MEGA_PWD"));

        // Set upload throttle.
        //
        // This is so that we can disable the sync before it transitions
        // to the monitoring state.
        cb.setUploadSpeed(1);

        // Give the sync something to backup.
        m.addfile("d/f", randomData(16384));
        m.addfile("f", randomData(16384));
        m.generate(cb.fsBasePath / "s");

        // Disable the sync when it starts uploading a file.
        cb.mOnFileAdded = [&cb, &id, &TIMEOUT](File&)
        {
            // the upload has been set super slow so there's loads of time.

            // get the single sync
            SyncConfig config;

            const auto getBackupResult = cb.waitFor(
                [&id, &config](StandardClient& backupClient)
                {
                    return id != UNDEF &&
                           backupClient.client.syncs.syncConfigByBackupId(id, config);
                },
                TIMEOUT);

            ASSERT_TRUE(getBackupResult)
                << "BackupId: " << id
                << ". SyncVec is empty: " << (cb.client.syncs.mNumSyncsActive == 0);

            // Make sure the sync's in mirroring mode.
            ASSERT_EQ(config.mBackupId, id);
            ASSERT_EQ(config.mSyncType, SyncConfig::TYPE_BACKUP);
            ASSERT_EQ(config.mBackupState, SYNC_BACKUP_MIRROR);

            // Disable the sync.
            cb.client.syncs.disableSyncs(NO_SYNC_ERROR, true, true);

            // Callback's done its job.
            cb.mOnFileAdded = nullptr;
        };

        // Add and start sync.
        id = cb.setupSync_mainthread("s", "s", true, false);
        ASSERT_NE(id, UNDEF);

        // Let the sync mirror.
        waitonsyncs(TIMEOUT, &cb);

        // Make sure the sync's been disabled.
        ASSERT_FALSE(cb.syncByBackupId(id));

        // Make sure it's still in mirror mode.
        {
            auto config = cb.syncConfigByBackupID(id);

            ASSERT_EQ(config.mBackupState, SYNC_BACKUP_MIRROR);
            ASSERT_EQ(config.mEnabled, true);
            ASSERT_EQ(config.mError, UNLOADING_SYNC);
        }

        // Get our hands on sync root's cloud handle.
        rootHandle = cb.syncSet(id).h;
        ASSERT_TRUE(!rootHandle.isUndef());

        // Make some changes to the cloud.
        vector<NewNode> node(1);

        cf->prepareOneFolder(&node[0], "g", false);

        ASSERT_TRUE(cf->putnodes(rootHandle, NoVersioning, std::move(node)));

        // Log out the client when we try and upload a file.
        std::promise<void> waiter;

        cb.mOnFileAdded = [&cb, &waiter, &id](File&)
        {
            // get the single sync
            SyncConfig config;
            ASSERT_TRUE(cb.client.syncs.syncConfigByBackupId(id, config));

            // Make sure we're mirroring.
            ASSERT_EQ(config.mBackupId, id);
            ASSERT_EQ(config.mSyncType, SyncConfig::TYPE_BACKUP);
            ASSERT_EQ(config.mBackupState, SYNC_BACKUP_MIRROR);

            // Notify the waiter.
            waiter.set_value();

            // Callback's done its job.
            cb.mOnFileAdded = nullptr;
        };

        // Resume the backup.
        ASSERT_TRUE(cb.enableSyncByBackupId(id, ""));

        // Wait for the sync to try and upload a file.
        ASSERT_TRUE(debugTolerantWaitOnFuture(waiter.get_future(), 45));

        // Save the session ID.
        cb.client.dumpsession(sessionID);

        // Log out the client.
        cb.localLogout();
    }

    // Create a couple new nodes.
    {
        vector<NewNode> nodes(2);

        cf->prepareOneFolder(&nodes[0], "h0", false);
        cf->prepareOneFolder(&nodes[1], "h1", false);

        ASSERT_TRUE(cf->putnodes(rootHandle, NoVersioning, std::move(nodes)));
    }

    // Check automatic resume.
    StandardClient cb(TESTROOT, "cb");

    // Log callbacks.
    cb.logcb = true;

    // So we can pause execution until al the syncs are restored.
    promise<void> notifier;

    // Hook the OnSyncStateConfig callback.
    cb.mOnSyncStateConfig = [&](const SyncConfig& config) {
        // Let waiters know we've restored the sync.
        if (config.mRunState == SyncRunState::Run)
            notifier.set_value();
    };

    // Log in client, resuming prior session.
    ASSERT_TRUE(cb.login_fetchnodesFromSession(sessionID));

    // Wait for the sync to be restored.
    ASSERT_NE(notifier.get_future().wait_for(std::chrono::seconds(8)),
              future_status::timeout);

    // Check config has been resumed.
    ASSERT_TRUE(cb.syncByBackupId(id));

    // Just let the sync mirror, Marge!
    waitonsyncs(TIMEOUT, &cb);

    // The cloud should match the local disk precisely.
    ASSERT_TRUE(cb.confirmModel_mainthread(m.root.get(), id));
}

#ifdef DEBUG

class BackupBehavior
  : public ::testing::Test
{
public:
    void doTest(const string& initialContent, const string& updatedContent);
}; // BackupBehavior

void BackupBehavior::doTest(const string& initialContent,
                            const string& updatedContent)
{
    auto TESTROOT = makeNewTestRoot();
    auto TIMEOUT  = std::chrono::seconds(8);

    StandardClient cu(TESTROOT, "cu");

    // Log callbacks.
    cu.logcb = true;

    // Log in uploader client.
    ASSERT_TRUE(cu.login_reset_makeremotenodes("MEGA_EMAIL", "MEGA_PWD", "s", 0, 0));

    // Add and start a backup sync.
    const auto idU = cu.setupSync_mainthread("su", "s", true, false);
    ASSERT_NE(idU, UNDEF);

    // Add a file for the engine to synchronize.
    Model m;

    m.addfile("f", initialContent);
    m.generate(cu.fsBasePath / "su");

    cu.triggerPeriodicScanEarly(idU);

    // Wait for the engine to process and upload the file.
    waitonsyncs(TIMEOUT, &cu);

    // Make sure the file made it to the cloud.
    ASSERT_TRUE(cu.confirmModel_mainthread(m.root.get(), idU));

    // Update file maintaining the mtime
    {
        const auto mtime = fs::last_write_time(cu.fsBasePath / "su" / "f");

        // Update the file's content.
        m.addfile("f", updatedContent);
        // Write the file.
        m.generate(cu.fsBasePath / "su", true);

        fs::last_write_time(cu.fsBasePath / "su" / "f", mtime);

        cu.triggerPeriodicScanEarly(idU);
    }

    // Wait for the engine to process the change.
    waitonsyncs(TIMEOUT, &cu);

    // Make sure the sync hasn't been disabled.
    {
        auto config = cu.syncConfigByBackupID(idU);

        ASSERT_EQ(config.mEnabled, true);
        ASSERT_EQ(config.mError, NO_SYNC_ERROR);
    }

    // Check that the file's been uploaded to the cloud.
    {
        StandardClient cd(TESTROOT, "cd");

        // Log in client.
        ASSERT_TRUE(cd.login_fetchnodes("MEGA_EMAIL", "MEGA_PWD"));

        // Add and start a new sync.
        auto idD = cd.setupSync_mainthread("sd", "s", false, false);
        ASSERT_NE(idD, UNDEF);

        // Wait for the sync to complete.
        waitonsyncs(TIMEOUT, &cd);

        // Make sure we haven't uploaded anything.
        ASSERT_TRUE(cu.confirmModel_mainthread(m.root.get(), idU));

        // Necessary since we've downloaded a file.
        m.ensureLocalDebrisTmpLock("");

        // Check that we've downloaded what we should've.
        ASSERT_TRUE(cd.confirmModel_mainthread(m.root.get(), idD));
    }
}

TEST_F(BackupBehavior, SameMTimeSmallerCRC)
{
    // File's small enough that the content is the CRC.
    auto initialContent = string("f");
    auto updatedContent = string("e");

    doTest(initialContent, updatedContent);
}

TEST_F(BackupBehavior, SameMTimeSmallerSize)
{
    auto initialContent = string("ff");
    auto updatedContent = string("f");

    doTest(initialContent, updatedContent);
}
#endif // DEBUG

TEST_F(SyncTest, RemoteReplaceDirectory)
{
    auto TESTROOT = makeNewTestRoot();

    // Sync client.
    StandardClient c(TESTROOT, "c");

    // Log callbacks.
    c.logcb = true;

    // Log in client.
    ASSERT_TRUE(c.login_reset_makeremotenodes("MEGA_EMAIL", "MEGA_PWD", "s", 0, 0));

    // Add and start sync.
    auto id = c.setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    // Populate local filesystem.
    Model m;

    m.addfile("x/d/f");
    m.addfile("x/d/g");
    m.addfile("d/f");
    m.addfile("d/g");
    //m.addfile("d/h");
    m.generate(c.syncSet(id).localpath);

    c.triggerPeriodicScanEarly(id);

    // Wait for initial sync to complete.
    waitonsyncs(chrono::seconds(4), &c);

    // Make sure everything made it to the cloud.
    ASSERT_TRUE(c.confirmModel_mainthread(m.root.get(), id));

    // Replace d/f with f.
    {
        StandardClient cr(TESTROOT, "cr");

        // Log callbacks.
        cr.logcb = true;

        // Log client in.
        ASSERT_TRUE(cr.login_fetchnodes("MEGA_EMAIL", "MEGA_PWD"));

        // Get our hands on x/d's node.
        auto node = cr.drillchildnodebyname(cr.gettestbasenode(), "s/x/d");
        ASSERT_NE(node, nullptr);

        {
            c.received_node_actionpackets = false;

            // Move d to x/d.
            ASSERT_TRUE(cr.movenode("s/d", "s/x"));

            // Wait for c to receive necessary action packets.
            ASSERT_TRUE(c.waitForNodesUpdated(8));

            // Wait for c to stall.
            ASSERT_TRUE(c.waitFor(SyncStallState(true), chrono::seconds(15)));

            c.received_node_actionpackets = false;

            // Remove the original x/d.
            ASSERT_TRUE(cr.deleteremote(node.get()));

            // Wait for c to receive cr's changes.
            ASSERT_TRUE(c.waitForNodesUpdated(8));

            // Wait for c to recover from the stall.
            ASSERT_TRUE(c.waitFor(SyncStallState(false), chrono::seconds(15)));
        }

        // Update model.
        m.movetosynctrash("x/d", "");
        m.movenode("d", "x");
    }

    // Wait for sync to complete.
    waitonsyncs(chrono::seconds(4), &c);

    // Did the sync complete successfully?
    ASSERT_TRUE(c.confirmModel_mainthread(m.root.get(), id));
}

TEST_F(SyncTest, RemoteReplaceFile)
{
    auto TESTROOT = makeNewTestRoot();

    // Sync client.
    StandardClient c(TESTROOT, "c");

    // Log callbacks.
    c.logcb = true;

    // Log in client.
    ASSERT_TRUE(c.login_reset_makeremotenodes("MEGA_EMAIL", "MEGA_PWD", "s", 0, 0));

    // Add and start sync.
    auto id = c.setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    // Populate local filesystem.
    Model m;

    m.addfile("d/f");
    m.addfile("f");
    m.generate(c.syncSet(id).localpath);

    c.triggerPeriodicScanEarly(id);

    // Wait for initial sync to complete.
    waitonsyncs(chrono::seconds(4), &c);

    // Make sure everything made it to the cloud.
    ASSERT_TRUE(c.confirmModel_mainthread(m.root.get(), id));

    c.received_node_actionpackets = false;

    // Replace d/f with f.
    {
        StandardClient cr(TESTROOT, "cr");

        // Log callbacks.
        cr.logcb = true;

        // Log client in.
        ASSERT_TRUE(cr.login_fetchnodes("MEGA_EMAIL", "MEGA_PWD"));

        // Get our hands on d/f's node.
        auto node = cr.drillchildnodebyname(cr.gettestbasenode(), "s/d/f");
        ASSERT_NE(node, nullptr);

        {
            // Move /f to /d/f.
            ASSERT_TRUE(cr.movenode("s/f", "s/d"));

            // Wait for c to stall.
            ASSERT_TRUE(c.waitFor(SyncStallState(true), chrono::seconds(15)));

            // Remove the original /d/f.
            ASSERT_TRUE(cr.deleteremote(node.get()));

            // Wait for c to recover from the stall.
            ASSERT_TRUE(c.waitFor(SyncStallState(false), chrono::seconds(15)));
        }

        // Update model.
        m.movetosynctrash("d/f", "");
        m.movenode("f", "d");
    }

    ASSERT_TRUE(c.waitForNodesUpdated(30)) << " no actionpacket received in c";

    // Wait for sync to complete.
    waitonsyncs(chrono::seconds(4), &c);

    // Did the sync complete successfully?
    ASSERT_TRUE(c.confirmModel_mainthread(m.root.get(), id));
}

class FilterFixture
  : public ::testing::Test
{
public:
    struct LocalFSModel
      : public Model
    {
        LocalFSModel() = default;

        LocalFSModel(const Model& other)
          : Model(other)
        {
        }

        LocalFSModel &operator=(const Model& other)
        {
            Model::operator=(other);
            return *this;
        }
    }; /* LocalFSModel */

    struct LocalNodeModel
      : public Model
    {
        LocalNodeModel() = default;

        LocalNodeModel(const Model& other)
          : Model(other)
        {
        }

        LocalNodeModel& operator=(const Model& other)
        {
            Model::operator=(other);
            return *this;
        }
    }; /* LocalNodeModel */

    struct RemoteNodeModel
      : public Model
    {
        RemoteNodeModel() = default;

        RemoteNodeModel(const Model& other)
          : Model(other)
        {
        }

        RemoteNodeModel& operator=(const Model& other)
        {
            Model::operator=(other);
            return *this;
        }
    }; /* RemoteNodeModel */

    FilterFixture()
      : filterFixureTestRoot(makeNewTestRoot())
      , cd(g_clientManager->getCleanStandardClient(0, filterFixureTestRoot))
      , cdu(g_clientManager->getCleanStandardClient(0, filterFixureTestRoot))
      , cu(g_clientManager->getCleanStandardClient(0, filterFixureTestRoot))
    {
        cd->logcb = true;
        cdu->logcb = true;
        cu->logcb = true;
    }

    void SetUp() override
    {
        ASSERT_TRUE(cd->resetBaseFolderMulticlient(cdu, cu));
    }

    bool confirm(StandardClient& client,
                 const handle id,
                 LocalFSModel& model,
                 const bool ignoreDebris = true,
                 const bool ignoreIgnoreFile = false)
    {
        return client.confirmModel_mainthread(
                 model.root.get(),
                 id,
                 ignoreDebris,
                 StandardClient::CONFIRM_LOCALFS,
                 false,
                 ignoreIgnoreFile);
    }

    bool confirm(StandardClient& client,
                 const handle id,
                 LocalNodeModel& model,
                 const bool ignoreDebris = true,
                 const bool ignoreIgnoreFile = false)
    {
        return client.confirmModel_mainthread(
                 model.root.get(),
                 id,
                 ignoreDebris,
                 StandardClient::CONFIRM_LOCALNODE,
                 false,
                 ignoreIgnoreFile);
    }

    bool confirm(StandardClient& client,
                 const handle id,
                 Model& model,
                 const bool ignoreDebris = true,
                 const bool ignoreIgnoreFile = false)
    {
        return client.confirmModel_mainthread(
                 model.root.get(),
                 id,
                 ignoreDebris,
                 StandardClient::CONFIRM_ALL,
                 false,
                 ignoreIgnoreFile);
    }

    bool confirm(StandardClient& client,
                 const handle id,
                 RemoteNodeModel& model,
                 const bool ignoreDebris = true,
                 const bool ignoreIgnoreFile = false)
    {
        return client.confirmModel_mainthread(
                 model.root.get(),
                 id,
                 ignoreDebris,
                 StandardClient::CONFIRM_REMOTE,
                 false,
                 ignoreIgnoreFile);
    }

    string debrisFilePath(const string& debrisName,
                          const string& path) const
    {
        ostringstream ostream;

        ostream << debrisName
                << "/"
                << todaysDate()
                << "/"
                << path;

        return ostream.str();
    }

    fs::path root(StandardClient& client) const
    {
        return client.fsBasePath;
    }

    handle setupSync(StandardClient& client,
                     const string& localFolder,
                     const string& remoteFolder,
                     bool uploadIgnoreFirst = true,
                     bool legacyExclusionsEligible = false)
    {
        SyncOptions options;

        options.legacyExclusionsEligible = legacyExclusionsEligible;
        options.uploadIgnoreFile = uploadIgnoreFirst;

        return client.setupSync_mainthread(localFolder, remoteFolder, options);
    }

    string todaysDate() const
    {
        size_t minimumLength = strlen("yyyy-mm-dd");

        string result(minimumLength + 1, 'X');

        time_t rawTime = time(nullptr);
        tm* localTime = localtime(&rawTime);

        strftime(&result[0], result.size(), "%F", localTime);
        result.resize(minimumLength);

        return result;
    }

    void waitOnSyncs(StandardClient* c0,
                     StandardClient* c1 = nullptr,
                     StandardClient* c2 = nullptr)
    {
        static chrono::seconds timeout(16);

        waitonsyncs(timeout, c0, c1, c2);
    }

    fs::path filterFixureTestRoot;

    // download client.
    StandardClientInUse cd;

    // download / upload client.
    StandardClientInUse cdu;

    // upload client.
    StandardClientInUse cu;
}; /* FilterFixture */

TEST_F(FilterFixture, AlreadySyncedFilterIsLoaded)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    ASSERT_TRUE(cdu->makeCloudSubdirs("x", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Populate local filesystem.
    localFS.addfile(".megaignore", "-:f\n-:g\n+sync:.megaignore");
    localFS.addfile("f");
    localFS.addfile("g");
    localFS.addfile("h");
    localFS.generate(root(cdu) / "root");

    // Populate cloud filesystem.
    {
        auto base = cdu->gettestbasenode();
        auto x = cdu->drillchildnodebyname(base, "x");

        // Upload .megaignore.
        ASSERT_TRUE(cdu->uploadFile(root(*cdu) / "root" / ".megaignore", *x));

        // Upload f.
        ASSERT_TRUE(cdu->uploadFile(root(*cdu) / "root" / "f", *x));
    }

    // Client shouldn't upload g as it will be excluded.
    remoteTree = localFS;
    remoteTree.removenode("g");

    // Client shouldn't download f as it will be excluded.
    localFS.removenode("f");
    fs::remove(root(*cdu) / "root" / "f");

    // Add and start sync.
    const auto id = setupSync(*cdu, "root", "x", false);
    ASSERT_NE(id, UNDEF);

    // Wait for the sync to complete.
    waitOnSyncs(cdu);

    // Confirm the models.
    ASSERT_TRUE(confirm(*cdu, id, localFS));
    ASSERT_TRUE(confirm(*cdu, id, remoteTree));
}

TEST_F(FilterFixture, CaseSensitiveFilter)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Set up filesystem.
    localFS.addfile("a/f");
    localFS.addfile("a/g");
    localFS.addfile("b/F");
    localFS.addfile("b/G");
    localFS.addfile(".megaignore", "-G:f\n-:g\n+sync:.megaignore");

    // Set up remote tree.
    remoteTree = localFS;
    remoteTree.removenode("a/f");
    remoteTree.removenode("a/g");
    remoteTree.removenode("b/G");

    // Log in client.
    ASSERT_TRUE(cu->makeCloudSubdirs("cu", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    localFS.generate(root(*cu) / "root");

    // Add and start sync.
    auto id = setupSync(*cu, "root", "cu", false);
    ASSERT_NE(id, UNDEF);

    // Wait for synchronization.
    waitOnSyncs(cu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));
}

TEST_F(FilterFixture, ExclusionSpecifiedWhenSyncAdded)
{
    // Make sure the sync root exists in the cloud.
    ASSERT_TRUE(cdu->makeCloudSubdirs("s", 0, 0));

    // Make sure we've received action packets before proceeding.
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Convenience.
    auto rootPath = cdu->fsBasePath / "s";

    // Populate the local filesystem.
    LocalFSModel localFS;

    localFS.addfolder("q");
    localFS.addfolder("r");
    localFS.generate(rootPath);

    // Setup the sync.
    auto id = UNDEF;

    {
        SyncOptions options;

        // s/q should be excluded by default.
        options.excludePath = path_u8string((u8path_compat("s") / u8path_compat("q")));

        // Add and start the sync.
        id = cdu->setupSync_mainthread("s", "s", options);
        ASSERT_NE(id, UNDEF);
    }

    // Wait for the initial sync to complete.
    waitOnSyncs(cdu);

    // Make sure nothing's changed on disk.
    ASSERT_TRUE(confirm(*cdu, id, localFS, true, true));

    // Make sure s/q wasn't uploaded to the cloud.
    RemoteNodeModel remoteTree;

    remoteTree.addfolder("r");

    ASSERT_TRUE(confirm(*cdu, id, remoteTree, true, true));
}

TEST_F(FilterFixture, FilterChangeWhileDownloading)
{
    // Random file data.
    const auto data = randomData(16384);

    // Ignore file data.
    const string ignoreFile = "-:f\n+sync:.megaignore";

    // Set up cloud.
    {
        // Build and generate model.
        Model model;

        model.addfile(".megaignore", "+sync:.megaignore");
        model.addfile("f", data);
        model.generate(root(*cu) / "root");

        // Create sync root.
        ASSERT_TRUE(cu->makeCloudSubdirs("x", 0, 0));
        ASSERT_TRUE(CatchupClients(cd, cdu, cu));

        // Add and start sync.
        auto id = setupSync(*cu, "root", "x", false);
        ASSERT_NE(id, UNDEF);

        // Wait for synchronization to complete.
        waitOnSyncs(cu);

        // Confirm model.
        ASSERT_TRUE(confirm(*cu, id, model));

        // Terminate the sync.
        ASSERT_TRUE(cu->delSync_mainthread(id));

        // Wait for the clients to agree on the state of the cloud.
        auto predicate = SyncRemoteMatch("x", model.root.get());

        ASSERT_TRUE(cd->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cdu->waitFor(predicate, DEFAULTWAIT));
    }

    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Set up local FS.
    localFS.addfile(".megaignore", ignoreFile);
    localFS.addfile("f", data);

    // Set up remote model.
    remoteTree = localFS;

    // Set download speed limit at 1kbps.
    cdu->setDownloadSpeed(1024);

    // So we know when f has started transferring.
    std::atomic<bool> downloadingf{false};

    // Exclude "f" once it begins downloading.
    cdu->mOnFileAdded = [&](File& file) {
        string name;

        file.displayname(&name);

        if (name != "f")
            return;

        // Let the completion callback know we've started downloading f.
        downloadingf.store(true);

        // now we write over .megaignore to make it ignore the file f that is downloading
        ASSERT_TRUE(createFile(root(*cdu) / "root" / ".megaignore",
                               ignoreFile.data(),
                               ignoreFile.size()));

        cdu->triggerPeriodicScanEarly(UNDEF);
    };

    // Remove download limit once .megaignore is uploaded.
    cdu->mOnFileComplete = [&](File& file) {
        // Wait until we've started uploading f.
        if (!downloadingf.load())
            return;

        string name;

        // What transfer has completed?
        file.displayname(&name);

        ASSERT_TRUE(name == ".megaignore"
                    || cdu->client.getmaxdownloadspeed() == 0);

        // Reset the speed limit when the ignore file has been uploaded.
        if (name == ".megaignore")
            cdu->client.setmaxdownloadspeed(0);
    };

    // Add and start sync.
    auto id = setupSync(*cdu, "root", "x", false);
    ASSERT_NE(id, UNDEF);

    // Wait for synchronization to complete.
    waitOnSyncs(cdu);

    // we expect the download to have been removed once we ignored the node
    localFS.removenode("f");

    // Confirm models.
    ASSERT_TRUE(confirm(*cdu, id, localFS));
    ASSERT_TRUE(confirm(*cdu, id, remoteTree));
}

TEST_F(FilterFixture, FilterChangeWhileUploading)
{
    // Random file data.
    const auto data = randomData(16384);

    // Ignore file data.
    const string ignoreFile = "-:f\n+sync:.megaignore";

    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Set up local FS.
    localFS.addfile("f", data);
    localFS.generate(root(*cdu) / "root");
    localFS.addfile(".megaignore", ignoreFile);

    // Set up remote tree.
    remoteTree = localFS;

    // Create sync root.
    ASSERT_TRUE(cdu->makeCloudSubdirs("x", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Set upload speed limit to 1kbps.
    cdu->setUploadSpeed(1024);

    cdu->mOnFileAdded =
      [&](File& file)
      {
          string name;

          file.displayname(&name);

          // remove speed limit when .megaignore starts uploading.
          if (name == ".megaignore")
          {
              cdu->client.setmaxuploadspeed(0);
          }

          // create .megaignore when f starts uploading.
          if (name == "f")
          {
              ASSERT_TRUE(createFile(root(*cdu) / "root" / ".megaignore",
                                     ignoreFile.data(),
                                     ignoreFile.size()));

              cdu->triggerPeriodicScanEarly(UNDEF);
          }
      };

    // Add and start sync.
    auto id = setupSync(*cdu, "root", "x", false);
    ASSERT_NE(id, UNDEF);

    // Wait for synchronization to complete.
    waitonsyncs(std::chrono::seconds(30), cdu);  // 16 was too short, when an upload failed and retried, succeeded on 2nd go but did not get to putnodes in time

    // we expect the upload to have been removed once we ignored the node
    remoteTree.removenode("f");

    // Confirm models.
    ASSERT_TRUE(confirm(*cdu, id, localFS));
    ASSERT_TRUE(confirm(*cdu, id, remoteTree));
}

TEST_F(FilterFixture, NameFilter)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Setup local FS.
    localFS.addfile(".megaignore",
                    // exclude all *.n* in the tree.
                    "-:*.n*\n"
                    // include all *.ni in the tree.
                    "+:*.ni\n"
                    // include all *.nN in the root.
                    "+N:*.nN\n"
                    // exclude all *.X* in the root.
                    "-N:*.X*\n"
                    // include all *.Xi in the root.
                    "+N:*.Xi\n"
                    "+sync:.megaignore");

    // excluded by -:*.n*
    localFS.addfile("d/df.n");
    // included by +:*.ni
    localFS.addfile("d/df.ni");
    // excluded by -:*.n*
    localFS.addfile("d/df.nN");
    // included as no matching exclusion rule.
    localFS.addfile("d/df.X");
    // excluded by -:*.n*
    localFS.addfile("f.n");
    // included by +:*.ni
    localFS.addfile("f.ni");
    // excluded by -:*.n*
    localFS.addfile("f.nN");
    // excluded by -N:*.X*
    localFS.addfile("f.X");
    // included by +N:*.Xi
    localFS.addfile("f.Xi");
    // excluded by -:*.n*
    localFS.addfile("d.n/f.ni");

    localFS.generate(root(*cu) / "root");

    // Setup remote tree.
    remoteTree = localFS;

    remoteTree.removenode("d/df.n");
    remoteTree.removenode("d/df.nN");
    remoteTree.removenode("f.n");
    remoteTree.removenode("f.X");
    remoteTree.removenode("d.n");

    // Log in client.
    ASSERT_TRUE(cu->makeCloudSubdirs("cu", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Add and start sync.
    auto id = setupSync(*cu, "root", "cu", false);
    ASSERT_NE(id, UNDEF);

    // Wait for sync to complete.
    waitOnSyncs(cu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));
}

TEST_F(FilterFixture, OrderDependentFilter)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Set up local filesystem.
    localFS.addfile(".megaignore", "-:a*\n+:ab*\n-:abc*\n+:abcd*\n+sync:.megaignore");
    localFS.addfile("a");
    localFS.addfile("ab");
    localFS.addfile("abc");
    localFS.addfile("abcd");
    localFS.generate(root(*cu) / "root");

    // a, abc are excluded from the remote node tree.
    remoteTree = localFS;
    remoteTree.removenode("a");
    remoteTree.removenode("abc");

    // Log in client.
    ASSERT_TRUE(cu->makeCloudSubdirs("cu", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Add and start sync.
    auto id = setupSync(*cu, "root", "cu", false);
    ASSERT_NE(id, UNDEF);

    // Wait for synchronization to complete.
    waitOnSyncs(cu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));
}

TEST_F(FilterFixture, PathFilter)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Setup local FS.
    localFS.addfile(".megaignore",
                    // exclude path d*/d*
                    "-p:d*/d*\n"
                    // include path di*/di*
                    "+p:di*/di*\n"
                    // include path dL
                    "+p:dL\n"
                    // include everything under dJ
                    "+p:dJ*\n"
                    "+sync:.megaignore");

    // excluded by -p:d*/d*
    localFS.addfile("d/d/f");
    // included as no matching rule.
    localFS.addfile("d/f");
    // included by +p:di*/di*
    localFS.addfile("di/di/f");
    // included as no matching rule.
    localFS.addfile("di/f");
    // excluded by -p:d*/d*
    localFS.addfile("dL/d/f");
    // included by +p:dL
    localFS.addfile("dL/f");
    // included by +p:dJ*
    localFS.addfile("dJ/d/f");
    localFS.addfile("dJ/f");

    localFS.generate(root(*cu) / "root");

    // Setup remote tree.
    remoteTree = localFS;
    remoteTree.removenode("d/d");
    remoteTree.removenode("dL/d");

    // Log in client.
    ASSERT_TRUE(cu->makeCloudSubdirs("cu", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Add and start sync.
    auto id = setupSync(*cu, "root", "cu", false);
    ASSERT_NE(id, UNDEF);

    // Wait for synchronization to complete.
    waitOnSyncs(cu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));
}

TEST_F(FilterFixture, TargetSpecificFilter)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Set up local filesystem.
    {
        const string ignoreFile =
          // Exclude directories matching *a.
          "-d:*a\n"
          // Exclude files matching *b.
          "-f:*b\n"
          // Exclude anything matching *c.
          "-:*c\n"
          // Include everything containing an x.
          "+:*x*\n"
          "+sync:.megaignore";

        localFS.addfile("da/fa", "fa");
        localFS.addfile("da/fb", "fb");
        localFS.addfile("da/fc", "fc");
        localFS.addfile("da/fxb", "fxb");
        localFS.addfile("da/fxc", "fxc");
        localFS.addfile(".megaignore", ignoreFile);
        localFS.addfile("fa");
        localFS.addfile("fb");
        localFS.addfile("fxb");
        localFS.addfile("fc");
        localFS.addfile("fxc");
        localFS.copynode("da", "db");
        localFS.copynode("da", "dc");
        localFS.copynode("da", "dxa");
        localFS.copynode("da", "dxc");

        localFS.generate(root(*cu) / "root");
    }

    // Set up rmote node tree.
    remoteTree = localFS;

    // Excluded by -d:*a
    remoteTree.removenode("da");

    // Excluded by -f:*b
    remoteTree.removenode("db/fb");
    remoteTree.removenode("dxa/fb");
    remoteTree.removenode("dxc/fb");
    remoteTree.removenode("fb");

    // Excluded by -:*c
    remoteTree.removenode("db/fc");
    remoteTree.removenode("dc");
    remoteTree.removenode("dxa/fc");
    remoteTree.removenode("dxc/fc");
    remoteTree.removenode("fc");

    // Log in the client.
    ASSERT_TRUE(cu->makeCloudSubdirs("cu", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Add and start the sync.
    auto id = setupSync(*cu, "root", "cu", false);
    ASSERT_NE(id, UNDEF);

    // Wait for synchronization to complete.
    waitOnSyncs(cu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));
}

class FilterFailureFixture
    : public FilterFixture
{
}; // FilterFailureFixture

TEST_F(FilterFailureFixture, ResolveBrokenIgnoreFile)
{
    // Convenience.
    const auto TIMEOUT = std::chrono::seconds(8);

    Model model0;
    Model model1;

    // Log in client.
    ASSERT_TRUE(cdu->makeCloudSubdirs("cdu", 1, 2));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Populate models.
    model0.addfile(".megaignore", "+sync:.megaignore");
    model0.generate(root(*cdu) / "s0");

    model1.addfile(".megaignore", "+sync:.megaignore");
    model1.addfile("f0");
    model1.generate(root(*cdu) / "s1");

    // Add and start syncs.
    auto id0 = setupSync(*cdu, "s0", "cdu/cdu_0", false);
    ASSERT_NE(id0, UNDEF);

    WaitMillisec(5000);  // give it a chance to upload .megaignore before we start the 2nd sync

    auto id1 = setupSync(*cdu, "s1", "cdu/cdu_1", false);
    ASSERT_NE(id1, UNDEF);

    // Wait for the initial sync to complete.
    waitOnSyncs(cdu);

    // Make sure everything's as we expect.
    ASSERT_TRUE(confirm(*cdu, id0, model0));
    ASSERT_TRUE(confirm(*cdu, id1, model1));

    // Break the ignore file.
    model0.addfile(".megaignore", "bad");
    model0.generate(root(*cdu) / "s0");

    cdu->triggerPeriodicScanEarly(id0);

    // Wait for the stall to be recognized.
    ASSERT_TRUE(cdu->waitFor(SyncStallState(true), TIMEOUT));

    // Pause the sync that owns the broken ignore file.
    ASSERT_TRUE(cdu->setSyncPausedByBackupId(id0, true));

    // Stall should be resolved.
    ASSERT_TRUE(cdu->waitFor(SyncStallState(false), TIMEOUT));

    // Check that the second sync is once again operating.
    model1.removenode("f0");

    fs::remove(root(*cdu) / "s1" / "f0");

    // Wait for the sync to complete.
    cdu->triggerPeriodicScanEarly(id1);
    waitOnSyncs(cdu);

    // Was the change synchronized?
    ASSERT_TRUE(confirm(*cdu, id1, model1));

    // Unpause the sync that owns the broken ignore file.
    ASSERT_TRUE(cdu->setSyncPausedByBackupId(id0, false));

    // The engine should stall again.
    ASSERT_TRUE(cdu->waitFor(SyncStallState(true), TIMEOUT));

    // Disable the stalled sync.
    ASSERT_TRUE(cdu->disableSync(id0, NO_SYNC_ERROR, false, true));

    // The engine should no longer be stalled.
    ASSERT_TRUE(cdu->waitFor(SyncStallState(false), TIMEOUT));

    // Re-add f0 and see if it gets uploaded.
    model1.addfile("f0");
    model1.generate(root(*cdu) / "s1");

    // Give the sync some time to process changes.
    cdu->triggerPeriodicScanEarly(id1);
    waitOnSyncs(cdu);

    // File should only be uploaded is s1 is operational.
    ASSERT_TRUE(confirm(*cdu, id1, model1));

    // Re-enable the disabled sync.
    ASSERT_TRUE(cdu->enableSyncByBackupId(id0, "s0 "));

    // The engine should stall again.
    ASSERT_TRUE(cdu->waitFor(SyncStallState(true), TIMEOUT));

    // Removing the sync should resolve the issue.
    ASSERT_TRUE(cdu->delSync_mainthread(id0));

    // Engine should no longer be stalled.
    ASSERT_TRUE(cdu->waitFor(SyncStallState(false), TIMEOUT));

    // Add a new file just to make sure the second sync is operating.
    model1.addfile("f1");
    model1.generate(root(*cdu) / "s1");

    // Give the engine some time to process our change.
    cdu->triggerPeriodicScanEarly(id1);
    waitOnSyncs(cdu);

    // f1 should exist in the cloud if the second sync is running.
    ASSERT_TRUE(confirm(*cdu, id1, model1));
}

TEST_F(FilterFailureFixture, TriggersStall)
{
    Model model;

    // Set up the local filesystem.
    model.addfile(".megaignore", "exclude-larger:4\nexclude-smaller:4\n+sync:.megaignore");
    model.generate(root(*cu) / "root");

    // Log in the client.
    ASSERT_TRUE(cu->makeCloudSubdirs("cu", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Hook the stall event.
    std::promise<void> notifier;

    cu->mOnStall = [&](bool stalled) {
        // Only notify the waiter when we become stalled.
        if (!stalled)
            return;

        // Notify the waiter.
        notifier.set_value();

        // Detach the callback.
        cu->mOnStall = nullptr;
    };

    // Add and start the sync.
    auto id = setupSync(*cu, "root", "cu", false);
    ASSERT_NE(id, UNDEF);

    // Wait for the engine to detect a stall.
    ASSERT_NE(notifier.get_future().wait_for(chrono::seconds(8)),
              future_status::timeout);

    // Was the ignore file correctly reported as the stall's cause?
    SyncStallInfoTests stalls;

    // Retrieve a list of stall causes from the client.
    ASSERT_TRUE(cu->syncStallDetected(stalls));

    // Make sure a stall was actually stored.
    ASSERT_FALSE(stalls.local.empty());

    auto& entry = *stalls.local.begin();

    // Was an ignore file behind the stall?
    ASSERT_EQ(entry.first.leafName(), IGNORE_FILE_NAME);

    // Was a load failure the cause of the stall?
    ASSERT_EQ(entry.second.reason, SyncWaitReason::FileIssue);
    ASSERT_EQ(entry.second.localPath1.problem, PathProblem::IgnoreFileMalformed);
}

class LocalToCloudFilterFixture
  : public FilterFixture
{
public:
    string debrisFilePath(const string& path) const
    {
        return FilterFixture::debrisFilePath("SyncDebris", path);
    }
}; /* LocalToCloudFilterFixture */

TEST_F(LocalToCloudFilterFixture, AcceptableFilterNameClash)
{
    const auto TIMEOUT = std::chrono::seconds(16);

    // Log in, taking care to reset the cloud's content.
    ASSERT_TRUE(cu->makeCloudSubdirs("s", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Populate the local filesystem.
    Model model;

    model.addfile("dl/fe");
    model.addfile("dl/fi");
    model.addfile(".megaignore", "-:fe\n+sync:.megaignore");
    model.generate(cu->fsBasePath / "s");

    // Populate the cloud.
    {
        // Convenience.
        auto ignoreFilePath = cu->fsBasePath / ".megaignore";

        // Create an ignore file for us to upload.
        ASSERT_TRUE(createFile(ignoreFilePath, "+sync:.megaignore"));

        // Upload the ignore file twice so to create a remote name clash.
        ASSERT_TRUE(cu->uploadFile(ignoreFilePath, "s"));
        ASSERT_TRUE(cu->uploadFile(ignoreFilePath, "s"));
    }

    // Add and start a sync.
    auto id = setupSync(*cu, "s", "s", false);
    ASSERT_NE(id, UNDEF);

    // Give the engine some time to detect the name clash.
    waitOnSyncs(cu);

    // Wait for the engine to detect the name clash.
    ASSERT_TRUE(cu->waitFor(SyncConflictState(true), TIMEOUT));

    // Make sure the clash is due to the ignore files.
    {
        list<NameConflict> conflicts;

        // Ask the engine what clashes it has detected.
        ASSERT_TRUE(cu->conflictsDetected(conflicts));

        // Clashes present?
        ASSERT_FALSE(conflicts.empty());

        const auto& conflict = conflicts.front();

        // Present at the sync root?
        ASSERT_EQ(conflict.cloudPath, "/mega_test_sync/s");

        // Two clashing names?
        ASSERT_EQ(conflict.clashingCloud.size(), 2u);

        // Both ignore files?
        ASSERT_EQ(conflict.clashingCloud[0].name, IGNORE_FILE_NAME);
        ASSERT_EQ(conflict.clashingCloud[1].name, IGNORE_FILE_NAME);
    }

    // Check that the engine uploaded what we expect.
    auto root = cu->gettestbasenode();

    // Get our hands on the cloud root.
    root = cu->drillchildnodebyname(root, "s");
    ASSERT_NE(root, nullptr);

    // Check that the directory "dl" has been uploaded.
    auto dl = cu->drillchildnodebyname(root, "dl");
    ASSERT_NE(dl, nullptr);

    // Check that the file "dl/fi" has been uploaded.
    ASSERT_NE(cu->drillchildnodebyname(dl, "fi"), nullptr);

    // Check that the file "dl/fe" has been skipped.
    ASSERT_EQ(cu->drillchildnodebyname(dl, "fe"), nullptr);

    // Locally removing the ignore file should clear any loaded filters.
    fs::remove(cu->fsBasePath / "s" / ".megaignore");

    // Give the engine some time to react to our changes.
    waitOnSyncs(cu);

    // Add a new file for the engine to try and synchronize.
    model.addfile("dl/fx");
    model.removenode(".megaignore");
    model.generate(cu->fsBasePath / "s");

    // Give the engine some time to process our changes.
    waitOnSyncs(cu);

    // "dl/fx" should not be synchronized.
    //
    // This is because there is no local ignore file present but there are
    // two ignore files in the cloud and the engine can't decide which of
    // the two it should download and read.
    //
    // That is, the filter state is undefined.
    //
    // The engine will not synchronize anything until the issue is resolved.
    ASSERT_EQ(cu->drillchildnodebyname(dl, "fx"), nullptr);

    // Remove one of the ignore files in the cloud.
    ASSERT_TRUE(cu->deleteremote("s/.megaignore"));

    // Wait for the engine to process the changes.
    waitOnSyncs(cu);

    // Wait for the name clash to be resolved.
    ASSERT_TRUE(cu->waitFor(SyncConflictState(false), TIMEOUT));

    // Ignore file's been downloaded.
    model.addfile(".megaignore", "+sync:.megaignore");
    model.ensureLocalDebrisTmpLock("");

    // No filters should be in effect and all files should be synchronized.
    ASSERT_TRUE(confirm(*cu, id, model, false));
}

TEST_F(LocalToCloudFilterFixture, DoesntDownloadIgnoredNodes)
{
    // Set up cloud.
    {
        Model model;

        model.addfile("d/f");
        model.addfile(".megaignore", "+sync:.megaignore");
        model.addfile("f");
        model.addfile("g", string(16, '!'));
        model.generate(root(*cu) / "root");

        ASSERT_TRUE(cu->makeCloudSubdirs("x", 0, 0));
        ASSERT_TRUE(CatchupClients(cd, cdu, cu));

        auto id = setupSync(*cu, "root", "x", false);
        ASSERT_NE(id, UNDEF);

        waitOnSyncs(cu);

        // Make sure everything was uploaded.
        ASSERT_TRUE(confirm(*cu, id, model));

        // Remove the sync.
        ASSERT_TRUE(cu->delSync_mainthread(id));

        // Wait for the clients to agree on the state of the cloud.
        auto predicate = SyncRemoteMatch("x", model.root.get());

        ASSERT_TRUE(cd->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cdu->waitFor(predicate, DEFAULTWAIT));
    }

    // Set up local FS.
    LocalFSModel localFS;

    localFS.addfile(".megaignore", "-:d\n-:f\nexclude-larger:15\n+sync:.megaignore");
    localFS.generate(root(*cd) / "root");

    // Set up local and remote trees.
    RemoteNodeModel remoteTree = localFS;

    remoteTree.addfile("d/f");
    remoteTree.addfile("f");
    remoteTree.addfile("g", string(16, '!'));

    // Add and start sync.
    auto id = setupSync(*cd, "root", "x", false);
    ASSERT_NE(id, UNDEF);

    // Wait for sync and confirm models.
    waitOnSyncs(cd);

    ASSERT_TRUE(confirm(*cd, id, localFS));
    ASSERT_TRUE(confirm(*cd, id, remoteTree));
}

TEST_F(LocalToCloudFilterFixture, DoesntMoveIgnoredNodes)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Setup local FS.
    localFS.addfile("0/fx");
    localFS.addfile(".megaignore", "+sync:.megaignore");
    localFS.addfolder("1");
    localFS.generate(root(*cu) / "root");

    // Setup remote note tree.
    remoteTree = localFS;

    // Log in the client.
    ASSERT_TRUE(cu->makeCloudSubdirs("cu", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Add and start sync.
    auto id = setupSync(*cu, "root", "cu", false);
    ASSERT_NE(id, UNDEF);

    // Wait for sync to complete.
    waitOnSyncs(cu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));

    // Filter out 0/fx.
    localFS.addfile("0/.megaignore", "-:*x\n+sync:.megaignore");
    localFS.generate(root(*cu) / "root");

    // Wait for the ignore file to be processed.
    cu->triggerPeriodicScanEarly(id);
    waitOnSyncs(cu);

    // 0/fx should remain in the cloud.
    // 1/fx should be added to the cloud.
    remoteTree = localFS;
    remoteTree.copynode("0/fx", "1/fx");

    // 0/fx should become 1/fx in both local models.
    localFS.copynode("0/fx", "1/fx");
    localFS.removenode("0/fx");

    // Rename 0/fx to 1/fx.
    fs::rename(root(*cu) / "root" / "0"/ "fx",
               root(*cu) / "root" / "1"/ "fx");

    // Wait for sync to complete.
    cu->triggerPeriodicScanEarly(id);
    waitOnSyncs(cu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));
}

TEST_F(LocalToCloudFilterFixture, DoesntRenameIgnoredNodes)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Setup local FS.
    localFS.addfile(".megaignore", "+sync:.megaignore");
    localFS.addfile("fx");
    localFS.generate(root(*cu) / "root");

    // Setup remote note tree.
    remoteTree = localFS;

    // Log in the client.
    ASSERT_TRUE(cu->makeCloudSubdirs("cu", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Add and start sync.
    auto id = setupSync(*cu, "root", "cu", false);
    ASSERT_NE(id, UNDEF);

    // Wait for sync to complete.
    waitOnSyncs(cu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));

    // Filter out fx.
    localFS.addfile(".megaignore", "-:*x\n+sync:.megaignore");
    localFS.generate(root(*cu) / "root");

    // fu should be added to the cloud.
    // fx should remain in the cloud.
    remoteTree = localFS;
    remoteTree.copynode("fx", "fu");

    // fx should beecome fu in both local models.
    localFS.copynode("fx", "fu");
    localFS.removenode("fx");

    // Rename fx to fu.
    fs::rename(root(*cu) / "root" / "fx",
               root(*cu) / "root" / "fu");

    // Wait for sync to complete.
    cu->triggerPeriodicScanEarly(id);
    waitOnSyncs(cu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));
}

TEST_F(LocalToCloudFilterFixture, DoesntRubbishIgnoredNodes)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Setup local FS.
    localFS.addfile(".megaignore", "+sync:.megaignore");
    localFS.addfile("fx");
    localFS.generate(root(*cu) / "root");

    // Setup remote note tree.
    remoteTree = localFS;

    // Log in the client.
    ASSERT_TRUE(cu->makeCloudSubdirs("cu", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Add and start sync.
    auto id = setupSync(*cu, "root", "cu", false);
    ASSERT_NE(id, UNDEF);

    // Wait for sync to complete.
    waitOnSyncs(cu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));

    // Filter out fx.
    localFS.addfile(".megaignore", "-:*x\n+sync:.megaignore");
    localFS.generate(root(*cu) / "root");

    // fx should remain in the cloud.
    remoteTree = localFS;

    // fx should no longer be visible in ether local model.
    localFS.removenode("fx");

    // Remove fx from the FS.
    ASSERT_TRUE(fs::remove(root(*cu) / "root" / "fx"));

    // Wait for sync to complete.
    cu->triggerPeriodicScanEarly(id);
    waitOnSyncs(cu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));
}

TEST_F(LocalToCloudFilterFixture, DoesntUploadIgnoredNodes)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Setup local FS.
    localFS.addfile("db/.megaignore", "exclude-smaller:8\nexclude-larger:16\n+sync:.megaignore");
    localFS.addfile("db/fe0", randomData(7));
    localFS.addfile("db/fe1", randomData(17));
    localFS.addfile("db/fi0", randomData(8));
    localFS.addfile("db/fi1", randomData(16));
    localFS.addfile("dl/.megaignore", "exclude-smaller:16\n+sync:.megaignore");
    localFS.addfile("dl/fe", randomData(15));
    localFS.addfile("dl/fi", randomData(16));
    localFS.addfile("du/.megaignore", "exclude-larger:16\n+sync:.megaignore");
    localFS.addfile("du/fe", randomData(17));
    localFS.addfile("du/fi", randomData(16));
    localFS.addfolder("dx");
    localFS.addfile("fu");
    localFS.addfile("fx");
    localFS.addfile(".megaignore", "-:*x\n+sync:.megaignore");
    localFS.generate(root(*cu) / "root");

    // Setup remote tree
    remoteTree = localFS;
    remoteTree.removenode("db/fe0");
    remoteTree.removenode("db/fe1");
    remoteTree.removenode("dl/fe");
    remoteTree.removenode("dr/fe0");
    remoteTree.removenode("dr/fe1");
    remoteTree.removenode("du/fe");
    remoteTree.removenode("dx");
    remoteTree.removenode("fx");

    // Log in client.
    ASSERT_TRUE(cu->makeCloudSubdirs("cu", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Add and start sync.
    auto id = setupSync(*cu, "root", "cu", false);
    ASSERT_NE(id, UNDEF);

    // Wait for synchronization to complete.
    waitOnSyncs(cu);

    // Confirm model expectations.
    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));

    // Update du/fi so that it violates the size filter.
    localFS.addfile("du/fi", randomData(32768));
    localFS.generate(root(*cu) / "root");

    // Wait for the change to be synchronized.
    //
    // This is expected as size filters have no effect if a file that
    // would be excluded exists locally and in the cloud.
    cu->triggerPeriodicScanEarly(id);
    waitOnSyncs(cu);

    // Remove the file locally.
    localFS.removenode("du/fi");
    fs::remove(root(*cu) / "root" / "du" / "fi");

    // It should also be removed in the cloud due to above.
    remoteTree.removenode("du/fi");

    // Wait for the sync to complete.
    cu->triggerPeriodicScanEarly(id);
    waitOnSyncs(cu);

    // Everything as we expect?
    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));
}

TEST_F(LocalToCloudFilterFixture, ExcludedIgnoreFile)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Populate local filesystem.
    localFS.addfile(".megaignore", "-N:f\n-:.megaignore\n+sync:.megaignore");
    localFS.addfile("d/.megaignore", "-:f\n+sync:.megaignore");
    localFS.addfile("d/f");
    localFS.addfile("d/g");
    localFS.addfile("e/.megaignore", "-:g\n+sync:.megaignore");
    localFS.addfile("e/f");
    localFS.addfile("e/g");
    localFS.addfile("f/.megaignore", "+sync:.megaignore");
    localFS.generate(root(*cu) / "root");

    remoteTree = localFS;

    // Excluded by /.megaignore.
    remoteTree.removenode("f");

    // Excluded by /d/.megaignore.
    remoteTree.removenode("d/f");

    // Excluded by /e/.megaignore.
    remoteTree.removenode("e/g");

    // Log in client.
    ASSERT_TRUE(cu->makeCloudSubdirs("cu", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Add and start sync.
    const auto id = setupSync(*cu, "root", "cu", false);
    ASSERT_NE(id, UNDEF);

    // Wait for the initial sync to complete.
    waitOnSyncs(cu);

    // Check everything that should've been uploaded, was.
    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));

    // Remove the root ignore file.
    localFS.removenode(".megaignore");
    remoteTree.removenode(".megaignore");

    fs::remove(root(*cu) / "root" / ".megaignore");

    // Which will cause these to be uploaded.
    remoteTree.addfile("f/.megaignore", "+sync:.megaignore");

    // Wait for the sync to complete.
    cu->triggerPeriodicScanEarly(id);
    waitOnSyncs(cu);

    // Check that the newly included ignore files were uploaded.
    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));
}


TEST_F(LocalToCloudFilterFixture, FilterAdded)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Setup local FS.
    localFS.addfile(".megaignore", "+sync:.megaignore");
    localFS.addfile("fu");
    localFS.addfile("fx");
    localFS.generate(root(*cu) / "root");

    // Setup local and remote trees.
    remoteTree = localFS;

    // Log in client.
    ASSERT_TRUE(cu->makeCloudSubdirs("cu", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Add and start sync.
    auto id = setupSync(*cu, "root", "cu", false);
    ASSERT_NE(id, UNDEF);

    // Wait for and confirm sync.
    waitOnSyncs(cu);

    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));

    // Add filter.
    localFS.addfile(".megaignore", "-:*x\n+sync:.megaignore");
    localFS.addfile("fxx");
    localFS.generate(root(*cu) / "root");

    // fxx should not be visible in remote tree.
    remoteTree = localFS;
    remoteTree.removenode("fxx");

    // Wait for and confirm sync.
    cu->triggerPeriodicScanEarly(id);
    waitOnSyncs(cu);

    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));
}


TEST_F(LocalToCloudFilterFixture, FilterChanged)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Setup local FS.
    localFS.addfile(".megaignore", "-:*y\nexclude-larger:2\n\n+sync:.megaignore");
    localFS.addfile("fx");
    localFS.addfile("fy");
    localFS.addfile("fz", "xxx");
    localFS.generate(root(*cu) / "root");

    // fy should not be present in the remote tree.
    remoteTree = localFS;
    remoteTree.removenode("fy");
    remoteTree.removenode("fz");

    // Log in client.
    ASSERT_TRUE(cu->makeCloudSubdirs("cu", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Add and start sync.
    auto id = setupSync(*cu, "root", "cu", false);
    ASSERT_NE(id, UNDEF);

    // Wait for and confirm sync.
    waitOnSyncs(cu);

    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));

    // Update filter.
    localFS.addfile(".megaignore", "-:*x\n+sync:.megaignore");
    localFS.generate(root(*cu) / "root");

    // f[xyz] should both be present in remote tree.
    remoteTree = localFS;

    // Wait for and confirm sync.
    cu->triggerPeriodicScanEarly(id);
    waitOnSyncs(cu);

    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));

    // Create a new folder, d, and move the ignore file into it.
    localFS.addfolder("d");
    localFS.generate(root(*cu) / "root");
    localFS.movenode(".megaignore", "d");

    remoteTree.addfolder("d");
    remoteTree.movenode(".megaignore", "d");

    fs::rename(root(*cu) / "root" / ".megaignore",
               root(*cu) / "root" / "d" / ".megaignore");

    // Wait for and confirm sync.
    cu->triggerPeriodicScanEarly(id);
    waitOnSyncs(cu);

    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));

    // Move the ignore file back to the root.
    localFS.movenode("d/.megaignore", "");
    remoteTree.movenode("d/.megaignore", "");

    fs::rename(root(*cu) / "root" / "d" / ".megaignore",
               root(*cu) / "root" / ".megaignore");

    // Remove fx locally.
    localFS.removenode("fx");

    fs::remove(root(*cu) / "root" / "fx");

    // Wait for and confirm sync.
    cu->triggerPeriodicScanEarly(id);
    waitOnSyncs(cu);

    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));
}

TEST_F(LocalToCloudFilterFixture, FilterDeferredChange)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Setup local FS.
    localFS.addfile("0/.megaignore", "-:f\n+sync:.megaignore");
    localFS.addfile("0/f");
    localFS.addfile("1/.megaignore", "-:g\n+sync:.megaignore");
    localFS.addfile("1/g");
    localFS.addfile(".megaignore", "-:?\n+sync:.megaignore");
    localFS.generate(root(*cu) / "root");

    // Setup remote tree.
    remoteTree = localFS;
    remoteTree.removenode("0");
    remoteTree.removenode("1");

    // Log in client.
    ASSERT_TRUE(cu->makeCloudSubdirs("cu", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Add and start sync.
    auto id = setupSync(*cu, "root", "cu", false);
    ASSERT_NE(id, UNDEF);

    // Wait for sync and confirm models.
    waitOnSyncs(cu);

    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));

    // Change 0/.megaignore.
    // Filter reload will be deferred.
    localFS.addfile("0/.megaignore", "#-:f\n+sync:.megaignore");
    localFS.generate(root(*cu) / "root");

    // Remove 1/.megaignore.
    // Filter clear will be deferred.
    localFS.removenode("1/.megaignore");

    ASSERT_TRUE(fs::remove(root(*cu) / "root" / "1" / ".megaignore"));

    // Wait for sync.
    // This should be a no-op as our changes are to ignored nodes.
    cu->triggerPeriodicScanEarly(id);
    waitOnSyncs(cu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));

    cu->received_node_actionpackets = false;

    // Remove .megaignore.
    // This should perform any pending filter reloads.
    ASSERT_TRUE(fs::remove(root(*cu) / "root" / ".megaignore"));

    cu->triggerPeriodicScanEarly(id);

    ASSERT_TRUE(cu->waitForNodesUpdated(30)) << " no actionpacket received in cu for remove";

    // Update models.
    localFS.removenode(".megaignore");

    remoteTree = localFS;

    // Wait for sync.
    waitOnSyncs(cu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));
}

TEST_F(LocalToCloudFilterFixture, FilterMovedAcrossHierarchy)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Setup local FS.
    localFS.addfile(".megaignore", "+sync:.megaignore");
    localFS.addfile("0/.megaignore", "-:x\n+sync:.megaignore");
    localFS.addfile("0/u");
    localFS.addfile("0/x");
    localFS.addfile("1/u");
    localFS.addfile("1/x");
    localFS.generate(root(*cu) / "root");

    // Setup remote tree.
    remoteTree = localFS;
    remoteTree.removenode("0/x");

    // Log in client.
    ASSERT_TRUE(cu->makeCloudSubdirs("cu", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Add and start sync.
    auto id = setupSync(*cu, "root", "cu", false);
    ASSERT_NE(id, UNDEF);

    // Wait for sync and confirm models.
    waitOnSyncs(cu);

    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));

    // Move 0/.megaignore to 1.
    fs::rename(root(*cu) / "root" / "0" / ".megaignore",
               root(*cu) / "root" / "1" / ".megaignore");

    localFS.movenode("0/.megaignore", "1");

    // Update local and remote trees.
    remoteTree = localFS;

    // Wait for synchronization.
    cu->triggerPeriodicScanEarly(id);
    waitOnSyncs(cu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));
}

TEST_F(LocalToCloudFilterFixture, FilterMovedBetweenSyncs)
{
    LocalFSModel s0LocalFS;
    LocalFSModel s1LocalFS;
    RemoteNodeModel s0RemoteTree;
    RemoteNodeModel s1RemoteTree;

    // Sync 0
    {
        // Set up local FS.
        s0LocalFS.addfile(".megaignore", "+sync:.megaignore");
        s0LocalFS.addfile("d/.megaignore", "-:x\n+sync:.megaignore");
        s0LocalFS.addfile("d/x");
        s0LocalFS.generate(root(*cdu) / "s0");

        // Set up remote tree.
        s0RemoteTree = s0LocalFS;
        s0RemoteTree.removenode("d/x");
    }

    // Sync 1
    {
        // Set up local FS.
        s1LocalFS.addfile(".megaignore", "+sync:.megaignore");
        s1LocalFS.addfile("d/x");
        s1LocalFS.generate(root(*cdu) / "s1");

        // Set up remote tree.
        s1RemoteTree = s1LocalFS;
    }

    // Create sync directories.
    {
        // Will be freed by putnodes_result(...).
        vector<NewNode> nodes(2);

        cdu->prepareOneFolder(&nodes[0], "s0", false);
        cdu->prepareOneFolder(&nodes[1], "s1", false);

        std::shared_ptr<Node> root = cdu->gettestbasenode();

        ASSERT_TRUE(cdu->putnodes(root->nodeHandle(), NoVersioning, std::move(nodes)));

        ASSERT_TRUE(cdu->drillchildnodebyname(root, "s0"));
        ASSERT_TRUE(cdu->drillchildnodebyname(root, "s1"));
    }

    // Add and start syncs.
    auto id0 = setupSync(*cdu, "s0", "s0", false);
    ASSERT_NE(id0, UNDEF);

    WaitMillisec(5000);  // give it a chance to upload .megaignore before we start the 2nd sync

    auto id1 = setupSync(*cdu, "s1", "s1", false);
    ASSERT_NE(id1, UNDEF);

    // Wait for synchronization to complete.
    waitOnSyncs(cdu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cdu, id0, s0LocalFS));
    ASSERT_TRUE(confirm(*cdu, id0, s0RemoteTree));

    ASSERT_TRUE(confirm(*cdu, id1, s1LocalFS));
    ASSERT_TRUE(confirm(*cdu, id1, s1RemoteTree));

    // Move cdu/s0/d/.megaignore to cdu/s1/d/.megaignore.
    fs::rename(root(*cdu) / "s0" / "d" / ".megaignore",
               root(*cdu) / "s1" / "d" / ".megaignore");

    // Wait for synchronization to complete.
    cdu->triggerPeriodicScanEarly(id0);
    cdu->triggerPeriodicScanEarly(id1);
    waitOnSyncs(cdu);

    // .megaignore no longer exists in cdu/s0.
    // as a consequence, cdu/s0/x is no longer ignored.
    s0LocalFS.removenode("d/.megaignore");

    s0RemoteTree.removenode("d/.megaignore");
    s0RemoteTree.addfile("d/x");

    // .megaignore has been added to cdu/s1/d.
    // as a consequence, cdu/s1/d/x is now ignored.
    s1LocalFS.addfile("d/.megaignore", "-:x\n+sync:.megaignore");

    s1RemoteTree = s1LocalFS;

    // Confirm models.
    ASSERT_TRUE(confirm(*cdu, id0, s0LocalFS));
    ASSERT_TRUE(confirm(*cdu, id0, s0RemoteTree));

    ASSERT_TRUE(confirm(*cdu, id1, s1LocalFS));
    ASSERT_TRUE(confirm(*cdu, id1, s1RemoteTree));

    // Add a new .megaignore to cdu/s0/d.
    // Add cdu/s0/d/y for it to ignore.
    s0LocalFS.addfile("d/.megaignore", "-:y\n+sync:.megaignore");
    s0LocalFS.addfile("d/y");
    s0LocalFS.generate(root(*cdu) / "s0");

    s0RemoteTree = s0LocalFS;
    s0RemoteTree.removenode("d/y");

    // Add cdu/s1/y.
    s1LocalFS.addfile("d/y");
    s1LocalFS.generate(root(*cdu) / "s1");

    s1RemoteTree.addfile("d/y");

    // Wait for synchronization to complete.
    cdu->triggerPeriodicScanEarly(id0);
    cdu->triggerPeriodicScanEarly(id1);
    waitOnSyncs(cdu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cdu, id0, s0LocalFS));
    ASSERT_TRUE(confirm(*cdu, id0, s0RemoteTree));

    ASSERT_TRUE(confirm(*cdu, id1, s1LocalFS));
    ASSERT_TRUE(confirm(*cdu, id1, s1RemoteTree));

    // Move cdu/s0/d/.megaignore to cdu/s1/d/.megaignore.
    fs::rename(root(*cdu) / "s0" / "d" / ".megaignore",
               root(*cdu) / "s1" / "d" / ".megaignore");

    // Wait for synchronization to complete.
    cdu->triggerPeriodicScanEarly(id0);
    cdu->triggerPeriodicScanEarly(id1);
    waitOnSyncs(cdu);

    // .megaignore no longer exists in cdu/s0/d.
    // as a consequence, cdu/s0/d/y is no longer ignored.
    s0LocalFS.removenode("d/.megaignore");

    s0RemoteTree.removenode("d/.megaignore");
    s0RemoteTree.addfile("d/y");

    // cdu/s1/d/.megaignore has been overwritten.
    // as a consequence, cdu/s1/d/x is no longer ignored.
    // as a consequence, cdu/s1/d/y is ignored.
    s1LocalFS.addfile("d/.megaignore", "-:y\n+sync:.megaignore");

    s1RemoteTree = s1LocalFS;

    // Confirm models.
    ASSERT_TRUE(confirm(*cdu, id0, s0LocalFS));
    ASSERT_TRUE(confirm(*cdu, id0, s0RemoteTree));

    ASSERT_TRUE(confirm(*cdu, id1, s1LocalFS));
    ASSERT_TRUE(confirm(*cdu, id1, s1RemoteTree));
}

TEST_F(LocalToCloudFilterFixture, FilterMovedDownHierarchy)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Setup local FS.
    localFS.addfile(".megaignore", "-:x\n+sync:.megaignore");
    localFS.addfile("0/u");
    localFS.addfile("0/x");
    localFS.addfile("1/u");
    localFS.addfile("1/x");
    localFS.addfolder("2/0");
    localFS.addfile("2/.megaignore", "-:.megaignore\n+sync:.megaignore");
    localFS.generate(root(*cu) / "root");

    // Setup remote tree.
    remoteTree = localFS;
    remoteTree.removenode("0/x");
    remoteTree.removenode("1/x");

    // Log in client.
    ASSERT_TRUE(cu->makeCloudSubdirs("cu", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Add and start sync.
    auto id = setupSync(*cu, "root", "cu", false);
    ASSERT_NE(id, UNDEF);

    // Wait for sync and confirm models.
    waitOnSyncs(cu);

    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));

    // Move 0/.megaignore to root.
    fs::rename(root(*cu) / "root" / ".megaignore",
               root(*cu) / "root" / "0" / ".megaignore");

    localFS.movenode(".megaignore", "0");

    // 1/x is now visible in the local and remote trees.
    remoteTree = localFS;
    remoteTree.removenode("0/x");

    // Move 2/.megaignore to 2/0/.megaignore.
    localFS.movenode("2/.megaignore", "2/0");
    remoteTree.movenode("2/.megaignore", "2/0");

    fs::rename(root(*cu) / "root" / "2" / ".megaignore",
               root(*cu) / "root" / "2" / "0" / ".megaignore");

    // Wait for synchronization.
    cu->triggerPeriodicScanEarly(id);
    waitOnSyncs(cu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));
}

TEST_F(LocalToCloudFilterFixture, FilterMovedIntoExcluded)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Set up local FS.
    localFS.addfile(".megaignore", "-:d*\n-:f*\n\n+sync:.megaignore");
    localFS.addfile("d/g");
    localFS.addfile("f");
    localFS.generate(root(*cu) / "root");

    // Only the ignore file is visible in the cloud.
    remoteTree = localFS;
    remoteTree.removenode("d");
    remoteTree.removenode("f");

    // Log in client.
    ASSERT_TRUE(cu->makeCloudSubdirs("cu", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Add and start sync.
    auto id = setupSync(*cu, "root", "cu", false);
    ASSERT_NE(id, UNDEF);

    // Wait for sync and confirm models.
    waitOnSyncs(cu);

    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));

    // Move ignore file into excluded directory.
    localFS.movenode(".megaignore", "d");

    fs::rename(root(*cu) / "root" / ".megaignore",
               root(*cu) / "root" / "d" / ".megaignore");

    // Remote tree is the same as FS.
    remoteTree = localFS;

    // Wait for sync to complete.
    cu->triggerPeriodicScanEarly(id);
    waitOnSyncs(cu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));
}

TEST_F(LocalToCloudFilterFixture, FilterMovedUpHierarchy)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Setup local FS.
    localFS.addfile("0/.megaignore", "-:x\n+sync:.megaignore");
    localFS.addfile("0/u");
    localFS.addfile("0/x");
    localFS.addfile("1/u");
    localFS.addfile("1/x");
    localFS.addfile("2/0/.megaignore", "-:.megaignore\n+sync:.megaignore");
    localFS.addfile(".megaignore", "+sync:.megaignore");
    localFS.generate(root(*cu) / "root");

    // Setup remote trees.
    remoteTree = localFS;
    remoteTree.removenode("0/x");

    // Log in client.
    ASSERT_TRUE(cu->makeCloudSubdirs("cu", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Add and start sync.
    auto id = setupSync(*cu, "root", "cu", false);
    ASSERT_NE(id, UNDEF);

    // Wait for sync and confirm models.
    waitOnSyncs(cu);

    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));

    // Move 0/.megaignore to root.
    fs::rename(root(*cu) / "root" / "0" / ".megaignore",
               root(*cu) / "root" / ".megaignore");

    localFS.removenode(".megaignore");
    localFS.movenode("0/.megaignore", "");

    // All nodes except for 0/x are visible in the remote tree.
    remoteTree = localFS;
    remoteTree.removenode("0/x");

    // Move 2/0/.megaignore to 2/.megaignore.
    localFS.movenode("2/0/.megaignore", "2");
    remoteTree.movenode("2/0/.megaignore", "2");

    fs::rename(root(*cu) / "root" / "2" / "0" / ".megaignore",
               root(*cu) / "root" / "2" / ".megaignore");

    // Wait for synchronization.
    cu->triggerPeriodicScanEarly(id);
    waitOnSyncs(cu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));
}

TEST_F(LocalToCloudFilterFixture, FilterNameClash)
{
    auto TIMEOUT = std::chrono::seconds(16);

    // Log in the client and clear the cloud.
    ASSERT_TRUE(cu->makeCloudSubdirs("s", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    Model model;

    // Populate the local filesystem.
    model.addfolder("d");
    model.addfile(".megaignore", "+sync:.megaignore");
    model.addfile(".megaignore", "#")->fsName(".%6degaignore");
    model.generate(cu->fsBasePath / "s");

    // Add and start a sync.
    auto id = setupSync(*cu, "s", "s", false);
    ASSERT_NE(id, UNDEF);

    // Give the engine some time to detect the name conflicts.
    waitOnSyncs(cu);

    // Wait for the engine to detect the name conflicts.
    ASSERT_TRUE(cu->waitFor(SyncConflictState(true), TIMEOUT));

    list<NameConflict> conflicts;

    // Ask the engine what name conflicts it has detected.
    ASSERT_TRUE(cu->conflictsDetected(conflicts));

    // Make sure the list of conflicts isn't empty.
    ASSERT_FALSE(conflicts.empty());

    // Make sure the conflcit is due to the ignore files.
    const auto& conflict = conflicts.front();

    // Detected at sync root?
    ASSERT_EQ(conflict.localPath.toPath(false), path_u8string((cu->fsBasePath / "s")));

    // Two local name clashes detected?
    ASSERT_EQ(conflict.clashingLocalNames.size(), 2u);

    // Both ignore files?
    {
        auto isIgnoreFile = [](const LocalPath& name) {
            // No ambiguity, thanks.
            const LocalPath& ignoreFileName = IGNORE_FILE_NAME;

            // Compare the name, taking care to decode any escapes.
            return !platformCompareUtf(name, true, ignoreFileName, false);
        };

        ASSERT_TRUE(isIgnoreFile(conflict.clashingLocalNames[0]));
        ASSERT_TRUE(isIgnoreFile(conflict.clashingLocalNames[1]));
    }

    // Make sure we didn't upload the "d" directory.
    ASSERT_EQ(cu->drillchildnodebyname(cu->gettestbasenode(), "s/d"), nullptr);
}

TEST_F(LocalToCloudFilterFixture, FilterOverwritten)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Setup local FS.
    localFS.addfile(".megaignore", "-:*x\n+sync:.megaignore");
    localFS.addfile("fu");
    localFS.addfile("fx");
    localFS.addfile("megaignore", "-:*u\n+sync:.megaignore");
    localFS.generate(root(*cu) / "root");

    // Setup remote tree.
    remoteTree = localFS;
    remoteTree.removenode("fx");

    // Log in to client.
    ASSERT_TRUE(cu->makeCloudSubdirs("cu", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Add and start sync.
    auto id = setupSync(*cu, "root", "cu", false);
    ASSERT_NE(id, UNDEF);

    // Wait for synchronization to complete.
    waitOnSyncs(cu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));

    // Move megaignore over .megaignore
    fs::rename(root(*cu) / "root" / "megaignore",
               root(*cu) / "root" / ".megaignore");

    localFS.removenode(".megaignore");
    localFS.copynode("megaignore", ".megaignore");
    localFS.removenode("megaignore");

    // f[ux] should be visible in the remote tree.
    remoteTree = localFS;

    // Wait for synchronization to complete.
    cu->triggerPeriodicScanEarly(id);
    waitOnSyncs(cu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));
}

TEST_F(LocalToCloudFilterFixture, FilterRemoved)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Setup local FS.
    localFS.addfile(".megaignore", "-:*x\n+sync:.megaignore");
    localFS.addfile("fx");
    localFS.generate(root(*cu) / "root");

    // Setup remote trees.
    remoteTree = localFS;
    remoteTree.removenode("fx");

    // Log in client.
    ASSERT_TRUE(cu->makeCloudSubdirs("cu", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Add and start sync.
    auto id = setupSync(*cu, "root", "cu", false);
    ASSERT_NE(id, UNDEF);

    // Wait for and confirm sync.
    waitOnSyncs(cu);

    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));

    // Remove filter from FS.
    localFS.removenode(".megaignore");

    ASSERT_TRUE(fs::remove(root(*cu) / "root" / ".megaignore"));

    // fx should be present in remote tree.
    remoteTree = localFS;

    // Wait for and confirm sync.
    cu->triggerPeriodicScanEarly(id);
    waitOnSyncs(cu);

    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));
}

TEST_F(LocalToCloudFilterFixture, MoveToIgnoredRubbishesRemote)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Setup local FS.
    localFS.addfile("1/.megaignore", "-:f\nexclude-larger:1\n\n+sync:.megaignore");
    localFS.addfile("0/f", "f");
    localFS.addfile("0/g", "gg");
    localFS.addfile(".megaignore", "+sync:.megaignore");
    localFS.generate(root(*cu) / "root");

    // Setup remote tree.
    remoteTree = localFS;

    // Log in client.
    ASSERT_TRUE(cu->makeCloudSubdirs("cu", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Ensure remote debris is clear.
    ASSERT_TRUE(cu->deleteremotedebris());

    // Add and start sync.
    auto id = setupSync(*cu, "root", "cu", false);
    ASSERT_NE(id, UNDEF);

    // Wait for sync to complete and confirm models.
    waitOnSyncs(cu);

    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));

    // Move 0/f to 1/f.
    fs::rename(root(*cu) / "root" / "0" / "f",
               root(*cu) / "root" / "1" / "f");

    localFS.movenode("0/f", "1");

    // Move 0/g to 1/g.
    fs::rename(root(*cu) / "root" / "0" / "g",
               root(*cu) / "root" / "1" / "g");

    localFS.movenode("0/g", "1");

    // Neither 0/f or 1 are present in local or remote tree.
    remoteTree = localFS;
    remoteTree.removenode("1/f");

    remoteTree.removenode("1/g");

    // Wait for sync to complete.
    cu->triggerPeriodicScanEarly(id);
    waitOnSyncs(cu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));

    // Verify that 0/f was moved into the remote debris.
    std::shared_ptr<Node> u = cu->drillchildnodebyname(cu->getcloudrubbishnode(),
                                       debrisFilePath("f"));
    ASSERT_TRUE(u);
}

TEST_F(LocalToCloudFilterFixture, OverwriteExcluded)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Set up local FS.
    localFS.addfile("d/f");
    localFS.addfile("d/.megaignore", "+:f\n+sync:.megaignore");
    localFS.addfile("f");
    localFS.addfile(".megaignore", "+sync:.megaignore");
    localFS.generate(root(*cdu) / "root");

    // Remote tree is consistent with FS.
    remoteTree = localFS;

    // Log in client.
    ASSERT_TRUE(cdu->makeCloudSubdirs("x", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Add and start sync.
    auto id = setupSync(*cdu, "root", "x", false);
    ASSERT_NE(id, UNDEF);

    // Wait for sync to complete.
    waitOnSyncs(cdu);

    // Confirm.
    ASSERT_TRUE(confirm(*cdu, id, localFS));
    ASSERT_TRUE(confirm(*cdu, id, remoteTree));

    // Add ignore file.
    localFS.addfile(".megaignore", "-:f\n+sync:.megaignore");
    localFS.generate(root(*cdu) / "root");

    // Remote is consistent with FS.
    remoteTree = localFS;

    // Wait for sync to complete.
    cdu->triggerPeriodicScanEarly(id);
    waitOnSyncs(cdu);

    // Confirm.
    ASSERT_TRUE(confirm(*cdu, id, localFS));
    ASSERT_TRUE(confirm(*cdu, id, remoteTree));

    // Move x/d/f (where it is not ignored) to x/f (where it is ignored) (overwriting the f that was there already).
    fs::rename(root(*cdu) / "root" / "d" / "f",
               root(*cdu) / "root" / "f");

    // Update models.
    localFS.removenode("f");
    localFS.movenode("d/f", "");

    remoteTree.removenode("d/f");

    // Wait for sync to complete.
    cdu->triggerPeriodicScanEarly(id);
    waitOnSyncs(cdu);

    // Confirm.
    ASSERT_TRUE(confirm(*cdu, id, localFS));
    ASSERT_TRUE(confirm(*cdu, id, remoteTree));
}

TEST_F(LocalToCloudFilterFixture, RenameToIgnoredRubbishesRemote)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Setup local FS.
    localFS.addfile(".megaignore", "-:x\n+sync:.megaignore");
    localFS.addfile("u");
    localFS.generate(root(*cu) / "root");

    // Setup remote tree.
    remoteTree = localFS;

    // Log in client.
    ASSERT_TRUE(cu->makeCloudSubdirs("cu", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Ensure remote debris is clear.
    ASSERT_TRUE(cu->deleteremotedebris());
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Add and start sync.
    auto id = setupSync(*cu, "root", "cu", false);
    ASSERT_NE(id, UNDEF);

    // Wait for sync to complete and confirm models.
    waitOnSyncs(cu);

    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));

    // Rename u to x.
    fs::rename(root(*cu) / "root" / "u",
               root(*cu) / "root" / "x");

    localFS.copynode("u", "x");
    localFS.removenode("u");

    // u is no longer present in remote tree.
    remoteTree.removenode("u");

    // Wait for sync to complete.
    cu->triggerPeriodicScanEarly(id);
    waitOnSyncs(cu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));

    // Verify that u was moved into the remote debris.
    std::shared_ptr<Node> u = cu->drillchildnodebyname(cu->getcloudrubbishnode(),
                                       debrisFilePath("u"));
    ASSERT_TRUE(u);
}

TEST_F(LocalToCloudFilterFixture, RenameReplaceIgnoreFile)
{
    // Log in client.
    ASSERT_TRUE(cu->makeCloudSubdirs("cu", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Add and start sync.
    auto id = setupSync(*cu, "root", "cu", false);
    ASSERT_NE(id, UNDEF);

    auto root = cu->syncSet(id).localpath;

    // Populate local filesystem.
    Model model;

    model.addfile("d0/.megaignore", "+sync:.megaignore");
    model.addfile("d1/.megaignore", "+sync:.megaignore");
    model.addfile(".megaignore", "+:.*\n+sync:.megaignore");
    model.generate(root);

    // Wait for initial sync to complete.
    cu->triggerPeriodicScanEarly(id);
    waitOnSyncs(cu);

    // Make sure our hierarchy made it the cloud.
    ASSERT_TRUE(confirm(*cu, id, model));

    // Rename/Replace d0/.megaignore
    {
        // Rename .megaignore -> f
        model.addfile("d0/f", "+sync:.megaignore");

        fs::rename(root / "d0" / ".megaignore",
                   root / "d0" / "f");

        // Replace .megaignore
        model.findnode("d0/.megaignore")->content = "-:x\n+sync:.megaignore";

        ASSERT_TRUE(createFile(root / "d0" / ".megaignore", "-:x\n+sync:.megaignore"));
    }

    // Wait for synchronization to complete.
    cu->triggerPeriodicScanEarly(id);
    waitOnSyncs(cu);

    // Did the changes make it to the cloud?
    ASSERT_TRUE(confirm(*cu, id, model));

    // Rename/Replace d1/.megaignore
    {
        // Rename .megaignore -> .f
        model.addfile("d1/.f", "+sync:.megaignore");

        fs::rename(root / "d1" / ".megaignore",
                   root / "d1" / ".f");

        // Replace .megaignore
        model.findnode("d1/.megaignore")->content = "-:y\n+sync:.megaignore";

        ASSERT_TRUE(createFile(root / "d1" / ".megaignore", "-:y\n+sync:.megaignore"));
    }

    // Wait for synchronization to complete.
    cu->triggerPeriodicScanEarly(id);
    waitOnSyncs(cu);

    // Did the changes make it to the cloud?
    ASSERT_TRUE(confirm(*cu, id, model));

    // Make sure the ignore files were actually reloaded.
    LocalFSModel localFS = model;
    RemoteNodeModel remoteTree = model;

    localFS.addfile("d0/x", "x");
    localFS.addfile("d1/y", "y");

    ASSERT_TRUE(createFile(root / "d0" / "x", "x"));
    ASSERT_TRUE(createFile(root / "d1" / "y", "y"));

    cu->triggerPeriodicScanEarly(id);
    waitOnSyncs(cu);

    ASSERT_TRUE(confirm(*cu, id, localFS));
    ASSERT_TRUE(confirm(*cu, id, remoteTree));
}

class CloudToLocalFilterFixture
  : public FilterFixture
{
public:
    string debrisFilePath(const string& path) const
    {
        return FilterFixture::debrisFilePath(MEGA_DEBRIS_FOLDER, path);
    }
}; /* CloudToLocalFilterFixture */

TEST_F(CloudToLocalFilterFixture, DoesntDownloadIgnoredNodes)
{
    RemoteNodeModel remoteTree;

    // Set up cloud.
    {
        // Convenience.
        auto lRoot = root(*cu) / "x";
        auto rRoot = cu->gettestbasenode();

        // Populate filesystem.
        // (fe = file excluded, fi = file included)
        remoteTree.addfile(".megaignore", "-:f\n+sync:.megaignore");
        remoteTree.addfile("d/f");
        remoteTree.addfile("d/g");
        remoteTree.addfile("db/.megaignore", "exclude-smaller:8\nexclude-larger:16");
        remoteTree.addfile("db/fe0", randomData(7));
        remoteTree.addfile("db/fe1", randomData(17));
        remoteTree.addfile("db/fi0", randomData(8));
        remoteTree.addfile("db/fi1", randomData(16));
        remoteTree.addfile("dl/.megaignore", "exclude-smaller:16");
        remoteTree.addfile("dl/fe", randomData(15));
        remoteTree.addfile("dl/fi", randomData(16));
        remoteTree.addfile("du/.megaignore", "exclude-larger:16");
        remoteTree.addfile("du/fe", randomData(17));
        remoteTree.addfile("du/fi", randomData(16));
        remoteTree.addfile("dr/.megaignore",
                           "exclude-smaller:16\nexclude-larger:8"); // exclude in-range [8-16]
        remoteTree.addfile("dr/fe0", randomData(8));
        remoteTree.addfile("dr/fe1", randomData(16));
        remoteTree.addfile("dr/fe2", randomData(9));
        remoteTree.addfile("dr/fe3", randomData(15));
        remoteTree.addfile("dr/fi0", randomData(7));
        remoteTree.addfile("dr/fi1", randomData(17));
        remoteTree.addfile("dr/fi2", randomData(0));
        remoteTree.addfile("f");
        remoteTree.addfile("g");
        remoteTree.generate(lRoot);

        // Create directories.
        ASSERT_TRUE(cu->uploadFolderTree(lRoot, rRoot.get()));

        // Upload files.
        ASSERT_TRUE(cu->uploadFilesInTree(lRoot, rRoot.get()));

        // Make sure everything made it to the cloud.
        auto predicate = SyncRemoteMatch("x", remoteTree.root.get());

        ASSERT_TRUE(cd->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cdu->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cu->waitFor(predicate, DEFAULTWAIT));
    }

    // Set up models.
    LocalFSModel localFS = remoteTree;

    localFS.removenode("d/f");
    localFS.removenode("db/fe0");
    localFS.removenode("db/fe1");
    localFS.removenode("dl/fe");
    localFS.removenode("dr/fe0");
    localFS.removenode("dr/fe1");
    localFS.removenode("dr/fe2");
    localFS.removenode("dr/fe3");
    localFS.removenode("du/fe");
    localFS.removenode("f");

    // Add and start sync.
    fs::create_directories(root(*cd) / "root");

    auto id = setupSync(*cd, "root", "x", false);
    ASSERT_NE(id, UNDEF);

    // Wait for synchronization to complete.
    waitOnSyncs(cd);

    // Confirm models.
    ASSERT_TRUE(confirm(*cd, id, localFS));
    ASSERT_TRUE(confirm(*cd, id, remoteTree));

    // Change du/fi's size such that it violates the size filter.
    {
        auto data = randomData(24);

        localFS.addfile("du/fi", data);
        remoteTree.addfile("du/fi", data);

        ASSERT_TRUE(createFile(root(*cd) / "root" / "du" / "fi", data));
    }

    // Wait for the change to hit the cloud.
    waitOnSyncs(cd);

    // Everything as we'd expect?
    ASSERT_TRUE(confirm(*cd, id, localFS));
    ASSERT_TRUE(confirm(*cd, id, remoteTree));

    // Make sure cdu is aware of du/fi.
    ASSERT_TRUE(cdu->waitFor(SyncRemoteMatch("x", remoteTree.root.get()), DEFAULTWAIT));

    // Remove du/fi in the cloud.
    {
        remoteTree.removenode("du/fi");

        ASSERT_TRUE(cdu->deleteremote("x/du/fi"));
    }

    // Removal should propagate down.
    localFS.removenode("du/fi");

    // Wait for the change to propagate.
    waitOnSyncs(cd);

    // Everything as we'd expect?
    ASSERT_TRUE(confirm(*cd, id, localFS));
    ASSERT_TRUE(confirm(*cd, id, remoteTree));
}

TEST_F(CloudToLocalFilterFixture, DoesntMoveIgnoredNodes)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Setup local FS.
    localFS.addfile(".megaignore", "+sync:.megaignore");
    localFS.addfile("d/fx");
    localFS.generate(root(*cdu) / "root");

    // Setup remote note tree.
    remoteTree = localFS;

    // Log in the client.
    ASSERT_TRUE(cdu->makeCloudSubdirs("cdu", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Add and start sync.
    auto id = setupSync(*cdu, "root", "cdu", false);
    ASSERT_NE(id, UNDEF);

    // Wait for sync to complete.
    waitOnSyncs(cdu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cdu, id, localFS));
    ASSERT_TRUE(confirm(*cdu, id, remoteTree));

    // Filter out fx.
    localFS.addfile(".megaignore", "-:*x\n+sync:.megaignore");
    localFS.generate(root(*cdu) / "root");

    // fx should remain in the cloud.
    remoteTree = localFS;

    // Wait for sync to complete.
    cdu->triggerPeriodicScanEarly(id);
    waitOnSyncs(cdu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cdu, id, localFS));
    ASSERT_TRUE(confirm(*cdu, id, remoteTree));

    // Move cdu/d/fx to cdu/fx.
    {
        // Make sure cu is aware of d/fx.
        auto predicate = SyncRemoteMatch("cdu", remoteTree.root.get());
        ASSERT_TRUE(cu->waitFor(std::move(predicate), DEFAULTWAIT));

        // Move the node.
        ASSERT_TRUE(cu->movenode("cdu/d/fx", "cdu"));

        // Update models.
        remoteTree.movenode("d/fx", "");
    }

    // Wait for sync to complete.
    waitOnSyncs(cdu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cdu, id, localFS));
    ASSERT_TRUE(confirm(*cdu, id, remoteTree));
}

TEST_F(CloudToLocalFilterFixture, DoesntRenameIgnoredNodes)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Setup local FS.
    localFS.addfile("x");
    localFS.addfile(".megaignore", "+sync:.megaignore");
    localFS.generate(root(*cdu) / "root");

    // Setup remote note tree.
    remoteTree = localFS;

    // Log in the client.
    ASSERT_TRUE(cdu->makeCloudSubdirs("cdu", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Add and start sync.
    auto id = setupSync(*cdu, "root", "cdu", false);
    ASSERT_NE(id, UNDEF);

    // Wait for sync to complete.
    waitOnSyncs(cdu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cdu, id, localFS));
    ASSERT_TRUE(confirm(*cdu, id, remoteTree));

    // Filter out fx.
    localFS.addfile(".megaignore", "-:x\n+sync:.megaignore");
    localFS.generate(root(*cdu) / "root");

    // x should remain in the cloud.
    remoteTree = localFS;

    // Wait for sync to complete.
    cdu->triggerPeriodicScanEarly(id);
    waitOnSyncs(cdu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cdu, id, localFS));
    ASSERT_TRUE(confirm(*cdu, id, remoteTree));

    // Rename cdu/x to cdu/y.
    {
        // Make sure cu is aware of x.
        auto predicate = SyncRemoteMatch("cdu", remoteTree.root.get());
        ASSERT_TRUE(cu->waitFor(std::move(predicate), DEFAULTWAIT));

        // Rename x to y.
        ASSERT_TRUE(cu->setattr("cdu/x", attr_map('n', "y")));
    }

    // Update models.
    localFS.addfile("y", "x");
    remoteTree.copynode("x", "y");
    remoteTree.removenode("x");

    // Wait for sync to complete.
    waitOnSyncs(cdu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cdu, id, localFS));
    ASSERT_TRUE(confirm(*cdu, id, remoteTree));
}

TEST_F(CloudToLocalFilterFixture, DoesntRubbishIgnoredNodes)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Setup local FS.
    localFS.addfile(".megaignore", "+sync:.megaignore");
    localFS.addfile("x");
    localFS.generate(root(*cdu) / "root");

    // Setup remote note tree.
    remoteTree = localFS;

    // Log in the client.
    ASSERT_TRUE(cdu->makeCloudSubdirs("cdu", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Add and start sync.
    auto id = setupSync(*cdu, "root", "cdu", false);
    ASSERT_NE(id, UNDEF);

    // Wait for sync to complete.
    waitOnSyncs(cdu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cdu, id, localFS));
    ASSERT_TRUE(confirm(*cdu, id, remoteTree));

    // Filter out fx.
    localFS.addfile(".megaignore", "-:x\n+sync:.megaignore");
    localFS.generate(root(*cdu) / "root");

    // x should remain in the cloud.
    remoteTree = localFS;

    // Wait for sync to complete.
    cdu->triggerPeriodicScanEarly(id);
    waitOnSyncs(cdu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cdu, id, localFS));
    ASSERT_TRUE(confirm(*cdu, id, remoteTree));

    // Remove cdu/x.
    {
        // Make sure cu is aware of x.
        auto predicate = SyncRemoteMatch("cdu", remoteTree.root.get());
        ASSERT_TRUE(cu->waitFor(std::move(predicate), DEFAULTWAIT));

        // Delete x.
        ASSERT_TRUE(cu->deleteremote("cdu/x"));
    }

    // Update models.
    remoteTree.removenode("x");

    // Wait for sync to complete.
    waitOnSyncs(cdu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cdu, id, localFS));
    ASSERT_TRUE(confirm(*cdu, id, remoteTree));
}

TEST_F(CloudToLocalFilterFixture, DoesntUploadIgnoredNodes)
{
    const string ignoreFile = "-:da\n-:f*\nexclude-smaller:2\n\n+sync:.megaignore";

    // Set up cloud.
    {
        Model model;

        // Convenience.
        const auto lRoot = root(*cu) / "x";
        const auto rRoot = cu->gettestbasenode();

        // Populate filesystem.
        model.addfile(".megaignore", ignoreFile);
        model.generate(lRoot);

        // Create directories.
        ASSERT_TRUE(cu->uploadFolderTree(lRoot, rRoot.get()));

        // Upload files.
        ASSERT_TRUE(cu->uploadFilesInTree(lRoot, rRoot.get()));

        // Wait for everyone to agree on the state of the cloud.
        auto predicate = SyncRemoteMatch("x", model.root.get());

        ASSERT_TRUE(cd->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cdu->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cu->waitFor(predicate, DEFAULTWAIT));
    }

    // Set up models.
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    localFS.addfile("da/f.txt", "daf");
    localFS.addfile("da/g.txt", "dag");
    localFS.addfile("db/f.txt", "dbf");
    localFS.addfile("db/g.txt", "dbg");
    localFS.addfile("f.txt", "rf");
    localFS.addfile("g.txt", "rg");
    localFS.addfile("h.txt", "!");
    localFS.generate(root(*cd) / "root");
    localFS.addfile(".megaignore", ignoreFile);

    remoteTree = localFS;
    remoteTree.removenode("da");
    remoteTree.removenode("db/f.txt");
    remoteTree.removenode("f.txt");
    remoteTree.removenode("h.txt");

    // Add and start sync.
    auto id = setupSync(*cd, "root", "x", false);
    ASSERT_NE(id, UNDEF);

    // Wait for synchronization to complete.
    waitOnSyncs(cd);

    // Confirm models.
    ASSERT_TRUE(confirm(*cd, id, localFS));
    ASSERT_TRUE(confirm(*cd, id, remoteTree));
}

TEST_F(CloudToLocalFilterFixture, ExcludedIgnoreFile)
{
    Model model;

    // Populate cloud.
    {
        // Convenience.
        const auto lRoot = root(*cu) / "x";
        const auto rRoot = cu->gettestbasenode();

        // Populate filesystem.
        model.addfile("0/.megaignore", "-:f\n+sync:.megaignore");
        model.addfile("0/f");
        model.addfile("1/.megaignore", "#");
        model.addfile(".megaignore", "-:1\n-:.megaignore\n+sync:.megaignore");
        model.generate(lRoot);

        // Create directories.
        ASSERT_TRUE(cu->uploadFolderTree(lRoot, rRoot.get()));

        // Upload files
        ASSERT_TRUE(cu->uploadFilesInTree(lRoot, rRoot.get()));

        // Wait for the clients to agree on the cloud's state.
        auto predicate = SyncRemoteMatch("x", model.root.get());

        ASSERT_TRUE(cd->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cdu->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cu->waitFor(predicate, DEFAULTWAIT));
    }

    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Local model should exclude /0/f and /1.
    localFS = model;
    localFS.removenode("0/f");
    localFS.removenode("1");

    // Remote model should be unchanged.
    remoteTree = model;

    // Make sure local sync root exists.
    fs::create_directories(root(*cdu) / "root");

    // Add and start sync.
    const auto id = setupSync(*cdu, "root", "x", false);
    ASSERT_NE(id, UNDEF);

    // Wait for initial sync to complete.
    waitOnSyncs(cdu);

    // Did we download what we expected?
    ASSERT_TRUE(confirm(*cdu, id, localFS));
    ASSERT_TRUE(confirm(*cdu, id, remoteTree));

    // Make some remote changes.
    {
        // Should allow download of 1.
        localFS.removenode(".megaignore");
        remoteTree.removenode(".megaignore");

        ASSERT_TRUE(cd->deleteremote("x/.megaignore"));

        localFS.addfile("1/.megaignore", "#");
    }

    // Wait for remote changes to reach us.
    waitOnSyncs(cdu);

    // Everything as we expect?
    ASSERT_TRUE(confirm(*cdu, id, localFS));
    ASSERT_TRUE(confirm(*cdu, id, remoteTree));
}

TEST_F(CloudToLocalFilterFixture, FilterAdded)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Setup local fs.
    localFS.addfile(".megaignore", "+sync:.megaignore");
    localFS.generate(root(*cu));
    localFS.addfile("d/x");
    localFS.generate(root(*cu) / "root");

    // Setup remote tree.
    remoteTree = localFS;

    // Log in "upload" client.
    ASSERT_TRUE(cu->makeCloudSubdirs("x", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Upload the initial ignore file.
    //
    // This is to avoid a race between clients.
    ASSERT_TRUE(cu->uploadFile(root(*cu) / ".megaignore", "x"));

    // Wait for cd to become aware of the new ignore file.
    {
        auto predicate = SyncRemoteNodePresent("x/.megaignore");
        ASSERT_TRUE(cd->waitFor(std::move(predicate), DEFAULTWAIT));
    }

    // Add and start syncs.
    auto cuId = setupSync(*cu, "root", "x", false);
    ASSERT_NE(cuId, UNDEF);

    auto cdId = setupSync(*cd, "root", "x", false);
    ASSERT_NE(cdId, UNDEF);

    // Wait for synchronization to complete.
    waitOnSyncs(cd, cu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cu, cuId, localFS));
    ASSERT_TRUE(confirm(*cu, cuId, remoteTree));

    ASSERT_TRUE(confirm(*cd, cdId, localFS));
    ASSERT_TRUE(confirm(*cd, cdId, remoteTree));

    // Add d/.megaignore to "upload" client.
    localFS.addfile("d/.megaignore", "-:x\n+sync:.megaignore");
    localFS.generate(root(*cu) / "root");

    // d/.megaignore's now in the cloud.
    remoteTree = localFS;

    // Wait for synchronization to complete.
    cu->triggerPeriodicScanEarly(cuId);
    waitOnSyncs(cu, cd);

    // Confirm models.
    ASSERT_TRUE(confirm(*cu, cuId, localFS));
    ASSERT_TRUE(confirm(*cu, cuId, remoteTree));

    ASSERT_TRUE(confirm(*cd, cdId, localFS));
    ASSERT_TRUE(confirm(*cd, cdId, remoteTree));

    // Remove x/d/x in the cloud.
    {
        // Wait for cdu to become aware of d/x.
        auto predicate = SyncRemoteMatch("x", remoteTree.root.get());
        ASSERT_TRUE(cdu->waitFor(std::move(predicate), DEFAULTWAIT));

        // Remove d/x.
        ASSERT_TRUE(cdu->deleteremote("x/d/x"));

        // Update model.
        remoteTree.removenode("d/x");
    }

    // Wait for sync to complete.
    waitOnSyncs(cu, cd);

    // x/x should remain locally.
    ASSERT_TRUE(confirm(*cu, cuId, localFS));
    ASSERT_TRUE(confirm(*cu, cuId, remoteTree));

    ASSERT_TRUE(confirm(*cd, cdId, localFS));
    ASSERT_TRUE(confirm(*cd, cdId, remoteTree));
}

TEST_F(CloudToLocalFilterFixture, FilterChanged)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Set up local FS.
    localFS.addfile(".megaignore", "-:x\n+sync:.megaignore");
    localFS.generate(root(*cu));
    localFS.addfile("x");
    localFS.addfile("y");
    localFS.generate(root(*cu) / "root");

    // Set up remote tree.
    remoteTree = localFS;
    remoteTree.removenode("x");

    // Log in the "uploader" client.
    ASSERT_TRUE(cu->makeCloudSubdirs("x", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Upload the initial ignore file.
    //
    // This is to avoid a race between clients.
    ASSERT_TRUE(cu->uploadFile(root(*cu) / ".megaignore", "x"));

    // Wait for cd to become aware of the ignore file.
    {
        auto predicate = SyncRemoteNodePresent("x/.megaignore");
        ASSERT_TRUE(cd->waitFor(std::move(predicate), DEFAULTWAIT));
    }

    // Add and start syncs.
    auto cuId = setupSync(*cu, "root", "x", false);
    ASSERT_NE(cuId, UNDEF);

    fs::create_directories(root(*cd) / "root");

    auto cdId = setupSync(*cd, "root", "x", false);
    ASSERT_NE(cdId, UNDEF);

    // Wait for synchronization to complete.
    waitOnSyncs(cu, cd);

    // Confirm models.
    ASSERT_TRUE(confirm(*cu, cuId, localFS));
    ASSERT_TRUE(confirm(*cu, cuId, remoteTree));

    // x is not present under cd.
    localFS.removenode("x");

    ASSERT_TRUE(confirm(*cd, cdId, localFS));
    ASSERT_TRUE(confirm(*cd, cdId, remoteTree));

    // Update ignore file on uploader side.
    localFS.addfile(".megaignore", "-:y\n+sync:.megaignore");
    localFS.generate(root(*cu) / "root");

    // Update models.
    localFS.addfile("x");

    // Remote contains everything.
    remoteTree = localFS;

    // Wait for synchronization to complete.
    cu->triggerPeriodicScanEarly(cuId);
    waitOnSyncs(cu, cd);

    // Confirm models.
    ASSERT_TRUE(confirm(*cu, cuId, localFS));
    ASSERT_TRUE(confirm(*cu, cuId, remoteTree));

    ASSERT_TRUE(confirm(*cd, cdId, localFS));
    ASSERT_TRUE(confirm(*cd, cdId, remoteTree));

    // Delete x/y in the cloud.
    {
        // Make sure cdu is up to date with respect to the cloud.
        auto predicate = SyncRemoteMatch("x", remoteTree.root.get());
        ASSERT_TRUE(cdu->waitFor(std::move(predicate), DEFAULTWAIT));

        // Remove x/y.
        ASSERT_TRUE(cdu->deleteremote("x/y"));

        // Update model.
        remoteTree.removenode("y");
    }

    // Wait for synchronization to complete.
    waitOnSyncs(cd, cu);

    // x/y should remain locally.
    ASSERT_TRUE(confirm(*cu, cuId, localFS));
    ASSERT_TRUE(confirm(*cu, cuId, remoteTree));

    ASSERT_TRUE(confirm(*cd, cdId, localFS));
    ASSERT_TRUE(confirm(*cd, cdId, remoteTree));
}

TEST_F(CloudToLocalFilterFixture, FilterDeferredChange)
{
    Model model;

    // Convenience.
    const auto cuLocalRoot = root(*cu) / "x";
    const auto cuCloudRoot = cu->gettestbasenode();

    // Set up remote model.
    model.addfile(".megaignore", "-:d\n+sync:.megaignore");
    model.addfile("d/.megaignore", "-:x\n+sync:.megaignore");
    model.addfile("d/x");
    model.addfile("d/y");
    model.generate(cuLocalRoot);

    // Upload tree.
    ASSERT_TRUE(cu->uploadFolderTree(cuLocalRoot, cuCloudRoot.get()));
    ASSERT_TRUE(cu->uploadFilesInTree(cuLocalRoot, cuCloudRoot.get()));

    // Wait for cd to receive cu's changes.
    {
        auto predicate = SyncRemoteMatch("x", model.root.get());
        ASSERT_TRUE(cd->waitFor(predicate, DEFAULTWAIT));
    }

    // Set up local FS.
    LocalFSModel localFS;

    localFS.addfile(".megaignore", "-:d\n+sync:.megaignore");

    // Set up remote model.
    RemoteNodeModel remoteTree = model;

    // Add sync and start sync.
    fs::create_directories(root(*cd) / "root");

    auto cdId = setupSync(*cd, "root", "x", false);
    ASSERT_NE(cdId, UNDEF);

    // Wait for synchronization to complete.
    waitOnSyncs(cd);

    // Confirm models.
    ASSERT_TRUE(confirm(*cd, cdId, localFS));
    ASSERT_TRUE(confirm(*cd, cdId, remoteTree));

    // Change x/d/.megaignore to include x and exclude y.
    {
        // Make sure cu's seen cd's changes.
        auto predicate = SyncRemoteMatch("x", remoteTree.root.get());
        ASSERT_TRUE(cu->waitFor(std::move(predicate), DEFAULTWAIT));

        // Update the ignore file.
        model.addfile("d/.megaignore", "-:y\n+sync:.megaignore");
        model.generate(cuLocalRoot);

        // Upload the updated file.
        ASSERT_TRUE(cu->uploadFile(cuLocalRoot / "d" / ".megaignore",
                                   "x/d",
                                   30,
                                   ClaimOldVersion));
    }

    // Wait for synchronization to complete.
    waitOnSyncs(cd);

    // Update models.
    remoteTree = model;

    // Confirm downloader models.
    ASSERT_TRUE(confirm(*cd, cdId, localFS));
    ASSERT_TRUE(confirm(*cd, cdId, remoteTree));

    // Remove x/.megaignore so to allow x/d.
    model.removenode(".megaignore");
    ASSERT_TRUE(cu->deleteremote("x/.megaignore"));

    // Wait for synchronization to complete.
    waitOnSyncs(cd);

    // Update models.
    localFS = model;
    localFS.removenode("d/y");
    remoteTree = model;

    // Confirm downloader models.
    ASSERT_TRUE(confirm(*cd, cdId, localFS));
    ASSERT_TRUE(confirm(*cd, cdId, remoteTree));
}

TEST_F(CloudToLocalFilterFixture, FilterMovedAcrossHierarchy)
{
    // Set up cloud.
    {
        Model model;

        // Convenience.
        const auto lRoot = root(*cu) / "x";
        const auto rRoot = cu->gettestbasenode();

        // Setup model.
        model.addfile("a/.megaignore", "-:fa\n+sync:.megaignore");
        model.addfile("a/fa");
        model.addfile("b/fa");
        model.addfile(".megaignore", "+sync:.megaignore");
        model.generate(lRoot);

        // Upload tree.
        ASSERT_TRUE(cu->uploadFolderTree(lRoot, rRoot.get()));
        ASSERT_TRUE(cu->uploadFilesInTree(lRoot, rRoot.get()));

        // Make sure everything made it to the cloud.
        auto predicate = SyncRemoteMatch("x", model.root.get());
        ASSERT_TRUE(cu->waitFor(predicate, DEFAULTWAIT));

        // Make sure everyone agrees on the cloud's state.
        ASSERT_TRUE(cd->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cdu->waitFor(predicate, DEFAULTWAIT));
    }

    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Setup local FS.
    localFS.addfile("a/.megaignore", "-:fa\n+sync:.megaignore");
    localFS.addfile("b/fa");
    localFS.addfile(".megaignore", "+sync:.megaignore");

    // Setup remote tree.
    remoteTree = localFS;
    remoteTree.addfile("a/fa");

    // Add and start sync.
    fs::create_directories(root(*cd) / "root");

    auto id = setupSync(*cd, "root", "x", false);
    ASSERT_NE(id, UNDEF);

    // Wait for synchronization to complete.
    waitOnSyncs(cd);

    // Confirm models.
    ASSERT_TRUE(confirm(*cd, id, localFS));
    ASSERT_TRUE(confirm(*cd, id, remoteTree));

    // Move x/a/.megaignore to x/b/.megaignore.
    {
        // Make sure cdu seems cd's changes.
        auto predicate = SyncRemoteMatch("x", remoteTree.root.get());
        ASSERT_TRUE(cdu->waitFor(std::move(predicate), DEFAULTWAIT));

        // Move a/.megaignore to b.
        ASSERT_TRUE(cdu->movenode("x/a/.megaignore", "x/b"));
    }

    // Wait for sync.
    waitOnSyncs(cd);

    // Update models.
    // a/.megaignore -> b/.megaignore.
    // a/fa should become included.
    // b/fa should become excluded.
    localFS.addfile("a/fa");
    localFS.movenode("a/.megaignore", "b");

    remoteTree.movenode("a/.megaignore", "b");

    // Confirm models.
    ASSERT_TRUE(confirm(*cd, id, localFS));
    ASSERT_TRUE(confirm(*cd, id, remoteTree));
}

TEST_F(CloudToLocalFilterFixture, FilterMovedDownHierarchy)
{
    // Set up cloud.
    {
        Model model;

        // Convenience.
        const auto lRoot = root(*cu) / "x";
        const auto rRoot = cu->gettestbasenode();

        // Setup model.
        model.addfile(".megaignore", "-:fa\n+sync:.megaignore");
        model.addfile("a/fa");
        model.addfile("b/fa");
        model.addfolder("c/d");
        model.addfile("c/.megaignore", "-:.megaignore\n+sync:.megaignore");
        model.generate(lRoot);

        // Upload tree.
        ASSERT_TRUE(cu->uploadFolderTree(lRoot, rRoot.get()));
        ASSERT_TRUE(cu->uploadFilesInTree(lRoot, rRoot.get()));

        // Make sure everything made it to the cloud.
        auto predicate = SyncRemoteMatch("x", model.root.get());
        ASSERT_TRUE(cu->waitFor(predicate, DEFAULTWAIT));

        // Make sure everyone agrees on the cloud's state.
        ASSERT_TRUE(cd->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cdu->waitFor(predicate, DEFAULTWAIT));
    }

    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Setup local FS.
    localFS.addfile(".megaignore", "-:fa\n+sync:.megaignore");
    localFS.addfolder("a");
    localFS.addfolder("b");
    localFS.addfolder("c/d");
    localFS.addfile("c/.megaignore", "-:.megaignore\n+sync:.megaignore");

    // Setup remote tree.
    remoteTree = localFS;
    remoteTree.addfile("a/fa");
    remoteTree.addfile("b/fa");

    // Add and start sync.
    fs::create_directories(root(*cd) / "root");

    auto id = setupSync(*cd, "root", "x", false);
    ASSERT_NE(id, UNDEF);

    // Wait for synchronization to complete.
    waitOnSyncs(cd);

    // Confirm models.
    ASSERT_TRUE(confirm(*cd, id, localFS));
    ASSERT_TRUE(confirm(*cd, id, remoteTree));

    // Move ignore files.
    {
        // Make sure cdu is up to date with cd's changes.
        auto predicate = SyncRemoteMatch("x", remoteTree.root.get());
        ASSERT_TRUE(cdu->waitFor(std::move(predicate), DEFAULTWAIT));

        // Move x/.megaignore to x/a/.megaignore.
        ASSERT_TRUE(cdu->movenode("x/.megaignore", "x/a"));

        // Move x/c/.megaignore to x/c/d/.megaignore.
        ASSERT_TRUE(cdu->movenode("x/c/.megaignore", "x/c/d"));
    }

    // Wait for sync.
    waitOnSyncs(cd);

    // Update models.
    //   .megaignore -> a/.megaignore.
    // c/.megaignore -> c/d/.megaignore.
    // a/fa should remain excluded.
    // b/fa should become included.
    localFS.addfile("b/fa");
    localFS.movenode(".megaignore", "a");
    localFS.movenode("c/.megaignore", "c/d");

    remoteTree = localFS;
    remoteTree.addfile("a/fa");

    // Confirm models.
    ASSERT_TRUE(confirm(*cd, id, localFS));
    ASSERT_TRUE(confirm(*cd, id, remoteTree));
}

TEST_F(CloudToLocalFilterFixture, FilterMovedIntoExcluded)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Set up cloud.
    {
        Model model;

        // Convenience.
        const auto lRoot = root(*cu) / "x";
        const auto rRoot = cu->gettestbasenode();

        // Setup models.
        model.addfile(".megaignore", "-:d*\n-:f*\n\n+sync:.megaignore");

        localFS = model;

        model.addfile("d/g");
        model.addfile("f");
        model.generate(lRoot);

        remoteTree = model;

        // Upload tree.
        ASSERT_TRUE(cu->uploadFolderTree(lRoot, rRoot.get()));
        ASSERT_TRUE(cu->uploadFilesInTree(lRoot, rRoot.get()));

        // Make sure everything made it to the cloud.
        auto predicate = SyncRemoteMatch("x", model.root.get());
        ASSERT_TRUE(cu->waitFor(predicate, DEFAULTWAIT));

        // Make sure everyone agrees on the cloud's state.
        ASSERT_TRUE(cd->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cdu->waitFor(predicate, DEFAULTWAIT));
    }

    // Add and start sync.
    fs::create_directories(root(*cd) / "root");

    auto id = setupSync(*cd, "root", "x", false);
    ASSERT_NE(id, UNDEF);

    // Wait for synchronization to complete.
    waitOnSyncs(cd);

    // Confirm models.
    ASSERT_TRUE(confirm(*cd, id, localFS));
    ASSERT_TRUE(confirm(*cd, id, remoteTree));

    // Move x/.megaignore into x/d/.megaignore.
    {
        // Make sure cdu sees cd's changes.
        auto predicate = SyncRemoteMatch("x", remoteTree.root.get());
        ASSERT_TRUE(cdu->waitFor(predicate, DEFAULTWAIT));

        // Move the ignore file.
        ASSERT_TRUE(cdu->movenode("x/.megaignore", "x/d"));

        // Update the model.
        remoteTree.movenode(".megaignore", "d");
    }

    // Wait for sync to complete.
    waitOnSyncs(cd);

    // Confirm models.
    localFS = remoteTree;

    ASSERT_TRUE(confirm(*cd, id, localFS));
    ASSERT_TRUE(confirm(*cd, id, remoteTree));
}

TEST_F(CloudToLocalFilterFixture, FilterMovedUpHierarchy)
{
    // Set up cloud.
    {
        Model model;

        // Convenience.
        const auto lRoot = root(*cu) / "x";
        const auto rRoot = cu->gettestbasenode();

        // Setup model.
        model.addfile("a/.megaignore", "-:fa\n+sync:.megaignore");
        model.addfile("a/fa");
        model.addfile("b/fa");
        model.addfile("c/d/.megaignore", "-:.megaignore\n+sync:.megaignore");
        model.addfile(".megaignore", "+sync:.megaignore");
        model.generate(lRoot);

        // Upload tree.
        ASSERT_TRUE(cu->uploadFolderTree(lRoot, rRoot.get()));
        ASSERT_TRUE(cu->uploadFilesInTree(lRoot, rRoot.get()));

        // Make sure everything made it to the cloud.
        auto predicate = SyncRemoteMatch("x", model.root.get());
        ASSERT_TRUE(cu->waitFor(predicate, DEFAULTWAIT));

        // Make sure everyone's seeing the same thing.
        ASSERT_TRUE(cd->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cdu->waitFor(predicate, DEFAULTWAIT));
    }

    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Setup local FS.
    localFS.addfile("a/.megaignore", "-:fa\n+sync:.megaignore");
    localFS.addfile("b/fa");
    localFS.addfile("c/d/.megaignore", "-:.megaignore\n+sync:.megaignore");
    localFS.addfile(".megaignore", "+sync:.megaignore");

    // Setup remote tree.
    remoteTree = localFS;
    remoteTree.addfile("a/fa");

    // Add and start sync.
    fs::create_directories(root(*cd) / "root");

    auto id = setupSync(*cd, "root", "x", false);
    ASSERT_NE(id, UNDEF);

    // Wait for synchronization to complete.
    waitOnSyncs(cd);

    // Confirm models.
    ASSERT_TRUE(confirm(*cd, id, localFS));
    ASSERT_TRUE(confirm(*cd, id, remoteTree));

    // Move x/a/.megaignore to x/.megaignore.
    {
        auto pauser = makeScopedSyncPauser(*cd, id);

        // Move x/a/.megaignore to x/.megaignore.
        localFS.removenode(".megaignore");
        localFS.copynode("a/.megaignore", ".megaignore");

        ASSERT_TRUE(cdu->copy("x/a/.megaignore", "x", ClaimOldVersion));

        // Remove x/a/.megaignore.
        localFS.removenode("a/.megaignore");
        remoteTree.removenode("a/.megaignore");

        ASSERT_TRUE(cdu->deleteremote("x/a/.megaignore"));

        // Wait for everyone to agree on the cloud's state.
        auto predicate = SyncRemoteMatch("x", remoteTree.root.get());

        ASSERT_TRUE(cd->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cdu->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cu->waitFor(predicate, DEFAULTWAIT));
    }

    // Wait for the engine to process the changes.
    waitOnSyncs(cd);

    // Check that the ignore file has been "moved."
    ASSERT_TRUE(confirm(*cd, id, localFS));
    ASSERT_TRUE(confirm(*cd, id, remoteTree));


    {
        auto pauser = makeScopedSyncPauser(*cd, id);

        remoteTree.removenode("b/fa");

        // Remove x/b/fa.
        //
        // The change shouldn't be actioned as the file became excluded by
        // the "move" above.
        ASSERT_TRUE(cdu->deleteremote("x/b/fa"));

        // Move x/cd/.megaignore up a level.
        //
        // Change should be actioned as ignore files cannot be excluded.
        localFS.movenode("c/d/.megaignore", "c");
        remoteTree.movenode("c/d/.megaignore", "c");

        ASSERT_TRUE(cdu->movenode("x/c/d/.megaignore", "x/c"));

        // Wait for all clients to see the changes.
        auto predicate = SyncRemoteMatch("x", remoteTree.root.get());
        ASSERT_TRUE(cd->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cdu->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cu->waitFor(predicate, DEFAULTWAIT));
    }

    // Wait for the engine to process above changes.
    waitOnSyncs(cd);

    // Confirm models.
    ASSERT_TRUE(confirm(*cd, id, localFS));
    ASSERT_TRUE(confirm(*cd, id, remoteTree));
}

TEST_F(CloudToLocalFilterFixture, FilterNameClash)
{
    auto TIMEOUT = std::chrono::seconds(16);

    // Set up cloud.
    {
        // Create the cloud root.
        ASSERT_TRUE(cdu->makeCloudSubdirs("s", 0, 0));
        ASSERT_TRUE(CatchupClients(cd, cdu, cu));

        // Convenience.
        auto ignoreFilePath = cdu->fsBasePath / ".megaignore";

        // Create a dummy ignore file for us to upload.
        ASSERT_TRUE(createFile(ignoreFilePath, "#"));

        // Upload the ignore file, twice.
        // This is so we have a cloud name clash.
        ASSERT_TRUE(cdu->uploadFile(ignoreFilePath, "s"));
        ASSERT_TRUE(cdu->uploadFile(ignoreFilePath, "s"));

        // Wait for everyone to see the new ignore file.
        auto predicate = SyncRemoteNodePresent("s/.megaignore");

        ASSERT_TRUE(cd->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cdu->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cu->waitFor(predicate, DEFAULTWAIT));
    }

    // Make sure local root exists.
    fs::create_directories(cdu->fsBasePath / "s");

    // Create a directory for the engine to synchronize.
    fs::create_directories(cdu->fsBasePath / "s" / "d");

    // Add and start a new sync.
    auto id = setupSync(*cdu, "s", "s", false);
    ASSERT_NE(id, UNDEF);

    // Give the engine some time to detect the name conflict.
    waitOnSyncs(cdu);

    // Wait for the engine to detect a name conflict.
    ASSERT_TRUE(cdu->waitFor(SyncConflictState(true), TIMEOUT));

    std::list<NameConflict> conflicts;

    // Ask the engine which name conflicts were detected.
    ASSERT_TRUE(cdu->conflictsDetected(conflicts));

    // Make sure the list of conflicts isn't empty.
    ASSERT_FALSE(conflicts.empty());

    // Make sure the conflicts are due to the ignore files.
    const auto& conflict = conflicts.front();

    // Detected at the sync root?
    ASSERT_EQ(conflict.cloudPath, "/mega_test_sync/s");

    // Two remote name clashes detected?
    ASSERT_EQ(conflict.clashingCloud.size(), 2u);

    // Both ignore files?
    ASSERT_EQ(conflict.clashingCloud[0].name, IGNORE_FILE_NAME);
    ASSERT_EQ(conflict.clashingCloud[1].name, IGNORE_FILE_NAME);

    // Make sure the engine didn't upload the "d" directory.
    ASSERT_EQ(cdu->drillchildnodebyname(cdu->gettestbasenode(), "s/d"), nullptr);
}

TEST_F(CloudToLocalFilterFixture, FilterNameClashMultiple)
{
    auto TIMEOUT = std::chrono::seconds(16);

    // Set up cloud.
    {
        // Create the cloud root.
        ASSERT_TRUE(cdu->makeCloudSubdirs("s", 0, 0));
        ASSERT_TRUE(CatchupClients(cd, cdu, cu));

        // Convenience.
        auto ignoreFilePath = cdu->fsBasePath / ".megaignore";

        // Create a dummy ignore file for us to upload.
        ASSERT_TRUE(createFile(ignoreFilePath, "#"));

        // Upload the ignore file, twice.
        // This is so we have a cloud name clash.
        ASSERT_TRUE(cdu->uploadFile(ignoreFilePath, "s"));
        ASSERT_TRUE(cdu->uploadFile(ignoreFilePath, "s"));

        // Wait for everyone to see the new ignore file.
        auto predicate = SyncRemoteNodePresent("s/.megaignore");

        ASSERT_TRUE(cd->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cdu->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cu->waitFor(predicate, DEFAULTWAIT));
    }

    // Make sure local root exists.
    fs::create_directories(cdu->fsBasePath / "s");

    // Create a directory for the engine to synchronize.
    fs::create_directories(cdu->fsBasePath / "s" / "d");

    // Add and start a new sync.
    auto id = setupSync(*cdu, "s", "s", false);
    ASSERT_NE(id, UNDEF);

    // Give the engine some time to detect the name conflict.
    waitOnSyncs(cdu);

    // Wait for the engine to detect a name conflict.
    ASSERT_TRUE(cdu->waitFor(SyncConflictState(true), TIMEOUT));

    // Create a second name conflict.
    const string otherFile = "otherFile";
    {
        // Convenience.
        auto otherFilePath = cdu->fsBasePath / otherFile;

        // Create a dummy file for us to upload.
        ASSERT_TRUE(createFile(otherFilePath, "&"));

        // Upload the other file, twice.
        // This is so we have another cloud name clash.
        ASSERT_TRUE(cdu->uploadFile(otherFilePath, "s"));
        ASSERT_TRUE(cdu->uploadFile(otherFilePath, "s"));

        // Wait for everyone to see the new other file.
        auto predicate = SyncRemoteNodePresent("s/otherFile");

        ASSERT_TRUE(cd->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cdu->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cu->waitFor(predicate, DEFAULTWAIT));
    }

    // Give the engine some time to detect the new name conflict.
    waitOnSyncs(cdu);

    // Wait for the engine to detect a new name conflict.
    ASSERT_TRUE(cdu->waitFor(SyncTotalConflictsStateUpdate(true), TIMEOUT));

    std::list<NameConflict> conflicts;

    // Ask the engine which name conflicts were detected.
    ASSERT_TRUE(cdu->conflictsDetected(conflicts));

    // Make sure there are two conflicts (for .megaignore and for otherFile).
    ASSERT_EQ(conflicts.size(), 2u);

    auto checkConflict = [](const NameConflict& conflict, const std::string& expectedFileName)
    {
        // Detected at the sync root?
        ASSERT_EQ(conflict.cloudPath, "/mega_test_sync/s");

        // Two remote name clashes detected?
        ASSERT_EQ(conflict.clashingCloud.size(), 2u);

        // Both expected files?
        ASSERT_EQ(conflict.clashingCloud[0].name, expectedFileName);
        ASSERT_EQ(conflict.clashingCloud[1].name, expectedFileName);
    };

    // Check the first conflict
    const auto& conflict = conflicts.front();
    checkConflict(conflict, IGNORE_FILE_NAME);
    conflicts.pop_front();

    // Check the second conflict
    const auto& conflict2 = conflicts.front();
    checkConflict(conflict2, otherFile);

    // Make sure the engine didn't upload the "d" directory.
    ASSERT_EQ(cdu->drillchildnodebyname(cdu->gettestbasenode(), "s/d"), nullptr);
}

TEST_F(CloudToLocalFilterFixture, FilterRemoved)
{
    // Set up cloud.
    {
        Model model;

        // Convenience.
        const auto lRoot = root(*cu) / "x";
        const auto rRoot = cu->gettestbasenode();

        // Setup model.
        model.addfile(".megaignore", "-:fa\n+sync:.megaignore");
        model.addfile("fa");
        model.generate(lRoot);

        // Upload tree.
        ASSERT_TRUE(cu->uploadFolderTree(lRoot, rRoot.get()));
        ASSERT_TRUE(cu->uploadFilesInTree(lRoot, rRoot.get()));

        // Make sure everything made it up to the cloud.
        auto predicate = SyncRemoteMatch("x", model.root.get());
        ASSERT_TRUE(cu->waitFor(predicate, DEFAULTWAIT));

        // Make sure everyone agrees on the cloud's state.
        ASSERT_TRUE(cd->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cdu->waitFor(predicate, DEFAULTWAIT));
    }

    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Setup local FS.
    localFS.addfile(".megaignore", "-:fa\n+sync:.megaignore");

    // Setup remote tree.
    remoteTree = localFS;
    remoteTree.addfile("fa");

    // Add and start sync.
    fs::create_directories(root(*cd) / "root");

    auto id = setupSync(*cd, "root", "x", false);
    ASSERT_NE(id, UNDEF);

    // Wait for synchronization to complete.
    waitOnSyncs(cd);

    // Confirm models.
    ASSERT_TRUE(confirm(*cd, id, localFS));
    ASSERT_TRUE(confirm(*cd, id, remoteTree));

    // Remove x/.megaignore.
    {
        // MAke sure cdu sees cd's changes.
        auto predicate = SyncRemoteMatch("x", remoteTree.root.get());
        ASSERT_TRUE(cdu->waitFor(std::move(predicate), DEFAULTWAIT));

        // Remove x/.megaignore.
        ASSERT_TRUE(cdu->deleteremote("x/.megaignore"));
    }

    // Wait for sync.
    waitOnSyncs(cd);

    // Update models.
    // .megaignore -> gone.
    // fa should now be included.
    localFS.removenode(".megaignore");
    localFS.addfile("fa");

    remoteTree = localFS;

    // Confirm models.
    ASSERT_TRUE(confirm(*cd, id, localFS));
    ASSERT_TRUE(confirm(*cd, id, remoteTree));
}

TEST_F(CloudToLocalFilterFixture, MoveToIgnoredRubbishesRemote)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Set up local FS.
    localFS.addfile("f");
    localFS.addfile("g");
    localFS.addfile("x/.megaignore", "exclude-smaller:2\n+sync:.megaignore");
    localFS.addfile(".megaignore", "-:d\n+sync:.megaignore");
    localFS.generate(root(*cdu) / "root");

    // Set up remote tree.
    remoteTree = localFS;

    // Log in client.
    ASSERT_TRUE(cdu->makeCloudSubdirs("cdu", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Add and start sync.
    auto id = setupSync(*cdu, "root", "cdu", false);
    ASSERT_NE(id, UNDEF);

    // Wait for synchronization to complete.
    waitOnSyncs(cdu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cdu, id, localFS));
    ASSERT_TRUE(confirm(*cdu, id, remoteTree));

    // Create the directory d.
    {
        auto pauser = makeScopedSyncPauser(*cdu, id);

        vector<NewNode> nodes(1);

        cdu->prepareOneFolder(&nodes[0], "d", false);
        ASSERT_TRUE(cdu->putnodes("cdu", NoVersioning, std::move(nodes)));

        remoteTree.addfolder("d");

        // Wait for all the clients to see cdu's change.
        auto predicate = SyncRemoteMatch("cdu", remoteTree.root.get());
        ASSERT_TRUE(cd->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cdu->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cu->waitFor(predicate, DEFAULTWAIT));
    }

    // Wait for the sync to process the new directory.
    waitOnSyncs(cdu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cdu, id, localFS));
    ASSERT_TRUE(confirm(*cdu, id, remoteTree));

    {
        auto pauser = makeScopedSyncPauser(*cdu, id);

        // Move f to d/f.
        ASSERT_TRUE(cdu->movenode("cdu/f", "cdu/d"));

        // Move g to x/g.
        ASSERT_TRUE(cdu->movenode("cdu/g", "cdu/x"));

        // f and g should have been moved into the local debris.
        localFS.copynode("f", debrisFilePath("f"));
        localFS.removenode("f");

        // f has moved to d/f in the cloud.
        remoteTree.movenode("f", "d");

        localFS.copynode("g", debrisFilePath("g"));
        localFS.removenode("g");

        // g has moved to x/g in the cloud.
        remoteTree.movenode("g", "x");

        // Wait for all the clients to receive the changes.
        auto predicate = SyncRemoteMatch("cdu", remoteTree.root.get());
        ASSERT_TRUE(cd->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cdu->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cu->waitFor(predicate, DEFAULTWAIT));
    }

    // Wait for synchronization to complete.
    waitOnSyncs(cdu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cdu, id, localFS, false));
    ASSERT_TRUE(confirm(*cdu, id, remoteTree));
}

TEST_F(CloudToLocalFilterFixture, OverwriteExcluded)
{
    RemoteNodeModel remoteTree;

    // Set up local FS.
    LocalFSModel localFS;

    localFS.addfile("d/f");
    localFS.addfile("d/.megaignore", "+:f\n+sync:.megaignore");
    localFS.addfile("f");
    localFS.addfile(".megaignore", "+sync:.megaignore");
    localFS.generate(root(*cdu) / "root");

    // Cloud should be consistent with FS.
    remoteTree = localFS;

    // Log in client.
    ASSERT_TRUE(cdu->makeCloudSubdirs("x", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Add and start sync.
    auto id = setupSync(*cdu, "root", "x", false);
    ASSERT_NE(id, UNDEF);

    // Wait for synchronization to complete.
    waitOnSyncs(cdu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cdu, id, localFS));
    ASSERT_TRUE(confirm(*cdu, id, remoteTree));

    // Add an ignore file.
    localFS.addfile(".megaignore", "-:f\n+sync:.megaignore");
    localFS.generate(root(*cdu) / "root");

    // Remote's consistent with FS.
    remoteTree = localFS;

    // Wait for synchronization to complete.
    cdu->triggerPeriodicScanEarly(id);
    waitOnSyncs(cdu);

    // Confirm.
    ASSERT_TRUE(confirm(*cdu, id, localFS));
    ASSERT_TRUE(confirm(*cdu, id, remoteTree));

    // Move x/d/f to x, overwriting x/f.
    {
        auto pauser = makeScopedSyncPauser(*cdu, id);

        // Make sure cd has seen cdu's changes.
        auto predicate = SyncRemoteMatch("x", remoteTree.root.get());
        ASSERT_TRUE(cd->waitFor(predicate, DEFAULTWAIT));

        // Get a fix on x/f.
        auto node = cd->drillchildnodebyname(cd->gettestbasenode(), "x/f");
        ASSERT_TRUE(node);

        // Move x/d/f to x.
        ASSERT_TRUE(cd->movenode("x/d/f", "x"));

        // Remove original x/f.
        ASSERT_TRUE(cd->deleteremote(node.get()));

        // Update models.
        localFS.removenode("d/f");

        remoteTree.removenode("f");
        remoteTree.movenode("d/f", "");

        // Wait for all the clients to see our changes.
        ASSERT_TRUE(cd->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cdu->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cu->waitFor(predicate, DEFAULTWAIT));
    }

    // Wait for synchronization to complete.
    waitOnSyncs(cdu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cdu, id, localFS));
    ASSERT_TRUE(confirm(*cdu, id, remoteTree));
}

TEST_F(CloudToLocalFilterFixture, RenameToIgnoredRubbishesRemote)
{
    LocalFSModel localFS;
    RemoteNodeModel remoteTree;

    // Set up local FS.
    localFS.addfile(".megaignore", "-:y\n+sync:.megaignore");
    localFS.addfile("x");
    localFS.generate(root(*cdu) / "root");

    // Set up remote tree.
    remoteTree = localFS;

    // Log in client.
    ASSERT_TRUE(cdu->makeCloudSubdirs("cdu", 0, 0));
    ASSERT_TRUE(CatchupClients(cd, cdu, cu));

    // Add and start sync.
    auto id = setupSync(*cdu, "root", "cdu", false);
    ASSERT_NE(id, UNDEF);

    // Wait for synchronization to complete.
    waitOnSyncs(cdu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cdu, id, localFS));
    ASSERT_TRUE(confirm(*cdu, id, remoteTree));

    // Rename cdu/x to cdu/y.
    {
        auto pauser = makeScopedSyncPauser(*cdu, id);

        // Make sure cu's seen cdu's changes.
        auto predicate = SyncRemoteMatch("cdu", remoteTree.root.get());
        ASSERT_TRUE(cu->waitFor(predicate, DEFAULTWAIT));

        // Rename x to y.
        ASSERT_TRUE(cu->rename("cdu/x", "y"));

        // x will be moved into the local debris.
        localFS.copynode("x", debrisFilePath("x"));
        localFS.removenode("x");

        // x has become y in the cloud.
        remoteTree.copynode("x", "y");
        remoteTree.removenode("x");

        // Make sure all clients have seen our changes.
        ASSERT_TRUE(cd->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cdu->waitFor(predicate, DEFAULTWAIT));
        ASSERT_TRUE(cu->waitFor(predicate, DEFAULTWAIT));
    }

    // Wait for synchronization to complete.
    waitOnSyncs(cdu);

    // Confirm models.
    ASSERT_TRUE(confirm(*cdu, id, localFS, false));
    ASSERT_TRUE(confirm(*cdu, id, remoteTree));
}

TEST_F(SyncTest, StallsWhenDownloadTargetHasLongName)
{
    const string DIRECTORY_NAME(256, 'd');
    const string FILE_NAME(256, 'f');

    auto TESTROOT = makeNewTestRoot();
    auto TIMEOUT  = std::chrono::seconds(8);

    StandardClientInUse c = g_clientManager->getCleanStandardClient(0, TESTROOT);

    // Log callbacks.
    c->logcb = true;

    // Log in client.
    ASSERT_TRUE(c->resetBaseFolderMulticlient());
    ASSERT_TRUE(c->makeCloudSubdirs("s", 0, 0));
    ASSERT_TRUE(CatchupClients(c));

    // Add and start sync.
    auto id = c->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    // Wait for the initial sync to complete.
    waitonsyncs(TIMEOUT, c);

    // Create a directory for the engine to synchronize.
    {
        vector<NewNode> node(1);

        c->prepareOneFolder(&node[0], DIRECTORY_NAME, false);

        ASSERT_TRUE(c->putnodes("s", NoVersioning, std::move(node)));
    }

    // Wait for the engine to process remote changes.
    waitonsyncs(TIMEOUT, c);

    // Wait for the engine to stall.
    ASSERT_TRUE(c->waitFor(SyncStallState(true), TIMEOUT));

    // Retrieve a list of stalls from the client.]
    SyncStallInfoTests stalls;

    ASSERT_TRUE(c->syncStallDetected(stalls));

    // Make sure the stall record is populated.
    ASSERT_FALSE(stalls.local.empty());
    ASSERT_TRUE(stalls.cloud.empty());

    // Was the stall due to the directory with the insane name?
    {
        auto localPath = c->fsBasePath / "s" / DIRECTORY_NAME;
        auto cloudPath = "/mega_test_sync/s/" + DIRECTORY_NAME;

        ASSERT_EQ(stalls.local.begin()->first.toPath(false), path_u8string(localPath));

        ASSERT_TRUE(stalls.local.begin()->second.localPath2.localPath.empty());

        ASSERT_EQ(stalls.local.begin()->second.cloudPath1.cloudPath,
                  cloudPath);

        ASSERT_EQ(stalls.local.begin()->second.reason,
            SyncWaitReason::CannotCreateFolder);
        ASSERT_EQ(stalls.local.begin()->second.localPath1.problem,
            PathProblem::NameTooLongForFilesystem);
    }

    // Does the stall resolve if we remove the directory?
    ASSERT_TRUE(c->deleteremote("s/" + DIRECTORY_NAME));

    // Wait for the stall to resolve.
    ASSERT_TRUE(c->waitFor(SyncStallState(false), 2 * TIMEOUT));

    // Wait for the engine to process remote changes.
    waitonsyncs(TIMEOUT, c);

    // Upload a file for the engine to synchronize.
    ASSERT_TRUE(c->uploadFile(c->fsBasePath / "s" / ".megaignore", string(FILE_NAME), "s"));

    // Give the engine some time to synchronize the file.
    waitonsyncs(TIMEOUT, c);

    // Wait for the engine to stall.
    ASSERT_TRUE(c->waitFor(SyncStallState(true), TIMEOUT));

    // Retrieve a list of stalls from the client.]
    ASSERT_TRUE(c->syncStallDetected(stalls));

    // Make sure the stall record is populated.
    ASSERT_FALSE(stalls.local.empty());
    ASSERT_TRUE(stalls.cloud.empty());

    // Was the stall due to the file with the insane name?
    {
        auto localPath = c->fsBasePath / "s" / FILE_NAME;
        auto cloudPath = "/mega_test_sync/s/" + FILE_NAME;

        auto& sr = stalls.local.begin()->second;

        ASSERT_TRUE(sr.localPath1.localPath.toPath(false).find(".getxfer") != string::npos);

        ASSERT_EQ(sr.localPath2.localPath.toPath(false), path_u8string(localPath));

        ASSERT_EQ(sr.cloudPath1.cloudPath,
                  cloudPath);

        ASSERT_EQ(sr.cloudPath2.cloudPath,
            string(""));

        ASSERT_EQ(sr.reason,
            SyncWaitReason::DownloadIssue);
        ASSERT_EQ(sr.localPath2.problem,
            PathProblem::NameTooLongForFilesystem);
    }

    // Does the stall resolve if we remove the file?
    ASSERT_TRUE(c->deleteremote("s/" + FILE_NAME));

    // Wait for the stall to resolve.
    ASSERT_TRUE(c->waitFor(SyncStallState(false), 2 * TIMEOUT));
}

TEST_F(SyncTest, StallsWhenMoveTargetHasLongName)
{
    const string FILE_NAME(256, 'f');

    auto TESTROOT = makeNewTestRoot();
    auto TIMEOUT  = std::chrono::seconds(8);

    StandardClientInUse c = g_clientManager->getCleanStandardClient(0, TESTROOT);

    // Log callbacks.
    c->logcb = true;

    // Log in client.
    ASSERT_TRUE(c->resetBaseFolderMulticlient());
    ASSERT_TRUE(c->makeCloudSubdirs("s", 0, 0));
    ASSERT_TRUE(CatchupClients(c));

    // Add and start sync->
    auto id = c->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    // Create a tree for the engine to synchronize.
    Model model;

    model.addfile("d/f");
    model.generate(c->fsBasePath / "s");

    // Wait for synchronization to complete.
    waitonsyncs(TIMEOUT, c);

    // Was the file uploaded?
    ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));

    // Rename the file so that it has a really, really long name.
    ASSERT_TRUE(c->rename("s/d/f", FILE_NAME));

    // Give the engine some time to react to remote changes.
    waitonsyncs(TIMEOUT, c);

    // Wait for the engine to stall.
    ASSERT_TRUE(c->waitFor(SyncStallState(true), TIMEOUT));

    // Acquire stall records from the client.
    SyncStallInfoTests stalls;

    ASSERT_TRUE(c->syncStallDetected(stalls));

    // Is the stall record populated?
    ASSERT_TRUE(stalls.local.empty());
    ASSERT_FALSE(stalls.cloud.empty());

    auto& sr = stalls.cloud.begin()->second;

    // Was the stall due to the rename?
    ASSERT_EQ(sr.localPath1.localPath.toPath(false),
              path_u8string((c->fsBasePath / "s" / "d" / "f")));

    ASSERT_EQ(sr.localPath2.localPath.toPath(false),
              path_u8string((c->fsBasePath / "s" / "d" / FILE_NAME)));

    ASSERT_EQ(sr.cloudPath1.cloudPath,
        "/mega_test_sync/s/d/f");

    ASSERT_EQ(sr.cloudPath2.cloudPath,
        "/mega_test_sync/s/d/" + FILE_NAME);

    ASSERT_EQ(sr.reason,
        SyncWaitReason::MoveOrRenameCannotOccur);
    ASSERT_EQ(sr.localPath2.problem,
        PathProblem::NameTooLongForFilesystem);

    // Correcting the name should resolve the stall.
    ASSERT_TRUE(c->rename("s/d/" + FILE_NAME, "ff"));

    // Wait for the stall to resolve.
    ASSERT_TRUE(c->waitFor(SyncStallState(false), 2 * TIMEOUT));

    // Wait for the engine to complete the rename.
    waitonsyncs(TIMEOUT, c);

    // Was the rename propagated?
    model.findnode("d/f")->name = "ff";

    ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));

    // Move (and rename) the file such that it has a long name.
    ASSERT_TRUE(c->movenode("s/d/ff", "s", FILE_NAME));

    // Wait for the engine to process remote changes.
    waitonsyncs(TIMEOUT, c);

    // Wait for the engine to stall.
    ASSERT_TRUE(c->waitFor(SyncStallState(true), TIMEOUT));

    // Retrieve stall records from the client.
    ASSERT_TRUE(c->syncStallDetected(stalls));

    // Is the stall record actually populated?
    ASSERT_EQ(stalls.cloud.size(), static_cast<size_t>(2));
    ASSERT_TRUE(stalls.local.empty());

    auto cloud_sr_it = stalls.cloud.begin();

    auto& cloud_sr1 = cloud_sr_it->second;

    // First stall: DestinationPathInUnresolvedArea

    // Correct paths reported?
    ASSERT_EQ(cloud_sr1.cloudPath1.cloudPath,
              "/mega_test_sync/s/d/" + FILE_NAME);

    ASSERT_EQ(cloud_sr1.cloudPath2.cloudPath,
              "/mega_test_sync/s/" + FILE_NAME);

    ASSERT_EQ(cloud_sr1.localPath1.localPath.toPath(false),
              path_u8string((c->fsBasePath / "s" / "d" / "ff")));

    // Correct reasons reported?
    ASSERT_EQ(cloud_sr1.reason,
        SyncWaitReason::MoveOrRenameCannotOccur);
    ASSERT_EQ(cloud_sr1.localPath2.problem,
        PathProblem::DestinationPathInUnresolvedArea);

    // Second stall: NameTooLongForFilesystem
    ++cloud_sr_it;
    auto& cloud_sr2 = cloud_sr_it->second;

    // Correct paths reported?
    ASSERT_EQ(cloud_sr2.localPath1.localPath.toPath(false),
              path_u8string((c->fsBasePath / "s" / "d" / "ff")));

    ASSERT_EQ(cloud_sr2.localPath2.localPath.toPath(false),
              path_u8string((c->fsBasePath / "s" / FILE_NAME)));

    ASSERT_EQ(cloud_sr2.cloudPath1.cloudPath,
              "/mega_test_sync/s/d/ff");

    ASSERT_EQ(cloud_sr2.cloudPath2.cloudPath,
              "/mega_test_sync/s/" + FILE_NAME);

    // Correct reasons reported?
    ASSERT_EQ(cloud_sr2.reason,
        SyncWaitReason::MoveOrRenameCannotOccur);
    ASSERT_EQ(cloud_sr2.localPath2.problem,
        PathProblem::NameTooLongForFilesystem);

    // Renaming the file to something sane should resolve the stall.
    ASSERT_TRUE(c->rename("s/" + FILE_NAME, "fff"));

    // Wait for the stall to be resolved.
    ASSERT_TRUE(c->waitFor(SyncStallState(false), 2 * TIMEOUT));

    // Wait for the engine to process the move.
    waitonsyncs(TIMEOUT, c);

    // Did the engine action the move?
    model.findnode("d/ff")->name = "fff";
    model.movenode("d/fff", "");

    ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));
}

// SDK-1515: Edit and move, move and edit files with same fsid.
TEST_F(SyncTest, BasicSync_EditAndMove_MoveAndEdit)
{
    // std::fylesystem::path
    const fs::path fsTestRoot = makeNewTestRoot();

    // Path components
    const string testFolder = "TestBaseFolder";
    const string origFolder = "OrigFolder";
    const string destFolder = "DestFolder";

    // Files
    const string editMoveFile = "editThenMoveFile.txt";
    const string moveEditFile = "moveThenEditFile.txt";

    const std::chrono::seconds TIMEOUT = std::chrono::seconds(15);

    StandardClientInUse actor = g_clientManager->getCleanStandardClient(0, fsTestRoot);

    // Log callbacks.
    actor->logcb = true;

    // Log in client.
    ASSERT_TRUE(actor->resetBaseFolderMulticlient());
    ASSERT_TRUE(actor->makeCloudSubdirs(testFolder, 0, 0));
    ASSERT_TRUE(CatchupClients(actor));

    // Sync threads
    handle actorBackupId = actor->setupSync_mainthread(
            testFolder, testFolder,
            false, false );

    ASSERT_NE(actorBackupId, UNDEF);

    Model actorModel; // Confirm model.

    actorModel.addfile(origFolder + "/" + editMoveFile);
    actorModel.addfile(origFolder + "/" + moveEditFile);
    actorModel.addfolder(destFolder);

    // Model hierarchy on FS
    actorModel.generate(actor->fsBasePath / testFolder );

    waitonsyncs(TIMEOUT, actor);

    auto testRootNode = actorModel.findnode( "", nullptr );
    ASSERT_NE(nullptr, testRootNode);

    ASSERT_TRUE( actor->confirmModel_mainthread( testRootNode , actorBackupId));

     // Retrieve fsid from file to check it remains the same later
     // @param path fs path
    auto getFSID = [&](const fs::path path) -> handle {
        auto fsAccess = actor->client.fsaccess->newfileaccess(false);

        auto localPath = LocalPath::fromAbsolutePath(path.string());
        fsAccess->fopen(localPath, OPEN_RDONLY, FSLogging::logExceptFileNotFound);

        return fsAccess->fsid;
    };

    auto initialEditMoveFSId = getFSID(actor->fsBasePath / testFolder / origFolder / editMoveFile);
    ASSERT_NE(initialEditMoveFSId, UNDEF);

    auto initialMoveEditFSId = getFSID(actor->fsBasePath / testFolder / origFolder / moveEditFile);
    ASSERT_NE(initialMoveEditFSId, UNDEF);

    // Are distinct files
    ASSERT_NE( initialEditMoveFSId, initialMoveEditFSId );

    // Update the content of file
    // @param modelNode to the file to change
    // @param fs path to file
    // @param aditionalContent to append to file
    auto updateFile = [](Model::ModelNode* modelNode, const fs::path& path, const string& additionalContent) {
        //auto fileModelNodePtr = actorModel.findnode( pathToFile );
        std::ofstream alterFile(path, std::ios::app | std::ios::out);
        ASSERT_TRUE( alterFile.good());
        alterFile << additionalContent;
        modelNode->content += additionalContent;
        size_t alteredFileSize = static_cast<size_t>(alterFile.tellp());
        alterFile.close();
        ASSERT_EQ(modelNode->content.size(), alteredFileSize);
    };

    // Modify the first testing file. Content on Model
    updateFile(
        actorModel.findnode( origFolder + "/" + editMoveFile),
        actor->fsBasePath / testFolder / origFolder / editMoveFile,
        "New content for first edit then move file"
    );

    // std::filesystem move file on FS
    auto initialFilePath = actor->fsBasePath / testFolder / origFolder / editMoveFile;
    auto newFilePath     = actor->fsBasePath / testFolder / destFolder / editMoveFile;
    fs::rename( initialFilePath, newFilePath );

    // Move file on model
    ASSERT_TRUE( actorModel.movenode( origFolder + "/" + editMoveFile, destFolder ));

    // Second file move first then modify
    // std::filesystem move file on FS
    initialFilePath = actor->fsBasePath / testFolder / origFolder / moveEditFile;
    newFilePath     = actor->fsBasePath / testFolder / destFolder / moveEditFile;
    fs::rename( initialFilePath, newFilePath );

    //// Move file on model
    ASSERT_TRUE( actorModel.movenode( origFolder + "/" + moveEditFile, destFolder ));

    updateFile(
        actorModel.findnode(destFolder + "/" + moveEditFile),
        actor->fsBasePath / testFolder / destFolder / moveEditFile,
        "New content for second move then edit file"
    );

    waitonsyncs(TIMEOUT, actor);

    ASSERT_TRUE( actor->confirmModel_mainthread( testRootNode , actorBackupId));

    // Check the fsid of the test files are still the originals
    auto finalEditMoveFSId = getFSID(actor->fsBasePath / testFolder / destFolder / editMoveFile);
    ASSERT_EQ(initialEditMoveFSId, finalEditMoveFSId);

    auto finalMoveEditFSId = getFSID(actor->fsBasePath / testFolder / destFolder / moveEditFile);
    ASSERT_EQ(initialMoveEditFSId, finalMoveEditFSId);
}

TEST_F(SyncTest, BasicSync_RapidLocalChangesWhenUploadCompletes)
{
    auto TESTROOT = makeNewTestRoot();
    auto TIMEOUT  = std::chrono::seconds(8);

    auto c = g_clientManager->getCleanStandardClient(0, TESTROOT);
    ASSERT_TRUE(c->resetBaseFolderMulticlient());

    ASSERT_TRUE(c->makeCloudSubdirs("s", 0, 0));
    ASSERT_TRUE(CatchupClients(c));

    // Log callbacks.
    c->logcb = true;

    // Populate model and local filesystem.
    Model m;
    m.addfile(".megaignore", "+sync:.megaignore");
    m.addfile("f", randomData(1024));
    m.generate(c->fsBasePath / "s");

    // Add and start a sync.
    auto id = c->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    // Wait for the initial sync to complete.
    waitonsyncs(TIMEOUT, c);

    // Was the initial sync successful?
    ASSERT_TRUE(c->confirmModel_mainthread(m.root.get(), id));

    // Hook the transfer completed callback.
    //
    // The idea here is that we start hammering the engine with a bunch of
    // file change notifications, the goal of which is to confuse the engine
    // such that it no longer knows which side is "current."
    c->onTransferCompleted = [&c](Transfer*)
    {
        // Only call us once.
        c->onTransferCompleted = nullptr;
    };

    // Make a local change for the sync to upload.
    m.addfile("f", randomData(1024));
    m.generate(c->fsBasePath / "s");

    // wait for transfer completion and then cause a whole lot more updates
    for (int i = 0; i < 20000; ++i)
    {
        if (c->onTransferCompleted == nullptr) break;
        WaitMillisec(1);
    }

    // Update the file in a tight loop, while the sync runs.
    for (auto i = 0; i < 32; ++i)
    {
        m.addfile("f", randomData(1024));
        m.generate(c->fsBasePath / "s");

        std::this_thread::sleep_for(std::chrono::milliseconds(500));
    }

    // Wait for the engine to process the change.
    waitonsyncs(TIMEOUT, c);

    SyncStallInfoTests stalls;

    // Engine should not have stalled
    ASSERT_FALSE(c->syncStallDetected(stalls));

    // check we ended up with the final file
    ASSERT_TRUE(c->confirmModel_mainthread(m.root.get(), id));
}

TEST_F(SyncTest, MaximumTreeDepthBehavior)
{
    auto TIMEOUT = std::chrono::seconds(16);

    // Allocate a new client.
    auto client = g_clientManager->getCleanStandardClient(0, makeNewTestRoot());

    // Make sure the cloud is clean.
    ASSERT_TRUE(client->resetBaseFolderMulticlient());

    // Get our hands on the cloud root.
    auto root = client->gettestbasenode();
    ASSERT_NE(root, nullptr);

    // Create a deep hierarchy in the cloud.
    string remoteRootPath = "00";

    {
        vector<NewNode> nodes(Sync::MAX_CLOUD_DEPTH - root->depth() - 2);

        client->prepareOneFolder(&nodes[0], "00", false);

        nodes[0].nodehandle = 1;
        nodes[0].parenthandle = UNDEF;

        for (auto i = 1u; i < nodes.size(); ++i)
        {
            string buffer(2, '0');

            snprintf(&buffer[0], 3, "%02x", i);

            remoteRootPath.append(1, '/');
            remoteRootPath.append(buffer);

            client->prepareOneFolder(&nodes[i], std::move(buffer), false);

            nodes[i].nodehandle = i + 1;
            nodes[i].parenthandle = i;
        }

        client->received_node_actionpackets = false;
        ASSERT_TRUE(client->putnodes(root->nodeHandle(), NoVersioning, std::move(nodes)));
        ASSERT_TRUE(client->waitForNodesUpdated(16));
    }

    // Add and start a new sync.
    auto id = client->setupSync_mainthread("00", remoteRootPath, false, false);
    ASSERT_NE(id, UNDEF);

    // Wait for the initial sync to complete.
    waitonsyncs(TIMEOUT, client);

    // Make sure we haven't stalled.
    SyncStallInfoTests stalls;

    ASSERT_FALSE(client->syncStallDetected(stalls));

    // Add a new directory.
    //
    // Trying to synchronize this directory should trigger a stall as
    // doing so would violate the node depth limit.
    fs::create_directories(client->fsBasePath / "00" / "x");

    // Wait for the engine to detect a stall.
    ASSERT_TRUE(client->waitFor(SyncStallState(true), TIMEOUT));

    // Make sure the engine's actually recorded the stall.
    ASSERT_TRUE(client->syncStallDetected(stalls));
    ASSERT_FALSE(stalls.empty());

    // Check that the stall is due to the deep hierarchy.
    ASSERT_EQ(stalls.local.begin()->second.reason,
              SyncWaitReason::SyncItemExceedsSupportedTreeDepth);

    // Removing the directory should correct the stall.
    fs::remove_all(client->fsBasePath / "00" / "x");

    // Wait for the stall to resolve.
    ASSERT_TRUE(client->waitFor(SyncStallState(false), TIMEOUT));
}

TEST_F(SyncTest, StallsWhenEncounteringHardLink)
{
    auto TIMEOUT = std::chrono::seconds(16);

    // Get our hands on a client.
    auto client = g_clientManager->getCleanStandardClient(0, makeNewTestRoot());

    // Make sure the client's clean.
    ASSERT_TRUE(client->resetBaseFolderMulticlient());

    // Make sure the sync root exists in the cloud.
    ASSERT_TRUE(client->makeCloudSubdirs("s", 0, 0));

    // Populate model (and local filesystem.)
    Model model;

    model.addfile("f0");
    model.addfile("f1");
    model.generate(client->fsBasePath / "s");

    // Add and start sync.
    auto id = client->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    // Wait for the initial sync to complete.
    waitonsyncs(TIMEOUT, client);

    // Make sure everything got uploaded.
    ASSERT_TRUE(client->confirmModel_mainthread(model.root.get(), id));

    // Create a hard link to f0.
    LocalPath sourcePath;
    LocalPath targetPath;

    {
        auto source = client->fsBasePath / "s" / "f0";
        auto target = client->fsBasePath / "s" / "f2";

        ASSERT_NO_FATAL_FAILURE(client->createHardLink(source, target, sourcePath, targetPath));
    }

    // Wait for the engine to process our changes.
    waitonsyncs(TIMEOUT, client);

    // Wait for the engine to detect a stall.
    ASSERT_TRUE(client->waitFor(SyncStallState(true), TIMEOUT));

    // Make sure we've actually stalled.
    SyncStallInfoTests stalls;

    ASSERT_TRUE(client->syncStallDetected(stalls));

    // Check that we've stalled for the right reason.
    ASSERT_FALSE(stalls.local.empty());

    auto& sr = stalls.local.begin()->second;

    ASSERT_EQ(sr.localPath1.localPath, sourcePath);
    ASSERT_EQ(sr.localPath2.localPath, targetPath);
    ASSERT_EQ(sr.reason, SyncWaitReason::FileIssue);
    ASSERT_EQ(sr.localPath1.problem, PathProblem::DetectedHardLink);
    ASSERT_EQ(sr.localPath2.problem, PathProblem::DetectedHardLink);

    // Check if we can resolve the stall by removing the hardlink.
    ASSERT_NO_FATAL_FAILURE(client->unlinklocal(targetPath));

    // Wait for the stall to be resolved.
    ASSERT_TRUE(client->waitFor(SyncStallState(false), TIMEOUT));

    // Wait for the engine to process our changes.
    waitonsyncs(TIMEOUT, client);

    // Make sure nothing's changed in the cloud.
    ASSERT_TRUE(client->confirmModel_mainthread(model.root.get(), id));
}

TEST_F(SyncTest, MultipleStallsWhenEncounteringHardLink)
{
    auto TIMEOUT = std::chrono::seconds(16);

    // Get our hands on a client.
    auto client = g_clientManager->getCleanStandardClient(0, makeNewTestRoot());

    // Make sure the client's clean.
    ASSERT_TRUE(client->resetBaseFolderMulticlient());

    // Make sure the sync root exists in the cloud.
    ASSERT_TRUE(client->makeCloudSubdirs("s", 0, 0));

    // Populate model (and local filesystem.)
    Model model;

    model.addfile("f0");
    model.addfile("f1");
    model.addfile("d1/f2");
    model.addfile("d2/f3");
    model.addfile("d3/f4");
    model.generate(client->fsBasePath / "s");

    // Add and start sync.
    auto id = client->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    // Wait for the initial sync to complete.
    waitonsyncs(TIMEOUT, client);

    // Make sure everything got uploaded.
    ASSERT_TRUE(client->confirmModel_mainthread(model.root.get(), id));

    // Create a hard link to f0.
    LocalPath sourcePath;
    LocalPath targetPath;

    {
        const auto source = client->fsBasePath / "s" / "f0";
        const auto target = client->fsBasePath / "s" / "d1" / "f5";

        ASSERT_NO_FATAL_FAILURE(client->createHardLink(source, target, sourcePath, targetPath));
    }

    // Wait for the engine to process our changes.
    waitonsyncs(TIMEOUT, client);

    // Wait for the engine to detect a stall.
    ASSERT_TRUE(client->waitFor(SyncStallState(true), TIMEOUT));
    ASSERT_TRUE(client->waitFor(SyncTotalStallsStateUpdate(false), TIMEOUT)); // First time stall state, the update flag should be unset

    // Make sure we've actually stalled.
    SyncStallInfoTests stalls;
    ASSERT_TRUE(client->stallsDetected(stalls));

    // Check that we've stalled for the right reason.
    ASSERT_FALSE(stalls.local.empty());

    auto& sr = stalls.local.begin()->second;

    ASSERT_EQ(sr.localPath1.localPath, sourcePath);
    ASSERT_EQ(sr.localPath2.localPath, targetPath);
    ASSERT_EQ(sr.reason, SyncWaitReason::FileIssue);
    ASSERT_EQ(sr.localPath1.problem, PathProblem::DetectedHardLink);
    ASSERT_EQ(sr.localPath2.problem, PathProblem::DetectedHardLink);

    // Create another hard link to f1.
    LocalPath sourcePath2;
    LocalPath targetPath2;

    {
        auto source = client->fsBasePath / "s" / "d2" / "f3";
        auto target = client->fsBasePath / "s" / "d3" / "f6";

        ASSERT_NO_FATAL_FAILURE(client->createHardLink(source, target, sourcePath2, targetPath2));
    }

    // Wait for the engine to process our changes.
    waitonsyncs(TIMEOUT, client);

    // Wait for the engine to detect a stall update
    ASSERT_TRUE(client->waitForSyncTotalStallsStateUpdateTrue(TIMEOUT));

    // Make sure the stalls collection is updated
    stalls.clear();
    ASSERT_TRUE(client->stallsDetected(stalls));

    // Check that we've stalled for the right reason.
    ASSERT_EQ(stalls.local.size(), 2u);

    auto itLocalStalls = stalls.local.begin();
    auto& sr2 = itLocalStalls->second;

    ASSERT_EQ(sr2.localPath1.localPath, sourcePath);
    ASSERT_EQ(sr2.localPath2.localPath, targetPath);
    ASSERT_EQ(sr2.reason, SyncWaitReason::FileIssue);
    ASSERT_EQ(sr2.localPath1.problem, PathProblem::DetectedHardLink);
    ASSERT_EQ(sr2.localPath2.problem, PathProblem::DetectedHardLink);

    ++itLocalStalls;
    auto& sr3 = itLocalStalls->second;

    ASSERT_EQ(sr3.localPath1.localPath, sourcePath2);
    ASSERT_EQ(sr3.localPath2.localPath, targetPath2);
    ASSERT_EQ(sr3.reason, SyncWaitReason::FileIssue);
    ASSERT_EQ(sr3.localPath1.problem, PathProblem::DetectedHardLink);
    ASSERT_EQ(sr3.localPath2.problem, PathProblem::DetectedHardLink);

    // The stalls update flag should be false by now
    ASSERT_TRUE(client->waitFor(SyncTotalStallsStateUpdate(false), TIMEOUT));

    // Check if we can resolve the first stall by removing the hardlink.
    ASSERT_NO_FATAL_FAILURE(client->unlinklocal(targetPath));

    // Wait for the engine to process our changes.
    waitonsyncs(TIMEOUT, client);

    // Wait for the stall state to be updated. We should still have one stall (updated as we had two stalls before).
    ASSERT_TRUE(client->waitForSyncTotalStallsStateUpdateTrue(TIMEOUT));

    // Make sure the stalls collection is updated
    stalls.clear();
    ASSERT_TRUE(client->stallsDetected(stalls));

    // Check that we've stalled for the right reason.
    ASSERT_EQ(stalls.local.size(), 1u);

    itLocalStalls = stalls.local.begin();
    auto& sr4 = itLocalStalls->second;

    ASSERT_EQ(sr4.localPath1.localPath, sourcePath2);
    ASSERT_EQ(sr4.localPath2.localPath, targetPath2);
    ASSERT_EQ(sr4.reason, SyncWaitReason::FileIssue);
    ASSERT_EQ(sr4.localPath1.problem, PathProblem::DetectedHardLink);
    ASSERT_EQ(sr4.localPath2.problem, PathProblem::DetectedHardLink);

    // Check if we can resolve the second stall by removing the hardlink.
    ASSERT_NO_FATAL_FAILURE(client->unlinklocal(targetPath2));

    // Wait for the engine to process our changes.
    waitonsyncs(TIMEOUT, client);

    // Wait for the stall to be resolved.
    ASSERT_TRUE(client->waitFor(SyncStallState(false), TIMEOUT));
    ASSERT_TRUE(client->waitFor(SyncTotalStallsStateUpdate(false), TIMEOUT));

    // Make sure nothing's changed in the cloud.
    ASSERT_TRUE(client->confirmModel_mainthread(model.root.get(), id));
}

#ifndef _WIN32

TEST_F(SyncTest, ChangingDirectoryPermissions)
{
    auto TIMEOUT = chrono::seconds(16);

    // Get our hands on a client.
    auto client = g_clientManager->getCleanStandardClient(0, makeNewTestRoot());

    // Make sure the cloud's clean.
    ASSERT_TRUE(client->resetBaseFolderMulticlient());

    // Make sure the sync root exists in the cloud.
    ASSERT_TRUE(client->makeCloudSubdirs("s", 0, 0));

    // Prepare model (and local filesystem.)
    Model model;

    model.addfile("d/f");
    model.generate(client->fsBasePath / "s");

    // Add and start sync.
    auto id = client->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    // Wait for the initial sync to complete.
    waitonsyncs(TIMEOUT, client);

    // Make sure everything made it to the cloud.
    ASSERT_TRUE(client->confirmModel_mainthread(model.root.get(), id));

    const auto dPath = path_u8string((client->fsBasePath / "s" / "d"));

    // Use PermissionsHandler to handle directory permissions
    PermissionHandler dirPermissionHandler(dPath);
    ASSERT_TRUE(dirPermissionHandler.originalPermissionsAvailable()) << "Failed to retrieve original permissions for directory";

    // Remove execute permissions from the directory
    ASSERT_TRUE(dirPermissionHandler.removePermissions(fs::perms::owner_exec | fs::perms::group_exec | fs::perms::others_exec)) << "Execution permissions could not be removed";

    client->triggerPeriodicScanEarly(id);

    // Wait for the engine to detect a stall.
    ASSERT_TRUE(client->waitFor(SyncStallState(true), DEFAULTWAIT));

    // Make sure we've stalled for the right reason.
    SyncStallInfoTests stalls;
    ASSERT_TRUE(client->syncStallDetected(stalls));
    ASSERT_TRUE(stalls.cloud.empty());
    ASSERT_EQ(stalls.local.size(), 1u);
    ASSERT_EQ(stalls.local.begin()->second.reason, SyncWaitReason::FileIssue);

    // Make sure d/f is still present in the cloud.
    ASSERT_TRUE(client->waitFor(SyncRemoteNodePresent("s/d/f"), TIMEOUT));

    // Restore execute permissions to the directory.
    ASSERT_TRUE(dirPermissionHandler.restorePermissions()) << "Restoring execution permissions failed!!";

    client->triggerPeriodicScanEarly(id);

    // Wait for the stall to be resolved.
    ASSERT_TRUE(client->waitFor(SyncStallState(false), TIMEOUT));

    // Remove read permissions from the directory.
    ASSERT_TRUE(dirPermissionHandler.removePermissions(fs::perms::owner_read | fs::perms::group_read | fs::perms::others_read)) << "Read permissions could not be removed";

    client->triggerPeriodicScanEarly(id);

    // Wait for the engine to detect a stall.
    ASSERT_TRUE(client->waitFor(SyncStallState(true), TIMEOUT));

    // Make sure we've stalled for the right reason.
    ASSERT_TRUE(client->syncStallDetected(stalls));
    ASSERT_TRUE(stalls.cloud.empty());
    ASSERT_EQ(stalls.local.size(), 1u);
    ASSERT_EQ(stalls.local.begin()->second.reason, SyncWaitReason::FileIssue);

    // Make sure d/f is still present in the cloud.
    ASSERT_TRUE(client->waitFor(SyncRemoteNodePresent("s/d/f"), TIMEOUT));

    // Restore read permissions.
    ASSERT_TRUE(dirPermissionHandler.restorePermissions()) << "Restoring read permissions failed!!";

    client->triggerPeriodicScanEarly(id);

    // Wait for the stall to be resolved.
    ASSERT_TRUE(client->waitFor(SyncStallState(false), TIMEOUT));
}

TEST_F(SyncTest, StallsOnSpecialFile)
{
    auto TIMEOUT = chrono::seconds(16);

    // Allocate a client.
    auto client = g_clientManager->getCleanStandardClient(0, makeNewTestRoot());

    // Make sure the cloud's clean.
    ASSERT_TRUE(client->resetBaseFolderMulticlient());

    // Make sure a sync root exists in the cloud.
    ASSERT_TRUE(client->makeCloudSubdirs("s", 0, 0));

    // Prepare model (local filesystem.)
    Model model;

    model.generate(client->fsBasePath / "s");

    // Add and start sync.
    auto id = client->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    // Wait for initial sync to complete.
    waitonsyncs(TIMEOUT, client);

    // Make sure everything's as we expect.
    ASSERT_TRUE(client->confirmModel_mainthread(model.root.get(), id));

    // Create a pipe for the engine to stall on.
    const auto fPath = path_u8string((client->fsBasePath / "s" / "f"));

    ASSERT_EQ(mkfifo(fPath.c_str(), S_IRUSR | S_IWUSR), 0);

#ifdef __APPLE__
    // Trigger another event so that we detect the FIFO.
    model.addfile("g");
    model.generate(client->fsBasePath / "s");
#endif // __APPLE__

    client->triggerPeriodicScanEarly(id);

    // Wait for the engine to stall.
    ASSERT_TRUE(client->waitFor(SyncStallState(true), TIMEOUT));

    // Check that it stalled due to the pipe.
    SyncStallInfoTests stalls;

    ASSERT_TRUE(client->syncStallDetected(stalls));
    ASSERT_TRUE(stalls.cloud.empty());
    ASSERT_EQ(stalls.local.size(), 1u);
    ASSERT_EQ(stalls.local.begin()->second.reason, SyncWaitReason::FileIssue);

    // Remove the pipe.
    ASSERT_EQ(unlink(fPath.c_str()), 0);

    client->triggerPeriodicScanEarly(id);

    // Wait for the stall to resolve.
    ASSERT_TRUE(client->waitFor(SyncStallState(false), TIMEOUT));
}

#endif // ! _WIN32

TEST_F(SyncTest, ExistingCloudMoveTargetMovedToDebrisWhenSynced)
{
    auto TESTROOT = makeNewTestRoot();
    auto TIMEOUT  = std::chrono::seconds(8);

    StandardClientInUse c = g_clientManager->getCleanStandardClient(0, TESTROOT);

    // Log callbacks.
    c->logcb = true;

    // Log in client.
    ASSERT_TRUE(c->resetBaseFolderMulticlient());
    ASSERT_TRUE(c->makeCloudSubdirs("s", 0, 0));
    ASSERT_TRUE(CatchupClients(c));

    // Populate local tree.
    Model model;

    model.addfile(".megaignore", "+sync:.megaignore");
    model.addfile("fx");
    model.addfile("fy");
    model.generate(c->fsBasePath / "s");

    // Add and start sync->
    auto id = c->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    // Wait for initial sync to complete.
    waitonsyncs(TIMEOUT, c);

    // Make sure initial sync succeeded.
    ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));

    // Pause the sync so the changes below are seen as being atomic->
    ASSERT_TRUE(c->setSyncPausedByBackupId(id, true));

    // Rename fx -> fy.
    {
        // Get our hands on the original fy.
        auto root = c->gettestbasenode();
        ASSERT_NE(root, nullptr);

        auto fy = c->drillchildnodebyname(root, "s/fy");
        ASSERT_NE(fy, nullptr);

        // Rename fx -> fy.
        model.movetosynctrash("fy", "");
        model.findnode("fx")->name = "fy";

        c->received_node_actionpackets = false;
        ASSERT_TRUE(c->rename("s/fx", "fy"));
        ASSERT_TRUE(c->waitForNodesUpdated(16));

        // Remove original fy.
        c->received_node_actionpackets = false;
        ASSERT_TRUE(c->deleteremote(fy.get()));
        ASSERT_TRUE(c->waitForNodesUpdated(16));
    }

    // Unpause the sync->
    ASSERT_TRUE(c->setSyncPausedByBackupId(id, false));

    // Wait for engine to process changes.
    waitonsyncs(TIMEOUT, c);

    // Did we move the original fy into the debris?
    ASSERT_TRUE(c->confirmModel_mainthread(model.root.get(), id));
}

TEST_F(SyncTest, StallsWhenExistingCloudMoveTargetUnknown)
{
    auto TESTROOT = makeNewTestRoot();
    auto TIMEOUT  = std::chrono::seconds(8);

    StandardClientInUse c = g_clientManager->getCleanStandardClient(0, TESTROOT);

    // Log callbacks.
    c->logcb = true;

    // Log in client.
    ASSERT_TRUE(c->resetBaseFolderMulticlient());
    ASSERT_TRUE(c->makeCloudSubdirs("s", 0, 0));
    ASSERT_TRUE(CatchupClients(c));

    // Populate local tree.
    Model local;

    local.addfile(".megaignore", "+sync:.megaignore");
    local.addfile("fx");
    local.generate(c->fsBasePath / "s");

    // Add and start sync->
    auto id = c->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    // Wait for initial sync to complete.
    waitonsyncs(TIMEOUT, c);

    // Make sure initial sync succeeded.
    ASSERT_TRUE(c->confirmModel_mainthread(local.root.get(), id));

    // Pause the sync so below changes appear atomically.
    ASSERT_TRUE(c->setSyncPausedByBackupId(id, true));

    // Make sure we receive action packets.
    c->received_node_actionpackets = false;

    // Rename fx to fy.
    ASSERT_TRUE(c->rename("s/fx", "fy"));
    ASSERT_TRUE(c->waitForNodesUpdated(16u));

    // Add foreign fy.
    local.addfile("fy");
    local.generate(c->fsBasePath / "s");

    // The paused sync should have that LocalNode marked as needing scanning
    WaitMillisec(1000);

    // Unpause the sync so that the engine processes our changes.
    ASSERT_TRUE(c->setSyncPausedByBackupId(id, false));

    // Wait for the engine to process the changes.
    waitonsyncs(TIMEOUT, c);

    // Wait for the engine to report a stall.
    ASSERT_TRUE(c->waitFor(SyncStallState(true), TIMEOUT));

    // Make sure we stalled for the reason we expect.
    SyncStallInfoTests stalls;

    ASSERT_TRUE(c->syncStallDetected(stalls));

    // Correct number of stalls?
    ASSERT_EQ(stalls.local.size(), 1u);

    // Make sure the move hasn't occured on the local filesystem.
    ASSERT_TRUE(fs::exists(c->fsBasePath / "s" / "fx"));
}

TEST_F(SyncTest, StallsWhenExistingCloudMoveTargetUnsynced)
{
    auto TESTROOT = makeNewTestRoot();
    auto TIMEOUT  = std::chrono::seconds(8);

    StandardClientInUse c = g_clientManager->getCleanStandardClient(0, TESTROOT);

    // Log callbacks.
    c->logcb = true;

    // Log in client.
    ASSERT_TRUE(c->resetBaseFolderMulticlient());
    ASSERT_TRUE(c->makeCloudSubdirs("s", 0, 0));
    ASSERT_TRUE(CatchupClients(c));

    // Populate local tree.
    Model local;

    local.addfile(".megaignore", "+sync:.megaignore");
    local.addfile("fx");
    local.addfile("fy");
    local.generate(c->fsBasePath / "s");

    // Create a file for later use outside of the sync tree.
    ASSERT_TRUE(createFile(c->fsBasePath / "fy", "fy"));

    // Add and start sync->
    auto id = c->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    // Wait for initial sync to complete.
    waitonsyncs(TIMEOUT, c);

    // Make sure the sync succeeded.
    ASSERT_TRUE(c->confirmModel_mainthread(local.root.get(), id));

    // So that the engine perceives below changes as atomic->
    ASSERT_TRUE(c->setSyncPausedByBackupId(id, true));

    // Remotely rename fx -> fy.
    {
        // Get our hands on the original fy.
        auto root = c->gettestbasenode();
        ASSERT_NE(root, nullptr);

        auto fy = c->drillchildnodebyname(root, "s/fy");
        ASSERT_NE(fy, nullptr);

        // Rename fx -> fy.
        c->received_node_actionpackets = false;
        ASSERT_TRUE(c->rename("s/fx", "fy"));
        ASSERT_TRUE(c->waitForNodesUpdated(16));

        // Remove original fy.
        c->received_node_actionpackets = false;
        ASSERT_TRUE(c->deleteremote(fy.get()));
        ASSERT_TRUE(c->waitForNodesUpdated(16));
    }

    // Locally move external fy into place.
    fs::rename(c->fsBasePath / "fy",
               c->fsBasePath / "s" / "fy");

    // The paused sync should have that LocalNode marked as needing scanning
    WaitMillisec(1000);

    // Unpause the sync so the engine processes our changes.
    ASSERT_TRUE(c->setSyncPausedByBackupId(id, false));

    // Wait for engine to process changes.
    waitonsyncs(TIMEOUT, c);

    // Wait for engine to stall.
    ASSERT_TRUE(c->waitFor(SyncStallState(true), TIMEOUT));

    // Retrieve stalls from the engine.
    SyncStallInfoTests stalls;

    ASSERT_TRUE(c->syncStallDetected(stalls));

    // Correct number of stalls?
    ASSERT_EQ(stalls.local.size(), 1u);

    // Make sure we haven't moved fx on the local filesystem.
    ASSERT_TRUE(fs::exists(c->fsBasePath / "s" / "fx"));
}

#ifndef NDEBUG

TEST_F(SyncTest, MovedSyncedFileWhileDownloadInProgress)
{
    // checks upload also:
    //  - establish file f synced in the root of a sync
    //  - update f in the cloud, causing the sync to download it
    //  - simultaneous with the download, locally move f to d/f inside the sync
    // we expect the updated f's download to end up at d/f locally

    auto TIMEOUT = std::chrono::seconds(16);
    promise<void> waiter;

    // New client with folder s that will be the sync
    auto client = g_clientManager->getCleanStandardClient(0, makeNewTestRoot());
    ASSERT_TRUE(client->resetBaseFolderMulticlient());
    ASSERT_TRUE(client->makeCloudSubdirs("s", 0, 0));

    // Prepare the sync contents: s/d (directory) and s/f (file)
    Model model;
    model.addfolder("d");
    model.addfile("f", randomData(16384));
    model.generate(client->fsBasePath / "s");

    // Keep a log of expected file fingerprints.
    vector<FileFingerprint> fingerprints;
    fingerprints.emplace_back(client->fingerprint(client->fsBasePath / "s" / "f"));
    ASSERT_TRUE(fingerprints.back().isvalid);

    // Make the sync, and upsync
    auto id = client->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);
    waitonsyncs(TIMEOUT, client);
    ASSERT_TRUE(client->confirmModel_mainthread(model.root.get(), id));

    // Throttle download speed so that we can move the local file before the
    // engine finishes downloading the latest changes from the cloud.
    client->setDownloadSpeed(4);

    // functor to detect the sync starting moves
    auto onMoveBeginHandler = [&client, &waiter](const LocalPath&, const LocalPath&) {
        waiter.set_value();
        client->mOnMoveBegin = nullptr;
    };

    // functor to detct the sync adding downloads
    auto detectDownloadStart = [&client, &waiter](Transfer& transfer) {
        if (transfer.type != GET) return;
        waiter.set_value();
        client->mOnTransferAdded = nullptr;
    };

    client->mOnTransferAdded = detectDownloadStart;

    // Update f in the cloud (manual upload, making a version chain, and causing the sync to download it)
    {
        auto data = randomData(16384);
        auto path = client->fsBasePath / "f";  // (this is outside s) (outside the sync)

        // Create a temporary file to upload.
        ASSERT_TRUE(createFile(path, data));

        // Upload the file.
        ASSERT_TRUE(client->uploadFile(path, "s", 30, ClaimOldVersion));

        // Update model.
        model.findnode("f")->content = data;

        // Keep track of the file's new fingerprint.
        fingerprints.emplace_back(client->fingerprint(path));
        ASSERT_TRUE(fingerprints.back().isvalid);
    }

    // s/f is updated in cloud, is a new file with 1 version
    // Wait for the engine to add the download.
    ASSERT_NE(waiter.get_future().wait_for(TIMEOUT),
              future_status::timeout);

    // the download of f just started, super slow.  Prep to detect move
    waiter = promise<void>();
    client->mOnMoveBegin = onMoveBeginHandler;

    // Move the local s/f to s/d/f and wait (download is already started)
    fs::rename(client->fsBasePath / "s" / "f",
               client->fsBasePath / "s" / "d" / "f");

    // Wait for the engine to kick off the move.
    ASSERT_NE(waiter.get_future().wait_for(TIMEOUT),
              future_status::timeout);

    // Remove the throttle, let download and move race each other
    client->setDownloadSpeed(0);
    waitonsyncs(TIMEOUT, client);

    // We expect to find the downloaded file at s/d/f even though
    // initially it was downloading to s/f (this checks file content too)
    model.movenode("f", "d");
    ASSERT_TRUE(client->confirmModel_mainthread(model.root.get(), id, true));


    // --------- new sub-test.
    // upload a new version of file f and overwrite at s/d/f.  Race the download against a move back to s/f


    // Prep to detect download starting
    waiter = promise<void>();
    client->mOnTransferAdded = detectDownloadStart;
    client->setDownloadSpeed(4);

    // Overwrite s/d/f in the cloud with new file data.
    // (this will trigger the sync to start a download of it)
    {
        auto data = randomData(16384);
        auto path = client->fsBasePath / "f";  // (this is outside s) (outside the sync)

        // Create a temporary file to upload.
        ASSERT_TRUE(createFile(path, data));

        // Upload the file.
        ASSERT_TRUE(client->uploadFile(path, "s/d", 30, ClaimOldVersion));

        // Update model.
        model.findnode("d/f")->content = data;

        // Keep track of the file's new fingerprint.
        fingerprints.emplace_back(client->fingerprint(path));
        ASSERT_TRUE(fingerprints.back().isvalid);
    }

    // Wait for the sync download of s/d/f to begin.
    ASSERT_NE(waiter.get_future().wait_for(TIMEOUT), future_status::timeout);

    // Prep to detect the sync cloud move back to s/f
    waiter = promise<void>();
    client->mOnMoveBegin = onMoveBeginHandler;

    // Move s/d/f back to s/f.
    fs::rename(client->fsBasePath / "s" / "d" / "f",
               client->fsBasePath / "s" / "f");

    // Wait for the sync move to begin.
    ASSERT_NE(waiter.get_future().wait_for(TIMEOUT), future_status::timeout);

    // let the download and the move race each other
    client->setDownloadSpeed(0);
    waitonsyncs(TIMEOUT, client);

    // check the results: new file only at s/f  (checks file content)
    model.movenode("d/f", "");
    ASSERT_TRUE(client->confirmModel_mainthread(model.root.get(), id, true));


    // --------- new sub-test.
    // Repeat the test one more time so we can check stall state.
    // upload a new version of file f and overwrite at s/f.
    // Race the sync download against a move back to s/d/f
    // this time we Also overwrite different local file at s/d/f after the move
    // and that's where the stall comes from

    // Prep to detect download starting
    waiter = promise<void>();
    client->mOnTransferAdded = detectDownloadStart;
    client->setDownloadSpeed(4);

    // Overwrite a new version of s/f in the cloud.
    {
        auto data = randomData(16384);
        auto path = client->fsBasePath / "f";

        // Create a temporary file to upload.
        ASSERT_TRUE(createFile(path, data));

        // Upload the file.
        ASSERT_TRUE(client->uploadFile(path, "s", 30, ClaimOldVersion));

        // Update model.
        model.findnode("f")->content = data;

        // Keep track of the file's new fingerprint.
        fingerprints.emplace_back(client->fingerprint(path));
        ASSERT_TRUE(fingerprints.back().isvalid);
    }

    // Wait for the download to start.
    ASSERT_NE(waiter.get_future().wait_for(TIMEOUT), future_status::timeout);

    // New move waiter that uploads
    waiter = promise<void>();
    client->mOnMoveBegin = [&client, &waiter](const LocalPath&, const LocalPath&) {

        // Now we cause the stall
        // The sync just detected the local file moved to s/d/f and started a cloud move for it
        // We overwrite this local s/d/f file with new data.
        // The sync would want to upload it to s/d/f.
        // But that would clash with the move of the old file from s/f to s/d/f

        auto data = randomData(16384);
        ASSERT_TRUE(createFile(client->fsBasePath / "s" / "d" / "f", data));

        waiter.set_value();
        client->mOnMoveBegin = nullptr;
    };

    // Move local s/f back into s/d/f.
    fs::rename(client->fsBasePath / "s" / "f",
               client->fsBasePath / "s" / "d" / "f");

    // Wait for the engine to detect and kick off the mOnMoveBegin.
    ASSERT_NE(waiter.get_future().wait_for(TIMEOUT), future_status::timeout);
    client->setDownloadSpeed(0);
    waitonsyncs(TIMEOUT, client);

    // We should detect a stall:
    // download started from s/f
    // upload started from s/d/f
    // cloud moving s/f to s/d/f
    // so we should have an upload and download occurring at s/d/f, different new file content at both
    ASSERT_TRUE(client->waitFor(SyncStallState(true), TIMEOUT));

    // Resolve the stall by removing the local file.
    fs::remove(client->fsBasePath / "s" / "d" / "f");

    // Wait for the stall to resolve.
    ASSERT_TRUE(client->waitFor(SyncStallState(false), TIMEOUT));

    // Wait for the engine to synchronize changes.
    waitonsyncs(TIMEOUT, client);

    // Make sure everything downloaded okay.
    model.movenode("f", "d");
    ASSERT_TRUE(client->confirmModel_mainthread(model.root.get(), id, true));

    // Check that the version chain is as we expect.
    {
        // Get the node's fingerprints.
        auto fp = client->fingerprints("s/d/f");

        // Make sure we have the number we expect.
        ASSERT_EQ(fp.size(), 4u);

        // Check that they agree with our log.
        ASSERT_TRUE(std::equal(fingerprints.crbegin(),
                               fingerprints.crend(),
                               fp.cbegin()));
    }
}

#endif // ! NDEBUG

using StallEntryPredicate =
  std::function<bool(const SyncStallEntry&)>;

SyncWaitPredicate SyncHasLocalStallMatching(StallEntryPredicate predicate)
{
    return [predicate](StandardClient& client) {
        SyncStallInfoTests stalls;

        // Engine hasn't signalled any stalls.
        if (!client.syncStallDetected(stalls))
            return false;

        // Search for a matching local stall.
        for (const auto& record : stalls.local)
        {
            if (predicate(record.second))
                return true;
        }

        // Couldn't find a matching local stall.
        return false;
    };
}

SyncWaitPredicate SyncHasLocalStallMatching(SyncWaitReason reason,
                                            const fs::path& path0,
                                            PathProblem problem0,
                                            const fs::path& path1 = fs::path(),
                                            PathProblem problem1 = PathProblem::NoProblem)
{
    return SyncHasLocalStallMatching(
        [=](const SyncStallEntry& entry)
        {
            return entry.reason == reason && entry.localPath1.problem == problem0 &&
                   entry.localPath2.problem == problem1 &&
                   entry.localPath1.localPath.toPath(false) == path_u8string(path0) &&
                   entry.localPath2.localPath.toPath(false) == path_u8string(path1);
        });
}

static bool isDeferredPathProblem(PathProblem problem)
{
    return problem >= PathProblem::PutnodeDeferredByController
           && problem <= PathProblem::UploadDeferredByController;
}

static bool isDeferredStall(const SyncStallEntry& entry)
{
    return isDeferredPathProblem(entry.localPath1.problem)
           || isDeferredPathProblem(entry.localPath2.problem);
}

static bool hasDeferredStall(const SyncStallInfo& stalls)
{
    for (const auto& stalledSyncs : stalls.syncStallInfoMaps)
    {
        for (const auto& record : stalledSyncs.second.local)
        {
            if (isDeferredStall(record.second))
                return true;
        }
    }

    return false;
}

TEST_F(SyncTest, MoveJustAsPutNodesSent)
{
    auto TIMEOUT = std::chrono::seconds(16);

    // Get our hands on a clean client.
    auto client = g_clientManager->getCleanStandardClient(0, makeNewTestRoot());

    // Make sure the cloud is clear.
    ASSERT_TRUE(client->resetBaseFolderMulticlient());

    // Make sure a remote sync root exists.
    ASSERT_TRUE(client->makeCloudSubdirs("s", 0, 0));

    // Populate local filesystem.
    Model model;

    LOG_info << "test adds file f, content 'x'.  Will cause upload";
    model.addfolder("d");
    model.addfile("f", "x");
    model.generate(client->fsBasePath / "s");

    // Add and start sync.
    auto id = client->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    // Wait for the initial sync to complete.
    waitonsyncs(TIMEOUT, client);

    // Make sure our hierarchy made it into the cloud.
    ASSERT_TRUE(client->confirmModel_mainthread(model.root.get(), id));

    // Instantiate controller.
    auto controller = std::make_shared<StandardSyncController>();

    // Inject controller.
    client->setSyncController(controller);

    // Signal "deferred" stalls immediately.
    client->setIsImmediateStall(isDeferredStall);
    client->setHasImmediateStall(hasDeferredStall);

    // Make sure original stall predicates are restored, no matter what.
    auto resetter = makeScopedStallPredicateResetter(*client);

    // Inhibit completion of s/f's putnodes.
    controller->setDeferPutnodeCompletionCallback([&](const fs::path& path) {
        return client->fsBasePath / "s" / "f" == path;
    });

    LOG_info << "test updates file f, content 'y'.  Will cause upload";

    // Make a change to s/f.
    model.addfile("f", "y");
    model.generate(client->fsBasePath / "s");

    // Wait for the engine to detect our intentional stall.
    auto predicate =
      SyncHasLocalStallMatching(SyncWaitReason::UploadIssue,
                                client->fsBasePath / "s" / "f",
                                PathProblem::PutnodeCompletionDeferredByController);

    ASSERT_TRUE(client->waitFor(std::move(predicate), DEFAULTWAIT));

    LOG_info << "test Move the file elsewhere locally : s/f to s/d/f";

    // Move s/f to s/d/f while the putnode's completion is pending.
    fs::rename(client->fsBasePath / "s" / "f",
               client->fsBasePath / "s" / "d" / "f");

    model.movenode("f", "d");

    // Wait for the engine to signal a stall due to the move.
    //
    // The move can't complete because the move-source has an outstanding
    // putnodes request.
    //
    // The rationale behind this behavior is simply that we can't really
    // "rewind" a putnodes that we've sent. We have to let it complete.
    predicate =
      SyncHasLocalStallMatching(SyncWaitReason::MoveOrRenameCannotOccur,
                                client->fsBasePath / "s" / "f",
                                PathProblem::PutnodeCompletionPending,
                                client->fsBasePath / "s" / "d" / "f");

    ASSERT_TRUE(client->waitFor(std::move(predicate), DEFAULTWAIT));

    // Now that we know the move has been detected, we can allow the
    // engine to complete the pending putnode request.
    controller->setDeferPutnodeCompletionCallback(nullptr);

    // Wait for the engine to return to normal operation.
    ASSERT_TRUE(client->waitFor(SyncStallState(false), DEFAULTWAIT));

    // Wait for syncing to complete.
    waitonsyncs(TIMEOUT, client);

    // Make sure everything's as we expect.
    ASSERT_TRUE(client->confirmModel_mainthread(model.root.get(), id));

    // Try the same test in reverse.
    //
    // That is, process the move target first.

    // Inhibit completion of s/d/f's putnodes.
    controller->setDeferPutnodeCompletionCallback([&](const fs::path& path) {
        return client->fsBasePath / "s" / "d" / "f" == path;
    });

    LOG_info << "test File d/f already exists - update content from `y` to `z`.  Sync will upload, ending in putnodes";

    model.addfile("d/f", "z");
    model.generate(client->fsBasePath / "s");

    // Wait for the engine to detect our intentional stall.
    predicate =
      SyncHasLocalStallMatching(SyncWaitReason::UploadIssue,
                                client->fsBasePath / "s" / "d" / "f",
                                PathProblem::PutnodeCompletionDeferredByController);

    ASSERT_TRUE(client->waitFor(std::move(predicate), DEFAULTWAIT));

    LOG_info << "test Moves d/f into its parent folder. Sync will generate another putnodes, somewhat contrary to the other";
    model.movenode("d/f", "");

    fs::rename(client->fsBasePath / "s" / "d" / "f",
               client->fsBasePath / "s" / "f");

    // Wait for the engine to signal a stall due to the move.
    predicate =
      SyncHasLocalStallMatching(SyncWaitReason::MoveOrRenameCannotOccur,
                                client->fsBasePath / "s" / "d" / "f",
                                PathProblem::PutnodeCompletionPending,
                                client->fsBasePath / "s" / "f");

    ASSERT_TRUE(client->waitFor(std::move(predicate), DEFAULTWAIT));

    // Now that the move's been recognized, allow the putnodes to complete.
    controller->setDeferPutnodeCompletionCallback(nullptr);

    // Wait for the engine to return to normal operation.
    ASSERT_TRUE(client->waitFor(SyncStallState(false), DEFAULTWAIT));

    // Wait for syncing to complete.
    waitonsyncs(TIMEOUT, client);

    // Check that the client is as we expect.
    ASSERT_TRUE(client->confirmModel_mainthread(model.root.get(), id));
}

TEST_F(SyncTest, RemovedJustAsPutNodesSent)
{
    auto TIMEOUT = std::chrono::seconds(16);

    // Get our hands on a clean client.
    auto client = g_clientManager->getCleanStandardClient(0, makeNewTestRoot());

    // Make sure the cloud is clear.
    ASSERT_TRUE(client->resetBaseFolderMulticlient());

    // Make sure a remote sync root exists.
    ASSERT_TRUE(client->makeCloudSubdirs("s", 0, 0));

    // Add and start sync.
    auto id = client->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    // Populate local filesystem.
    Model model;

    LOG_info << "test adds local file s/f (containing x)";
    model.addfile("f", "x");
    model.generate(client->fsBasePath / "s");
    waitonsyncs(TIMEOUT, client);

    // Check if the cloud is as we expect.
    ASSERT_TRUE(client->confirmModel_mainthread(model.root.get(), id));

    // Instantiate controller.
    auto controller = std::make_shared<StandardSyncController>();

    // Inject controller.
    client->setSyncController(controller);

    // Signal "deferred" stalls immediately.
    client->setIsImmediateStall(isDeferredStall);
    client->setHasImmediateStall(hasDeferredStall);

    // Make sure original stall predicates are restored, no matter what.
    auto resetter = makeScopedStallPredicateResetter(*client);

    // Inhibit completion of s/f's putnodes.
    controller->setDeferPutnodeCompletionCallback([&](const fs::path& path) {
        return client->fsBasePath / "s" / "f" == path;
    });

    LOG_info << "test replaces local file content s/f (with y. was: x)";

    model.addfile("f", "y");
    model.generate(client->fsBasePath / "s");

    // Wait for the engine to detect our intentional stall.
    auto predicate =
      SyncHasLocalStallMatching(SyncWaitReason::UploadIssue,
                                client->fsBasePath / "s" / "f",
                                PathProblem::PutnodeCompletionDeferredByController);

    ASSERT_TRUE(client->waitFor(std::move(predicate), TIMEOUT));

    LOG_info << "test deletes local file s/f";

    // Remove s/f while its putnodes is still in progress.
    model.removenode("f");

    fs::remove(client->fsBasePath / "s" / "f");

    // Give the engine a little time to recognize the change.
    WaitMillisec(2 * 1000);

    // Let s/f's putnodes complete.
    controller->setDeferPutnodeCompletionCallback(nullptr);

    // Wait for the stall to be resolved.
    ASSERT_TRUE(client->waitFor(SyncStallState(false), TIMEOUT));

    // Wait for the engine to finish syncing.
    waitonsyncs(TIMEOUT, client);

    // Check if the cloud is as we expect.
    ASSERT_TRUE(client->confirmModel_mainthread(model.root.get(), id));

    // Try the same scenario when the file hasn't previously been synchronized.

    // Inhibit completion of s/g's putnodes.
    controller->setDeferPutnodeCompletionCallback([&](const fs::path& path) {
        return client->fsBasePath / "s" / "g" == path;
    });

    LOG_info << "test adds local file s/g (content: x)";

    model.addfile("g", "x");
    model.generate(client->fsBasePath / "s");

    // Wait for the engine to stall.
    predicate =
      SyncHasLocalStallMatching(SyncWaitReason::UploadIssue,
                                client->fsBasePath / "s" / "g",
                                PathProblem::PutnodeCompletionDeferredByController);

    ASSERT_TRUE(client->waitFor(std::move(predicate), TIMEOUT));

    LOG_info << "test removes local file s/g (content: x)";

    // Remove g.
    model.removenode("g");

    fs::remove(client->fsBasePath / "s" / "g");

    // Give the engine a little time to detect the change.
    WaitMillisec(2 * 1000);

    // Remove the block on s/g's putnodes.
    controller->setDeferPutnodeCompletionCallback(nullptr);

    // Wait for the stall to be resolved.
    ASSERT_TRUE(client->waitFor(SyncStallState(false), TIMEOUT));

    // Wait for the engine to synchronize our changes.
    waitonsyncs(TIMEOUT, client);

    // Make sure the cloud is as we expect.
    ASSERT_TRUE(client->confirmModel_mainthread(model.root.get(), id));
}

TEST_F(SyncTest, UndecryptableSharesBehavior)
{
    const auto TESTROOT = makeNewTestRoot();

    StandardClient client0(TESTROOT, "client0");
    StandardClient client1(TESTROOT, "client1");
    StandardClient client2(TESTROOT, "client2");

    // Log in the clients.
    ASSERT_TRUE(client0.login_reset("MEGA_EMAIL", "MEGA_PWD"));
    ASSERT_TRUE(client1.login_reset("MEGA_EMAIL_AUX", "MEGA_PWD_AUX"));
    ASSERT_TRUE(client2.login_reset("MEGA_EMAIL_AUX2", "MEGA_PWD_AUX2"));

    // Make sure our "contacts" know about each other.
    {
        // Convenience predicate.
        auto contactRequestReceived = [](handle id) {
            return [id](StandardClient& client) {
                return client.ipcr(id);
            };
        };
        auto contactRequestFnished = [](const string& email) {
            return [&email](StandardClient& client) {
                return !client.opcr(email);
            };
        };
        auto contactVerificationFinished = [](const string& email) {
            return [&email](StandardClient& client) {
                return client.isverified(email);
            };
        };

        // Convenience helper.
        auto contactAdd = [&](StandardClient& client, const string& name) {
            // Get our hands on the contact's email.
            const string email = Utils::getenv(name, "");
            // Get main client email.
            const string email0 = Utils::getenv("MEGA_EMAIL", "");

            // Are we already associated with this contact?
            if (client0.iscontact(email))
            {
                // Then remove them.
                ASSERT_TRUE(client0.rmcontact(email));
            }

            // Remove pending contact request, if any.
            if (client0.opcr(email))
            {
                ASSERT_TRUE(client0.opcr(email, OPCA_DELETE));
            }

            // Add the contact.
            auto id = client0.opcr(email, OPCA_ADD);
            ASSERT_NE(id, UNDEF) << "Undef id when trying to add the contact! email = '" << email << "'";

            // Wait for the contact to receive the request.
            ASSERT_TRUE(client.waitFor(contactRequestReceived(id), DEFAULTWAIT));

            // Accept the contact request.
            ASSERT_TRUE(client.ipcr(id, IPCA_ACCEPT));

            // Wait for the response to reach first client
            ASSERT_TRUE(client0.waitFor(contactRequestFnished(email), DEFAULTWAIT));

            // Verify contact credentials if they are not
            if (gManualVerification)
            {
                if (!client0.isverified(email))
                {
                    ASSERT_TRUE(client0.verifyCredentials(email));
                }
                if (!client.isverified(email0))
                {
                    ASSERT_TRUE(client.verifyCredentials(email0));
                }

                // Wait for contact verification
                ASSERT_TRUE(client0.waitFor(contactVerificationFinished(email), DEFAULTWAIT));
                ASSERT_TRUE(client.waitFor(contactVerificationFinished(email0), DEFAULTWAIT));
            }
        };

        // Introduce the contacts to each other.
        ASSERT_NO_FATAL_FAILURE(contactAdd(client1, "MEGA_EMAIL_AUX"));
        ASSERT_NO_FATAL_FAILURE(contactAdd(client2, "MEGA_EMAIL_AUX2"));
    }

    Model model;

    // Populate the local filesystem.
    model.addfile("t/f");
    model.addfile("u/f");
    model.addfile("v/f");
    model.addfile("f");
    model.addfile(".megaignore", "+sync:.megaignore");
    model.generate(client1.fsBasePath / "s");

    // Get our hands on the remote test root.
    auto r = client0.gettestbasenode();
    ASSERT_NE(r, nullptr);

    // Populate the remote test root.
    {
        auto sPath = client1.fsBasePath / "s";

        ASSERT_TRUE(client0.uploadFolderTree(sPath, r.get()));
        ASSERT_TRUE(client0.uploadFilesInTree(sPath, r.get()));
    }

    NodeHandle sh;

    // Get our hands on the remote sync root.
    {
        auto s = client0.drillchildnodebyname(r, "s");
        ASSERT_NE(s, nullptr);

        sh = s->nodeHandle();
    }

    // Share the test root with client 1.
    ASSERT_EQ(client0.opensharedialog(*r), API_OK);
    ASSERT_EQ(client0.share(*r, Utils::getenv("MEGA_EMAIL_AUX", ""), FULL), API_OK);
    ASSERT_TRUE(client1.waitFor(SyncRemoteNodePresent(*r), std::chrono::seconds(90)));

    // Reset to avoid keeping a shared_ptr<Node>
    // All shared_ptr<Node> have to be reseted before logout (avoid assert failure at Node::~Node)
    r.reset();

    // Share the sync root with client 2.
    ASSERT_EQ(client0.opensharedialog(sh), API_OK);
    ASSERT_EQ(client0.share(sh, Utils::getenv("MEGA_EMAIL_AUX2", ""), FULL), API_OK);
    ASSERT_TRUE(client2.waitFor(SyncRemoteNodePresent(sh), std::chrono::seconds(90)));

    // Add and start a new sync.
    auto id = UNDEF;

    // Add the sync.
    id = client1.setupSync_mainthread("s", sh, false, false);
    ASSERT_NE(id, UNDEF);

    // Wait for the initial sync to complete.
    waitonsyncs(DEFAULTWAIT, &client1);

    // Make sure the clients all agree with what's in the cloud.
    ASSERT_TRUE(client1.confirmModel_mainthread(model.root.get(), id));
    ASSERT_TRUE(client2.waitFor(SyncRemoteMatch(sh, model.root.get()), DEFAULTWAIT));

    // Log out the sharing client so that it doesn't maintain keys.
    ASSERT_TRUE(client0.logout(false));

    // Make a couple changes to client1's sync via client2.
    {
        // Nodes from client2's perspective.
        auto xs = client2.client.nodeByHandle(sh);
        ASSERT_NE(xs, nullptr);

        auto xt = client2.client.childnodebyname(xs.get(), "t");
        ASSERT_NE(xt, nullptr);

        auto xu = client2.client.childnodebyname(xs.get(), "u");
        ASSERT_NE(xu, nullptr);

        auto xv = client2.client.childnodebyname(xs.get(), "v");
        ASSERT_NE(xv, nullptr);

        // Create a new directory w under s.
        {
            vector<NewNode> node(1);

            client1.received_node_actionpackets = false;

            client2.prepareOneFolder(&node[0], "w", false);
            ASSERT_TRUE(client2.putnodes(xs->nodeHandle(), NoVersioning, std::move(node)));
            ASSERT_TRUE(client1.waitForNodesUpdated(30));
        }

        // Get our hands on w from client 2's perspective.
        auto xw = client2.client.childnodebyname(xs.get(), "w");
        ASSERT_NE(xw, nullptr);

        // Be certain that client 1 can see w.
        ASSERT_TRUE(client1.waitFor(SyncRemoteNodePresent(*xw), DEFAULTWAIT));

        // Let the engine try and process the change.
        waitonsyncs(DEFAULTWAIT, &client1);

        // Move t, u and v under w.
        client1.received_node_actionpackets = false;

        model.movenode("t", "w"); // from SRW

        ASSERT_TRUE(client2.movenode(xt->nodehandle, xw->nodehandle));
        ASSERT_TRUE(client1.waitForNodesUpdated(30));

        client1.received_node_actionpackets = false;

        model.movenode("u", "w"); // from SRW

        ASSERT_TRUE(client2.movenode(xu->nodehandle, xw->nodehandle));
        ASSERT_TRUE(client1.waitForNodesUpdated(30));

        client1.received_node_actionpackets = false;

        model.movenode("v", "w"); // from SRW

        ASSERT_TRUE(client2.movenode(xv->nodehandle, xw->nodehandle));
        ASSERT_TRUE(client1.waitForNodesUpdated(30));
    }

    // Wait for client 1, it must not generate a stall
    ASSERT_FALSE(client1.waitFor(SyncStallState(true), DEFAULTWAIT));

    // Temporarily log out client 1.
    //
    // Undecrpytable nodes won't be serialized.
    string session;

    client1.client.dumpsession(session);
    client1.localLogout();

    // Hook resume callback.
    promise<void> notify;

    // resumption probably triggers a sync_added() callback too, which can
    // be tracked by onAutoResumeResult, instead of by the onSyncStateConfig
    client1.mOnSyncStateConfig = [&](const SyncConfig& config) {
        if (config.mRunState != SyncRunState::Run)
            return;

        notify.set_value();
        client1.mOnSyncStateConfig = nullptr;
    };

    // Log the client back in.
    ASSERT_TRUE(client1.login_fetchnodesFromSession(session));

    // Wait for the sync to resume.
    ASSERT_NE(notify.get_future().wait_for(DEFAULTWAIT), future_status::timeout);

    // Give the sync some time to process changes.
    waitonsyncs(DEFAULTWAIT, &client1);

    // Wait for the engine once again to ensure it does not generate a stall.
    ASSERT_FALSE(client1.waitFor(SyncStallState(true), DEFAULTWAIT));
}

TEST_F(SyncTest, CloudHorizontalMoveChain)
{
    // Get our hands on a client.
    auto client = g_clientManager->getCleanStandardClient(0, makeNewTestRoot());

    // Make sure the cloud's clean.
    ASSERT_TRUE(client->resetBaseFolderMulticlient());

    // Create a directory for us to sync against.
    ASSERT_TRUE(client->makeCloudSubdirs("s", 0, 0));

    // Populate the local filesystem.
    Model model;

    model.addfile("q.txt");
    model.addfile("r.txt");
    model.addfile("s.txt");
    model.addfile(".megaignore", "+sync:.megaignore");
    model.generate(client->fsBasePath / "s");

    // Synchronize the files to the cloud.
    auto id = client->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    // Wait for the synchronization to complete.
    waitonsyncs(DEFAULTWAIT, client);

    // Make sure everything was uploaded successfully.
    ASSERT_TRUE(client->confirmModel_mainthread(model.root.get(), id));

    // Get our hands on the handles of the files we uploaded.
    auto qh = client->getNodeHandle("s/q.txt");
    ASSERT_NE(qh, UNDEF);
    auto rh = client->getNodeHandle("s/r.txt");
    ASSERT_NE(rh, UNDEF);
    auto sh = client->getNodeHandle("s/s.txt");
    ASSERT_NE(sh, UNDEF);

    // Rotate the cloud files: x -> y -> z -> x
    {
        auto pauser = makeScopedSyncPauser(*client, id);
        auto root = client->fsBasePath / "s";

        model.findnode("s.txt")->name = "t.txt";
        ASSERT_TRUE(client->rename(sh, "t.txt"));

        model.findnode("r.txt")->name = "s.txt";
        ASSERT_TRUE(client->rename(rh, "s.txt"));

        model.findnode("q.txt")->name = "r.txt";
        ASSERT_TRUE(client->rename(qh, "r.txt"));

        // Wait for our changes to hit the cloud.
        ASSERT_TRUE(client->waitFor(SyncRemoteMatch("s", model), DEFAULTWAIT));
    }

    // Wait for the engine to process our changes.
    waitonsyncs(DEFAULTWAIT, client);

    // Make sure everything was synchronized correctly.
    ASSERT_TRUE(client->confirmModel_mainthread(model.root.get(), id));

    // Make sure the nodes were truly moved.
    EXPECT_EQ(qh, client->getNodeHandle("s/r.txt"));
    EXPECT_EQ(rh, client->getNodeHandle("s/s.txt"));
    EXPECT_EQ(sh, client->getNodeHandle("s/t.txt"));
}

TEST_F(SyncTest, CloudHorizontalMoveCycle)
{
    // Get our hands on a client.
    auto client = g_clientManager->getCleanStandardClient(0, makeNewTestRoot());

    // Make sure the cloud's clean.
    ASSERT_TRUE(client->resetBaseFolderMulticlient());

    // Create a directory for us to sync against.
    ASSERT_TRUE(client->makeCloudSubdirs("s", 0, 0));

    // Populate the local filesystem.
    Model model;

    model.addfile("x.txt");
    model.addfile("y.txt");
    model.addfile("z.txt");
    model.generate(client->fsBasePath / "s");

    // Synchronize the files to the cloud.
    auto id = client->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    // Wait for the synchronization to complete.
    waitonsyncs(DEFAULTWAIT, client);

    // Make sure everything was uploaded successfully.
    ASSERT_TRUE(client->confirmModel_mainthread(model.root.get(), id));

    // Get our hands on the handles of the files we uploaded.
    auto xh = client->getNodeHandle("s/x.txt");
    ASSERT_NE(xh, UNDEF);
    auto yh = client->getNodeHandle("s/y.txt");
    ASSERT_NE(yh, UNDEF);
    auto zh = client->getNodeHandle("s/z.txt");
    ASSERT_NE(zh, UNDEF);

    // Rotate the cloud files: x -> y -> z -> x
    {
        auto pauser = makeScopedSyncPauser(*client, id);

        client->received_node_actionpackets = false;
        ASSERT_TRUE(client->rename(zh, "x.txt"));
        ASSERT_TRUE(client->waitForNodesUpdated(16));

        client->received_node_actionpackets = false;
        ASSERT_TRUE(client->rename(yh, "z.txt"));
        ASSERT_TRUE(client->waitForNodesUpdated(16));

        client->received_node_actionpackets = false;
        ASSERT_TRUE(client->rename(xh, "y.txt"));
        ASSERT_TRUE(client->waitForNodesUpdated(16));
    }

    // Wait for the engine to process our changes.
    waitonsyncs(DEFAULTWAIT, client);

    // Wait for the engine to stall.
    ASSERT_TRUE(client->waitFor(SyncStallState(true), DEFAULTWAIT));

    // Make sure we've stalled for the right reasons.
    {
        SyncStallInfoTests stalls;

        ASSERT_TRUE(client->syncStallDetected(stalls));
        ASSERT_EQ(stalls.cloud.size(), 3u);

        std::set<PathProblem> problems;
        std::set<SyncWaitReason> reasons;

        for (auto& i : stalls.cloud)
        {
            reasons.emplace(i.second.reason);
            problems.emplace(i.second.cloudPath1.problem);
            problems.emplace(i.second.cloudPath2.problem);
            problems.emplace(i.second.localPath1.problem);
            problems.emplace(i.second.localPath2.problem);
        }

        problems.erase(PathProblem::NoProblem);

        ASSERT_EQ(problems.size(), 1u);
        ASSERT_EQ(*problems.begin(), PathProblem::WaitingForAnotherMoveToComplete);

        ASSERT_EQ(reasons.size(), 1u);
        ASSERT_EQ(*reasons.begin(), SyncWaitReason::MoveOrRenameCannotOccur);
    }

    // Make sure nothing's changed on disk.
    EXPECT_TRUE(client->confirmModel_mainthread(
                  model.root.get(),
                  id,
                  false,
                  StandardClient::CONFIRM_LOCALFS));

    // Make sure the nodes haven't been moved in the cloud.
    EXPECT_EQ(xh, client->getNodeHandle("s/y.txt"));
    EXPECT_EQ(yh, client->getNodeHandle("s/z.txt"));
    EXPECT_EQ(zh, client->getNodeHandle("s/x.txt"));
}

TEST_F(SyncTest, CloudVerticalMoveChain)
{
    // Get our hands on a client.
    auto client = g_clientManager->getCleanStandardClient(0, makeNewTestRoot());

    // Make sure the cloud's clean.
    ASSERT_TRUE(client->resetBaseFolderMulticlient());

    // Create a directory for us to sync against.
    ASSERT_TRUE(client->makeCloudSubdirs("s", 0, 0));

    // Populate the local filesystem.
    Model model;

    model.addfile("q.txt");
    model.addfile("0/r.txt");
    model.addfile("0/1/s.txt");
    model.addfolder("0/1/2");
    model.generate(client->fsBasePath / "s");

    // Synchronize the files to the cloud.
    auto id = client->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    // Wait for the synchronization to complete.
    waitonsyncs(DEFAULTWAIT, client);

    // Make sure everything was uploaded successfully.
    ASSERT_TRUE(client->confirmModel_mainthread(model.root.get(), id));

    // Get our hands on the handles of the files we uploaded.
    auto qh = client->getNodeHandle("s/q.txt");
    ASSERT_NE(qh, UNDEF);
    auto rh = client->getNodeHandle("s/0/r.txt");
    ASSERT_NE(rh, UNDEF);
    auto sh = client->getNodeHandle("s/0/1/s.txt");
    ASSERT_NE(sh, UNDEF);

    // Rotate the local files: q -> 0/r -> 0/1/s -> 0/1/2/t
    {
        auto pauser = makeScopedSyncPauser(*client, id);

        auto node = model.removenode("0/1/s.txt");
        node->name = "t.txt";
        model.findnode("0/1/2")->addkid(std::move(node));

        client->received_node_actionpackets = false;
        ASSERT_TRUE(client->movenode(sh, "s/0/1/2", "t.txt"));
        ASSERT_TRUE(client->waitForNodesUpdated(16));

        node = model.removenode("0/r.txt");
        node->name = "s.txt";
        model.findnode("0/1")->addkid(std::move(node));

        client->received_node_actionpackets = false;
        ASSERT_TRUE(client->movenode(rh, "s/0/1", "s.txt"));
        ASSERT_TRUE(client->waitForNodesUpdated(16));

        node = model.removenode("q.txt");
        node->name = "r.txt";
        model.findnode("0")->addkid(std::move(node));

        client->received_node_actionpackets = false;
        ASSERT_TRUE(client->movenode(qh, "s/0", "r.txt"));
        ASSERT_TRUE(client->waitForNodesUpdated(16));
    }

    // Wait for the engine to process our changes.
    waitonsyncs(DEFAULTWAIT, client);

    // Make sure the moves were synchronized correctly.
    ASSERT_TRUE(client->confirmModel_mainthread(model.root.get(), id));

    // Make sure the nodes have actually been moved.
    EXPECT_EQ(qh, client->getNodeHandle("s/0/r.txt"));
    EXPECT_EQ(rh, client->getNodeHandle("s/0/1/s.txt"));
    EXPECT_EQ(sh, client->getNodeHandle("s/0/1/2/t.txt"));
}

TEST_F(SyncTest, CloudVerticalMoveCycle)
{
    // Get our hands on a client.
    auto client = g_clientManager->getCleanStandardClient(0, makeNewTestRoot());

    // Make sure the cloud's clean.
    ASSERT_TRUE(client->resetBaseFolderMulticlient());

    // Create a directory for us to sync against.
    ASSERT_TRUE(client->makeCloudSubdirs("s", 0, 0));

    // Populate the local filesystem.
    Model model;

    model.addfile("x.txt", "x");
    model.addfile("0/y.txt", "y");
    model.addfile("0/1/z.txt", "z");
    model.generate(client->fsBasePath / "s");

    // Synchronize the files to the cloud.
    auto id = client->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    // Wait for the synchronization to complete.
    waitonsyncs(DEFAULTWAIT, client);

    // Make sure everything was uploaded successfully.
    ASSERT_TRUE(client->confirmModel_mainthread(model.root.get(), id));

    // Get our hands on the handles of the files we uploaded.
    auto xh = client->getNodeHandle("s/x.txt");
    ASSERT_NE(xh, UNDEF);
    auto yh = client->getNodeHandle("s/0/y.txt");
    ASSERT_NE(yh, UNDEF);
    auto zh = client->getNodeHandle("s/0/1/z.txt");
    ASSERT_NE(zh, UNDEF);

    // Rotate the local files: x -> 0/y -> 0/1/z -> x
    {
        auto pauser = makeScopedSyncPauser(*client, id);

        client->received_node_actionpackets = false;
        ASSERT_TRUE(client->movenode(yh, "s/0/1", "z.txt"));
        ASSERT_TRUE(client->waitForNodesUpdated(16));

        client->received_node_actionpackets = false;
        ASSERT_TRUE(client->movenode(xh, "s/0", "y.txt"));
        ASSERT_TRUE(client->waitForNodesUpdated(16));

        client->received_node_actionpackets = false;
        ASSERT_TRUE(client->movenode(zh, "s", "x.txt"));
        ASSERT_TRUE(client->waitForNodesUpdated(16));
    }

    // Wait for the engine to process our changes.
    waitonsyncs(DEFAULTWAIT, client);

    // Wait for the engine to stall.
    ASSERT_TRUE(client->waitFor(SyncStallState(true), DEFAULTWAIT));

    // Make sure we've stalled for the right reasons.
    {
        SyncStallInfoTests stalls;

        ASSERT_TRUE(client->syncStallDetected(stalls));
        ASSERT_EQ(stalls.cloud.size(), 3u);

        std::set<PathProblem> problems;
        std::set<SyncWaitReason> reasons;

        for (auto& i : stalls.cloud)
        {
            reasons.emplace(i.second.reason);
            problems.emplace(i.second.cloudPath1.problem);
            problems.emplace(i.second.cloudPath2.problem);
            problems.emplace(i.second.localPath1.problem);
            problems.emplace(i.second.localPath2.problem);
        }

        problems.erase(PathProblem::NoProblem);

        ASSERT_EQ(problems.size(), 1u);
        ASSERT_EQ(*problems.begin(), PathProblem::WaitingForAnotherMoveToComplete);

        ASSERT_EQ(reasons.size(), 1u);
        ASSERT_EQ(*reasons.begin(), SyncWaitReason::MoveOrRenameCannotOccur);
    }

    // Make sure nothing's changed on the local filesystem.
    ASSERT_TRUE(client->confirmModel_mainthread(
                  model.root.get(),
                  id,
                  false,
                  StandardClient::CONFIRM_LOCALFS));

    // Make sure the cloud remains the way we made it.
    EXPECT_EQ(xh, client->getNodeHandle("s/0/y.txt"));
    EXPECT_EQ(yh, client->getNodeHandle("s/0/1/z.txt"));
    EXPECT_EQ(zh, client->getNodeHandle("s/x.txt"));
}

TEST_F(SyncTest, LocalHorizontalMoveChain)
{
    // Get our hands on a client.
    auto client = g_clientManager->getCleanStandardClient(0, makeNewTestRoot());

    // Make sure the cloud's clean.
    ASSERT_TRUE(client->resetBaseFolderMulticlient());

    // Create a directory for us to sync against.
    ASSERT_TRUE(client->makeCloudSubdirs("s", 0, 0));

    // Populate the local filesystem.
    Model model;

    model.addfile("q.txt");
    model.addfile("r.txt");
    model.addfile("s.txt");
    model.generate(client->fsBasePath / "s");

    // Synchronize the files to the cloud.
    auto id = client->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    // Wait for the synchronization to complete.
    waitonsyncs(DEFAULTWAIT, client);

    // Make sure everything was uploaded successfully.
    ASSERT_TRUE(client->confirmModel_mainthread(model.root.get(), id));

    // Get our hands on the handles of the files we uploaded.
    auto qh = client->getNodeHandle("s/q.txt");
    ASSERT_NE(qh, UNDEF);
    auto rh = client->getNodeHandle("s/r.txt");
    ASSERT_NE(rh, UNDEF);
    auto sh = client->getNodeHandle("s/s.txt");
    ASSERT_NE(sh, UNDEF);

    // Rotate the local files: x -> y -> z -> x
    {
        auto pauser = makeScopedSyncPauser(*client, id);
        auto root = client->fsBasePath / "s";

        model.findnode("s.txt")->name = "t.txt";
        fs::rename(root / "s.txt", root / "t.txt");

        model.findnode("r.txt")->name = "s.txt";
        fs::rename(root / "r.txt", root / "s.txt");

        model.findnode("q.txt")->name = "r.txt";
        fs::rename(root / "q.txt", root / "r.txt");
    }

    // Wait for the engine to process our changes.
    waitonsyncs(DEFAULTWAIT, client);

    // Make sure the engine correctly performed the moves.
    ASSERT_TRUE(client->confirmModel_mainthread(model.root.get(), id));

    // Nothing should've moved in the cloud.
    EXPECT_EQ(qh, client->getNodeHandle("s/r.txt"));
    EXPECT_EQ(rh, client->getNodeHandle("s/s.txt"));
    EXPECT_EQ(sh, client->getNodeHandle("s/t.txt"));
}

TEST_F(SyncTest, LocalHorizontalMoveCycle)
{
    // Get our hands on a client.
    auto client = g_clientManager->getCleanStandardClient(0, makeNewTestRoot());

    // Make sure the cloud's clean.
    ASSERT_TRUE(client->resetBaseFolderMulticlient());

    // Create a directory for us to sync against.
    ASSERT_TRUE(client->makeCloudSubdirs("s", 0, 0));

    // Populate the local filesystem.
    Model model;

    model.addfile("x.txt");
    model.addfile("y.txt");
    model.addfile("z.txt");
    model.generate(client->fsBasePath / "s");

    // Synchronize the files to the cloud.
    auto id = client->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    // Wait for the synchronization to complete.
    waitonsyncs(DEFAULTWAIT, client);

    // Make sure everything was uploaded successfully.
    ASSERT_TRUE(client->confirmModel_mainthread(model.root.get(), id));

    // Get our hands on the handles of the files we uploaded.
    auto xh = client->getNodeHandle("s/x.txt");
    ASSERT_NE(xh, UNDEF);
    auto yh = client->getNodeHandle("s/y.txt");
    ASSERT_NE(yh, UNDEF);
    auto zh = client->getNodeHandle("s/z.txt");
    ASSERT_NE(zh, UNDEF);

    // Rotate the local files: x -> y -> z -> x
    {
        auto pauser = makeScopedSyncPauser(*client, id);
        auto root = client->fsBasePath / "s";

        model.findnode("z.txt")->name = "w.txt";
        fs::rename(root / "z.txt", root / "w.txt");

        model.findnode("y.txt")->name = "z.txt";
        fs::rename(root / "y.txt", root / "z.txt");

        model.findnode("x.txt")->name = "y.txt";
        fs::rename(root / "x.txt", root / "y.txt");

        model.findnode("w.txt")->name = "x.txt";
        fs::rename(root / "w.txt", root / "x.txt");
    }

    // Wait for the engine to process our changes.
    waitonsyncs(DEFAULTWAIT, client);

    // Wait for the engine to stall.
    ASSERT_TRUE(client->waitFor(SyncStallState(true), DEFAULTWAIT));

    // Make sure we've stalled for the right reasons.
    {
        SyncStallInfoTests stalls;

        ASSERT_TRUE(client->syncStallDetected(stalls));
        ASSERT_EQ(stalls.local.size(), 3u);

        std::set<PathProblem> problems;
        std::set<SyncWaitReason> reasons;

        for (auto& i : stalls.local)
        {
            reasons.emplace(i.second.reason);
            problems.emplace(i.second.cloudPath1.problem);
            problems.emplace(i.second.cloudPath2.problem);
            problems.emplace(i.second.localPath1.problem);
            problems.emplace(i.second.localPath2.problem);
        }

        problems.erase(PathProblem::NoProblem);

        ASSERT_EQ(problems.size(), 1u);
        ASSERT_EQ(*problems.begin(), PathProblem::WaitingForAnotherMoveToComplete);

        ASSERT_EQ(reasons.size(), 1u);
        ASSERT_EQ(*reasons.begin(), SyncWaitReason::MoveOrRenameCannotOccur);
    }

    // Nothing should've moved in the cloud.
    EXPECT_EQ(xh, client->getNodeHandle("s/x.txt"));
    EXPECT_EQ(yh, client->getNodeHandle("s/y.txt"));
    EXPECT_EQ(zh, client->getNodeHandle("s/z.txt"));
}

TEST_F(SyncTest, LocalVerticalMoveChain)
{
    // Get our hands on a client.
    auto client = g_clientManager->getCleanStandardClient(0, makeNewTestRoot());

    // Make sure the cloud's clean.
    ASSERT_TRUE(client->resetBaseFolderMulticlient());

    // Create a directory for us to sync against.
    ASSERT_TRUE(client->makeCloudSubdirs("s", 0, 0));

    // Populate the local filesystem.
    Model model;

    model.addfile("q.txt");
    model.addfile("0/r.txt");
    model.addfile("0/1/s.txt");
    model.addfolder("0/1/2");
    model.generate(client->fsBasePath / "s");

    // Synchronize the files to the cloud.
    auto id = client->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    // Wait for the synchronization to complete.
    waitonsyncs(DEFAULTWAIT, client);

    // Make sure everything was uploaded successfully.
    ASSERT_TRUE(client->confirmModel_mainthread(model.root.get(), id));

    // Get our hands on the handles of the files we uploaded.
    auto qh = client->getNodeHandle("s/q.txt");
    ASSERT_NE(qh, UNDEF);
    auto rh = client->getNodeHandle("s/0/r.txt");
    ASSERT_NE(rh, UNDEF);
    auto sh = client->getNodeHandle("s/0/1/s.txt");
    ASSERT_NE(sh, UNDEF);

    // Rotate the local files: q -> 0/r -> 0/1/s -> 0/1/2/t.
    {
        auto pauser = makeScopedSyncPauser(*client, id);
        auto root = client->fsBasePath / "s";

        auto node = model.removenode("0/1/s.txt");
        node->name = "t.txt";
        model.findnode("0/1/2")->addkid(std::move(node));

        fs::rename(root / "0" / "1" / "s.txt",
                   root / "0" / "1" / "2" / "t.txt");

        node = model.removenode("0/r.txt");
        node->name = "s.txt";
        model.findnode("0/1")->addkid(std::move(node));

        fs::rename(root / "0" / "r.txt",
                   root / "0" / "1" / "s.txt");

        node = model.removenode("q.txt");
        node->name = "r.txt";
        model.findnode("0")->addkid(std::move(node));

        fs::rename(root / "q.txt",
                   root / "0" / "r.txt");
    }

    // Wait for the engine to process our changes.
    waitonsyncs(DEFAULTWAIT, client);

    // Make sure everything was synchronized correctly.
    ASSERT_TRUE(client->confirmModel_mainthread(model.root.get(), id));

    // Make sure the nodes were truly moved.
    EXPECT_EQ(qh, client->getNodeHandle("s/0/r.txt"));
    EXPECT_EQ(rh, client->getNodeHandle("s/0/1/s.txt"));
    EXPECT_EQ(sh, client->getNodeHandle("s/0/1/2/t.txt"));
}

TEST_F(SyncTest, LocalVerticalMoveCycle)
{
    // Get our hands on a client.
    auto client = g_clientManager->getCleanStandardClient(0, makeNewTestRoot());

    // Make sure the cloud's clean.
    ASSERT_TRUE(client->resetBaseFolderMulticlient());

    // Create a directory for us to sync against.
    ASSERT_TRUE(client->makeCloudSubdirs("s", 0, 0));

    // Populate the local filesystem.
    Model model;

    model.addfile("x.txt", "x");
    model.addfile("0/y.txt", "y");
    model.addfile("0/1/z.txt", "z");
    model.generate(client->fsBasePath / "s");

    // Synchronize the files to the cloud.
    auto id = client->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    // Wait for the synchronization to complete.
    waitonsyncs(DEFAULTWAIT, client);

    // Make sure everything was uploaded successfully.
    ASSERT_TRUE(client->confirmModel_mainthread(model.root.get(), id));

    // Get our hands on the handles of the files we uploaded.
    auto xh = client->getNodeHandle("s/x.txt");
    ASSERT_NE(xh, UNDEF);
    auto yh = client->getNodeHandle("s/0/y.txt");
    ASSERT_NE(yh, UNDEF);
    auto zh = client->getNodeHandle("s/0/1/z.txt");
    ASSERT_NE(zh, UNDEF);

    // Rotate the local files: x -> 0/y -> 0/1/z -> x
    {
        auto pauser = makeScopedSyncPauser(*client, id);
        auto root = client->fsBasePath / "s";

        fs::rename(root / "0" / "1" / "z.txt", root / "z.txt");

        model.findnode("0/1/z.txt")->content = "y";
        fs::rename(root / "0" / "y.txt", root / "0" / "1" / "z.txt");

        model.findnode("0/y.txt")->content = "x";
        fs::rename(root / "x.txt", root / "0" / "y.txt");

        model.findnode("x.txt")->content = "z";
        fs::rename(root / "z.txt", root / "x.txt");
    }

    // Wait for the engine to process our changes.
    waitonsyncs(DEFAULTWAIT, client);

    // Wait for the engine to stall.
    ASSERT_TRUE(client->waitFor(SyncStallState(true), DEFAULTWAIT));

    // Make sure we've stalled for the right reasons.
    {
        SyncStallInfoTests stalls;

        ASSERT_TRUE(client->syncStallDetected(stalls));
        ASSERT_EQ(stalls.local.size(), 3u);

        std::set<PathProblem> problems;
        std::set<SyncWaitReason> reasons;

        for (auto& i : stalls.local)
        {
            reasons.emplace(i.second.reason);
            problems.emplace(i.second.cloudPath1.problem);
            problems.emplace(i.second.cloudPath2.problem);
            problems.emplace(i.second.localPath1.problem);
            problems.emplace(i.second.localPath2.problem);
        }

        problems.erase(PathProblem::NoProblem);

        ASSERT_EQ(problems.size(), 1u);
        ASSERT_EQ(*problems.begin(), PathProblem::WaitingForAnotherMoveToComplete);

        ASSERT_EQ(reasons.size(), 1u);
        ASSERT_EQ(*reasons.begin(), SyncWaitReason::MoveOrRenameCannotOccur);
    }

    // Make sure nothign changed in the cloud.
    EXPECT_EQ(xh, client->getNodeHandle("s/x.txt"));
    EXPECT_EQ(yh, client->getNodeHandle("s/0/y.txt"));
    EXPECT_EQ(zh, client->getNodeHandle("s/0/1/z.txt"));
}


TEST_F(SyncTest, SyncUtf8DifferentlyNormalized1)
{
    fs::path localtestroot = makeNewTestRoot();
    auto client = g_clientManager->getCleanStandardClient(0, localtestroot);
    ASSERT_TRUE(client->resetBaseFolderMulticlient());

    ASSERT_TRUE(client->makeCloudSubdirs("s", 0, 0));

    string name1 = "\x73\x6f\x75\x68\x6c\x61\x73\x20\x73\x20\x6b\x6f\x70\x69\xc3\xad\x20\x43\x50";  // from cloud - therefore, this is the normalized form we use
    string name2 = "\x73\x6f\x75\x68\x6c\x61\x73\x20\x73\x20\x6b\x6f\x70\x69\x69\xcc\x81\x20\x43\x50"; // form from Mac FS

    fs::path n1_utf8 = u8path_compat(name1);
    fs::path n2_utf8 = u8path_compat(name2);

    string convertedback_1 = path_u8string(n1_utf8);
    string convertedback_2 = path_u8string(n2_utf8);

    ASSERT_EQ(convertedback_1.size(), name1.size());
    ASSERT_EQ(convertedback_2.size(), name2.size());

    LocalPath::utf8_normalize(&convertedback_1);
    LocalPath::utf8_normalize(&convertedback_2);
    ASSERT_EQ(convertedback_1, convertedback_2);
    ASSERT_EQ(convertedback_2, name1);

    // Make a cloud node with one normalization
    ASSERT_TRUE(createNameFile(localtestroot, name1));
    ASSERT_TRUE(client->uploadFile(localtestroot / n1_utf8, "s"));

    auto root = client->fsBasePath / "s";

    // Same file in the sync locally, but name encoded differently
    fs::create_directory(root);
    fs::copy(localtestroot / n1_utf8, root / n2_utf8);

    // Set up the sync and see how it deals with those (may vary by platform, Mac auto normalizes filesnames for example (with some other normalization than we chose))
    auto id = client->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);
    WaitMillisec(1000);

    // Wait for the synchronization to complete.
    auto waitResult = waitonsyncs(std::chrono::seconds(5), client);
    if (auto stallsDetected = !noSyncStalled(waitResult); stallsDetected)
    {
        printStallIssues(*client);
        ASSERT_TRUE(!stallsDetected) << "stall issues detected";
    }

    Model model;
    model.addfile(name1)->fsName(name2);

    // Make sure everything was uploaded successfully.
    ASSERT_TRUE(client->confirmModel_mainthread(model.root.get(), id));


}

TEST_F(SyncTest, RemoveSync)
{
    // Set up a client
    fs::path localtestroot = makeNewTestRoot();
    auto clientA1 = g_clientManager->getCleanStandardClient(0, localtestroot); // user 1 client 1

    // Create remote dir
    ASSERT_TRUE(clientA1->resetBaseFolderMulticlient());
    ASSERT_TRUE(clientA1->makeCloudSubdirs("f", 0, 0));

    // create sync
    handle backupId1 = clientA1->setupSync_mainthread("sync1", "f", false, true);
    ASSERT_NE(backupId1, UNDEF);
    waitonsyncs(std::chrono::seconds(4), clientA1);
    auto* sync = clientA1->syncByBackupId(backupId1);
    ASSERT_NE(sync, nullptr);

    // Delete the sync and make sure it is disable
    clientA1->onRemovedSync = [](const SyncConfig& config)
    {
        ASSERT_EQ(config.mRunState, SyncRunState::Disable);
    };
    clientA1->delSync_mainthread(backupId1);
}

#ifdef _WIN32

TEST_F(SyncTest, IgnoreFilesShouldBeHidden)
{
    // Get our hands on a new client.
    auto client = g_clientManager->getCleanStandardClient(0, makeNewTestRoot());

    // Make sure the cloud's clean.
    ASSERT_TRUE(client->resetBaseFolderMulticlient());

    Model model;

    // Compute sync path for convenience.
    auto rootPath = client->fsBasePath / "s";

    // Populate the model with a couple ignore files.
    model.addfile(".megaignore", "#s\n+sync:.megaignore");
    model.addfile("sd0/sd0d0/.megaignore", "#sd0d0\n+sync:.megaignore");

    // Populate the local disk.
    model.generate(rootPath);

    // Upload test tree to the cloud.
    ASSERT_TRUE(client->uploadFolderTree(rootPath, ""));
    ASSERT_TRUE(client->uploadFilesInTree(rootPath, ""));

    // Add a couple more ignore files.
    //
    // We'll consider these files to have been created by the user.
    model.addfile("sd1/sd1d0/.megaignore", "#sd1d0\n+sync:.megaignore");
    model.generate(rootPath);

    // Remove .megaignore and sd0/.megaignore.
    //
    // We want these to be created by the sync engine.
    std::error_code error;

    ASSERT_TRUE(fs::remove(rootPath / ".megaignore", error));
    ASSERT_FALSE(error);

    ASSERT_TRUE(fs::remove(rootPath / "sd0" / "sd0d0" / ".megaignore", error));
    ASSERT_FALSE(error);

    // Synchronize our local directory with the cloud.
    auto id = client->setupSync_mainthread("s", "s", false, false);
    ASSERT_NE(id, UNDEF);

    // Wait for the sync to complete.
    waitonsyncs(DEFAULTWAIT, client);

    // For convenience: Make sure we check ignore files, too.
    auto confirm = [&]() {
        return client->confirmModel_mainthread(model.root.get(),
                                               id,
                                               false,
                                               StandardClient::CONFIRM_ALL,
                                               false,
                                               false);
    }; // confirm

    // Make sure everything's where it should be.
    ASSERT_TRUE(confirm());

    // Verify that .megaignore and sd0/.megaignore are marked as hidden.
    //
    // These files were created directly by the sync engine so it has the
    // right to mark them as it pleases.
    EXPECT_TRUE(isFileHidden(rootPath / ".megaignore"));
    EXPECT_TRUE(isFileHidden(rootPath / "sd0" / "sd0d0" / ".megaignore"));

    // sd1/.megaignore should remain unchanged.
    //
    // As the sync engine didn't create this file, we have to assume that
    // the user themselves did and if so, that they may have explicitly
    // marked that file as being visible.
    EXPECT_FALSE(isFileHidden(rootPath / "sd1" / "sd1d0" / ".megaignore"));

    // Moving an ignore file should not change whether it is hidden.
    model.copynode("sd0/sd0d0/.megaignore", "sd0/.megaignore");
    model.movetosynctrash("sd0/sd0d0/.megaignore", "");

    model.movenode("sd1/sd1d0/.megaignore", "sd1");

    // Regardless of whether the file was moved in the cloud...
    ASSERT_TRUE(client->movenode("s/sd0/sd0d0/.megaignore", "s/sd0"));

    // Or on the local disk.
    fs::rename(rootPath / "sd1" / "sd1d0" / ".megaignore",
               rootPath / "sd1" / ".megaignore",
               error);

    ASSERT_FALSE(error);

    // Wait for the engine to recognize and process our changes.
    waitonsyncs(DEFAULTWAIT, client);

    // Make sure everything is as it should be.
    ASSERT_TRUE(confirm());

    // Should remain hidden as the engine created it.
    EXPECT_TRUE(isFileHidden(rootPath / "sd0" / ".megaignore"));

    // Should remain visible as the user created it.
    EXPECT_FALSE(isFileHidden(rootPath / "sd1" / ".megaignore"));

    // Downloading a new version of an ignore file shouldn't change whether it is visible.
    ASSERT_TRUE(client->uploadFile(rootPath / "sd1" / ".megaignore",
                                   ".megaignore",
                                   "s/sd1",
                                   static_cast<int>(DEFAULTWAIT.count()),
                                   ClaimOldVersion));

    // Wait for the engine to synchronize our changes.
    waitonsyncs(DEFAULTWAIT, client);

    // Make sure everything is as we expect.
    ASSERT_TRUE(confirm());

    // Ignore file's visibility shouldn't have changed.
    EXPECT_FALSE(isFileHidden(rootPath / "sd1" / ".megaignore"));
}

#endif // _WIN32

class ContradictoryMoveFixture
  : public ::testing::Test
{
public:
    ContradictoryMoveFixture()
      : Test()
      , c(g_clientManager->getCleanStandardClient(0, makeNewTestRoot()))
      , mc()
      , mf()
      , id(UNDEF)
    {
    }

    void SetUp() override
    {
        // Make sure the cloud's clean.
        ASSERT_TRUE(c->resetBaseFolderMulticlient());

        // Make sure we have something to sync against in the cloud.
        ASSERT_TRUE(c->makeCloudSubdirs("s", 0, 0));

        // Populate local model.
        mf.addfolder("da");
        mf.addfolder("db");
        mf.addfolder("dc");
        mf.addfile(".megaignore", "+sync:.megaignore");
        mf.generate(c->fsBasePath / "s");

        // Initially cloud matches disk.
        mc = mf;

        // Add and start a new sync.
        id = c->setupSync_mainthread("s", "s", false, false);
        ASSERT_NE(id, UNDEF);

        // Wait for the initial sync to complete.
        waitonsyncs(DEFAULTWAIT, c);

        ASSERT_TRUE(c->waitFor(SyncStallState(false), DEFAULTWAIT));
        out() << "sync set up and we are not stalled";

        // Make sure everything made it safely to the cloud.
        ASSERT_TRUE(c->confirmModel_mainthread(mc.root.get(), id));

        // Create a contradictory move scenario.
        {
            auto pauser = makeScopedSyncPauser(*c, id);

            // Remotely move da -> db.
            mc.movenode("da", "db");

            ASSERT_TRUE(c->movenode("s/da", "s/db"));
            ASSERT_TRUE(c->waitFor(SyncRemoteMatch("s", mc.root.get()), DEFAULTWAIT));

            // Locally move db -> da.
            std::error_code result;

            mf.movenode("db", "da");

            fs::rename(c->fsBasePath / "s" / "db",
                       c->fsBasePath / "s" / "da" / "db",
                       result);

            ASSERT_FALSE(result);
        }

        // Wait for a stall to be signalled.
        ASSERT_TRUE(c->waitFor(SyncStallState(true), DEFAULTWAIT));
        ASSERT_TRUE(c->confirmModel_mainthread(mc.root.get(), id, true, StandardClient::CONFIRM_REMOTE));
        ASSERT_TRUE(c->confirmModel_mainthread(mf.root.get(), id, true, StandardClient::CONFIRM_LOCALFS));

        out() << "ContradictoryMoveFixture is SetUp, with da in db remotely, db in da locally, and sync c stalled";
    }

    // Client we're using to perform the tests.
    StandardClientInUse c;

    // Models representing the state of our client.
    Model mc;
    Model mf;

    // ID of the sync we're using to perform our test.
    handle id;
}; // ContradictoryMoveFixture

TEST_F(ContradictoryMoveFixture, MoveLocally)
{
    out() << "ContradictoryMoveFixture MoveRemotely resolving by moving db back to the sync root locally";

    // undo the local side of the clash
    std::error_code err;
    fs::rename(c->fsBasePath / "s" / "da" / "db",
               c->fsBasePath / "s" / "db", err);
    ASSERT_TRUE(!err);

    // Wait for the stall to temporarily resolve.
    ASSERT_TRUE(c->waitFor(SyncStallState(false), DEFAULTWAIT));

    // Wait for the engine to become idle.
    auto result = waitonsyncs(std::chrono::seconds(5), c);

    // both should now be in the target state, given by cloud-side model
    EXPECT_TRUE(!result.front().syncStalled);

    EXPECT_TRUE(c->confirmModel_mainthread(mc.root.get(),
                                           id,
                                           false,
                                           StandardClient::CONFIRM_REMOTE,
                                           false,
                                           false));

    EXPECT_TRUE(c->confirmModel_mainthread(mc.root.get(),
                                           id,
                                           false,
                                           StandardClient::CONFIRM_LOCALFS,
                                           false,
                                           false));
}

TEST_F(ContradictoryMoveFixture, MoveRemotely)
{
    out() << "ContradictoryMoveFixture MoveRemotely resolving by moving da back to the sync root remotely";

    // undo the cloud side of the clash
    ASSERT_TRUE(c->movenode("s/db/da", "s"));

    // Wait for the stall to resolve.
    ASSERT_TRUE(c->waitFor(SyncStallState(false), DEFAULTWAIT));

    // Wait for the engine to become idle.
    auto result = waitonsyncs(std::chrono::seconds(5), c);

    // both should now be in the target state, given by file-side model
    EXPECT_TRUE(!result.front().syncStalled);

    EXPECT_TRUE(c->confirmModel_mainthread(mf.root.get(),
                                           id,
                                           false,
                                           StandardClient::CONFIRM_REMOTE,
                                           false,
                                           false));

    EXPECT_TRUE(c->confirmModel_mainthread(mf.root.get(),
                                           id,
                                           false,
                                           StandardClient::CONFIRM_LOCALFS,
                                           false,
                                           false));
}

TEST_F(ContradictoryMoveFixture, ResolveLocally)
{
    out() << "ContradictoryMoveFixture MoveRemotely resolving by moving db back and da into it, locally";

    // Manually make the disk look like the cloud.
    {
        auto pauser = makeScopedSyncPauser(*c, id);
        std::error_code result;

        // Move da/db -> db.
        mf.movenode("da/db", "");

        fs::rename(c->fsBasePath / "s" / "da" / "db",
                   c->fsBasePath / "s" / "db",
                   result);

        ASSERT_FALSE(result);

        // Move da -> db/da.
        mf.movenode("da", "db");

        fs::rename(c->fsBasePath / "s" / "da",
                   c->fsBasePath / "s" / "db" / "da",
                   result);

        ASSERT_FALSE(result);
    }

    // Wait for the stall to be resolved.
    ASSERT_TRUE(c->waitFor(SyncStallState(false), DEFAULTWAIT));

    // Wait for the engine to idle.
    auto result = waitonsyncs(DEFAULTWAIT, c);

    // Make sure no stalls were detected.
    EXPECT_FALSE(result.front().syncStalled);

    // Make sure the state of the sync is as we expect.
    EXPECT_TRUE(c->confirmModel_mainthread(mf.root.get(), id));
}

TEST_F(ContradictoryMoveFixture, ResolveRemotely)
{
    out() << "ContradictoryMoveFixture MoveRemotely resolving by moving da back and db into it, remotely";

    // Manually make the cloud look like the disk.
    {
        auto pauser = makeScopedSyncPauser(*c, id);

        // Move db/da -> da.
        mc.movenode("db/da", "");

        ASSERT_TRUE(c->movenode("s/db/da", "s"));

        // Move db -> da/db.
        mc.movenode("db", "da");

        ASSERT_TRUE(c->movenode("s/db", "s/da"));

        // Wait for the client to receive our changes.
        ASSERT_TRUE(c->waitFor(SyncRemoteMatch("s", mc.root.get()), DEFAULTWAIT));
    }

    // Wait for the stall to be resolved.
    ASSERT_TRUE(c->waitFor(SyncStallState(false), DEFAULTWAIT));

    // Wait for the engine to idle.
    auto result = waitonsyncs(DEFAULTWAIT, c);

    // Make sure no stalls were detected.
    EXPECT_FALSE(result.front().syncStalled);

    // Make sure the state of the sync is as we expect.
    EXPECT_TRUE(c->confirmModel_mainthread(mf.root.get(), id));
}

#endif

