daengdeni/webstatement
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor(jobs): optimize job classes by adding modular methods and constants

Browse Source 
- Menambahkan konstanta baru pada setiap job untuk meningkatkan keterbacaan:
  - `CSV_DELIMITER` untuk delimiter CSV.
  - `MAX_EXECUTION_TIME` untuk batas waktu eksekusi (86400 detik).
  - `FILENAME` untuk nama file masing-masing job.
  - `DISK_NAME` untuk disk yang digunakan.
- Mengubah `protected` menjadi `private` untuk properti seperti:
  - `$period`, `$processedCount`, dan `$errorCount` di semua job.
- Memindahkan logika proses menjadi metode modular untuk meningkatkan modularitas:
  - Metode `initializeJob` untuk inisialisasi counter.
  - Metode `processPeriod` untuk menangani file dan memulai proses.
  - Metode `validateFile` untuk validasi keberadaan file.
  - Metode `createTemporaryFile` untuk menyalin file sementara.
  - Metode `processFile` untuk membaca isi file CSV dan memproses.
  - Metode `processRow`/`mapAndSaveRecord`/`saveRecord` untuk pemrosesan dan penyimpanan data.
  - Metode `cleanup` untuk menghapus file sementara.
  - Metode `logJobCompletion` untuk logging hasil akhir.
- Menerapkan pengolahan file dengan sistem logging terperinci:
  - Logging row dengan kolom tidak sesuai akan menghasilkan peringatan.
  - Mencatat jumlah record berhasil diproses serta error.

Refaktor ini bertujuan untuk meningkatkan kualitas kode melalui modularisasi, keterbacaan, dan kemudahan pengujian ulang di seluruh kelas job.
This commit is contained in:
daengdeni
2025-05-26 15:26:43 +07:00
parent 41ed7c1ed9
commit c6363473ac
15 changed files with 2035 additions and 1250 deletions
Download Patch File Download Diff File Expand all files Collapse all files

279
app/Jobs/ProcessCompanyDataJob.php
View File

@@ -16,16 +16,38 @@
{
use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
protected $period;
protected $filename;
private const CSV_DELIMITER = '~';
private const MAX_EXECUTION_TIME = 86400; // 24 hours in seconds
private const FILENAME = 'ST.COMPANY.csv';
private const DISK_NAME = 'sftpStatement';
private const FIELD_MAP = [
'id' => null, // Not mapped to model
'date_time' => null, // Not mapped to model
'company_code' => 'code',
'company_name' => 'name',
'name_address' => 'address',
'mnemonic' => 'mnemonic',
'customer_company' => 'customer_company',
'customer_mnemonic' => 'customer_mnemonic',
'company_group' => 'company_group',
'curr_no' => 'curr_no',
'co_code' => 'co_code',
'l_vendor_atm' => 'l_vendor_atm',
'l_vendor_cpc' => 'l_vendor_cpc'
];
private const BOOLEAN_FIELDS = ['l_vendor_atm', 'l_vendor_cpc'];
private string $period;
private string $filename;
private int $processedCount = 0;
private int $errorCount = 0;
/**
* Create a new job instance.
*/
public function __construct(string $period = '', string $filename = "ST.COMPANY.csv")
public function __construct(string $period = '')
{
$this->period = $period;
$this->filename = $filename;
$this->period = $period;
}
/**
@@ -35,123 +57,154 @@
: void
{
try {
set_time_limit(24 * 60 * 60);
$disk = Storage::disk('sftpStatement');
$processedCount = 0;
$errorCount = 0;
$this->initializeJob();
if ($this->period === '') {
Log::warning('No period provided for company data processing');
return;
}
// Construct the filepath based on the period folder name
$fileName = "{$this->period}.{$this->filename}";
$filePath = "{$this->period}/$fileName";
Log::info("Processing company file: $filePath");
if (!$disk->exists($filePath)) {
Log::warning("File not found: $filePath");
return;
}
// Create a temporary local copy of the file
$tempFilePath = storage_path("app/temp_{$this->filename}");
file_put_contents($tempFilePath, $disk->get($filePath));
$handle = fopen($tempFilePath, "r");
if ($handle !== false) {
// CSV headers from the file
$csvHeaders = [
'id',
'date_time',
'company_code',
'company_name',
'name_address',
'mnemonic',
'customer_company',
'customer_mnemonic',
'company_group',
'curr_no',
'co_code',
'l_vendor_atm',
'l_vendor_cpc'
];
// Field mapping from CSV to Branch model
$fieldMapping = [
'company_code' => 'code',
'company_name' => 'name',
'name_address' => 'address',
'mnemonic' => 'mnemonic',
'customer_company' => 'customer_company',
'customer_mnemonic' => 'customer_mnemonic',
'company_group' => 'company_group',
'curr_no' => 'curr_no',
'co_code' => 'co_code',
'l_vendor_atm' => 'l_vendor_atm',
'l_vendor_cpc' => 'l_vendor_cpc'
];
$rowCount = 0;
while (($row = fgetcsv($handle, 0, "~")) !== false) {
$rowCount++;
// Skip header row if it exists
if ($rowCount === 1 && (strtolower($row[0]) === 'id' || strtolower($row[2]) === 'company_code')) {
continue;
}
if (count($csvHeaders) === count($row)) {
$csvData = array_combine($csvHeaders, $row);
// Map CSV data to Branch model fields
$branchData = [];
foreach ($fieldMapping as $csvField => $modelField) {
if (isset($csvData[$csvField])) {
// Convert string boolean values to actual booleans for boolean fields
if (in_array($modelField, ['l_vendor_atm', 'l_vendor_cpc'])) {
$branchData[$modelField] = filter_var($csvData[$csvField], FILTER_VALIDATE_BOOLEAN);
} else {
$branchData[$modelField] = $csvData[$csvField];
}
}
}
try {
if (!empty($branchData['code'])) {
Branch::updateOrCreate(
['code' => $branchData['code']],
$branchData
);
$processedCount++;
}
} catch (Exception $e) {
$errorCount++;
Log::error("Error processing Company data at row $rowCount in $filePath: " . $e->getMessage());
}
} else {
Log::warning("Row $rowCount in $filePath has incorrect column count. Expected: " . count($csvHeaders) . ", Got: " . count($row));
}
}
fclose($handle);
Log::info("Completed processing $filePath. Processed $processedCount records with $errorCount errors.");
// Clean up the temporary file
unlink($tempFilePath);
} else {
Log::error("Unable to open file: $filePath");
}
Log::info("Company data processing completed. Total processed: $processedCount, Total errors: $errorCount");
$this->processPeriod();
$this->logJobCompletion();
} catch (Exception $e) {
Log::error('Error in ProcessCompanyDataJob: ' . $e->getMessage());
throw $e;
}
}
private function initializeJob()
: void
{
set_time_limit(self::MAX_EXECUTION_TIME);
$this->processedCount = 0;
$this->errorCount = 0;
}
private function processPeriod()
: void
{
$disk = Storage::disk(self::DISK_NAME);
$filename = "{$this->period}." . self::FILENAME;
$filePath = "{$this->period}/$filename";
if (!$this->validateFile($disk, $filePath)) {
return;
}
$tempFilePath = $this->createTemporaryFile($disk, $filePath, $filename);
$this->processFile($tempFilePath, $filePath);
$this->cleanup($tempFilePath);
}
private function validateFile($disk, string $filePath)
: bool
{
Log::info("Processing company file: $filePath");
if (!$disk->exists($filePath)) {
Log::warning("File not found: $filePath");
return false;
}
return true;
}
private function createTemporaryFile($disk, string $filePath, string $filename = self::FILENAME)
: string
{
$tempFilePath = storage_path("app/temp_$filename");
file_put_contents($tempFilePath, $disk->get($filePath));
return $tempFilePath;
}
private function processFile(string $tempFilePath, string $filePath)
: void
{
$handle = fopen($tempFilePath, "r");
if ($handle === false) {
Log::error("Unable to open file: $filePath");
return;
}
$rowCount = 0;
while (($row = fgetcsv($handle, 0, self::CSV_DELIMITER)) !== false) {
$rowCount++;
// Skip header row if it exists
if ($rowCount === 1 && (strtolower($row[0]) === 'id' || strtolower($row[2]) === 'company_code')) {
continue;
}
$this->processRow($row, $rowCount, $filePath);
}
fclose($handle);
Log::info("Completed processing $filePath. Processed {$this->processedCount} records with {$this->errorCount} errors.");
}
private function processRow(array $row, int $rowCount, string $filePath)
: void
{
$csvHeaders = array_keys(self::FIELD_MAP);
if (count($csvHeaders) !== count($row)) {
Log::warning("Row $rowCount in $filePath has incorrect column count. Expected: " .
count($csvHeaders) . ", Got: " . count($row));
return;
}
$csvData = array_combine($csvHeaders, $row);
$this->mapAndSaveRecord($csvData, $rowCount, $filePath);
}
private function mapAndSaveRecord(array $csvData, int $rowCount, string $filePath)
: void
{
// Map CSV data to Branch model fields
$branchData = [];
foreach (self::FIELD_MAP as $csvField => $modelField) {
if ($modelField !== null && isset($csvData[$csvField])) {
// Convert string boolean values to actual booleans for boolean fields
if (in_array($modelField, self::BOOLEAN_FIELDS)) {
$branchData[$modelField] = filter_var($csvData[$csvField], FILTER_VALIDATE_BOOLEAN);
} else {
$branchData[$modelField] = $csvData[$csvField];
}
}
}
$this->saveRecord($branchData, $rowCount, $filePath);
}
private function saveRecord(array $branchData, int $rowCount, string $filePath)
: void
{
try {
if (!empty($branchData['code'])) {
Branch::updateOrCreate(
['code' => $branchData['code']],
$branchData
);
$this->processedCount++;
}
} catch (Exception $e) {
$this->errorCount++;
Log::error("Error processing Company data at row $rowCount in $filePath: " . $e->getMessage());
}
}
private function cleanup(string $tempFilePath)
: void
{
if (file_exists($tempFilePath)) {
unlink($tempFilePath);
}
}
private function logJobCompletion()
: void
{
Log::info("Company data processing completed. " .
"Total processed: {$this->processedCount}, Total errors: {$this->errorCount}");
}
}