feat(effects): resubscribe to effects on error

[alex-okrushko]

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our guidelines: https://github.com/ngrx/platform/blob/master/CONTRIBUTING.md#commit
• Tests for the changes have been added (for bug fixes / features)
• Documentation has been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

When Errors happen in the main Actions stream that error is reported and the stream is closed

Closes # #1851

What is the new behavior?

For {dispatch: true}, which is the default Effect option, if the error occurs in the main actions stream, the effect will be resubscribed. This could result in unusual behavior (in cases where operators like startWith are used).

Resubscriptions can be turned off by setting {resubscribeOnError: false} in the effect metadata.

Does this PR introduce a breaking change?

[x] Yes
[ ] No

BREAKING CHANGE:

Prior to introduction of automatic resubscriptions on errors, all effects had effectively {resubscribeOnError: false} behavior. For the rare cases when this is still wanted please add {resubscribeOnError: false} to the effect metadata.

BEFORE:

login$ = createEffect(() =>
    this.actions$.pipe(
      ofType(LoginPageActions.login),
      mapToAction(
        // Happy path callback
        action => this.authService.login(action.credentials).pipe(
            map(user => AuthApiActions.loginSuccess({ user }))),
        // error callback
        error => AuthApiActions.loginFailure({ error }),
      ) 
    ));

AFTER:

login$ = createEffect(() =>
    this.actions$.pipe(
      ofType(LoginPageActions.login),
      mapToAction(
        // Happy path callback
        action => this.authService.login(action.credentials).pipe(
            map(user => AuthApiActions.loginSuccess({ user }))),
        // error callback
        error => AuthApiActions.loginFailure({ error }),
      )
    // Errors are handled and it is safe to disable resubscription 
    ), {resubscribeOnError: false });

Other information

[alex-okrushko]

Also refactored createEffect a bit - removed overrides and sprinkled it with a bit of TS ✨magic✨

[ngrxbot]

Preview docs changes for 8096171 at https://previews.ngrx.io/pr1881-8096171/

[brandonroberts]

The git commit message needs to indicate the breaking change also

[ngrxbot]

Preview docs changes for c6b9ded at https://previews.ngrx.io/pr1881-c6b9ded/

[ngrxbot]

Preview docs changes for 1ac0665 at https://previews.ngrx.io/pr1881-1ac0665/

[ngrxbot]

Preview docs changes for 2041346 at https://previews.ngrx.io/pr1881-2041346/

[ngrxbot]

Preview docs changes for cf21508 at https://previews.ngrx.io/pr1881-cf21508/