Cutlery/invoiceninja
1
0
Fork 0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2025-05-24 02:14:21 -04:00
Code Issues Packages Projects Releases Wiki Activity

Fixes for notifications

Browse Source
This commit is contained in:
David Bomba 2023-01-19 17:20:31 +11:00
parent 2aea9eade3
commit 24aa73c359
5 changed files with 230 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
app/Http/Controllers/ClientPortal/RecurringInvoiceController.php
View File

@ -51,6 +51,7 @@ class RecurringInvoiceController extends Controller
*
* @param ShowRecurringInvoiceRequest $request
* @param RecurringInvoice $recurring_invoice
*
* @return Factory|View
*/
public function show(ShowRecurringInvoiceRequest $request, RecurringInvoice $recurring_invoice)
@ -60,20 +61,24 @@ class RecurringInvoiceController extends Controller
]);
}
/**
* Handle the request cancellation notification
*
* @param RequestCancellationRequest $request [description]
* @param RecurringInvoice $recurring_invoice [description]
*
* @return \Illuminate\Routing\Redirector|\Illuminate\Http\RedirectResponse
*/
public function requestCancellation(RequestCancellationRequest $request, RecurringInvoice $recurring_invoice)
{
nlog('outside cancellation');
if ($recurring_invoice->subscription?->allow_cancellation) {
nlog('inside the cancellation');
$nmo = new NinjaMailerObject;
$nmo->mailable = (new NinjaMailer((new ClientContactRequestCancellationObject($recurring_invoice, auth()->user()))->build()));
$nmo->mailable = (new NinjaMailer((new ClientContactRequestCancellationObject($recurring_invoice, auth()->user(), false))->build()));
$nmo->company = $recurring_invoice->company;
$nmo->settings = $recurring_invoice->company->settings;
// $notifiable_users = $this->filterUsersByPermissions($recurring_invoice->company->company_users, $recurring_invoice, ['recurring_cancellation']);
$recurring_invoice->company->company_users->each(function ($company_user) use ($nmo) {
$methods = $this->findCompanyUserNotificationType($company_user, ['recurring_cancellation', 'all_notifications']);
@ -86,15 +91,6 @@ class RecurringInvoiceController extends Controller
}
});
// $notifiable_users->each(function ($company_user) use($nmo){
// $nmo->to_user = $company_user->user;
// NinjaMailerJob::dispatch($nmo);
// });
//$recurring_invoice->user->notify(new ClientContactRequestCancellation($recurring_invoice, auth()->user()));
return $this->render('recurring_invoices.cancellation.index', [
'invoice' => $recurring_invoice,
]);

19
app/Jobs/Inventory/AdjustProductInventory.php
View File

@ -19,6 +19,7 @@ use App\Mail\Admin\InventoryNotificationObject;
use App\Models\Company;
use App\Models\Invoice;
use App\Models\Product;
use App\Utils\Traits\Notifications\UserNotifies;
use App\Utils\Traits\NumberFormatter;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
@ -29,7 +30,7 @@ use Illuminate\Queue\SerializesModels;
class AdjustProductInventory implements ShouldQueue
{
use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
use Dispatchable, InteractsWithQueue, Queueable, SerializesModels, UserNotifies;
public Company $company;
@ -146,8 +147,22 @@ class AdjustProductInventory implements ShouldQueue
$nmo->mailable = new NinjaMailer((new InventoryNotificationObject($product, $notification_level))->build());
$nmo->company = $this->company;
$nmo->settings = $this->company->settings;
// $product->company_users->each(function ($cu) use($product, $nmo){
// if($this->checkNotificationExists($cu, $product, ['inventory_all', 'inventory_user']))
// {
// $nmo->to_user = $cu->user;
// (new NinjaMailerJob($nmo))->handle();
// }
// });
$nmo->to_user = $this->company->owner();
NinjaMailerJob::dispatch($nmo);
(new NinjaMailerJob($nmo))->handle();
}
}

2
app/Services/Invoice/InvoiceService.php
View File

@ -526,7 +526,7 @@ class InvoiceService
$this->invoice->exchange_rate = $this->invoice->client->currency()->exchange_rate;
}
if ($settings->auto_bill_standard_invoices) {
if ($this->invoice->client->getSetting('auto_bill_standard_invoices')) {
$this->invoice->auto_bill_enabled = true;
}

34
app/Utils/Traits/Notifications/UserNotifies.php
View File

@ -15,6 +15,7 @@ use App\Models\Client;
use App\Models\Credit;
use App\Models\Invoice;
use App\Models\Payment;
use App\Models\Product;
use App\Models\PurchaseOrder;
use App\Models\Quote;
@ -41,7 +42,7 @@ trait UserNotifies
}
//if a user owns this record or is assigned to it, they are attached the permission for notification.
if ($invitation->{$entity_name}->user_id == $company_user->_user_id || $invitation->{$entity_name}->assigned_user_id == $company_user->user_id) {
if ($invitation->{$entity_name}->user_id == $company_user->user_id || $invitation->{$entity_name}->assigned_user_id == $company_user->user_id) {
$required_permissions = $this->addSpecialUserPermissionForEntity($invitation->{$entity_name}, $required_permissions);
} else {
$required_permissions = $this->removeSpecialUserPermissionForEntity($invitation->{$entity_name}, $required_permissions);
@ -67,7 +68,7 @@ trait UserNotifies
return [];
}
if ($entity->user_id == $company_user->_user_id || $entity->assigned_user_id == $company_user->user_id) {
if ($entity->user_id == $company_user->user_id || $entity->assigned_user_id == $company_user->user_id) {
$required_permissions = $this->addSpecialUserPermissionForEntity($entity, $required_permissions);
} else {
$required_permissions = $this->removeSpecialUserPermissionForEntity($entity, $required_permissions);
@ -87,22 +88,18 @@ trait UserNotifies
switch ($entity) {
case $entity instanceof Payment || $entity instanceof Client: //we pass client also as this is the proxy for Payment Failures (ie, there is no payment)
return array_merge($required_permissions, ['all_notifications', 'all_user_notifications', 'payment_failure_user', 'payment_success_user']);
break;
case $entity instanceof Invoice:
return array_merge($required_permissions, ['all_notifications', 'all_user_notifications', 'invoice_created_user', 'invoice_sent_user', 'invoice_viewed_user', 'invoice_late_user']);
break;
case $entity instanceof Quote:
return array_merge($required_permissions, ['all_notifications', 'all_user_notifications', 'quote_created_user', 'quote_sent_user', 'quote_viewed_user', 'quote_approved_user', 'quote_expired_user']);
break;
case $entity instanceof Credit:
return array_merge($required_permissions, ['all_notifications', 'all_user_notifications', 'credit_created_user', 'credit_sent_user', 'credit_viewed_user']);
break;
case $entity instanceof PurchaseOrder:
return array_merge($required_permissions, ['all_notifications', 'all_user_notifications', 'purchase_order_created_user', 'purchase_order_sent_user', 'purchase_order_viewed_user']);
break;
case $entity instanceof Product:
return array_merge($required_permissions, ['all_notifications', 'all_user_notifications', 'inventory_user', 'inventory_all']);
default:
return [];
break;
}
}
@ -113,19 +110,16 @@ trait UserNotifies
switch ($entity) {
case $entity instanceof Payment || $entity instanceof Client: //we pass client also as this is the proxy for Payment Failures (ie, there is no payment)
return array_diff($required_permissions, ['all_user_notifications', 'payment_failure_user', 'payment_success_user']);
break;
case $entity instanceof Invoice:
return array_diff($required_permissions, ['all_user_notifications', 'invoice_created_user', 'invoice_sent_user', 'invoice_viewed_user', 'invoice_late_user']);
break;
case $entity instanceof Quote:
return array_diff($required_permissions, ['all_user_notifications', 'quote_created_user', 'quote_sent_user', 'quote_viewed_user', 'quote_approved_user', 'quote_expired_user']);
break;
case $entity instanceof Credit:
return array_diff($required_permissions, ['all_user_notifications', 'credit_created_user', 'credit_sent_user', 'credit_viewed_user']);
break;
case $entity instanceof PurchaseOrder:
return array_diff($required_permissions, ['all_user_notifications', 'purchase_order_created_user', 'purchase_order_sent_user', 'purchase_order_viewed_user']);
break;
case $entity instanceof Product:
return array_diff($required_permissions, ['all_user_notifications', 'inventory_user']);
default:
// code...
break;
@ -165,13 +159,23 @@ trait UserNotifies
});
}
private function checkNotificationExists($company_user, $entity, $required_notification)
/**
* Underrated method right here, last ones
* are always the best
*
* @param CompanyUser $company_user
* @param Invoice | Quote | Credit | PurchaseOrder | Product $entity
* @param array $required_notification
*
* @return bool
*/
private function checkNotificationExists($company_user, $entity, $required_notification): bool
{
/* Always make sure we push the `all_notificaitons` into the mix */
array_push($required_notification, 'all_notifications');
/* Selectively add the all_user if the user is associated with the entity */
if ($entity->user_id == $company_user->_user_id || $entity->assigned_user_id == $company_user->user_id) {
if ($entity->user_id == $company_user->user_id || $entity->assigned_user_id == $company_user->user_id) {
array_push($required_notification, 'all_user_notifications');
}

183
tests/Feature/Notify/NotificationTest.php Normal file
View File

@ -0,0 +1,183 @@
<?php
/**
* Invoice Ninja (https://invoiceninja.com).
*
* @link https://github.com/invoiceninja/invoiceninja source repository
*
* @copyright Copyright (c) 2021. Invoice Ninja LLC (https://invoiceninja.com)
*
* @license https://www.elastic.co/licensing/elastic-license
*/
namespace Tests\Feature\Notify;
use App\DataMapper\CompanySettings;
use App\Models\CompanyToken;
use App\Models\CompanyUser;
use App\Models\Product;
use App\Models\User;
use App\Utils\Traits\Notifications\UserNotifies;
use Illuminate\Support\Str;
use Tests\MockAccountData;
use Tests\TestCase;
/**
* @test
* @covers App\Utils\Traits\Notifications\UserNotifies
*/
class NotificationTest extends TestCase
{
use UserNotifies;
use MockAccountData;
protected function setUp() :void
{
parent::setUp();
$this->withoutMiddleware(
ThrottleRequests::class
);
$this->makeTestData();
}
public function testNotificationFound()
{
$notifications = new \stdClass;
$notifications->email = ["inventory_all"];
$this->user->company_users()->where('company_id', $this->company->id)->update(['notifications' => (array)$notifications]);
$this->assertTrue(property_exists($this->cu->notifications,'email'));
$p = Product::factory()->create([
'user_id' => $this->user->id,
'company_id' => $this->company->id
]);
$notification_users = $this->filterUsersByPermissions($this->company->company_users, $p, ['inventory_all']);
$this->assertCount(1, $notification_users->toArray());
$notification_users = $this->filterUsersByPermissions($this->company->company_users, $p, ['inventory_user']);
$this->assertCount(0, $notification_users->toArray());
$notification_users = $this->filterUsersByPermissions($this->company->company_users, $p, ['inventory_user','invalid notification']);
$this->assertCount(0, $notification_users->toArray());
}
public function testAllNotificationsFires()
{
$notifications = new \stdClass;
$notifications->email = ["all_notifications"];
$p = Product::factory()->create([
'user_id' => $this->user->id,
'company_id' => $this->company->id
]);
$this->user->company_users()->where('company_id', $this->company->id)->update(['notifications' => (array)$notifications]);
$notification_users = $this->filterUsersByPermissions($this->company->company_users, $p, ['inventory_all']);
$this->assertCount(1, $notification_users->toArray());
}
public function testAllNotificationsFiresForUser()
{
$notifications = new \stdClass;
$notifications->email = ["all_user_notifications"];
$p = Product::factory()->create([
'user_id' => $this->user->id,
'company_id' => $this->company->id
]);
$this->user->company_users()->where('company_id', $this->company->id)->update(['notifications' => (array)$notifications]);
$notification_users = $this->filterUsersByPermissions($this->company->company_users, $p, ['all_user_notifications']);
$this->assertCount(1, $notification_users->toArray());
}
public function testAllNotificationsDoesNotFiresForUser()
{
$u = User::factory()->create([
'account_id' => $this->account->id,
'email' => $this->faker->safeEmail(),
'confirmation_code' => uniqid("st",true),
]);
$company_token = new CompanyToken;
$company_token->user_id = $u->id;
$company_token->company_id = $this->company->id;
$company_token->account_id = $this->account->id;
$company_token->name = 'test token';
$company_token->token = Str::random(64);
$company_token->is_system = true;
$company_token->save();
$u->companies()->attach($this->company->id, [
'account_id' => $this->account->id,
'is_owner' => 1,
'is_admin' => 1,
'is_locked' => 0,
'notifications' => CompanySettings::notificationDefaults(),
'settings' => null,
]);
$p = Product::factory()->create([
'user_id' => $u->id,
'company_id' => $this->company->id
]);
$notifications = new \stdClass;
$notifications->email = ["all_user_notifications"];
$this->user->company_users()->where('company_id', $this->company->id)->update(['notifications' => (array)$notifications]);
$methods = $this->findUserEntityNotificationType($p, $this->cu, ['all_user_notifications']);
$this->assertCount(0, $methods);
$methods = $this->findUserEntityNotificationType($p, $this->cu, ['all_notifications']);
$this->assertCount(0, $methods);
$notifications = [];
$notifications['email'] = ["all_notifications"];
$cu = CompanyUser::where('company_id', $this->company->id)->where('user_id', $this->user->id)->first();
$cu->notifications = $notifications;
$cu->save();
$methods = $this->findUserEntityNotificationType($p, $cu, ["all_notifications"]);
$this->assertCount(1, $methods);
$notifications = [];
$notifications['email'] = ["inventory_user"];
$cu = CompanyUser::where('company_id', $this->company->id)->where('user_id', $this->user->id)->first();
$cu->notifications = $notifications;
$cu->save();
$methods = $this->findUserEntityNotificationType($p, $cu, ["all_notifications"]);
$this->assertCount(0, $methods);
$p = Product::factory()->create([
'user_id' => $this->user->id,
'company_id' => $this->company->id
]);
$methods = $this->findUserEntityNotificationType($p, $cu, []);
nlog($methods);
$this->assertCount(1, $methods);
}
}