Merge pull request #9 from CartoDB/v2.x-carto-fix-interspersed-messages

Fix for interspersed messages

.npmignore

@@ -0,0 +1,4 @@
+.gitignore
+.travis.yml
+bench/
+test/

.travis.yml

@@ -1,12 +1,9 @@
 language: node_js
 node_js:
-  - "0.12"
-  - "4"
-  - "5"
   - "6"
-
-addons:
-  postgresql: "9.2"
+  - "8"
+  - "10"
+  - "11"
 
 services:
   - postgresql

Makefile

@@ -12,3 +12,8 @@ minor: test
 	npm version minor -m "Bump version"
 	git push origin master --tags
 	npm publish
+
+major: test
+	npm version major -m "Bump version"
+	git push origin master --tags
+	npm publish

NEWS.carto.md

@@ -0,0 +1,34 @@
+# CARTO's Changelog
+
+## v2.2.0-carto.1
+Released 2019-mm-dd
+
+Bug fixes:
+ * Copy to: ensure stream is detached when finished
+ * Copy to: deal with interspersed messages properly. See [#9](https://github.com/CartoDB/node-pg-copy-streams/pull/9)
+
+## v1.2.0-carto.3
+Released 2018-11-21
+
+Features:
+ * Drop support for Node.js 0.12, 4 and, 5.
+ * Add support for Node.js 8 and 10.
+ * Add package-lock.json
+ * Do not use deprecated Buffer constructors.
+
+## v1.2.0-carto.2
+Released 2018-10-26
+
+Bug fixes:
+ * Make all modules to use strict mode semantics.
+
+## v1.2.0-carto.1
+Released 2018-06-11
+
+Bug fixes:
+ * Improves performance of COPY TO by sending bigger chunks through low level `push()`. See https://github.com/CartoDB/node-pg-copy-streams/pull/1
+
+## v1.2.0
+Released 2016-08-22
+
+Vanilla version v1.2.0 from upstream repository. See https://github.com/CartoDB/node-pg-copy-streams/releases/tag/v1.2.0

README.md

@@ -20,10 +20,12 @@ If you're not familiar with the feature (I wasn't either) you can read this for
 ### pipe from a table to stdout
 
 ```js
-var pg = require('pg');
+var {Pool} = require('pg');
 var copyTo = require('pg-copy-streams').to;
 
-pg.connect(function(err, client, done) {
+var pool = new Pool();
+
+pool.connect(function(err, client, done) {
   var stream = client.query(copyTo('COPY my_table TO STDOUT'));
   stream.pipe(process.stdout);
   stream.on('end', done);
@@ -35,10 +37,12 @@ pg.connect(function(err, client, done) {
 
 ```js
 var fs = require('fs');
-var pg = require('pg');
+var {Pool} = require('pg');
 var copyFrom = require('pg-copy-streams').from;
 
-pg.connect(function(err, client, done) {
+var pool = new Pool();
+
+pool.connect(function(err, client, done) {
   var stream = client.query(copyFrom('COPY my_table FROM STDIN'));
   var fileStream = fs.createReadStream('some_file.tsv')
   fileStream.on('error', done);
@@ -66,6 +70,26 @@ Before you set out on this magical piping journey, you _really_ should read this
 Take note of the following warning in the PostgreSQL documentation:
 > COPY stops operation at the first error. This should not lead to problems in the event of a COPY TO, but the target table will already have received earlier rows in a COPY FROM. These rows will not be visible or accessible, but they still occupy disk space. This might amount to a considerable amount of wasted disk space if the failure happened well into a large copy operation. You might wish to invoke VACUUM to recover the wasted space.
 
+## benchmarks
+
+The COPY command is commonly used to move huge sets of data. This can put some pressure on the node.js loop, the amount of CPU or the amount of memory used.
+There is a bench/ directory in the repository where benchmark scripts are stored. If you have performance issues with `pg-copy-stream` do not hesitate to write a new benchmark that highlights your issue. Please avoid to commit huge files (PR won't be accepted) and find other ways to generate huge datasets.
+
+If you have a local instance of postgres on your machine, you can start a benchmark for example with
+
+```sh
+$ cd bench
+$ PGPORT=5432 PGDATABASE=postgres node copy-from.js
+```
+
+## tests
+
+In order to launch the test suite, you need to have a local instance of postgres running on your machine.
+
+```sh
+$ PGPORT=5432 PGDATABASE=postgres make test
+```
+
 ## contributing
 
 Instead of adding a bunch more code to the already bloated [node-postgres](https://github.com/brianc/node-postgres) I am trying to make the internals extensible and work on adding edge-case features as 3rd party modules.
@@ -79,6 +103,36 @@ Generally how I work is if you submit a few pull requests and you're interested
 
 Since this isn't a module with tons of installs and dependent modules I hope we can work together on this to iterate faster here and make something really useful.
 
+## changelog
+
+### version 2.x - published YYYY-MM-DD
+
+### version 2.2.0 - published YYYY-MM-DD
+
+ * Small refactor in copy-from passing from 3 push to 2 push in every chunk transform loop
+ * Add bench/ directory for benchmarks
+ * Add benchmark to compare performance of pg-copy-stream wrt psql during copy-from
+ * Add benchmark to measure memory usage of copy-from
+
+### version 2.1.0 - published 2019-03-19
+
+ * Change README to stop using the pg pool singleton (removed after pg 7.0)
+ * Do not register copy-to.pushBufferIfNeeded on the instance itself (avoid dangling method on the object)
+ * Fix copy-to test wrt intermittent unhandled promise bug
+ * Add tests regarding client re-use
+
+### version 2.0.0 - published 2019-03-14
+
+This version's major change is a modification in the COPY TO implementation. In the previous version, when a chunk was received from the database, it was analyzed and every row contained within that chunk was pushed individually down the stream pipeline. Small rows could lead to a "one chunk" / "thousands of row pushed" performance issue in node. Thanks to @rafatower & CartoDB for the patch.
+This is considered to be a major change since some people could be relying on the fact that each outgoing chunk is an individual row.
+
+Other changes in this version
+ * Use Strict
+ * Travis deprecation of old node version (0.12, 0.4). Support LTS 6, 8, 10 and Current 11
+ * Update dev dependencies (pg, lodash)
+ * Stop using deprecated Buffer constructor
+ * Add package-lock.json
+
 ## license
 
 The MIT License (MIT)

bench/copy-from-memory.js

@@ -0,0 +1,45 @@
+var cp = require('duplex-child-process');
+var pg = require('pg')
+
+var copy = require('../').from
+
+var client = function() {
+  var client = new pg.Client()
+  client.connect()
+  return client
+}
+
+var inStream = function() {
+  return cp.spawn('seq', ['0', '29999999']);
+}
+
+var running = true;
+
+var c = client();
+c.query('DROP TABLE IF EXISTS plugnumber', function() {
+  c.query('CREATE TABLE plugnumber (num int)', function() {
+    var seq = inStream()
+    var from = c.query(copy('COPY plugnumber FROM STDIN'))
+    seq.pipe(from);
+    from.on('end', function() {
+      running = false;
+      c.end();
+    })
+  })
+})  
+
+
+var rssMin = process.memoryUsage().rss / 1024 / 1024
+var rssMax = rssMin
+
+memlog = function() {
+  var rss = process.memoryUsage().rss / 1024 / 1024
+  rssMin = Math.min(rss, rssMin)
+  rssMax = Math.max(rss, rssMax)
+  console.log('rss:' + Math.round(rss*100)/100 + 'MB rssMin:'+ Math.round(rssMin*100)/100 + 'MB rssMax:' + Math.round(rssMax*100)/100 + 'MB')
+  if (running) {
+    setTimeout(memlog, 1000);
+  }
+}
+
+memlog()

bench/copy-from.js

@@ -0,0 +1,86 @@
+var Benchmark = require('benchmark');
+var cp = require('duplex-child-process');
+var pg = require('pg')
+
+var copy = require('../').from
+
+var client = function() {
+  var client = new pg.Client()
+  client.connect()
+  return client
+}
+
+var psql = '/opt/postgresql-9.6.1/bin/psql'
+var limit = 999999;
+var inStream = function() {
+  return cp.spawn('seq', ['0', ''+limit]);
+}
+var suite = new Benchmark.Suite;
+suite
+.add({
+  name: 'unix pipe into psql COPY',
+  defer: true,
+  fn: function(d) {
+    var c = client();
+    c.query('DROP TABLE IF EXISTS plugnumber', function() {
+      c.query('CREATE TABLE plugnumber (num int)', function() {
+        c.end();
+        var from = cp.spawn('sh', ['-c', 'seq 0 '+limit+' | '+psql+' postgres -c \'COPY plugnumber FROM STDIN\''])
+        from.on('close', function() {
+          d.resolve();
+        })
+      })
+    })
+  }
+})
+.add({
+  name: 'pipe into psql COPY',
+  defer: true,
+  fn: function(d) {
+    var c = client();
+    c.query('DROP TABLE IF EXISTS plugnumber', function() {
+      c.query('CREATE TABLE plugnumber (num int)', function() {
+        c.end();
+        var seq = inStream();
+        var from = cp.spawn(psql, ['postgres', '-c', 'COPY plugnumber FROM STDIN'])
+        seq.pipe(from);
+        from.on('close', function() {
+          d.resolve();
+        })
+      })
+    })
+  }
+})
+.add({
+  name: 'pipe into pg-copy-stream COPY',
+  defer: true,
+  fn: function(d) {
+    var c = client();
+    c.query('DROP TABLE IF EXISTS plugnumber', function() {
+      c.query('CREATE TABLE plugnumber (num int)', function() {
+        var seq = inStream()
+        var from = c.query(copy('COPY plugnumber FROM STDIN'))
+        seq.pipe(from);
+        from.on('end', function() {
+          c.end();
+          d.resolve();
+        })
+      })
+    })
+  }
+})
+
+.on('cycle', function(event) {
+  console.log(String(event.target));
+})
+.on('complete', function() {
+  console.log('Fastest is ' + this.filter('fastest').map('name'));
+});
+
+
+var c = client()
+c.query('DROP TABLE IF EXISTS plugnumber', function() {
+  c.end();
+  suite.run();
+})
+

copy-to.js

@@ -1,3 +1,5 @@
+'use strict';
+
 module.exports = function(txt, options) {
   return new CopyStreamQuery(txt, options)
 }
@@ -21,6 +23,7 @@ CopyStreamQuery.prototype.submit = function(connection) {
   connection.query(this.text)
   this.connection = connection
   this.connection.removeAllListeners('copyData')
+  this.on('end', () => this._detach())
   connection.stream.pipe(this)
 }
 
@@ -42,6 +45,17 @@ CopyStreamQuery.prototype._transform = function(chunk, enc, cb) {
   var messageCode;
   var needPush = false;
 
+  var buffer = Buffer.alloc(chunk.length);
+  var buffer_offset = 0;
+
+  var self = this;
+  var pushBufferIfneeded = function() {
+    if (needPush && buffer_offset > 0) {
+      self.push(buffer.slice(0, buffer_offset))
+      buffer_offset = 0;
+    }
+  }
+
   while((chunk.length - offset) >= (Byte1Len + Int32Len)) {
     var messageCode = chunk[offset]
 
@@ -67,10 +81,10 @@ CopyStreamQuery.prototype._transform = function(chunk, enc, cb) {
       case code.NoticeResponse:
       case code.NotificationResponse:
         break;
-  
+
       case code.ErrorResponse:
       case code.CopyDone:
-        this._detach()
+        pushBufferIfneeded();
         this.push(null)
         return cb();
         break;
@@ -81,18 +95,28 @@ CopyStreamQuery.prototype._transform = function(chunk, enc, cb) {
     length = chunk.readUInt32BE(offset+Byte1Len)
     if(chunk.length >= (offset + Byte1Len + length)) {
       offset += Byte1Len + Int32Len
-      if (needPush) {
-        var row = chunk.slice(offset, offset + length - Int32Len)
-        this.rowCount++
-        this.push(row)
+      var message = chunk.slice(offset, offset + length - Int32Len)
+      switch(messageCode) {
+        case code.CopyData:
+          this.rowCount++;
+          message.copy(buffer, buffer_offset);
+          buffer_offset += message.length;
+          break;
+        case code.ParameterStatus:
+        case code.NoticeResponse:
+        case code.NotificationResponse:
+          this.emit('warning', 'Got an interspersed message: ' + message);
+          break;
       }
-      offset += (length - Int32Len)
+      offset += (length - Int32Len);
     } else {
       // we need more chunks for a complete message
       break;
     }
   }
 
+  pushBufferIfneeded();
+
   if(chunk.length - offset) {
     var slice = chunk.slice(offset)
     this._remainder = slice

index.js

@@ -1,3 +1,5 @@
+'use strict';
+
 var CopyToQueryStream = require('./copy-to')
 module.exports = {
   to: function(txt, options) {
@@ -28,12 +30,10 @@ CopyStreamQuery.prototype.submit = function(connection) {
 }
 
 
-var copyDataBuffer = Buffer([code.CopyData])
 CopyStreamQuery.prototype._transform = function(chunk, enc, cb) {
   var Int32Len = 4;
-  this.push(copyDataBuffer)
-  var lenBuffer = Buffer(Int32Len)
-  lenBuffer.writeUInt32BE(chunk.length + Int32Len, 0)
+  var lenBuffer = Buffer.from([code.CopyData, 0, 0, 0, 0])
+  lenBuffer.writeUInt32BE(chunk.length + Int32Len, 1)
   this.push(lenBuffer)
   this.push(chunk)
   cb()
@@ -41,7 +41,7 @@ CopyStreamQuery.prototype._transform = function(chunk, enc, cb) {
 
 CopyStreamQuery.prototype._flush = function(cb) {
   var Int32Len = 4;
-  var finBuffer = Buffer([code.CopyDone, 0, 0, 0, Int32Len])
+  var finBuffer = Buffer.from([code.CopyDone, 0, 0, 0, Int32Len])
   this.push(finBuffer)
   this.cb_flush = cb
 }

package-lock.json

@@ -0,0 +1,215 @@
+{
+  "name": "pg-copy-streams",
+  "version": "2.2.0",
+  "lockfileVersion": 1,
+  "requires": true,
+  "dependencies": {
+    "async": {
+      "version": "0.2.10",
+      "resolved": "https://registry.npmjs.org/async/-/async-0.2.10.tgz",
+      "integrity": "sha1-trvgsGdLnXGXCMo43owjfLUmw9E=",
+      "dev": true
+    },
+    "base64-js": {
+      "version": "0.0.2",
+      "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-0.0.2.tgz",
+      "integrity": "sha1-Ak8Pcq+iW3X5wO5zzU9V7Bvtl4Q=",
+      "dev": true
+    },
+    "benchmark": {
+      "version": "2.1.4",
+      "resolved": "https://registry.npmjs.org/benchmark/-/benchmark-2.1.4.tgz",
+      "integrity": "sha1-CfPeMckWQl1JjMLuVloOvzwqVik=",
+      "dev": true,
+      "requires": {
+        "lodash": "^4.17.4",
+        "platform": "^1.3.3"
+      }
+    },
+    "bops": {
+      "version": "0.0.6",
+      "resolved": "https://registry.npmjs.org/bops/-/bops-0.0.6.tgz",
+      "integrity": "sha1-CC0dVfoB5g29wuvC26N/ZZVUzzo=",
+      "dev": true,
+      "requires": {
+        "base64-js": "0.0.2",
+        "to-utf8": "0.0.1"
+      }
+    },
+    "buffer-writer": {
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/buffer-writer/-/buffer-writer-2.0.0.tgz",
+      "integrity": "sha512-a7ZpuTZU1TRtnwyCNW3I5dc0wWNC3VR9S++Ewyk2HHZdrO3CQJqSpd+95Us590V6AL7JqUAH2IwZ/398PmNFgw==",
+      "dev": true
+    },
+    "concat-stream": {
+      "version": "1.1.0",
+      "resolved": "https://registry.npmjs.org/concat-stream/-/concat-stream-1.1.0.tgz",
+      "integrity": "sha1-hCae/YzGUCdeMi8wnfRIZ7xRxfM=",
+      "dev": true,
+      "requires": {
+        "bops": "0.0.6"
+      }
+    },
+    "duplex-child-process": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/duplex-child-process/-/duplex-child-process-1.0.0.tgz",
+      "integrity": "sha1-SpSXQob7x4QNCFPSs/5ZCp20YUc=",
+      "dev": true
+    },
+    "gonna": {
+      "version": "0.0.0",
+      "resolved": "https://registry.npmjs.org/gonna/-/gonna-0.0.0.tgz",
+      "integrity": "sha1-6k4ZsVJ6F4LhJQVeMCSabUvHmlk=",
+      "dev": true
+    },
+    "heroku-env": {
+      "version": "0.1.1",
+      "resolved": "https://registry.npmjs.org/heroku-env/-/heroku-env-0.1.1.tgz",
+      "integrity": "sha1-wGeRyUTpuHSOMXf1S/cBQyZ+Yxc=",
+      "dev": true,
+      "requires": {
+        "parse-database-url": "~0.2.0"
+      }
+    },
+    "lodash": {
+      "version": "4.17.11",
+      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.11.tgz",
+      "integrity": "sha512-cQKh8igo5QUhZ7lg38DYWAxMvjSAKG0A8wGSVimP07SIUEK2UO+arSRKbRZWtelMtN5V0Hkwh5ryOto/SshYIg==",
+      "dev": true
+    },
+    "packet-reader": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/packet-reader/-/packet-reader-1.0.0.tgz",
+      "integrity": "sha512-HAKu/fG3HpHFO0AA8WE8q2g+gBJaZ9MG7fcKk+IJPLTGAD6Psw4443l+9DGRbOIh3/aXr7Phy0TjilYivJo5XQ==",
+      "dev": true
+    },
+    "parse-database-url": {
+      "version": "0.2.2",
+      "resolved": "https://registry.npmjs.org/parse-database-url/-/parse-database-url-0.2.2.tgz",
+      "integrity": "sha1-SGFa56fA/HfjKU0jVCpqUnPDVws=",
+      "dev": true
+    },
+    "pg": {
+      "version": "7.8.2",
+      "resolved": "https://registry.npmjs.org/pg/-/pg-7.8.2.tgz",
+      "integrity": "sha512-5U4fjV43DnQxelkhyPdU3YfUbYVa21bNmreXRCM/gFFw09YxWaitWWITm/u0twUNF5EYOSDhkgyEAocgtpP9JQ==",
+      "dev": true,
+      "requires": {
+        "buffer-writer": "2.0.0",
+        "packet-reader": "1.0.0",
+        "pg-connection-string": "0.1.3",
+        "pg-pool": "^2.0.4",
+        "pg-types": "~2.0.0",
+        "pgpass": "1.x",
+        "semver": "4.3.2"
+      }
+    },
+    "pg-connection-string": {
+      "version": "0.1.3",
+      "resolved": "https://registry.npmjs.org/pg-connection-string/-/pg-connection-string-0.1.3.tgz",
+      "integrity": "sha1-2hhHsglA5C7hSSvq9l1J2RskXfc=",
+      "dev": true
+    },
+    "pg-int8": {
+      "version": "1.0.1",
+      "resolved": "https://registry.npmjs.org/pg-int8/-/pg-int8-1.0.1.tgz",
+      "integrity": "sha512-WCtabS6t3c8SkpDBUlb1kjOs7l66xsGdKpIPZsg4wR+B3+u9UAum2odSsF9tnvxg80h4ZxLWMy4pRjOsFIqQpw==",
+      "dev": true
+    },
+    "pg-pool": {
+      "version": "2.0.6",
+      "resolved": "https://registry.npmjs.org/pg-pool/-/pg-pool-2.0.6.tgz",
+      "integrity": "sha512-hod2zYQxM8Gt482q+qONGTYcg/qVcV32VHVPtktbBJs0us3Dj7xibISw0BAAXVMCzt8A/jhfJvpZaxUlqtqs0g==",
+      "dev": true
+    },
+    "pg-types": {
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/pg-types/-/pg-types-2.0.0.tgz",
+      "integrity": "sha512-THUD7gQll5tys+5eQ8Rvs7DjHiIC3bLqixk3gMN9Hu8UrCBAOjf35FoI39rTGGc3lM2HU/R+Knpxvd11mCwOMA==",
+      "dev": true,
+      "requires": {
+        "pg-int8": "1.0.1",
+        "postgres-array": "~2.0.0",
+        "postgres-bytea": "~1.0.0",
+        "postgres-date": "~1.0.0",
+        "postgres-interval": "^1.1.0"
+      }
+    },
+    "pgpass": {
+      "version": "1.0.2",
+      "resolved": "https://registry.npmjs.org/pgpass/-/pgpass-1.0.2.tgz",
+      "integrity": "sha1-Knu0G2BltnkH6R2hsHwYR8h3swY=",
+      "dev": true,
+      "requires": {
+        "split": "^1.0.0"
+      }
+    },
+    "platform": {
+      "version": "1.3.5",
+      "resolved": "https://registry.npmjs.org/platform/-/platform-1.3.5.tgz",
+      "integrity": "sha512-TuvHS8AOIZNAlE77WUDiR4rySV/VMptyMfcfeoMgs4P8apaZM3JrnbzBiixKUv+XR6i+BXrQh8WAnjaSPFO65Q==",
+      "dev": true
+    },
+    "postgres-array": {
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/postgres-array/-/postgres-array-2.0.0.tgz",
+      "integrity": "sha512-VpZrUqU5A69eQyW2c5CA1jtLecCsN2U/bD6VilrFDWq5+5UIEVO7nazS3TEcHf1zuPYO/sqGvUvW62g86RXZuA==",
+      "dev": true
+    },
+    "postgres-bytea": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/postgres-bytea/-/postgres-bytea-1.0.0.tgz",
+      "integrity": "sha1-AntTPAqokOJtFy1Hz5zOzFIazTU=",
+      "dev": true
+    },
+    "postgres-date": {
+      "version": "1.0.3",
+      "resolved": "https://registry.npmjs.org/postgres-date/-/postgres-date-1.0.3.tgz",
+      "integrity": "sha1-4tiXAu/bJY/52c7g/pG9BpdSV6g=",
+      "dev": true
+    },
+    "postgres-interval": {
+      "version": "1.2.0",
+      "resolved": "https://registry.npmjs.org/postgres-interval/-/postgres-interval-1.2.0.tgz",
+      "integrity": "sha512-9ZhXKM/rw350N1ovuWHbGxnGh/SNJ4cnxHiM0rxE4VN41wsg8P8zWn9hv/buK00RP4WvlOyr/RBDiptyxVbkZQ==",
+      "dev": true,
+      "requires": {
+        "xtend": "^4.0.0"
+      }
+    },
+    "semver": {
+      "version": "4.3.2",
+      "resolved": "https://registry.npmjs.org/semver/-/semver-4.3.2.tgz",
+      "integrity": "sha1-x6BxWKgL7dBSNVt3DYLWZA+AO+c=",
+      "dev": true
+    },
+    "split": {
+      "version": "1.0.1",
+      "resolved": "https://registry.npmjs.org/split/-/split-1.0.1.tgz",
+      "integrity": "sha512-mTyOoPbrivtXnwnIxZRFYRrPNtEFKlpB2fvjSnCQUiAA6qAZzqwna5envK4uk6OIeP17CsdF3rSBGYVBsU0Tkg==",
+      "dev": true,
+      "requires": {
+        "through": "2"
+      }
+    },
+    "through": {
+      "version": "2.3.8",
+      "resolved": "https://registry.npmjs.org/through/-/through-2.3.8.tgz",
+      "integrity": "sha1-DdTJ/6q8NXlgsbckEV1+Doai4fU=",
+      "dev": true
+    },
+    "to-utf8": {
+      "version": "0.0.1",
+      "resolved": "https://registry.npmjs.org/to-utf8/-/to-utf8-0.0.1.tgz",
+      "integrity": "sha1-0Xrqcv8vujm55DYBvns/9y4ImFI=",
+      "dev": true
+    },
+    "xtend": {
+      "version": "4.0.1",
+      "resolved": "https://registry.npmjs.org/xtend/-/xtend-4.0.1.tgz",
+      "integrity": "sha1-pcbVMr5lbiPbgg77lDofBJmNY68=",
+      "dev": true
+    }
+  }
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg-copy-streams",
-  "version": "1.2.0",
+  "version": "2.2.0",
   "description": "Low-Level COPY TO and COPY FROM streams for PostgreSQL in JavaScript using",
   "main": "index.js",
   "scripts": {
@@ -23,11 +23,13 @@
     "url": "https://github.com/brianc/node-pg-copy-streams/issues"
   },
   "devDependencies": {
-    "pg": "~4.4.3",
+    "async": "~0.2.10",
+    "benchmark": "^2.1.4",
     "concat-stream": "~1.1.0",
+    "duplex-child-process": "^1.0.0",
     "gonna": "0.0.0",
-    "lodash": "~2.2.1",
     "heroku-env": "~0.1.1",
-    "async": "~0.2.10"
+    "lodash": "^4.17.11",
+    "pg": "^7.8.2"
   }
 }

test/binary.js

@@ -1,3 +1,5 @@
+'use strict';
+
 var assert = require('assert')
 var gonna = require('gonna')
 
@@ -19,7 +21,7 @@ var testBinaryCopy = function() {
   var fromClient = client()
   var toClient = client()
 
-  queries = [
+  var queries = [
     'DROP TABLE IF EXISTS data',
     'CREATE TABLE IF NOT EXISTS data (num BIGINT, word TEXT)',
     'INSERT INTO data (num, word) VALUES (1, \'hello\'), (2, \'other thing\'), (3, \'goodbye\')',
@@ -33,7 +35,7 @@ var testBinaryCopy = function() {
     var fromStream = fromClient.query(to('COPY (SELECT * FROM data) TO STDOUT BINARY'))
     var toStream = toClient.query(from('COPY data_copy FROM STDIN BINARY'))
 
-    runStream = function(callback) {
+    var runStream = function(callback) {
       fromStream.on('error', callback)
       toStream.on('error', callback)
       toStream.on('finish', callback)

test/copy-from.js

@@ -1,3 +1,5 @@
+'use strict';
+
 var assert = require('assert')
 var gonna = require('gonna')
 
@@ -31,7 +33,7 @@ var testRange = function(top) {
   var txt = 'COPY numbers FROM STDIN'
   var stream = fromClient.query(copy(txt))
   for(var i = 0; i < top; i++) {
-    stream.write(Buffer('' + i + '\t' + i*10 + '\n'))
+    stream.write(Buffer.from('' + i + '\t' + i*10 + '\n'))
   }
   stream.end()
   var countDone = gonna('have correct count')
@@ -67,7 +69,36 @@ var testSingleEnd = function() {
     assert(count==1, '`end` Event was triggered ' + count + ' times');
     if (count == 1) fromClient.end();
   })
-  stream.end(Buffer('1\n'))
+  stream.end(Buffer.from('1\n'))
     
 }
 testSingleEnd()
+
+var testClientReuse = function() {
+  var fromClient = client()
+  fromClient.query('CREATE TEMP TABLE numbers(num int)')
+  var txt = 'COPY numbers FROM STDIN';
+  var count = 0;
+  var countMax = 2;
+  var card = 100000;
+  var runStream = function() {
+    var stream = fromClient.query(copy(txt))
+    stream.on('end', function() {
+      count++;
+      if (count<countMax) {
+        runStream()
+      } else {
+        fromClient.query('SELECT sum(num) AS s FROM numbers', function(err, res) {
+          var total = countMax * card * (card+1)
+          assert.equal(res.rows[0].s, total, 'copy-from.ClientReuse wrong total')
+          fromClient.end()
+        })
+      }
+    })
+    stream.write(Buffer.from(_.range(0, card+1).join('\n') + '\n'))
+    stream.end(Buffer.from(_.range(0, card+1).join('\n') + '\n'))
+  }
+  runStream();
+}
+testClientReuse()
+

test/copy-to.js

@@ -1,3 +1,5 @@
+'use strict';
+
 var assert = require('assert')
 var gonna = require('gonna')
 
@@ -20,7 +22,6 @@ var testConstruction = function() {
   var stream = copy(txt, {highWaterMark: 10})
   assert.equal(stream._readableState.highWaterMark, 10, 'Client should have been set with a correct highWaterMark.')
 }
-
 testConstruction()
 
 var testComparators = function() {
@@ -29,7 +30,7 @@ var testComparators = function() {
     assert(copy1._gotCopyOutResponse, 'should have received CopyOutResponse')
     assert(!copy1._remainder, 'Message with no additional data (len=Int4Len+0) should not leave a remainder')
   }))
-  copy1.end(new Buffer([code.CopyOutResponse, 0x00, 0x00, 0x00, 0x04])); 
+  copy1.end(new Buffer.from([code.CopyOutResponse, 0x00, 0x00, 0x00, 0x04])); 
 
 
 }
@@ -57,7 +58,6 @@ var testRange = function(top) {
     done()
   });
 }
-
 testRange(10000)
 
 var testInternalPostgresError = function() {
@@ -74,7 +74,7 @@ var testInternalPostgresError = function() {
 
     setTimeout(function() {
       var cancelQuery = "SELECT pg_cancel_backend(pid) FROM pg_stat_activity WHERE query ~ 'pg_sleep' AND NOT query ~ 'pg_cancel_backend'"
-      cancelClient.query(cancelQuery)
+      cancelClient.query(cancelQuery, function() { cancelClient.end() })
     }, 50)
   }
 
@@ -82,7 +82,6 @@ var testInternalPostgresError = function() {
     assert.notEqual(err, null)
     var expectedMessage = 'canceling statement due to user request'
     assert.notEqual(err.toString().indexOf(expectedMessage), -1, 'Error message should mention reason for query failure.')
-    cancelClient.end()
     queryClient.end()
   })
 }
@@ -116,7 +115,91 @@ var testNoticeResponse = function() {
 
   })
 }
-
 testNoticeResponse();
 
+var warnAndReturnOne = `
+CREATE OR REPLACE FUNCTION pg_temp.test_warn_return_one()
+RETURNS INTEGER
+AS $$
+BEGIN
+  RAISE WARNING 'hey, this is returning one';
+  RETURN 1;
+END;
+$$ LANGUAGE plpgsql`;
 
+var testInterspersedMessageDoesNotBreakCopyFlow = function() {
+  var toClient = client();
+  toClient.query(warnAndReturnOne, (err, res) => {
+    var q = "COPY (SELECT * FROM pg_temp.test_warn_return_one()) TO STDOUT WITH (FORMAT 'csv', HEADER true)";
+    var stream = toClient.query(copy(q));
+    var done = gonna('got expected COPY TO payload', 1000, function() {
+      toClient.end();
+    });
+
+    stream.pipe(concat(function(buf) {
+      res = buf.toString('utf8')
+    }));
+
+    stream.on('end', function() {
+      var expected = "test_warn_return_one\n1\n";
+      assert.equal(res, expected);
+      // note the header counts as a row
+      assert.equal(stream.rowCount, 2, 'should have rowCount = 2 but got ' + stream.rowCount);
+      done();
+    });
+  });
+};
+testInterspersedMessageDoesNotBreakCopyFlow();
+
+var testInterspersedMessageEmitsWarnign = function() {
+  var toClient = client();
+  toClient.query(warnAndReturnOne, (err, res) => {
+    var q = "COPY (SELECT * FROM pg_temp.test_warn_return_one()) TO STDOUT WITH (FORMAT 'csv', HEADER true)";
+    var stream = toClient.query(copy(q));
+    var done = gonna('got expected warning event', 1000, function() {
+      toClient.end();
+    });
+
+    stream.on('warning', function(msg) {
+      assert(msg.match(/Got an interspersed message:.*WARNING.*hey, this is returning one/),
+             'did not get expected warning for interspersed message in COPY TO');
+      done();
+    })
+  });
+};
+testInterspersedMessageEmitsWarnign();
+
+var testClientReuse = function() {
+  var c = client();
+  var limit = 100000;
+  var countMax = 10;
+  var countA = countMax;
+  var countB = 0;
+  var runStream = function(num, callback) {
+    var sql = "COPY (SELECT * FROM generate_series(0,"+limit+")) TO STDOUT"
+    var stream = c.query(copy(sql))
+    stream.on('error', callback)
+    stream.pipe(concat(function(buf) {
+      var res = buf.toString('utf8');
+      var exp = _.range(0, limit+1).join('\n') + '\n'
+      assert.equal(res, exp, 'clientReuse: sent & received buffer should be equal')
+      countB++;
+      callback();
+    }))
+  }
+  
+  var rs = function(err) {
+    assert.equal(err, null, err)
+    countA--;
+    if (countA) {
+      runStream(countB, rs)
+    } else {
+      assert.equal(countB, countMax, 'clientReuse: there should be countMax queries on the same client')
+      c.end()
+    }
+  };
+
+  runStream(countB, rs);
+
+}
+testClientReuse();

test/index.js

@@ -1,3 +1,5 @@
+'use strict';
+
 require('./copy-from')
 require('./copy-to')
 require('./binary')