feat: add signal option to retry and parallel

[SaidbekAbdiganiev]

Tip

The owner of this PR can publish a preview release by commenting /publish in this PR. Afterwards, anyone can try it out by running pnpm add radashi@pr<PR_NUMBER>.

Summary

This PR adds an option to pass AbortController.signal to retry and parallel to end their execution before looping over all of the array items, or going through all of the retry attempts. When aborted, the functions throw an Error with the message Operation aborted.

// _.retry
import * as _ from 'radashi'

const abortController = new AbortController()
const signal = abortController.signal

const promise = _.retry({ times: 3, delay: 1000, signal }, api.users.list)

// To abort the operation:
abortController.abort()

try {
  await promise
} catch (err) {
  if (err.message === 'Operation aborted') {
    console.log('Retry operation was aborted')
  }
}

//_.parallel
import * as _ from 'radashi'

const userIds = [1, 2, 3, 4, 5, 6, 7, 8, 9]
const abortController = new AbortController()
const signal = abortController.signal

const [err, users] = await _.tryit(_.parallel)(3, userIds, async userId => {
  return await api.users.find(userId)
}, signal)

// To abort the operation:
abortController.abort()

console.log(err) // => Error: Operation Aborted
console.log(err.message) // => "Operation Aborted"

Related issue, if any:

#255
https://github.com/orgs/radashi-org/discussions/256

For any code change,

• Related documentation has been updated, if needed
• Related tests have been added or updated, if needed
• Related benchmarks have been added or updated, if needed

Does this PR introduce a breaking change?

Yes

I do not know entirely what are the implications of this change, but I added the DOM parameter to lib in tsconfig.json. According to this article, it adds the types for browser API's which in this case includes the AbortController. According to can i use, it is supported in all major browsers and has been implemented in node since v15, so it shouldn't break any existing applications using older versions of radashi.

Bundle impact

Status	File	Size 1	Difference
M	src/async/parallel.ts	1563	+291 (+23%)
M	src/async/retry.ts	535	+32 (+6%)

Footnotes

1. Function size includes the import dependencies of the function. ↩

[aleclarson]

Just a few more changes and it should be good :)

[aleclarson]

Hey! There's a new requirement for PRs that introduce new features. Without this requirement met, we won't be able to merge this. Note that this PR can still be included in a beta prerelease before this requirement is fulfilled.

• Edit the next-minor.md file

⚠️ Note: You need to run git rebase main before this file will appear locally.

[SaidbekAbdiganiev]

Hi @aleclarson! I’ve updated next-minor.md. When you have a moment, please check it out

[aleclarson]

Hey @SaidbekAbdiganiev, thanks for the contribution! I'll merge this now and I hope to release it in v12.3.0 very soon. Hope to see more from you in the future 😃

P.S. I refactored the parallel implementation in 3588941 with the following improvements:

• Avoid function allocations
• Stop processing the array upon being aborted
• Reject with signal.reason just like signal.throwIfAborted does

[radashi-bot]

A stable release 12.3.0 has been published to NPM. 🚀

To install:

pnpm add [email protected]