Benevia.Core.DataGenerator 0.9.16

Benevia.Core.DataGenerator

Maintainers

• @dilshod06
• @alisherrik
• @dev-muhammad

High‑level, attribute‑driven data generation engine for Benevia Core / ERP. It bootstraps per‑tenant initial data (blank or demo), applies versioned feature seed scripts, and ensures idempotent incremental upgrades.

Configuration (DataGeneratorConfig)

"Tenants": {
  "tenant-a": {
    "ConnectionString": "Host=localhost;Database=tenant_a;Username=...;Password=...",
    "InitialDataOption": "DemoData",          // or BlankData / empty
    "AdminUsername": "admin",                 // optional override
    "AdminPassword": "Admin@123"              // optional override
  }
}

DataGeneratorConfig fields:

• ConnectionString (required)
• InitialDataOption (optional, default "") – if equals DemoData (case‑insensitive) demo seed runs after blank baseline
• AdminUsername (optional, default admin)
• AdminPassword (optional, default Admin@123)

How It Runs

Register the data generator in your Program.cs:

builder.Services.AddCoreDataGeneration();
await app.Services.InitializeDataGeneratorAsync(ct);

2. For each tenant:
   • Initializes responsibility definitions first (loads/syncs permissions) so seed scripts can safely resolve responsibilities by name.
   • Acquires a database lock record (DataGenerator key) to avoid concurrent runs across nodes.
   • Ensures connection string is set on the shared DbContext.
   • Executes baseline (BlankData) then optional demo preset.
3. For each preset:
   • Discovers assemblies marked with BusinessLogicAssemblyAttribute plus the generator assembly.
   • Locates concrete types implementing ICreateData.
   • Builds dependency layers via DependedFeaturesAttribute.
   • Runs each layer in parallel.
   • Within a feature type, invokes all methods decorated with the target attribute whose version is newer than stored.
   • Updates / inserts a Features row with the highest discovered version.

Attributes

BlankDataAttribute / DemoDataAttribute

Annotate public instance methods of a class implementing ICreateData:

public class ProductSeed : ICreateData
{
    [DataGenerator(DataKind.BlankData, 1)]
    public void SeedProducts(IDataContext dc, EventContext logic) { /* ... */ }

    [DataGenerator(DataKind.DemoData, 1)]
    public void SeedDemoSkus(IDataContext dc, EventContext logic) { /* ... */ }
}

Rules:

• Method signature: (IDataContext dataContext, EventContext eventContext)
• Version must increase monotonically per feature namespace.
• For updates: add a new method with higher Version; previous methods are skipped once version stored >= their version.

DependedFeaturesAttribute

Apply to a feature class to ensure execution order:

[DependedFeatures("ProductSeed", "PricingSeed")] // Names = other feature class names
public class OrderSeed : ICreateData { ... }

Dependency names map to the class names (namespaces are used as persisted feature names—ensure namespace uniqueness).

Feature Version Tracking

Features model columns:

• Name (uses feature type namespace)
• Version (double)
• CreatedAt

On each run for a feature namespace:

1. All applicable methods (attribute + version > stored OR no existing row) execute sequentially inside the feature instance.
2. Highest discovered version is written once (PersistFeatureVersion).

Extending / Adding a Feature

1. Create a class implementing ICreateData in a project marked with BusinessLogicAssemblyAttribute.
2. Give it a stable namespace (used as the feature key).
3. Add one or more attribute methods (start with Version = 1.0).
4. For future schema / data evolution, add new method(s) with higher Version numbers—never change old versions.
5. If ordering is required, add DependedFeaturesAttribute referencing other feature class names.

Safety Guidelines

• Keep seed methods idempotent beyond version gating (avoid inserting duplicates if re-run before version bump).
• Avoid external network calls inside seed methods; keep them deterministic.
• Validate any sensitive default credentials are overridden outside development.

Minimal Example

public class CoreSeed : ICreateData
{
    [DataGenerator(DataKind.Blank, 1)]
    public void SeedCore(IDataContext dc, EventContext eventContext) { /* baseline */ }

    [DataGenerator(DataKind.DemoData, 1)]
    public void SeedCoreDemo(IDataContext dc, EventContext eventContext) { /* demo */ }
}

Register your assembly with BusinessLogicAssemblyAttribute so discovery picks it up.

Invocation

Ensure startup calls:

await app.Services.InitializeDataGeneratorAsync(ct);

(Place after migrations / database availability.)