@dazn/kopytko-framework 2.1.4 → 3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dazn/kopytko-framework",
-  "version": "2.1.4",
+  "version": "3.0.0",
   "description": "A modern Roku's Brightscript framework",
   "keywords": [
     "brightscript",

package/src/components/renderer/Kopytko.brs

@@ -1,7 +1,10 @@
+' @import /components/functionCall.brs from @dazn/kopytko-utils
+
 sub init()
   m.state = {}
   m.elementToFocus = Invalid
 
+  m._enabledErrorCatching = _isComponentDidCatchEnabled()
   m._isInitialized = false
   m._previousProps = {}
   m._previousState = {}
@@ -21,7 +24,8 @@ sub initKopytko(dynamicProps = {} as Object, componentsMapping = {} as Object)
   m.top.observeFieldScoped("focusedChild", "focusDidChange")
   m.top.update(dynamicProps)
 
-  constructor()
+  _methodCall(constructor, "constructor")
+
   m._previousState = _cloneObject(m.state) ' required because of setting default state in constructor()
 
   _mountComponent()
@@ -32,7 +36,7 @@ end sub
 sub destroyKopytko(data = {} as Object)
   if (NOT m._isInitialized) then return
 
-  componentWillUnmount()
+  _methodCall(componentWillUnmount, "componentWillUnmount")
 
   if (m["$$eventBus"] <> Invalid)
     m["$$eventBus"].clear()
@@ -41,7 +45,8 @@ sub destroyKopytko(data = {} as Object)
   m.state = {}
   m._previousState = {}
   m.top.unobserveFieldScoped("focusedChild")
-  m._kopytkoUpdater.destroy()
+
+  _methodCall(m._kopytkoUpdater.destroy, "destroyKopytko", [], m._kopytkoUpdater)
 
   _clearDOM()
 
@@ -73,15 +78,15 @@ sub focusDidChange(event as Object)
 end sub
 
 sub setState(partialState as Object, callback = Invalid as Dynamic)
-  m._kopytkoUpdater.enqueueStateUpdate(partialState, callback)
+  _methodCall(m._kopytkoUpdater.enqueueStateUpdate, "setState", [partialState, callback], m._kopytkoUpdater)
 end sub
 
 sub forceUpdate()
-  m._kopytkoUpdater.forceStateUpdate()
+  _methodCall(m._kopytkoUpdater.forceStateUpdate, "forceUpdate", [], m._kopytkoUpdater)
 end sub
 
 sub enqueueUpdate()
-  m._kopytkoUpdater.enqueueStateUpdate()
+  _methodCall(m._kopytkoUpdater.enqueueStateUpdate, "enqueueUpdate", [], m._kopytkoUpdater)
 end sub
 
 sub updateProps(props = {} as Object)
@@ -92,10 +97,10 @@ end sub
 
 sub _mountComponent()
   m._virtualDOM = render()
-  m._kopytkoDOM.renderElement(m._virtualDOM, m.top)
 
-  m._kopytkoUpdater.setComponentMounted(m.state)
-  componentDidMount()
+  _methodCall(m._kopytkoDOM.renderElement, "renderElement", [m._virtualDOM, m.top], m._kopytkoDOM)
+  _methodCall(m._kopytkoUpdater.setComponentMounted, "setComponentMounted", [m.state], m._kopytkoUpdater)
+  _methodCall(componentDidMount, "componentDidMount")
 end sub
 
 sub _onStateUpdated()
@@ -114,7 +119,8 @@ sub _updateDOM()
     m.top.setFocus(true)
   end if
 
-  componentDidUpdate(m._previousProps, m._previousState)
+  _methodCall(componentDidUpdate, "componentDidUpdate", [m._previousProps, m._previousState])
+
   m._previousState = _cloneObject(m.state)
 end sub
 
@@ -131,3 +137,37 @@ function _cloneObject(obj as Object) as Object
 
   return newObj
 end function
+
+function _isComponentDidCatchEnabled() as Boolean
+  isComponentDidCatchEnabled = false
+
+  #if enableKopytkoComponentDidCatch
+    isComponentDidCatchEnabled = true
+  #end if
+
+  return isComponentDidCatchEnabled AND Type(componentDidCatch) <> "<uninitialized>"
+end function
+
+sub _methodCall(func as Function, methodName as String, args = [] as Object, context = Invalid as Object)
+  if (m._enabledErrorCatching)
+    try
+      functionCall(func, args, context)
+    catch error
+      _throw(error, methodName)
+    end try
+
+    return
+  end if
+
+  functionCall(func, args, context)
+end sub
+
+sub _throw(error as Object, failingComponentMethod as String)
+  componentDidCatch(error, {
+    componentMethod: failingComponentMethod,
+    componentName: m.top.subtype(),
+    componentProps: m.top.getFields(),
+    componentState: m.state,
+    componentVirtualDOM: m._virtualDOM,
+  })
+end sub

package/src/components/router/ActivatedRoute.xml

@@ -9,6 +9,7 @@
     <field id="renderedUrl" type="string" />
     <field id="routeConfig" type="assocarray" />
     <field id="shouldSkip" type="boolean" />
+    <field id="skipInHistory" type="boolean" />
     <field id="virtualPath" type="string" />
   </interface>
 </component>

package/src/components/router/Router.brs

@@ -1,48 +1,48 @@
 ' @import /components/buildUrl.brs from @dazn/kopytko-utils
 ' @import /components/getProperty.brs from @dazn/kopytko-utils
 ' @import /components/NodeUtils.brs from @dazn/kopytko-utils
-' @import /components/ternary.brs from @dazn/kopytko-utils
 ' @import /components/utils/KopytkoGlobalNode.brs
+
 sub init()
   _global = KopytkoGlobalNode()
   _global.addFields({
     router: m.top,
   })
-  m.top.activatedRoute = CreateObject("roSGNode", "ActivatedRoute")
+  m.top.activatedRoute = _createRoute()
 
   m._history = []
 end sub
 
-sub navigate(data as Object)
-  url = buildUrl(data.path, data.params)
+sub navigate(navigateData as Object)
+  url = buildUrl(navigateData.path, navigateData.params)
   if (url = m.top.url) then return ' Avoid doubling url
 
-  if (data.skipInHistory = Invalid OR (NOT data.skipInHistory))
+  isBackJourney = getProperty(navigateData, "isBackJourney", false)
+
+  if (NOT getProperty(navigateData, "skipInHistory", false))
     _updateHistory()
   end if
 
-  if (NOT m.top.activatedRoute.shouldSkip)
-    m.top.previousRoute = NodeUtils().cloneNode(m.top.activatedRoute)
-  end if
+  ' Needs to be set before activatedRoute as _getPreviousRoute uses the previous value of activatedRoute.
+  m.top.previousRoute = _getPreviousRoute(isBackJourney)
 
-  m.top.activatedRoute.path = data.path
-  m.top.activatedRoute.params = ternary(data.params <> Invalid, data.params, {})
-  m.top.activatedRoute.backJourneyData = data.backJourneyData
-  m.top.activatedRoute.isBackJourney = getProperty(data, "isBackJourney", false)
+  m.top.activatedRoute.path = getProperty(navigateData, "path", "")
+  m.top.activatedRoute.params = getProperty(navigateData, "params", {})
+  m.top.activatedRoute.backJourneyData = navigateData.backJourneyData
+  m.top.activatedRoute.isBackJourney = isBackJourney
   m.top.activatedRoute.shouldSkip = false
-  m.top.activatedRoute.virtualPath = ""
+  m.top.activatedRoute.virtualPath = getProperty(navigateData, "virtualPath", "")
   m.top.url = url
 end sub
 
-function back(data = {} as Object) as Boolean
-  previousLocation = m._history.pop()
-  if (previousLocation = Invalid)
-    return false
-  end if
+function back(_backData = {} as Object) as Boolean
+  previousRoute = m._history.pop()
+
+  if (previousRoute = Invalid) then return false
 
-  previousLocation.skipInHistory = true
-  previousLocation.isBackJourney = true
-  navigate(previousLocation)
+  previousRoute.skipInHistory = true
+  previousRoute.isBackJourney = true
+  navigate(previousRoute)
 
   return true
 end function
@@ -51,22 +51,25 @@ sub resetHistory(rootPath = "" as String)
   m._history = []
 
   if (rootPath <> "")
-    m._history.push({ path: rootPath, params: {} })
+    m._history.push(_createRoute({ path: rootPath }))
   end if
 end sub
 
+function _getPreviousRoute(isBackJourney as Boolean) as Object
+  if (isBackJourney OR m.top.activatedRoute.shouldSkip) then return m._history.peek()
+
+  return NodeUtils().cloneNode(m.top.activatedRoute)
+end function
+
 sub _updateHistory()
-  if (m.top.url = "" OR m.top.activatedRoute.shouldSkip)
-    return
-  end if
+  if (m.top.url = "" OR m.top.activatedRoute.shouldSkip) then return
 
-  m._history.push(_createHistoryItem(m.top.activatedRoute))
+  m._history.push(NodeUtils().cloneNode(m.top.activatedRoute))
 end sub
 
-function _createHistoryItem(route as Object) as Object
-  return {
-    path: route.path,
-    params: route.params,
-    backJourneyData: route.backJourneyData,
-  }
+function _createRoute(routeData = {} as Object) as Object
+  route = CreateObject("roSGNode", "ActivatedRoute")
+  route.setFields(routeData)
+
+  return route
 end function