Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,10 @@ jobs:
- name: Setup .NET
uses: actions/setup-dotnet@v4
with:
dotnet-version: 10.0.x
# 11 builds the net11.0 targets; 10 provides the runtime for the net10.0 test runs
dotnet-version: |
10.0.x
11.0.x

- name: Install GitVersion
run: dotnet tool install GitVersion.Tool --global --version 5.*
Expand Down
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -360,4 +360,6 @@ MigrationBackup/

# Fody - auto-generated XML schema
FodyWeavers.xsd
*.json

# GitVersion output (generated in CI)
version_info.json
261 changes: 261 additions & 0 deletions Mimeo.DynamicUI.Blazor.Tests/Forms/ImportFormCsvTests.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,261 @@
using AwesomeAssertions;
using Bunit;
using CsvHelper;
using Microsoft.AspNetCore.Components.Forms;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Localization;
using Mimeo.DynamicUI.Blazor.Forms;
using Mimeo.DynamicUI.Blazor.Services;
using Mimeo.DynamicUI.Data;
using System.Globalization;

namespace Mimeo.DynamicUI.Blazor.Tests.Forms
{
/// <summary>
/// ImportForm reads CSV records through reflection (a generic helper made generic over
/// <see cref="IImportExportDataService.GetImportModelType"/>), so these tests cover the model shapes it must handle.
/// </summary>
public class ImportFormCsvTests
{
private const string CsvContentType = "text/csv";

[Fact]
public async Task ImportsCsvRecordsAsInstancesOfTheImportModelType()
{
// Arrange
using var context = CreateContext();
var service = new RecordingImportService<CsvImportModel>();
var imported = new List<object?>();

var form = RenderImportForm(context, service, async args =>
{
await foreach (var record in args.Data)
{
imported.Add(record);
}
});

// Act
await UploadAsync(form, "Id,Name,Price\n1,Alpha,1.5\n2,\"Smith, Jr\",20\n");

// Assert
form.WaitForAssertion(() => imported.Should().HaveCount(2));
imported.Should().AllBeOfType<CsvImportModel>();
imported.Cast<CsvImportModel>().Should().BeEquivalentTo(
[
new CsvImportModel { Id = 1, Name = "Alpha", Price = 1.5m },
new CsvImportModel { Id = 2, Name = "Smith, Jr", Price = 20m },
]);
ErrorText(form).Should().BeEmpty();
}

[Fact]
public async Task ImportedRecordsFlowThroughTheTypedImportExportDataServiceAdapter()
{
// Arrange: the same wiring ImportExportButtons uses
using var context = CreateContext();
var service = new RecordingImportService<CsvImportModel>();
IImportExportDataService untypedService = service;

var form = RenderImportForm(context, service, untypedService.ImportData);

// Act
await UploadAsync(form, "Id,Name,Price\n1,Alpha,1.5\n");

// Assert
form.WaitForAssertion(() => service.Imported.Should().ContainSingle());
service.Imported[0].Should().BeEquivalentTo(new CsvImportModel { Id = 1, Name = "Alpha", Price = 1.5m });
}

[Fact]
public async Task ImportsStructModels()
{
// Arrange: CsvHelper supports [CsvRecord] structs, but IAsyncEnumerable<T> is only covariant for reference types
using var context = CreateContext();
var service = new RecordingImportService<CsvImportStruct>();
IImportExportDataService untypedService = service;

var form = RenderImportForm(context, service, untypedService.ImportData);

// Act
await UploadAsync(form, "Id,Name\n1,Alpha\n2,Beta\n");

// Assert
form.WaitForAssertion(() => ErrorText(form).Should().BeEmpty());
form.WaitForAssertion(() => service.Imported.Should().Equal(
new CsvImportStruct { Id = 1, Name = "Alpha" },
new CsvImportStruct { Id = 2, Name = "Beta" }));
}

[Fact]
public async Task ImportHonorsCsvRecordMapOfAModelThatCannotBeAnnotated()
{
// Arrange: replacement for the removed CsvImportClassMapType
using var context = CreateContext();
var service = new RecordingImportService<MappedImportModel>();
IImportExportDataService untypedService = service;

var form = RenderImportForm(context, service, untypedService.ImportData);

// Act
await UploadAsync(form, "Identifier,Name\n7,Alpha\n");

// Assert
form.WaitForAssertion(() => service.Imported.Should().ContainSingle());
service.Imported[0].Should().BeEquivalentTo(new MappedImportModel { Id = 7, Name = "Alpha", Secret = null });
}

[Fact]
public async Task ImportUsesInvariantCultureRegardlessOfCurrentCulture()
{
// Arrange: de-DE would read "1.5" as 15
var originalCulture = CultureInfo.CurrentCulture;
CultureInfo.CurrentCulture = new CultureInfo("de-DE");
try
{
using var context = CreateContext();
var service = new RecordingImportService<CsvImportModel>();
IImportExportDataService untypedService = service;

var form = RenderImportForm(context, service, untypedService.ImportData);

// Act
await UploadAsync(form, "Id,Name,Price\n1,Alpha,1.5\n");

// Assert
form.WaitForAssertion(() => service.Imported.Should().ContainSingle());
service.Imported[0].Price.Should().Be(1.5m);
}
finally
{
CultureInfo.CurrentCulture = originalCulture;
}
}

[Fact]
public async Task ShowsAnErrorWhenAColumnIsMissing()
{
// Arrange
using var context = CreateContext();
var service = new RecordingImportService<CsvImportModel>();
IImportExportDataService untypedService = service;

var form = RenderImportForm(context, service, untypedService.ImportData);

// Act
await UploadAsync(form, "Id,Name\n1,Alpha\n");

// Assert
form.WaitForAssertion(() => ErrorText(form).Should().Contain("Price"));
service.Imported.Should().BeEmpty();
}

[Fact]
public async Task ShowsAnErrorWhenTheModelHasNoCsvMapping()
{
// Arrange: CsvHelper 34 can only read [CsvRecord] or [CsvRecordMap] types
using var context = CreateContext();
var service = new RecordingImportService<UnmappedImportModel>();
IImportExportDataService untypedService = service;

var form = RenderImportForm(context, service, untypedService.ImportData);

// Act
await UploadAsync(form, "Id\n1\n");

// Assert
form.WaitForAssertion(() => ErrorText(form).Should().Contain(nameof(UnmappedImportModel)));
service.Imported.Should().BeEmpty();
}

private static BunitContext CreateContext()
{
var context = new BunitContext();
context.JSInterop.Mode = JSRuntimeMode.Loose;
context.Services.AddSingleton<TaskRunningService>();
context.Services.AddSingleton<IStringLocalizer, KeyStringLocalizer>();
return context;
}

private static IRenderedComponent<ImportForm> RenderImportForm(
BunitContext context,
IImportExportDataService service,
Func<ImportEventArgs<object?>, Task> onImport)
{
return context.Render<ImportForm>(parameters => parameters
.Add(p => p.ImportExportDataService, service)
.Add(p => p.OnImport, onImport));
}

private static async Task UploadAsync(IRenderedComponent<ImportForm> form, string csv)
{
var inputFile = form.FindComponent<InputFile>();
await form.InvokeAsync(() => inputFile.UploadFiles(InputFileContent.CreateFromText(csv, "import.csv", contentType: CsvContentType)));
}

private static string ErrorText(IRenderedComponent<ImportForm> form) =>
form.Find(".alert-danger").TextContent.Trim();

private sealed class RecordingImportService<TModel> : IImportExportDataService<TModel>
{
public List<TModel> Imported { get; } = [];

public async Task ImportData(ImportEventArgs<TModel> args)
{
await foreach (var record in args.Data)
{
Imported.Add(record);
}
}

public Task<DataResponse<TModel>> GetExportModels(DataQuery args) =>
Task.FromResult(new DataResponse<TModel> { Count = 0, Value = [] });
}

private sealed class KeyStringLocalizer : IStringLocalizer
{
public LocalizedString this[string name] => new(name, name);

public LocalizedString this[string name, params object[] arguments] => new(name, name);

public IEnumerable<LocalizedString> GetAllStrings(bool includeParentCultures) => [];
}
}

[CsvRecord]
public partial class CsvImportModel
{
public int Id { get; set; }
public string? Name { get; set; }
public decimal Price { get; set; }
}

[CsvRecord]
public partial struct CsvImportStruct
{
public int Id { get; set; }
public string? Name { get; set; }
}

public class MappedImportModel
{
public int Id { get; set; }
public string? Name { get; set; }
public string? Secret { get; set; }
}

[CsvRecordMap(typeof(MappedImportModel))]
public partial class MappedImportModelMap
{
[CsvColumn("Identifier")]
public int Id { get; set; }

[CsvIgnore]
public string? Secret { get; set; }
}

public class UnmappedImportModel
{
public int Id { get; set; }
}
}
20 changes: 7 additions & 13 deletions Mimeo.DynamicUI.Blazor.Tests/Mimeo.DynamicUI.Blazor.Tests.csproj
Original file line number Diff line number Diff line change
@@ -1,28 +1,22 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>net10.0</TargetFramework>
<TargetFrameworks>net10.0;net11.0</TargetFrameworks>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>

<IsPackable>false</IsPackable>
<IsTestProject>true</IsTestProject>
<OutputType>Exe</OutputType>
<UseMicrosoftTestingPlatformRunner>true</UseMicrosoftTestingPlatformRunner>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="AwesomeAssertions" Version="9.5.0" />
<PackageReference Include="bunit" Version="2.9.0" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="18.8.1" />
<PackageReference Include="AwesomeAssertions" Version="9.6.0" />
<PackageReference Include="bunit" Version="2.15.2" />
<PackageReference Include="Microsoft.Testing.Extensions.CodeCoverage" Version="18.12.0" />
<PackageReference Include="System.Linq.Async" Version="7.0.1" />
<PackageReference Include="xunit.runner.visualstudio" Version="3.1.5">
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
<PrivateAssets>all</PrivateAssets>
</PackageReference>
<PackageReference Include="coverlet.collector" Version="10.0.1">
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
<PrivateAssets>all</PrivateAssets>
</PackageReference>
<PackageReference Include="xunit.v3" Version="3.2.2" />
<PackageReference Include="xunit.v3" Version="4.0.3" />
</ItemGroup>

<ItemGroup>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,6 @@ private async Task OnGridLoadData(LoadDataArgs args)
}

isLoading = true;
StateHasChanged();

try
{
Expand Down Expand Up @@ -210,7 +209,6 @@ private async Task OnGridLoadData(LoadDataArgs args)
finally
{
isLoading = false;
StateHasChanged();
}
}

Expand Down
4 changes: 4 additions & 0 deletions Mimeo.DynamicUI.Blazor/Forms/DynamicEditForm.razor
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,11 @@

private async Task SubmitEventHandler()
{
#if NET11_0_OR_GREATER
if (Context != null && await Context.ValidateAsync() == true)
#else
if (Context?.Validate() == true)
#endif
{
ErrorMessage = "";
try
Expand Down
23 changes: 21 additions & 2 deletions Mimeo.DynamicUI.Blazor/Forms/ImportExportButtons.razor
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
@using Mimeo.DynamicUI.Blazor.Extensions
@using Microsoft.Extensions.Logging
@using Mimeo.DynamicUI.Blazor.Extensions

@inject DialogService dialogService
@inject TaskRunningService taskRunningService
@inject IJSRuntime JSRuntime
@inject ILogger<ImportExportButtons> logger

@{
RenderFragment exportFragment;
Expand Down Expand Up @@ -66,7 +68,24 @@
var extension = dataType.ToString("f").ToLower(); // This works for CSV and JSON. In the future we might need to tweak things.

var fileName = $"export-{DateTime.Now.ToString("o").Replace(":", "_")}.{extension}";
await JSRuntime.InvokeVoidAsync("exportHelpers.downloadFile", fileName, $"text/{extension}", file);

try
{
await JSRuntime.InvokeVoidAsync("exportHelpers.downloadFile", fileName, $"text/{extension}", file);
}
catch (JSDisconnectedException)
{
// User navigated away or closed the tab; safe to ignore.
}
catch (TaskCanceledException)
{
// Interop timed out or was canceled during component disposal.
}
catch (JSException ex)
{
// Actual bug or runtime error in the JS function; log it without crashing the circuit.
logger.LogWarning(ex, "Failed to execute exportHelpers.downloadFile JS interop.");
}
});
}

Expand Down
Loading
Loading