Add changelog for 1.2.1

Author: jeromew

README.md

@@ -7,17 +7,17 @@ Ingest streaming data into PostgresSQL or Export data from PostgreSQL and transf
 
 ## what are you talking about ?
 
-Well first you have to know that PostgreSQL has not-so-well-known mechanism that helps when importing into PostgreSQL from a source (*copy-in*)
-or exporting to a sink from PostgreSQL (*copy-out*)
+Well first you have to know that PostgreSQL has not-so-well-known mechanism that helps when importing into PostgreSQL from a source (_copy-in_)
+or exporting to a sink from PostgreSQL (_copy-out_)
 
 You should first go and get familiar with the [pg-copy-streams](https://github.com/brianc/node-pg-copy-streams) module that does
 the heavy lifting of handling the COPY part of the protocol flow.
 
 ## what does this module do ?
 
-When dealing with the COPY mechanism, you can use different formats for *copy-out* or *copy-in* : text, csv or binary.
+When dealing with the COPY mechanism, you can use different formats for _copy-out_ or _copy-in_ : text, csv or binary.
 
-The text and csv formats are interesting but they have some limitations due to the fact that they are text based, need field separators, escaping, etc. Have you ever been in the CSV hell ? 
+The text and csv formats are interesting but they have some limitations due to the fact that they are text based, need field separators, escaping, etc. Have you ever been in the CSV hell ?
 
 The PostgreSQL documentation states : Many programs produce strange and occasionally perverse CSV files, so the file format is more a convention than a standard. Thus you might encounter some files that cannot be imported using this mechanism, and COPY might produce files that other programs cannot process.
 
@@ -26,9 +26,10 @@ Do you want to go there ? If you take the blue pill, then this module might be f
 It can be used to parse and deparse the PostgreSQL binary streams that are made available by the `pg-copy-streams` module.
 
 The main API is called `transform` an tries to hide many of those details. It can be used to easily do non trivial things like :
- - transforming rows
- - expanding on the number of rows
- - forking rows into several databases at the same time, with the same of different structures 
+
+- transforming rows
+- expanding on the number of rows
+- forking rows into several databases at the same time, with the same of different structures
 
 ## Example
 
@@ -61,83 +62,89 @@ Table C has the simple structure
 CREATE TABLE generated (body text);
 ```
 
-And you want to fill it, for each source row, with a number `id` of rows (expanding the number of rows), with a body of "BODY: " + description. 
+And you want to fill it, for each source row, with a number `id` of rows (expanding the number of rows), with a body of "BODY: " + description.
 
 After all this is done, you want to add a line in the `generated` table with a body of "COUNT: " + total number of rows inserted (not counting this one)
 
 Here is a code that will do just this.
 
 ```js
-var pg = require('pg');
-var through2 = require('through2');
-var copyOut = require('pg-copy-streams').to;
-var copyIn = require('pg-copy-streams').from;
-var pgCopyTransform = require('pg-copy-streams-binary').transform;
-
-var client = function(dsn) {
-  var client = new pg.Client(dsn);
-  client.connect();
-  return client;
+var pg = require('pg')
+var through2 = require('through2')
+var copyOut = require('pg-copy-streams').to
+var copyIn = require('pg-copy-streams').from
+var pgCopyTransform = require('pg-copy-streams-binary').transform
+
+var client = function (dsn) {
+  var client = new pg.Client(dsn)
+  client.connect()
+  return client
 }
 
-var dsnA = null; // configure database A connection parameters
-var dsnB = null; // configure database B connection parameters
-var dsnC = null; // configure database C connection parameters
+var dsnA = null // configure database A connection parameters
+var dsnB = null // configure database B connection parameters
+var dsnC = null // configure database C connection parameters
 
-var clientA = client(dsnA);
-var clientB = client(dsnB);
-var clientC = client(dsnC);
+var clientA = client(dsnA)
+var clientB = client(dsnB)
+var clientC = client(dsnC)
 
 var AStream = clientA.query(copyOut('COPY item      TO   STDOUT BINARY'))
-var BStream = clientB.query(copyIn ('COPY product   FROM STDIN  BINARY'))
-var CStream = clientB.query(copyIn ('COPY generated FROM STDIN  BINARY'))
+var BStream = clientB.query(copyIn('COPY product   FROM STDIN  BINARY'))
+var CStream = clientB.query(copyIn('COPY generated FROM STDIN  BINARY'))
 
 var transform = through2.obj(
-  function(row, _, cb) {
-    var id = parseInt(row.ref.split(':')[0]);
-    var d = new Date('1999-01-01T00:00:00Z');
-    d.setDate(d.getDate() + id);
+  function (row, _, cb) {
+    var id = parseInt(row.ref.split(':')[0])
+    var d = new Date('1999-01-01T00:00:00Z')
+    d.setDate(d.getDate() + id)
     count++
-    this.push([0,
+    this.push([
+      0,
       { type: 'int4', value: id },
       { type: 'text', value: row.ref.split(':')[1] },
       { type: 'text', value: row.description.toLowerCase() },
       { type: 'timestamptz', value: d },
-      { type: '_int2', value: [ [ id, id+1 ], [ id+2, id+3 ] ] }
+      {
+        type: '_int2',
+        value: [
+          [id, id + 1],
+          [id + 2, id + 3],
+        ],
+      },
     ])
     while (id > 0) {
       count++
-      this.push([1,
-        { type: 'text', value: 'BODY: ' + row.description }
-      ]);
-      id--;
+      this.push([1, { type: 'text', value: 'BODY: ' + row.description }])
+      id--
     }
     cb()
   },
-  function(cb) {
-    this.push([1,
-      { type: 'text', value: 'COUNT: ' + count}
-    ])
+  function (cb) {
+    this.push([1, { type: 'text', value: 'COUNT: ' + count }])
     cb()
   }
-);
+)
 
-var count = 0;
+var count = 0
 var pct = pgCopyTransform({
-  mapping: [{key:'id',type:'int4'}, {key:'ref',type:'text'},{key:'description',type:'text'}],
+  mapping: [
+    { key: 'id', type: 'int4' },
+    { key: 'ref', type: 'text' },
+    { key: 'description', type: 'text' },
+  ],
   transform: transform,
   targets: [BStream, CStream],
-});
+})
 
-pct.on('close', function() {
+pct.on('close', function () {
   // Done !
-  clientA.end();
-  clientB.end();
-  clientC.end();
+  clientA.end()
+  clientB.end()
+  clientC.end()
 })
 
-AStream.pipe(pct);
-
+AStream.pipe(pct)
 ```
 
 The `test/transform.js` test does something along these lines to check that it works.
@@ -207,7 +214,6 @@ default: true
 This option can be used to not send the header that PostgreSQL expects at the end of COPY session.
 You could use this if you want to unpipe this stream pipe another one that will send more data and maybe finish the COPY session.
 
-
 ## API for Parser
 
 ### options.mapping
@@ -225,27 +231,33 @@ When `mapping` is not given, the Parser will push rows as arrays of Buffers.
 
 For all supported types, their corresponding array version is also supported.
 
- * bool
- * bytea
- * int2, int4
- * float4, float8
- * text
- * json
- * timestamptz
+- bool
+- bytea
+- int2, int4
+- float4, float8
+- text
+- json
+- timestamptz
 
 Note that when types are mentioned in the `mapping` option, it should be stricly equal to one of theses types. pgadmin might sometimes mention aliases (like integer instead of int4) and you should not use these aliases.
 
-The types for array (one or more dimentions) corresponds to the type prefixed with an underscore. So an array of int4, int4[], needs to be referenced as _int4 without any mention of the dimensions. This is because the dimension information is embedded in the binary format.
+The types for array (one or more dimentions) corresponds to the type prefixed with an underscore. So an array of int4, int4[], needs to be referenced as \_int4 without any mention of the dimensions. This is because the dimension information is embedded in the binary format.
 
+## changelog
+
+### version 1.2.1 - published 2020-05-29
+
+- Fix a compatibility bug introduced via `pg-copy-streams` 3.0. The parser can now handle rows that span across several stream chunks
+- Migration of tests to mocha
 
 ## Warnings & Disclaimer
 
 There are many details in the binary protocol, and as usual, the devil is in the details.
- * Currently, operations are considered to happen on table WITHOUT OIDS. Usage on table WITH OIDS has not been tested.
- * In Arrays null placeholders are not implemented (no spot in the array can be empty).
- * In Arrays, the first element of a dimension is always at index 1.
- * Errors handling has not yet been tuned so do not expect explicit error messages
 
+- Currently, operations are considered to happen on table WITHOUT OIDS. Usage on table WITH OIDS has not been tested.
+- In Arrays null placeholders are not implemented (no spot in the array can be empty).
+- In Arrays, the first element of a dimension is always at index 1.
+- Errors handling has not yet been tuned so do not expect explicit error messages
 
 The PostgreSQL documentation states it clearly : "a binary-format file is less portable across machine architectures and PostgreSQL versions".
 Tests are trying to discover issues that may appear in between PostgreSQL version but it might not work in your specific environment.
@@ -255,9 +267,9 @@ Use it at your own risks !
 
 ## External references
 
- * [COPY documentation, including binary format](https://www.postgresql.org/docs/current/static/sql-copy.html)
- * [send/recv implementations for types in PostgreSQL](https://github.com/postgres/postgres/tree/master/src/backend/utils/adt)
- * [default type OIDs in PostgreSQL catalog](https://github.com/postgres/postgres/blob/master/src/include/catalog/pg_type.h)
+- [COPY documentation, including binary format](https://www.postgresql.org/docs/current/static/sql-copy.html)
+- [send/recv implementations for types in PostgreSQL](https://github.com/postgres/postgres/tree/master/src/backend/utils/adt)
+- [default type OIDs in PostgreSQL catalog](https://github.com/postgres/postgres/blob/master/src/include/catalog/pg_type.h)
 
 ## Acknowledgments
 
@@ -286,5 +298,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
-
-