More README

porsager · porsager · commit a19e436997fc · 2019-11-27T23:40:34.000+01:00
diff --git a/README.md b/README.md
@@ -37,9 +37,17 @@ const postgres = require('postgres/cjs')
 
 ## Connection options
 
+You can use either a postgres:// url connection string or the options to define your database connection properties.
+
 ```js
 
 const sql = postgres('postgres://user:pass@host:port/database', {
+  host        :             // or hostname
+  port        :             // Postgres server port
+  path        :             // unix socket path (usually /tmp)
+  database    :             // Database to connect to
+  username    :             // or username
+  password    :             // or password
   ssl         : false,      // True, or an object with options to tls.connect
   max         : 10,         // Max number of connections
   timeout     : 0,          // Idle connection timeout in seconds
@@ -130,7 +138,7 @@ sql.notify('news', JSON.stringify({ no: 'this', is: 'news' }))
 Due to the nature of sql and Postgres types various helpers are available to simplify queries.
 
 #### Object to row `row(Object, ...columns)`
-Sometimes the number of columns can be quite large, so typing out 
+Sometimes the number of columns can be quite large, so this is shorter.
 
 ```js
 
@@ -350,7 +358,7 @@ There are also the following errors specifically for this library.
 ##### MESSAGE_NOT_SUPPORTED
 > X (X) is not supported
 
-Whenever a mesage is received which is not supported by this library. Feel free to file an issue if you think something is missing.
+Whenever a message is received from Postgres which is not supported by this library. Feel free to file an issue if you think something is missing.
 
 ##### SASL_SIGNATURE_MISMATCH
 > Message type X not supported
diff --git a/cjs/bytes.js b/cjs/bytes.js
@@ -30,10 +30,6 @@ const b = {
     b.i = 5
     return b
   },
-  dec(x) {
-    b.i -= x
-    return b
-  },
   inc(x) {
     b.i += x
     return b
@@ -44,11 +40,7 @@ const b = {
     b.i += buffer.utf8Write(x, b.i, length)
     return b
   },
-  i16(x, i) {
-    if (i || i === 0) {
-      buffer.writeUInt16BE(x, i)
-      return b
-    }
+  i16(x) {
     fit(2)
     buffer.writeUInt16BE(x, b.i)
     b.i += 2
@@ -70,12 +62,6 @@ const b = {
     b.i += x
     return b
   },
-  push(x) {
-    fit(x.length)
-    x.copy(buffer, b.i)
-    b.i += x.length
-    return b
-  },
   end(at = 1) {
     buffer.writeUInt32BE(b.i - at, at)
     const out = buffer.slice(0, b.i)
diff --git a/cjs/connection.js b/cjs/connection.js
@@ -34,6 +34,7 @@ module.exports = function Connection(options = {}) {
   })
 
   const backend = Backend({
+    onparse,
     onparameter,
     transform,
     parsers,
@@ -47,6 +48,11 @@ module.exports = function Connection(options = {}) {
 
   return connection
 
+  function onparse() {
+    if (backend.query && backend.query.statement.name)
+      statements[backend.query.statement.sig] = backend.query.statement.name
+  }
+
   function onauth(type, x) {
     socket.write(frontend.auth(type, x, options))
   }
@@ -94,9 +100,11 @@ module.exports = function Connection(options = {}) {
       ? queries.push(query)
       : (backend.query = query)
 
-    const buffer = statements.has(sig)
-      ? prepared(statements.get(sig), args, query)
-      : prepare(sig, str, args, query)
+    const buffer = query.simple
+      ? frontend.Query(str)
+      : statements.has(sig)
+        ? prepared(statements.get(sig), args, query)
+        : prepare(sig, str, args, query)
 
     connection.ready
       ? socket.write(buffer)
@@ -109,8 +117,7 @@ module.exports = function Connection(options = {}) {
   }
 
   function prepare(sig, str, args, query) {
-    query.statement = { name: sig ? 'p' + id++ : '' }
-    sig && statements.set(sig, query.statement)
+    query.statement = { name: sig ? 'p' + id++ : '', sig }
     return Buffer.concat([
       frontend.Parse(query.statement.name, str, args),
       frontend.Bind(query.statement.name, args)
@@ -133,6 +140,7 @@ module.exports = function Connection(options = {}) {
       messages.forEach(socket.write)
       messages = []
       connection.ready = true
+      connection.onconnect && connection.onconnect()
     }
   }
 
@@ -161,8 +169,8 @@ module.exports = function Connection(options = {}) {
     connection.ready = connection.active = false
   }
 
-  function unknown(buffer) {
-    // console.log('Unknown Message', buffer[0])
+  function unknown() {
+    // console.log('Unknown Message', x[0])
   }
 }
 
@@ -174,18 +182,15 @@ function postgresSocket(options, {
 }) {
   let socket
   let closed = true
-  let ended = false
 
   return {
     ready: false,
     write: x => socket.write(x),
     destroy: () => {
-      ended = true
       socket.destroy()
       return Promise.resolve()
     },
     end: () => {
-      ended = true
       return new Promise(r => socket.end(r))
     },
     connect
diff --git a/cjs/frontend.js b/cjs/frontend.js
@@ -25,32 +25,13 @@ const authNames = {
 }
 
 const auths = {
-  2 : authNotImplemented,
-  3 : authNotImplemented,
+  3 : AuthenticationCleartextPassword,
   5 : AuthenticationMD5Password,
-  6 : authNotImplemented,
-  7 : authNotImplemented,
-  8 : authNotImplemented,
-  9 : authNotImplemented,
   10: SASL,
   11: SASLContinue,
   12: SASLFinal
 }
 
-const messages = {
-  B : 'Bind',
-  C : 'Close',
-  D : 'Describe',
-  E : 'Execute',
-  F : 'FunctionCall',
-  f : 'CopyFail',
-  H : 'Flush',
-  P : 'Parse',
-  p : 'PasswordMessage',
-  S : 'Sync',
-  Q : 'Query',
-  X : 'Terminate'
-}
 
 module.exports = {
   connect,
@@ -60,20 +41,6 @@ module.exports = {
   Query
 }
 
-/* Other messages
-
-  Close (C)
-  Describe (D)
-  Execute (F)
-  FunctionCall (F)
-  CopyFail (f)
-  Flush (H)
-  PasswordMessage (p)
-  Sync (S)
-  Terminate (X)
-
-*/
-
 function connect({ user, database, connection }) {
   return bytes
     .inc(4)
@@ -84,19 +51,27 @@ function connect({ user, database, connection }) {
       database,
       client_encoding: '\'utf-8\'',
       ...connection
-    }).filter(([k, v]) => v).map(([k, v]) => k + N + v).join(N))
+    }).filter(([, v]) => v).map(([k, v]) => k + N + v).join(N))
     .z(2)
     .end(0)
 }
 
 function auth(type, x, options) {
-  return auths[type](type, x, options) || ''
+  return (auths[type] || authNotImplemented)(type, x, options) || ''
+}
+
+function AuthenticationCleartextPassword(type, x, { pass }) {
+  return bytes
+    .p()
+    .str(pass)
+    .z(1)
+    .end()
 }
 
-function AuthenticationMD5Password(type, x, { user, password }) {
+function AuthenticationMD5Password(type, x, { user, pass }) {
   return bytes
     .p()
-    .str('md5' + md5(Buffer.concat([Buffer.from(md5(password + user)), x.slice(9)])))
+    .str('md5' + md5(Buffer.concat([Buffer.from(md5(pass + user)), x.slice(9)])))
     .z(1)
     .end()
 }
@@ -119,7 +94,7 @@ function SASLContinue(type, x, options) {
   const res = x.utf8Slice(9).split(',').reduce((acc, x) => (acc[x[0]] = x.slice(2), acc), {})
 
   const saltedPassword = crypto.pbkdf2Sync(
-    options.password,
+    options.pass,
     Buffer.from(res.s, 'base64'),
     parseInt(res.i), 32,
     'sha256'
@@ -139,7 +114,7 @@ function SASLContinue(type, x, options) {
 }
 
 function SASLFinal(type, x, options) {
-  if (x.utf8Slice(9).split(N, 1)[0].slice(2, -1) !== options.serverSignature) {
+  if (x.utf8Slice(9).split(N, 1)[0].slice(2) !== options.serverSignature) {
     throw errors.generic({
       message: 'The server did not return the correct signature',
       code: 'SASL_SIGNATURE_MISMATCH'
@@ -172,7 +147,7 @@ function Bind(name, args) {
     .i16(0)
     .i16(args.length)
 
-  args.forEach((x, i) => {
+  args.forEach(x => {
     if (x.value == null)
       return bytes.i32(0xFFFFFFFF)
 
diff --git a/cjs/index.js b/cjs/index.js
diff --git a/cjs/package.json b/cjs/package.json
