[Woo POS][Local catalog] Set up GRDB database with initial schema (#16047)

Author: joshheald

Modules/Package.resolved

@@ -83,6 +83,7 @@ let package = Package(
         .package(url: "https://github.com/envoy/Embassy", from: "4.1.2"),
         // FIXME: This should be available via Tracks, but Tracks does not compile for watchOS
         .package(url: "https://github.com/getsentry/sentry-cocoa", from: "8.46.0"),
+        .package(url: "https://github.com/groue/GRDB.swift", from: "7.0.0"),
         .package(url: "https://github.com/jonreid/ViewControllerPresentationSpy", from: "7.0.0"),
         .package(url: "https://github.com/kishikawakatsumi/KeychainAccess", from: "4.2.2"),
         .package(url: "https://github.com/krzysztofzablocki/Difference.git", branch: "master"),
@@ -159,7 +160,8 @@ let package = Package(
             name: "Storage",
             dependencies: [
                 "Codegen",
-                "WooFoundation"
+                "WooFoundation",
+                .product(name: "GRDB", package: "GRDB.swift")
             ],
             exclude: ["Model/Migrations.md"],
             resources: [.process("Resources")]

Modules/Package.swift

@@ -0,0 +1,48 @@
+import Foundation
+import GRDB
+
+// TODO: remove ignore when we start using this
+// periphery: ignore
+public final class GRDBManager {
+
+    let databaseQueue: DatabaseQueue
+    private let databasePath: String
+
+    public init(databasePath: String) throws {
+        self.databasePath = databasePath
+
+        let databaseURL = URL(fileURLWithPath: databasePath)
+        let directoryURL = databaseURL.deletingLastPathComponent()
+
+        try FileManager.default.createDirectory(at: directoryURL, withIntermediateDirectories: true, attributes: nil)
+
+        self.databaseQueue = try DatabaseQueue(path: databasePath)
+
+        try migrateIfNeeded()
+    }
+
+    init() throws {
+        self.databasePath = "in-memory"
+        self.databaseQueue = try DatabaseQueue()
+        try migrateIfNeeded()
+    }
+}
+
+// TODO: remove ignore when we start using this
+// periphery: ignore
+private extension GRDBManager {
+    func migrateIfNeeded() throws {
+        var migrator = DatabaseMigrator()
+
+        #if DEBUG
+        // Speed up development by dropping the database when migrations change
+        migrator.eraseDatabaseOnSchemaChange = true
+        #endif
+
+        migrator.registerMigration("V001InitialSchema") { db in
+            try V001InitialSchema.migrate(db)
+        }
+
+        try migrator.migrate(databaseQueue)
+    }
+}

Modules/Sources/Storage/GRDB/GRDBManager.swift

@@ -0,0 +1,119 @@
+import Foundation
+import GRDB
+
+// TODO: remove ignore when we start using this
+// periphery: ignore
+struct V001InitialSchema {
+    // This migration is under development and not released yet.
+    // It's still open for modification, until we ship.
+    // TODO: Mark this as final when we enable the pointOfSaleLocalCatalogi1 feature flag
+
+    static func migrate(_ db: Database) throws {
+        try createSiteTable(db)
+        try createProductTable(db)
+        try createProductAttributeTable(db)
+        try createProductImageTable(db)
+        try createProductVariationTable(db)
+        try createProductVariationAttributeTable(db)
+        try createProductVariationImageTable(db)
+    }
+
+    static func createSiteTable(_ db: Database) throws {
+        try db.create(table: "site") { siteTable in
+            siteTable.primaryKey("id", .integer).notNull()
+        }
+    }
+
+    static func createProductTable(_ db: Database) throws {
+        // Note that it's best to use strings for names in the database
+        // not derive them from a Swift class.
+        // https://swiftpackageindex.com/groue/grdb.swift/v7.6.1/documentation/grdb/migrations#Good-Practices-for-Defining-Migrations
+        try db.create(table: "product") { productTable in
+            productTable.primaryKey("id", .integer).notNull()
+            productTable.belongsTo("site", onDelete: .cascade).notNull()
+
+            productTable.column("name", .text).notNull()
+            productTable.column("productTypeKey", .text).notNull()
+
+            productTable.column("fullDescription", .text)
+            productTable.column("shortDescription", .text)
+
+            productTable.column("sku", .text)
+            productTable.column("globalUniqueID", .text)
+            productTable.column("price", .text).notNull()
+
+            productTable.column("downloadable", .boolean).notNull()
+
+            productTable.column("parentID", .integer).notNull()
+        }
+    }
+
+    private static func createProductAttributeTable(_ db: Database) throws {
+        try db.create(table: "productAttribute") { productAttributeTable in
+            // This table holds local product attributes only. Global attributes belong to a site.
+            productAttributeTable.autoIncrementedPrimaryKey("id").notNull()
+            productAttributeTable.belongsTo("product", onDelete: .cascade).notNull()
+
+            productAttributeTable.column("name", .text).notNull()
+            productAttributeTable.column("position", .integer).notNull()
+            productAttributeTable.column("visible", .boolean).notNull()
+            productAttributeTable.column("variation", .boolean).notNull()
+            productAttributeTable.column("options", .jsonText).notNull()
+        }
+    }
+
+    private static func createProductImageTable(_ db: Database) throws {
+        try db.create(table: "productImage") { productImageTable in
+            productImageTable.primaryKey("id", .integer).notNull()
+            productImageTable.belongsTo("product", onDelete: .cascade).notNull()
+
+            productImageTable.column("dateCreated", .datetime).notNull()
+            productImageTable.column("dateModified", .datetime)
+
+            productImageTable.column("src", .text).notNull()
+            productImageTable.column("name", .text)
+            productImageTable.column("alt", .text)
+        }
+    }
+
+    private static func createProductVariationTable(_ db: Database) throws {
+        try db.create(table: "productVariation") { productVariationTable in
+            productVariationTable.primaryKey("id", .integer).notNull()
+            productVariationTable.belongsTo("site", onDelete: .cascade).notNull()
+            productVariationTable.belongsTo("product", onDelete: .cascade).notNull()
+
+            productVariationTable.column("sku", .text)
+            productVariationTable.column("globalUniqueID", .text)
+            productVariationTable.column("price", .text).notNull()
+
+            productVariationTable.column("downloadable", .boolean).notNull()
+
+            productVariationTable.column("fullDescription", .text)
+        }
+    }
+
+    private static func createProductVariationAttributeTable(_ db: Database) throws {
+        try db.create(table: "productVariationAttribute") { productVariationAttributeTable in
+            // This table holds local variation attributes only. Global attributes belong to a site.
+            productVariationAttributeTable.autoIncrementedPrimaryKey("id").notNull()
+            productVariationAttributeTable.belongsTo("productVariation", onDelete: .cascade).notNull()
+
+            productVariationAttributeTable.column("name", .text).notNull()
+            productVariationAttributeTable.column("option", .text).notNull()
+        }
+    }
+
+    private static func createProductVariationImageTable(_ db: Database) throws {
+        try db.create(table: "productVariationImage") { productVariationImageTable in
+            productVariationImageTable.primaryKey("id", .integer).notNull()
+            productVariationImageTable.belongsTo("productVariation").notNull()
+
+            productVariationImageTable.column("dateCreated", .datetime).notNull()
+            productVariationImageTable.column("dateModified", .datetime)
+
+            productVariationImageTable.column("src", .text).notNull()
+            productVariationImageTable.column("name", .text)
+            productVariationImageTable.column("alt", .text)
+        }
+    }
+}