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

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

33 34 35 36 37 38 39 40 41
// 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

42 43 44 45
namespace capnp {
namespace _ {  // private
namespace {

Kenton Varda's avatar
Kenton Varda committed
46 47 48
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.
49 50 51
  //
  // 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
52 53 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

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();
85 86
        auto paramType = method.getParamType();
        auto resultType = method.getResultType();
Kenton Varda's avatar
Kenton Varda committed
87

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

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

        auto sendResultsTo = call.getSendResultsTo();

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

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

        auto iter = returnTypes.find(
109
            std::make_pair(sender == CLIENT ? SERVER : CLIENT, ret.getAnswerId()));
Kenton Varda's avatar
Kenton Varda committed
110 111 112 113 114 115 116 117 118 119 120 121
        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;
        }

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

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

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

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

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

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

      default:
        break;
    }

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

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

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

161 162 163 164
class TestNetworkAdapter;

class TestNetwork {
public:
165
  TestNetwork() {
Kenton Varda's avatar
Kenton Varda committed
166 167 168 169 170 171 172 173
    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>());
  }
174 175 176 177
  ~TestNetwork() noexcept(false);

  TestNetworkAdapter& add(kj::StringPtr name);

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

Kenton Varda's avatar
Kenton Varda committed
187 188
  RpcDumper dumper;

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

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

class TestNetworkAdapter final: public TestNetworkAdapterBase {
public:
199 200 201
  TestNetworkAdapter(TestNetwork& network): network(network) {}

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

  uint getSentCount() { return sent; }
  uint getReceivedCount() { return received; }
210 211 212

  typedef TestNetworkAdapterBase::Connection Connection;

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

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

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

      networkException = kj::mv(exception);

      tasks = nullptr;
    }

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

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

247 248
      kj::Array<word> data;
      FlatArrayMessageReader message;
249 250 251 252
    };

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

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

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

267 268
        ++connection.network.sent;

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

274 275
        auto incomingMessage = kj::heap<IncomingRpcMessageImpl>(messageToFlatArray(message));

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

    private:
293
      ConnectionImpl& connection;
294
      MallocMessageBuilder message;
295 296
    };

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

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

Kenton Varda's avatar
Kenton Varda committed
310
      if (messages.empty()) {
Kenton Varda's avatar
Kenton Varda committed
311 312 313 314 315 316 317 318
        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);
        }
319
      } else {
320
        ++network.received;
Kenton Varda's avatar
Kenton Varda committed
321 322
        auto result = kj::mv(messages.front());
        messages.pop();
323
        return kj::Maybe<kj::Own<IncomingRpcMessage>>(kj::mv(result));
324 325
      }
    }
Kenton Varda's avatar
Kenton Varda committed
326 327 328 329 330 331 332 333 334
    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;
      }
    }
335

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

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

345 346
    kj::Maybe<kj::Exception> networkException;

Kenton Varda's avatar
Kenton Varda committed
347 348
    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
349
    kj::Maybe<kj::Own<kj::PromiseFulfiller<void>>> fulfillOnEnd;
Kenton Varda's avatar
Kenton Varda committed
350

351
    kj::Own<kj::TaskSet> tasks;
352 353
  };

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

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

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

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

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

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

private:
392 393 394
  TestNetwork& network;
  uint sent = 0;
  uint received = 0;
395

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

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

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

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

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

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

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

Kenton Varda's avatar
Kenton Varda committed
443
  TestContext()
444 445
      : waitScope(loop),
        clientNetwork(network.add("client")),
Kenton Varda's avatar
Kenton Varda committed
446
        serverNetwork(network.add("server")),
447 448
        rpcClient(makeRpcClient(clientNetwork)),
        rpcServer(makeRpcServer(serverNetwork, restorer)) {}
449 450 451 452 453 454 455 456 457 458 459 460 461 462 463
  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
464

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

472
    return rpcClient.restore(hostId, ref.getObjectId());
473 474 475
  }
};

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

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

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

487 488 489
  // 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).
490 491
  bool barFailed = false;
  auto request3 = client.barRequest();
492
  auto promise3 = request3.send().then(
493 494 495 496 497 498
      [](Response<test::TestInterface::BarResults>&& response) {
        ADD_FAILURE() << "Expected bar() call to fail.";
      }, [&](kj::Exception&& e) {
        barFailed = true;
      });

499 500 501 502
  auto request2 = client.bazRequest();
  initTestMessage(request2.initS());
  auto promise2 = request2.send();

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

505
  auto response1 = promise1.wait(context.waitScope);
506 507 508

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

509
  auto response2 = promise2.wait(context.waitScope);
510

511
  promise3.wait(context.waitScope);
512

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

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

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

  int chainedCallCount = 0;

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

  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
540
  EXPECT_EQ(0, context.restorer.callCount);
541 542
  EXPECT_EQ(0, chainedCallCount);

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

546
  auto response2 = pipelinePromise2.wait(context.waitScope);
547 548
  checkTestMessage(response2);

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

553 554 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
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);
}

581 582 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
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
610 611 612 613
TEST(Rpc, TailCall) {
  TestContext context;

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

  int calleeCallCount = 0;

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

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

  auto promise = request.send();

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

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

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

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

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

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

644 645
TEST(Rpc, Cancelation) {
  // Tests allowCancellation().
646

Kenton Varda's avatar
Kenton Varda committed
647 648
  TestContext context;

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

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

  kj::Promise<void> promise = nullptr;

  bool returned = false;
  {
660
    auto request = client.expectCancelRequest();
661 662
    request.setCap(kj::heap<TestCapDestructor>(kj::mv(paf.fulfiller)));
    promise = request.send().then(
663
        [&](Response<test::TestMoreStuff::ExpectCancelResults>&& response) {
664
      returned = true;
665
    }).eagerlyEvaluate(nullptr);
666
  }
667 668 669 670 671 672
  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);
673 674 675 676 677 678

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

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

  EXPECT_TRUE(destroyed);
  EXPECT_FALSE(returned);
}

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

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

  int chainedCallCount = 0;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    // Give some time to settle.
772 773 774
    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());
775 776 777 778 779 780 781

    // 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.
782
  destructionPromise.wait(context.waitScope);
783 784 785
  EXPECT_TRUE(destroyed);
}

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

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

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

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

    {
      auto responsePromise = request.send();

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

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

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

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

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

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

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

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

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

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

  {
    // 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();

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

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

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

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

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

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

  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);

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

  auto call2 = getCallSequence(pipeline, 2);

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

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

894 895 896 897 898 899
  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
900 901
}

902 903 904 905 906 907 908 909 910 911 912 913
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));
}

914 915 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
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);

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

947 948 949 950 951 952
  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);
953 954 955 956 957

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

958 959 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
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);
}

986 987 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
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);

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

1023
  expectPromiseThrows(kj::mv(req), context.waitScope);
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038
  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
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
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);
}

1065 1066 1067 1068
// =======================================================================================

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

1069
class TestGateway final: public TestRealmGateway::Server {
1070 1071 1072 1073 1074
public:
  kj::Promise<void> import(ImportContext context) override {
    auto cap = context.getParams().getCap();
    context.releaseParams();
    return cap.saveRequest().send()
1075
        .then([KJ_CPCAP(context)](Response<Persistent<Text>::SaveResults> response) mutable {
1076 1077 1078 1079 1080 1081 1082 1083 1084
      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()
1085 1086
        .then([KJ_CPCAP(context)]
            (Response<Persistent<test::TestSturdyRef>::SaveResults> response) mutable {
1087 1088 1089 1090 1091 1092
      context.getResults().setSturdyRef(kj::str("exported-",
          response.getSturdyRef().getObjectId().getAs<Text>()));
    });
  }
};

1093
class TestPersistent final: public Persistent<test::TestSturdyRef>::Server {
1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
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;
};

1106
class TestPersistentText final: public Persistent<Text>::Server {
1107 1108 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
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());
}

1151 1152 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;
  TestRestorer restorer;
  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;
  TestRestorer restorer;
  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