Home
Huge thanks to @thejmazz for taking the time to write these notes about how the codebase works! 🍻
React-Redux App Architecture
Entrypoint
File: index.js
Imports: agent.js
, store.js
, ./components/*
Renders routes pointing to their associated components:
Agent
File: agent.js
Exports an object where each key is a "service" and a service has methods that internally run a request:
get
put
post
delete
For example, Auth
:
Thus, these services essentially take some options, map to a request, and return the promise of that request. The general type could be:
As well, agent.js
locally stores a token which can be set via the exported setToken
. As some config there is API_ROOT
.
Redux
Store
File: store.js
Imports: reducer.js
, middleware.js
Fairly simple store setup, applies promiseMiddleware
before localStorageMiddleware
, logger only on development.
Middleware
File: middleware.js
Imports: agent.js
promiseMiddleware
Intercepts all actions where action.payload
is a Promise. In which case it:
store.dispatch({ type: 'ASYNC_START', subtype: action.type })
action.payload.then
success:
store.dispatch({ type: 'ASYNC_END', promise: res })
error: sets
action.error = true
,store.dispatch({ type: 'ASYNC_END', promise: action.payload })
Then, for success and error, using the modified
action
object:store.dispatch(action)
localStorageMiddleware
Runs after promiseMiddleware
. Intercepts REGISTER | LOGIN
and either
a. sets token into localstorage and
agent.setToken(token)
b. sets token in localstorage to
''
and doesagent.setToken(null)
Reducers
File: reducer.js
Imports: ./reducers/*.js
Uses combineReducers
to export a reducer where each key is the reducer of the file with the same key.
General Reducer Patterns
map payload into piece of state
toggle loading states by casing on
ASYNC_START
andaction.subtype
toggle errors by taking
action.errors
if it is there (see middleware)
set state keys to null if they did not come in payload (Flow type issues?)
handle redirections (will be triggered by
componentWillReceiveProps
somewhere)
Components
Most mapStateToProps
won't be mentionned, as there are fairly simple. Take some objects, use them in render.
mapDispatchToProps
will be referred to as "handlers". Some will emerge as common ones. Dispatching some specific handlers on some specific lifecylce methods will also emerge as a pattern.
Handlers:
onLoad
onUnload
onSubmit
onClick
onX
onLoad
seems to be the most common one, used for any components that need ajax in data into store into props into their render method (which is basically everything on an SPA lol).
Patterns
onLoad
handlers pass a Promise or multiple promises viaPromise.all
sending multiple leads to magic
payload[0]
andpayload[1]
in reducer (seereducers/article.js
)pass a handler, e.g.
onClickTag
as a prop to a child component. child component then calls it with agent:props.onClickTag(tag, agent.Articles.byTag(tag))
. (does this only ever happen with a connectedindex.jsx
inside a folder?)to render or not to render:
similary, if you cannot call handlers yet since props are not ready:
use
componentWillReceiveProps
to call handlers if necessary, e.g. inEditor.js
:
Root Component - "/"
Imported components: Header
Handlers
onLoad: (payload, token) => dispatch({ type: 'APP_LOAD', payload, token, skipTracking: true })
onRedirect: () => dispatch({ type: 'REDIRECT' })
Lifecycle
Home Component - "/"
(<IndexRoute>
on "/")
Handlers
Lifecycle
Other Components
Should be self explanatory, follow patterns described above, it was just the home and index components are somewhat unique due to handling of routing.
Last updated