mapbox / mapbox/s3scan

Cancel method

Open
#8 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
10
Forks
3
PR merge metrics
No merged PRs in 30d

Description

It would be cool to have a cancel method. Right now I'm using this to pipe an `s3scan.Scan` to another transform stream, and then when I've gotten as much as I need I end that stream, but trying to end the scan stream results in a write after end error because of the queue. Something like a `purge` or `cancel` option to delete all queued items and cancel the stream would be useful in cases like this.

Contributor guide

Open the contributing guide

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 s3scan.Scan stream implementation and its queue handling. Reproduce ending the downstream transform, then define and verify cancel or purge behavior so queued items are discarded and ending the scan does not produce a write-after-end error.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, javascript, node.js
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 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.