improve: disable save async by default (#2298)

Due to reports of system crashes and various concurrency issues,
asynchronous saving will be disabled by default as a precautionary
measure. We encourage the community's continued support by reporting any
instances of crashes or bugs. This will assist us in enhancing and
ensuring the feature's reliability for production use. Until these
issues are fully resolved, asynchronous saving will remain disabled.

config.lua.dist

@@ -277,9 +277,11 @@ maxAllowedOnADummy = 1
 
 -- Save interval per time
 -- NOTE: toggleSaveInterval: true = enable the save interval, false = disable the save interval
+-- NOTE: toggleSaveAsync = true, will enable save async (experimental), not recommended for use in production
 -- NOTE: saveIntervalType: "minute", "second" or "hour"
 -- NOTE: toggleSaveIntervalCleanMap: true = enable the clean map, false = disable the clean map
 -- NOTE: saveIntervalTime: time based on what was set in "saveIntervalType"
+toggleSaveAsync = false
 toggleSaveInterval = true
 saveIntervalType = "hour"
 toggleSaveIntervalCleanMap = true

src/config/config_enums.hpp

@@ -284,6 +284,7 @@ enum ConfigKey_t : uint16_t {
 	TOGGLE_MAP_CUSTOM,
 	TOGGLE_MOUNT_IN_PZ,
 	TOGGLE_RECEIVE_REWARD,
+	TOGGLE_SAVE_ASYNC,
 	TOGGLE_SAVE_INTERVAL_CLEAN_MAP,
 	TOGGLE_SAVE_INTERVAL,
 	TOGGLE_SERVER_IS_RETRO,

src/config/configmanager.cpp

@@ -149,6 +149,7 @@ bool ConfigManager::load() {
 	loadBoolConfig(L, TOGGLE_IMBUEMENT_SHRINE_STORAGE, "toggleImbuementShrineStorage", true);
 	loadBoolConfig(L, TOGGLE_MOUNT_IN_PZ, "toggleMountInProtectionZone", false);
 	loadBoolConfig(L, TOGGLE_RECEIVE_REWARD, "toggleReceiveReward", false);
+	loadBoolConfig(L, TOGGLE_SAVE_ASYNC, "toggleSaveAsync", false);
 	loadBoolConfig(L, TOGGLE_SAVE_INTERVAL_CLEAN_MAP, "toggleSaveIntervalCleanMap", false);
 	loadBoolConfig(L, TOGGLE_SAVE_INTERVAL, "toggleSaveInterval", false);
 	loadBoolConfig(L, TOGGLE_SERVER_IS_RETRO, "toggleServerIsRetroPVP", false);

src/game/scheduling/save_manager.cpp

@@ -35,6 +35,12 @@ void SaveManager::scheduleAll() {
 	auto scheduledAt = std::chrono::steady_clock::now();
 	m_scheduledAt = scheduledAt;
 
+	// Disable save async if the config is set to false
+	if (!g_configManager().getBoolean(TOGGLE_SAVE_ASYNC, __FUNCTION__)) {
+		saveAll();
+		return;
+	}
+
 	threadPool.addLoad([this, scheduledAt]() {
 		if (m_scheduledAt.load() != scheduledAt) {
 			logger.warn("Skipping save for server because another save has been scheduled.");
@@ -50,6 +56,14 @@ void SaveManager::schedulePlayer(std::weak_ptr<Player> playerPtr) {
 		logger.debug("Skipping save for player because player is no longer online.");
 		return;
 	}
+
+	// Disable save async if the config is set to false
+	if (!g_configManager().getBoolean(TOGGLE_SAVE_ASYNC, __FUNCTION__)) {
+		logger.debug("Saving player {}.", playerToSave->getName());
+		doSavePlayer(playerToSave);
+		return;
+	}
+
 	logger.debug("Scheduling player {} for saving.", playerToSave->getName());
 	auto scheduledAt = std::chrono::steady_clock::now();
 	m_playerMap[playerToSave->getGUID()] = scheduledAt;