Adding ?apiKey= to connection string #66

gionatamettifogo · gionatamettifogo · commit 9316ec579326 · 2024-03-11T13:21:59.000+01:00
diff --git a/.env.example b/.env.example
@@ -2,5 +2,8 @@
 # chinook database used in non-destructive tests
 CHINOOK_DATABASE_URL="sqlitecloud://user:password@xxx.sqlite.cloud:8860/chinook.sqlite"
 
+# api key used to test login w/o username and password
+CHINOOK_API_KEY=xxxxxx
+
 # sqlite cloud gateway for socket.io connections
 GATEWAY_URL=ws://localhost:4000
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@sqlitecloud/drivers",
-  "version": "0.0.56",
+  "version": "0.0.57",
   "description": "SQLiteCloud drivers for Typescript/Javascript in edge, web and node clients",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
diff --git a/scripts/gateway-build.sh b/scripts/gateway-build.sh
diff --git a/scripts/gateway-upgrade.sh b/scripts/gateway-upgrade.sh
diff --git a/scripts/sqlitecloud-cli b/scripts/sqlitecloud-cli
diff --git a/src/drivers/types.ts b/src/drivers/types.ts
@@ -20,6 +20,8 @@ export interface SQLiteCloudConfig {
   password?: string
   /** True if password is hashed, default is false */
   passwordHashed?: boolean
+  /** API key can be provided instead of username and password */
+  apiKey?: string
 
   /** Host name is required unless connectionString is provided, eg: xxx.sqlitecloud.io */
   host?: string
diff --git a/src/drivers/utilities.ts b/src/drivers/utilities.ts
@@ -36,7 +36,13 @@ export function anonimizeError(error: Error): Error {
 /** Initialization commands sent to database when connection is established */
 export function getInitializationCommands(config: SQLiteCloudConfig): string {
   // first user authentication, then all other commands
-  let commands = `AUTH USER ${config.username || ''} ${config.passwordHashed ? 'HASH' : 'PASSWORD'} ${config.password || ''}; `
+  let commands = ''
+
+  if (config.apiKey) {
+    commands = `AUTH APIKEY ${config.apiKey}; `
+  } else {
+    commands = `AUTH USER ${config.username || ''} ${config.passwordHashed ? 'HASH' : 'PASSWORD'} ${config.password || ''}; `
+  }
 
   if (config.database) {
     if (config.createDatabase && !config.dbMemory) {
@@ -192,23 +198,32 @@ export function validateConfiguration(config: SQLiteCloudConfig): SQLiteCloudCon
   config.nonlinearizable = parseBoolean(config.nonlinearizable)
   config.insecure = parseBoolean(config.insecure)
 
-  if (!config.username || !config.password || !config.host) {
+  const hasCredentials = (config.username && config.password) || config.apiKey
+  if (!config.host || !hasCredentials) {
     console.error('SQLiteCloudConnection.validateConfiguration - missing arguments', config)
-    throw new SQLiteCloudError('The user, password and host arguments must be specified.', { errorCode: 'ERR_MISSING_ARGS' })
+    throw new SQLiteCloudError('The user, password and host arguments or the ?apiKey= must be specified.', { errorCode: 'ERR_MISSING_ARGS' })
   }
 
   if (!config.connectionString) {
     // build connection string from configuration, values are already validated
     // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-    config.connectionString = `sqlitecloud://${encodeURIComponent(config.username)}:${encodeURIComponent(config.password)}@${config.host}:${config.port}/${
-      config.database
-    }`
+    if (config.apiKey) {
+      config.connectionString = `sqlitecloud://${config.host}:${config.port}/${config.database || ''}?apiKey=${config.apiKey}`
+    } else {
+      config.connectionString = `sqlitecloud://${encodeURIComponent(config.username || '')}:${encodeURIComponent(config.password || '')}@${config.host}:${
+        config.port
+      }/${config.database}`
+    }
   }
 
   return config
 }
 
-/** Parse connectionString like sqlitecloud://username:password@host:port/database?option1=xxx&option2=xxx into its components */
+/**
+ * Parse connectionString like sqlitecloud://username:password@host:port/database?option1=xxx&option2=xxx
+ * or sqlitecloud://host.sqlite.cloud:8860/chinook.sqlite?apiKey=mIiLARzKm9XBVllbAzkB1wqrgijJ3Gx0X5z1Agm3xBo
+ * into its basic components.
+ */
 export function parseConnectionString(connectionString: string): SQLiteCloudConfig {
   try {
     // The URL constructor throws a TypeError if the URL is not valid.
@@ -232,6 +247,15 @@ export function parseConnectionString(connectionString: string): SQLiteCloudConf
       ...options
     }
 
+    // either you use an apiKey or username and password
+    if (config.apiKey) {
+      if (config.username || config.password) {
+        console.warn('SQLiteCloudConnection.parseConnectionString - apiKey and username/password are both specified, using apiKey')
+      }
+      delete config.username
+      delete config.password
+    }
+
     const database = url.pathname.replace('/', '') // pathname is database name, remove the leading slash
     if (database) {
       config.database = database
diff --git a/test/connection-tls.test.ts b/test/connection-tls.test.ts
@@ -12,6 +12,7 @@ import {
   LONG_TIMEOUT,
   getTestingConfig,
   getChinookConfig,
+  getChinookApiKeyUrl,
   getChinookTlsConnection,
   sendCommandsAsync,
   // clearTestingDatabasesAsync,
@@ -74,6 +75,32 @@ describe('connection-tls', () => {
       LONG_TIMEOUT
     )
 
+    it(
+      'should connect using api key',
+      done => {
+        try {
+          // eg: sqlitecloud://mIiLARzKm9XBVllbAzkB1wqrgijJ3Gx0X5z1Agm3xBo@host.sqlite.cloud:8860/chinook.sqlite
+          const connectionUrl = getChinookApiKeyUrl()
+          const connection = new SQLiteCloudTlsConnection(connectionUrl, error => {
+            expect(error).toBeNull()
+            expect(connection.connected).toBe(true)
+
+            connection.sendCommands('TEST STRING', (error, results) => {
+              connection.close()
+              expect(connection.connected).toBe(false)
+              done()
+            })
+          })
+          expect(connection).toBeDefined()
+        } catch (error) {
+          console.error(`An error occurred while connecting using api key: ${error}`)
+          debugger
+          throw error
+        }
+      },
+      LONG_TIMEOUT
+    )
+
     it('should connect with connection string', done => {
       // if (CHINOOK_DATABASE_URL.indexOf('localhost') > 0) {
       //   // skip this test when running locally since it requires a self-signed certificate
@@ -128,7 +155,7 @@ describe('connection-tls', () => {
         expect(error).toBeDefined()
         expect(error).toBeInstanceOf(SQLiteCloudError)
         const sqliteCloudError = error as SQLiteCloudError
-        expect(sqliteCloudError.message).toBe('The user, password and host arguments must be specified.')
+        expect(sqliteCloudError.message).toBe('The user, password and host arguments or the ?apiKey= must be specified.')
         expect(sqliteCloudError.errorCode).toBe('ERR_MISSING_ARGS')
         expect(sqliteCloudError.externalErrorCode).toBeUndefined()
         expect(sqliteCloudError.offsetCode).toBeUndefined()
@@ -524,7 +551,7 @@ describe('connection-tls', () => {
       chinook.sendCommands('LIST METADATA;', (error, results) => {
         expect(error).toBeNull()
         expect(results.numberOfColumns).toBe(8)
-        expect(results.numberOfRows).toBe(64)
+        expect(results.numberOfRows).toBeGreaterThanOrEqual(32)
 
         done()
         chinook.close()
@@ -594,7 +621,7 @@ describe('connection-tls', () => {
       chinook.sendCommands('SELECT * FROM tracks;', (error, results) => {
         expect(error).toBeNull()
         expect(results.numberOfColumns).toBe(9)
-        expect(results.numberOfRows).toBe(3503)
+        expect(results.numberOfRows).toBeGreaterThan(3000) // 3503 tracks but we sometimes test deleting rows
 
         done()
         chinook.close()
diff --git a/test/connection-ws.test.ts b/test/connection-ws.test.ts
@@ -306,7 +306,7 @@ describe('connection-ws', () => {
         chinook.sendCommands('LIST METADATA;', (error, results) => {
           expect(error).toBeNull()
           expect(results.numberOfColumns).toBe(8)
-          expect(results.numberOfRows).toBe(64)
+          expect(results.numberOfRows).toBeGreaterThanOrEqual(32)
           done()
         })
       })
@@ -363,7 +363,7 @@ describe('connection-ws', () => {
         chinook.sendCommands('SELECT * FROM tracks;', (error, results) => {
           expect(error).toBeNull()
           expect(results.numberOfColumns).toBe(9)
-          expect(results.numberOfRows).toBe(3503)
+          expect(results.numberOfRows).toBeGreaterThan(3000) // 3503 tracks but we sometimes test deleting rows
           done()
         })
       })
diff --git a/test/shared.ts b/test/shared.ts
@@ -34,6 +34,9 @@ if (!CHINOOK_DATABASE_URL || CHINOOK_DATABASE_URL.indexOf('/chinook.sqlite') ===
   throw new Error('CHINOOK_DATABASE_URL is not defined in .env file or is not a valid chinook.sqlite url')
 }
 
+// API key for chinook database used to test API key authentication
+export const CHINOOK_API_KEY = process.env.CHINOOK_API_KEY as string
+
 export const GATEWAY_URL = process.env.GATEWAY_URL as string
 expect(CHINOOK_DATABASE_URL).toBeDefined()
 expect(GATEWAY_URL).toBeDefined()
@@ -97,6 +100,15 @@ export function getChinookConfig(url = CHINOOK_DATABASE_URL, extraConfig?: Parti
   return chinookConfig
 }
 
+/** Returns a test connection url with an api key  */
+export function getChinookApiKeyUrl(): string {
+  const chinookConfig = getChinookConfig(CHINOOK_DATABASE_URL)
+  if (!CHINOOK_API_KEY) {
+    throw new Error('CHINOOK_API_KEY is not defined in .env file')
+  }
+  return `sqlitecloud://${chinookConfig.host}:${chinookConfig.port}/${chinookConfig.database || ''}?apiKey=${CHINOOK_API_KEY}`
+}
+
 /** Returns connection to chinook via websocket gateway */
 export function getChinookWebsocketConnection(callback?: ResultsCallback, extraConfig?: Partial<SQLiteCloudConfig>): SQLiteCloudConnection {
   let chinookConfig = getChinookConfig(CHINOOK_DATABASE_URL, extraConfig)
diff --git a/test/utilities.test.ts b/test/utilities.test.ts
@@ -174,6 +174,24 @@ describe('parseConnectionString', () => {
       database: 'database'
     })
   })
+
+  it('should parse connection with api key', () => {
+    const apiKey = 'mIiLARzKm9XBVllbAzkB1wqrgijJ3Gx0X5z1Agm3xBo'
+    const connectionString = `sqlitecloud://host:1234/database?apiKey=${apiKey}`
+    const config = parseConnectionString(connectionString)
+
+    expect(config.apiKey).toBe(apiKey)
+    expect(config.username).toBeUndefined()
+    expect(config.password).toBeUndefined()
+    expect(config.passwordHashed).toBeUndefined()
+
+    expect(config).toEqual({
+      apiKey,
+      host: 'host',
+      port: 1234,
+      database: 'database'
+    })
+  })
 })
 
 describe('getTestingDatabaseName', () => {

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@sqlitecloud/drivers",`
`3`		`- "version": "0.0.56",`
	`3`	`+ "version": "0.0.57",`
`4`	`4`	`"description": "SQLiteCloud drivers for Typescript/Javascript in edge, web and node clients",`
`5`	`5`	`"main": "./lib/index.js",`
`6`	`6`	`"types": "./lib/index.d.ts",`