YamlResourceCollection.cs 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524
  1. using System.Collections.ObjectModel;
  2. using System.Collections.Specialized;
  3. using System.Diagnostics;
  4. using RackPeek.Domain.Discovery;
  5. using RackPeek.Domain.Resources;
  6. using RackPeek.Domain.Resources.AccessPoints;
  7. using RackPeek.Domain.Resources.Connections;
  8. using RackPeek.Domain.Resources.Desktops;
  9. using RackPeek.Domain.Resources.Firewalls;
  10. using RackPeek.Domain.Resources.Hardware;
  11. using RackPeek.Domain.Resources.Laptops;
  12. using RackPeek.Domain.Resources.Routers;
  13. using RackPeek.Domain.Resources.Servers;
  14. using RackPeek.Domain.Resources.Services;
  15. using RackPeek.Domain.Resources.SystemResources;
  16. using RackPeek.Domain.Resources.OtherHardware;
  17. using RackPeek.Domain.Resources.UpsUnits;
  18. using YamlDotNet.Serialization;
  19. using YamlDotNet.Serialization.NamingConventions;
  20. using Switch = RackPeek.Domain.Resources.Switches.Switch;
  21. namespace RackPeek.Domain.Persistence.Yaml;
  22. public class ResourceCollection {
  23. public readonly SemaphoreSlim FileLock = new(1, 1);
  24. public List<Resource> Resources { get; } = new();
  25. public List<Connection> Connections { get; } = new();
  26. /// <summary>
  27. /// Whether the store has ever been read successfully. Guarded by
  28. /// <see cref="FileLock" />. Write paths check it so a boot that survived an
  29. /// unreadable config cannot later persist the empty in-memory collection over
  30. /// the user's file.
  31. /// </summary>
  32. public bool Loaded { get; set; }
  33. }
  34. public sealed class YamlResourceCollection(
  35. string filePath,
  36. ITextFileStore fileStore,
  37. ResourceCollection resourceCollection,
  38. IResourceYamlMigrationService migrationService)
  39. : IResourceCollection {
  40. // Bump this when your YAML schema changes, and add a migration step below.
  41. private static readonly int _currentSchemaVersion = RackPeekConfigMigrationDeserializer.ListOfMigrations.Count;
  42. public Task<bool> Exists(string name) {
  43. return Task.FromResult(resourceCollection.Resources.Exists(r =>
  44. r.Name.Equals(name, StringComparison.OrdinalIgnoreCase)));
  45. }
  46. public Task<string?> GetKind(string? name) {
  47. return Task.FromResult(resourceCollection.Resources.FirstOrDefault(r =>
  48. r.Name.Equals(name, StringComparison.OrdinalIgnoreCase))?.Kind);
  49. }
  50. public Task<IReadOnlyList<(Resource, string)>> GetByLabelAsync(string name) {
  51. ReadOnlyCollection<(Resource r, string)> result = resourceCollection.Resources
  52. .Where(r => r.Labels != null && r.Labels.TryGetValue(name, out _))
  53. .Select(r => (r, r.Labels![name]))
  54. .ToList()
  55. .AsReadOnly();
  56. return Task.FromResult<IReadOnlyList<(Resource, string)>>(result);
  57. }
  58. public Task<Dictionary<string, int>> GetLabelsAsync() {
  59. var result = resourceCollection.Resources
  60. .SelectMany(r => r.Labels ?? Enumerable.Empty<KeyValuePair<string, string>>())
  61. .Where(kvp => !string.IsNullOrWhiteSpace(kvp.Key))
  62. .GroupBy(kvp => kvp.Key)
  63. .ToDictionary(g => g.Key, g => g.Count());
  64. return Task.FromResult(result);
  65. }
  66. public Task<IReadOnlyList<(Resource, string)>> GetResourceIpsAsync() {
  67. var result = new List<(Resource, string)>();
  68. List<Resource> allResources = resourceCollection.Resources;
  69. // Build fast lookup for systems
  70. var systemsByName = allResources
  71. .OfType<SystemResource>()
  72. .ToDictionary(s => s.Name, StringComparer.OrdinalIgnoreCase);
  73. // Cache resolved system IPs (prevents repeated recursion)
  74. var resolvedSystemIps = new Dictionary<string, string?>(StringComparer.OrdinalIgnoreCase);
  75. foreach (Resource resource in allResources)
  76. switch (resource) {
  77. case SystemResource system: {
  78. var ip = ResolveSystemIp(system, systemsByName, resolvedSystemIps);
  79. if (!string.IsNullOrWhiteSpace(ip))
  80. result.Add((system, ip));
  81. break;
  82. }
  83. case Service service: {
  84. var ip = ResolveServiceIp(service, systemsByName, resolvedSystemIps);
  85. if (!string.IsNullOrWhiteSpace(ip))
  86. result.Add((service, ip));
  87. break;
  88. }
  89. }
  90. return Task.FromResult((IReadOnlyList<(Resource, string)>)result);
  91. }
  92. public Task<Dictionary<string, int>> GetTagsAsync() {
  93. var result = resourceCollection.Resources
  94. .SelectMany(r => r.Tags) // flatten all tag arrays
  95. .Where(t => !string.IsNullOrWhiteSpace(t))
  96. .GroupBy(t => t)
  97. .ToDictionary(g => g.Key, g => g.Count());
  98. return Task.FromResult(result);
  99. }
  100. public Task<IReadOnlyList<T>> GetAllOfTypeAsync<T>() =>
  101. Task.FromResult<IReadOnlyList<T>>(resourceCollection.Resources.OfType<T>().ToList());
  102. public Task<IReadOnlyList<Resource>> GetDependantsAsync(string name) {
  103. var result = resourceCollection.Resources
  104. .Where(r => r.RunsOn.Any(p => p.Equals(name, StringComparison.OrdinalIgnoreCase)))
  105. .ToList();
  106. return Task.FromResult<IReadOnlyList<Resource>>(result);
  107. }
  108. public async Task Merge(string incomingYaml, MergeMode mode) {
  109. if (string.IsNullOrWhiteSpace(incomingYaml))
  110. return;
  111. await resourceCollection.FileLock.WaitAsync();
  112. try {
  113. await EnsureLoadedAsync();
  114. YamlRoot incomingRoot = await migrationService.DeserializeAsync(incomingYaml);
  115. List<Resource> incomingResources = incomingRoot.Resources ?? new List<Resource>();
  116. DiscoveryIdResolver.ResolveNames(
  117. resourceCollection.Resources,
  118. incomingResources,
  119. incomingRoot.Connections);
  120. List<Resource> merged = ResourceCollectionMerger.Merge(
  121. resourceCollection.Resources,
  122. incomingResources,
  123. mode);
  124. resourceCollection.Resources.Clear();
  125. resourceCollection.Resources.AddRange(merged);
  126. List<Connection>? mergedConnections = ConnectionMerger.Merge(
  127. resourceCollection.Connections,
  128. incomingRoot.Connections,
  129. mode);
  130. if (mergedConnections != null) {
  131. resourceCollection.Connections.Clear();
  132. resourceCollection.Connections.AddRange(mergedConnections);
  133. }
  134. var rootToSave = new YamlRoot {
  135. Version = RackPeekConfigMigrationDeserializer.ListOfMigrations.Count,
  136. Resources = resourceCollection.Resources,
  137. Connections = resourceCollection.Connections
  138. };
  139. await SaveRootAsync(rootToSave);
  140. }
  141. finally {
  142. resourceCollection.FileLock.Release();
  143. }
  144. }
  145. public Task<IReadOnlyList<Resource>> GetByTagAsync(string name) {
  146. return Task.FromResult<IReadOnlyList<Resource>>(
  147. resourceCollection.Resources
  148. .Where(r => r.Tags.Contains(name))
  149. .ToList()
  150. );
  151. }
  152. public IReadOnlyList<Hardware> HardwareResources =>
  153. resourceCollection.Resources.OfType<Hardware>().ToList();
  154. public IReadOnlyList<SystemResource> SystemResources =>
  155. resourceCollection.Resources.OfType<SystemResource>().ToList();
  156. public IReadOnlyList<Service> ServiceResources =>
  157. resourceCollection.Resources.OfType<Service>().ToList();
  158. public Task<Resource?> GetByNameAsync(string name) {
  159. return Task.FromResult(resourceCollection.Resources.FirstOrDefault(r =>
  160. r.Name.Equals(name, StringComparison.OrdinalIgnoreCase)));
  161. }
  162. public Task<T?> GetByNameAsync<T>(string name) where T : Resource {
  163. Resource? resource =
  164. resourceCollection.Resources.FirstOrDefault(r => r.Name.Equals(name, StringComparison.OrdinalIgnoreCase));
  165. return Task.FromResult(resource as T);
  166. }
  167. public Resource? GetByName(string name) {
  168. return resourceCollection.Resources.FirstOrDefault(r =>
  169. r.Name.Equals(name, StringComparison.OrdinalIgnoreCase));
  170. }
  171. public async Task LoadAsync() {
  172. // Routes.razor calls LoadAsync on every Blazor circuit init, so
  173. // multiple tabs / fresh page loads can run this concurrently. Without
  174. // the lock, two callers can interleave Resources.Clear() and
  175. // AddRange() and corrupt the List<T>'s internal _size, producing
  176. // "Index was outside the bounds of the array" out of List.Clear.
  177. await resourceCollection.FileLock.WaitAsync();
  178. try {
  179. await LoadUnderLockAsync();
  180. }
  181. finally {
  182. resourceCollection.FileLock.Release();
  183. }
  184. }
  185. private async Task LoadUnderLockAsync() {
  186. var yaml = await fileStore.ReadAllTextAsync(filePath);
  187. YamlRoot root = await migrationService.DeserializeAsync(
  188. yaml,
  189. async originalYaml => await BackupOriginalAsync(originalYaml),
  190. async migratedRoot => await SaveRootAsync(migratedRoot)
  191. );
  192. resourceCollection.Resources.Clear();
  193. if (root.Resources != null)
  194. resourceCollection.Resources.AddRange(root.Resources);
  195. resourceCollection.Connections.Clear();
  196. if (root.Connections != null)
  197. resourceCollection.Connections.AddRange(root.Connections);
  198. resourceCollection.Loaded = true;
  199. }
  200. /// <summary>
  201. /// Called at the top of every write path, under the lock. Normally a no-op:
  202. /// both the CLI and the web host load at startup. When that startup load failed
  203. /// (unreadable or malformed file, tolerated so the process can boot), this
  204. /// retries — and if the store still cannot be read, the write fails HERE, before
  205. /// the empty in-memory collection can be persisted over the user's config.
  206. /// </summary>
  207. private async Task EnsureLoadedAsync() {
  208. if (!resourceCollection.Loaded)
  209. await LoadUnderLockAsync();
  210. }
  211. public Task AddAsync(Resource resource) {
  212. return UpdateWithLockAsync(list => {
  213. if (list.Any(r => r.Name.Equals(resource.Name, StringComparison.OrdinalIgnoreCase)))
  214. throw new InvalidOperationException($"'{resource.Name}' already exists.");
  215. resource.Kind = GetKind(resource);
  216. list.Add(resource);
  217. });
  218. }
  219. public Task UpdateAsync(Resource resource) {
  220. return UpdateWithLockAsync(list => {
  221. var index = list.FindIndex(r => r.Name.Equals(resource.Name, StringComparison.OrdinalIgnoreCase));
  222. if (index == -1) throw new InvalidOperationException("Not found.");
  223. resource.Kind = GetKind(resource);
  224. list[index] = resource;
  225. });
  226. }
  227. public Task DeleteAsync(string name) {
  228. return UpdateWithLockAsync(list =>
  229. list.RemoveAll(r => r.Name.Equals(name, StringComparison.OrdinalIgnoreCase)));
  230. }
  231. public Task AddConnectionAsync(Connection connection) => UpdateConnectionsWithLockAsync(list => { list.Add(connection); });
  232. public Task RemoveConnectionAsync(Connection connection) {
  233. return UpdateConnectionsWithLockAsync(list => {
  234. list.RemoveAll(c =>
  235. (PortsMatch(c.A, connection.A) && PortsMatch(c.B, connection.B)) ||
  236. (PortsMatch(c.A, connection.B) && PortsMatch(c.B, connection.A)));
  237. });
  238. }
  239. public Task RemoveConnectionsForPortAsync(PortReference port) {
  240. return UpdateConnectionsWithLockAsync(list => {
  241. list.RemoveAll(c =>
  242. PortsMatch(c.A, port) ||
  243. PortsMatch(c.B, port));
  244. });
  245. }
  246. public Task<IReadOnlyList<Connection>> GetConnectionsAsync() {
  247. IReadOnlyList<Connection> result =
  248. resourceCollection.Connections
  249. .ToList()
  250. .AsReadOnly();
  251. return Task.FromResult(result);
  252. }
  253. public Task<IReadOnlyList<Connection>> GetConnectionsForResourceAsync(string resource) {
  254. IReadOnlyList<Connection> result =
  255. resourceCollection.Connections
  256. .Where(c =>
  257. c.A.Resource.Equals(resource, StringComparison.OrdinalIgnoreCase) ||
  258. c.B.Resource.Equals(resource, StringComparison.OrdinalIgnoreCase))
  259. .ToList()
  260. .AsReadOnly();
  261. return Task.FromResult(result);
  262. }
  263. public Task<Connection?> GetConnectionForPortAsync(PortReference port) {
  264. Connection? connection =
  265. resourceCollection.Connections
  266. .FirstOrDefault(c =>
  267. PortsMatch(c.A, port) ||
  268. PortsMatch(c.B, port));
  269. return Task.FromResult(connection);
  270. }
  271. private string? ResolveSystemIp(
  272. SystemResource system,
  273. Dictionary<string, SystemResource> systemsByName,
  274. Dictionary<string, string?> cache) {
  275. // Return cached result if already resolved
  276. if (cache.TryGetValue(system.Name, out var cached))
  277. return cached;
  278. // Direct IP wins
  279. if (!string.IsNullOrWhiteSpace(system.Ip)) {
  280. cache[system.Name] = system.Ip;
  281. return system.Ip;
  282. }
  283. // Must have exactly one parent
  284. if (system.RunsOn?.Count != 1) {
  285. cache[system.Name] = null;
  286. return null;
  287. }
  288. var parentName = system.RunsOn.First();
  289. if (!systemsByName.TryGetValue(parentName, out SystemResource? parent)) {
  290. cache[system.Name] = null;
  291. return null;
  292. }
  293. var resolved = ResolveSystemIp(parent, systemsByName, cache);
  294. cache[system.Name] = resolved;
  295. return resolved;
  296. }
  297. private string? ResolveServiceIp(
  298. Service service,
  299. Dictionary<string, SystemResource> systemsByName,
  300. Dictionary<string, string?> cache) {
  301. // Direct IP wins
  302. if (!string.IsNullOrWhiteSpace(service.Network?.Ip))
  303. return service.Network!.Ip;
  304. // Must have exactly one parent
  305. if (service.RunsOn?.Count != 1)
  306. return null;
  307. var parentName = service.RunsOn.First();
  308. if (!systemsByName.TryGetValue(parentName, out SystemResource? parent))
  309. return null;
  310. return ResolveSystemIp(parent, systemsByName, cache);
  311. }
  312. private async Task UpdateWithLockAsync(Action<List<Resource>> action) {
  313. await resourceCollection.FileLock.WaitAsync();
  314. try {
  315. await EnsureLoadedAsync();
  316. action(resourceCollection.Resources);
  317. // Always write current schema version when app writes the file.
  318. var root = new YamlRoot {
  319. Version = _currentSchemaVersion,
  320. Resources = resourceCollection.Resources,
  321. Connections = resourceCollection.Connections
  322. };
  323. await SaveRootAsync(root);
  324. }
  325. finally {
  326. resourceCollection.FileLock.Release();
  327. }
  328. }
  329. // ----------------------------
  330. // Versioning + migration
  331. // ----------------------------
  332. private async Task BackupOriginalAsync(string originalYaml) {
  333. // Timestamped backup for safe rollback
  334. var backupPath = $"{filePath}.bak.{DateTime.UtcNow:yyyyMMddHHmmss}";
  335. await fileStore.WriteAllTextAsync(backupPath, originalYaml);
  336. }
  337. private async Task SaveRootAsync(YamlRoot? root) {
  338. var contents = SerializeRootAsync(root);
  339. await fileStore.WriteAllTextAsync(filePath, contents);
  340. }
  341. public static string SerializeRootAsync(YamlRoot? root) {
  342. ISerializer serializer = new SerializerBuilder()
  343. .WithNamingConvention(CamelCaseNamingConvention.Instance)
  344. .WithTypeConverter(new StorageSizeYamlConverter())
  345. .WithTypeConverter(new NotesStringYamlConverter())
  346. .ConfigureDefaultValuesHandling(
  347. DefaultValuesHandling.OmitNull |
  348. DefaultValuesHandling.OmitEmptyCollections
  349. )
  350. .Build();
  351. // Preserve ordering: version first, then resources
  352. Debug.Assert(root != null, nameof(root) + " != null");
  353. var payload = new OrderedDictionary {
  354. ["version"] = root.Version,
  355. ["resources"] = (root.Resources ?? new List<Resource>()).Select(SerializeResource).ToList(),
  356. ["connections"] = root.Connections ?? new List<Connection>()
  357. };
  358. return serializer.Serialize(payload);
  359. }
  360. private static string GetKind(Resource resource) {
  361. return resource switch {
  362. Server => "Server",
  363. Switch => "Switch",
  364. Firewall => "Firewall",
  365. Router => "Router",
  366. Desktop => "Desktop",
  367. Laptop => "Laptop",
  368. AccessPoint => "AccessPoint",
  369. Ups => "Ups",
  370. Other => "Other",
  371. SystemResource => "System",
  372. Service => "Service",
  373. _ => throw new InvalidOperationException($"Unknown resource type: {resource.GetType().Name}")
  374. };
  375. }
  376. public static OrderedDictionary SerializeResource(Resource resource) {
  377. var map = new OrderedDictionary {
  378. ["kind"] = GetKind(resource)
  379. };
  380. ISerializer serializer = new SerializerBuilder()
  381. .WithNamingConvention(CamelCaseNamingConvention.Instance)
  382. .WithTypeConverter(new NotesStringYamlConverter())
  383. .ConfigureDefaultValuesHandling(
  384. DefaultValuesHandling.OmitNull |
  385. DefaultValuesHandling.OmitEmptyCollections
  386. )
  387. .Build();
  388. var yaml = serializer.Serialize(resource);
  389. Dictionary<string, object?> props = new DeserializerBuilder()
  390. .Build()
  391. .Deserialize<Dictionary<string, object?>>(yaml);
  392. foreach ((var key, var value) in props)
  393. if (!string.Equals(key, "kind", StringComparison.OrdinalIgnoreCase))
  394. map[key] = value;
  395. return map;
  396. }
  397. private static bool PortsMatch(PortReference a, PortReference b) {
  398. return a.Resource.Equals(b.Resource, StringComparison.OrdinalIgnoreCase)
  399. && a.PortGroup == b.PortGroup
  400. && a.PortIndex == b.PortIndex;
  401. }
  402. private async Task UpdateConnectionsWithLockAsync(Action<List<Connection>> action) {
  403. await resourceCollection.FileLock.WaitAsync();
  404. try {
  405. await EnsureLoadedAsync();
  406. action(resourceCollection.Connections);
  407. var root = new YamlRoot {
  408. Version = _currentSchemaVersion,
  409. Resources = resourceCollection.Resources,
  410. Connections = resourceCollection.Connections
  411. };
  412. await SaveRootAsync(root);
  413. }
  414. finally {
  415. resourceCollection.FileLock.Release();
  416. }
  417. }
  418. }
  419. public class YamlRoot {
  420. public int Version { get; set; }
  421. public List<Resource>? Resources { get; set; }
  422. public List<Connection>? Connections { get; set; }
  423. }