rpc-test.c++ 42 KB
Newer Older
Kenton Varda's avatar
Kenton Varda committed
1 2
// Copyright (c) 2013-2014 Sandstorm Development Group, Inc. and contributors
// Licensed under the MIT License:
3
//
Kenton Varda's avatar
Kenton Varda committed
4 5 6 7 8 9
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
10
//
Kenton Varda's avatar
Kenton Varda committed
11 12
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
13
//
Kenton Varda's avatar
Kenton Varda committed
14 15 16 17 18 19 20
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
21

22 23
#define CAPNP_TESTING_CAPNP 1

24 25
#include "rpc.h"
#include "test-util.h"
Kenton Varda's avatar
Kenton Varda committed
26
#include "schema.h"
27
#include "serialize.h"
28
#include <kj/debug.h>
Kenton Varda's avatar
Kenton Varda committed
29
#include <kj/string-tree.h>
30
#include <kj/compat/gtest.h>
31
#include <capnp/rpc.capnp.h>
32 33 34
#include <map>
#include <queue>

35 36 37 38 39 40 41 42 43
// TODO(cleanup): Auto-generate stringification functions for union discriminants.
namespace capnp {
namespace rpc {
inline kj::String KJ_STRINGIFY(Message::Which which) {
  return kj::str(static_cast<uint16_t>(which));
}
}  // namespace rpc
}  // namespace capnp

44 45 46 47
namespace capnp {
namespace _ {  // private
namespace {

Kenton Varda's avatar
Kenton Varda committed
48 49 50
class RpcDumper {
  // Class which stringifies RPC messages for debugging purposes, including decoding params and
  // results based on the call's interface and method IDs and extracting cap descriptors.
51 52 53
  //
  // TODO(cleanup):  Clean this code up and move it to someplace reusable, so it can be used as
  //   a packet inspector / debugging tool for Cap'n Proto network traffic.
Kenton Varda's avatar
Kenton Varda committed
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86

public:
  void addSchema(InterfaceSchema schema) {
    schemas[schema.getProto().getId()] = schema;
  }

  enum Sender {
    CLIENT,
    SERVER
  };

  kj::String dump(rpc::Message::Reader message, Sender sender) {
    const char* senderName = sender == CLIENT ? "client" : "server";

    switch (message.which()) {
      case rpc::Message::CALL: {
        auto call = message.getCall();
        auto iter = schemas.find(call.getInterfaceId());
        if (iter == schemas.end()) {
          break;
        }
        InterfaceSchema schema = iter->second;
        auto methods = schema.getMethods();
        if (call.getMethodId() >= methods.size()) {
          break;
        }
        InterfaceSchema::Method method = methods[call.getMethodId()];

        auto schemaProto = schema.getProto();
        auto interfaceName =
            schemaProto.getDisplayName().slice(schemaProto.getDisplayNamePrefixLength());

        auto methodProto = method.getProto();
87 88
        auto paramType = method.getParamType();
        auto resultType = method.getResultType();
Kenton Varda's avatar
Kenton Varda committed
89

90 91 92
        if (call.getSendResultsTo().isCaller()) {
          returnTypes[std::make_pair(sender, call.getQuestionId())] = resultType;
        }
Kenton Varda's avatar
Kenton Varda committed
93

94
        auto payload = call.getParams();
95
        auto params = kj::str(payload.getContent().getAs<DynamicStruct>(paramType));
Kenton Varda's avatar
Kenton Varda committed
96 97 98 99 100 101

        auto sendResultsTo = call.getSendResultsTo();

        return kj::str(senderName, "(", call.getQuestionId(), "): call ",
                       call.getTarget(), " <- ", interfaceName, ".",
                       methodProto.getName(), params,
102
                       " caps:[", kj::strArray(payload.getCapTable(), ", "), "]",
Kenton Varda's avatar
Kenton Varda committed
103 104 105 106 107 108 109 110
                       sendResultsTo.isCaller() ? kj::str()
                                                : kj::str(" sendResultsTo:", sendResultsTo));
      }

      case rpc::Message::RETURN: {
        auto ret = message.getReturn();

        auto iter = returnTypes.find(
111
            std::make_pair(sender == CLIENT ? SERVER : CLIENT, ret.getAnswerId()));
Kenton Varda's avatar
Kenton Varda committed
112 113 114 115 116 117 118 119 120 121 122 123
        if (iter == returnTypes.end()) {
          break;
        }

        auto schema = iter->second;
        returnTypes.erase(iter);
        if (ret.which() != rpc::Return::RESULTS) {
          // Oops, no results returned.  We don't check this earlier because we want to make sure
          // returnTypes.erase() gets a chance to happen.
          break;
        }

124
        auto payload = ret.getResults();
Kenton Varda's avatar
Kenton Varda committed
125 126

        if (schema.getProto().isStruct()) {
127
          auto results = kj::str(payload.getContent().getAs<DynamicStruct>(schema.asStruct()));
Kenton Varda's avatar
Kenton Varda committed
128

129
          return kj::str(senderName, "(", ret.getAnswerId(), "): return ", results,
130
                         " caps:[", kj::strArray(payload.getCapTable(), ", "), "]");
Kenton Varda's avatar
Kenton Varda committed
131
        } else if (schema.getProto().isInterface()) {
132
          payload.getContent().getAs<DynamicCapability>(schema.asInterface());
133
          return kj::str(senderName, "(", ret.getAnswerId(), "): return cap ",
134
                         kj::strArray(payload.getCapTable(), ", "));
Kenton Varda's avatar
Kenton Varda committed
135 136 137 138 139
        } else {
          break;
        }
      }

140 141
      case rpc::Message::BOOTSTRAP: {
        auto restore = message.getBootstrap();
Kenton Varda's avatar
Kenton Varda committed
142 143 144

        returnTypes[std::make_pair(sender, restore.getQuestionId())] = InterfaceSchema();

145 146
        return kj::str(senderName, "(", restore.getQuestionId(), "): bootstrap ",
                       restore.getDeprecatedObjectId().getAs<test::TestSturdyRefObjectId>());
Kenton Varda's avatar
Kenton Varda committed
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
      }

      default:
        break;
    }

    return kj::str(senderName, ": ", message);
  }

private:
  std::map<uint64_t, InterfaceSchema> schemas;
  std::map<std::pair<Sender, uint32_t>, Schema> returnTypes;
};

// =======================================================================================

163 164 165 166
class TestNetworkAdapter;

class TestNetwork {
public:
167
  TestNetwork() {
Kenton Varda's avatar
Kenton Varda committed
168 169 170 171 172 173 174 175
    dumper.addSchema(Schema::from<test::TestInterface>());
    dumper.addSchema(Schema::from<test::TestExtends>());
    dumper.addSchema(Schema::from<test::TestPipeline>());
    dumper.addSchema(Schema::from<test::TestCallOrder>());
    dumper.addSchema(Schema::from<test::TestTailCallee>());
    dumper.addSchema(Schema::from<test::TestTailCaller>());
    dumper.addSchema(Schema::from<test::TestMoreStuff>());
  }
176 177 178 179
  ~TestNetwork() noexcept(false);

  TestNetworkAdapter& add(kj::StringPtr name);

180 181 182
  kj::Maybe<TestNetworkAdapter&> find(kj::StringPtr name) {
    auto iter = map.find(name);
    if (iter == map.end()) {
183 184 185 186 187 188
      return nullptr;
    } else {
      return *iter->second;
    }
  }

Kenton Varda's avatar
Kenton Varda committed
189 190
  RpcDumper dumper;

191
private:
192
  std::map<kj::StringPtr, kj::Own<TestNetworkAdapter>> map;
193 194 195
};

typedef VatNetwork<
196
    test::TestSturdyRefHostId, test::TestProvisionId, test::TestRecipientId,
197
    test::TestThirdPartyCapId, test::TestJoinResult> TestNetworkAdapterBase;
198 199 200

class TestNetworkAdapter final: public TestNetworkAdapterBase {
public:
201 202 203
  TestNetworkAdapter(TestNetwork& network): network(network) {}

  ~TestNetworkAdapter() {
204
    kj::Exception exception = KJ_EXCEPTION(FAILED, "Network was destroyed.");
Kenton Varda's avatar
Kenton Varda committed
205
    for (auto& entry: connections) {
206 207 208
      entry.second->disconnect(kj::cp(exception));
    }
  }
209 210 211

  uint getSentCount() { return sent; }
  uint getReceivedCount() { return received; }
212 213 214

  typedef TestNetworkAdapterBase::Connection Connection;

Kenton Varda's avatar
Kenton Varda committed
215 216
  class ConnectionImpl final
      : public Connection, public kj::Refcounted, public kj::TaskSet::ErrorHandler {
217
  public:
Kenton Varda's avatar
Kenton Varda committed
218
    ConnectionImpl(TestNetworkAdapter& network, RpcDumper::Sender sender)
219
        : network(network), sender(sender), tasks(kj::heap<kj::TaskSet>(*this)) {}
220 221 222 223 224 225 226 227

    void attach(ConnectionImpl& other) {
      KJ_REQUIRE(partner == nullptr);
      KJ_REQUIRE(other.partner == nullptr);
      partner = other;
      other.partner = *this;
    }

228
    void disconnect(kj::Exception&& exception) {
Kenton Varda's avatar
Kenton Varda committed
229 230 231
      while (!fulfillers.empty()) {
        fulfillers.front()->reject(kj::cp(exception));
        fulfillers.pop();
232 233 234 235 236 237 238
      }

      networkException = kj::mv(exception);

      tasks = nullptr;
    }

Kenton Varda's avatar
Kenton Varda committed
239
    class IncomingRpcMessageImpl final: public IncomingRpcMessage, public kj::Refcounted {
240
    public:
241 242 243
      IncomingRpcMessageImpl(kj::Array<word> data)
          : data(kj::mv(data)),
            message(this->data) {}
244

245
      AnyPointer::Reader getBody() override {
246
        return message.getRoot<AnyPointer>();
247 248
      }

249 250
      kj::Array<word> data;
      FlatArrayMessageReader message;
251 252 253 254
    };

    class OutgoingRpcMessageImpl final: public OutgoingRpcMessage {
    public:
255
      OutgoingRpcMessageImpl(ConnectionImpl& connection, uint firstSegmentWordSize)
256
          : connection(connection),
257 258
            message(firstSegmentWordSize == 0 ? SUGGESTED_FIRST_SEGMENT_WORDS
                                              : firstSegmentWordSize) {}
259

260
      AnyPointer::Builder getBody() override {
261 262 263
        return message.getRoot<AnyPointer>();
      }

264
      void send() override {
265 266 267 268
        if (connection.networkException != nullptr) {
          return;
        }

269 270
        ++connection.network.sent;

Kenton Varda's avatar
Kenton Varda committed
271 272
        // Uncomment to get a debug dump.
//        kj::String msg = connection.network.network.dumper.dump(
273
//            message.getRoot<rpc::Message>(), connection.sender);
Kenton Varda's avatar
Kenton Varda committed
274 275
//        KJ_ DBG(msg);

276 277
        auto incomingMessage = kj::heap<IncomingRpcMessageImpl>(messageToFlatArray(message));

Kenton Varda's avatar
Kenton Varda committed
278
        auto connectionPtr = &connection;
279
        connection.tasks->add(kj::evalLater(kj::mvCapture(incomingMessage,
280
            [connectionPtr](kj::Own<IncomingRpcMessageImpl>&& message) {
Kenton Varda's avatar
Kenton Varda committed
281
          KJ_IF_MAYBE(p, connectionPtr->partner) {
Kenton Varda's avatar
Kenton Varda committed
282 283
            if (p->fulfillers.empty()) {
              p->messages.push(kj::mv(message));
Kenton Varda's avatar
Kenton Varda committed
284
            } else {
Kenton Varda's avatar
Kenton Varda committed
285 286 287 288
              ++p->network.received;
              p->fulfillers.front()->fulfill(
                  kj::Own<IncomingRpcMessage>(kj::mv(message)));
              p->fulfillers.pop();
Kenton Varda's avatar
Kenton Varda committed
289
            }
290
          }
Kenton Varda's avatar
Kenton Varda committed
291
        })));
292 293 294
      }

    private:
295
      ConnectionImpl& connection;
296
      MallocMessageBuilder message;
297 298
    };

299 300 301 302 303
    test::TestSturdyRefHostId::Reader getPeerVatId() override {
      // Not actually implemented for the purpose of this test.
      return test::TestSturdyRefHostId::Reader();
    }

304
    kj::Own<OutgoingRpcMessage> newOutgoingMessage(uint firstSegmentWordSize) override {
305 306
      return kj::heap<OutgoingRpcMessageImpl>(*this, firstSegmentWordSize);
    }
307
    kj::Promise<kj::Maybe<kj::Own<IncomingRpcMessage>>> receiveIncomingMessage() override {
308 309 310 311
      KJ_IF_MAYBE(e, networkException) {
        return kj::cp(*e);
      }

Kenton Varda's avatar
Kenton Varda committed
312
      if (messages.empty()) {
Kenton Varda's avatar
Kenton Varda committed
313 314 315 316 317 318 319 320
        KJ_IF_MAYBE(f, fulfillOnEnd) {
          f->get()->fulfill();
          return kj::Maybe<kj::Own<IncomingRpcMessage>>(nullptr);
        } else {
          auto paf = kj::newPromiseAndFulfiller<kj::Maybe<kj::Own<IncomingRpcMessage>>>();
          fulfillers.push(kj::mv(paf.fulfiller));
          return kj::mv(paf.promise);
        }
321
      } else {
322
        ++network.received;
Kenton Varda's avatar
Kenton Varda committed
323 324
        auto result = kj::mv(messages.front());
        messages.pop();
325
        return kj::Maybe<kj::Own<IncomingRpcMessage>>(kj::mv(result));
326 327
      }
    }
Kenton Varda's avatar
Kenton Varda committed
328 329 330 331 332 333 334 335 336
    kj::Promise<void> shutdown() override {
      KJ_IF_MAYBE(p, partner) {
        auto paf = kj::newPromiseAndFulfiller<void>();
        p->fulfillOnEnd = kj::mv(paf.fulfiller);
        return kj::mv(paf.promise);
      } else {
        return kj::READY_NOW;
      }
    }
337

Kenton Varda's avatar
Kenton Varda committed
338 339 340 341
    void taskFailed(kj::Exception&& exception) override {
      ADD_FAILURE() << kj::str(exception).cStr();
    }

342
  private:
343
    TestNetworkAdapter& network;
344
    RpcDumper::Sender sender KJ_UNUSED_MEMBER;
345 346
    kj::Maybe<ConnectionImpl&> partner;

347 348
    kj::Maybe<kj::Exception> networkException;

Kenton Varda's avatar
Kenton Varda committed
349 350
    std::queue<kj::Own<kj::PromiseFulfiller<kj::Maybe<kj::Own<IncomingRpcMessage>>>>> fulfillers;
    std::queue<kj::Own<IncomingRpcMessage>> messages;
Kenton Varda's avatar
Kenton Varda committed
351
    kj::Maybe<kj::Own<kj::PromiseFulfiller<void>>> fulfillOnEnd;
Kenton Varda's avatar
Kenton Varda committed
352

353
    kj::Own<kj::TaskSet> tasks;
354 355
  };

356
  kj::Maybe<kj::Own<Connection>> connect(test::TestSturdyRefHostId::Reader hostId) override {
357
    TestNetworkAdapter& dst = KJ_REQUIRE_NONNULL(network.find(hostId.getHost()));
358

Kenton Varda's avatar
Kenton Varda committed
359 360
    auto iter = connections.find(&dst);
    if (iter == connections.end()) {
Kenton Varda's avatar
Kenton Varda committed
361 362
      auto local = kj::refcounted<ConnectionImpl>(*this, RpcDumper::CLIENT);
      auto remote = kj::refcounted<ConnectionImpl>(dst, RpcDumper::SERVER);
363 364
      local->attach(*remote);

Kenton Varda's avatar
Kenton Varda committed
365 366
      connections[&dst] = kj::addRef(*local);
      dst.connections[this] = kj::addRef(*remote);
367

Kenton Varda's avatar
Kenton Varda committed
368 369
      if (dst.fulfillerQueue.empty()) {
        dst.connectionQueue.push(kj::mv(remote));
370
      } else {
Kenton Varda's avatar
Kenton Varda committed
371 372
        dst.fulfillerQueue.front()->fulfill(kj::mv(remote));
        dst.fulfillerQueue.pop();
373 374
      }

375
      return kj::Own<Connection>(kj::mv(local));
376
    } else {
377
      return kj::Own<Connection>(kj::addRef(*iter->second));
378 379 380
    }
  }

381
  kj::Promise<kj::Own<Connection>> accept() override {
Kenton Varda's avatar
Kenton Varda committed
382
    if (connectionQueue.empty()) {
383
      auto paf = kj::newPromiseAndFulfiller<kj::Own<Connection>>();
Kenton Varda's avatar
Kenton Varda committed
384
      fulfillerQueue.push(kj::mv(paf.fulfiller));
385 386
      return kj::mv(paf.promise);
    } else {
Kenton Varda's avatar
Kenton Varda committed
387 388
      auto result = kj::mv(connectionQueue.front());
      connectionQueue.pop();
389 390 391 392 393
      return kj::mv(result);
    }
  }

private:
394 395 396
  TestNetwork& network;
  uint sent = 0;
  uint received = 0;
397

Kenton Varda's avatar
Kenton Varda committed
398 399 400
  std::map<const TestNetworkAdapter*, kj::Own<ConnectionImpl>> connections;
  std::queue<kj::Own<kj::PromiseFulfiller<kj::Own<Connection>>>> fulfillerQueue;
  std::queue<kj::Own<Connection>> connectionQueue;
401 402 403 404 405
};

TestNetwork::~TestNetwork() noexcept(false) {}

TestNetworkAdapter& TestNetwork::add(kj::StringPtr name) {
406
  return *(map[name] = kj::heap<TestNetworkAdapter>(*this));
407 408 409 410
}

// =======================================================================================

411
class TestRestorer final: public SturdyRefRestorer<test::TestSturdyRefObjectId> {
412 413
public:
  int callCount = 0;
414
  int handleCount = 0;
415

416 417 418
  Capability::Client restore(test::TestSturdyRefObjectId::Reader objectId) override {
    switch (objectId.getTag()) {
      case test::TestSturdyRefObjectId::Tag::TEST_INTERFACE:
419
        return kj::heap<TestInterfaceImpl>(callCount);
420 421 422
      case test::TestSturdyRefObjectId::Tag::TEST_EXTENDS:
        return Capability::Client(newBrokenCap("No TestExtends implemented."));
      case test::TestSturdyRefObjectId::Tag::TEST_PIPELINE:
423
        return kj::heap<TestPipelineImpl>(callCount);
424 425 426 427
      case test::TestSturdyRefObjectId::Tag::TEST_TAIL_CALLEE:
        return kj::heap<TestTailCalleeImpl>(callCount);
      case test::TestSturdyRefObjectId::Tag::TEST_TAIL_CALLER:
        return kj::heap<TestTailCallerImpl>(callCount);
428
      case test::TestSturdyRefObjectId::Tag::TEST_MORE_STUFF:
429
        return kj::heap<TestMoreStuffImpl>(callCount, handleCount);
430 431 432 433 434
    }
    KJ_UNREACHABLE;
  }
};

Kenton Varda's avatar
Kenton Varda committed
435
struct TestContext {
436
  kj::EventLoop loop;
437
  kj::WaitScope waitScope;
438 439
  TestNetwork network;
  TestRestorer restorer;
440 441
  TestNetworkAdapter& clientNetwork;
  TestNetworkAdapter& serverNetwork;
442 443
  RpcSystem<test::TestSturdyRefHostId> rpcClient;
  RpcSystem<test::TestSturdyRefHostId> rpcServer;
444

Kenton Varda's avatar
Kenton Varda committed
445
  TestContext()
446 447
      : waitScope(loop),
        clientNetwork(network.add("client")),
Kenton Varda's avatar
Kenton Varda committed
448
        serverNetwork(network.add("server")),
449 450
        rpcClient(makeRpcClient(clientNetwork)),
        rpcServer(makeRpcServer(serverNetwork, restorer)) {}
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
  TestContext(Capability::Client bootstrap,
              RealmGateway<test::TestSturdyRef, Text>::Client gateway)
      : waitScope(loop),
        clientNetwork(network.add("client")),
        serverNetwork(network.add("server")),
        rpcClient(makeRpcClient(clientNetwork, gateway)),
        rpcServer(makeRpcServer(serverNetwork, bootstrap)) {}
  TestContext(Capability::Client bootstrap,
              RealmGateway<test::TestSturdyRef, Text>::Client gateway,
              bool)
      : waitScope(loop),
        clientNetwork(network.add("client")),
        serverNetwork(network.add("server")),
        rpcClient(makeRpcClient(clientNetwork)),
        rpcServer(makeRpcServer(serverNetwork, bootstrap, gateway)) {}
Kenton Varda's avatar
Kenton Varda committed
466

467
  Capability::Client connect(test::TestSturdyRefObjectId::Tag tag) {
468
    MallocMessageBuilder refMessage(128);
469 470
    auto ref = refMessage.initRoot<test::TestSturdyRef>();
    auto hostId = ref.initHostId();
471 472
    hostId.setHost("server");
    ref.getObjectId().initAs<test::TestSturdyRefObjectId>().setTag(tag);
473

474
    return rpcClient.restore(hostId, ref.getObjectId());
475 476 477
  }
};

Kenton Varda's avatar
Kenton Varda committed
478 479 480 481
TEST(Rpc, Basic) {
  TestContext context;

  auto client = context.connect(test::TestSturdyRefObjectId::Tag::TEST_INTERFACE)
482
      .castAs<test::TestInterface>();
483 484 485 486 487 488

  auto request1 = client.fooRequest();
  request1.setI(123);
  request1.setJ(true);
  auto promise1 = request1.send();

489 490 491
  // We used to call bar() after baz(), hence the numbering, but this masked the case where the
  // RPC system actually disconnected on bar() (thus returning an exception, which we decided
  // was expected).
492 493
  bool barFailed = false;
  auto request3 = client.barRequest();
494
  auto promise3 = request3.send().then(
495 496 497 498 499 500
      [](Response<test::TestInterface::BarResults>&& response) {
        ADD_FAILURE() << "Expected bar() call to fail.";
      }, [&](kj::Exception&& e) {
        barFailed = true;
      });

501 502 503 504
  auto request2 = client.bazRequest();
  initTestMessage(request2.initS());
  auto promise2 = request2.send();

Kenton Varda's avatar
Kenton Varda committed
505
  EXPECT_EQ(0, context.restorer.callCount);
506

507
  auto response1 = promise1.wait(context.waitScope);
508 509 510

  EXPECT_EQ("foo", response1.getX());

511
  auto response2 = promise2.wait(context.waitScope);
512

513
  promise3.wait(context.waitScope);
514

Kenton Varda's avatar
Kenton Varda committed
515
  EXPECT_EQ(2, context.restorer.callCount);
516 517 518
  EXPECT_TRUE(barFailed);
}

Kenton Varda's avatar
Kenton Varda committed
519 520 521 522
TEST(Rpc, Pipelining) {
  TestContext context;

  auto client = context.connect(test::TestSturdyRefObjectId::Tag::TEST_PIPELINE)
523
      .castAs<test::TestPipeline>();
524 525 526 527 528

  int chainedCallCount = 0;

  auto request = client.getCapRequest();
  request.setN(234);
529
  request.setInCap(kj::heap<TestInterfaceImpl>(chainedCallCount));
530 531 532 533 534 535 536 537 538 539 540 541

  auto promise = request.send();

  auto pipelineRequest = promise.getOutBox().getCap().fooRequest();
  pipelineRequest.setI(321);
  auto pipelinePromise = pipelineRequest.send();

  auto pipelineRequest2 = promise.getOutBox().getCap().castAs<test::TestExtends>().graultRequest();
  auto pipelinePromise2 = pipelineRequest2.send();

  promise = nullptr;  // Just to be annoying, drop the original promise.

Kenton Varda's avatar
Kenton Varda committed
542
  EXPECT_EQ(0, context.restorer.callCount);
543 544
  EXPECT_EQ(0, chainedCallCount);

545
  auto response = pipelinePromise.wait(context.waitScope);
546 547
  EXPECT_EQ("bar", response.getX());

548
  auto response2 = pipelinePromise2.wait(context.waitScope);
549 550
  checkTestMessage(response2);

Kenton Varda's avatar
Kenton Varda committed
551
  EXPECT_EQ(3, context.restorer.callCount);
552 553 554
  EXPECT_EQ(1, chainedCallCount);
}

555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582
TEST(Rpc, Release) {
  TestContext context;

  auto client = context.connect(test::TestSturdyRefObjectId::Tag::TEST_MORE_STUFF)
      .castAs<test::TestMoreStuff>();

  auto handle1 = client.getHandleRequest().send().wait(context.waitScope).getHandle();
  auto promise = client.getHandleRequest().send();
  auto handle2 = promise.wait(context.waitScope).getHandle();

  EXPECT_EQ(2, context.restorer.handleCount);

  handle1 = nullptr;

  for (uint i = 0; i < 16; i++) kj::evalLater([]() {}).wait(context.waitScope);
  EXPECT_EQ(1, context.restorer.handleCount);

  handle2 = nullptr;

  for (uint i = 0; i < 16; i++) kj::evalLater([]() {}).wait(context.waitScope);
  EXPECT_EQ(1, context.restorer.handleCount);

  promise = nullptr;

  for (uint i = 0; i < 16; i++) kj::evalLater([]() {}).wait(context.waitScope);
  EXPECT_EQ(0, context.restorer.handleCount);
}

583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611
TEST(Rpc, ReleaseOnCancel) {
  // At one time, there was a bug where if a Return contained capabilities, but the client had
  // canceled the request and already send a Finish (which presumably didn't reach the server before
  // the Return), then we'd leak those caps. Test for that.

  TestContext context;

  auto client = context.connect(test::TestSturdyRefObjectId::Tag::TEST_MORE_STUFF)
      .castAs<test::TestMoreStuff>();
  client.whenResolved().wait(context.waitScope);

  {
    auto promise = client.getHandleRequest().send();

    // If the server receives cancellation too early, it won't even return a capability in the
    // results, it will just return "canceled". We want to emulate the case where the return message
    // and the cancel (finish) message cross paths. It turns out that exactly two evalLater()s get
    // us there.
    //
    // TODO(cleanup): This is fragile, but I'm not sure how else to write it without a ton
    //   of scaffolding.
    kj::evalLater([]() {}).wait(context.waitScope);
    kj::evalLater([]() {}).wait(context.waitScope);
  }

  for (uint i = 0; i < 16; i++) kj::evalLater([]() {}).wait(context.waitScope);
  EXPECT_EQ(0, context.restorer.handleCount);
}

Kenton Varda's avatar
Kenton Varda committed
612 613 614 615
TEST(Rpc, TailCall) {
  TestContext context;

  auto caller = context.connect(test::TestSturdyRefObjectId::Tag::TEST_TAIL_CALLER)
616 617 618 619
      .castAs<test::TestTailCaller>();

  int calleeCallCount = 0;

620
  test::TestTailCallee::Client callee(kj::heap<TestTailCalleeImpl>(calleeCallCount));
621 622 623 624 625 626 627 628 629

  auto request = caller.fooRequest();
  request.setI(456);
  request.setCallee(callee);

  auto promise = request.send();

  auto dependentCall0 = promise.getC().getCallSequenceRequest().send();

630
  auto response = promise.wait(context.waitScope);
631
  EXPECT_EQ(456, response.getI());
632
  EXPECT_EQ("from TestTailCaller", response.getT());
633 634 635 636 637

  auto dependentCall1 = promise.getC().getCallSequenceRequest().send();

  auto dependentCall2 = response.getC().getCallSequenceRequest().send();

638 639 640
  EXPECT_EQ(0, dependentCall0.wait(context.waitScope).getN());
  EXPECT_EQ(1, dependentCall1.wait(context.waitScope).getN());
  EXPECT_EQ(2, dependentCall2.wait(context.waitScope).getN());
641 642

  EXPECT_EQ(1, calleeCallCount);
Kenton Varda's avatar
Kenton Varda committed
643
  EXPECT_EQ(1, context.restorer.callCount);
644 645
}

646 647
TEST(Rpc, Cancelation) {
  // Tests allowCancellation().
648

Kenton Varda's avatar
Kenton Varda committed
649 650
  TestContext context;

651 652
  auto paf = kj::newPromiseAndFulfiller<void>();
  bool destroyed = false;
653
  auto destructionPromise = paf.promise.then([&]() { destroyed = true; }).eagerlyEvaluate(nullptr);
654

Kenton Varda's avatar
Kenton Varda committed
655
  auto client = context.connect(test::TestSturdyRefObjectId::Tag::TEST_MORE_STUFF)
656 657 658 659 660 661
      .castAs<test::TestMoreStuff>();

  kj::Promise<void> promise = nullptr;

  bool returned = false;
  {
662
    auto request = client.expectCancelRequest();
663 664
    request.setCap(kj::heap<TestCapDestructor>(kj::mv(paf.fulfiller)));
    promise = request.send().then(
665
        [&](Response<test::TestMoreStuff::ExpectCancelResults>&& response) {
666
      returned = true;
667
    }).eagerlyEvaluate(nullptr);
668
  }
669 670 671 672 673 674
  kj::evalLater([]() {}).wait(context.waitScope);
  kj::evalLater([]() {}).wait(context.waitScope);
  kj::evalLater([]() {}).wait(context.waitScope);
  kj::evalLater([]() {}).wait(context.waitScope);
  kj::evalLater([]() {}).wait(context.waitScope);
  kj::evalLater([]() {}).wait(context.waitScope);
675 676 677 678 679 680

  // We can detect that the method was canceled because it will drop the cap.
  EXPECT_FALSE(destroyed);
  EXPECT_FALSE(returned);

  promise = nullptr;  // request cancellation
681
  destructionPromise.wait(context.waitScope);
682 683 684 685 686

  EXPECT_TRUE(destroyed);
  EXPECT_FALSE(returned);
}

Kenton Varda's avatar
Kenton Varda committed
687 688 689 690
TEST(Rpc, PromiseResolve) {
  TestContext context;

  auto client = context.connect(test::TestSturdyRefObjectId::Tag::TEST_MORE_STUFF)
691 692 693 694 695 696 697 698 699 700
      .castAs<test::TestMoreStuff>();

  int chainedCallCount = 0;

  auto request = client.callFooRequest();
  auto request2 = client.callFooWhenResolvedRequest();

  auto paf = kj::newPromiseAndFulfiller<test::TestInterface::Client>();

  {
701 702 703
    auto fork = paf.promise.fork();
    request.setCap(fork.addBranch());
    request2.setCap(fork.addBranch());
704 705 706 707 708
  }

  auto promise = request.send();
  auto promise2 = request2.send();

709 710
  // Make sure getCap() has been called on the server side by sending another call and waiting
  // for it.
711
  EXPECT_EQ(2, client.getCallSequenceRequest().send().wait(context.waitScope).getN());
Kenton Varda's avatar
Kenton Varda committed
712
  EXPECT_EQ(3, context.restorer.callCount);
713 714

  // OK, now fulfill the local promise.
715
  paf.fulfiller->fulfill(kj::heap<TestInterfaceImpl>(chainedCallCount));
716 717

  // We should now be able to wait for getCap() to finish.
718 719
  EXPECT_EQ("bar", promise.wait(context.waitScope).getS());
  EXPECT_EQ("bar", promise2.wait(context.waitScope).getS());
720

Kenton Varda's avatar
Kenton Varda committed
721
  EXPECT_EQ(3, context.restorer.callCount);
722 723 724
  EXPECT_EQ(2, chainedCallCount);
}

Kenton Varda's avatar
Kenton Varda committed
725 726 727
TEST(Rpc, RetainAndRelease) {
  TestContext context;

728 729
  auto paf = kj::newPromiseAndFulfiller<void>();
  bool destroyed = false;
730
  auto destructionPromise = paf.promise.then([&]() { destroyed = true; }).eagerlyEvaluate(nullptr);
731 732

  {
Kenton Varda's avatar
Kenton Varda committed
733
    auto client = context.connect(test::TestSturdyRefObjectId::Tag::TEST_MORE_STUFF)
734 735 736 737
        .castAs<test::TestMoreStuff>();

    {
      auto request = client.holdRequest();
738
      request.setCap(kj::heap<TestCapDestructor>(kj::mv(paf.fulfiller)));
739
      request.send().wait(context.waitScope);
740 741 742
    }

    // Do some other call to add a round trip.
743
    EXPECT_EQ(1, client.getCallSequenceRequest().send().wait(context.waitScope).getN());
744 745 746 747 748

    // Shouldn't be destroyed because it's being held by the server.
    EXPECT_FALSE(destroyed);

    // We can ask it to call the held capability.
749
    EXPECT_EQ("bar", client.callHeldRequest().send().wait(context.waitScope).getS());
750 751 752

    {
      // We can get the cap back from it.
753
      auto capCopy = client.getHeldRequest().send().wait(context.waitScope).getCap();
754 755 756

      {
        // And call it, without any network communications.
Kenton Varda's avatar
Kenton Varda committed
757
        uint oldSentCount = context.clientNetwork.getSentCount();
758 759 760
        auto request = capCopy.fooRequest();
        request.setI(123);
        request.setJ(true);
761
        EXPECT_EQ("foo", request.send().wait(context.waitScope).getX());
Kenton Varda's avatar
Kenton Varda committed
762
        EXPECT_EQ(oldSentCount, context.clientNetwork.getSentCount());
763 764 765 766 767 768
      }

      {
        // We can send another copy of the same cap to another method, and it works.
        auto request = client.callFooRequest();
        request.setCap(capCopy);
769
        EXPECT_EQ("bar", request.send().wait(context.waitScope).getS());
770 771 772 773
      }
    }

    // Give some time to settle.
774 775 776
    EXPECT_EQ(5, client.getCallSequenceRequest().send().wait(context.waitScope).getN());
    EXPECT_EQ(6, client.getCallSequenceRequest().send().wait(context.waitScope).getN());
    EXPECT_EQ(7, client.getCallSequenceRequest().send().wait(context.waitScope).getN());
777 778 779 780 781 782 783

    // Can't be destroyed, we haven't released it.
    EXPECT_FALSE(destroyed);
  }

  // We released our client, which should cause the server to be released, which in turn will
  // release the cap pointing back to us.
784
  destructionPromise.wait(context.waitScope);
785 786 787
  EXPECT_TRUE(destroyed);
}

Kenton Varda's avatar
Kenton Varda committed
788 789 790 791
TEST(Rpc, Cancel) {
  TestContext context;

  auto client = context.connect(test::TestSturdyRefObjectId::Tag::TEST_MORE_STUFF)
792 793 794 795
      .castAs<test::TestMoreStuff>();

  auto paf = kj::newPromiseAndFulfiller<void>();
  bool destroyed = false;
796
  auto destructionPromise = paf.promise.then([&]() { destroyed = true; }).eagerlyEvaluate(nullptr);
797 798 799

  {
    auto request = client.neverReturnRequest();
800
    request.setCap(kj::heap<TestCapDestructor>(kj::mv(paf.fulfiller)));
801 802 803 804 805

    {
      auto responsePromise = request.send();

      // Allow some time to settle.
806 807
      EXPECT_EQ(1, client.getCallSequenceRequest().send().wait(context.waitScope).getN());
      EXPECT_EQ(2, client.getCallSequenceRequest().send().wait(context.waitScope).getN());
808 809 810 811 812 813 814

      // The cap shouldn't have been destroyed yet because the call never returned.
      EXPECT_FALSE(destroyed);
    }
  }

  // Now the cap should be released.
815
  destructionPromise.wait(context.waitScope);
816 817 818
  EXPECT_TRUE(destroyed);
}

Kenton Varda's avatar
Kenton Varda committed
819 820 821 822
TEST(Rpc, SendTwice) {
  TestContext context;

  auto client = context.connect(test::TestSturdyRefObjectId::Tag::TEST_MORE_STUFF)
823 824 825 826
      .castAs<test::TestMoreStuff>();

  auto paf = kj::newPromiseAndFulfiller<void>();
  bool destroyed = false;
827
  auto destructionPromise = paf.promise.then([&]() { destroyed = true; }).eagerlyEvaluate(nullptr);
828

829
  auto cap = test::TestInterface::Client(kj::heap<TestCapDestructor>(kj::mv(paf.fulfiller)));
830 831 832 833 834

  {
    auto request = client.callFooRequest();
    request.setCap(cap);

835
    EXPECT_EQ("bar", request.send().wait(context.waitScope).getS());
836 837 838
  }

  // Allow some time for the server to release `cap`.
839
  EXPECT_EQ(1, client.getCallSequenceRequest().send().wait(context.waitScope).getN());
840 841 842 843 844 845 846 847 848 849 850

  {
    // More requests with the same cap.
    auto request = client.callFooRequest();
    auto request2 = client.callFooRequest();
    request.setCap(cap);
    request2.setCap(kj::mv(cap));

    auto promise = request.send();
    auto promise2 = request2.send();

851 852
    EXPECT_EQ("bar", promise.wait(context.waitScope).getS());
    EXPECT_EQ("bar", promise2.wait(context.waitScope).getS());
853 854 855
  }

  // Now the cap should be released.
856
  destructionPromise.wait(context.waitScope);
857 858 859
  EXPECT_TRUE(destroyed);
}

Kenton Varda's avatar
Kenton Varda committed
860
RemotePromise<test::TestCallOrder::GetCallSequenceResults> getCallSequence(
861
    test::TestCallOrder::Client& client, uint expected) {
Kenton Varda's avatar
Kenton Varda committed
862 863 864 865 866
  auto req = client.getCallSequenceRequest();
  req.setExpected(expected);
  return req.send();
}

Kenton Varda's avatar
Kenton Varda committed
867 868 869 870
TEST(Rpc, Embargo) {
  TestContext context;

  auto client = context.connect(test::TestSturdyRefObjectId::Tag::TEST_MORE_STUFF)
Kenton Varda's avatar
Kenton Varda committed
871 872
      .castAs<test::TestMoreStuff>();

873
  auto cap = test::TestCallOrder::Client(kj::heap<TestCallOrderImpl>());
Kenton Varda's avatar
Kenton Varda committed
874 875 876 877 878 879 880 881 882 883 884 885

  auto earlyCall = client.getCallSequenceRequest().send();

  auto echoRequest = client.echoRequest();
  echoRequest.setCap(cap);
  auto echo = echoRequest.send();

  auto pipeline = echo.getCap();

  auto call0 = getCallSequence(pipeline, 0);
  auto call1 = getCallSequence(pipeline, 1);

886
  earlyCall.wait(context.waitScope);
Kenton Varda's avatar
Kenton Varda committed
887 888 889

  auto call2 = getCallSequence(pipeline, 2);

890
  auto resolved = echo.wait(context.waitScope).getCap();
Kenton Varda's avatar
Kenton Varda committed
891 892 893 894 895

  auto call3 = getCallSequence(pipeline, 3);
  auto call4 = getCallSequence(pipeline, 4);
  auto call5 = getCallSequence(pipeline, 5);

896 897 898 899 900 901
  EXPECT_EQ(0, call0.wait(context.waitScope).getN());
  EXPECT_EQ(1, call1.wait(context.waitScope).getN());
  EXPECT_EQ(2, call2.wait(context.waitScope).getN());
  EXPECT_EQ(3, call3.wait(context.waitScope).getN());
  EXPECT_EQ(4, call4.wait(context.waitScope).getN());
  EXPECT_EQ(5, call5.wait(context.waitScope).getN());
Kenton Varda's avatar
Kenton Varda committed
902 903
}

904 905 906 907 908 909 910 911 912 913 914 915
template <typename T>
void expectPromiseThrows(kj::Promise<T>&& promise, kj::WaitScope& waitScope) {
  EXPECT_TRUE(promise.then([](T&&) { return false; }, [](kj::Exception&&) { return true; })
      .wait(waitScope));
}

template <>
void expectPromiseThrows(kj::Promise<void>&& promise, kj::WaitScope& waitScope) {
  EXPECT_TRUE(promise.then([]() { return false; }, [](kj::Exception&&) { return true; })
      .wait(waitScope));
}

916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946
TEST(Rpc, EmbargoError) {
  TestContext context;

  auto client = context.connect(test::TestSturdyRefObjectId::Tag::TEST_MORE_STUFF)
      .castAs<test::TestMoreStuff>();

  auto paf = kj::newPromiseAndFulfiller<test::TestCallOrder::Client>();

  auto cap = test::TestCallOrder::Client(kj::mv(paf.promise));

  auto earlyCall = client.getCallSequenceRequest().send();

  auto echoRequest = client.echoRequest();
  echoRequest.setCap(cap);
  auto echo = echoRequest.send();

  auto pipeline = echo.getCap();

  auto call0 = getCallSequence(pipeline, 0);
  auto call1 = getCallSequence(pipeline, 1);

  earlyCall.wait(context.waitScope);

  auto call2 = getCallSequence(pipeline, 2);

  auto resolved = echo.wait(context.waitScope).getCap();

  auto call3 = getCallSequence(pipeline, 3);
  auto call4 = getCallSequence(pipeline, 4);
  auto call5 = getCallSequence(pipeline, 5);

947
  paf.fulfiller->rejectIfThrows([]() { KJ_FAIL_ASSERT("foo") { break; } });
948

949 950 951 952 953 954
  expectPromiseThrows(kj::mv(call0), context.waitScope);
  expectPromiseThrows(kj::mv(call1), context.waitScope);
  expectPromiseThrows(kj::mv(call2), context.waitScope);
  expectPromiseThrows(kj::mv(call3), context.waitScope);
  expectPromiseThrows(kj::mv(call4), context.waitScope);
  expectPromiseThrows(kj::mv(call5), context.waitScope);
955 956 957 958 959

  // Verify that we're still connected (there were no protocol errors).
  getCallSequence(client, 1).wait(context.waitScope);
}

960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987
TEST(Rpc, EmbargoNull) {
  // Set up a situation where we pipeline on a capability that ends up coming back null. This
  // should NOT cause a Disembargo to be sent, but due to a bug in earlier versions of Cap'n Proto,
  // a Disembargo was indeed sent to the null capability, which caused the server to disconnect
  // due to protocol error.

  TestContext context;

  auto client = context.connect(test::TestSturdyRefObjectId::Tag::TEST_MORE_STUFF)
      .castAs<test::TestMoreStuff>();

  auto promise = client.getNullRequest().send();

  auto cap = promise.getNullCap();

  auto call0 = cap.getCallSequenceRequest().send();

  promise.wait(context.waitScope);

  auto call1 = cap.getCallSequenceRequest().send();

  expectPromiseThrows(kj::mv(call0), context.waitScope);
  expectPromiseThrows(kj::mv(call1), context.waitScope);

  // Verify that we're still connected (there were no protocol errors).
  getCallSequence(client, 0).wait(context.waitScope);
}

988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
TEST(Rpc, CallBrokenPromise) {
  // Tell the server to call back to a promise client, then resolve the promise to an error.

  TestContext context;

  auto client = context.connect(test::TestSturdyRefObjectId::Tag::TEST_MORE_STUFF)
      .castAs<test::TestMoreStuff>();
  auto paf = kj::newPromiseAndFulfiller<test::TestInterface::Client>();

  {
    auto req = client.holdRequest();
    req.setCap(kj::mv(paf.promise));
    req.send().wait(context.waitScope);
  }

  bool returned = false;
  auto req = client.callHeldRequest().send()
      .then([&](capnp::Response<test::TestMoreStuff::CallHeldResults>&&) {
    returned = true;
  }, [&](kj::Exception&& e) {
    returned = true;
    kj::throwRecoverableException(kj::mv(e));
  }).eagerlyEvaluate(nullptr);

  kj::evalLater([]() {}).wait(context.waitScope);
  kj::evalLater([]() {}).wait(context.waitScope);
  kj::evalLater([]() {}).wait(context.waitScope);
  kj::evalLater([]() {}).wait(context.waitScope);
  kj::evalLater([]() {}).wait(context.waitScope);
  kj::evalLater([]() {}).wait(context.waitScope);
  kj::evalLater([]() {}).wait(context.waitScope);
  kj::evalLater([]() {}).wait(context.waitScope);

  EXPECT_FALSE(returned);

1023
  paf.fulfiller->rejectIfThrows([]() { KJ_FAIL_ASSERT("foo") { break; } });
1024

1025
  expectPromiseThrows(kj::mv(req), context.waitScope);
1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
  EXPECT_TRUE(returned);

  kj::evalLater([]() {}).wait(context.waitScope);
  kj::evalLater([]() {}).wait(context.waitScope);
  kj::evalLater([]() {}).wait(context.waitScope);
  kj::evalLater([]() {}).wait(context.waitScope);
  kj::evalLater([]() {}).wait(context.waitScope);
  kj::evalLater([]() {}).wait(context.waitScope);
  kj::evalLater([]() {}).wait(context.waitScope);
  kj::evalLater([]() {}).wait(context.waitScope);

  // Verify that we're still connected (there were no protocol errors).
  getCallSequence(client, 1).wait(context.waitScope);
}

Kenton Varda's avatar
Kenton Varda committed
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
TEST(Rpc, Abort) {
  // Verify that aborts are received.

  TestContext context;

  MallocMessageBuilder refMessage(128);
  auto hostId = refMessage.initRoot<test::TestSturdyRefHostId>();
  hostId.setHost("server");

  auto conn = KJ_ASSERT_NONNULL(context.clientNetwork.connect(hostId));

  {
    // Send an invalid message (Return to non-existent question).
    auto msg = conn->newOutgoingMessage(128);
    auto body = msg->getBody().initAs<rpc::Message>().initReturn();
    body.setAnswerId(1234);
    body.setCanceled();
    msg->send();
  }

  auto reply = KJ_ASSERT_NONNULL(conn->receiveIncomingMessage().wait(context.waitScope));
  EXPECT_EQ(rpc::Message::ABORT, reply->getBody().getAs<rpc::Message>().which());

  EXPECT_TRUE(conn->receiveIncomingMessage().wait(context.waitScope) == nullptr);
}

1067 1068 1069 1070
// =======================================================================================

typedef RealmGateway<test::TestSturdyRef, Text> TestRealmGateway;

1071
class TestGateway final: public TestRealmGateway::Server {
1072 1073 1074 1075 1076
public:
  kj::Promise<void> import(ImportContext context) override {
    auto cap = context.getParams().getCap();
    context.releaseParams();
    return cap.saveRequest().send()
1077
        .then([KJ_CPCAP(context)](Response<Persistent<Text>::SaveResults> response) mutable {
1078 1079 1080 1081 1082 1083 1084 1085 1086
      context.getResults().initSturdyRef().getObjectId().setAs<Text>(
          kj::str("imported-", response.getSturdyRef()));
    });
  }

  kj::Promise<void> export_(ExportContext context) override {
    auto cap = context.getParams().getCap();
    context.releaseParams();
    return cap.saveRequest().send()
1087 1088
        .then([KJ_CPCAP(context)]
            (Response<Persistent<test::TestSturdyRef>::SaveResults> response) mutable {
1089 1090 1091 1092 1093 1094
      context.getResults().setSturdyRef(kj::str("exported-",
          response.getSturdyRef().getObjectId().getAs<Text>()));
    });
  }
};

1095
class TestPersistent final: public Persistent<test::TestSturdyRef>::Server {
1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107
public:
  TestPersistent(kj::StringPtr name): name(name) {}

  kj::Promise<void> save(SaveContext context) override {
    context.initResults().initSturdyRef().getObjectId().setAs<Text>(name);
    return kj::READY_NOW;
  }

private:
  kj::StringPtr name;
};

1108
class TestPersistentText final: public Persistent<Text>::Server {
1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152
public:
  TestPersistentText(kj::StringPtr name): name(name) {}

  kj::Promise<void> save(SaveContext context) override {
    context.initResults().setSturdyRef(name);
    return kj::READY_NOW;
  }

private:
  kj::StringPtr name;
};

TEST(Rpc, RealmGatewayImport) {
  TestRealmGateway::Client gateway = kj::heap<TestGateway>();
  Persistent<Text>::Client bootstrap = kj::heap<TestPersistentText>("foo");

  MallocMessageBuilder hostIdBuilder;
  auto hostId = hostIdBuilder.getRoot<test::TestSturdyRefHostId>();
  hostId.setHost("server");

  TestContext context(bootstrap, gateway);
  auto client = context.rpcClient.bootstrap(hostId).castAs<Persistent<test::TestSturdyRef>>();

  auto response = client.saveRequest().send().wait(context.waitScope);

  EXPECT_EQ("imported-foo", response.getSturdyRef().getObjectId().getAs<Text>());
}

TEST(Rpc, RealmGatewayExport) {
  TestRealmGateway::Client gateway = kj::heap<TestGateway>();
  Persistent<test::TestSturdyRef>::Client bootstrap = kj::heap<TestPersistent>("foo");

  MallocMessageBuilder hostIdBuilder;
  auto hostId = hostIdBuilder.getRoot<test::TestSturdyRefHostId>();
  hostId.setHost("server");

  TestContext context(bootstrap, gateway, true);
  auto client = context.rpcClient.bootstrap(hostId).castAs<Persistent<Text>>();

  auto response = client.saveRequest().send().wait(context.waitScope);

  EXPECT_EQ("exported-foo", response.getSturdyRef());
}

1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258
TEST(Rpc, RealmGatewayImportExport) {
  // Test that a save request which leaves the realm, bounces through a promise capability, and
  // then comes back into the realm, does not actually get translated both ways.

  TestRealmGateway::Client gateway = kj::heap<TestGateway>();
  Persistent<test::TestSturdyRef>::Client bootstrap = kj::heap<TestPersistent>("foo");

  MallocMessageBuilder serverHostIdBuilder;
  auto serverHostId = serverHostIdBuilder.getRoot<test::TestSturdyRefHostId>();
  serverHostId.setHost("server");

  MallocMessageBuilder clientHostIdBuilder;
  auto clientHostId = clientHostIdBuilder.getRoot<test::TestSturdyRefHostId>();
  clientHostId.setHost("client");

  kj::EventLoop loop;
  kj::WaitScope waitScope(loop);
  TestNetwork network;
  TestNetworkAdapter& clientNetwork = network.add("client");
  TestNetworkAdapter& serverNetwork = network.add("server");
  RpcSystem<test::TestSturdyRefHostId> rpcClient =
      makeRpcServer(clientNetwork, bootstrap, gateway);
  auto paf = kj::newPromiseAndFulfiller<Capability::Client>();
  RpcSystem<test::TestSturdyRefHostId> rpcServer =
      makeRpcServer(serverNetwork, kj::mv(paf.promise));

  auto client = rpcClient.bootstrap(serverHostId).castAs<Persistent<test::TestSturdyRef>>();

  bool responseReady = false;
  auto responsePromise = client.saveRequest().send()
      .then([&](Response<Persistent<test::TestSturdyRef>::SaveResults>&& response) {
    responseReady = true;
    return kj::mv(response);
  }).eagerlyEvaluate(nullptr);

  // Crank the event loop to give the message time to reach the server and block on the promise
  // resolution.
  kj::evalLater([]() {}).wait(waitScope);
  kj::evalLater([]() {}).wait(waitScope);
  kj::evalLater([]() {}).wait(waitScope);
  kj::evalLater([]() {}).wait(waitScope);

  EXPECT_FALSE(responseReady);

  paf.fulfiller->fulfill(rpcServer.bootstrap(clientHostId));

  auto response = responsePromise.wait(waitScope);

  // Should have the original value. If it went through export and re-import, though, then this
  // will be "imported-exported-foo", which is wrong.
  EXPECT_EQ("foo", response.getSturdyRef().getObjectId().getAs<Text>());
}

TEST(Rpc, RealmGatewayImportExport) {
  // Test that a save request which enters the realm, bounces through a promise capability, and
  // then goes back out of the realm, does not actually get translated both ways.

  TestRealmGateway::Client gateway = kj::heap<TestGateway>();
  Persistent<Text>::Client bootstrap = kj::heap<TestPersistentText>("foo");

  MallocMessageBuilder serverHostIdBuilder;
  auto serverHostId = serverHostIdBuilder.getRoot<test::TestSturdyRefHostId>();
  serverHostId.setHost("server");

  MallocMessageBuilder clientHostIdBuilder;
  auto clientHostId = clientHostIdBuilder.getRoot<test::TestSturdyRefHostId>();
  clientHostId.setHost("client");

  kj::EventLoop loop;
  kj::WaitScope waitScope(loop);
  TestNetwork network;
  TestNetworkAdapter& clientNetwork = network.add("client");
  TestNetworkAdapter& serverNetwork = network.add("server");
  RpcSystem<test::TestSturdyRefHostId> rpcClient =
      makeRpcServer(clientNetwork, bootstrap);
  auto paf = kj::newPromiseAndFulfiller<Capability::Client>();
  RpcSystem<test::TestSturdyRefHostId> rpcServer =
      makeRpcServer(serverNetwork, kj::mv(paf.promise), gateway);

  auto client = rpcClient.bootstrap(serverHostId).castAs<Persistent<Text>>();

  bool responseReady = false;
  auto responsePromise = client.saveRequest().send()
      .then([&](Response<Persistent<Text>::SaveResults>&& response) {
    responseReady = true;
    return kj::mv(response);
  }).eagerlyEvaluate(nullptr);

  // Crank the event loop to give the message time to reach the server and block on the promise
  // resolution.
  kj::evalLater([]() {}).wait(waitScope);
  kj::evalLater([]() {}).wait(waitScope);
  kj::evalLater([]() {}).wait(waitScope);
  kj::evalLater([]() {}).wait(waitScope);

  EXPECT_FALSE(responseReady);

  paf.fulfiller->fulfill(rpcServer.bootstrap(clientHostId));

  auto response = responsePromise.wait(waitScope);

  // Should have the original value. If it went through import and re-export, though, then this
  // will be "exported-imported-foo", which is wrong.
  EXPECT_EQ("foo", response.getSturdyRef());
}

1259 1260 1261
}  // namespace
}  // namespace _ (private)
}  // namespace capnp