middleware receive immutable versions of state and actions #63802
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
oatkiller
added
the
release_note:skip
|
Pinging @elastic/endpoint-app-team (Feature:Endpoint) |
oatkiller
force-pushed
the
immutable-stuff-in-middleware
branch
from
30b22d2
to
85722d8
Compare
oatkiller
commented
Apr 17, 2020
| @@ -29,7 +31,7 @@ export const alertMiddlewareFactory: MiddlewareFactory<AlertListState> = (coreSt | |||
| return [indexPattern]; | |||
| } | |||
|
|
|||
| return api => next => async (action: AppAction) => { | |||
There was a problem hiding this comment.
This will now be an Immutable version of AppAction.
oatkiller
commented
Apr 17, 2020
|
|
||
| export const hostMiddlewareFactory: MiddlewareFactory<HostListState> = coreStart => { | ||
| return ({ getState, dispatch }) => next => async (action: AppAction) => { |
There was a problem hiding this comment.
This will now be an Immutable version of AppAction.
oatkiller
commented
Apr 17, 2020
| import { EndpointPluginStartDependencies } from '../../../plugin'; | ||
|
|
||
| const composeWithReduxDevTools = (window as any).__REDUX_DEVTOOLS_EXTENSION_COMPOSE__ | ||
| ? (window as any).__REDUX_DEVTOOLS_EXTENSION_COMPOSE__({ name: 'EndpointApp' }) | ||
| : compose; | ||
|
|
||
| export type Selector<S, R> = (state: S) => R; |
There was a problem hiding this comment.
moved type to types module. Code should be more readable now, and this type is relevant to the others there: ImmutableMiddleware, ImmutableMiddlewareAPI, ImmutableMidlewareFactory.
oatkiller
commented
Apr 17, 2020
| @@ -66,7 +47,7 @@ export const appStoreFactory: (middlewareDeps?: { | |||
| * Any additional Redux Middlewares | |||
| * (should only be used for testing - example: to inject the action spy middleware) | |||
| */ | |||
| additionalMiddleware?: Array<ReturnType<MiddlewareFactory>>; | |||
| additionalMiddleware?: Array<ReturnType<ImmutableMiddlewareFactory>>; | |||
There was a problem hiding this comment.
@paul-tavares objections to replacing this with:
actionSpyMiddleware?: ActionSpyMiddleware
I don't think code outside of the store should dictating what middleware are used, how they are constructed, or what order they are applied in.
Theoretical example of what i'm concerned about:
Assume we learn that the actionSpyMiddleware should really come before all other middleware (seems reasonable, since by being added last, other middleware could decide not to pass an action on to the action spy.) If we move all 'additional middleware' to the beginning of the chain, and if there were other additional middleware (as opposed to just the spy) then that could cause issues.
jonathan-buttner
approved these changes
Apr 17, 2020
💛 Build succeeded, but was flaky
Test FailuresKibana Pipeline / kibana-xpack-agent / X-Pack Detection Engine API Integration Tests.x-pack/test/detection_engine_api_integration/security_and_spaces/tests/find_statuses·ts.detection engine api security and spaces enabled find_statuses should return a single rule status when a single rule is loaded from a find status with defaults addedStandard OutStack TraceHistory
To update your PR or re-run it, just comment with: |
dplumlee
approved these changes
Apr 17, 2020
madirey
approved these changes
Apr 17, 2020
oatkiller
pushed a commit
to oatkiller/kibana
that referenced
this pull request
Apr 17, 2020
…lastic#63802) Middleware receive state and actions, but they shouldn't mutate either. With this PR, middleware using the `substateMiddlewareFactory` helper will have this enforced via typescript. * replace `MiddlewareFactory` with `ImmutableMiddlewareFactory` * Added types: `ImmutableMiddleware` and `ImmutableMiddlewareAPI` which are similar to the ones built into redux but which enforce that state and actions aren't mutated (and which allow `Immutable` versions of actions to be dispatched. No changes to runtime code.
jloleysens
added a commit
to jloleysens/kibana
that referenced
this pull request
Apr 20, 2020
…bana into ingest-node-pipelines/privileges * 'feature/ingest-node-pipelines' of github.com:elastic/kibana: (126 commits) [SEARCH] Cleanup fetch soon (elastic#63320) skip flaky suite (elastic#58692) [Uptime] Refresh index and also show more info to user regardi… (elastic#62606) [Drilldowns] Fix back button by removing panels from url in dashboard in view mode (elastic#62415) [platform] serve plugins from /bundles/plugin:${id} [Alerting] Documentation for how to pre-configure connectors. (elastic#63807) skip flaky suite (elastic#63621) Revert "skip flaky suite (elastic#63747)" skip flaky suite (elastic#63747) [SIEM][Detections Engine] - Update rule.lists to be rule.exceptions_list (elastic#63717) [SIEM] Flaky test fix: Bump find_statuses timeout (elastic#63900) [Uptime] Add cert API request and runtime type checking (elastic#63062) [Lens] Allow table to scroll horizontally (elastic#63805) [Metrics UI] Allow users to create alerts from the central Alerts UI (elastic#63803) Migrate legacy maps licensing (x-pack/tilemap) to NP (elastic#63539) [Alerting] "Create alert" and alert list design improvements (elastic#63515) [Lens] Fix existence for dotted paths in _source (elastic#63752) Example plugins in X-Pack (elastic#63823) [ML] Migrate Mocha unit tests to Jest: migrate job utils and query utils tests (elastic#63775) Endpoint: middleware receive immutable versions of state and actions (elastic#63802) ...
|
Looks like this PR has a backport PR but it still hasn't been merged. Please merge it ASAP to keep the branches relatively in sync. |
kibanamachine
added
backport missing
oatkiller
pushed a commit
that referenced
this pull request
Apr 22, 2020
…63802) (#63887) Middleware receive state and actions, but they shouldn't mutate either. With this PR, middleware using the `substateMiddlewareFactory` helper will have this enforced via typescript. * replace `MiddlewareFactory` with `ImmutableMiddlewareFactory` * Added types: `ImmutableMiddleware` and `ImmutableMiddlewareAPI` which are similar to the ones built into redux but which enforce that state and actions aren't mutated (and which allow `Immutable` versions of actions to be dispatched. No changes to runtime code. Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Middleware receive state and actions, but they shouldn't mutate either. With this PR, middleware using the
substateMiddlewareFactoryhelper will have this enforced via typescript.MiddlewareFactorywithImmutableMiddlewareFactoryImmutableMiddlewareandImmutableMiddlewareAPIwhich are similar to the ones built into redux but which enforce that state and actions aren't mutated (and which allowImmutableversions of actions to be dispatched.No changes to runtime code.
See https://redux.js.org/faq/immutable-data for explanation of the pattern
Checklist
no runtime code changes intended
For maintainers