-
-
Notifications
You must be signed in to change notification settings - Fork 15.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[DRAFT]: Add a Code Splitting page to the 'Recipes' section #3190
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
8cf9d36
Add page
abettadapur 418082a
Outline
abettadapur d2b7931
Add to readme
abettadapur f66a44d
implementation example
abettadapur 4d20d09
Code splitting
abettadapur 95ff8d5
Merge branch 'master' into code-splitting-docs
markerikson 2338655
Rework code splitting page per review feedback and add page
markerikson 5a72594
Fix formatting
markerikson File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,167 @@ | ||
--- | ||
id: code-splitting | ||
title: Code Splitting | ||
sidebar_label: Code Splitting | ||
hide_title: true | ||
--- | ||
|
||
# Code Splitting | ||
|
||
In large web applications, it is often desirable to split up the app code into multiple JS bundles that can be loaded on-demand. This strategy, called 'code splitting', helps to increase performance of your application by reducing the size of the initial JS payload that must be fetched. | ||
|
||
To code split with Redux, we want to be able to dynamically add reducers to the store. However, Redux really only has a single root reducer function. This root reducer is normally generated by calling `combineReducers()` or a similar function when the application is initialized. In order to dynamically add more reducers, we need to call that function again to re-generate the root reducer. Below, we discuss some approaches to solving this problem and reference two libraries that provide this functionality. | ||
|
||
## Basic Principle | ||
|
||
### Using `replaceReducer` | ||
|
||
The Redux store exposes a `replaceReducer` function, which replaces the current active root reducer function with a new root reducer function. Calling it will swap the internal reducer function reference, and dispatch an action to help any newly-added slice reducers initialize themselves: | ||
|
||
```js | ||
const newRootReducer = combineReducers({ | ||
existingSlice: existingSliceReducer, | ||
newSlice: newSliceReducer | ||
}) | ||
|
||
store.replaceReducer(newRootReducer) | ||
``` | ||
|
||
## Reducer Injection Approaches | ||
|
||
### Defining an `injectReducer` function | ||
|
||
We will likely want to call `store.replaceReducer()` from anywhere in the application. Because of that, it's helpful | ||
to define a reusable `injectReducer()` function that keeps references to all of the existing slice reducers, and attach | ||
that to the store instance. | ||
|
||
```javascript | ||
import { createStore } from 'redux' | ||
|
||
// Define the Reducers that will always be present in the appication | ||
const staticReducers = { | ||
users: usersReducer, | ||
posts: postsReducer | ||
} | ||
|
||
// Configure the store | ||
export default function configureStore(initialState) { | ||
const store = createStore(createReducer(), initialState) | ||
|
||
// Add a dictionary to keep track of the registered async reducers | ||
store.asyncReducers = {} | ||
|
||
// Create an inject reducer function | ||
// This function adds the async reducer, and creates a new combined reducer | ||
store.injectReducer = (key, asyncReducer) => { | ||
this.asyncReducers[key] = asyncReducer | ||
this.replaceReducer(createReducer(this.asyncReducers)) | ||
} | ||
|
||
// Return the modified store | ||
return store | ||
} | ||
|
||
function createReducer(asyncReducers) { | ||
return combineReducers({ | ||
...staticReducers, | ||
...asyncReducers | ||
}) | ||
} | ||
``` | ||
|
||
Now, one just needs to call `store.injectReducer` to add a new reducer to the store. | ||
|
||
### Using a 'Reducer Manager' | ||
|
||
Another approach is to create a 'Reducer Manager' object, which keeps track of all the registered reducers and exposes a `reduce()` function. Consider the following example: | ||
|
||
```javascript | ||
export function createReducerManager(initialReducers) { | ||
// Create an object which maps keys to reducers | ||
const reducers = { ...initialReducers }; | ||
|
||
// Create the initial combinedReducer | ||
let combinedReducer = combineReducers(reducers); | ||
|
||
// An array which is used to delete state keys when reducers are removed | ||
const keysToRemove = []; | ||
|
||
return { | ||
getReducerMap: () => reducers, | ||
|
||
// The root reducer function exposed by this object | ||
// This will be passed to the store | ||
reduce: (state, action) => { | ||
// If any reducers have been removed, clean up their state first | ||
if (keysToRemove.length > 0) { | ||
state = { ...state as any }; | ||
for (let key of keysToRemove) { | ||
delete state[key]; | ||
} | ||
keysToRemove = []; | ||
} | ||
|
||
// Delegate to the combined reducer | ||
return combinedReducer(state, action); | ||
}, | ||
|
||
// Adds a new reducer with the specified key | ||
add: (key, reducer) => { | ||
if (!key || reducers[key]) { | ||
return; | ||
} | ||
|
||
// Add the reducer to the reducer mapping | ||
reducers[key] = reducer; | ||
|
||
// Generate a new combined reducer | ||
combinedReducer = combineReducers(reducers); | ||
}, | ||
|
||
// Removes a reducer with the specified key | ||
remove: (key: string) => { | ||
if (!key || !reducers[key]) { | ||
return; | ||
} | ||
|
||
// Remove it from the reducer mapping | ||
delete reducers[key]; | ||
|
||
// Add the key to the list of keys to clean up | ||
keysToRemove.push(key); | ||
|
||
// Generate a new combined reducer | ||
combinedReducer = combineReducers(rm); | ||
} | ||
}; | ||
} | ||
|
||
const staticReducers = { | ||
users: usersReducer, | ||
posts: postsReducer | ||
}; | ||
|
||
export function configureStore(initialState) { | ||
const reducerManager = createReducerManager(staticReducers); | ||
|
||
// Create a store with the root reducer function being the one exposed by the manager. | ||
const store = createStore(reducerManager.reduce, initialState); | ||
|
||
// Optional: Put the reducer manager on the store so it is easily accessible | ||
store.reducerManager = reducerManager; | ||
} | ||
``` | ||
|
||
To add a new reducer, one can now call `store.reducerManager.add("asyncState", asyncReducer)`. | ||
|
||
To remove a reducer, one can now call `store.reducerManager.remove("asyncState")` | ||
|
||
## Libraries and Frameworks | ||
|
||
There are a few good libraries out there that can help you add the above functionality automatically: | ||
|
||
- [`redux-dynostore`](https://github.com/ioof-holdings/redux-dynostore): | ||
Provides tools for building dynamic Redux stores, including dynamically adding reducers and sagas, and React bindings to help you add in association with components. | ||
- [`redux-dynamic-modules`](https://github.com/Microsoft/redux-dynamic-modules): | ||
This library introduces the concept of a 'Redux Module', which is a bundle of Redux artifacts (reducers, middleware) that should be dynamically loaded. It also exposes a React higher-order component to load 'modules' when areas of the application come online. Additionally, it has integrations with libraries like `redux-thunk` and `redux-saga` which also help dynamically load their artifacts (thunks, sagas). | ||
- [Redux Ecosystem Links: Reducers - Dynamic Reducer Injection](https://github.com/markerikson/redux-ecosystem-links/blob/master/reducers.md#dynamic-reducer-injection) |
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's have a small section on what
replaceReducer()
is here, then move any discussion ofinjectReducers()
or similar to an additional header section.