sails-sqlite 0.1.0 → 0.2.1

package/lib/private/machines/join.js

@@ -1,30 +1,11 @@
-const processEachRecord = require('./private/process-each-record')
-const generateJoinSqlQuery = require('./private/generate-join-sql-query')
-
 module.exports = {
   friendlyName: 'Join',
-
   description: 'Perform a join operation in SQLite using better-sqlite3.',
-
   inputs: {
-    datastore: {
-      description: 'The datastore to use for the query.',
-      required: true,
-      example: '==='
-    },
-    models: {
-      description:
-        'An object containing all of the model definitions that have been registered.',
-      required: true,
-      example: '==='
-    },
-    query: {
-      description: 'A normalized Waterline Stage Three Query.',
-      required: true,
-      example: '==='
-    }
+    query: require('../constants/query.input'),
+    connection: require('../constants/connection.input'),
+    dryOrm: require('../constants/dry-orm.input')
   },
-
   exits: {
     success: {
       description: 'The query was run successfully.',
@@ -34,60 +15,245 @@ module.exports = {
       description: 'An error occurred while performing the query.'
     }
   },
+  fn: function (inputs, exits) {
+    const _ = require('@sailshq/lodash')
+    const async = require('async')
+    const WLUtils = require('waterline-utils')
+    const processEachRecord = require('./private/process-each-record')
+    const compileStatement = require('./private/compile-statement')
 
-  fn: async function (inputs, exits) {
-    const { datastore, models, query } = inputs
-
-    try {
-      const { joins } = require('waterline-utils')
-
-      // Convert join criteria using waterline-utils
-      const joinCriteria = joins.convertJoinCriteria({
-        query,
-        getPk: (tableName) => {
-          // Find the model by tableName
-          let targetModel = null
-          for (const modelIdentity in models) {
-            if (models[modelIdentity].tableName === tableName) {
-              targetModel = models[modelIdentity]
-              break
-            }
+    const { query, connection, dryOrm } = inputs
+    const models = dryOrm.models
+
+    let hasReturned = false
+
+    // Find the model definition
+    const model = models[query.using]
+    if (!model) {
+      if (hasReturned) return
+      hasReturned = true
+      return exits.error(new Error(`No model found for table: ${query.using}`))
+    }
+
+    // Get primary key info
+    const primaryKeyAttr = model.primaryKey
+    const primaryKeyColumnName =
+      model.definition[primaryKeyAttr].columnName || primaryKeyAttr
+
+    // Build statements
+    const statements = WLUtils.joins.convertJoinCriteria({
+      query,
+      getPk: function getPk(tableName) {
+        let targetModel = null
+        for (const modelIdentity in models) {
+          if (models[modelIdentity].tableName === tableName) {
+            targetModel = models[modelIdentity]
+            break
           }
+        }
+        if (!targetModel) {
+          throw new Error('Invalid parent table name')
+        }
+        const pkAttrName = targetModel.primaryKey
+        const pkColumnName =
+          targetModel.definition[pkAttrName].columnName || pkAttrName
+        return pkColumnName
+      }
+    })
+
+    // Run parent query
+    const compiledQuery = compileStatement(statements.parentStatement)
+    const db = connection
+    const stmt = db.prepare(compiledQuery.sql)
+    const parentResults = stmt.all(...(compiledQuery.bindings || []))
+
+    // Early exit if no joins or no results
+    if (!_.has(query, 'joins') || !parentResults.length) {
+      if (hasReturned) return
+      hasReturned = true
+      return exits.success(parentResults)
+    }
+
+    // Detect child records
+    const sortedResults = WLUtils.joins.detectChildrenRecords(
+      primaryKeyColumnName,
+      parentResults
+    )
+
+    // Initialize query cache
+    const queryCache = WLUtils.joins.queryCache()
+
+    // Process instructions
+    _.each(statements.instructions, function (val, key) {
+      const popInstructions = val.instructions
+      const strategy = val.strategy.strategy
+      const parentModel = models[_.first(popInstructions).parent]
+
+      if (!parentModel) {
+        throw new Error('Invalid parent model in instructions')
+      }
+
+      const pkAttr = parentModel.primaryKey
+      const pkColumnName = parentModel.definition[pkAttr].columnName || pkAttr
+
+      let alias, keyName
+      if (val.strategy && val.strategy.strategy === 1) {
+        alias = _.first(popInstructions).alias
+        keyName = _.first(popInstructions).parentKey
+      } else {
+        alias = _.first(popInstructions).alias
+      }
+
+      _.each(sortedResults.parents, function (parentRecord) {
+        const cache = {
+          attrName: key,
+          parentPkAttr: pkColumnName,
+          belongsToPkValue: parentRecord[pkColumnName],
+          keyName: keyName || alias,
+          type: strategy
+        }
+
+        const childKey = _.first(popInstructions).childKey
+        const parentKey = _.first(popInstructions).parentKey
 
-          if (!targetModel) {
-            throw new Error(`No model found with tableName: ${tableName}`)
+        const records = _.filter(
+          sortedResults.children[alias],
+          function (child) {
+            if (strategy === 3) {
+              return child._parent_fk === parentRecord[parentKey]
+            }
+            return child[childKey] === parentRecord[parentKey]
           }
+        )
 
-          const pkAttrName = targetModel.primaryKey
-          const pkDef = targetModel.attributes[pkAttrName]
-          return pkDef.columnName || pkAttrName
+        if (strategy === 3) {
+          _.each(records, function (record) {
+            delete record._parent_fk
+          })
         }
-      })
 
-      // Generate SQL query using our helper
-      const { sql, bindings } = generateJoinSqlQuery(
-        joinCriteria,
-        models,
-        query
-      )
-
-      // Execute the query using the database connection from the datastore
-      const db = datastore.manager
-      const stmt = db.prepare(sql)
-      const results = stmt.all(...bindings)
-
-      // Process results through the join utility
-      const processedResults = joins.processJoinResults({
-        query,
-        records: results,
-        orm: {
-          collections: models
+        if (records.length) {
+          cache.records = records
         }
+
+        queryCache.set(cache)
       })
+    })
+
+    // Set parents
+    queryCache.setParents(sortedResults.parents)
 
-      return exits.success(processedResults)
-    } catch (error) {
-      return exits.error(error)
+    // Single-query path (no child statements)
+    if (!statements.childStatements || !statements.childStatements.length) {
+      const combinedResults = queryCache.combineRecords() || []
+      const orm = { collections: models }
+      processEachRecord({
+        records: combinedResults,
+        identity: model.identity,
+        orm: orm
+      })
+      if (hasReturned) return
+      hasReturned = true
+      return exits.success(combinedResults)
     }
+
+    // Multi-query path (process child statements)
+    const parentKeys = _.map(queryCache.getParents(), function (record) {
+      return record[primaryKeyColumnName]
+    })
+
+    async.each(
+      statements.childStatements,
+      function (template, next) {
+        // Handle IN queries
+        if (template.queryType === 'in') {
+          const inClause = _.pullAt(
+            template.statement.where.and,
+            template.statement.where.and.length - 1
+          )
+          const clause = _.first(inClause)
+          _.each(clause, function (val) {
+            val.in = parentKeys
+          })
+          template.statement.where.and.push(clause)
+        }
+
+        // Handle UNION queries with special case for per-entity pagination
+        if (template.queryType === 'union') {
+          const unionStatements = []
+          _.each(parentKeys, function (parentPk) {
+            const unionStatement = _.merge({}, template.statement)
+            const andClause = _.pullAt(
+              unionStatement.where.and,
+              unionStatement.where.and.length - 1
+            )
+            _.each(_.first(andClause), function (val, key) {
+              _.first(andClause)[key] = parentPk
+            })
+            unionStatement.where.and.push(_.first(andClause))
+            unionStatements.push(unionStatement)
+          })
+
+          if (unionStatements.length) {
+            // Check if this is per-entity pagination (has LIMIT/OFFSET)
+            const hasPerEntityPagination =
+              unionStatements[0].limit || unionStatements[0].skip
+
+            if (hasPerEntityPagination && unionStatements.length > 1) {
+              // SQLite-savvy approach: Execute separate queries for per-entity pagination
+              const allChildResults = []
+
+              _.each(unionStatements, function (singleStatement) {
+                const compiledQuery = compileStatement(singleStatement)
+                const stmt = db.prepare(compiledQuery.sql)
+                const results = stmt.all(...(compiledQuery.bindings || []))
+                allChildResults.push(...results)
+              })
+
+              // Extend cache with combined results
+              queryCache.extend(allChildResults, template.instructions)
+              return next()
+            } else {
+              // Standard UNION approach for non-pagination cases
+              template.statement = { unionAll: unionStatements }
+            }
+          }
+        }
+
+        if (!template.statement) {
+          return next()
+        }
+
+        // Run child query
+        const childCompiledQuery = compileStatement(template.statement)
+        const childStmt = db.prepare(childCompiledQuery.sql)
+        const childResults = childStmt.all(
+          ...(childCompiledQuery.bindings || [])
+        )
+
+        // Extend cache
+        queryCache.extend(childResults, template.instructions)
+        next()
+      },
+      function (err) {
+        if (hasReturned) return
+
+        if (err) {
+          hasReturned = true
+          return exits.error(err)
+        }
+
+        // Final combine and return
+        const combinedResults = queryCache.combineRecords() || []
+        const orm = { collections: models }
+        processEachRecord({
+          records: combinedResults,
+          identity: model.identity,
+          orm: orm
+        })
+        hasReturned = true
+        return exits.success(combinedResults)
+      }
+    )
   }
 }

package/lib/private/machines/lease-connection.js

@@ -0,0 +1,58 @@
+/**
+ * Module dependencies
+ */
+
+/**
+ * Lease Connection
+ *
+ * Get a dedicated connection from the datastore for use in transactions.
+ * For SQLite, this returns the same connection manager since SQLite is single-threaded.
+ */
+
+module.exports = {
+  friendlyName: 'Lease connection',
+
+  description:
+    'Get a dedicated connection from the datastore for use in transactions.',
+
+  moreInfoUrl:
+    'https://github.com/WiseLibs/better-sqlite3/blob/master/docs/api.md',
+
+  inputs: {
+    manager: {
+      description: 'The connection manager instance to get a connection from.',
+      example: '===',
+      required: true
+    },
+
+    meta: {
+      description: 'Additional options for this query.',
+      example: '==='
+    }
+  },
+
+  exits: {
+    failed: {
+      description: 'Could not get a connection to the database.'
+    },
+
+    success: {
+      description: 'A connection was successfully leased.',
+      outputExample: '==='
+    }
+  },
+
+  fn: function leaseConnection(inputs, exits) {
+    const manager = inputs.manager
+    const meta = inputs.meta || {}
+
+    try {
+      // For SQLite, the manager IS the database connection
+      // SQLite is single-threaded and doesn't support concurrent transactions
+      // The "connection" is actually the database instance
+      return exits.success(manager)
+    } catch (err) {
+      return exits.failed(err)
+    }
+  }
+}

package/lib/private/machines/parse-native-query-error.js

@@ -0,0 +1,90 @@
+module.exports = {
+  friendlyName: 'Parse native query error',
+
+  description:
+    'Attempt to identify and parse a raw error from sending a native query and normalize it into a standard error footprint.',
+
+  inputs: {
+    nativeQueryError: {
+      description:
+        'The error sent back from the database as a result of a native query.',
+      extendedDescription:
+        'Specifically, this is the Error returned from sendNativeQuery().',
+      example: '===',
+      required: true
+    },
+
+    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 error was parsed successfully.',
+      outputVariableName: 'report',
+      outputDescription:
+        'The `footprint` property is the normalized "footprint" dictionary representing the provided error.',
+      outputExample: '==='
+    },
+
+    malformed: {
+      description:
+        'The provided error cannot be parsed (perhaps it was corrupted or otherwise incomplete).',
+      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: '==='
+    },
+
+    notUnique: {
+      description: 'A uniqueness constraint was violated.',
+      outputVariableName: 'report',
+      outputDescription:
+        'The `footprint` property contains details about the uniqueness error.',
+      outputExample: '==='
+    },
+
+    notFound: {
+      description: 'No record(s) found matching the specified criteria.',
+      outputVariableName: 'report',
+      outputDescription:
+        'The `footprint` property contains details about the not found error.',
+      outputExample: '==='
+    }
+  },
+
+  fn: function parseNativeQueryError(inputs, exits) {
+    try {
+      const err = inputs.nativeQueryError
+      const footprint = {
+        identity: 'unknown',
+        error: err,
+        raw: err
+      }
+
+      if (err.code === 'SQLITE_CONSTRAINT') {
+        if (err.message && err.message.includes('UNIQUE')) {
+          return exits.notUnique({
+            footprint: footprint,
+            meta: inputs.meta
+          })
+        }
+      }
+
+      return exits.success({
+        footprint: footprint,
+        meta: inputs.meta
+      })
+    } catch (err) {
+      return exits.malformed({
+        error: err,
+        meta: inputs.meta
+      })
+    }
+  }
+}

package/lib/private/machines/parse-native-query-result.js

@@ -0,0 +1,59 @@
+module.exports = {
+  friendlyName: 'Parse native query result',
+
+  description: 'Parse a raw result from a native query and normalize it.',
+
+  inputs: {
+    nativeQueryResult: {
+      description:
+        'The result data sent back from the the database as a result of a native query.',
+      extendedDescription:
+        'Specifically, this is the `result` returned by sendNativeQuery().',
+      example: '===',
+      required: true
+    },
+
+    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 result was parsed successfully.',
+      outputVariableName: 'report',
+      outputDescription:
+        'The `result` property is the parsed result. The `meta` property is reserved for custom driver-specific extensions.',
+      outputExample: '==='
+    },
+
+    couldNotParse: {
+      description:
+        'The provided result could not be parsed (it might be corrupted or in an unexpected format).',
+      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: '==='
+    }
+  },
+
+  fn: function parseNativeQueryResult(inputs, exits) {
+    try {
+      const result = inputs.nativeQueryResult
+
+      return exits.success({
+        result: result.rows || [],
+        meta: inputs.meta
+      })
+    } catch (err) {
+      return exits.couldNotParse({
+        error: err,
+        meta: inputs.meta
+      })
+    }
+  }
+}

package/lib/private/machines/private/build-sqlite-where-clause.js

@@ -11,8 +11,8 @@
  * @returns {String}            [SQLite WHERE clause]
  */
 module.exports = function buildSqliteWhereClause(whereClause, WLModel, meta) {
-  // Handle empty `where` clause.
-  if (Object.keys(whereClause).length === 0) {
+  // Handle null, undefined, or empty `where` clause.
+  if (!whereClause || Object.keys(whereClause).length === 0) {
     return ''
   }
 
@@ -57,14 +57,16 @@ function buildConstraint(columnName, constraint, WLModel, meta) {
     case 'in':
       return `${columnName} IN (${modifier.map(sqliteEscape).join(', ')})`
     case 'like':
+      // SQLite uses LIKE with % and _ wildcards (not REGEXP)
       let likePattern = modifier
-        .replace(/^%/, '.*')
-        .replace(/([^\\])%/g, '$1.*')
-        .replace(/\\%/g, '%')
-      likePattern = `^${likePattern}$`
-      let clause = `${columnName} REGEXP '${likePattern}'`
+      // Convert JavaScript-style wildcards to SQL LIKE wildcards if needed
+      if (!likePattern.includes('%') && !likePattern.includes('_')) {
+        // If no wildcards, assume they want contains behavior
+        likePattern = `%${likePattern}%`
+      }
+      let clause = `${columnName} LIKE '${likePattern.replace(/'/g, "''")}'`
       if (meta && meta.makeLikeModifierCaseInsensitive === true) {
-        clause = `LOWER(${columnName}) REGEXP '${likePattern.toLowerCase()}'`
+        clause = `LOWER(${columnName}) LIKE LOWER('${likePattern.replace(/'/g, "''")}')`
       }
       return clause
     default: