Dropped sync mode, made it really async-ish and simpler

Author: hoegaarden

README.md

@@ -15,22 +15,19 @@ var conn_info = {
   'user' : 'the_user_name' ,
 };
 
-// --- sync ----
-conn_info.password = pgPass(conn_info);
-// connect to postgresql server
 
 // ---- async ----
 pgPass(conn_info, function(pass){
-conn_info.password = pass;
+  conn_info.password = pass;
   // connect to postgresql server
 });
 ```
 
 ## Description
 
-This module tries to read the `~/.pgpass ` file (or the equivalent for windows systems). If the environment variable `PGPASSFILE` is set, this file is used instead. If everything goes right, the password from said file is returned (in syn mode) or given to the callback (async mode); if the password cannot be read `null` is returned or passed to the callback.
+This module tries to read the `~/.pgpass` file (or the equivalent for windows systems). If the environment variable `PGPASSFILE` is set, this file is used instead. If everything goes right, the password from said file is to the callback; if the password cannot be read `undefined` is passed to the callback.
 
-Cases where `null` is returned:
+Cases where `undefined` is returned:
 
 - the environment variable `PGPASSWORD` is set
 - the file cannot be read (wrong permissions, no such file, ...)

lib/helper.js

@@ -21,6 +21,7 @@ function isRegFile(mode) {
 
 var fieldNames = [ 'host', 'port', 'database', 'user', 'password' ];
 var nrOfFields = fieldNames.length;
+var passKey = fieldNames[ fieldNames.length -1 ];
 
 
 function warn() {
@@ -87,47 +88,54 @@ module.exports.usePgPass = function(stats, fname) {
     return true;
 };
 
-module.exports.read = function(input, cb) {
-    var isStream = (input instanceof Stream && input.readable === true);
-    var isBuffer = Buffer.isBuffer(input);
-    var results = [];
 
-    var func = isStream ? handleStream : (
-        isBuffer ? handleBuffer : handleString
-    );
+var matcher = module.exports.match = function(connInfo, entry) {
+    return fieldNames.slice(0, -1).reduce(function(prev, field, idx){
+        if (idx == 1) {
+            // the port
+            if ( Number( connInfo[field] || defaultPort ) === Number( entry[field] ) ) {
+                return prev && true;
+            }
+        }
+        return prev && (
+            entry[field] === '*' ||
+              entry[field] === connInfo[field]
+        );
+    }, true);
+};
 
-    return func(input);
 
-    function addLine(line) {
+module.exports.getPassword = function(connInfo, stream, cb) {
+    var pass;
+    var lineStream = stream.pipe(new Split());
+
+    function onLine(line) {
         var entry = parseLine(line);
-        if (entry && isValidEntry(entry)) {
-            results.push(entry);
+        if (entry && isValidEntry(entry) && matcher(connInfo, entry)) {
+            pass = entry[passKey];
+            lineStream.end(); // -> calles onEnd(), but pass is set now
         }
     }
 
-    function handleString(str) {
-        str.split(/\n\r?/).forEach(addLine);
-        if (typeof cb === 'function') {
-            cb(null, results);
-        }
-        return results;
-    }
+    var onEnd = function() {
+        cb(pass);
+    };
 
-    function handleBuffer(buf) {
-        return handleString(buf.toString());
-    }
+    var onErr = function(err) {
+        warn('WARNING: error on reading file: %s', err);
+        cb(undefined);
+    };
 
-    function handleStream(stream) {
-        stream.pipe(new Split())
-          .on('data', addLine)
-          .on('end', cb.bind(null, null, results))
-          .on('error', cb.bind(null, null, results)) // ignore errors
-        ;
+    stream.on('error', onErr);
+    lineStream
+        .on('data', onLine)
+        .on('end', onEnd)
+        .on('error', onErr)
+    ;
 
-        return null;
-    }
 };
 
+
 var parseLine = module.exports.parseLine = function(line) {
     if (line.length < 11 || line.match(/^\s+#/)) {
         return null;
@@ -220,40 +228,3 @@ var isValidEntry = module.exports.isValidEntry = function(entry){
     return true;
 };
 
-
-module.exports.getPassword = function(input, creds, add){
-    input = input || {};
-    creds = creds || [];
-
-    var matches = function(cred){
-        return fieldNames.slice(0, -1).reduce(function(prev, field, idx){
-            if (idx == 1) {
-                // the port
-                if ( Number( input[field] || defaultPort ) === Number( cred[field] ) ) {
-                    return prev && true;
-                }
-            }
-            return prev && (
-                cred[field] === '*' ||
-                  cred[field] === input[field]
-            );
-        }, true);
-    };
-
-    for (var credIdx = 0 ; credIdx < creds.length ; credIdx += 1) {
-        var cred = creds[credIdx];
-
-        if (matches(cred)) {
-            var name = fieldNames[ nrOfFields - 1 ];
-            var pass = cred[ name ];
-
-            if (add) {
-                input[ name ] = pass;
-            }
-
-            return pass;
-        }
-    }
-
-    return undefined;
-};

lib/index.js

@@ -5,47 +5,19 @@ var path = require('path')
   , helper = require( path.join(__dirname, 'helper.js') )
 ;
 
-function getPassword(file, conn, cb){
+
+module.exports.warnTo = helper.warnTo;
+
+module.exports = function(connInfo, cb) {
+    var file = helper.getFileName();
+    
     fs.stat(file, function(err, stat){
         if (err || !helper.usePgPass(stat, file)) {
             return cb(undefined);
         }
 
         var st = fs.createReadStream(file);
 
-        return helper.read(st, function(err, results){
-            return cb(helper.getPassword(conn, results));
-        });
+        helper.getPassword(connInfo, st, cb);
     });
-}
-
-function getPasswordSync(file, conn){
-    var stat;
-    try {
-        stat = fs.statSync(file);
-    } catch (x) {
-        return undefined;
-    }
-
-    if (!helper.usePgPass(stat, file)) {
-        return undefined;
-    }
-
-    var content = fs.readFileSync(file);
-    var results = helper.read(content);
-
-    return helper.getPassword(conn, results);
-}
-
-
-module.exports.warnTo = helper.warnTo;
-
-module.exports = function(conn, cb) {
-    var file = helper.getFileName();
-
-    if ('function' === typeof cb) {
-        return getPassword(file, conn, cb);
-    } else {
-        return getPasswordSync(file, conn);
-    }
-};
+};

test/helper.js

@@ -225,120 +225,60 @@ describe('#isValidEntry()', function(){
 });
 
 
-describe('#read()', function(){
-    var fileContent = [
-        'somehost:112233:somedb:someuser:somepass' ,
-        'otherhost:4:otherdb:other\\:user:' ,
-        'thirdhost:5:thirddb:thirduser:thirdpass'
-    ].join('\n');
-
-    it('should handle a string', function(){
-        var resReturn, resCb;
-
-        resReturn = helper.read(fileContent, function(err, res){
-            resCb = res;
-        });
-
-        assert.notEqual( resReturn, [] );
-        assert.deepEqual( resReturn, resCb );
-    });
-
-    it('should handle a buffer', function(){
-        var resReturn, resCb;
-        var buf = new Buffer(fileContent);
-
-        resReturn = helper.read(buf, function(err, res){
-            resCb = res;
-        });
-
-        assert.notEqual( resReturn, [] );
-        assert.deepEqual( resReturn, resCb );
-    });
-
-    it('should handle a stream', function(done){
-        var resReturn, resCb;
-        var stream = new Stream().queue(fileContent).end();
-
-        resReturn = helper.read(stream, function(err, res){
-            assert.equal(err, null);
-            assert.notEqual(res, null);
-            assert.notEqual(res, []);
-            done();
-        });
-
-        assert.equal( resReturn, null );
-    });
-
-});
 
 
 describe('#getPassword()', function(){
-    var creds = [
-        {
-            'host'     : 'host1' ,
-            'port'     : '100' ,
-            'database' : 'database1' ,
-            'user'     : 'user1' ,
-            'password' : 'thepassword1'
-        } , {
-            'host'     : '*' ,
-            'port'     : '*' ,
-            'database' : 'database2' ,
-            'user'     : '*' ,
-            'password' : 'thepassword2'
-        }
-    ];
+    var creds =
+        'host1:100:database1:user1:thepassword1' + '\n' +
+        '*:*:database2:*:thepassword2' + '\n'
+    ;
+
     var conn1 = {
         'host'     : 'host1' ,
         'port'     : 100 ,
         'database' : 'database1' ,
         'user'     : 'user1'
     };
-    var conn2 = {
-        'host'     : 'host2' ,
-        'database' : 'database2' ,
-        'user'     : 'user2'
-    };
     var conn3 = {
         'host'     : 'host3' ,
         'database' : 'database3' ,
         'user'     : 'user3'
     };
 
-    it('should return a password', function(){
-        var ret;
 
-        ret = helper.getPassword(conn1, creds);
-        assert.equal(ret, creds[0].password);
+    it('should not get password for non-matching conn_info', function(done){
+        var st = new Stream();
 
-        ret = helper.getPassword(conn2, creds);
-        assert.equal(ret, creds[1].password);
-    });
+        helper.getPassword(conn3, st, function(pass){
+            assert.deepEqual(pass, undefined);
+            done();
+        });
 
-    it('should not return and not fill in a password', function(){
-        var ret;
+        st.write(creds);
+        st.end();
+    });
 
-        ret = helper.getPassword(conn3, undefined, true);
-        assert(!ret);
-        assert(!conn3.password);
+    it('should get password for matching conn_info', function(done){
+        var st = new Stream();
 
-        ret = helper.getPassword(conn1, undefined, true);
-        assert(!ret);
-        assert(!conn1.password);
+        helper.getPassword(conn1, st, function(pass){
+            assert.notDeepEqual(pass, undefined);
+            done();
+        });
 
-        ret = helper.getPassword({}, creds, true);
-        assert(!ret);
+        st.write(creds);
+        st.end();
     });
 
-    it('should return and fill in a password', function(){
-        var ret;
+    it('should ignore no password on any error', function(done){
+        var st = new Stream();
 
-        ret = helper.getPassword(conn1, creds, true);
-        assert.equal(ret, creds[0].password);
-        assert.equal(conn1.password, creds[0].password);
+        helper.getPassword({}, st, function(pass){
+            assert.deepEqual(pass, undefined);
+            done();
+        });
 
-        ret = helper.getPassword(conn2, creds, true);
-        assert.equal(ret, creds[1].password);
-        assert.equal(conn2.password, creds[1].password);
+        st.emit('error', new Error('just some error'));
+        st.end();
     });
 });