format usage estimates refactoring & test

This commit is contained in:
Čarodej
2021-12-16 13:44:36 +01:00
parent b4dfbd1623
commit 27753f30ad
3 changed files with 105 additions and 56 deletions

View File

@@ -0,0 +1,31 @@
<?php
namespace App\Users\Actions;
use ByteUnits\Metric;
use Illuminate\Support\Collection;
class FormatUsageEstimatesAction
{
public function __invoke(string $currency, Collection $usage)
{
return $usage->map(function ($estimate) use ($currency) {
// Format usage
$usage = match ($estimate['feature']) {
'bandwidth' => Metric::megabytes($estimate['usage'])->format(),
'storage' => Metric::megabytes($estimate['usage'])->format(),
};
// Normalize units
$amount = $estimate['amount'] / 1000;
return [
'feature' => $estimate['feature'],
'amount' => $amount,
'cost' => format_currency($amount, $currency),
'usage' => $usage,
];
});
}
}

View File

@@ -2,8 +2,10 @@
namespace App\Users\Resources;
use App\Users\Actions\FormatUsageEstimatesAction;
use ByteUnits\Metric;
use Domain\Folders\Resources\FolderCollection;
use VueFileManager\Subscription\Domain\Usage\Actions\SumUsageForCurrentPeriodAction;
use Illuminate\Http\Resources\Json\JsonResource;
use VueFileManager\Subscription\Domain\Credits\Resources\BalanceResource;
use VueFileManager\Subscription\Domain\Subscriptions\Resources\SubscriptionResource;
@@ -61,44 +63,17 @@ class UserResource extends JsonResource
private function getUsageEstimates()
{
$estimates = $this
->subscription
->plan
->meteredFeatures
->map(function ($feature) {
// Get plan currency
$currency = $this->subscription->plan->currency;
// Get first tier
$tier = $feature->tiers()->first();
// Get usage
$usage = resolve(SumUsageForCurrentPeriodAction::class)($this->subscription);
$usageQuery = $this->subscription
->usages()
->where('created_at', '>=', now()->subDays(30))
->where('subscription_id', $this->subscription->id)
->where('metered_feature_id', $feature->id);
$usage = match ($feature->aggregate_strategy) {
'sum_of_usage' => $usageQuery->sum('quantity'),
'maximum_usage' => $usageQuery->max('quantity'),
};
$amount = ($tier->per_unit / 1000) * $usage;
$formattedUsage = match ($feature->key) {
'bandwidth' => Metric::megabytes($usage)->format(),
'storage' => Metric::megabytes($usage)->format(),
};
// return sum of money
return [
'feature' => $feature->key,
'amount' => $amount,
'cost' => format_currency($amount, $this->subscription->plan->currency),
'usage' => $formattedUsage,
];
});
// Format usages
$estimates = resolve(FormatUsageEstimatesAction::class)($currency, $usage);
return [
'costEstimate' => format_currency($estimates->sum('amount'), $this->subscription->plan->currency),
'costEstimate' => format_currency($estimates->sum('amount'), $currency),
'featureEstimates' => $estimates->toArray(),
];
}

View File

@@ -1,10 +1,14 @@
<?php
namespace Tests\App\Users;
use App\Users\Actions\FormatUsageEstimatesAction;
use Tests\TestCase;
use App\Users\Models\User;
use VueFileManager\Subscription\Domain\Plans\Models\Plan;
use VueFileManager\Subscription\Domain\Plans\Models\PlanFeature;
use VueFileManager\Subscription\Domain\Plans\Models\PlanMeteredFeature;
use VueFileManager\Subscription\Domain\Subscriptions\Models\Subscription;
use VueFileManager\Subscription\Support\Events\SubscriptionWasCreated;
use VueFileManager\Subscription\Support\Events\SubscriptionWasExpired;
use VueFileManager\Subscription\Support\Events\SubscriptionWasUpdated;
@@ -18,17 +22,17 @@ class UserSubscriptionTest extends TestCase
{
$plan = Plan::factory()
->has(PlanFeature::factory()
->count(2)
->sequence(
[
'key' => 'max_storage_amount',
'value' => 200,
],
[
'key' => 'max_team_members',
'value' => 20,
],
), 'features')
->count(2)
->sequence(
[
'key' => 'max_storage_amount',
'value' => 200,
],
[
'key' => 'max_team_members',
'value' => 20,
],
), 'features')
->create();
$user = User::factory()
@@ -44,6 +48,7 @@ class UserSubscriptionTest extends TestCase
'max_team_members' => 20,
]);
}
/**
* @test
*/
@@ -51,17 +56,17 @@ class UserSubscriptionTest extends TestCase
{
$plan = Plan::factory()
->has(PlanFeature::factory()
->count(2)
->sequence(
[
'key' => 'max_storage_amount',
'value' => 200,
],
[
'key' => 'max_team_members',
'value' => 20,
],
), 'features')
->count(2)
->sequence(
[
'key' => 'max_storage_amount',
'value' => 200,
],
[
'key' => 'max_team_members',
'value' => 20,
],
), 'features')
->create();
$user = User::factory()
@@ -99,4 +104,42 @@ class UserSubscriptionTest extends TestCase
'max_team_members' => 5,
]);
}
/**
* @test
*/
public function it_format_price_estimates()
{
$usages = collect([
[
'feature' => 'bandwidth',
"amount" => 7546.96,
"usage" => 26024,
], [
"feature" => "storage",
"amount" => 476.28,
"usage" => 3969,
]
]);
// Format usage estimates
$estimates = resolve(FormatUsageEstimatesAction::class)('USD', $usages)
->toArray();
$expected = [
[
"feature" => "bandwidth",
"amount" => 7.54696,
"cost" => "$7.55",
"usage" => "26.02GB",
], [
"feature" => "storage",
"amount" => 0.47628,
"cost" => "$0.48",
"usage" => "3.97GB",
]
];
$this->assertEquals($expected, $estimates);
}
}