🔥 Switched to node-sqlite dialect of knex

These bindings also rely on a forked version of knex, as well as
updates to @tryghost/database-info and knex-migrator

Author: sam-lord

ghost/core/core/server/data/db/connection.js

@@ -17,20 +17,33 @@ let knexInstance;
 function configure(dbConfig) {
     const client = dbConfig.client;
 
-    if (client === 'sqlite3') {
+    if (client === 'sqlite3' || client === 'node-sqlite') {
         // Backwards compatibility with old knex behaviour
         dbConfig.useNullAsDefault = Object.prototype.hasOwnProperty.call(dbConfig, 'useNullAsDefault') ? dbConfig.useNullAsDefault : true;
 
         // Enables foreign key checks and delete on cascade
         dbConfig.pool = {
             afterCreate(conn, cb) {
-                conn.run('PRAGMA foreign_keys = ON', cb);
+                if (client === 'sqlite3') {
+                    conn.run('PRAGMA foreign_keys = ON', cb);
 
-                // These two are meant to improve performance at the cost of reliability
-                // Should be safe for tests. We add them here and leave them on
-                if (config.get('env').startsWith('testing')) {
-                    conn.run('PRAGMA synchronous = OFF;');
-                    conn.run('PRAGMA journal_mode = TRUNCATE;');
+                    // These two are meant to improve performance at the cost of reliability
+                    // Should be safe for tests. We add them here and leave them on
+                    if (config.get('env').startsWith('testing')) {
+                        conn.run('PRAGMA synchronous = OFF;');
+                        conn.run('PRAGMA journal_mode = TRUNCATE;');
+                    }
+                } else if (client === 'node-sqlite') {
+                    // node-sqlite uses exec for PRAGMA statements
+                    conn.exec('PRAGMA foreign_keys = ON');
+
+                    // These two are meant to improve performance at the cost of reliability
+                    // Should be safe for tests. We add them here and leave them on
+                    if (config.get('env').startsWith('testing')) {
+                        conn.exec('PRAGMA synchronous = OFF');
+                        conn.exec('PRAGMA journal_mode = TRUNCATE');
+                    }
+                    cb();
                 }
             }
         };

ghost/core/core/server/data/schema/commands.js

@@ -506,7 +506,7 @@ function deleteTable(table, transaction = db.knex) {
 async function getTables(transaction = db.knex) {
     const client = transaction.client.config.client;
 
-    if (client === 'sqlite3') {
+    if (client === 'sqlite3' || client === 'node-sqlite') {
         const response = await transaction.raw('select * from sqlite_master where type = "table"');
         return _.reject(_.map(response, 'tbl_name'), name => name === 'sqlite_sequence');
     } else if (client === 'mysql2') {
@@ -524,7 +524,7 @@ async function getTables(transaction = db.knex) {
 async function getIndexes(table, transaction = db.knex) {
     const client = transaction.client.config.client;
 
-    if (client === 'sqlite3') {
+    if (client === 'sqlite3' || client === 'node-sqlite') {
         const response = await transaction.raw(`pragma index_list("${table}")`);
         return _.flatten(_.map(response, 'name'));
     } else if (client === 'mysql2') {
@@ -542,7 +542,7 @@ async function getIndexes(table, transaction = db.knex) {
 async function getColumns(table, transaction = db.knex) {
     const client = transaction.client.config.client;
 
-    if (client === 'sqlite3') {
+    if (client === 'sqlite3' || client === 'node-sqlite') {
         const response = await transaction.raw(`pragma table_info("${table}")`);
         return _.flatten(_.map(response, 'name'));
     } else if (client === 'mysql2') {

ghost/core/core/server/services/url/Resources.js

@@ -122,7 +122,7 @@ class Resources {
         debug('_fetch', resourceConfig.type, resourceConfig.modelOptions);
 
         let modelOptions = _.cloneDeep(resourceConfig.modelOptions);
-        const isSQLite = config.get('database:client') === 'sqlite3';
+        const isSQLite = ['sqlite3', 'node-sqlite'].includes(config.get('database:client'));
 
         // CASE: prevent "too many SQL variables" error on SQLite3 (https://github.com/TryGhost/Ghost/issues/5810)
         if (isSQLite) {

ghost/core/core/shared/config/env/config.testing-browser.json

@@ -1,7 +1,7 @@
 {
     "url": "http://127.0.0.1:2369",
     "database": {
-        "client": "sqlite3",
+        "client": "node-sqlite",
         "connection": {
             "filename": "/tmp/ghost-test.db"
         },

ghost/core/core/shared/config/env/config.testing.json

@@ -1,7 +1,7 @@
 {
     "url": "http://127.0.0.1:2369",
     "database": {
-        "client": "sqlite3",
+        "client": "node-sqlite",
         "connection": {
             "filename": "/tmp/ghost-test.db"
         },

ghost/core/core/shared/config/utils.js

@@ -70,7 +70,7 @@ const sanitizeDatabaseProperties = function sanitizeDatabaseProperties(nconf) {
 
     nconf.set('database', database);
 
-    if (nconf.get('database:client') === 'sqlite3') {
+    if (['sqlite3', 'node-sqlite'].includes(nconf.get('database:client'))) {
         makePathsAbsolute(nconf, nconf.get('database:connection'), 'database:connection');
     }
 };

ghost/core/package.json

@@ -21,14 +21,14 @@
   "license": "MIT",
   "scripts": {
     "archive": "npm pack",
-    "dev": "node --watch --import=tsx index.js",
+    "dev": "node --experimental-sqlite --watch --import=tsx index.js",
     "build:assets": "yarn build:assets:css && yarn build:assets:js",
     "build:assets:js": "node bin/minify-assets.js",
     "build:assets:css": "postcss core/frontend/public/ghost.css --no-map --use cssnano -o core/frontend/public/ghost.min.css",
     "build:tsc": "tsc",
     "pretest": "yarn build:assets",
     "test": "yarn test:unit",
-    "test:base": "mocha --reporter dot --require tsx --require=./test/utils/overrides.js --exit --trace-warnings --recursive --extension=test.js,test.ts",
+    "test:base": "mocha --experimental-sqlite --reporter dot --require tsx --require=./test/utils/overrides.js --exit --trace-warnings --recursive --extension=test.js,test.ts",
     "test:single": "yarn test:base --timeout=60000",
     "test:all": "yarn test:unit && yarn test:integration && yarn test:e2e && yarn lint",
     "test:debug": "DEBUG=ghost:test* yarn test",

ghost/core/test/e2e-api/admin/__snapshots__/config.test.js.snap

@@ -4,7 +4,7 @@ exports[`Config API As Owner Can retrieve config and all expected properties 1:
 Object {
   "config": Object {
     "clientExtensions": Object {},
-    "database": StringMatching /sqlite3\\|mysql\\|mysql2/,
+    "database": StringMatching /sqlite3\\|node-sqlite\\|mysql\\|mysql2/,
     "emailAnalytics": true,
     "enableDeveloperExperiments": false,
     "environment": StringMatching /\\^testing/,

ghost/core/test/e2e-api/admin/config.test.js

@@ -37,7 +37,7 @@ describe('Config API', function () {
                 .expectStatus(200)
                 .matchBodySnapshot({
                     config: {
-                        database: stringMatching(/sqlite3|mysql|mysql2/),
+                        database: stringMatching(/sqlite3|node-sqlite|mysql|mysql2/),
                         environment: stringMatching(/^testing/),
                         version: stringMatching(/\d+\.\d+\.\d+/)
                     }