andTee() / andThrough() to handle side-effects a bit easier (from issue #445) #467

untidy-hair · 2023-04-03T04:48:24Z

closes #445

Hi @supermacro!
I opened an issue with a suggestion about 2.5 months ago (Jan 17) but I think you have been very busy and I thought maybe a real code would save your time :)

I got a feedback comment in the original issue thread and I ended up having these two methods.

andTee()

andTee(f: (t: T) => unknown): ResultAsync<T, E>
// Usage: validate() below returns ResultAsync
validate(userInfoInput).andThen(buildUser).andTee(logEvent).andThen(notifyUserRegistration)....

andThrough()

andThrough<F>(f: (t: T) => ResultAsync<unknown, F>): ResultAsync<T, E | F>
// Usage: validate() below returns ResultAsync
validate(userInfoInput).andThen(buildUser).andThrough(persistUser).andThen(notifyUserRegistration)....

Both return the original input okAsync<T> upon success, but in case of error, andTee() ignores the error whereas andThrough() returns the new error errAsync<F>. The former is suitable for such as logging when you don't want to stop the main logic upon trivial side-effect failure and the latter is suitable when you want to stop the main logic upon a critical side-effect failure such as DB insertion error.

Origianlly I was going to use the name andTee for no.2 above that passes error value in case of an error but considering the original meaning of "tee", even the error should not come back to the main "pipe" so I used the name for no.1 above instead. (But as I wrote in the original issue, there could be better names.)

And was also written in the original thread, this can be done with the current APIs but these two new methods will make it possible to write and understand each step of the logics more vividly (IMO) and I personally have cases I want to rewrite code with andThrough() for DB persistence as I explained here :)

Thanks in advance!

brndt · 2023-05-29T15:56:33Z

@supermacro can you take a look on this please? It's quite useful feature to avoid boilerplate

brndt · 2023-09-12T21:36:00Z

@supermacro bump :)

supermacro · 2023-10-09T10:02:29Z

#496

untidy-hair · 2023-12-06T03:41:02Z

Hi @supermacro , have you had a chance to look at this PR? I'd appreciate your review! Thank you!

changeset-bot · 2024-08-25T07:15:02Z

⚠️ No Changeset found

Latest commit: 4b9d2fd

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

m-shaka

Thank you for your contribution
Can you add docs about new features to README?

tests/index.test.ts

tests/typecheck-tests.ts

src/result.ts

untidy-hair · 2024-08-25T16:08:18Z

@m-shaka thank you for the comment, I will get back to you after making updates.

m-shaka · 2024-08-26T04:28:53Z

@supermacro Hey Gio, I think andTee is a nice name, but what do you think of the name andThrough? Do you have any other ideas?

untidy-hair · 2024-08-28T03:45:19Z

Hi @m-shaka and @supermacro , I updated the PR based on the suggestions as well as README. Thanks

supermacro · 2024-08-28T14:26:54Z

Both names are ok with me! Don't think it's fair for me to come in so late and opine strongly here. Great job everyone .. and thanks for your patience :)

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [neverthrow](https://github.com/supermacro/neverthrow) | dependencies | minor | [`7.0.1` -> `7.2.0`](https://renovatebot.com/diffs/npm/neverthrow/7.0.1/7.2.0) | --- ### Release Notes <details> <summary>supermacro/neverthrow (neverthrow)</summary> ### [`v7.2.0`](https://github.com/supermacro/neverthrow/blob/HEAD/CHANGELOG.md#720) [Compare Source](supermacro/neverthrow@v7.1.0...v7.2.0) ##### Minor Changes - [#562](supermacro/neverthrow#562) [`547352f`](supermacro/neverthrow@547352f) Thanks [@sharno](https://github.com/sharno)! - change the return type of `safeTry` to be `ResultAsync<T, E>` instead of `Promise<Result<T, E>>` for better composability ### [`v7.1.0`](https://github.com/supermacro/neverthrow/blob/HEAD/CHANGELOG.md#710) [Compare Source](supermacro/neverthrow@v7.0.1...v7.1.0) ##### Minor Changes - [#467](supermacro/neverthrow#467) [`4b9d2fd`](supermacro/neverthrow@4b9d2fd) Thanks [@untidy-hair ](https://github.com/untidy-hair)! - feat: add `andTee` and `andThrough` to handle side-effect ##### Patch Changes - [#483](supermacro/neverthrow#483) [`96f7f66`](supermacro/neverthrow@96f7f66) Thanks [@braxtonhall](https://github.com/braxtonhall)! - Fix `combineWithAllErrors` types - [#563](supermacro/neverthrow#563) [`eadf50c`](supermacro/neverthrow@eadf50c) Thanks [@mattpocock](https://github.com/mattpocock)! - Made err() infer strings narrowly for easier error tagging. </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://git.tristess.app/alexandresoro/ouca/pulls/70 Reviewed-by: Alexandre Soro <[email protected]> Co-authored-by: renovate <[email protected]> Co-committed-by: renovate <[email protected]>

untidy-hair added 2 commits April 2, 2023 22:18

Implement andTee, andSafeTee and asyncAndTee

2d45d8e

Change andTee to andThrough, andSafeTee to andTee upon issue suggestion

39b8571

guilherme-sato approved these changes Oct 31, 2023

View reviewed changes

Merge branch 'master' into feature/andTee

96c8537

m-shaka requested review from m-shaka and supermacro as code owners August 25, 2024 07:14

m-shaka requested changes Aug 25, 2024

View reviewed changes

tests/index.test.ts Outdated Show resolved Hide resolved

tests/typecheck-tests.ts Outdated Show resolved Hide resolved

src/result.ts Outdated Show resolved Hide resolved

src/result.ts Outdated Show resolved Hide resolved

Update per suggestions

98d0abc

Update README.md with new .andTee(), .andThrough() and asyncAndThrough()

4b9d2fd

untidy-hair force-pushed the feature/andTee branch from fd9dd29 to 4b9d2fd Compare August 28, 2024 03:42

supermacro approved these changes Aug 28, 2024

View reviewed changes

supermacro merged commit e72e9cd into supermacro:master Aug 28, 2024
8 checks passed

supermacro mentioned this pull request Aug 28, 2024

feat: add a "tap"-method to perform side effects #456

Closed

m-shaka mentioned this pull request Aug 28, 2024

chore: add a missing changeset file #575

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

andTee() / andThrough() to handle side-effects a bit easier (from issue #445) #467

andTee() / andThrough() to handle side-effects a bit easier (from issue #445) #467

untidy-hair commented Apr 3, 2023 •

edited

Loading

brndt commented May 29, 2023

brndt commented Sep 12, 2023

supermacro commented Oct 9, 2023

untidy-hair commented Dec 6, 2023 •

edited

Loading

changeset-bot bot commented Aug 25, 2024 •

edited

Loading

m-shaka left a comment

untidy-hair commented Aug 25, 2024

m-shaka commented Aug 26, 2024

untidy-hair commented Aug 28, 2024

supermacro commented Aug 28, 2024

andTee() / andThrough() to handle side-effects a bit easier (from issue #445) #467

andTee() / andThrough() to handle side-effects a bit easier (from issue #445) #467

Conversation

untidy-hair commented Apr 3, 2023 • edited Loading

brndt commented May 29, 2023

brndt commented Sep 12, 2023

supermacro commented Oct 9, 2023

untidy-hair commented Dec 6, 2023 • edited Loading

changeset-bot bot commented Aug 25, 2024 • edited Loading

⚠️ No Changeset found

m-shaka left a comment

Choose a reason for hiding this comment

untidy-hair commented Aug 25, 2024

m-shaka commented Aug 26, 2024

untidy-hair commented Aug 28, 2024

supermacro commented Aug 28, 2024

untidy-hair commented Apr 3, 2023 •

edited

Loading

untidy-hair commented Dec 6, 2023 •

edited

Loading

changeset-bot bot commented Aug 25, 2024 •

edited

Loading