Skip to content

Show the check run on the set view and submit an open set #2607

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pournasserian merged 1 commit into from
Oct 19, 2026
Merged

Show the check run on the set view and submit an open set #2607

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
127 changes: 122 additions & 5 deletions src/FluentCMS.Admin/Components/Pages/ChangeSetView.razor
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
@using FluentCMS.Core.Desk
@inject IChangeSetDirectory Directory
@inject IDeskQueues Queues
@inject FluentCMS.Core.Checks.IChangeSetChecks Checks
@inject IAuditReader Audit
@inject NavigationManager Navigation
@inject IStringLocalizer<ChangeSetView> L
Expand Down Expand Up @@ -90,6 +91,14 @@
<Button Type="submit" data-action="approve" aria-keyshortcuts="A">@L["Approve"] <Kbd Class="bg-primary-foreground/20 text-primary-foreground" aria-hidden="true">A</Kbd></Button>
</form>
}
@if (set.State == ChangeSetState.Open)
{
<form method="post" @onsubmit="SubmitAsync" @formname="submit">
<AntiforgeryToken />
<input type="hidden" name="Submit.Seen" value="@_seen" />
<Button Type="submit" data-action="submit" aria-keyshortcuts="S">@L["Submit for checks"] <Kbd Class="bg-primary-foreground/20 text-primary-foreground" aria-hidden="true">S</Kbd></Button>
</form>
}
@if (set.State == ChangeSetState.Approved)
{
<form method="post" @onsubmit="PublishAsync" @formname="publish">
Expand Down Expand Up @@ -132,6 +141,10 @@
}
</div>
@* A form posted from a page shown before the set moved on must still find its handler, which then says the set moved on. *@
@if (set.State != ChangeSetState.Open)
{
<form method="post" @onsubmit="SubmitAsync" @formname="submit" hidden></form>
}
@if (set.State != ChangeSetState.AwaitingReview)
{
<form method="post" @onsubmit="ApproveAsync" @formname="approve" hidden></form>
Expand Down Expand Up @@ -188,17 +201,74 @@
<CardHeader>
<CardTitle><h2>@L["Checks"]</h2></CardTitle>
<CardDescription>
@if (set.State == ChangeSetState.ChecksFailed)
@if (_checks?.Run is { } run)
{
<span class="flex flex-wrap items-center gap-2">
<Badge Variant="@CheckVariant(run.Status)" data-testid="check-run-status" data-status="@CheckSlug(run.Status)">@CheckLabel(run.Status)</Badge>
<span>@L["Run {0}, {1}", run.Number, run.Mode == FluentCMS.Core.Checks.CheckRunMode.Inline ? L["checked on submit"] : L["checked in the background"]]</span>
@Time(run.FinishedAt)
@if (run.Cost > 0)
{
<span dir="ltr">@run.Cost.ToString("0.00####", CultureInfo.InvariantCulture) USD</span>
}
</span>
}
else if (_checks?.Job is { } job)
{
@L["The checks failed for this set."]
@L["The checks are running: {0} of {1} items done.", job.Progress.Done, job.Progress.Total?.ToString(CultureInfo.CurrentCulture) ?? "?"]
}
else
{
@L["No check results are stored for this set."]
@L["The checks run when the set is submitted."]
}
@L["Results per check appear here once checks run on every change set."]
</CardDescription>
</CardHeader>
@if (_checks?.Run is { } results && (results.Problems.Count > 0 || results.Items.Any(item => item.Results.Count > 0)))
{
<CardContent Class="grid gap-4 text-sm">
@if (results.Problems.Count > 0)
{
<ul class="grid gap-1 text-destructive" data-testid="check-problems">
@foreach (var problem in results.Problems)
{
<li>@problem</li>
}
</ul>
}
@foreach (var item in results.Items.Where(item => item.Results.Count > 0))
{
<div class="grid gap-2" data-checked-item="@item.ItemId.ToString("N")">
<p class="font-medium"><bdi>@item.ContentType</bdi> <bdi class="font-mono text-xs text-muted-foreground" dir="ltr">@item.ItemId.ToString("N")[..8]</bdi></p>
<ul class="grid gap-2">
@foreach (var result in item.Results.OrderBy(result => CheckOrder(result.Status)))
{
<li class="grid gap-1" data-check="@result.Check" data-status="@CheckSlug(result.Status)">
<span class="flex flex-wrap items-center gap-2">
<Badge Variant="@CheckVariant(result.Status)">@CheckLabel(result.Status)</Badge>
<span class="font-medium"><bdi>@result.Check</bdi></span>
<span class="text-muted-foreground">@(result.Severity == FluentCMS.Core.Checks.CheckSeverity.Block ? L["blocks"] : L["warns"])</span>
</span>
@foreach (var finding in result.Findings)
{
<span class="ps-2 text-muted-foreground" data-finding>
@finding.Message
@if (finding.Pointer.Length > 0)
{
<code class="ms-1 font-mono text-xs" dir="ltr">@finding.Pointer</code>
}
@if (finding.Excerpt is { } excerpt)
{
<q class="ms-1">@excerpt</q>
}
</span>
}
</li>
}
</ul>
</div>
}
</CardContent>
}
</Card>
<Card data-testid="change-set-routing">
<CardHeader>
Expand Down Expand Up @@ -260,9 +330,13 @@
[SupplyParameterFromQuery(Name = "done")]
private string? Done { get; set; }

private FluentCMS.Core.Checks.ChangeSetChecksState? _checks;
private DeskQueue? _queue;
private Guid? _next;

[SupplyParameterFromForm(FormName = "submit")]
private ReviewForm? Submit { get; set; }

[SupplyParameterFromForm(FormName = "approve")]
private ReviewForm? Approve { get; set; }

Expand Down Expand Up @@ -300,6 +374,7 @@
[
new(["J", "K"], L["Move to the next or previous item"]),
new(["Enter"], L["Fold or unfold the item that has focus"]),
new(["S"], L["Submit an open set for checks"]),
new(["A"], L["Approve the set and move to the next one"]),
new(["R"], L["Reject the set with a reason"]),
new(["P"], L["Publish an approved set"]),
Expand Down Expand Up @@ -378,9 +453,22 @@
_stateSince = lastMove?.Timestamp;
_seen = lastMove?.Id.ToString("N");
_next = await NextAsync();
var checks = await Checks.GetAsync(Id);
_checks = checks.IsSuccess ? checks.Value : null;
return true;
}

private async Task SubmitAsync()
{
await ActAsync(Submit, async () =>
{
var submitted = await Checks.SubmitAsync(Id);
return submitted.IsSuccess
? FluentCMS.Core.Results.Result<ChangeSet>.Success(submitted.Value.ChangeSet)
: FluentCMS.Core.Results.Result<ChangeSet>.Failure(submitted.Errors);
}, L["Submitted. The checks run on the set before it is reviewed."]);
}

private async Task ApproveAsync()
{
if (await ActAsync(Approve, () => Directory.TransitionAsync(Id, ChangeSetState.Approved), L["Approved. Publish the set to make its items live."]) is not null)
Expand Down Expand Up @@ -456,13 +544,42 @@
return result.IsSuccess ? result.Value : null;
}

private static string CheckSlug(FluentCMS.Core.Checks.CheckStatus status) => status switch
{
FluentCMS.Core.Checks.CheckStatus.NeedsReview => "needs-review",
_ => status.ToString().ToLowerInvariant(),
};

private static int CheckOrder(FluentCMS.Core.Checks.CheckStatus status) => status switch
{
FluentCMS.Core.Checks.CheckStatus.Fail => 0,
FluentCMS.Core.Checks.CheckStatus.NeedsReview => 1,
FluentCMS.Core.Checks.CheckStatus.Warn => 2,
_ => 3,
};

private static string CheckVariant(FluentCMS.Core.Checks.CheckStatus status) => status switch
{
FluentCMS.Core.Checks.CheckStatus.Fail => "destructive",
FluentCMS.Core.Checks.CheckStatus.Pass => "secondary",
_ => "outline",
};

private string CheckLabel(FluentCMS.Core.Checks.CheckStatus status) => status switch
{
FluentCMS.Core.Checks.CheckStatus.Pass => L["Passed"],
FluentCMS.Core.Checks.CheckStatus.Warn => L["Warning"],
FluentCMS.Core.Checks.CheckStatus.Fail => L["Failed"],
_ => L["Needs review"],
};

private string ReviewHint(ChangeSetState state) => state switch
{
ChangeSetState.AwaitingReview => L["Approve the set, or reject it with a reason."],
ChangeSetState.ChecksFailed => L["The checks failed. Whoever opened the set can fix and resubmit it, or you can reject it with a reason."],
ChangeSetState.Approved => L["The set is approved. Publishing it makes all its items live together."],
ChangeSetState.Published => L["The set is live. Reverting it opens a set that undoes it, which is reviewed like any other."],
ChangeSetState.Open => L["The set is still open, so it cannot be reviewed yet."],
ChangeSetState.Open => L["The set is still open. Submit it when it holds every change; the checks run, then a person reviews it."],
ChangeSetState.ChecksRunning => L["The checks are running, so it cannot be reviewed yet."],
ChangeSetState.Rejected => L["The set was rejected. Nothing more can be done with it."],
_ => L["The set was reverted. Nothing more can be done with it."],
Expand Down
43 changes: 43 additions & 0 deletions tests/FluentCMS.IntegrationTests/Desk/ReviewActionTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using System.Net;
using System.Text.Json;
using System.Text.RegularExpressions;
using FluentCMS.Core.Audit;
using FluentCMS.Core.ChangeSets;
Expand Down Expand Up @@ -56,6 +57,48 @@ public async Task Reviewing_from_a_queue_moves_on_to_its_next_set_and_back_to_th
Assert.Contains("data-testid=\"desk-done\"", await host.Client.GetStringAsync(host.LocationOf(rejected)!));
}

[Fact]
public async Task Submitting_an_open_set_runs_its_checks_and_the_view_shows_each_result_with_its_evidence()
{
using var install = new TemporaryInstall();
await using var host = await AdminHost.StartAsync(install);
var ownerId = await host.CreateFirstAdministratorAsync();
await host.AsUserAsync<IContentTypeDirectory, ContentType>(ownerId, async types => (await types.CreateAsync(new NewContentType(
"Product page", "product-page", new ContentTypeDefinition([new FieldDefinition("headline", "text", required: true)])))).Value);
await host.AsUserAsync<FluentCMS.Core.Checks.ICheckDirectory, bool>(ownerId, async checks =>
{
var definition = new FluentCMS.Core.Checks.CheckDefinition(
"terms",
"No superlatives.",
JsonDocument.Parse("""{"terms": ["best in class"]}""").RootElement,
[
new FluentCMS.Core.Checks.CheckExample("passes", FluentCMS.Core.Checks.CheckVerdict.Pass, JsonDocument.Parse("""{"headline": "A kettle"}""").RootElement, contentType: "product-page"),
new FluentCMS.Core.Checks.CheckExample("fails", FluentCMS.Core.Checks.CheckVerdict.Fail, JsonDocument.Parse("""{"headline": "Best in class"}""").RootElement, contentType: "product-page"),
],
scope: new FluentCMS.Core.Checks.CheckScope(["product-page"]));
Assert.True((await checks.CreateAsync(new FluentCMS.Core.Checks.NewCheck("no-superlatives", definition))).IsSuccess);
return (await checks.ActivateAsync("no-superlatives", 1)).IsSuccess;
});
var entry = await host.AsUserAsync<FluentCMS.Core.Content.IEntryDirectory, FluentCMS.Core.Content.Entry>(ownerId, async entries => (await entries.CreateAsync(
new FluentCMS.Core.Content.NewEntry("product-page", JsonDocument.Parse("""{"headline": "The best in class kettle"}""").RootElement))).Value);
var set = await host.AsUserAsync<IChangeSetDirectory, ChangeSet>(ownerId, async directory =>
{
var opened = (await directory.OpenAsync(new NewChangeSet("Launch the kettle.", []))).Value;
return (await directory.AddOperationAsync(opened.Id, ChangeOperation.Create(OperationKind.Create, ItemKind.Entry, entry.Id, null, 1).Value)).Value;
});
await host.SignInAsync(AdminHost.Owner);
Assert.Equal(["submit"], Actions(await host.Client.GetStringAsync($"/sets/{set.Id}")));

var submitted = await (await ActAsync(host, set.Id, "submit")).Content.ReadAsStringAsync();

Assert.Contains("data-state=\"checks-failed\"", submitted);
Assert.Contains("data-testid=\"check-run-status\" data-status=\"fail\"", submitted);
var result = submitted[submitted.IndexOf("data-check=\"no-superlatives\"", StringComparison.Ordinal)..];
Assert.StartsWith("data-check=\"no-superlatives\" data-status=\"fail\"", result);
Assert.Contains("/headline", result);
Assert.Contains("best in class", result);
}

[Fact]
public async Task A_rejection_needs_a_reason_which_the_view_then_shows()
{
Expand Down
Loading
Loading