123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332 |
- /*
- * Copyright 2013-present Facebook, Inc.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
- #include <thread>
- #include <folly/Memory.h>
- #include <folly/io/async/EventBase.h>
- #include <folly/io/async/Request.h>
- #include <folly/portability/GTest.h>
- using namespace folly;
- RequestToken testtoken("test");
- class TestData : public RequestData {
- public:
- explicit TestData(int data) : data_(data) {}
- ~TestData() override {}
- bool hasCallback() override {
- return true;
- }
- void onSet() override {
- set_++;
- }
- void onUnset() override {
- unset_++;
- }
- int set_ = 0, unset_ = 0;
- int data_;
- };
- class RequestContextTest : public ::testing::Test {
- protected:
- void SetUp() override {
- // Make sure each test starts out using the default context, and not some
- // other context left over by a previous test.
- RequestContext::setContext(nullptr);
- // Make sure no data is set for the "test" key when we start. There could
- // be left over data in the default context from a previous test. If we
- // don't clear it out future calls to setContextData() won't actually work,
- // and will reset the data to null instead of properly setting the new
- // desired data.
- //
- // (All of the tests generally want the behavior of overwriteContextData()
- // rather than setContextData(), but that method is private.)
- //
- // We ideally want to clear out data for any keys that may be set, not just
- // the "test" key, but there also isn't a RequestContext API to do this.
- clearData();
- }
- RequestContext& getContext() {
- auto* ctx = RequestContext::get();
- EXPECT_TRUE(ctx != nullptr);
- return *ctx;
- }
- void setData(int data = 0, std::string key = "test") {
- getContext().setContextData(key, std::make_unique<TestData>(data));
- }
- bool hasData(std::string key = "test") {
- return getContext().hasContextData(key);
- }
- const TestData& getData(std::string key = "test") {
- auto* ptr = dynamic_cast<TestData*>(getContext().getContextData(key));
- EXPECT_TRUE(ptr != nullptr);
- return *ptr;
- }
- void clearData(std::string key = "test") {
- getContext().clearContextData(key);
- }
- };
- TEST_F(RequestContextTest, SimpleTest) {
- EventBase base;
- // There should always be a default context with get()
- EXPECT_TRUE(RequestContext::get() != nullptr);
- // but not with saveContext()
- EXPECT_EQ(RequestContext::saveContext(), nullptr);
- RequestContext::create();
- EXPECT_NE(RequestContext::saveContext(), nullptr);
- RequestContext::create();
- EXPECT_NE(RequestContext::saveContext(), nullptr);
- EXPECT_EQ(nullptr, RequestContext::get()->getContextData("test"));
- RequestContext::get()->setContextData("test", std::make_unique<TestData>(10));
- base.runInEventBaseThread([&]() {
- EXPECT_TRUE(RequestContext::get() != nullptr);
- auto data = dynamic_cast<TestData*>(
- RequestContext::get()->getContextData(testtoken))
- ->data_;
- EXPECT_EQ(10, data);
- base.terminateLoopSoon();
- });
- auto th = std::thread([&]() { base.loopForever(); });
- th.join();
- EXPECT_TRUE(RequestContext::get() != nullptr);
- auto a =
- dynamic_cast<TestData*>(RequestContext::get()->getContextData("test"));
- auto data = a->data_;
- EXPECT_EQ(10, data);
- RequestContext::setContext(std::shared_ptr<RequestContext>());
- // There should always be a default context
- EXPECT_TRUE(nullptr != RequestContext::get());
- }
- TEST_F(RequestContextTest, RequestContextScopeGuard) {
- RequestContextScopeGuard g0;
- setData(10);
- {
- RequestContextScopeGuard g1;
- EXPECT_FALSE(hasData());
- setData(20);
- EXPECT_EQ(20, getData().data_);
- EXPECT_EQ(1, getData().set_);
- EXPECT_EQ(0, getData().unset_);
- }
- EXPECT_EQ(10, getData().data_);
- EXPECT_EQ(2, getData().set_);
- EXPECT_EQ(1, getData().unset_);
- }
- TEST_F(RequestContextTest, defaultContext) {
- // Don't create a top level guard
- setData(10);
- {
- RequestContextScopeGuard g1;
- EXPECT_FALSE(hasData());
- }
- EXPECT_EQ(10, getData().data_);
- EXPECT_EQ(1, getData().set_);
- EXPECT_EQ(0, getData().unset_);
- }
- TEST_F(RequestContextTest, setIfAbsentTest) {
- EXPECT_TRUE(RequestContext::get() != nullptr);
- RequestContext::get()->setContextData("test", std::make_unique<TestData>(10));
- EXPECT_FALSE(RequestContext::get()->setContextDataIfAbsent(
- "test", std::make_unique<TestData>(20)));
- EXPECT_EQ(
- 10,
- dynamic_cast<TestData*>(RequestContext::get()->getContextData(testtoken))
- ->data_);
- EXPECT_TRUE(RequestContext::get()->setContextDataIfAbsent(
- "test2", std::make_unique<TestData>(20)));
- EXPECT_EQ(
- 20,
- dynamic_cast<TestData*>(RequestContext::get()->getContextData("test2"))
- ->data_);
- RequestContext::setContext(std::shared_ptr<RequestContext>());
- EXPECT_TRUE(nullptr != RequestContext::get());
- }
- TEST_F(RequestContextTest, testSetUnset) {
- RequestContext::create();
- auto ctx1 = RequestContext::saveContext();
- ctx1->setContextData("test", std::make_unique<TestData>(10));
- auto testData1 = dynamic_cast<TestData*>(ctx1->getContextData("test"));
- // onSet called in setContextData
- EXPECT_EQ(1, testData1->set_);
- // Override RequestContext
- RequestContext::create();
- auto ctx2 = RequestContext::saveContext();
- ctx2->setContextData(testtoken, std::make_unique<TestData>(20));
- auto testData2 = dynamic_cast<TestData*>(ctx2->getContextData(testtoken));
- // onSet called in setContextData
- EXPECT_EQ(1, testData2->set_);
- // Check ctx1->onUnset was called
- EXPECT_EQ(1, testData1->unset_);
- RequestContext::setContext(ctx1);
- EXPECT_EQ(2, testData1->set_);
- EXPECT_EQ(1, testData1->unset_);
- EXPECT_EQ(1, testData2->unset_);
- RequestContext::setContext(ctx2);
- EXPECT_EQ(2, testData1->set_);
- EXPECT_EQ(2, testData1->unset_);
- EXPECT_EQ(2, testData2->set_);
- EXPECT_EQ(1, testData2->unset_);
- }
- TEST_F(RequestContextTest, deadlockTest) {
- class DeadlockTestData : public RequestData {
- public:
- explicit DeadlockTestData(const std::string& val) : val_(val) {}
- ~DeadlockTestData() override {
- RequestContext::get()->setContextData(
- val_, std::make_unique<TestData>(1));
- }
- bool hasCallback() override {
- return false;
- }
- std::string val_;
- };
- RequestContext::get()->setContextData(
- "test", std::make_unique<DeadlockTestData>("test2"));
- RequestContext::get()->clearContextData(testtoken);
- }
- // A common use case is to use set/unset to maintain a thread global
- // Regression test to ensure that unset is always called before set
- TEST_F(RequestContextTest, sharedGlobalTest) {
- static bool global = false;
- class GlobalTestData : public RequestData {
- public:
- void onSet() override {
- ASSERT_FALSE(global);
- global = true;
- }
- void onUnset() override {
- ASSERT_TRUE(global);
- global = false;
- }
- bool hasCallback() override {
- return true;
- }
- };
- RequestContextScopeGuard g0;
- RequestContext::get()->setContextData(
- "test", std::make_unique<GlobalTestData>());
- {
- RequestContextScopeGuard g1;
- RequestContext::get()->setContextData(
- "test", std::make_unique<GlobalTestData>());
- }
- }
- TEST_F(RequestContextTest, ShallowCopyBasic) {
- ShallowCopyRequestContextScopeGuard g0;
- setData(123, "immutable");
- EXPECT_EQ(123, getData("immutable").data_);
- EXPECT_FALSE(hasData());
- {
- ShallowCopyRequestContextScopeGuard g1;
- EXPECT_EQ(123, getData("immutable").data_);
- setData(789);
- EXPECT_EQ(789, getData().data_);
- }
- EXPECT_FALSE(hasData());
- EXPECT_EQ(123, getData("immutable").data_);
- EXPECT_EQ(1, getData("immutable").set_);
- EXPECT_EQ(0, getData("immutable").unset_);
- }
- TEST_F(RequestContextTest, ShallowCopyOverwrite) {
- RequestContextScopeGuard g0;
- setData(123);
- EXPECT_EQ(123, getData().data_);
- {
- ShallowCopyRequestContextScopeGuard g1(
- "test", std::make_unique<TestData>(789));
- EXPECT_EQ(789, getData().data_);
- EXPECT_EQ(1, getData().set_);
- EXPECT_EQ(0, getData().unset_);
- }
- EXPECT_EQ(123, getData().data_);
- EXPECT_EQ(2, getData().set_);
- EXPECT_EQ(1, getData().unset_);
- }
- TEST_F(RequestContextTest, ShallowCopyDefaultContext) {
- // Don't set global scope guard
- setData(123);
- EXPECT_EQ(123, getData().data_);
- {
- ShallowCopyRequestContextScopeGuard g1(
- "test", std::make_unique<TestData>(789));
- EXPECT_EQ(789, getData().data_);
- }
- EXPECT_EQ(123, getData().data_);
- EXPECT_EQ(1, getData().set_);
- EXPECT_EQ(0, getData().unset_);
- }
- TEST_F(RequestContextTest, ShallowCopyClear) {
- RequestContextScopeGuard g0;
- setData(123);
- EXPECT_EQ(123, getData().data_);
- {
- ShallowCopyRequestContextScopeGuard g1;
- EXPECT_EQ(123, getData().data_);
- clearData();
- setData(789);
- EXPECT_EQ(789, getData().data_);
- }
- EXPECT_EQ(123, getData().data_);
- EXPECT_EQ(2, getData().set_);
- EXPECT_EQ(1, getData().unset_);
- }
|