[clangd] Add more logs and attach tracers to remote index server routines

[kbobyrev]

Rebase on top of parent revision, add more logging on the client side.

[sammccall]

Server-side tracing looks nice, but you'll need some flags to allow actually extracting a trace, right?

clang-tools-extra/clangd/index/remote/server/Server.cpp

62 ↗

(On Diff #278081)

Nit: this is "LookupRequest" on the client side. I'd suggest just the same on the server, or "Recv.LookupRequest" or so? to make it easier to correspond them

63 ↗

(On Diff #278081)

you don't do this on the client side, but could

63 ↗

(On Diff #278081)

prefer DebugString over ShortDebugString, the missing newlines can make it hard to follow

98 ↗

(On Diff #278081)

you don't do this on the client side, but should

[kbobyrev]

Resolve the comments.

[kbobyrev]

clang-tools-extra/clangd/index/remote/server/Server.cpp

63 ↗

(On Diff #278081)

Do you mean logging RPCRequest there? Done now.

[kbobyrev]

Rebase on top of master

[kbobyrev]

In favor of D84499 with clean diffs.

[kbobyrev]

Reset D83831 to master.

clang-tools-extra/clangd/index/remote/marshalling/Marshalling.cpp

if (!LocalIndexRoot.empty()) {
     assert(LocalIndexRoot.endswith(llvm::sys::path::get_separator()));
     this->LocalIndexRoot = LocalIndexRoot.str();
   }
   assert(!RemoteIndexRoot.empty() || !LocalIndexRoot.empty());
 }
 
 clangd::FuzzyFindRequest
 Marshaller::fromProtobuf(const FuzzyFindRequest *Request) {
+<<<<<<< HEAD
   assert(RemoteIndexRoot);
+=======
+  assert(LocalIndexRoot);
+>>>>>>> 529b83e6cf3... [clangd] Don't send invalid messages from remote index
   clangd::FuzzyFindRequest Result;
   Result.Query = Request->query();
   for (const auto &Scope : Request->scopes())
     Result.Scopes.push_back(Scope);
   Result.AnyScope = Request->any_scope();
   if (Request->limit())
     Result.Limit = Request->limit();
   Result.RestrictForCodeCompletion = Request->restricted_for_code_completion();
   for (const auto &Path : Request->proximity_paths()) {
+<<<<<<< HEAD
     llvm::SmallString<256> LocalPath = llvm::StringRef(*RemoteIndexRoot);
+=======
+    llvm::SmallString<256> LocalPath = llvm::StringRef(*LocalIndexRoot);
+>>>>>>> 529b83e6cf3... [clangd] Don't send invalid messages from remote index
     llvm::sys::path::append(LocalPath, Path);
     Result.ProximityPaths.push_back(std::string(LocalPath));
   }
   for (const auto &Type : Request->preferred_types())
     Result.ProximityPaths.push_back(Type);
   return Result;
 }
 

 LookupRequest Marshaller::toProtobuf(const clangd::LookupRequest &From) {
   LookupRequest RPCRequest;
   for (const auto &SymbolID : From.IDs)
     RPCRequest.add_ids(SymbolID.str());
   return RPCRequest;
 }
 
 FuzzyFindRequest Marshaller::toProtobuf(const clangd::FuzzyFindRequest &From) {
+<<<<<<< HEAD
   assert(LocalIndexRoot);
+=======
+  assert(RemoteIndexRoot);
+>>>>>>> 529b83e6cf3... [clangd] Don't send invalid messages from remote index
   FuzzyFindRequest RPCRequest;
   RPCRequest.set_query(From.Query);
   for (const auto &Scope : From.Scopes)
     RPCRequest.add_scopes(Scope);
   RPCRequest.set_any_scope(From.AnyScope);
   if (From.Limit)
     RPCRequest.set_limit(*From.Limit);
   RPCRequest.set_restricted_for_code_completion(From.RestrictForCodeCompletion);
   for (const auto &Path : From.ProximityPaths) {
     llvm::SmallString<256> RelativePath = llvm::StringRef(Path);
+<<<<<<< HEAD
     if (llvm::sys::path::replace_path_prefix(RelativePath, *LocalIndexRoot,
+=======
+    if (llvm::sys::path::replace_path_prefix(RelativePath, *RemoteIndexRoot,
+>>>>>>> 529b83e6cf3... [clangd] Don't send invalid messages from remote index
                                              ""))
       RPCRequest.add_proximity_paths(llvm::sys::path::convert_to_slash(
           RelativePath, llvm::sys::path::Style::posix));
   }
   for (const auto &Type : From.PreferredTypes)
     RPCRequest.add_preferred_types(Type);
   return RPCRequest;
 }

clang-tools-extra/clangd/unittests/remote/MarshallingTests.cpp

TEST(RemoteMarshallingTest, IncludeHeaderURIs) {
   EXPECT_TRUE(Deserialized);
 
   Sym.IncludeHeaders = ValidHeaders;
   EXPECT_EQ(toYAML(Sym), toYAML(*Deserialized));
 }
 
 TEST(RemoteMarshallingTest, FuzzyFindRequestSerialization) {
   clangd::FuzzyFindRequest Request;
+<<<<<<< HEAD
   Request.ProximityPaths = {testPath("local/Header.h"),
                             testPath("local/subdir/OtherHeader.h"),
                             testPath("remote/File.h"), "Not a Path."};
   Marshaller ProtobufMarshaller(testPath("remote/"), testPath("local/"));
+=======
+  Request.ProximityPaths = {testPath("remote/Header.h"),
+                            testPath("remote/subdir/OtherHeader.h"),
+                            testPath("notremote/File.h"), "Not a Path."};
+  Marshaller ProtobufMarshaller(testPath("remote/"), testPath("home/"));
+>>>>>>> 529b83e6cf3... [clangd] Don't send invalid messages from remote index
   auto Serialized = ProtobufMarshaller.toProtobuf(Request);
   EXPECT_EQ(Serialized.proximity_paths_size(), 2);
   auto Deserialized = ProtobufMarshaller.fromProtobuf(&Serialized);
   EXPECT_THAT(Deserialized.ProximityPaths,
               testing::ElementsAre(testPath("remote/Header.h"),
                                    testPath("remote/subdir/OtherHeader.h")));
 }