mcollina / mcollina/split2

exception thrown within the mapper does not catch by stream on error mechanism

Open
#38 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
296
Forks
25
PR merge metrics
No merged PRs in 30d

Description

example:

pipeline(
            this.s3StreamReader.openStream(this.bucket, key),
            splitLine(line => {
                try {
                   return JSON.parse(line.toString());
                } catch (error) {
                    throw new TypeError(`line: "${line}" is not in json format`);
                }
            }),
            (error?) => {
                if (!error) {
                    this.logger.debug(`done streaming file: '${this.bucket}/${key}'`);
                }
                else {
                    this.logger.error(`error streaming file: '${this.bucket}/${key}', ${error}`);
                }
            }
        ).on("error" (err) => {
this.logger("WILL NEVER BE CALLED")
});

the on error will never be called.

fix suggestion to the transform function:

function transform (chunk, enc, cb) {
  var list
  if (this.overflow) { // Line buffer is full. Skip to start of next line.
    var buf = this[kDecoder].write(chunk)
    list = buf.split(this.matcher)

    if (list.length === 1) return cb() // Line ending not found. Discard entire chunk.

    // Line ending found. Discard trailing fragment of previous line and reset overflow state.
    list.shift()
    this.overflow = false
  } else {
    this[kLast] += this[kDecoder].write(chunk)
    list = this[kLast].split(this.matcher)
  }

  this[kLast] = list.pop()

  for (var i = 0; i < list.length; i++) {
  try{
    push(this, this.mapper(list[i]));
  } catch(error)
    cb(error)
  }

  this.overflow = this[kLast].length > this.maxLength
  if (this.overflow && !this.skipOverflow) return cb(new Error('maximum buffer reached'))

  cb()
}

basically wrapping the call with try/catch, on catch cb(error)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the transform function used by splitLine and reproduce the mapper exception with the pipeline example. Verify that an exception from the mapper reaches the stream error callback without changing normal line splitting or overflow handling.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
backend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.