BlueGit

projects-timfalken-com microchess

Fix startup migration compatibility with older SQLite

timfa Tim Falken · pushed by timfa

Authored 2026-09-08 · 2 months ago

Hash
c93bfc6aca995128a93c04cae9fd96da91f2c225
Parent
503ead58
4 files changed +72 −3
.gitlab-ci.yml +1 −0
@@ -12,6 +12,7 @@ php_tests:
12 12 - find web -name '*.php' -not -path '*/artifacts/*' -print0 | xargs -0 -n1 php -l
13 13 - php -r 'foreach (["pdo_sqlite", "curl"] as $extension) { if (!extension_loaded($extension)) { fwrite(STDERR, "Missing extension " . $extension); exit(1); } }'
14 14 - php web/tests/chess.php
15 - python3 web/tests/startup.py
15 16 - python3 web/tests/integration.py
16 17
17 18 frontend_checks:
@@ -12,6 +12,7 @@ php_tests:
12 - find web -name '*.php' -not -path '*/artifacts/*' -print0 | xargs -0 -n1 php -l
12 - find web -name '*.php' -not -path '*/artifacts/*' -print0 | xargs -0 -n1 php -l
13 - php -r 'foreach (["pdo_sqlite", "curl"] as $extension) { if (!extension_loaded($extension)) { fwrite(STDERR, "Missing extension " . $extension); exit(1); } }'
13 - php -r 'foreach (["pdo_sqlite", "curl"] as $extension) { if (!extension_loaded($extension)) { fwrite(STDERR, "Missing extension " . $extension); exit(1); } }'
14 - php web/tests/chess.php
14 - php web/tests/chess.php
15 - python3 web/tests/startup.py
15 - python3 web/tests/integration.py
16 - python3 web/tests/integration.py
16
17
17frontend_checks:
18frontend_checks:
web/README.md +1 −0
@@ -81,6 +81,7 @@ From the repository root:
81 81 ```sh
82 82 find web -name '*.php' -not -path '*/artifacts/*' -print0 | xargs -0 -n1 php -l
83 83 php web/tests/chess.php
84 python3 web/tests/startup.py
84 85 python3 web/tests/integration.py
85 86 node --check web/assets/app.js
86 87 ```
@@ -81,6 +81,7 @@ From the repository root:
81```sh
81```sh
82find web -name '*.php' -not -path '*/artifacts/*' -print0 | xargs -0 -n1 php -l
82find web -name '*.php' -not -path '*/artifacts/*' -print0 | xargs -0 -n1 php -l
83php web/tests/chess.php
83php web/tests/chess.php
84python3 web/tests/startup.py
84python3 web/tests/integration.py
85python3 web/tests/integration.py
85node --check web/assets/app.js
86node --check web/assets/app.js
86```
87```
web/lib/bootstrap.php +17 −3
@@ -28,13 +28,23 @@ function db(): PDO {
28 28 try {
29 29 if (!in_array('activity_at',$db->query('PRAGMA table_info(games)')->fetchAll(PDO::FETCH_COLUMN,1),true)) {
30 30 $db->exec('ALTER TABLE games ADD COLUMN activity_at INTEGER');
31 $db->exec('UPDATE games SET activity_at=unixepoch() WHERE activity_at IS NULL');
31 $db->exec("UPDATE games SET activity_at=CAST(strftime('%s','now') AS INTEGER) WHERE activity_at IS NULL");
32 32 }
33 33 $db->exec('COMMIT');
34 34 } catch (Throwable $e) { $db->exec('ROLLBACK');throw $e; }
35 35 }
36 $db->exec('CREATE TRIGGER IF NOT EXISTS games_activity_insert AFTER INSERT ON games BEGIN UPDATE games SET activity_at=unixepoch() WHERE id=NEW.id; END;
37 CREATE TRIGGER IF NOT EXISTS games_activity_update AFTER UPDATE OF version ON games BEGIN UPDATE games SET activity_at=unixepoch() WHERE id=NEW.id; END;');
36 // Replace legacy triggers once, including databases already migrated on newer SQLite.
37 $legacy=$db->query("SELECT sql FROM sqlite_master WHERE type='trigger' AND name IN ('games_activity_insert','games_activity_update')")->fetchAll(PDO::FETCH_COLUMN);
38 if (array_filter($legacy,static fn(string $sql): bool => stripos($sql,'unixepoch(')!==false)) {
39 $db->exec('BEGIN IMMEDIATE');
40 try {
41 $db->exec('DROP TRIGGER IF EXISTS games_activity_insert; DROP TRIGGER IF EXISTS games_activity_update;');
42 activityTriggers($db);
43 $db->exec('COMMIT');
44 } catch (Throwable $e) { $db->exec('ROLLBACK');throw $e; }
45 } else {
46 activityTriggers($db);
47 }
38 48 // Assign existing accounts once as well as newly created accounts.
39 49 foreach ($db->query('SELECT id FROM users WHERE id NOT IN (SELECT user_id FROM user_avatars)')->fetchAll(PDO::FETCH_COLUMN) as $id) {
40 50 $avatars=avatarCatalog();
@@ -43,6 +53,10 @@ function db(): PDO {
43 53 }
44 54 return $db;
45 55 }
56 function activityTriggers(PDO $db): void {
57 $db->exec("CREATE TRIGGER IF NOT EXISTS games_activity_insert AFTER INSERT ON games BEGIN UPDATE games SET activity_at=CAST(strftime('%s','now') AS INTEGER) WHERE id=NEW.id; END;
58 CREATE TRIGGER IF NOT EXISTS games_activity_update AFTER UPDATE OF version ON games BEGIN UPDATE games SET activity_at=CAST(strftime('%s','now') AS INTEGER) WHERE id=NEW.id; END;");
59 }
46 60 function query(string $sql,array $args=[]): PDOStatement { $s=db()->prepare($sql);$s->execute($args);return $s; }
47 61 function profile(string $id): array {
48 62 return query('SELECT u.*,a.avatar FROM users u LEFT JOIN user_avatars a ON a.user_id=u.id WHERE u.id=?',[$id])->fetch();
@@ -28,13 +28,23 @@ function db(): PDO {
28 try {
28 try {
29 if (!in_array('activity_at',$db->query('PRAGMA table_info(games)')->fetchAll(PDO::FETCH_COLUMN,1),true)) {
29 if (!in_array('activity_at',$db->query('PRAGMA table_info(games)')->fetchAll(PDO::FETCH_COLUMN,1),true)) {
30 $db->exec('ALTER TABLE games ADD COLUMN activity_at INTEGER');
30 $db->exec('ALTER TABLE games ADD COLUMN activity_at INTEGER');
31 $db->exec('UPDATE games SET activity_at=unixepoch() WHERE activity_at IS NULL');
31 $db->exec("UPDATE games SET activity_at=CAST(strftime('%s','now') AS INTEGER) WHERE activity_at IS NULL");
32 }
32 }
33 $db->exec('COMMIT');
33 $db->exec('COMMIT');
34 } catch (Throwable $e) { $db->exec('ROLLBACK');throw $e; }
34 } catch (Throwable $e) { $db->exec('ROLLBACK');throw $e; }
35 }
35 }
36 $db->exec('CREATE TRIGGER IF NOT EXISTS games_activity_insert AFTER INSERT ON games BEGIN UPDATE games SET activity_at=unixepoch() WHERE id=NEW.id; END;
36 // Replace legacy triggers once, including databases already migrated on newer SQLite.
37 CREATE TRIGGER IF NOT EXISTS games_activity_update AFTER UPDATE OF version ON games BEGIN UPDATE games SET activity_at=unixepoch() WHERE id=NEW.id; END;');
37 $legacy=$db->query("SELECT sql FROM sqlite_master WHERE type='trigger' AND name IN ('games_activity_insert','games_activity_update')")->fetchAll(PDO::FETCH_COLUMN);
38 if (array_filter($legacy,static fn(string $sql): bool => stripos($sql,'unixepoch(')!==false)) {
39 $db->exec('BEGIN IMMEDIATE');
40 try {
41 $db->exec('DROP TRIGGER IF EXISTS games_activity_insert; DROP TRIGGER IF EXISTS games_activity_update;');
42 activityTriggers($db);
43 $db->exec('COMMIT');
44 } catch (Throwable $e) { $db->exec('ROLLBACK');throw $e; }
45 } else {
46 activityTriggers($db);
47 }
38 // Assign existing accounts once as well as newly created accounts.
48 // Assign existing accounts once as well as newly created accounts.
39 foreach ($db->query('SELECT id FROM users WHERE id NOT IN (SELECT user_id FROM user_avatars)')->fetchAll(PDO::FETCH_COLUMN) as $id) {
49 foreach ($db->query('SELECT id FROM users WHERE id NOT IN (SELECT user_id FROM user_avatars)')->fetchAll(PDO::FETCH_COLUMN) as $id) {
40 $avatars=avatarCatalog();
50 $avatars=avatarCatalog();
@@ -43,6 +53,10 @@ function db(): PDO {
43 }
53 }
44 return $db;
54 return $db;
45}
55}
56function activityTriggers(PDO $db): void {
57 $db->exec("CREATE TRIGGER IF NOT EXISTS games_activity_insert AFTER INSERT ON games BEGIN UPDATE games SET activity_at=CAST(strftime('%s','now') AS INTEGER) WHERE id=NEW.id; END;
58 CREATE TRIGGER IF NOT EXISTS games_activity_update AFTER UPDATE OF version ON games BEGIN UPDATE games SET activity_at=CAST(strftime('%s','now') AS INTEGER) WHERE id=NEW.id; END;");
59}
46function query(string $sql,array $args=[]): PDOStatement { $s=db()->prepare($sql);$s->execute($args);return $s; }
60function query(string $sql,array $args=[]): PDOStatement { $s=db()->prepare($sql);$s->execute($args);return $s; }
47function profile(string $id): array {
61function profile(string $id): array {
48 return query('SELECT u.*,a.avatar FROM users u LEFT JOIN user_avatars a ON a.user_id=u.id WHERE u.id=?',[$id])->fetch();
62 return query('SELECT u.*,a.avatar FROM users u LEFT JOIN user_avatars a ON a.user_id=u.id WHERE u.id=?',[$id])->fetch();
web/tests/startup.py added +53 −0
@@ -0,0 +1,53 @@
1 #!/usr/bin/env python3
2 """Exercise first startup and upgrades while preserving existing game data."""
3 from pathlib import Path
4 import shutil
5 import sqlite3
6 import subprocess
7 import tempfile
8
9 WEB = Path(__file__).resolve().parents[1]
10 ARTIFACTS = WEB / 'tests/artifacts'
11 ARTIFACTS.mkdir(exist_ok=True)
12 with tempfile.TemporaryDirectory(prefix='startup-', dir=ARTIFACTS) as tmp:
13 root = Path(tmp)
14 shutil.copytree(WEB / 'lib', root / 'lib')
15 shutil.copytree(WEB / 'assets/avatars', root / 'assets/avatars')
16 (root / 'data').mkdir()
17 def startup():
18 result = subprocess.run(['php', '-r', 'require $argv[1]; db();', str(root / 'lib/bootstrap.php')], capture_output=True, text=True, check=True)
19 assert not result.stderr, result.stderr
20 log = root / 'data/php-errors.log'
21 assert not log.exists() or not log.read_text(), 'Startup emitted PHP errors'
22 startup()
23 con = sqlite3.connect(root / 'data/microchess.sqlite')
24 con.executescript("""
25 INSERT INTO users VALUES('a','Alice'),('b','Bob');
26 INSERT INTO games(a,b,status,created) VALUES('a','b','active',123);
27 DROP TRIGGER games_activity_insert;
28 DROP TRIGGER games_activity_update;
29 ALTER TABLE games DROP COLUMN activity_at;
30 """)
31 startup()
32 row = con.execute('SELECT a,b,status,created,activity_at FROM games').fetchone()
33 assert row[:4] == ('a','b','active',123) and row[4] > 0, row
34 con.executescript("""
35 DROP TRIGGER games_activity_insert;
36 DROP TRIGGER games_activity_update;
37 CREATE TRIGGER games_activity_insert AFTER INSERT ON games BEGIN UPDATE games SET activity_at=unixepoch() WHERE id=NEW.id; END;
38 CREATE TRIGGER games_activity_update AFTER UPDATE OF version ON games BEGIN UPDATE games SET activity_at=unixepoch() WHERE id=NEW.id; END;
39 UPDATE games SET activity_at=123;
40 """)
41 startup()
42 assert con.execute('SELECT activity_at FROM games').fetchone()[0] == 123
43 triggers = con.execute("SELECT sql FROM sqlite_master WHERE type='trigger'").fetchall()
44 assert len(triggers) == 2 and all('unixepoch(' not in sql.lower() for sql, in triggers)
45 con.execute('UPDATE games SET version=version+1')
46 assert con.execute('SELECT activity_at FROM games').fetchone()[0] > 123
47 con.execute("INSERT INTO games(a,b,status,created) VALUES('b','a','active',456)")
48 assert con.execute('SELECT activity_at FROM games WHERE id=2').fetchone()[0] > 0
49 con.commit()
50 startup()
51 assert con.execute('SELECT count(*) FROM games').fetchone()[0] == 2
52 con.close()
53 print('Startup: fresh database, legacy migration, trigger upgrade and repeated startup passed.')
@@ -0,0 +1,53 @@
1#!/usr/bin/env python3
2"""Exercise first startup and upgrades while preserving existing game data."""
3from pathlib import Path
4import shutil
5import sqlite3
6import subprocess
7import tempfile
8
9WEB = Path(__file__).resolve().parents[1]
10ARTIFACTS = WEB / 'tests/artifacts'
11ARTIFACTS.mkdir(exist_ok=True)
12with tempfile.TemporaryDirectory(prefix='startup-', dir=ARTIFACTS) as tmp:
13 root = Path(tmp)
14 shutil.copytree(WEB / 'lib', root / 'lib')
15 shutil.copytree(WEB / 'assets/avatars', root / 'assets/avatars')
16 (root / 'data').mkdir()
17 def startup():
18 result = subprocess.run(['php', '-r', 'require $argv[1]; db();', str(root / 'lib/bootstrap.php')], capture_output=True, text=True, check=True)
19 assert not result.stderr, result.stderr
20 log = root / 'data/php-errors.log'
21 assert not log.exists() or not log.read_text(), 'Startup emitted PHP errors'
22 startup()
23 con = sqlite3.connect(root / 'data/microchess.sqlite')
24 con.executescript("""
25 INSERT INTO users VALUES('a','Alice'),('b','Bob');
26 INSERT INTO games(a,b,status,created) VALUES('a','b','active',123);
27 DROP TRIGGER games_activity_insert;
28 DROP TRIGGER games_activity_update;
29 ALTER TABLE games DROP COLUMN activity_at;
30 """)
31 startup()
32 row = con.execute('SELECT a,b,status,created,activity_at FROM games').fetchone()
33 assert row[:4] == ('a','b','active',123) and row[4] > 0, row
34 con.executescript("""
35 DROP TRIGGER games_activity_insert;
36 DROP TRIGGER games_activity_update;
37 CREATE TRIGGER games_activity_insert AFTER INSERT ON games BEGIN UPDATE games SET activity_at=unixepoch() WHERE id=NEW.id; END;
38 CREATE TRIGGER games_activity_update AFTER UPDATE OF version ON games BEGIN UPDATE games SET activity_at=unixepoch() WHERE id=NEW.id; END;
39 UPDATE games SET activity_at=123;
40 """)
41 startup()
42 assert con.execute('SELECT activity_at FROM games').fetchone()[0] == 123
43 triggers = con.execute("SELECT sql FROM sqlite_master WHERE type='trigger'").fetchall()
44 assert len(triggers) == 2 and all('unixepoch(' not in sql.lower() for sql, in triggers)
45 con.execute('UPDATE games SET version=version+1')
46 assert con.execute('SELECT activity_at FROM games').fetchone()[0] > 123
47 con.execute("INSERT INTO games(a,b,status,created) VALUES('b','a','active',456)")
48 assert con.execute('SELECT activity_at FROM games WHERE id=2').fetchone()[0] > 0
49 con.commit()
50 startup()
51 assert con.execute('SELECT count(*) FROM games').fetchone()[0] == 2
52 con.close()
53print('Startup: fresh database, legacy migration, trigger upgrade and repeated startup passed.')