Merge pull request #527 from Hornwitser/autosave-data

Implement autosaving of data held in memory

plugins/inventory_sync/controller.ts

@@ -38,16 +38,11 @@ async function saveDatabase(
 export class ControllerPlugin extends BaseControllerPlugin {
 	acquiredPlayers!: Map<string, { instanceId: number, expires?: number }>;
 	playerDatastore!: Map<string, IpcPlayerData>;
-	autosaveId!: ReturnType<typeof setInterval>;
+	playerDatastoreDirty = false;
 
 	async init() {
 		this.acquiredPlayers = new Map();
 		this.playerDatastore = await loadDatabase(this.controller.config, this.logger);
-		this.autosaveId = setInterval(() => {
-			saveDatabase(this.controller.config, this.playerDatastore, this.logger).catch(err => {
-				this.logger.error(`Unexpected error autosaving player data:\n${err.stack}`);
-			});
-		}, this.controller.config.get("inventory_sync.autosave_interval") as number * 1000);
 
 		this.controller.handle(msg.AcquireRequest, this.handleAcquireRequest.bind(this));
 		this.controller.handle(msg.ReleaseRequest, this.handleReleaseRequest.bind(this));
@@ -89,7 +84,7 @@ export class ControllerPlugin extends BaseControllerPlugin {
 		if (
 			!acquisitionRecord
 			|| acquisitionRecord.instanceId === instanceId
-			|| !this.controller.instances!.has(acquisitionRecord.instanceId)
+			|| !this.controller.instances.has(acquisitionRecord.instanceId)
 			|| acquisitionRecord.expires && acquisitionRecord.expires < Date.now()
 		) {
 			this.acquiredPlayers.set(playerName, { instanceId });
@@ -103,7 +98,7 @@ export class ControllerPlugin extends BaseControllerPlugin {
 		let { instanceId, playerName } = request;
 		if (!this.acquire(instanceId, playerName)) {
 			let acquisitionRecord = this.acquiredPlayers.get(playerName);
-			let instance = this.controller.instances!.get(acquisitionRecord!.instanceId)!;
+			let instance = this.controller.instances.get(acquisitionRecord!.instanceId)!;
 			return {
 				status: "busy",
 				message: instance.config.get("instance.name"),
@@ -132,7 +127,7 @@ export class ControllerPlugin extends BaseControllerPlugin {
 
 	async handleUploadRequest(request: msg.UploadRequest) {
 		let { instanceId, playerName, playerData } = request;
-		let instanceName = this.controller.instances!.get(instanceId)!.config.get("instance.name");
+		let instanceName = this.controller.instances.get(instanceId)!.config.get("instance.name");
 		let store = true;
 		let acquisitionRecord = this.acquiredPlayers.get(playerName);
 		if (!acquisitionRecord) {
@@ -161,12 +156,13 @@ export class ControllerPlugin extends BaseControllerPlugin {
 		if (store) {
 			this.logger.verbose(`Received player data for ${playerName} from ${instanceName}`);
 			this.playerDatastore.set(playerName, playerData);
+			this.playerDatastoreDirty = true;
 		}
 	}
 
 	async handleDownloadRequest(request: msg.DownloadRequest) {
 		let { instanceId, playerName } = request;
-		let instanceName = this.controller.instances!.get(instanceId)!.config.get("instance.name");
+		let instanceName = this.controller.instances.get(instanceId)!.config.get("instance.name");
 
 		let acquisitionRecord = this.acquiredPlayers.get(playerName);
 		if (!acquisitionRecord) {
@@ -179,9 +175,11 @@ export class ControllerPlugin extends BaseControllerPlugin {
 		return new msg.DownloadRequest.Response(this.playerDatastore.get(playerName) || null);
 	}
 
-	async onShutdown() {
-		clearInterval(this.autosaveId);
-		await saveDatabase(this.controller.config, this.playerDatastore, this.logger);
+	async onSaveData() {
+		if (this.playerDatastoreDirty) {
+			this.playerDatastoreDirty = false;
+			await saveDatabase(this.controller.config, this.playerDatastore, this.logger);
+		}
 	}
 
 	async handleDatabaseStatsRequest() {

plugins/inventory_sync/info.ts

@@ -4,13 +4,6 @@ import * as messages from "./messages";
 class ControllerConfigGroup extends lib.PluginConfigGroup { }
 ControllerConfigGroup.defaultAccess = ["controller", "host", "control"];
 ControllerConfigGroup.groupName = "inventory_sync";
-ControllerConfigGroup.define({
-	name: "autosave_interval",
-	title: "Autosave Interval",
-	description: "Interval the player data is autosaved at in seconds.",
-	type: "number",
-	initial_value: 600, // 10 minutes
-});
 ControllerConfigGroup.define({
 	name: "player_lock_timeout",
 	title: "Player Lock Timeout",