xlsx-stream-reader/test/test.js

Memory efficinet non-blocking/event based streaming XLSX reader

/* global describe, it */

const XlsxStreamReader = require('../index')
const fs = require('fs')
const assert = require('assert')
const path = require('path')

describe('The xslx stream parser', function () {
  it('parses large files', function (done) {
    var workBookReader = new XlsxStreamReader()
    fs.createReadStream(path.join(__dirname, 'big.xlsx')).pipe(workBookReader)
    workBookReader.on('worksheet', function (workSheetReader) {
      workSheetReader.on('end', function () {
        assert(workSheetReader.rowCount === 80000)
        done()
      })
      workSheetReader.process()
    })
  })
  it('supports predefined formats', function (done) {
    var workBookReader = new XlsxStreamReader()
    fs.createReadStream(path.join(__dirname, 'predefined_formats.xlsx')).pipe(workBookReader)
    const rows = []
    workBookReader.on('worksheet', function (workSheetReader) {
      workSheetReader.on('end', function () {
        assert(rows[1][4] === '9/27/86')
        assert(rows[1][8] === '20064')
        done()
      })
      workSheetReader.on('row', function (r) {
        rows.push(r.values)
      })
      workSheetReader.process()
    })
  })
  it('supports custom formats', function (done) {
    var workBookReader = new XlsxStreamReader()
    fs.createReadStream(path.join(__dirname, 'import.xlsx')).pipe(workBookReader)
    const rows = []
    workBookReader.on('worksheet', function (workSheetReader) {
      workSheetReader.on('end', function () {
        assert(rows[1][2] === '27/09/1986')
        assert(rows[1][3] === '20064')
        done()
      })
      workSheetReader.on('row', function (r) {
        rows.push(r.values)
      })
      workSheetReader.process()
    })
  })
  it('catches zip format errors', function (done) {
    var workBookReader = new XlsxStreamReader()
    fs.createReadStream(path.join(__dirname, 'notanxlsx')).pipe(workBookReader)
    workBookReader.on('error', function (err) {
      assert(err.message === 'invalid signature: 0x6d612069')
      done()
    })
  })
  it('parses a file with no number format ids', function (done) {
    const workBookReader = new XlsxStreamReader()
    const rows = []
    fs.createReadStream(path.join(__dirname, 'nonumfmt.xlsx')).pipe(workBookReader)
    workBookReader.on('worksheet', function (workSheetReader) {
      workSheetReader.on('end', function () {
        assert(rows[1][1] === 'lambrate')
        done()
      })
      workSheetReader.on('row', function (r) {
        rows.push(r.values)
      })
      workSheetReader.process()
    })
  })
  it('parses two files in parallel', done => {
    const file1 = 'import.xlsx'
    const file2 = 'file_with_2_sheets.xlsx'
    let finishedStreamCount = 0
    const endStream = function () {
      finishedStreamCount++

      if (finishedStreamCount === 2) {
        done()
      }
    }

    fs.createReadStream(path.join(__dirname, file1)).pipe(consumeXlsxFile(endStream))
    fs.createReadStream(path.join(__dirname, file2)).pipe(consumeXlsxFile(endStream))
  })
  it('support rich-text', function (done) {
    const workBookReader = new XlsxStreamReader({ saxTrim: false })
    fs.createReadStream(path.join(__dirname, 'richtext.xlsx')).pipe(workBookReader)
    const rows = []
    workBookReader.on('worksheet', function (workSheetReader) {
      workSheetReader.on('end', function () {
        assert(rows[0][2] === 'B cell')
        assert(rows[0][3] === 'C cell')
        done()
      })
      workSheetReader.on('row', function (r) {
        rows.push(r.values)
      })
      workSheetReader.process()
    })
  })
  it('parses a file having uppercase in sheet name and mixed first node', function (done) {
    const workBookReader = new XlsxStreamReader()
    const rows = []
    fs.createReadStream(path.join(__dirname, 'uppercase_sheet_name.xlsx')).pipe(workBookReader)
    workBookReader.on('worksheet', function (workSheetReader) {
      workSheetReader.on('end', function () {
        assert.strictEqual(rows.length, 24)
        assert.deepStrictEqual(
          rows[0].slice(1),
          ['Category ID', 'Parent category ID', 'Name DE', 'Name FR', 'Name IT', 'Name EN', 'GS1 ID']
        )
        done()
      })
      workSheetReader.on('row', function (r) {
        rows.push(r.values)
      })
      workSheetReader.process()
    })
    workBookReader.on('end', function () {
      rows.length || done(new Error('Read nothing'))
    })
  })
})

function consumeXlsxFile (cb) {
  const workBookReader = new XlsxStreamReader()
  workBookReader.on('worksheet', sheet => sheet.process())
  workBookReader.on('end', cb)
  return workBookReader
}