opensourcepos/app/Database/Migrations/20260916000000_AddJobsModule.php

<?php

namespace App\Database\Migrations;

use CodeIgniter\Database\Migration;

class AddJobsModule extends Migration
{
    public function up(): void
    {
        $this->db->table('modules')->insert([
            'module_id'     => 'jobs',
            'name_lang_key' => 'jobs',
            'desc_lang_key' => 'jobs_desc',
            'sort'          => 130,
        ]);

        $this->db->table('permissions')->insert([
            'permission_id' => 'jobs',
            'module_id'     => 'jobs',
        ]);

        $this->db->table('grants')->insert([
            'permission_id' => 'jobs',
            'person_id'     => 1,
            'menu_group'    => 'office',
        ]);

        $this->forge->addField([
            'throttle_id' => ['type' => 'INT', 'unsigned' => true, 'auto_increment' => true],
            'max_count'   => ['type' => 'INT', 'unsigned' => true, 'default' => 0],
            'period'      => ['type' => 'ENUM', 'constraint' => ['second', 'minute', 'hour', 'day', 'month']],
            'deleted'     => ['type' => 'TINYINT', 'constraint' => 1, 'default' => 0],
        ]);
        $this->forge->addPrimaryKey('throttle_id');
        $this->forge->createTable('job_throttles');

        // CodeIgniter Queue's own tables (mirrors codeigniter4/queue's bundled
        // migrations, collapsed to their final shape since this app runs
        // migrations through MY_Migration rather than `php spark migrate`,
        // and vendor package migrations are never picked up that way).
        $this->forge->addField([
            'id'           => ['type' => 'bigint', 'constraint' => 11, 'unsigned' => true, 'auto_increment' => true],
            'queue'        => ['type' => 'varchar', 'constraint' => 64, 'null' => false],
            'payload'      => ['type' => 'text', 'null' => false],
            'priority'     => ['type' => 'varchar', 'constraint' => 64, 'null' => false, 'default' => 'default'],
            'status'       => ['type' => 'tinyint', 'unsigned' => true, 'null' => false, 'default' => 0],
            'attempts'     => ['type' => 'tinyint', 'unsigned' => true, 'null' => false, 'default' => 0],
            'available_at' => ['type' => 'int', 'unsigned' => true, 'null' => false],
            'created_at'   => ['type' => 'int', 'unsigned' => true, 'null' => false],
        ]);
        $this->forge->addPrimaryKey('id');
        $this->forge->addKey(['queue', 'priority', 'status', 'available_at'], false, false, 'queue_priority_status_available_at');
        $this->forge->createTable('queue_jobs', true);

        $this->forge->addField([
            'id'         => ['type' => 'bigint', 'constraint' => 11, 'unsigned' => true, 'auto_increment' => true],
            'connection' => ['type' => 'varchar', 'constraint' => 64, 'null' => false],
            'queue'      => ['type' => 'varchar', 'constraint' => 64, 'null' => false],
            'payload'    => ['type' => 'text', 'null' => false],
            'priority'   => ['type' => 'varchar', 'constraint' => 64, 'null' => false, 'default' => 'default'],
            // Not part of codeigniter4/queue's own schema: DatabaseHandler::failed()
            // doesn't carry attempts over from queue_jobs, so BoundedQueueWorker
            // records it directly when it moves a job here (see handle()) so the
            // Jobs Manage grid can show a real error count for failed rows.
            'attempts'   => ['type' => 'tinyint', 'unsigned' => true, 'null' => false, 'default' => 0],
            'exception'  => ['type' => 'text', 'null' => false],
            'failed_at'  => ['type' => 'int', 'unsigned' => true, 'null' => false],
        ]);
        $this->forge->addPrimaryKey('id');
        $this->forge->addKey('queue');
        $this->forge->createTable('queue_jobs_failed', true);

        // Batch tracking for queued CSV imports (issue #3833 Phase 3): one row
        // per import, incremented atomically by each row's job as it completes
        // so the last row can fire 'import_completed' exactly once.
        $this->forge->addField([
            'id'         => ['type' => 'VARCHAR', 'constraint' => 36],
            'type'       => ['type' => 'VARCHAR', 'constraint' => 64],
            'total'      => ['type' => 'INT', 'unsigned' => true, 'default' => 0],
            'completed'  => ['type' => 'INT', 'unsigned' => true, 'default' => 0],
            'failed'     => ['type' => 'INT', 'unsigned' => true, 'default' => 0],
            'status'     => ['type' => 'ENUM', 'constraint' => ['pending', 'processing', 'completed', 'partial']],
            'created_at' => ['type' => 'DATETIME', 'null' => true],
            'updated_at' => ['type' => 'DATETIME', 'null' => true],
        ]);
        $this->forge->addPrimaryKey('id');
        $this->forge->addKey(['type', 'status']);
        $this->forge->createTable('import_batches');

        $jobsConfigValues = [
            ['key' => 'jobs_mode', 'value' => 'web'],
            ['key' => 'jobs_web_max_seconds', 'value' => '5'],
            ['key' => 'jobs_task_max_seconds', 'value' => '30'],
            ['key' => 'jobs_failed_retention_days', 'value' => '30'],
            ['key' => 'jobs_retention_days', 'value' => '7'],
            ['key' => 'jobs_auto_purge', 'value' => '1'],
            ['key' => 'jobs_retry_limit', 'value' => '3'],
            ['key' => 'jobs_manual_max_seconds', 'value' => '30'],
        ];

        $this->db->table('app_config')->ignore(true)->insertBatch($jobsConfigValues);
    }

    public function down(): void
    {
        $jobsConfigKeys = [
            'jobs_mode',
            'jobs_web_max_seconds',
            'jobs_task_max_seconds',
            'jobs_failed_retention_days',
            'jobs_retention_days',
            'jobs_auto_purge',
            'jobs_retry_limit',
            'jobs_manual_max_seconds',
        ];

        $this->db->table('app_config')->whereIn('key', $jobsConfigKeys)->delete();

        $this->forge->dropTable('import_batches', true);
        $this->forge->dropTable('queue_jobs_failed', true);
        $this->forge->dropTable('queue_jobs', true);
        $this->forge->dropTable('job_throttles', true);

        $this->db->table('grants')->where('permission_id', 'jobs')->delete();
        $this->db->table('permissions')->where('permission_id', 'jobs')->delete();
        $this->db->table('modules')->where('module_id', 'jobs')->delete();
    }
}