add configurable maintenance event to local agent (#180)

AgentInterfaces/MaintenanceSchedule.cs

@@ -50,6 +50,8 @@ public class MaintenanceEvent
 
         public DateTime? NotBefore { get; set; }
 
+        public string Description { get; set; }
+
         public string EventSource { get; set; }
 
         public int DurationInSeconds { get; set; }

LocalMultiplayerAgent.UnitTest/ControllerTests.cs

@@ -30,6 +30,9 @@ public async Task ValidateStandingByToInitializingThrows()
 
             string sessionHostId = "testSessionHostId";
 
+            // Settings is accessed in the heartbeat endpoint
+            Globals.Settings = new();
+
             // send the first heartbeat with "StandingBy"
             SessionHostHeartbeatInfo heartbeat = new SessionHostHeartbeatInfo()
             {

LocalMultiplayerAgent/Config/MultiplayerSettings.cs

@@ -30,6 +30,8 @@ public class MultiplayerSettings
 
         public int NumHeartBeatsForTerminateResponse { get; set; }
 
+        public int NumHeartBeatsForMaintenanceEventResponse { get; set; }
+
         public bool RunContainer { get; set; }
 
         public string OutputFolder { get; set; }
@@ -49,6 +51,12 @@ public class MultiplayerSettings
 
         public IDictionary<string, string> DeploymentMetadata { get; set; }
 
+        public string MaintenanceEventType { get; set; }
+
+        public string MaintenanceEventStatus { get; set; }
+
+        public string MaintenanceEventSource { get; set; }
+
         public SessionHostsStartInfo ToSessionHostsStartInfo()
         {
             // Clear mount path in process based, otherwise, agent will kick into back-compat mode and try to strip the

LocalMultiplayerAgent/Config/MultiplayerSettingsValidator.cs

@@ -104,6 +104,12 @@ public bool IsValid(bool createBuild = false)
                     Console.WriteLine("NumHeartBeatsForTerminateResponse must be greater than NumHeartBeatsForActivateResponse. Ideally more than 1, since you would like the server to be alive for a few seconds");
                     isSuccess = false;
                 }
+
+                if (_settings.NumHeartBeatsForTerminateResponse < _settings.NumHeartBeatsForMaintenanceEventResponse)
+                {
+                    Console.WriteLine("NumHeartBeatsForMaintenanceEventResponse must be less than or equal to NumHeartBeatsForTerminateResponse.");
+                    isSuccess = false;
+                }
             }
 
             if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX))

LocalMultiplayerAgent/Controllers/SessionHostController.cs

@@ -12,6 +12,7 @@ namespace LocalMultiplayerAgent.Controllers
     using Microsoft.Azure.Gaming.VmAgent.Model;
     using Microsoft.Extensions.Hosting;
     using Instrumentation;
+    using System.Collections.Generic;
 
     public class SessionHostController : Controller
     {
@@ -54,6 +55,7 @@ public async Task<IActionResult> ProcessHeartbeat(string sessionHostId,
             Operation op = Operation.Continue;
             SessionConfig config = null;
             Console.WriteLine($"CurrentGameState: {heartbeatRequest.CurrentGameState}");
+            bool sendMaintenanceEvent = false;
 
             if(!ValidateSessionHostStatusTransition(previousSessionHostStatus, currentGameState))
             {
@@ -78,22 +80,50 @@ public async Task<IActionResult> ProcessHeartbeat(string sessionHostId,
                     config = Globals.SessionConfig;
                 }
 
+                sendMaintenanceEvent = (numHeartBeats == Globals.Settings.NumHeartBeatsForMaintenanceEventResponse);
+
                 HeartBeatsCount[sessionHostId]++;
             }
             else
             {
+                sendMaintenanceEvent = (Globals.Settings.NumHeartBeatsForMaintenanceEventResponse == 1);
                 HeartBeatsCount.TryAdd(sessionHostId, 1);
             }
 
             previousSessionHostStatus = currentGameState;
 
-            return Ok(new SessionHostHeartbeatInfo
+            SessionHostHeartbeatInfo heartbeatResponse = new SessionHostHeartbeatInfo
             {
                 CurrentGameState = currentGameState,
                 NextHeartbeatIntervalMs = DefaultHeartbeatIntervalMs,
                 Operation = op,
                 SessionConfig = config
-            });
+            };
+
+            if (_wasGsdkVersionLogged && sendMaintenanceEvent)
+            {
+                heartbeatResponse.MaintenanceSchedule = new()
+                {
+                    DocumentIncarnation = "1",
+                    MaintenanceEvents = new List<MaintenanceEvent>()
+                    {
+                        new()
+                        {
+                            EventId = Guid.NewGuid().ToString(),
+                            EventType = Globals.Settings.MaintenanceEventType,
+                            ResourceType = "VirtualMachine",
+                            AffectedResources = new List<string>() { "vmId" },
+                            EventStatus = Globals.Settings.MaintenanceEventStatus,
+                            NotBefore = DateTime.UtcNow.AddMinutes(5),
+                            Description = $"Scheduled {Globals.Settings.MaintenanceEventType} event for VM",
+                            EventSource = Globals.Settings.MaintenanceEventSource,
+                            DurationInSeconds = 300
+                        }
+                    }
+                };
+            }
+
+            return Ok(heartbeatResponse);
         }
 
         private static bool _wasGsdkVersionLogged = false;

LocalMultiplayerAgent/MultiplayerSettings.json

@@ -2,8 +2,13 @@
     "RunContainer": false,
     "OutputFolder": "",
     "NumHeartBeatsForActivateResponse": 10,
+    "NumHeartBeatsForMaintenanceEventResponse": 0, // a value < 1 will disable the maintenance event
     "NumHeartBeatsForTerminateResponse": 60,
     "AgentListeningPort": 56001,
+    // Valid maintenance event values are explained here: https://learn.microsoft.com/azure/virtual-machines/windows/scheduled-events#event-properties
+    "MaintenanceEventType": "Reboot",
+    "MaintenanceEventStatus": "Scheduled",
+    "MaintenanceEventSource": "Platform",
     "AssetDetails": [
         {
             "MountPath": "C:\\Assets",