From 1a076f1300c2cab5670b9364a6122a5b154ff9c0 Mon Sep 17 00:00:00 2001 From: John Knox Date: Tue, 25 Sep 2018 04:45:32 -0700 Subject: [PATCH] Rename C++ fields and internal methods Summary: From sonar* to flipper*. Reviewed By: priteshrnandgaonkar Differential Revision: D9944461 fbshipit-source-id: 870997e3d1d5aaef73dd445e6d94615f93fe6abc --- xplat/Flipper/ConnectionContextStore.cpp | 6 +-- xplat/Flipper/ConnectionContextStore.h | 2 +- xplat/Flipper/FlipperClient.cpp | 10 ++--- xplat/Flipper/FlipperClient.h | 12 +++--- xplat/Flipper/FlipperConnection.h | 10 ++--- xplat/Flipper/FlipperConnectionImpl.h | 4 +- .../Flipper/FlipperConnectionManagerImpl.cpp | 38 +++++++++---------- xplat/Flipper/FlipperConnectionManagerImpl.h | 6 +-- xplat/Flipper/FlipperResponder.h | 8 ++-- xplat/Flipper/FlipperState.cpp | 2 +- xplat/Flipper/Log.cpp | 4 +- xplat/FlipperTestLib/FlipperConnectionMock.h | 4 +- ...rConnectionManagerImplTerminationTests.cpp | 12 +++--- 13 files changed, 59 insertions(+), 59 deletions(-) diff --git a/xplat/Flipper/ConnectionContextStore.cpp b/xplat/Flipper/ConnectionContextStore.cpp index e3167ead4..1d250f21c 100644 --- a/xplat/Flipper/ConnectionContextStore.cpp +++ b/xplat/Flipper/ConnectionContextStore.cpp @@ -36,7 +36,7 @@ bool ConnectionContextStore::hasRequiredFiles() { } std::string ConnectionContextStore::createCertificateSigningRequest() { - ensureSonarDirExists(); + ensureFlipperDirExists(); generateCertSigningRequest( deviceData_.appId.c_str(), absoluteFilePath(CSR_FILE_NAME).c_str(), @@ -90,7 +90,7 @@ std::string ConnectionContextStore::getCertificateDirectoryPath() { return absoluteFilePath(""); } -bool ConnectionContextStore::ensureSonarDirExists() { +bool ConnectionContextStore::ensureFlipperDirExists() { std::string dirPath = absoluteFilePath(""); struct stat info; if (stat(dirPath.c_str(), &info) != 0) { @@ -99,7 +99,7 @@ bool ConnectionContextStore::ensureSonarDirExists() { } else if (info.st_mode & S_IFDIR) { return true; } else { - log("ERROR: Sonar path exists but is not a directory: " + dirPath); + log("ERROR: Flipper path exists but is not a directory: " + dirPath); return false; } } diff --git a/xplat/Flipper/ConnectionContextStore.h b/xplat/Flipper/ConnectionContextStore.h index 6b7739489..07870147d 100644 --- a/xplat/Flipper/ConnectionContextStore.h +++ b/xplat/Flipper/ConnectionContextStore.h @@ -25,7 +25,7 @@ private: DeviceData deviceData_; std::string absoluteFilePath(const char* filename); - bool ensureSonarDirExists(); + bool ensureFlipperDirExists(); }; diff --git a/xplat/Flipper/FlipperClient.cpp b/xplat/Flipper/FlipperClient.cpp index b6b82a7fa..ff0dceb9a 100644 --- a/xplat/Flipper/FlipperClient.cpp +++ b/xplat/Flipper/FlipperClient.cpp @@ -42,12 +42,12 @@ FlipperClient* FlipperClient::instance() { void FlipperClient::setStateListener( std::shared_ptr stateListener) { log("Setting state listener"); - sonarState_->setUpdateListener(stateListener); + flipperState_->setUpdateListener(stateListener); } void FlipperClient::addPlugin(std::shared_ptr plugin) { log("FlipperClient::addPlugin " + plugin->identifier()); - auto step = sonarState_->start("Add plugin " + plugin->identifier()); + auto step = flipperState_->start("Add plugin " + plugin->identifier()); std::lock_guard lock(mutex_); performAndReportError([this, plugin, step]() { @@ -117,7 +117,7 @@ void FlipperClient::onConnected() { void FlipperClient::onDisconnected() { log("FlipperClient::onDisconnected"); - auto step = sonarState_->start("Trigger onDisconnected callbacks"); + auto step = flipperState_->start("Trigger onDisconnected callbacks"); std::lock_guard lock(mutex_); connected_ = false; performAndReportError([this, step]() { @@ -214,11 +214,11 @@ void FlipperClient::performAndReportError(const std::function& func) { } std::string FlipperClient::getState() { - return sonarState_->getState(); + return flipperState_->getState(); } std::vector FlipperClient::getStateElements() { - return sonarState_->getStateElements(); + return flipperState_->getStateElements(); } } // namespace flipper diff --git a/xplat/Flipper/FlipperClient.h b/xplat/Flipper/FlipperClient.h index a076d9eb2..0449b6f3b 100644 --- a/xplat/Flipper/FlipperClient.h +++ b/xplat/Flipper/FlipperClient.h @@ -25,7 +25,7 @@ class FlipperClient : public FlipperConnectionManager::Callbacks { public: /** Call before accessing instance with FlipperClient::instance(). This will set up - all the state needed to establish a Sonar connection. + all the state needed to establish a Flipper connection. */ static void init(FlipperInitConfig config); @@ -41,20 +41,20 @@ class FlipperClient : public FlipperConnectionManager::Callbacks { Only public for testing */ FlipperClient(std::unique_ptr socket, std::shared_ptr state) - : socket_(std::move(socket)), sonarState_(state) { - auto step = sonarState_->start("Create client"); + : socket_(std::move(socket)), flipperState_(state) { + auto step = flipperState_->start("Create client"); socket_->setCallbacks(this); step->complete(); } void start() { - auto step = sonarState_->start("Start client"); + auto step = flipperState_->start("Start client"); socket_->start(); step->complete(); } void stop() { - auto step = sonarState_->start("Stop client"); + auto step = flipperState_->start("Stop client"); socket_->stop(); step->complete(); } @@ -94,7 +94,7 @@ class FlipperClient : public FlipperConnectionManager::Callbacks { std::map> plugins_; std::map> connections_; std::mutex mutex_; - std::shared_ptr sonarState_; + std::shared_ptr flipperState_; void performAndReportError(const std::function& func); void disconnect(std::shared_ptr plugin); diff --git a/xplat/Flipper/FlipperConnection.h b/xplat/Flipper/FlipperConnection.h index baf0f8669..71cc532ed 100644 --- a/xplat/Flipper/FlipperConnection.h +++ b/xplat/Flipper/FlipperConnection.h @@ -22,20 +22,20 @@ with corresponding identifiers. */ class FlipperConnection { public: - using SonarReceiver = std::function< + using FlipperReceiver = std::function< void(const folly::dynamic&, std::unique_ptr)>; virtual ~FlipperConnection() {} /** - Invoke a method on the Sonar desktop plugin with with a matching identifier. + Invoke a method on the Flipper desktop plugin with with a matching identifier. */ virtual void send( const std::string& method, const folly::dynamic& params) = 0; /** - Report an error to the Sonar desktop app + Report an error to the Flipper desktop app */ virtual void error( const std::string& message, @@ -43,11 +43,11 @@ class FlipperConnection { /** Register a receiver to be notified of incoming calls of the given - method from the Sonar desktop plugin with a matching identifier. + method from the Flipper desktop plugin with a matching identifier. */ virtual void receive( const std::string& method, - const SonarReceiver& receiver) = 0; + const FlipperReceiver& receiver) = 0; }; } // namespace flipper diff --git a/xplat/Flipper/FlipperConnectionImpl.h b/xplat/Flipper/FlipperConnectionImpl.h index 42e89020d..e7da56808 100644 --- a/xplat/Flipper/FlipperConnectionImpl.h +++ b/xplat/Flipper/FlipperConnectionImpl.h @@ -46,7 +46,7 @@ class FlipperConnectionImpl : public FlipperConnection { folly::dynamic::object("message", message)("stacktrace", stacktrace))); } - void receive(const std::string& method, const SonarReceiver& receiver) + void receive(const std::string& method, const FlipperReceiver& receiver) override { receivers_[method] = receiver; } @@ -54,7 +54,7 @@ class FlipperConnectionImpl : public FlipperConnection { private: FlipperConnectionManager* socket_; std::string name_; - std::map receivers_; + std::map receivers_; }; } // namespace flipper diff --git a/xplat/Flipper/FlipperConnectionManagerImpl.cpp b/xplat/Flipper/FlipperConnectionManagerImpl.cpp index 1ab23f283..9650e192e 100644 --- a/xplat/Flipper/FlipperConnectionManagerImpl.cpp +++ b/xplat/Flipper/FlipperConnectionManagerImpl.cpp @@ -22,7 +22,7 @@ #include #define WRONG_THREAD_EXIT_MSG \ - "ERROR: Aborting sonar initialization because it's not running in the sonar thread." + "ERROR: Aborting flipper initialization because it's not running in the flipper thread." static constexpr int reconnectIntervalSeconds = 2; static constexpr int connectionKeepaliveSeconds = 10; @@ -78,7 +78,7 @@ class Responder : public rsocket::RSocketResponder { }; FlipperConnectionManagerImpl::FlipperConnectionManagerImpl(FlipperInitConfig config, std::shared_ptr state, std::shared_ptr contextStore) - : deviceData_(config.deviceData), sonarState_(state), sonarEventBase_(config.callbackWorker), connectionEventBase_(config.connectionWorker), contextStore_(contextStore) { + : deviceData_(config.deviceData), flipperState_(state), flipperEventBase_(config.callbackWorker), connectionEventBase_(config.connectionWorker), contextStore_(contextStore) { CHECK_THROW(config.callbackWorker, std::invalid_argument); CHECK_THROW(config.connectionWorker, std::invalid_argument); } @@ -88,9 +88,9 @@ FlipperConnectionManagerImpl::~FlipperConnectionManagerImpl() { } void FlipperConnectionManagerImpl::start() { - auto step = sonarState_->start("Start connection thread"); + auto step = flipperState_->start("Start connection thread"); folly::makeFuture() - .via(sonarEventBase_->getEventBase()) + .via(flipperEventBase_->getEventBase()) .delayed(std::chrono::milliseconds(0)) .thenValue([this, step](auto&&){ step->complete(); startSync(); }); } @@ -104,7 +104,7 @@ void FlipperConnectionManagerImpl::startSync() { log("Already connected"); return; } - auto connect = sonarState_->start("Connect to desktop"); + auto connect = flipperState_->start("Connect to desktop"); try { if (isCertificateExchangeNeeded()) { doCertificateExchange(); @@ -142,7 +142,7 @@ void FlipperConnectionManagerImpl::doCertificateExchange() { "device", deviceData_.device)("app", deviceData_.app))); address.setFromHostPort(deviceData_.host, insecurePort); - auto connectingInsecurely = sonarState_->start("Connect insecurely"); + auto connectingInsecurely = flipperState_->start("Connect insecurely"); connectionIsTrusted_ = false; client_ = rsocket::RSocket::createConnectedClient( @@ -156,14 +156,14 @@ void FlipperConnectionManagerImpl::doCertificateExchange() { .get(); connectingInsecurely->complete(); - requestSignedCertFromSonar(); + requestSignedCertFromFlipper(); } void FlipperConnectionManagerImpl::connectSecurely() { rsocket::SetupParameters parameters; folly::SocketAddress address; - auto loadingDeviceId = sonarState_->start("Load Device Id"); + auto loadingDeviceId = flipperState_->start("Load Device Id"); auto deviceId = contextStore_->getDeviceId(); if (deviceId.compare("unknown")) { loadingDeviceId->complete(); @@ -174,7 +174,7 @@ void FlipperConnectionManagerImpl::connectSecurely() { address.setFromHostPort(deviceData_.host, securePort); std::shared_ptr sslContext = contextStore_->getSSLContext(); - auto connectingSecurely = sonarState_->start("Connect securely"); + auto connectingSecurely = flipperState_->start("Connect securely"); connectionIsTrusted_ = true; client_ = rsocket::RSocket::createConnectedClient( @@ -194,7 +194,7 @@ void FlipperConnectionManagerImpl::connectSecurely() { void FlipperConnectionManagerImpl::reconnect() { folly::makeFuture() - .via(sonarEventBase_->getEventBase()) + .via(flipperEventBase_->getEventBase()) .delayed(std::chrono::seconds(reconnectIntervalSeconds)) .thenValue([this](auto&&){ startSync(); }); } @@ -215,7 +215,7 @@ void FlipperConnectionManagerImpl::setCallbacks(Callbacks* callbacks) { } void FlipperConnectionManagerImpl::sendMessage(const folly::dynamic& message) { - sonarEventBase_->add([this, message]() { + flipperEventBase_->add([this, message]() { if (client_) { client_->getRequester() ->fireAndForget(rsocket::Payload(folly::toJson(message))) @@ -230,7 +230,7 @@ bool FlipperConnectionManagerImpl::isCertificateExchangeNeeded() { return true; } - auto step = sonarState_->start("Check required certificates are present"); + auto step = flipperState_->start("Check required certificates are present"); bool hasRequiredFiles = contextStore_->hasRequiredFiles(); if (hasRequiredFiles) { step->complete(); @@ -238,16 +238,16 @@ bool FlipperConnectionManagerImpl::isCertificateExchangeNeeded() { return !hasRequiredFiles; } -void FlipperConnectionManagerImpl::requestSignedCertFromSonar() { - auto generatingCSR = sonarState_->start("Generate CSR"); +void FlipperConnectionManagerImpl::requestSignedCertFromFlipper() { + auto generatingCSR = flipperState_->start("Generate CSR"); std::string csr = contextStore_->createCertificateSigningRequest(); generatingCSR->complete(); folly::dynamic message = folly::dynamic::object("method", "signCertificate")( "csr", csr.c_str())("destination", contextStore_->getCertificateDirectoryPath().c_str()); - auto gettingCert = sonarState_->start("Getting cert from desktop"); + auto gettingCert = flipperState_->start("Getting cert from desktop"); - sonarEventBase_->add([this, message, gettingCert]() { + flipperEventBase_->add([this, message, gettingCert]() { client_->getRequester() ->requestResponse(rsocket::Payload(folly::toJson(message))) ->subscribe([this, gettingCert](rsocket::Payload p) { @@ -269,7 +269,7 @@ void FlipperConnectionManagerImpl::requestSignedCertFromSonar() { std::string errorMessage = errorWithPayload.payload.moveDataToString(); if (errorMessage.compare("not implemented")) { - log("Desktop failed to provide certificates. Error from sonar desktop:\n" + errorMessage); + log("Desktop failed to provide certificates. Error from flipper desktop:\n" + errorMessage); } else { sendLegacyCertificateRequest(message); } @@ -286,7 +286,7 @@ void FlipperConnectionManagerImpl::requestSignedCertFromSonar() { void FlipperConnectionManagerImpl::sendLegacyCertificateRequest(folly::dynamic message) { // Desktop is using an old version of Flipper. // Fall back to fireAndForget, instead of requestResponse. - auto sendingRequest = sonarState_->start("Sending fallback certificate request"); + auto sendingRequest = flipperState_->start("Sending fallback certificate request"); client_->getRequester() ->fireAndForget(rsocket::Payload(folly::toJson(message))) ->subscribe([this, sendingRequest]() { @@ -298,7 +298,7 @@ void FlipperConnectionManagerImpl::sendLegacyCertificateRequest(folly::dynamic m } bool FlipperConnectionManagerImpl::isRunningInOwnThread() { - return sonarEventBase_->isInEventBaseThread(); + return flipperEventBase_->isInEventBaseThread(); } } // namespace flipper diff --git a/xplat/Flipper/FlipperConnectionManagerImpl.h b/xplat/Flipper/FlipperConnectionManagerImpl.h index 35cb6bb6a..0a7c3ba0b 100644 --- a/xplat/Flipper/FlipperConnectionManagerImpl.h +++ b/xplat/Flipper/FlipperConnectionManagerImpl.h @@ -48,9 +48,9 @@ class FlipperConnectionManagerImpl : public FlipperConnectionManager { bool isOpen_ = false; Callbacks* callbacks_; DeviceData deviceData_; - std::shared_ptr sonarState_; + std::shared_ptr flipperState_; - folly::EventBase* sonarEventBase_; + folly::EventBase* flipperEventBase_; folly::EventBase* connectionEventBase_; std::unique_ptr client_; bool connectionIsTrusted_; @@ -61,7 +61,7 @@ class FlipperConnectionManagerImpl : public FlipperConnectionManager { void doCertificateExchange(); void connectSecurely(); bool isCertificateExchangeNeeded(); - void requestSignedCertFromSonar(); + void requestSignedCertFromFlipper(); bool isRunningInOwnThread(); void sendLegacyCertificateRequest(folly::dynamic message); std::string getDeviceId(); diff --git a/xplat/Flipper/FlipperResponder.h b/xplat/Flipper/FlipperResponder.h index ad47727c5..fce4b15d9 100644 --- a/xplat/Flipper/FlipperResponder.h +++ b/xplat/Flipper/FlipperResponder.h @@ -15,22 +15,22 @@ namespace flipper { /** * FlipperResponder is used to asynchronously respond to messages - * received from the Sonar desktop app. + * received from the Flipper desktop app. */ class FlipperResponder { public: virtual ~FlipperResponder(){}; /** - * Deliver a successful response to the Sonar desktop app. + * Deliver a successful response to the Flipper desktop app. */ virtual void success(const folly::dynamic& response) const = 0; /** - * Inform the Sonar desktop app of an error in handling the request. + * Inform the Flipper desktop app of an error in handling the request. */ virtual void error(const folly::dynamic& response) const = 0; }; -} // namespace sonar +} // namespace flipper } // namespace facebook diff --git a/xplat/Flipper/FlipperState.cpp b/xplat/Flipper/FlipperState.cpp index 2188d5a92..df4240741 100644 --- a/xplat/Flipper/FlipperState.cpp +++ b/xplat/Flipper/FlipperState.cpp @@ -13,7 +13,7 @@ using namespace facebook::flipper; /* Class responsible for collecting state updates and combining them into a - * view of the current state of the sonar client. */ + * view of the current state of the flipper client. */ FlipperState::FlipperState(): log("") {} diff --git a/xplat/Flipper/Log.cpp b/xplat/Flipper/Log.cpp index b1ac1112f..58468cb29 100644 --- a/xplat/Flipper/Log.cpp +++ b/xplat/Flipper/Log.cpp @@ -9,9 +9,9 @@ namespace flipper { void log(const std::string& message) { #ifdef __ANDROID__ - __android_log_print(ANDROID_LOG_INFO, "sonar", "sonar: %s", message.c_str()); + __android_log_print(ANDROID_LOG_INFO, "flipper", "flipper: %s", message.c_str()); #else - printf("sonar: %s\n", message.c_str()); + printf("flipper: %s\n", message.c_str()); #endif } diff --git a/xplat/FlipperTestLib/FlipperConnectionMock.h b/xplat/FlipperTestLib/FlipperConnectionMock.h index 16304c4fd..ae168e27e 100644 --- a/xplat/FlipperTestLib/FlipperConnectionMock.h +++ b/xplat/FlipperTestLib/FlipperConnectionMock.h @@ -21,7 +21,7 @@ class FlipperConnectionMock : public FlipperConnection { sent_[method] = params; } - void receive(const std::string& method, const SonarReceiver& receiver) + void receive(const std::string& method, const FlipperReceiver& receiver) override { receivers_[method] = receiver; } @@ -30,7 +30,7 @@ class FlipperConnectionMock : public FlipperConnection { override {} std::map sent_; - std::map receivers_; + std::map receivers_; }; } // namespace flipper diff --git a/xplat/FlipperTests/FlipperConnectionManagerImplTerminationTests.cpp b/xplat/FlipperTests/FlipperConnectionManagerImplTerminationTests.cpp index 8be0c19b5..04c8dd372 100644 --- a/xplat/FlipperTests/FlipperConnectionManagerImplTerminationTests.cpp +++ b/xplat/FlipperTests/FlipperConnectionManagerImplTerminationTests.cpp @@ -70,27 +70,27 @@ TEST_F(FlipperConnectionManagerImplTerminationTest, testNonStartedEventBaseDoesn } TEST_F(FlipperConnectionManagerImplTerminationTest, testStartedEventBaseDoesntHang) { - auto sonarEventBase = new EventBase(); + auto flipperEventBase = new EventBase(); auto connectionEventBase = new EventBase(); - auto sonarThread = std::thread([sonarEventBase](){ - sonarEventBase->loopForever(); + auto flipperThread = std::thread([flipperEventBase](){ + flipperEventBase->loopForever(); }); auto connectionThread = std::thread([connectionEventBase](){ connectionEventBase->loopForever(); }); auto config = FlipperInitConfig { DeviceData {}, - sonarEventBase, + flipperEventBase, connectionEventBase }; auto instance = std::make_shared(config, state, contextStore); instance->start(); - sonarEventBase->terminateLoopSoon(); + flipperEventBase->terminateLoopSoon(); connectionEventBase->terminateLoopSoon(); - sonarThread.join(); + flipperThread.join(); connectionThread.join(); }