refactor: 💡 Add options to the "call" middleware (#17)

"call" now needs the new options "runOnServer", "runOnHydrate" to be
passed explicitly, rather than using hard-coded logic to determine where
to run.
"runOnClientRender" has not been added since there's currently no
use-case for skipping client render.

This aims to clarify when each callback runs.

Author: toerndev

packages/rudy/src/core/createRouter.js

@@ -1,5 +1,6 @@
 // @flow
 import qs from 'qs'
+import { createSelector } from '@respond-framework/utils'
 import type {
   Options,
   Store,
@@ -22,8 +23,6 @@ import {
   onError as defaultOnError,
 } from '../utils'
 
-import { createSelector } from '@respond-framework/utils'
-
 import {
   serverRedirect,
   pathlessRoute,
@@ -42,14 +41,16 @@ export default (
     anonymousThunk,
     pathlessRoute('thunk'),
     transformAction, // pipeline starts here
+    // Hydrate: skip callbacks called on server to produce initialState (beforeEnter, thunk, etc)
+    // Server: don't allow client-centric callbacks (onEnter, onLeave, beforeLeave)
     call('beforeLeave', { prev: true }),
-    call('beforeEnter'),
+    call('beforeEnter', { runOnServer: true }),
     enter,
     changePageTitle(),
     call('onLeave', { prev: true }),
-    call('onEnter'),
-    call('thunk', { cache: true }),
-    call('onComplete'),
+    call('onEnter', { runOnHydrate: true }),
+    call('thunk', { cache: true, runOnServer: true }),
+    call('onComplete', { runOnServer: true }),
   ],
 ) => {
   const {
@@ -82,7 +83,9 @@ export default (
   const has = (name: string) => wares[name]
   const ctx = { busy: false }
   const api = { routes, history, options, register, has, ctx }
-  const onError = call('onError')(api)
+  const onError = call('onError', { runOnServer: true, runOnHydrate: true })(
+    api,
+  )
   const nextPromise = options.compose(
     middlewares,
     api,

packages/rudy/src/middleware/call/utils/shouldCall.js

@@ -1,16 +1,14 @@
 // @flow
-import type { LocationState } from '../../../flow-types'
 import { isServer } from '@respond-framework/utils'
+import type { LocationState } from '../../../flow-types'
 import { isHydrate } from '../../../utils'
 
-export default (name, route, req) => {
+export default (name, route, req, { runOnServer, runOnHydrate }) => {
   if (!route[name] && !req.options[name]) return false
 
-  // skip callbacks (beforeEnter, thunk, etc) called on server, which produced initialState
-  if (isHydrate(req) && !/onEnter|onError/.test(name)) return false
+  if (isHydrate(req) && !runOnHydrate) return false
 
-  // dont allow these client-centric callbacks on the server
-  if (isServer() && /onEnter|Leave/.test(name)) return false
+  if (isServer() && !runOnServer) return false
 
   return allowBoth
 }

packages/rudy/src/middleware/pathlessRoute.js

@@ -4,7 +4,9 @@ export default (...names) => (api) => {
   names[0] = names[0] || 'thunk'
   names[1] = names[1] || 'onComplete'
 
-  const middlewares = names.map((name) => call(name, { skipOpts: true }))
+  const middlewares = names.map((name) =>
+    call(name, { runOnServer: true, skipOpts: true }),
+  )
 
   const pipeline = api.options.compose(
     middlewares,