migration tracking.

lnbits/core/migrations.py

@@ -1,4 +1,15 @@
-from lnbits.db import open_db
+import sqlite3
+
+
+def m000_create_migrations_table(db):
+    db.execute(
+        """
+    CREATE TABLE dbversions (
+        db TEXT PRIMARY KEY,
+        version INT NOT NULL
+    )
+    """
+    )
 
 
 def m001_initial(db):
@@ -76,35 +87,36 @@ def m002_add_fields_to_apipayments(db):
     Adding fields to apipayments for better accounting,
     and renaming payhash to checking_id since that is what it really is.
     """
-    db.execute("ALTER TABLE apipayments RENAME COLUMN payhash TO checking_id")
-    db.execute("ALTER TABLE apipayments ADD COLUMN hash TEXT")
-    db.execute("CREATE INDEX by_hash ON apipayments (hash)")
-    db.execute("ALTER TABLE apipayments ADD COLUMN preimage TEXT")
-    db.execute("ALTER TABLE apipayments ADD COLUMN bolt11 TEXT")
-    db.execute("ALTER TABLE apipayments ADD COLUMN extra TEXT")
+    try:
+        db.execute("ALTER TABLE apipayments RENAME COLUMN payhash TO checking_id")
+        db.execute("ALTER TABLE apipayments ADD COLUMN hash TEXT")
+        db.execute("CREATE INDEX by_hash ON apipayments (hash)")
+        db.execute("ALTER TABLE apipayments ADD COLUMN preimage TEXT")
+        db.execute("ALTER TABLE apipayments ADD COLUMN bolt11 TEXT")
+        db.execute("ALTER TABLE apipayments ADD COLUMN extra TEXT")
 
-    import json
+        import json
 
-    rows = db.fetchall("SELECT * FROM apipayments")
-    for row in rows:
-        if not row["memo"] or not row["memo"].startswith("#"):
-            continue
+        rows = db.fetchall("SELECT * FROM apipayments")
+        for row in rows:
+            if not row["memo"] or not row["memo"].startswith("#"):
+                continue
 
-        for ext in ["withdraw", "events", "lnticket", "paywall", "tpos"]:
-            prefix = "#" + ext + " "
-            if row["memo"].startswith(prefix):
-                new = row["memo"][len(prefix) :]
-                db.execute(
-                    """
-                    UPDATE apipayments SET extra = ?, memo = ?
-                    WHERE checking_id = ? AND memo = ?
-                    """,
-                    (json.dumps({"tag": ext}), new, row["checking_id"], row["memo"]),
-                )
-                break
-
-
-def migrate():
-    with open_db() as db:
-        m001_initial(db)
-        m002_add_fields_to_apipayments(db)
+            for ext in ["withdraw", "events", "lnticket", "paywall", "tpos"]:
+                prefix = "#" + ext + " "
+                if row["memo"].startswith(prefix):
+                    new = row["memo"][len(prefix) :]
+                    db.execute(
+                        """
+                        UPDATE apipayments SET extra = ?, memo = ?
+                        WHERE checking_id = ? AND memo = ?
+                        """,
+                        (json.dumps({"tag": ext}), new, row["checking_id"], row["memo"]),
+                    )
+                    break
+    except sqlite3.OperationalError:
+        # this is necessary now because it may be the case that this migration will
+        # run twice in some environments.
+        # catching errors like this won't be necessary in anymore now that we
+        # keep track of db versions so no migration ever runs twice.
+        pass