sapling/eden/fs/service/PrettyPrinters.cpp
Michael Bolin 5d738193e5 Store Hg dirstate data in Hg instead of Eden.
Summary:
This is a major change to how we manage the dirstate in Eden's Hg extension.

Previously, the dirstate information was stored under `$EDEN_CONFIG_DIR`,
which is Eden's private storage. Any time the Mercurial extension wanted to
read or write the dirstate, it had to make a Thrift request to Eden to do so on
its behalf. The upside is that Eden could answer dirstate-related questions
independently of the Python code.

This was sufficiently different than how Mercurial's default dirstate worked
that our subclass, `eden_dirstate`, had to override quite a bit of behavior.
Failing to manage the `.hg/dirstate` file in a way similar to the way Mercurial
does has exposed some "unofficial contracts" that Mercurial has. For example,
tools like Nuclide rely on changes to the `.hg/dirstate` file as a heuristic to
determine when to invalidate its internal caches for Mercurial data.

Today, Mercurial has a well-factored `dirstatemap` abstraction that is primarily
responsible for the transactions with the dirstate's data. With this split, we can
focus on putting most of our customizations in our `eden_dirstate_map` subclass
while our `eden_dirstate` class has to override fewer methods. Because the
data is managed through the `.hg/dirstate` file, transaction logic in Mercurial that
relies on renaming/copying that file will work out-of-the-box. This change
also reduces the number of Thrift calls the Mercurial extension has to make
for operations like `hg status` or `hg add`.

In this revision, we introduce our own binary format for the `.hg/dirstate` file.
The logic to read and write this file is in `eden/py/dirstate.py`. After the first
40 bytes, which are used for the parent hashes, the next four bytes are
reserved for a version number for the file format so we can manage file format
changes going forward.

Admittedly one downside of this change is that it is a breaking change.
Ideally, users should commit all of their local changes in their existing mounts,
shutdown Eden, delete the old mounts, restart Eden, and re-clone.

In the end, this change deletes a number of Mercurial-specific code and Thrift
APIs from Eden. This is a better separation of concerns that makes Eden more
SCM-agnostic. For example, this change removes `Dirstate.cpp` and
`DirstatePersistance.cpp`, replacing them with the much simpler and more
general `Differ.cpp`. The Mercurial-specific logic from `Dirstate.cpp` that turned
a diff into an `hg status` now lives in the Mercurial extension in
`EdenThriftClient.getStatus()`, which is much more appropriate.

Note that this reverts the changes that were recently introduced in D6116105:
we now need to intercept `localrepo.localrepository.dirstate` once again.

Reviewed By: simpkins

Differential Revision: D6179950

fbshipit-source-id: 5b78904909b669c9cc606e2fe1fd118ef6eaab95
2017-11-06 19:56:49 -08:00

60 lines
1.5 KiB
C++

/*
* Copyright (c) 2004-present, Facebook, Inc.
* All rights reserved.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree. An additional grant
* of patent rights can be found in the PATENTS file in the same directory.
*
*/
#include "eden/fs/service/PrettyPrinters.h"
#include <ostream>
namespace {
template <typename ThriftEnum>
std::ostream& outputThriftEnum(
std::ostream& os,
ThriftEnum value,
const std::map<ThriftEnum, const char*>& valuesToNames,
folly::StringPiece typeName) {
auto iter = valuesToNames.find(value);
if (iter == valuesToNames.end()) {
os << typeName << "::" << int(value);
} else {
os << iter->second;
}
return os;
}
} // unnamed namespace
namespace facebook {
namespace eden {
/**
* Pretty-print a CheckoutConflict
*/
std::ostream& operator<<(std::ostream& os, ConflictType conflictType) {
return outputThriftEnum(
os, conflictType, _ConflictType_VALUES_TO_NAMES, "ConflictType");
}
/**
* Pretty-print a CheckoutConflict
*/
std::ostream& operator<<(std::ostream& os, const CheckoutConflict& conflict) {
os << "CheckoutConflict(type=" << conflict.type << ", path=\""
<< conflict.path << "\", message=\"" << conflict.message << "\")";
return os;
}
/**
* Pretty-print a StatusCode
*/
std::ostream& operator<<(std::ostream& os, ScmFileStatus scmFileStatus) {
return outputThriftEnum(
os, scmFileStatus, _ScmFileStatus_VALUES_TO_NAMES, "ScmFileStatus");
}
} // namespace eden
} // namespace facebook