Introduce max devices and shockers per user limit (#207)

* Initial implementation

* Fix error on create device

* Finish impl

* bleh

* Rename Device -> Hub

* Use async override

* Update API/Controller/Devices/DevicesController.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Luc ♥ <luca@perugia.ovh>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: 3 people

API/Controller/Devices/DeviceOtaController.cs

@@ -46,7 +46,7 @@ public async Task<IActionResult> GetOtaUpdateHistory([FromRoute] Guid deviceId,
         // Check if user owns device or has a share
         var deviceExistsAndYouHaveAccess = await _db.Devices.AnyAsync(x =>
             x.Id == deviceId && x.OwnerId == CurrentUser.Id);
-        if (!deviceExistsAndYouHaveAccess) return Problem(DeviceError.DeviceNotFound);
+        if (!deviceExistsAndYouHaveAccess) return Problem(HubError.HubNotFound);
 
         return LegacyDataOk(await otaService.GetUpdates(deviceId));
     }

API/Controller/Devices/DevicesController.cs

@@ -4,6 +4,7 @@
 using OpenShock.API.Models.Requests;
 using OpenShock.API.Services;
 using OpenShock.Common.Authentication.Attributes;
+using OpenShock.Common.Constants;
 using OpenShock.Common.Errors;
 using OpenShock.Common.Extensions;
 using OpenShock.Common.Models;
@@ -59,7 +60,7 @@ public async Task<IActionResult> GetDeviceById([FromRoute] Guid deviceId)
                 CreatedOn = x.CreatedAt,
                 Token = hasAuthPerms ? x.Token : null
             }).FirstOrDefaultAsync();
-        if (device == null) return Problem(DeviceError.DeviceNotFound);
+        if (device == null) return Problem(HubError.HubNotFound);
 
         return LegacyDataOk(device);
     }
@@ -80,7 +81,7 @@ public async Task<IActionResult> GetDeviceById([FromRoute] Guid deviceId)
     public async Task<IActionResult> EditDevice([FromRoute] Guid deviceId, [FromBody] HubEditRequest body, [FromServices] IDeviceUpdateService updateService)
     {
         var device = await _db.Devices.FirstOrDefaultAsync(x => x.OwnerId == CurrentUser.Id && x.Id == deviceId);
-        if (device == null) return Problem(DeviceError.DeviceNotFound);
+        if (device == null) return Problem(HubError.HubNotFound);
 
         device.Name = body.Name;
         await _db.SaveChangesAsync();
@@ -105,7 +106,7 @@ public async Task<IActionResult> EditDevice([FromRoute] Guid deviceId, [FromBody
     public async Task<IActionResult> RegenerateDeviceToken([FromRoute] Guid deviceId)
     {
         var device = await _db.Devices.FirstOrDefaultAsync(x => x.OwnerId == CurrentUser.Id && x.Id == deviceId);
-        if (device == null) return Problem(DeviceError.DeviceNotFound);
+        if (device == null) return Problem(HubError.HubNotFound);
 
         device.Token = CryptoUtils.RandomString(256);
 
@@ -130,7 +131,7 @@ public async Task<IActionResult> RegenerateDeviceToken([FromRoute] Guid deviceId
     public async Task<IActionResult> RemoveDevice([FromRoute] Guid deviceId, [FromServices] IDeviceUpdateService updateService)
     {
         var affected = await _db.Devices.Where(x => x.Id == deviceId).WhereIsUserOrPrivileged(x => x.Owner, CurrentUser).ExecuteDeleteAsync();
-        if (affected <= 0) return Problem(DeviceError.DeviceNotFound);
+        if (affected <= 0) return Problem(HubError.HubNotFound);
 
         await updateService.UpdateDeviceForAllShared(CurrentUser.Id, deviceId, DeviceUpdateType.Deleted);
 
@@ -162,6 +163,12 @@ public Task<IActionResult> CreateDevice([FromServices] IDeviceUpdateService upda
     [MapToApiVersion("2")]
     public async Task<IActionResult> CreateDeviceV2([FromBody] HubCreateRequest data, [FromServices] IDeviceUpdateService updateService)
     {
+        int nDevices = await _db.Devices.CountAsync(d => d.OwnerId == CurrentUser.Id);
+        if (nDevices >= HardLimits.MaxHubsPerUser)
+        {
+            return Problem(HubError.TooManyHubs);
+        }
+
         var device = new Common.OpenShockDb.Device
         {
             Id = Guid.CreateVersion7(),
@@ -193,7 +200,7 @@ public async Task<IActionResult> GetPairCode([FromRoute] Guid deviceId)
         var devicePairs = _redis.RedisCollection<DevicePair>();
 
         var deviceExists = await _db.Devices.AnyAsync(x => x.Id == deviceId && x.OwnerId == CurrentUser.Id);
-        if (!deviceExists) Problem(DeviceError.DeviceNotFound);
+        if (!deviceExists) return Problem(HubError.HubNotFound);
         // replace with unlink?
         var existing = await devicePairs.FindByIdAsync(deviceId.ToString());
         if (existing != null) await devicePairs.DeleteAsync(existing);
@@ -230,15 +237,15 @@ public async Task<IActionResult> GetLiveControlGatewayInfo([FromRoute] Guid devi
         var deviceExistsAndYouHaveAccess = await _db.Devices.AnyAsync(x =>
             x.Id == deviceId && (x.OwnerId == CurrentUser.Id || x.Shockers.Any(y => y.UserShares.Any(
                 z => z.SharedWithUserId == CurrentUser.Id))));
-        if (!deviceExistsAndYouHaveAccess) return Problem(DeviceError.DeviceNotFound);
+        if (!deviceExistsAndYouHaveAccess) return Problem(HubError.HubNotFound);
 
         // Check if device is online
         var devicesOnline = _redis.RedisCollection<DeviceOnline>();
         var online = await devicesOnline.FindByIdAsync(deviceId.ToString());
-        if (online == null) return Problem(DeviceError.DeviceIsNotOnline);
+        if (online == null) return Problem(HubError.HubIsNotOnline);
 
         // Check if device is connected to a LCG node
-        if (online.Gateway == null) return Problem(DeviceError.DeviceNotConnectedToGateway);
+        if (online.Gateway == null) return Problem(HubError.HubNotConnectedToGateway);
 
         // Get LCG node info
         var lcgNodes = _redis.RedisCollection<LcgNode>();

API/Controller/Devices/GetShockers.cs

@@ -24,7 +24,7 @@ public sealed partial class DevicesController
     public async Task<IActionResult> GetShockers([FromRoute] Guid deviceId)
     {
         var deviceExists = await _db.Devices.AnyAsync(x => x.OwnerId == CurrentUser.Id && x.Id == deviceId);
-        if (!deviceExists) return Problem(DeviceError.DeviceNotFound);
+        if (!deviceExists) return Problem(HubError.HubNotFound);
 
         var shockers = _db.Shockers
             .Where(x => x.DeviceId == deviceId)

API/Controller/Shockers/EditShocker.cs

@@ -32,7 +32,7 @@ public async Task<IActionResult> EditShocker(
         [FromServices] IDeviceUpdateService deviceUpdateService)
     {
         var device = await _db.Devices.AnyAsync(x => x.OwnerId == CurrentUser.Id && x.Id == body.Device);
-        if (!device) return Problem(DeviceError.DeviceNotFound);
+        if (!device) return Problem(HubError.HubNotFound);
 
         var shocker = await _db.Shockers.FirstOrDefaultAsync(x => x.Device.OwnerId == CurrentUser.Id && x.Id == shockerId);
         if (shocker == null) return Problem(ShockerError.ShockerNotFound);

API/Controller/Shockers/RegisterShocker.cs

@@ -5,6 +5,7 @@
 using OpenShock.API.Models.Requests;
 using OpenShock.API.Services;
 using OpenShock.Common.Authentication.Attributes;
+using OpenShock.Common.Constants;
 using OpenShock.Common.Errors;
 using OpenShock.Common.Models;
 using OpenShock.Common.OpenShockDb;
@@ -32,10 +33,10 @@ public async Task<IActionResult> RegisterShocker(
     {
         var device = await _db.Devices.Where(x => x.OwnerId == CurrentUser.Id && x.Id == body.Device)
             .Select(x => x.Id).FirstOrDefaultAsync();
-        if (device == Guid.Empty) return Problem(DeviceError.DeviceNotFound);
+        if (device == Guid.Empty) return Problem(HubError.HubNotFound);
         var shockerCount = await _db.Shockers.CountAsync(x => x.DeviceId == body.Device);
 
-        if (shockerCount >= 11) return Problem(DeviceError.TooManyShockers);
+        if (shockerCount >= HardLimits.MaxShockersPerHub) return Problem(HubError.TooManyShockers);
 
         var shocker = new Shocker
         {

Common/Constants/HardLimits.cs

@@ -46,7 +46,9 @@ public static class HardLimits
     public const int ShockerControlLogCustomNameMaxLength = 64;
 
     public const int CreateShareRequestMaxShockers = 128;
-    
+
+    public const int MaxHubsPerUser = 4;
+    public const int MaxShockersPerHub = 11;
     public const int MaxShockerControlLogsPerUser = 2048;
 
     // Don't allow any firmware prior to 2024.

Common/Errors/DeviceError.cs

@@ -0,0 +1,16 @@
+using System.Net;
+using OpenShock.Common.Constants;
+using OpenShock.Common.Problems;
+
+namespace OpenShock.Common.Errors;
+
+public static class HubError
+{
+    public static OpenShockProblem HubNotFound => new("Hub.NotFound", "Hub not found", HttpStatusCode.NotFound);
+    public static OpenShockProblem HubIsNotOnline => new("Hub.NotOnline", "Hub is not online", HttpStatusCode.NotFound);
+    public static OpenShockProblem HubNotConnectedToGateway => new("Hub.NotConnectedToGateway", "Hub is not connected to a gateway", HttpStatusCode.PreconditionFailed, "Hub is online but not connected to a LCG node, you might need to upgrade your firmware to use this feature");
+
+    public static OpenShockProblem TooManyHubs => new("Hub.TooManyHubs", "You have too many hubs", HttpStatusCode.Conflict, $"You have reached the maximum number of shockers for this hub ({HardLimits.MaxHubsPerUser})");
+    public static OpenShockProblem TooManyShockers => new("Hub.TooManyShockers", "Hub has too many shockers", HttpStatusCode.BadRequest, $"You have reached the maximum number of shockers for this hub ({HardLimits.MaxShockersPerHub})");
+    
+}