1
0
mirror of https://github.com/bitwarden/server synced 2026-01-04 17:43:53 +00:00

Refactor to track entities rather than manually writing destroy

This commit is contained in:
Hinton
2025-10-07 16:54:08 -07:00
parent 79f5d8f147
commit 92f2555b5c
9 changed files with 122 additions and 44 deletions

View File

@@ -9,18 +9,16 @@ public interface IRecipeService
/// </summary>
/// <param name="templateName">The name of the recipe template (e.g., "OrganizationWithUsersRecipe")</param>
/// <param name="arguments">Optional JSON arguments to pass to the recipe's Seed method</param>
/// <returns>The result returned by the recipe's Seed method</returns>
/// <returns>A tuple containing the result and optional seed ID for tracked entities</returns>
/// <exception cref="RecipeNotFoundException">Thrown when the recipe template is not found</exception>
/// <exception cref="RecipeExecutionException">Thrown when there's an error executing the recipe</exception>
object? ExecuteRecipe(string templateName, JsonElement? arguments);
(object? Result, Guid? SeedId) ExecuteRecipe(string templateName, JsonElement? arguments);
/// <summary>
/// Destroys data created by a recipe with the given template name and arguments.
/// Destroys data created by a recipe using the seeded data ID.
/// </summary>
/// <param name="templateName">The name of the recipe template (e.g., "OrganizationWithUsersRecipe")</param>
/// <param name="arguments">Optional JSON arguments to pass to the recipe's Destroy method</param>
/// <returns>The result returned by the recipe's Destroy method</returns>
/// <exception cref="RecipeNotFoundException">Thrown when the recipe template is not found</exception>
/// <exception cref="RecipeExecutionException">Thrown when there's an error executing the recipe</exception>
object? DestroyRecipe(string templateName, JsonElement? arguments);
/// <param name="seedId">The ID of the seeded data to destroy</param>
/// <returns>The result of the destroy operation</returns>
/// <exception cref="RecipeExecutionException">Thrown when there's an error destroying the seeded data</exception>
object? DestroyRecipe(Guid seedId);
}

View File

@@ -1,4 +1,6 @@
using Bit.Infrastructure.EntityFramework.Models;
using Bit.Infrastructure.EntityFramework.Repositories;
using Bit.Seeder;
using System.Reflection;
using System.Text.Json;
@@ -15,14 +17,71 @@ public class RecipeService : IRecipeService
_logger = logger;
}
public object? ExecuteRecipe(string templateName, JsonElement? arguments)
public (object? Result, Guid? SeedId) ExecuteRecipe(string templateName, JsonElement? arguments)
{
return ExecuteRecipeMethod(templateName, arguments, "Seed");
var result = ExecuteRecipeMethod(templateName, arguments, "Seed");
if (result is not RecipeResult recipeResult)
{
return (Result: result, SeedId: null);
}
if (recipeResult.TrackedEntities.Count == 0)
{
return (Result: recipeResult.Result, SeedId: null);
}
var seededData = new SeededData
{
Id = Guid.NewGuid(),
RecipeName = templateName,
Data = JsonSerializer.Serialize(recipeResult.TrackedEntities),
CreationDate = DateTime.UtcNow
};
_databaseContext.Add(seededData);
_databaseContext.SaveChanges();
_logger.LogInformation("Saved seeded data with ID {SeedId} for recipe {RecipeName}",
seededData.Id, templateName);
return (Result: recipeResult.Result, SeedId: seededData.Id);
}
public object? DestroyRecipe(string templateName, JsonElement? arguments)
public object? DestroyRecipe(Guid seedId)
{
return ExecuteRecipeMethod(templateName, arguments, "Destroy");
var seededData = _databaseContext.SeededData.FirstOrDefault(s => s.Id == seedId);
if (seededData == null)
{
throw new RecipeExecutionException($"Seeded data with ID {seedId} not found");
}
var trackedEntities = JsonSerializer.Deserialize<Dictionary<string, List<Guid>>>(seededData.Data);
if (trackedEntities == null)
{
throw new RecipeExecutionException($"Failed to deserialize tracked entities for seed ID {seedId}");
}
// Delete in reverse order to respect foreign key constraints
if (trackedEntities.TryGetValue("User", out var userIds))
{
var users = _databaseContext.Users.Where(u => userIds.Contains(u.Id));
_databaseContext.RemoveRange(users);
}
if (trackedEntities.TryGetValue("Organization", out var orgIds))
{
var organizations = _databaseContext.Organizations.Where(o => orgIds.Contains(o.Id));
_databaseContext.RemoveRange(organizations);
}
_databaseContext.Remove(seededData);
_databaseContext.SaveChanges();
_logger.LogInformation("Successfully destroyed seeded data with ID {SeedId} for recipe {RecipeName}",
seedId, seededData.RecipeName);
return new { SeedId = seedId, RecipeName = seededData.RecipeName };
}
private object? ExecuteRecipeMethod(string templateName, JsonElement? arguments, string methodName)