feat(Effects): dispatch init feature effects action on init by timdeschryver · Pull Request #1305 · ngrx/platform

timdeschryver · 2018-08-28T17:59:46Z

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)
Docs have 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?

Issue Number: #683

What is the new behavior?

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

If we agree on the API, I'll also add these changes to the docs.
I also would want to change the root effects action name (this will be a breaking change) to make it more clear that it's initiated by the root effects: from @ngrx/effects/init to @ngrx/root-effects/init .

Closes #683

timdeschryver · 2018-08-28T18:00:46Z

modules/effects/src/effects_feature_module.ts

+import { getSourceForInstance } from './effects_metadata';
+
+export const FEATURE_EFFECTS_INIT = '@ngrx/feature-effects/init';
+export type FeatureEffectsInit = {


The reason why I created this is to be typesafe, see the effects test case for a "demo".

coveralls · 2018-08-28T18:03:19Z

Coverage increased (+0.006%) to 88.761% when pulling 0059e01 on timdeschryver:pr/feature-effects-init into fa21f29 on ngrx:master.

brandonroberts · 2018-08-29T19:14:21Z

modules/effects/src/effects_feature_module.ts

 import { FEATURE_EFFECTS } from './tokens';
+import { getSourceForInstance } from './effects_metadata';
+
+export const FEATURE_EFFECTS_INIT = '@ngrx/feature-effects/init';


I think the prefix should remain @ngrx/effects/something. What about @ngrx/effects/(update-effects or update)?

Yea you're right.
My vote goes for @ngrx/effects/update-effects to keep things consistent with @ngrx/store/update-reducers.

Plus we wouldn't need to change the root effects:

I also would want to change the root effects action name (this will be a breaking change) to make it more clear that it's initiated by the root effects: from @ngrx/effects/init to @ngrx/root-effects/init

modules/effects/src/effects_feature_module.ts

docs/effects/api.md

brandonroberts · 2018-08-30T18:22:19Z

docs/effects/api.md

+### UPDATE_EFFECTS
+
+After feature effects have been registered, a `UPDATE_EFFECTS` action will be dispatched.
+This action will have all registered effects as its payload.


action has all newly

Just to be sure, you mean that this can be removed right?

No, just update. This action has all newly registered effects as its payload.

docs/effects/api.md

ThomasBurleson · 2018-09-04T17:52:03Z

Nice. Just what i needed.

timdeschryver · 2018-09-04T17:59:04Z

Keep in mind this isn't released yet @ThomasBurleson - if you need it now you can install from the nightly builds.

During a prod build the contructor name of an effect gets magnled, therefore this implementation can't be used.

timdeschryver commented Aug 28, 2018

View reviewed changes

timdeschryver force-pushed the pr/feature-effects-init branch from 99f391c to 0e4cdd2 Compare August 28, 2018 18:02

brandonroberts reviewed Aug 29, 2018

View reviewed changes

timdeschryver force-pushed the pr/feature-effects-init branch 3 times, most recently from d17dac7 to 68f88c7 Compare August 30, 2018 06:56

timdeschryver added 2 commits August 30, 2018 09:45

feat(Effects): dispatch init feature effects action on init

f5f7b31

docs(Effects): add UPDATE_EFFECTS

90ca432

timdeschryver force-pushed the pr/feature-effects-init branch from 68f88c7 to 90ca432 Compare August 30, 2018 07:45

brandonroberts requested changes Aug 30, 2018

View reviewed changes

timdeschryver added 2 commits August 30, 2018 20:39

doc improvements

a0788d5

revert removing optional parameters

0059e01

brandonroberts approved these changes Aug 31, 2018

View reviewed changes

brandonroberts merged commit 15a4b58 into ngrx:master Aug 31, 2018

brandonroberts mentioned this pull request Aug 31, 2018

Init effects not triggering other effects #1250

Closed

timdeschryver deleted the pr/feature-effects-init branch August 31, 2018 13:41

timdeschryver added a commit that referenced this pull request Dec 13, 2018

revert(Effects): dispatch init feature effects action on init #1305

6b4ad99

During a prod build the contructor name of an effect gets magnled, therefore this implementation can't be used.

timdeschryver mentioned this pull request Dec 13, 2018

feat(Effects): add OnInitEffects interface to dispatch an action on initialization #1467

Merged

3 tasks

brandonroberts pushed a commit that referenced this pull request Dec 20, 2018

revert(Effects): dispatch init feature effects action on init #1305

e9cc9ae

During a prod build the contructor name of an effect gets magnled, therefore this implementation can't be used.

Uh oh!

Conversation

timdeschryver commented Aug 28, 2018

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Other information

Uh oh!

timdeschryver Aug 28, 2018

Choose a reason for hiding this comment

Uh oh!

coveralls commented Aug 28, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

brandonroberts Aug 29, 2018

Choose a reason for hiding this comment

Uh oh!

timdeschryver Aug 29, 2018

Choose a reason for hiding this comment

Uh oh!

brandonroberts Aug 29, 2018

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

brandonroberts Aug 30, 2018

Choose a reason for hiding this comment

Uh oh!

timdeschryver Aug 30, 2018

Choose a reason for hiding this comment

Uh oh!

brandonroberts Aug 30, 2018

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ThomasBurleson commented Sep 4, 2018

Uh oh!

timdeschryver commented Sep 4, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

coveralls commented Aug 28, 2018 •

edited

Loading