connection url parameters should be case insensitive #67

Author: gionatamettifogo

.husky/pre-commit

@@ -0,0 +1,5 @@
+bun install
+bun install --production
+bun .husky/pre-commit.js
+git add package.json
+git add bun.lockb

.husky/pre-commit.js

@@ -0,0 +1,16 @@
+//
+// pre-commit.js - update version in package.json with day of the year before checkin
+//
+
+const fs = require('fs')
+const path = require('path')
+
+const packagePath = path.join(__dirname, '../package.json')
+const package = require(packagePath)
+
+const yearStart = new Date('2024-01-01').getTime()
+const now = new Date().getTime()
+const dayOfYear = Math.floor((now - yearStart) / (1000 * 60 * 60 * 24))
+
+package.version = package.version.replace(/\.\d+$/, `.${dayOfYear}`)
+fs.writeFileSync(packagePath, JSON.stringify(package, null, 2))

bun.lockb

@@ -1,6 +1,6 @@
 {
   "name": "@sqlitecloud/drivers",
-  "version": "1.0.82",
+  "version": "1.0.103",
   "description": "SQLiteCloud drivers for Typescript/Javascript in edge, web and node clients",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -14,15 +14,16 @@
     "prettier": "prettier --write 'src/**/*'",
     "lint": "eslint ./src/ --fix && tsc --noEmit",
     "typedoc": "rm -rf ./docs/ && typedoc --out docs && typedoc --plugin typedoc-plugin-markdown --out docs/markdown",
-    "npmgui": "npx npm-gui@latest"
+    "npmgui": "npx npm-gui@latest",
+    "prepare": "husky"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/sqlitecloud/sqlitecloud-js.git"
   },
   "license": "MIT",
   "author": {
-    "name": "SQLiteCloud, Inc.",
+    "name": "SQLite Cloud, Inc.",
     "email": "support@sqlitecloud.io",
     "url": "https://sqlitecloud.io/"
   },
@@ -86,4 +87,4 @@
     "arrowParens": "avoid",
     "printWidth": 160
   }
-}
+}

package-lock.json

@@ -259,8 +259,29 @@ export function parseConnectionString(connectionString: string): SQLiteCloudConf
     const url = new URL(knownProtocolUrl)
     const options: { [key: string]: string } = {}
 
+    // properties that are mixed case in the connection string should be accepted even if the
+    // customer mistakenly write them in camelCase or kebab-case or whateverTheCase
+    const mixedCaseProperties = [
+      'connectionString',
+      'passwordHashed',
+      'apiKey',
+      'createDatabase',
+      'dbMemory',
+      'compression',
+      'noBlob',
+      'maxData',
+      'maxRows',
+      'maxRowset',
+      'tlsOptions',
+      'useWebsocket',
+      'gatewayUrl',
+      'clientId'
+    ]
+
     url.searchParams.forEach((value, key) => {
-      options[key] = value
+      let normalizedKey = key.toLowerCase().replaceAll('-', '').replaceAll('_', '')
+      const mixedCaseKey = mixedCaseProperties.find(mixedCaseProperty => mixedCaseProperty.toLowerCase() == normalizedKey)
+      options[mixedCaseKey || normalizedKey] = value
     })
 
     const config: SQLiteCloudConfig = {

package.json

@@ -12,6 +12,7 @@ import { SQLiteCloudTlsConnection } from '../src/drivers/connection-tls'
 import { SQLiteCloudWebsocketConnection } from '../src/drivers/connection-ws'
 
 import { SQLiteCloudConnection, SQLiteCloudRowset } from '../src'
+import { expect } from '@jest/globals'
 import * as dotenv from 'dotenv'
 dotenv.config()
 

src/drivers/utilities.ts

@@ -6,6 +6,8 @@ import { SQLiteCloudError } from '../src/index'
 import { prepareSql, parseConnectionString } from '../src/drivers/utilities'
 import { getTestingDatabaseName } from './shared'
 
+import { expect, describe, it } from '@jest/globals'
+
 describe('prepareSql', () => {
   it('should replace single ? parameter', () => {
     const sql = prepareSql('SELECT * FROM users WHERE name = ?', 'John')
@@ -115,6 +117,38 @@ describe('parseConnectionString', () => {
     })
   })
 
+  it('should parse options regardless of case', () => {
+    const connectionString1 = 'sqlitecloud://host?apiKey=xxx'
+    const config1 = parseConnectionString(connectionString1)
+    expect(config1).toEqual({
+      host: 'host',
+      apiKey: 'xxx'
+    })
+
+    const connectionString2 = 'sqlitecloud://host?apikey=yyy'
+    const config2 = parseConnectionString(connectionString2)
+    expect(config2).toEqual({
+      host: 'host',
+      apiKey: 'yyy'
+    })
+
+    const connectionString3 = 'sqlitecloud://host?api_key=yyy&no_blob=true'
+    const config3 = parseConnectionString(connectionString3)
+    expect(config3).toEqual({
+      host: 'host',
+      apiKey: 'yyy',
+      noBlob: 'true' // only parsing here, validation is later in validateConfiguration
+    })
+
+    const connectionString4 = 'sqlitecloud://host?api-key=yyy&max-rows=42'
+    const config4 = parseConnectionString(connectionString4)
+    expect(config4).toEqual({
+      host: 'host',
+      apiKey: 'yyy',
+      maxRows: '42' // only parsing here, validation is later in validateConfiguration
+    })
+  })
+
   it('should parse connection string without port', () => {
     const connectionString = 'sqlitecloud://user:password@host'
     const config = parseConnectionString(connectionString)