cief/exchange-2.0
1
0
Fork 0
mirror of https://gitlab.com/CIEFWorldwideSdnBhd/exchange-2.0.git synced 2026-08-19 04:23:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Code sync from Shipping Portal, independent deployment of Vue Polling, checkout from dillon/34-jenkins-vapor

Browse Source
This commit is contained in:
Dillon Ngo
2023-12-30 01:15:27 +08:00
parent 1ddf7923a5
commit 18df0e256b
37 changed files with 1281 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files
app/Classes/Exceptions/JobResourceNotFoundException.php
+11
View File
@@ -0,0 +1,11 @@
<?php
namespace App\Classes\Exceptions;
use App\Classes\ValueObjects\Constants\HttpStatus;
final class JobResourceNotFoundException extends ServiceApiException {
public function __construct(?string $message = null) {
parent::__construct($message ?? 'Unable to find the requested resource', HttpStatus::RESOURCE_NOT_FOUND);
}
}
app/Classes/General/Abstracts/AbstractControllerLogic.php
+14 -1
View File
@@ -17,6 +17,7 @@ use Illuminate\Http\Resources\Json\ResourceCollection;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Log;
use App\Classes\Exceptions\JobResourceNotFoundException;
abstract class AbstractControllerLogic
{
@@ -67,7 +68,19 @@ abstract class AbstractControllerLogic
return $response;
} catch (ErrorException|GeneralExceptions $exception){
log::error($exception);
if ($exception instanceof JobResourceNotFoundException) {
Log::error(sprintf(
"Uncaught exception '%s' with message '%s' in %s:%d",
get_class($exception),
$exception->getMessage(),
$exception->getTrace()[0]['file'],
$exception->getTrace()[0]['line']
));
}
else{
log::error($exception);
}
return (new ApiResponseObject($this->getNotificationTitle().' failed', $exception->getMessage(),
$exception->getCode() ? $exception->getCode() : HttpStatus::SERVER_ERROR))->handler();
app/Classes/General/Eloquent/AbstractFetchRecord.php
+11 -3
View File
@@ -4,9 +4,11 @@ namespace App\Classes\General\Eloquent;
use App\Classes\Exceptions\ResourceNotFoundException;
use App\Classes\Exceptions\JobResourceNotFoundException;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Psy\Exception\ErrorException;
use Illuminate\Support\Facades\Log;
abstract class AbstractFetchRecord extends AbstractGetRecord
{
@@ -27,12 +29,18 @@ abstract class AbstractFetchRecord extends AbstractGetRecord
* @return Model
* @throws ResourceNotFoundException
*/
public function getResults(Builder $query): Model {
public function getResults(Builder $query, array $param = []): Model {
if(!$query->exists()){
throw new ResourceNotFoundException('Unable to find any record based on the criteria provided');
$table = $query->getModel()->getTable();
if($table ==='job_results'){
throw new JobResourceNotFoundException('Unable to find any job based on the criteria provided');
}
else{
throw new ResourceNotFoundException('Unable to find any record based on the criteria provided');
}
}
return $query->first();
}
}
}
app/Classes/General/Eloquent/AbstractGetRecord.php
+20 -6
View File
@@ -30,11 +30,25 @@ abstract class AbstractGetRecord
return $this->filters->only(self::DECORATION_FILTERS);
}
// /**
// * @param null|string $json
// * @return array
// */
// public function deserializeFilters(?string $json): array {
// return $json !== null ? collect(json_decode($json))->toArray() : [];
// }
/**
* @param null|string $json
* @param null|string $param
* @return array
*/
public function deserializeFilters(?string $json): array {
public function deserializeFilters($param): array {
if(gettype($param) == "array"){
$json = implode(',', $param);
}
else{
$json = $param;
}
return $json !== null ? collect(json_decode($json))->toArray() : [];
}
@@ -50,9 +64,9 @@ abstract class AbstractGetRecord
* @param array $filters
* @return mixed
*/
public function handler(array $filters){
public function handler(array $filters, array $params = []){
$this->filters = collect($filters);
return $this->getResults($this->applyFiltersToQuery());
return $this->getResults($this->applyFiltersToQuery(), $params);
}
@@ -65,6 +79,6 @@ abstract class AbstractGetRecord
* @param Builder $query
* @return mixed
*/
abstract function getResults(Builder $query);
abstract function getResults(Builder $query, array $params = []);
}
}
app/Classes/General/Eloquent/AbstractListRecord.php
+10 -4
View File
@@ -17,11 +17,11 @@ abstract class AbstractListRecord extends AbstractGetRecord
* @return mixed
* @throws MalformedRequestException
*/
public function execute(array $filters = []){
public function execute(array $filters = [], array $param = []){
try{
return $this->handler($filters);
return $this->handler($filters, $param);
} catch (QueryException $exception){
log::error($exception);
@@ -30,18 +30,24 @@ abstract class AbstractListRecord extends AbstractGetRecord
}
/**
* @param Builder $query
* @return mixed
*/
public function getResults(Builder $query) {
public function getResults(Builder $query, array $param = []) {
$filters = $this->getDecorationFilters();
if($filters->has('order_by')){
$query = $query->orderBy($filters->get('order_by')->column, $filters->get('order_by')->DESC ? 'DESC': 'ASC');
}
return $filters->has('per_page') ? $query->paginate($filters->get('per_page')) : $query->get();
if(!empty($param)){
return $filters->has('per_page') ? $query->paginate($filters->get('per_page'), ['*'], 'page', $param['page']) : $query->get(); //page data from query parameters e.g ?page=1
}
else{
return $filters->has('per_page') ? $query->paginate($filters->get('per_page')) : $query->get();
}
}
app/Classes/General/Eloquent/Filters/JobId.php
+20
View File
@@ -0,0 +1,20 @@
<?php
namespace App\Classes\General\Eloquent\Filters;
use Illuminate\Database\Eloquent\Builder;
class JobId implements Filter
{
/**
* @param Builder $builder
* @param $value
* @return Builder|mixed
*/
public static function apply(Builder $builder, $value)
{
return $builder->where('job_id', $value);
}
}
app/Classes/General/Helper.php
+24
View File
@@ -2,6 +2,7 @@
namespace App\Classes\General;
use Illuminate\Http\Resources\Json\ResourceCollection;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Str;
@@ -42,4 +43,27 @@ class Helper
}
}
}
/**
* @param null|string $param
* @return array
*/
static function deserializeFilters($param): array {
if(gettype($param) == "array"){
$json = implode(',', $param);
}
else{
$json = $param;
}
return $json !== null ? collect(json_decode($json))->toArray() : [];
}
/**
* @param ResourceCollection $collection
* @return array
*/
static function collectionResponse(ResourceCollection $collection){
return json_decode($collection->response()->getContent(), true);
}
}
app/Classes/Jobs/ListBookingsJob.php
+50
View File
@@ -0,0 +1,50 @@
<?php
namespace App\Classes\Jobs;
use App\Classes\Modules\Bookings\Processors\ListBookingsJobProcessor;
use App\Classes\Modules\Jobs\DataTransferObjects\ListGenericJobObject;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;
use App\Models\JobResult;
use Illuminate\Support\Facades\Log;
class ListBookingsJob implements ShouldQueue
{
use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
/** @var ListGenericJobObject */
private $listGenericJobObject;
private $jobId;
/**
* ListBookingsJob constructor.
* @param ListGenericJobObject $listGenericJobObject
*/
public function __construct(ListGenericJobObject $listGenericJobObject)
{
$this->listGenericJobObject = $listGenericJobObject;
}
public function handle()
{
$rawPayload = $this->job->payload();
if(isset($rawPayload['data']['commandName'])){
$this->listGenericJobObject->setJobCommandName($rawPayload['data']['commandName']);
}
if(isset($rawPayload['data']['command'])){
$this->listGenericJobObject->setJobCommand($rawPayload['data']['command']);
}
$result = (App()->make(ListBookingsJobProcessor::class))->execute($this->listGenericJobObject);
}
public function getJobId(){
return $this->job->getJobId();
}
}
app/Classes/Jobs/ListDocumentsJob.php
+61
View File
@@ -0,0 +1,61 @@
<?php
namespace App\Classes\Jobs;
use App\Classes\Modules\Documents\Processors\ListDocumentsJobProcessor;
use App\Classes\Modules\Jobs\DataTransferObjects\ListGenericJobObject;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;
use App\Models\JobResult;
use Illuminate\Support\Facades\Log;
class ListDocumentsJob implements ShouldQueue
{
use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
/** @var ListGenericJobObject */
private $listGenericJobObject;
private $jobId;
/**
* ListDocumentsJob constructor.
* @param ListGenericJobObject $listGenericJobObject
*/
public function __construct(ListGenericJobObject $listGenericJobObject)
{
$this->listGenericJobObject = $listGenericJobObject;
}
public function handle()
{
$rawPayload = $this->job->payload();
if(isset($rawPayload['data']['commandName'])){
$this->listGenericJobObject->setJobCommandName($rawPayload['data']['commandName']);
}
if(isset($rawPayload['data']['command'])){
$this->listGenericJobObject->setJobCommand($rawPayload['data']['command']);
}
$result = (App()->make(ListDocumentsJobProcessor::class))->execute($this->listGenericJobObject);
//cief todo: Insert into DB: job id, query result, timestamp
// Store the result in the job_results table
//cief todo: why cannot save data in table like this
// $model = new JobResult();
// $model->job_id = $this->job->getJobId();
// $model->result = json_encode($result);
// $model->save();
// Log::error(json_encode($model->id));
}
public function getJobId(){
return $this->job->getJobId();
}
}
app/Classes/Jobs/ListTransactionsJob.php
+50
View File
@@ -0,0 +1,50 @@
<?php
namespace App\Classes\Jobs;
use App\Classes\Modules\Transactions\Processors\ListTransactionsJobProcessor;
use App\Classes\Modules\Jobs\DataTransferObjects\ListGenericJobObject;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;
use App\Models\JobResult;
use Illuminate\Support\Facades\Log;
class ListTransactionsJob implements ShouldQueue
{
use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
/** @var ListGenericJobObject */
private $listGenericJobObject;
private $jobId;
/**
* ListTransactionsJob constructor.
* @param ListGenericJobObject $listGenericJobObject
*/
public function __construct(ListGenericJobObject $listGenericJobObject)
{
$this->listGenericJobObject = $listGenericJobObject;
}
public function handle()
{
$rawPayload = $this->job->payload();
if(isset($rawPayload['data']['commandName'])){
$this->listGenericJobObject->setJobCommandName($rawPayload['data']['commandName']);
}
if(isset($rawPayload['data']['command'])){
$this->listGenericJobObject->setJobCommand($rawPayload['data']['command']);
}
$result = (App()->make(ListTransactionsJobProcessor::class))->execute($this->listGenericJobObject);
}
public function getJobId(){
return $this->job->getJobId();
}
}
app/Classes/Modules/Bookings/ControllersLogic/ListBookingJobLogic.php
+56
View File
@@ -0,0 +1,56 @@
<?php
namespace App\Classes\Modules\Bookings\ControllersLogic;
use App\Classes\General\Abstracts\AbstractControllerLogic;
use App\Classes\Jobs\ListBookingsJob;
use App\Classes\Modules\Bookings\Standards\Rules\CanListBookings;
use App\Classes\Modules\Jobs\DataTransferObjects\ListGenericJobObject;
use ErrorException;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
class ListBookingJobLogic extends AbstractControllerLogic
{
/**
* @return array
*/
protected function notification():array {
return [
'title' => 'List Booking Job',
'message' => 'You have successfully submit a job to list bookings'
];
}
/**
* @param Request $request
* @return JsonResponse
*/
public function logic(Request $request) : JsonResponse
{
$jobId = uniqid();
$user = Auth::user();
$userInfo = (object) [
'email' => $user->email,
'type' => $user->type,
];
$listGenericJobObject = new ListGenericJobObject(
$request->fullUrl(),
$request->all(),
$jobId,
$userInfo
);
ListBookingsJob::dispatch($listGenericJobObject);
$result = [];
$result['job_id'] = $jobId;
return $this->response(['data' => $result]);
}
}
app/Classes/Modules/Bookings/Processors/ListBookingsJobProcessor.php
+57
View File
@@ -0,0 +1,57 @@
<?php
namespace App\Classes\Modules\Bookings\Processors;
use App\Classes\Modules\Bookings\Services\ListsBookings;
use App\Classes\Modules\Jobs\Services\CreatesJobResult;
use App\Classes\Exceptions\MalformedRequestException;
use App\Classes\General\Helper;
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Facades\Log;
use App\Classes\Modules\Jobs\DataTransferObjects\ListGenericJobObject;
use Illuminate\Http\Resources\Json\ResourceCollection;
use App\Http\Resources\BookingResource;
class ListBookingsJobProcessor
{
/** @var ListsBookings */
private $listsBookings;
/** @var CreatesJobResult */
private $createsJobResult;
/**
* ListBookingsJobProcessor constructor.
* @param ListsBookings $listsBookings
* @param CreatesJobResult $createsJobResult
*/
public function __construct(ListsBookings $listsBookings, CreatesJobResult $createsJobResult)
{
$this->listsBookings = $listsBookings;
$this->createsJobResult = $createsJobResult;
}
/**
* @param ListGenericJobObject $listGenericJobObject
* @return null|object
* @throws \App\Classes\Exceptions\MalformedRequestException
*/
public function execute(ListGenericJobObject $listGenericJobObject) {
$query = $this->listsBookings->execute($this->listsBookings->deserializeFilters($listGenericJobObject->getPayload()['filters']), ['page' => $listGenericJobObject->getPayload()['page']]);
foreach ($query->items() as &$item) {
$item['userInfo'] = $listGenericJobObject->getUserInfo();
}
//cief todo: remove comments
$result = Helper::collectionResponse(BookingResource::collection($query));
// $result = new JobBookingCollectionResponse($query, $listGenericJobObject->getuserInfo());
// $result = $this->collectionResponse(new BookingResourceCollection(BookingResource::collection($query), $listGenericJobObject->getuserInfo()));
$create = $this->createsJobResult->execute($listGenericJobObject, json_encode($result));
return $create;
}
}
app/Classes/Modules/Documents/ControllersLogic/ListDocumentJobLogic.php
+74
View File
@@ -0,0 +1,74 @@
<?php
namespace App\Classes\Modules\Documents\ControllersLogic;
use App\Classes\General\Abstracts\AbstractControllerLogic;
use App\Classes\Modules\Documents\Services\ListsDocuments;
use App\Classes\Modules\Jobs\DataTransferObjects\ListGenericJobObject;
use App\Classes\Jobs\ListDocumentsJob;
use App\Http\Resources\DocumentResource;
use ErrorException;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
use App\Classes\General\Helper;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Auth;
class ListDocumentJobLogic extends AbstractControllerLogic
{
/**
* @return array
*/
protected function notification():array {
return [
'title' => 'List Document Job',
'message' => 'You have successfully submit a job to list documents'
];
}
/**
* @param Request $request
* @return JsonResponse
*/
public function logic(Request $request) : JsonResponse
{
$jobId = uniqid();
$user = Auth::user();
$userInfo = (object) [
'email' => $user->email,
'type' => $user->type,
];
$listGenericJobObject = new ListGenericJobObject(
$request->fullUrl(),
$request->all(),
$jobId,
$userInfo
);
ListDocumentsJob::dispatch($listGenericJobObject);
//cief todo: remove comments
// // Create your job instance with delay, so we can back here within delay and take control in our hands.
// $job = new ListDocuments($listGenericJobObject);
// $job->delay(now()->addSeconds(5));
// // Dispath your job with our custom_dispatch helper. This will return job id from jobs table
// // $jobId = $this->custom_dispatch($job);
$result = [];
$result['job_id'] = $jobId;
return $this->response(['data' => $result]);
}
//cief todo: no longer need jobId
// function custom_dispatch($job): int {
// return app(\Illuminate\Contracts\Bus\Dispatcher::class)->dispatch($job);
// }
}
app/Classes/Modules/Documents/Processors/ListDocumentsJobProcessor.php
+54
View File
@@ -0,0 +1,54 @@
<?php
namespace App\Classes\Modules\Documents\Processors;
use App\Classes\Modules\Documents\Services\ListsDocuments;
use App\Classes\Modules\Jobs\Services\CreatesJobResult;
use App\Classes\Exceptions\MalformedRequestException;
use App\Classes\General\Helper;
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Facades\Log;
use App\Classes\Modules\Jobs\DataTransferObjects\ListGenericJobObject;
use App\Http\Controllers\Documents\ListDocumentsController;
use Illuminate\Http\Resources\Json\ResourceCollection;
use App\Http\Resources\DocumentResource;
class ListDocumentsJobProcessor
{
/** @var ListsDocuments */
private $listsDocuments;
/** @var CreatesJobResult */
private $createsJobResult;
/**
* ListDocumentsJobProcessor constructor.
* @param ListsDocuments $listsDocuments
* @param CreatesJobResult $createsJobResult
*/
public function __construct(ListsDocuments $listsDocuments, CreatesJobResult $createsJobResult)
{
$this->listsDocuments = $listsDocuments;
$this->createsJobResult = $createsJobResult;
}
/**
* @param ListGenericJobObject $listGenericJobObject
* @return null|object
* @throws \App\Classes\Exceptions\MalformedRequestException
*/
public function execute(ListGenericJobObject $listGenericJobObject) {
$query = $this->listsDocuments->execute($this->listsDocuments->deserializeFilters($listGenericJobObject->getPayload()['filters']), ['page' => $listGenericJobObject->getPayload()['page']]);
foreach ($query->items() as &$item) {
$item['userInfo'] = $listGenericJobObject->getUserInfo();
}
$result = Helper::collectionResponse(DocumentResource::collection($query));
$create = $this->createsJobResult->execute($listGenericJobObject, json_encode($result));
return $create;
}
}
app/Classes/Modules/Jobs/ControllersLogic/FetchJobResultLogic.php
+54
View File
@@ -0,0 +1,54 @@
<?php
namespace App\Classes\Modules\Jobs\ControllersLogic;
use App\Classes\General\Abstracts\AbstractControllerLogic;
use App\Classes\Modules\Jobs\Services\FetchesJobResult;
use App\Http\Resources\JobResultResource;
use ErrorException;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
class FetchJobResultLogic extends AbstractControllerLogic
{
/**
* @return array
*/
protected function notification():array {
return [
'title' => 'Retrieved Data',
'message' => 'You have successfully retrieved data'
];
}
/** @var FetchesJobResult */
private $fetchesJobResult;
/**
* FetchJobResultLogic constructor.
* @param FetchesJobResult $fetchesJobResult
*/
public function __construct(FetchesJobResult $fetchesJobResult)
{
$this->fetchesJobResult = $fetchesJobResult;
}
/**
* @param Request $request
* @return JsonResponse
* @throws \App\Classes\Exceptions\AccessForbiddenException
* @throws \App\Classes\Exceptions\MalformedRequestException
* @throws \App\Classes\Exceptions\RequestValidationException
*/
public function logic(Request $request) : JsonResponse
{
$query = $this->fetchesJobResult->execute(['job_id' => $request->route('job_id')]);
return $this->resourceResponse(new JobResultResource($query));
}
}
app/Classes/Modules/Jobs/DataTransferObjects/ListGenericJobObject.php
+99
View File
@@ -0,0 +1,99 @@
<?php
namespace App\Classes\Modules\Jobs\DataTransferObjects;
use Illuminate\Http\Request;
use App\Classes\General\Interfaces\DataTransferObject;
class ListGenericJobObject implements DataTransferObject
{
/** @var string */
private $name;
/** @var array */
private $payload;
/** @var string */
private $jobId;
/** @var object */
private $userInfo;
/** @var string */
private $jobCommandName;
/** @var string */
private $jobCommand;
public function __construct(string $name, array $payload, string $jobId, object $userInfo = null)
{
$this->name = $name;
$this->payload = $payload;
$this->jobId = $jobId;
$this->userInfo = $userInfo;
}
/**
* @return string
*/
public function getName(): string
{
return $this->name;
}
/**
* @return array
*/
public function getPayload(): array
{
return $this->payload;
}
/**
* @return string
*/
public function getJobId(): string
{
return $this->jobId;
}
/**
* @return object
*/
public function getUserInfo(): object
{
return $this->userInfo;
}
/**
* @return string
*/
public function getJobCommandName(): string
{
return $this->jobCommandName;
}
/**
* @return string
*/
public function getJobCommand(): string
{
return $this->jobCommand;
}
// public function setJobId(int $jobId)
// {
// $this->jobId = $jobId;
// }
public function setJobCommandName(string $jobCommandName)
{
$this->jobCommandName = $jobCommandName;
}
public function setJobCommand(string $jobCommand)
{
$this->jobCommand = $jobCommand;
}
}
app/Classes/Modules/Jobs/Services/CreatesJobResult.php
+28
View File
@@ -0,0 +1,28 @@
<?php
namespace App\Classes\Modules\Jobs\Services;
use App\Classes\General\Eloquent\AbstractUpdateRecord;
use App\Models\JobResult;
use App\Classes\Modules\Jobs\DataTransferObjects\ListGenericJobObject;
class CreatesJobResult extends AbstractUpdateRecord
{
/**
* @param ListGenericJobObject $listGenericJobObject
* @param string $result
* @return \Illuminate\Database\Eloquent\Model
* @throws \App\Classes\Exceptions\MalformedRequestException
*/
public function execute(ListGenericJobObject $listGenericJobObject, string $result)
{
$model = new JobResult();
$model->job_id = $listGenericJobObject->getJobId();
$model->result = $result;
$model->url = $listGenericJobObject->getName();
$model->job_command_name = $listGenericJobObject->getJobCommandName();
$model->job_command = $listGenericJobObject->getJobCommand();
return $this->handler($model);
}
}
app/Classes/Modules/Jobs/Services/FetchesJobResult.php
+33
View File
@@ -0,0 +1,33 @@
<?php
namespace App\Classes\Modules\Jobs\Services;
use App\Classes\General\Eloquent\AbstractFetchRecord;
use Illuminate\Database\Eloquent\Builder;
use App\Models\JobResult;
class FetchesJobResult extends AbstractFetchRecord
{
/** @var JobResult */
private $repository;
/**
* FetchesJobResult constructor.
* @param JobResult $repository
*/
public function __construct(JobResult $repository)
{
$this->repository = $repository;
}
/**
* @return Builder
*/
public function getRepository(): Builder
{
return $this->repository->newQuery();
}
}
app/Classes/Modules/Transactions/ControllersLogic/ListTransactionsJobLogic.php
+47
View File
@@ -0,0 +1,47 @@
<?php
namespace App\Classes\Modules\Transactions\ControllersLogic;
use App\Classes\General\Abstracts\AbstractControllerLogic;
use App\Classes\Jobs\ListTransactionsJob;
use App\Classes\Modules\Jobs\DataTransferObjects\ListGenericJobObject;
use ErrorException;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
class ListTransactionsJobLogic extends AbstractControllerLogic
{
/**
* @return array
*/
protected function notification():array {
return [
'title' => 'List Transaction Job',
'message' => 'You have successfully submit a job to list transactions'
];
}
/**
* @param Request $request
* @return JsonResponse
*/
public function logic(Request $request) : JsonResponse
{
$jobId = uniqid();
$listGenericJobObject = new ListGenericJobObject(
$request->fullUrl(),
$request->all(),
$jobId
);
ListTransactionsJob::dispatch($listGenericJobObject);
$result = [];
$result['job_id'] = $jobId;
return $this->response(['data' => $result]);
}
}
app/Classes/Modules/Transactions/Processors/ListTransactionsJobProcessor.php
+50
View File
@@ -0,0 +1,50 @@
<?php
namespace App\Classes\Modules\Transactions\Processors;
use App\Classes\Modules\Transactions\Services\ListsTransactions;
use App\Classes\Modules\Jobs\Services\CreatesJobResult;
use App\Classes\Exceptions\MalformedRequestException;
use App\Classes\General\Helper;
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Facades\Log;
use App\Classes\Modules\Jobs\DataTransferObjects\ListGenericJobObject;
use Illuminate\Http\Resources\Json\ResourceCollection;
use App\Http\Resources\TransactionResource;
class ListTransactionsJobProcessor
{
/** @var ListsTransactions */
private $listsTransactions;
/** @var CreatesJobResult */
private $createsJobResult;
/**
* ListTransactionsJobProcessor constructor.
* @param ListsTransactions $listsTransactions
* @param CreatesJobResult $createsJobResult
*/
public function __construct(ListsTransactions $listsTransactions, CreatesJobResult $createsJobResult)
{
$this->listsTransactions = $listsTransactions;
$this->createsJobResult = $createsJobResult;
}
/**
* @param ListGenericJobObject $listGenericJobObject
* @return null|object
* @throws \App\Classes\Exceptions\MalformedRequestException
*/
public function execute(ListGenericJobObject $listGenericJobObject) {
$query = $this->listsTransactions->execute($this->listsTransactions->deserializeFilters($listGenericJobObject->getPayload()['filters']), ['page' => $listGenericJobObject->getPayload()['page']]);
$result = Helper::collectionResponse(TransactionResource::collection($query));
$create = $this->createsJobResult->execute($listGenericJobObject, json_encode($result));
return $create;
}
}
app/Http/Controllers/Bookings/ListBookingsJobController.php
+22
View File
@@ -0,0 +1,22 @@
<?php
namespace App\Http\Controllers\Bookings;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
use App\Classes\Modules\Bookings\ControllersLogic\ListBookingJobLogic;
class ListBookingsJobController
{
/**
* @param Request $request
* @param ListBookingJobLogic $logic
* @return JsonResponse
*/
public function list(Request $request, ListBookingJobLogic $logic) : JsonResponse {
return $logic->execute($request);
}
}
app/Http/Controllers/Documents/ListDocumentsJobController.php
+19
View File
@@ -0,0 +1,19 @@
<?php
namespace App\Http\Controllers\Documents;
use App\Classes\Modules\Documents\ControllersLogic\ListDocumentJobLogic;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
class ListDocumentsJobController
{
/**
* @param Request $request
* @param ListDocumentJobLogic $logic
* @return JsonResponse
*/
public function list(Request $request, ListDocumentJobLogic $logic): JsonResponse {
return $logic->execute($request);
}
}
app/Http/Controllers/Jobs/FetchJobResultController.php
+19
View File
@@ -0,0 +1,19 @@
<?php
namespace App\Http\Controllers\Jobs;
use App\Classes\Modules\Jobs\ControllersLogic\FetchJobResultLogic;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
class FetchJobResultController
{
/**
* @param Request $request
* @param FetchJobResultLogic $logic
* @return JsonResponse
*/
public function fetch(Request $request, FetchJobResultLogic $logic): JsonResponse {
return $logic->execute($request);
}
}
app/Http/Controllers/Transactions/ListTransactionsJobController.php
+21
View File
@@ -0,0 +1,21 @@
<?php
namespace App\Http\Controllers\Transactions;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
use App\Classes\Modules\Transactions\ControllersLogic\ListTransactionsJobLogic;
class ListTransactionsJobController
{
/**
* @param Request $request
* @param ListTransactionsJobLogic $logic
* @return JsonResponse
*/
public function list(Request $request, ListTransactionsJobLogic $logic) : JsonResponse {
return $logic->execute($request);
}
}
app/Http/Resources/BookingResource.php
+9 -1
View File
@@ -11,10 +11,18 @@ use App\Classes\ValueObjects\Constants\TransactionType;
use App\Classes\ValueObjects\Constants\DocumentType;
use Carbon\Carbon;
use Illuminate\Http\Resources\Json\JsonResource;
use Illuminate\Http\Resources\Json\AnonymousResourceCollection;
use Illuminate\Support\Facades\Log;
class BookingResource extends JsonResource
{
private $userInfo;
public function __construct($resource, $userInfo = null)
{
parent::__construct($resource);
$this->userInfo = $userInfo ?? ($resource->userInfo ?? null);
}
/**
* Transform the resource into an array.
@@ -27,7 +35,7 @@ class BookingResource extends JsonResource
{
return [
'id' => $this->id,
'company' => new CompanyResource($this->company),
'company' => new CompanyResource($this->company, $this->userInfo),
'bank' => new BankResource($this->bank),
'service' => new ServiceTypeResource($this->service),
'marking' => $this->marking,
app/Http/Resources/CompanyResource.php
+30 -1
View File
@@ -19,6 +19,14 @@ use Illuminate\Support\Facades\Log;
class CompanyResource extends JsonResource
{
private $userInfo;
public function __construct($resource, $userInfo = null)
{
parent::__construct($resource);
$this->userInfo = $userInfo;
}
/**
* Transform the resource into an array.
*
@@ -33,6 +41,26 @@ class CompanyResource extends JsonResource
$segment = SegmentConstant::where('reference', SegmentConstants::SUPPLIER_CURRENCIES)->where('detail->id', $this->id)->first();
$serviceCharge = SegmentConstant::where('reference', SegmentConstants::SERVICE_CHARGE)->where('detail->id', $this->id)->first();
$userResource = null;
$userInfoEmail = $this->userInfo && isset($this->userInfo->email) ? $this->userInfo->email : null;
$userInfoType = $this->userInfo && isset($this->userInfo->type) ? $this->userInfo->type : null;
if(!$userInfoEmail && Auth::user()){
$userInfoEmail = Auth::user()->email;
}
if(!$userInfoType && Auth::user()){
$userInfoType = Auth::user()->type;
}
//cief todo: remove
// Log::error('CompanyResource 1: '. json_encode($userInfoEmail));
// Log::error('CompanyResource 2: '. json_encode($userInfoType));
if(!is_null($userInfoEmail) && !is_null($userInfoType)){
$userResource = new UserResource($userInfoType === RoleTypes::USER ? $this->employees()->where('email', '=', $userInfoEmail)->first() : $this->employees()->orderBy('id', 'DESC')->first());
}
return [
'id' => $this->id,
'name' => $this->name,
@@ -43,7 +71,8 @@ class CompanyResource extends JsonResource
'status' => (int) $this->status,
'contact' => new ContactResource ($this->when($this->has('contacts'), $this->contacts->first())),
'address' => new AddressResource($this->when($this->has('addresses'), $this->addresses->where('billing', true)->first())),
'employee' => new UserResource(Auth::user()->type === RoleTypes::USER ? $this->employees()->where('email', '=', Auth::user()->email)->first() : $this->employees()->orderBy('id', 'DESC')->first()),
//cief todo: this one need to decide what to do to replace Auth:user() when it is run by job queue
'employee' => $userResource,
'identification' => new DocumentResource($this->documents->whereIn('document_type', DocumentType::IDENTIFICATION_DOCUMENTS)->first()),
'bookings' => $this->whenLoaded('bookings', $this->bookings()->orderBy('id', 'DESC')->get(), []),
'confirmed_bookings' => $this->bookings()->whereHas('transactions', function ($query){
app/Http/Resources/DocumentResource.php
+4 -1
View File
@@ -8,6 +8,9 @@ use App\Models\Document;
use Carbon\Carbon;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Http\Resources\Json\JsonResource;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Auth;
use Illuminate\Http\Resources\Json\AnonymousResourceCollection;
class DocumentResource extends JsonResource
{
@@ -24,7 +27,7 @@ class DocumentResource extends JsonResource
'reference' => $this->reference,
'status' => (int) $this->status,
'document_type' => $this->document_type,
'owner' => $this->relationLoaded('owner') ? ($this->owner instanceof Booking ? new BookingResource($this->owner) : new CompanyResource($this->owner)) : null,
'owner' => $this->relationLoaded('owner') ? ($this->owner instanceof Booking ? new BookingResource($this->owner, $this->userInfo) : new CompanyResource($this->owner, $this->userInfo)) : null,
'files' => FileResource::collection($this->files),
'created_at' => Carbon::parse($this->created_at)->format('d-m-Y h:i:s A')
];
app/Http/Resources/JobResultResource.php
+22
View File
@@ -0,0 +1,22 @@
<?php
namespace App\Http\Resources;
use Illuminate\Http\Resources\Json\JsonResource;
class JobResultResource extends JsonResource
{
/**
* Transform the resource into an array.
*
* @param \Illuminate\Http\Request $request
* @return array
*/
public function toArray($request)
{
return [
'job_id' => $this->job_id,
'result' => $this->result,
];
}
}
app/Models/JobResult.php
+13
View File
@@ -0,0 +1,13 @@
<?php
namespace App\Models;
class JobResult extends AbstractModel
{
protected $table = 'job_results';
public $fillable = [
'job_id',
'result'
];
}
database/migrations/2023_08_08_124848_create_job_results_table.php
+35
View File
@@ -0,0 +1,35 @@
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
class CreateJobResultsTable extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::create('job_results', function (Blueprint $table) {
$table->id();
$table->string('job_id', 50);
$table->longText('result')->nullable();
$table->timestamps();
// $table->foreign('job_id')->references('id')->on('jobs')->onDelete('cascade');
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Schema::dropIfExists('job_results');
}
}
database/migrations/2023_08_29_063531_add_new_column_to_job_results_table.php
+36
View File
@@ -0,0 +1,36 @@
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
class AddNewColumnToJobResultsTable extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::table('job_results', function (Blueprint $table) {
$table->longText('url')->after('result')->nullable();
$table->string('job_command_name')->after('url')->nullable();
$table->longText('job_command')->after('job_command_name')->nullable();
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Schema::table('job_results', function (Blueprint $table) {
$table->dropColumn('url');
$table->dropColumn('job_command_name');
$table->dropColumn('job_command');
});
}
}
resources/assets/vue/components/bookings/sections/SupplierPendingOrdersSectionComponent.vue
+10 -4
View File
@@ -117,11 +117,17 @@
</div>
<div class="row">
<div class="col">
<list-component ref="pendingOrdersList" section="pendingOrdersSection" :endpoint="route('api.transaction.list')" :options="{per_page: 5, status: 2, owner_type: 'App\\Models\\Booking', type: 1, original_currency_id_in: [selectedCurrency.id], transaction_service_id: selectedService.id}">
<!-- CIEF TODO: For easy revert to old code -->
<!-- <list-component ref="pendingOrdersList" section="pendingOrdersSection" :endpoint="route('api.transaction.list')" :options="{per_page: 5, status: 2, owner_type: 'App\\Models\\Booking', type: 1, original_currency_id_in: [selectedCurrency.id], transaction_service_id: selectedService.id}">
<template slot="list" slot-scope="{data}">
<supplier-pending-order-component :data="data" v-on:input="updateOrder($event)"></supplier-pending-order-component>
</template>
</list-component>
</list-component> -->
<list-polling-component ref="pendingOrdersList" section="pendingOrdersSection" :endpoint="route('api.transaction.list.job')" :options="{per_page: 5, status: 2, owner_type: 'App\\Models\\Booking', type: 1, original_currency_id_in: [selectedCurrency.id], transaction_service_id: selectedService.id}">
<template slot="list" slot-scope="{data}">
<supplier-pending-order-component :data="data" v-on:input="updateOrder($event)"></supplier-pending-order-component>
</template>
</list-polling-component>
</div>
</div>
</div>
@@ -165,7 +171,7 @@
}
},
created(){
this.submit(route('api.company.list') + '?filters=' + JSON.stringify({'business_type': 3, 'status_in': [1, 2, 0]}), 'get', 'pendingOrdersSection', false, false)
this.submit(route('api.company.list') + '?filters=' + JSON.stringify({'business_type': 3, 'status_in': [1, 2, 0]}), 'get', 'pendingOrdersSection', false, false); //cief todo: Uncaught (in promise) null
},
methods: {
successHandler(response){
@@ -210,4 +216,4 @@
}
</script>
</script>
resources/assets/vue/components/general/elements/ListPollingComponent.vue
+204
View File
@@ -0,0 +1,204 @@
<template>
<transition-component group enter-class="animate__animated animate__fadeInUp animate__delay-1 animate__faster p-r-30" leave-class="animate__animated animate__fadeOutDown animate__faster p-r-30" style="min-height: 300px;width:100%">
<loading-component style="height: 200px; top: 0;" key="1" color="success" v-show="isLoading"></loading-component>
<div class="row" key="2" v-show="!$store.getters.isLoading(section)">
<div class="col">
<div class="row">
<div class="col">
<div class="row align-items-center justify-content-center p-t-50 p-b-50" v-show="!$store.getters.getListData(section).length && !isLoading && emptyListSection">
<div class="col-10">
<div class="row align-items-center justify-content-center hint-text">
<div class="col-4 hint-text"><img src="/images/not-found-illustration.png" class="w-100 hint-text"/></div>
</div>
<div class="row text-center">
<div class="col">
<div class="row m-t-20">
<div class="col">
<p class="all-caps no-margin fs-11" style="letter-spacing: 2px;">Nothing To Show Here</p>
</div>
</div>
<div class="row m-t-5 align-items-center justify-content-center">
<div class="col">
<small class="fs-9 muted all-caps font-lato" style="letter-spacing: 2px">There is no results found, Try adjusting your filters to find what you are looking for.</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="row" v-show="!isLoading">
<div class="col">
<div class="list disable-text-selection" data-check-all="checkAll">
<div class="row" ref="list" v-for="item in $store.getters.getListData(section)" v-bind:key="item.id" :data="item">
<div class="col">
<slot name="list" :data="item"></slot>
</div>
</div>
</div>
</div>
</div>
<div class="row" v-show="!isLoading">
<div class="col">
<pagination-component :section="section" class="mb-5" ref="pagination"></pagination-component>
</div>
</div>
</div>
</div>
</div>
</div>
</transition-component>
</template>
<script>
export default {
props: {
section:{
type: String,
required: true
},
endpoint: {
type: String,
required: true
},
options: {
default () {
return {}
}
},
emptyListSection: {
type: Boolean,
default: true,
}
},
data(){
return {
filters: this.options,
pollingInterval: null,
isPolling: false,
isLoading: false,
}
},
created(){
this.setDecoratorDefault();
this.$store.dispatch('updateListQueue', {'name': this.section, 'page': 1, 'filters': this.filters}); //cief todo: Uncaught (in promise) null
},
computed: {
pendingList () {
return this.$store.getters.isInCompleteQueue(this.section);
}
},
watch: {
pendingList(inComplete){
if(inComplete){
this.fetchList();
}
}
},
methods: {
fetchList(){
let listDecorators = this.$store.getters.getListDetails(this.section);
let url = this.endpoint + '?page=' + listDecorators.page + '&filters=' + JSON.stringify(listDecorators.filters);
this.isLoading = true;
this.submitJob(url);
},
//cief todo: remove?
// updateFilters(filters){
// this.filters = filters;
// this.setDecoratorDefault();
// console.log('updateFilters');
// this.submit(this.endpoint + '?page=1&filters=' + JSON.stringify(this.filters), 'get', this.section, false, false); //cief todo: Uncaught (in promise) null
// },
successHandler(response){
let result = JSON.parse(response.payload.data.result);
result.meta = {
current_page: result.meta.current_page,
first_page_url: result.meta.first_page_url,
from: result.meta.from,
last_page: result.meta.last_page,
last_page_url: result.meta.last_page_url,
next_page_url: result.meta.next_page_url,
path: result.meta.path,
per_page: result.meta.per_page,
prev_page_url: result.meta.prev_page_url,
to: result.meta.to,
total: result.meta.total
};
console.log('ListPolling:', JSON.stringify(result.meta));
this.stopPolling();
this.$store.dispatch('completeList', {'name': this.section, 'data': result.data});
this.$refs.pagination.makePagination(result.meta, result.links);
this.isLoading = false;
},
errorHandler(error){
// console.log('ListPolling error:', JSON.stringify(error));
this.isPolling = false;
// this.isLoading = false;
},
startPolling(jobId, maxAttempts = 3) {
let attempts = 0;
const pollJobResult = () => {
if (this.isPolling) {
return;
}
this.isPolling = true;
attempts++;
if (attempts > maxAttempts) {
clearInterval(this.pollingInterval);
this.pollingInterval = null;
this.isPolling = false;
this.isLoading = false;
console.log(`Reached maximum attempts (${maxAttempts}). Polling stopped.`);
return;
}
this.fetchJobResult(jobId);
};
// Initial call
// pollJobResult();
// Set up polling interval
this.pollingInterval = setInterval(pollJobResult, 10000);
},
stopPolling() {
clearInterval(this.pollingInterval);
this.pollingInterval = null;
this.isPolling = false;
},
submitJob(url){
try {
this.$store.dispatch('crudRequest', {endpoint: url, method: 'get'}).then(response => {
let success = response.ok;
response.json().then(response => {
if(!success){return;}
let jobId = response.payload.data.job_id;
if(jobId){
this.startPolling(jobId);
}
});
})
// this.job.progress = response.data.progress;
// this.job.completed = response.data.completed;
// if (this.job.completed) {
// this.stopPolling();
// }
} catch (error) {
console.error('Error submitJob', error);
}
},
fetchJobResult(jobId) {
try {
let anotherEndpoint = route('api.job.fetch', jobId);
this.submit(anotherEndpoint, 'get', this.section, false, false); //cief todo: Uncaught (in promise) null
} catch (error) {
console.error('Error fetchJobResult', error);
}
}
}
}
</script>
routes/api.php
+4
View File
@@ -67,6 +67,10 @@ Route::group(['middleware' => 'api', 'prefix' => 'v1', 'as' => 'api.'], function
require __DIR__ . '/milestone.php';
// require __DIR__ . '/accounting.php'; //cief todo: To check if this is needed
require __DIR__ . '/job.php';
// require __DIR__ . '/rate.php';
// require __DIR__ . '/receipt.php';
routes/currency.php
+1 -1
View File
@@ -1,4 +1,4 @@
<?php
<?php
use Illuminate\Support\Facades\Route;
routes/document.php
+2 -1
View File
@@ -4,9 +4,10 @@ use Illuminate\Support\Facades\Route;
Route::group(['prefix' => 'document', 'as' => 'document.', 'namespace' => 'Documents'], function () {
Route::get('/list', 'ListDocumentsController@list')->name('list');
Route::get('/list/job', 'ListDocumentsJobController@list')->name('list.job');
Route::delete('/{id}/delete', 'DeleteDocumentController@delete')->name('delete');
Route::put('/{id}/approve', 'ApproveDocumentController@approve')->name('status.approve');
Route::put('/{id}/reject', 'RejectDocumentController@reject')->name('status.reject');
Route::put('/{id}/reference/update', 'UpdateDocumentReferenceController@update')->name('reference.update');
});
});
routes/job.php
+7
View File
@@ -0,0 +1,7 @@
<?php
use Illuminate\Support\Facades\Route;
Route::group(['prefix' => 'job', 'as' => 'job.', 'namespace' => 'Jobs'], function () {
Route::get('/fetch/{job_id}', 'FetchJobResultController@fetch')->name('fetch');
});