@cap-js/sqlite 1.3.1 → 1.5.0

package/CHANGELOG.md

@@ -1,10 +1,45 @@
-# Change Log
+# Changelog
 
 - All notable changes to this project are documented in this file.
 - The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - This project adheres to [Semantic Versioning](http://semver.org/).
 
-## Version 1.3.1 - 2023-10-10
+## [1.5.0](https://github.com/cap-js/cds-dbs/compare/sqlite-v1.4.0...sqlite-v1.5.0) (2024-02-02)
+
+
+### Added
+
+* SELECT returns LargeBinaries as streams unless feature flag "stream_compat" is set ([#251](https://github.com/cap-js/cds-dbs/issues/251)) ([8165a4a](https://github.com/cap-js/cds-dbs/commit/8165a4a3f6bb21c970668c8873f9d9c662b43780))
+* Support Readable Streams inside INSERT.entries ([#343](https://github.com/cap-js/cds-dbs/issues/343)) ([f6faf89](https://github.com/cap-js/cds-dbs/commit/f6faf8955b7888479c66f1727ade65b382611c2f))
+
+
+### Fixed
+
+* config in streaming test with compat flag ([#412](https://github.com/cap-js/cds-dbs/issues/412)) ([335a178](https://github.com/cap-js/cds-dbs/commit/335a1785e216b581759f75154fef7b1b43e6ca17))
+* Do not generate UUIDs for association keys ([#398](https://github.com/cap-js/cds-dbs/issues/398)) ([9970e14](https://github.com/cap-js/cds-dbs/commit/9970e14352679711a9c60807608becff05151fc4))
+* make @cap-js/sqlite work with better-sqlite3@9.3.0 ([#422](https://github.com/cap-js/cds-dbs/issues/422)) ([44c0a59](https://github.com/cap-js/cds-dbs/commit/44c0a59277b14be0b81b7f80555e18377ddbfe3c))
+* sqlite date string compatibility parsing only for valid dates ([#410](https://github.com/cap-js/cds-dbs/issues/410)) ([2a8bb2d](https://github.com/cap-js/cds-dbs/commit/2a8bb2d60940760c6280d8cc06100cb9087194b5)), closes [#409](https://github.com/cap-js/cds-dbs/issues/409)
+* UPSERT for @cap-js/hana for entities with multiple keys ([#418](https://github.com/cap-js/cds-dbs/issues/418)) ([9bbac6e](https://github.com/cap-js/cds-dbs/commit/9bbac6ebbbddfa2f620833ce195eedeb0a79f43e))
+
+## [1.4.0](https://github.com/cap-js/cds-dbs/compare/sqlite-v1.3.1...sqlite-v1.4.0) (2023-11-20)
+
+
+### Added
+
+* **temporal data:** add time slice key to conflict clause ([#249](https://github.com/cap-js/cds-dbs/issues/249)) ([67b8edf](https://github.com/cap-js/cds-dbs/commit/67b8edf9b7f6b0fbab0010d7c93ed03a01e103ed))
+
+
+### Fixed
+
+* align time function behavior ([#322](https://github.com/cap-js/cds-dbs/issues/322)) ([c3ab40a](https://github.com/cap-js/cds-dbs/commit/c3ab40a007c105465349dd2f612178367b8e713a))
+* date functions with null value ([#347](https://github.com/cap-js/cds-dbs/issues/347)) ([bdc8967](https://github.com/cap-js/cds-dbs/commit/bdc8967f07276acdb249dec42231d432e132e0d4))
+
+
+### Changed
+
+* upgrade to better-sqlite@9 ([#334](https://github.com/cap-js/cds-dbs/issues/334)) ([5184e41](https://github.com/cap-js/cds-dbs/commit/5184e4155ccd1a2945a1fc033204e24425d70341))
+
+## [1.3.1](https://github.com/cap-js/cds-dbs/compare/v1.3.0...v1.3.1) (2023-10-10)
 
 ### Changed
 
@@ -12,7 +47,7 @@
 
 ## Version 1.3.0 - 2023-10-06
 
-### Fixed 
+### Fixed
 
 - `CURRENT_TIMESTAMP` in view definition preserves the timezone. #254 
 

package/README.md

@@ -14,7 +14,6 @@ npm add @cap-js/sqlite -D
 
 Learn more about setup and usage in the [respective database guide](https://cap.cloud.sap/docs/guides/databases-sqlite).
 
-
 ## Support
 
 This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/cap-js/cds-dbs/issues).
@@ -23,6 +22,11 @@ This project is open to feature requests/suggestions, bug reports etc. via [GitH
 
 Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
 
+## Versioning
+
+This library follows [Semantic Versioning](https://semver.org/).
+All notable changes are documented in [CHANGELOG.md](CHANGELOG.md).
+
 ## Code of Conduct
 
 We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](CODE_OF_CONDUCT.md) at all times.

package/lib/SQLiteService.js

@@ -1,23 +1,42 @@
 const { SQLService } = require('@cap-js/db-service')
-const { Readable } = require('stream')
 const cds = require('@sap/cds/lib')
 const sqlite = require('better-sqlite3')
 const $session = Symbol('dbc.session')
 const convStrm = require('stream/consumers')
+const { Readable } = require('stream')
 
 class SQLiteService extends SQLService {
+  init() {
+    return super.init(...arguments)
+  }
+
   get factory() {
     return {
       options: { max: 1, ...this.options.pool },
       create: tenant => {
         const database = this.url4(tenant)
         const dbc = new sqlite(database)
+
+        const deterministic = { deterministic: true }
         dbc.function('session_context', key => dbc[$session][key])
-        dbc.function('regexp', { deterministic: true }, (re, x) => (RegExp(re).test(x) ? 1 : 0))
-        dbc.function('ISO', { deterministic: true }, d => d && new Date(d).toISOString())
-        dbc.function('json_merge', { varargs: true, deterministic: true }, (...args) =>
-          args.join('').replace(/}{/g, ','),
-        )
+        dbc.function('regexp', deterministic, (re, x) => (RegExp(re).test(x) ? 1 : 0))
+        dbc.function('ISO', deterministic, d => d && new Date(d).toISOString())
+
+        // define date and time functions in js to allow for throwing errors
+        const isTime = /^\d{1,2}:\d{1,2}:\d{1,2}$/
+        const hasTimezone = /([+-]\d{1,2}:?\d{0,2}|Z)$/
+        const toDate = (d, allowTime = false) => {
+          const date = new Date(allowTime && isTime.test(d) ? `1970-01-01T${d}Z` : hasTimezone.test(d) ? d : d + 'Z')
+          if (Number.isNaN(date.getTime())) throw new Error(`Value does not contain a valid ${allowTime ? 'time' : 'date'} "${d}"`)
+          return date
+        }
+        dbc.function('year', deterministic, d => d === null ? null : toDate(d).getUTCFullYear())
+        dbc.function('month', deterministic, d => d === null ? null : toDate(d).getUTCMonth() + 1)
+        dbc.function('day', deterministic, d => d === null ? null : toDate(d).getUTCDate())
+        dbc.function('hour', deterministic, d => d === null ? null : toDate(d, true).getUTCHours())
+        dbc.function('minute', deterministic, d => d === null ? null : toDate(d, true).getUTCMinutes())
+        dbc.function('second', deterministic, d => d === null ? null : toDate(d, true).getUTCSeconds())
+
         if (!dbc.memory) dbc.pragma('journal_mode = WAL')
         return dbc
       },
@@ -62,13 +81,11 @@ class SQLiteService extends SQLService {
   async _run(stmt, binding_params) {
     for (let i = 0; i < binding_params.length; i++) {
       const val = binding_params[i]
+      if (val instanceof Readable) {
+        binding_params[i] = await convStrm[val.type === 'json' ? 'text' : 'buffer'](val)
+      }
       if (Buffer.isBuffer(val)) {
-        binding_params[i] = Buffer.from(val.base64Slice())
-      } else if (typeof val === 'object' && val && val.pipe) {
-        // REVISIT: stream.setEncoding('base64') sometimes misses the last bytes
-        // if (val.type === 'binary') val.setEncoding('base64')
-        binding_params[i] = await convStrm.buffer(val)
-        if (val.type === 'binary') binding_params[i] = Buffer.from(binding_params[i].toString('base64'))
+        binding_params[i] = Buffer.from(val.toString('base64'))
       }
     }
     return stmt.run(binding_params)
@@ -94,36 +111,25 @@ class SQLiteService extends SQLService {
     yield ']'
   }
 
-  async _stream(stmt, binding_params, one) {
-    const columns = stmt.columns()
-    // Stream single blob column
-    if (columns.length === 1 && columns[0].name !== '_json_') {
-      // Setting result set to raw to keep better-sqlite from doing additional processing
-      stmt.raw(true)
-      const rows = stmt.all(binding_params)
-      // REVISIT: return undefined when no rows are found
-      if (rows.length === 0) return undefined
-      if (rows[0][0] === null) return null
-      // Buffer.from only applies encoding when the input is a string
-      let raw = Buffer.from(rows[0][0].toString(), 'base64')
-      stmt.raw(false)
-      return new Readable({
-        read(size) {
-          if (raw.length === 0) return this.push(null)
-          const chunk = raw.slice(0, size)
-          raw = raw.slice(size)
-          this.push(chunk)
-        },
-      })
-    }
+  exec(sql) {
+    return this.dbc.exec(sql)
+  }
 
-    stmt.raw(true)
-    const rs = stmt.iterate(binding_params)
-    return Readable.from(this._iterator(rs, one))
+  _prepareStreams(values) {
+    let any
+    values.forEach((v, i) => {
+      if (v instanceof Readable) {
+        any = values[i] = convStrm.buffer(v)
+      }
+    })
+    return any ? Promise.all(values) : values
   }
 
-  exec(sql) {
-    return this.dbc.exec(sql)
+  async onSIMPLE({ query, data }) {
+    const { sql, values } = this.cqn2sql(query, data)
+    let ps = await this.prepare(sql)
+    const vals = await this._prepareStreams(values)
+    return (await ps.run(vals)).changes
   }
 
   onPlainSQL({ query, data }, next) {
@@ -154,8 +160,14 @@ class SQLiteService extends SQLService {
     }
 
     val(v) {
+      if (Buffer.isBuffer(v.val)) v.val = v.val.toString('base64')
       // intercept DateTime values and convert to Date objects to compare ISO Strings
-      if (/\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[Z+-]/.test(v.val)) v.val = new Date(v.val)
+      else if (/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(.\d{1,9})?(Z|[+-]\d{2}(:?\d{2})?)$/.test(v.val)) {
+        const date = new Date(v.val)
+        if (!Number.isNaN(date.getTime())) {
+          v.val = date
+        }
+      }
       return super.val(v)
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js/sqlite",
-  "version": "1.3.1",
+  "version": "1.5.0",
   "description": "CDS database service for SQLite",
   "homepage": "https://github.com/cap-js/cds-dbs/tree/main/sqlite#cds-database-service-for-sqlite",
   "repository": {
@@ -30,11 +30,11 @@
     "test": "jest --silent"
   },
   "dependencies": {
-    "@cap-js/db-service": "^1.3.1",
-    "better-sqlite3": "^8"
+    "@cap-js/db-service": "^1.6.0",
+    "better-sqlite3": "^9.3.0"
   },
   "peerDependencies": {
-    "@sap/cds": ">=7"
+    "@sap/cds": ">=7.6"
   },
   "cds": {
     "requires": {