sails-sqlite 0.1.0 → 0.2.1

package/lib/private/machines/send-native-query.js

@@ -0,0 +1,100 @@
+module.exports = {
+  friendlyName: 'Send native query',
+
+  description: 'Send a native query to the SQLite database.',
+
+  inputs: {
+    connection: {
+      friendlyName: 'Connection',
+      description: 'An active database connection.',
+      extendedDescription:
+        'The provided database connection instance must still be active. Only database connection instances created by the `getConnection()` machine in this driver are supported.',
+      example: '===',
+      required: true
+    },
+
+    nativeQuery: {
+      description: 'A native query for the database.',
+      extendedDescription:
+        'If `valuesToEscape` is provided, this supports template syntax like `?` for SQLite parameter binding.',
+      example: 'SELECT * FROM pets WHERE species=? AND nickname=?',
+      required: true
+    },
+
+    valuesToEscape: {
+      description:
+        'An optional list of strings, numbers, or special literals (true, false, or null) to escape and include in the native query, in order.',
+      extendedDescription:
+        'The first value in the list will be used to replace the first `?`, the second value to replace the second `?`, and so on.',
+      example: '===',
+      defaultsTo: []
+    },
+
+    meta: {
+      friendlyName: 'Meta (custom)',
+      description: 'Additional stuff to pass to the driver.',
+      extendedDescription:
+        'This is reserved for custom driver-specific extensions.',
+      example: '==='
+    }
+  },
+
+  exits: {
+    success: {
+      description: 'The native query was executed successfully.',
+      outputVariableName: 'report',
+      outputDescription:
+        'The `result` property is the result data the database sent back. The `meta` property is reserved for custom driver-specific extensions.',
+      outputExample: '==='
+    },
+
+    queryFailed: {
+      description:
+        'The database returned an error when attempting to execute the native query.',
+      outputVariableName: 'report',
+      outputDescription:
+        'The `error` property is a JavaScript Error instance with more details about what went wrong. The `meta` property is reserved for custom driver-specific extensions.',
+      outputExample: '==='
+    },
+
+    badConnection: {
+      friendlyName: 'Bad connection',
+      description: 'The provided connection is not valid or no longer active.',
+      outputVariableName: 'report',
+      outputDescription:
+        'The `meta` property is reserved for custom driver-specific extensions.',
+      outputExample: '==='
+    }
+  },
+
+  fn: function sendNativeQuery(inputs, exits) {
+    if (!inputs.connection || typeof inputs.connection.prepare !== 'function') {
+      return exits.badConnection()
+    }
+
+    const sql = inputs.nativeQuery
+    const bindings = inputs.valuesToEscape || []
+
+    try {
+      const stmt = inputs.connection.prepare(sql)
+      const isSelect =
+        sql.trim().toUpperCase().startsWith('SELECT') ||
+        sql.trim().toUpperCase().startsWith('PRAGMA')
+      const result = isSelect ? stmt.all(...bindings) : stmt.run(...bindings)
+
+      return exits.success({
+        result: {
+          rows: isSelect ? result : [],
+          changes: result.changes || 0,
+          lastInsertRowid: result.lastInsertRowid
+        },
+        meta: inputs.meta
+      })
+    } catch (err) {
+      return exits.queryFailed({
+        error: err,
+        meta: inputs.meta
+      })
+    }
+  }
+}

package/lib/private/machines/sum-records.js

@@ -59,7 +59,7 @@ module.exports = {
     const db = inputs.connection
 
     try {
-      let sumQuery = `SELECT COALESCE(SUM(${numericFieldName}), 0) as total FROM ${tableName}`
+      let sumQuery = `SELECT COALESCE(SUM(\`${numericFieldName}\`), 0) as total FROM \`${tableName}\``
       if (whereClause) {
         sumQuery += ` WHERE ${whereClause}`
       }

package/lib/private/machines/update-records.js

@@ -72,24 +72,33 @@ module.exports = {
 
     const db = inputs.connection
 
+    // Check if we're already in a transaction
+    const wasInTransaction = db.inTransaction
+
     try {
-      // Start a transaction
-      db.exec('BEGIN TRANSACTION')
+      // Start a transaction only if we're not already in one
+      if (!wasInTransaction) {
+        db.exec('BEGIN TRANSACTION')
+      }
 
       let affectedIds = []
 
       if (isFetchEnabled) {
         // Get the IDs of records which match this criteria
-        const selectSql = `SELECT ${pkColumnName} FROM ${tableName} WHERE ${sqliteWhere}`
+        const selectSql = sqliteWhere
+          ? `SELECT \`${pkColumnName}\` FROM \`${tableName}\` WHERE ${sqliteWhere}`
+          : `SELECT \`${pkColumnName}\` FROM \`${tableName}\``
         const selectStmt = db.prepare(selectSql)
         affectedIds = selectStmt.all().map((row) => row[pkColumnName])
       }
 
       // Prepare the UPDATE statement
       const setClauses = Object.entries(s3q.valuesToSet)
-        .map(([column, value]) => `${column} = ?`)
+        .map(([column, value]) => `\`${column}\` = ?`)
         .join(', ')
-      const updateSql = `UPDATE ${tableName} SET ${setClauses} WHERE ${sqliteWhere}`
+      const updateSql = sqliteWhere
+        ? `UPDATE \`${tableName}\` SET ${setClauses} WHERE ${sqliteWhere}`
+        : `UPDATE \`${tableName}\` SET ${setClauses}`
       const updateStmt = db.prepare(updateSql)
 
       // Execute the UPDATE
@@ -107,7 +116,9 @@ module.exports = {
         s3q.valuesToSet[pkColumnName] !== undefined &&
         affectedIds.length > 1
       ) {
-        db.exec('ROLLBACK')
+        if (!wasInTransaction) {
+          db.exec('ROLLBACK')
+        }
         return exits.error(
           new Error(
             'Consistency violation: Updated multiple records to have the same primary key value. (PK values should be unique!)'
@@ -117,12 +128,14 @@ module.exports = {
 
       // If fetch is not enabled, we're done
       if (!isFetchEnabled) {
-        db.exec('COMMIT')
+        if (!wasInTransaction) {
+          db.exec('COMMIT')
+        }
         return exits.success()
       }
 
       // Fetch the updated records
-      const fetchSql = `SELECT * FROM ${tableName} WHERE ${pkColumnName} IN (${affectedIds.map(() => '?').join(', ')})`
+      const fetchSql = `SELECT * FROM \`${tableName}\` WHERE \`${pkColumnName}\` IN (${affectedIds.map(() => '?').join(', ')})`
       const fetchStmt = db.prepare(fetchSql)
       const phRecords = fetchStmt.all(affectedIds)
 
@@ -131,10 +144,14 @@ module.exports = {
         processNativeRecord(phRecord, WLModel, s3q.meta)
       })
 
-      db.exec('COMMIT')
+      if (!wasInTransaction) {
+        db.exec('COMMIT')
+      }
       return exits.success(phRecords)
     } catch (err) {
-      db.exec('ROLLBACK')
+      if (!wasInTransaction) {
+        db.exec('ROLLBACK')
+      }
       err = processNativeError(err)
       if (err.footprint && err.footprint.identity === 'notUnique') {
         return exits.notUnique(err)

package/package.json

@@ -1,13 +1,15 @@
 {
   "name": "sails-sqlite",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "SQLite adapter for Sails/Waterline",
   "main": "lib",
   "directories": {
     "lib": "./lib"
   },
   "scripts": {
-    "test": "node tests/",
+    "test": "npm run lint && npm run custom-tests && npm run adapter-tests",
+    "custom-tests": "node tests/",
+    "adapter-tests": "rm -rf .tmp && node tests/runner.js",
     "lint": "prettier --check .",
     "lint:fix": "prettier --write .",
     "prepare": "husky"
@@ -48,13 +50,16 @@
   "devDependencies": {
     "husky": "^9.0.11",
     "lint-staged": "^15.2.2",
-    "prettier": "3.2.5"
+    "mocha": "^11.7.2",
+    "prettier": "3.2.5",
+    "waterline-adapter-tests": "^1.0.1"
   },
   "lint-staged": {
     "**/*": "prettier --write --ignore-unknown"
   },
   "dependencies": {
     "better-sqlite3": "^12.2.0",
+    "flaverr": "^1.10.0",
     "machine": "^15.2.3",
     "waterline-utils": "^1.4.5"
   },

package/tests/index.js

@@ -6,7 +6,7 @@ const fs = require('node:fs')
 
 // __dirname is automatically available in CommonJS
 
-const testFiles = ['adapter.test.js', 'sequence.test.js', 'datatypes.test.js']
+const testFiles = ['transaction.test.js']
 
 function cleanupTestDatabases() {
   try {

package/tests/runner.js

@@ -0,0 +1,99 @@
+/**
+ * Run integration tests
+ *
+ * Uses the `waterline-adapter-tests` module to
+ * run mocha tests against the appropriate version
+ * of Waterline.  Only the interfaces explicitly
+ * declared in this adapter's `package.json` file
+ * are tested. (e.g. `queryable`, `semantic`, etc.)
+ */
+
+/**
+ * Module dependencies
+ */
+
+var util = require('util')
+var TestRunner = require('waterline-adapter-tests')
+var Adapter = require('../')
+
+// Grab targeted interfaces from this adapter's `package.json` file:
+var package = {}
+var interfaces = []
+var features = []
+try {
+  package = require('../package.json')
+  interfaces = package.waterlineAdapter.interfaces
+  features = package.waterlineAdapter.features
+} catch (e) {
+  throw new Error(
+    '\n' +
+      'Could not read supported interfaces from `waterlineAdapter.interfaces`' +
+      '\n' +
+      "in this adapter's `package.json` file ::" +
+      '\n' +
+      util.inspect(e)
+  )
+}
+
+console.log('Testing `' + package.name + '`, a Sails/Waterline adapter.')
+console.log(
+  'Running `waterline-adapter-tests` against ' +
+    interfaces.length +
+    ' interfaces...'
+)
+console.log('( ' + interfaces.join(', ') + ' )')
+console.log()
+console.log('Latest draft of Waterline adapter interface spec:')
+console.log(
+  'http://sailsjs.com/documentation/concepts/extending-sails/adapters'
+)
+console.log()
+
+/**
+ * Integration Test Runner
+ *
+ * Uses the `waterline-adapter-tests` module to
+ * run mocha tests against the specified interfaces
+ * of the currently-implemented Waterline adapter API.
+ */
+new TestRunner({
+  // Mocha opts
+  mocha: {
+    bail: true
+  },
+
+  // Load the adapter module.
+  adapter: Adapter,
+
+  // Default connection config to use.
+  config: {
+    url: '.tmp/test-db.sqlite',
+    schema: false
+  },
+
+  // The set of adapter interfaces to test against.
+  // (grabbed these from this adapter's package.json file above)
+  interfaces: interfaces,
+
+  // The set of adapter features to test against.
+  // (grabbed these from this adapter's package.json file above)
+  features: features
+
+  // Most databases implement 'semantic' and 'queryable'.
+  //
+  // As of Sails/Waterline v0.10, the 'associations' interface
+  // is also available.  If you don't implement 'associations',
+  // it will be polyfilled for you by Waterline core.  The core
+  // implementation will always be used for cross-adapter / cross-connection
+  // joins.
+  //
+  // In future versions of Sails/Waterline, 'queryable' may be also
+  // be polyfilled by core.
+  //
+  // These polyfilled implementations can usually be further optimized at the
+  // adapter level, since most databases provide optimizations for internal
+  // operations.
+  //
+  // Full interface reference:
+  // https://github.com/balderdashy/sails-docs/blob/master/adapter-specification.md
+})