mirror/opensourcepos
1
0
Fork 0
mirror of https://github.com/opensourcepos/opensourcepos.git synced 2026-05-18 13:28:32 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add transactions to missing config keys migration. (#4318)

Browse Source 
* `execute_script()` now returns a boolean for error handling.

* Added transaction to `Migration_MissingConfigKeys.up()`.

* Added `executeScriptWithTransaction()` to migration helpers.

* Many changes for testing; also minor formatting fixes.

* Removed test code and pointed the `NullableTaxCategoryId` migration at the right SQL file.

* Fixed header.php

* Code cleanup from code review:
- Added IGNORE to SQL scripts.
- Added try-catch to executeScriptWithTransaction().
- Various comment changes.

* Fixed naming issue

Nullable tax category ID migration now runs the correct script.

* Updated SQL

Replaced INSERT WHERE NOT EXISTS in missing config keys sql script to use a single INSERT IGNORE.

* Updated migration helper

Updated executeScriptWithTransaction to use transRollback

---------

Co-authored-by: Joe Williams <hey-there-joe@outlook.com>
This commit is contained in:
Joe Williams
2025-10-15 22:53:14 -07:00
committed by GitHub
parent d1e5575ac1
commit 759356288b
4 changed files with 84 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
app/Database/Migrations/20250716170000_MissingConfigKeys.php
View File

@@ -11,12 +11,14 @@ class Migration_MissingConfigKeys extends Migration
*/
public function up(): void
{
error_log('Migrating config table');
error_log('Migrating config keys...');
helper('migration');
execute_script(APPPATH . 'Database/Migrations/sqlscripts/3.4.2_missing_config_keys.sql');
error_log('Migrating config table');
if (executeScriptWithTransaction(APPPATH . 'Database/Migrations/sqlscripts/3.4.2_missing_config_keys.sql')) {
error_log('Migrated config keys.');
} else {
error_log('Failed to migrate config keys.');
}
}
/**

6
app/Database/Migrations/20250729170000_NullableTaxCategoryId.php
View File

@@ -11,12 +11,12 @@ class Migration_NullableTaxCategoryId extends Migration
*/
public function up(): void
{
error_log('Migrating config table');
error_log('Migrating nullable tax category ID');
helper('migration');
execute_script(APPPATH . 'Database/Migrations/sqlscripts/3.4.2_missing_config_keys.sql');
execute_script(APPPATH . 'Database/Migrations/sqlscripts/3.4.2_nullable_tax_category_id.sql');
error_log('Migrating config table');
error_log('Migrated nullable tax category ID');
}
/**

46
app/Database/Migrations/sqlscripts/3.4.2_missing_config_keys.sql
View File

@@ -1,35 +1,11 @@
INSERT INTO ospos_app_config (`key`, `value`)
SELECT 'msg_msg', ''
WHERE NOT EXISTS (SELECT 1 FROM ospos_app_config WHERE `key` = 'msg_msg');
INSERT INTO ospos_app_config (`key`, `value`)
SELECT 'msg_pwd', ''
WHERE NOT EXISTS (SELECT 1 FROM ospos_app_config WHERE `key` = 'msg_pwd');
INSERT INTO ospos_app_config (`key`, `value`)
SELECT 'msg_uid', ''
WHERE NOT EXISTS (SELECT 1 FROM ospos_app_config WHERE `key` = 'msg_uid');
INSERT INTO ospos_app_config (`key`, `value`)
SELECT 'msg_src', ''
WHERE NOT EXISTS (SELECT 1 FROM ospos_app_config WHERE `key` = 'msg_src');
INSERT INTO ospos_app_config (`key`, `value`)
SELECT 'smtp_timeout', 5000
WHERE NOT EXISTS (SELECT 1 FROM ospos_app_config WHERE `key` = 'smtp_timeout');
INSERT INTO ospos_app_config (`key`, `value`)
SELECT 'smtp_crypto', 'tls'
WHERE NOT EXISTS (SELECT 1 FROM ospos_app_config WHERE `key` = 'smtp_crypto');
INSERT INTO ospos_app_config (`key`, `value`)
SELECT 'smtp_port', 587
WHERE NOT EXISTS (SELECT 1 FROM ospos_app_config WHERE `key` = 'smtp_port');
INSERT INTO ospos_app_config (`key`, `value`)
SELECT 'mailpath', '/usr/bin/sendmail'
WHERE NOT EXISTS (SELECT 1 FROM ospos_app_config WHERE `key` = 'mailpath');
INSERT INTO ospos_app_config (`key`, `value`)
SELECT 'protocol', 'sendmail'
WHERE NOT EXISTS (SELECT 1 FROM ospos_app_config WHERE `key` = 'protocol');
INSERT IGNORE INTO ospos_app_config (`key`, `value`)
VALUES
('msg_msg', ''),
('msg_pwd', ''),
('msg_uid', ''),
('msg_src', ''),
('smtp_timeout', 5000),
('smtp_crypto', 'tls'),
('smtp_port', 587),
('mailpath', '/usr/bin/sendmail'),
('protocol', 'sendmail');

71
app/Helpers/migration_helper.php
View File

@@ -3,9 +3,11 @@
use Config\Database;
/**
* Migration helper
* Migration helper.
* @param string $path Path to migration script.
* @return bool Whether the migration executed successfully.
*/
function execute_script(string $path): void
function execute_script(string $path): bool
{
$version = preg_replace("/(.*_)?(.*).sql/", "$2", $path);
error_log("Migrating to $version (file: $path)");
@@ -16,17 +18,72 @@ function execute_script(string $path): void
$db = Database::connect();
$success = true;
foreach ($sqls as $statement) {
$statement = "$statement;";
$hadError = !$db->simpleQuery($statement);
if (!$db->simpleQuery($statement)) {
if ($hadError) {
$success = false;
foreach ($db->error() as $error) {
error_log("error: $error");
}
}
}
error_log("Migrated to $version");
if ($success) {
error_log("Successfully migrated to $version");
} else {
error_log("Could not migrate to $version.");
}
return $success;
}
/**
* Migration helper that uses a transaction.
* @param string $path Path to migration script.
* @return bool Whether the migration executed successfully.
*/
function executeScriptWithTransaction(string $path): bool
{
$version = preg_replace("/(.*_)?(.*).sql/", "$2", $path);
error_log("Migrating to $version (file: $path) with transaction");
$sql = file_get_contents($path);
$sqls = explode(';', $sql);
array_pop($sqls);
$db = Database::connect();
$db->transStart();
$success = true;
try {
foreach ($sqls as $statement) {
$statement = "$statement;";
$hadError = !$db->query($statement);
if ($hadError) {
$success = false;
foreach ($db->error() as $error) {
error_log("error: $error");
}
}
}
} catch (Exception $e) {
error_log("Could not migrate to $version: " . $e->getMessage());
$db->transRollback();
return false;
}
if ($success) {
error_log("Successfully migrated to $version");
} else {
error_log("Could not migrate to $version.");
}
$db->transComplete();
return $success;
}
/**
@@ -228,9 +285,9 @@ function dropColumnIfExists(string $table, string $column): void
// Check if the column exists in the table
$builder->select('COLUMN_NAME')
->where('TABLE_SCHEMA', $db->database)
->where('TABLE_NAME', $prefix . $table)
->where('COLUMN_NAME', $column);
->where('TABLE_SCHEMA', $db->database)
->where('TABLE_NAME', $prefix . $table)
->where('COLUMN_NAME', $column);
$query = $builder->get();