jens/flipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add locking to FlipperState

Browse Source 
Summary: FlipperState may be updated from multiple threads, so it needs synchronization. Note the comments in the diff about why we drop the lock before calling out to the update listener -- this can be changed if necessary in the future.

Reviewed By: jknoxville

Differential Revision: D18095471

fbshipit-source-id: 95d558394ae1a9b7583e5a61969e1eeda6448cff
This commit is contained in:
Scott Wolchok
2019-10-24 09:28:27 -07:00
committed by Facebook Github Bot
parent f00f0ad4b9
commit 8dbf60e82e
2 changed files with 54 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
xplat/Flipper/FlipperState.cpp
View File

@@ -6,9 +6,9 @@
*/
#include "FlipperState.h"
#include <vector>
#include "FlipperStateUpdateListener.h"
#include "FlipperStep.h"
#include <vector>
#if FLIPPER_DEBUG_LOG
#include "Log.h"
@@ -22,42 +22,64 @@ using namespace facebook::flipper;
FlipperState::FlipperState() : logs("") {}
void FlipperState::setUpdateListener(
std::shared_ptr<FlipperStateUpdateListener> listener) {
std::lock_guard<std::mutex> lock(mutex);
mListener = listener;
}
void FlipperState::started(std::string step) {
std::shared_ptr<FlipperStateUpdateListener> localListener;
{
std::lock_guard<std::mutex> lock(mutex);
#if FLIPPER_DEBUG_LOG
log("[started] " + step);
log("[started] " + step);
#endif
if (stateMap.find(step) == stateMap.end()) {
insertOrder.push_back(step);
if (stateMap.find(step) == stateMap.end()) {
insertOrder.push_back(step);
}
stateMap[step] = State::in_progress;
localListener = mListener;
}
stateMap[step] = State::in_progress;
if (mListener) {
mListener->onUpdate();
// Need to drop the lock before issuing callback because the caller
// might call us back (and is responsible for their own locking).
if (localListener) {
localListener->onUpdate();
}
}
void FlipperState::success(std::string step) {
std::shared_ptr<FlipperStateUpdateListener> localListener;
{
std::lock_guard<std::mutex> lock(mutex);
#if FLIPPER_DEBUG_LOG
log("[finished] " + step);
log("[finished] " + step);
#endif
logs = logs + "[Success] " + step + "\n";
stateMap[step] = State::success;
if (mListener) {
mListener->onUpdate();
logs = logs + "[Success] " + step + "\n";
stateMap[step] = State::success;
localListener = mListener;
}
// Need to drop the lock before issuing callback because the caller
// might call us back (and is responsible for their own locking).
if (localListener) {
localListener->onUpdate();
}
}
void FlipperState::failed(std::string step, std::string errorMessage) {
std::string message = "[Failed] " + step + ": " + errorMessage;
std::shared_ptr<FlipperStateUpdateListener> localListener;
{
std::lock_guard<std::mutex> lock(mutex);
std::string message = "[Failed] " + step + ": " + errorMessage;
#if FLIPPER_DEBUG_LOG
log(message);
log(message);
#endif
logs = logs + message + "\n";
stateMap[step] = State::failed;
if (mListener) {
mListener->onUpdate();
logs = logs + message + "\n";
stateMap[step] = State::failed;
localListener = mListener;
}
// Need to drop the lock before issuing callback because the caller
// might call us back (and is responsible for their own locking).
if (localListener) {
localListener->onUpdate();
}
}
@@ -65,10 +87,12 @@ void FlipperState::failed(std::string step, std::string errorMessage) {
// representation of the current state so the UI can show it in a more intuitive
// way
std::string FlipperState::getState() {
std::lock_guard<std::mutex> lock(mutex);
return logs;
}
std::vector<StateElement> FlipperState::getStateElements() {
std::lock_guard<std::mutex> lock(mutex);
std::vector<StateElement> v;
for (auto stepName : insertOrder) {
v.push_back(StateElement(stepName, stateMap[stepName]));
@@ -77,6 +101,8 @@ std::vector<StateElement> FlipperState::getStateElements() {
}
std::shared_ptr<FlipperStep> FlipperState::start(std::string step_name) {
// started() acquires the lock and we don't access any of our members below,
// so we needn't take the lock.
started(step_name);
return std::make_shared<FlipperStep>(step_name, this);
}