-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add refund reports * Fix fake data generator in reports
- Loading branch information
1 parent
a8e16b0
commit a89c0d4
Showing
5 changed files
with
204 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
133 changes: 133 additions & 0 deletions
133
BTCPayServer/Services/Reporting/RefundsReportProvider.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| #nullable enable | ||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Threading; | ||
| using System.Threading.Tasks; | ||
| using BTCPayServer.Client.Models; | ||
| using BTCPayServer.Data; | ||
| using Dapper; | ||
| using Microsoft.EntityFrameworkCore; | ||
|
|
||
| namespace BTCPayServer.Services.Reporting | ||
| { | ||
| public class RefundsReportProvider : ReportProvider | ||
| { | ||
| private readonly BTCPayNetworkJsonSerializerSettings _serializerSettings; | ||
| private readonly DisplayFormatter _displayFormatter; | ||
|
|
||
| private ViewDefinition CreateDefinition() | ||
| { | ||
| return new ViewDefinition | ||
| { | ||
| Fields = new List<StoreReportResponse.Field> | ||
| { | ||
| new("Date", "datetime"), | ||
| new("InvoiceId", "invoice_id"), | ||
| new("Currency", "string"), | ||
| new("Completed", "amount"), | ||
| new("Awaiting", "amount"), | ||
| new("Limit", "amount"), | ||
| new("FullyPaid", "boolean") | ||
| }, | ||
| Charts = | ||
| { | ||
| new () | ||
| { | ||
| Name = "Aggregated amount", | ||
| Groups = { "Currency" }, | ||
| HasGrandTotal = false, | ||
| Aggregates = { "Awaiting", "Completed", "Limit" } | ||
| } | ||
| } | ||
| }; | ||
| } | ||
| public override string Name => "Refunds"; | ||
|
|
||
| public ApplicationDbContextFactory DbContextFactory { get; } | ||
|
|
||
| public RefundsReportProvider( | ||
| ApplicationDbContextFactory dbContextFactory, | ||
| BTCPayNetworkJsonSerializerSettings serializerSettings, | ||
| DisplayFormatter displayFormatter) | ||
| { | ||
| DbContextFactory = dbContextFactory; | ||
| _serializerSettings = serializerSettings; | ||
| _displayFormatter = displayFormatter; | ||
| } | ||
| record RefundRow(DateTimeOffset Created, string InvoiceId, string PullPaymentId, string Currency, decimal Limit) | ||
| { | ||
| public decimal Completed { get; set; } | ||
| public decimal Awaiting { get; set; } | ||
| } | ||
| public override async Task Query(QueryContext queryContext, CancellationToken cancellation) | ||
| { | ||
| queryContext.ViewDefinition = CreateDefinition(); | ||
| RefundRow? currentRow = null; | ||
| await using var ctx = DbContextFactory.CreateContext(); | ||
| var conn = ctx.Database.GetDbConnection(); | ||
| var rows = await conn.QueryAsync( | ||
| """ | ||
| SELECT i."Created", i."Id" AS "InvoiceId", p."State", p."PaymentMethodId", pp."Id" AS "PullPaymentId", pp."Blob" AS "ppBlob", p."Blob" AS "pBlob" FROM "Invoices" i | ||
| JOIN "Refunds" r ON r."InvoiceDataId"= i."Id" | ||
| JOIN "PullPayments" pp ON r."PullPaymentDataId"=pp."Id" | ||
| LEFT JOIN "Payouts" p ON p."PullPaymentDataId"=pp."Id" | ||
| WHERE i."StoreDataId" = @storeId | ||
| AND i."Created" >= @start AND i."Created" <= @end | ||
| AND pp."Archived" IS FALSE | ||
| ORDER BY i."Created", pp."Id" | ||
| """, new { start = queryContext.From, end = queryContext.To, storeId = queryContext.StoreId }); | ||
| foreach (var r in rows) | ||
| { | ||
| PullPaymentBlob ppBlob = GetPullPaymentBlob(r); | ||
| PayoutBlob? pBlob = GetPayoutBlob(r); | ||
|
|
||
| if ((string)r.PullPaymentId != currentRow?.PullPaymentId) | ||
| { | ||
| AddRow(queryContext, currentRow); | ||
| currentRow = new(r.Created, r.InvoiceId, r.PullPaymentId, ppBlob.Currency, ppBlob.Limit); | ||
| } | ||
| if (pBlob is null) | ||
| continue; | ||
| var state = Enum.Parse<PayoutState>((string)r.State); | ||
| if (state == PayoutState.Cancelled) | ||
| continue; | ||
| if (state is PayoutState.Completed) | ||
| currentRow.Completed += pBlob.Amount; | ||
| else | ||
| currentRow.Awaiting += pBlob.Amount; | ||
| } | ||
| AddRow(queryContext, currentRow); | ||
| } | ||
|
|
||
| private PayoutBlob? GetPayoutBlob(dynamic r) | ||
| { | ||
| if (r.pBlob is null) | ||
| return null; | ||
| Data.PayoutData p = new Data.PayoutData(); | ||
| p.PaymentMethodId = r.PaymentMethodId; | ||
| p.Blob = (string)r.pBlob; | ||
| return p.GetBlob(_serializerSettings); | ||
| } | ||
|
|
||
| private static PullPaymentBlob GetPullPaymentBlob(dynamic r) | ||
| { | ||
| Data.PullPaymentData pp = new Data.PullPaymentData(); | ||
| pp.Blob = (string)r.ppBlob; | ||
| return pp.GetBlob(); | ||
| } | ||
|
|
||
| private void AddRow(QueryContext queryContext, RefundRow? currentRow) | ||
| { | ||
| if (currentRow is null) | ||
| return; | ||
| var data = queryContext.AddData(); | ||
| data.Add(currentRow.Created); | ||
| data.Add(currentRow.InvoiceId); | ||
| data.Add(currentRow.Currency); | ||
| data.Add(_displayFormatter.ToFormattedAmount(currentRow.Completed, currentRow.Currency)); | ||
| data.Add(_displayFormatter.ToFormattedAmount(currentRow.Awaiting, currentRow.Currency)); | ||
| data.Add(_displayFormatter.ToFormattedAmount(currentRow.Limit, currentRow.Currency)); | ||
| data.Add(currentRow.Limit <= currentRow.Completed); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters