You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@weex.apache.org by GitBox <gi...@apache.org> on 2018/09/17 09:38:53 UTC
[GitHub] Hanks10100 closed pull request #1531: [jsfm] Add more debug logs
for vdom operation
Hanks10100 closed pull request #1531: [jsfm] Add more debug logs for vdom operation
URL: https://github.com/apache/incubator-weex/pull/1531
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/runtime/bridge/TaskCenter.js b/runtime/bridge/TaskCenter.js
index 0d4d070d38..807451cc21 100644
--- a/runtime/bridge/TaskCenter.js
+++ b/runtime/bridge/TaskCenter.js
@@ -19,7 +19,7 @@
import CallbackManager from './CallbackManager'
import Element from '../vdom/Element'
-import { typof } from '../shared/utils'
+import { typof, checkLevel, debugLog } from '../shared/utils'
import { normalizePrimitive } from './normalize'
let fallback = function () {}
@@ -106,12 +106,20 @@ export class TaskCenter {
}
switch (type) {
- case 'dom':
+ case 'dom': {
+ if (checkLevel('debug')) {
+ debugLog(`[task](${this.instanceId},${this.type},${action}) ${JSON.stringify(args)}`)
+ }
return this[action](this.instanceId, args)
+ }
case 'component':
return this.componentHandler(this.instanceId, ref, method, args, Object.assign({ component }, options))
- default:
+ default: {
+ if (checkLevel('debug')) {
+ debugLog(`[task](${this.instanceId},${module},${method}) ${JSON.stringify(args)}`)
+ }
return this.moduleHandler(this.instanceId, module, method, args, options)
+ }
}
}
diff --git a/runtime/shared/env/console.js b/runtime/shared/env/console.js
index eb54815f30..14149ede45 100644
--- a/runtime/shared/env/console.js
+++ b/runtime/shared/env/console.js
@@ -20,14 +20,14 @@
/**
* @fileOverview
* This file will hack `console` methods by `WXEnvironment.logLevel`.
+ *
* So we can control how many and which messages will be sent by change the log level.
* Additionally in native platform the message content must be primitive values and
* using `nativeLog(...args, logLevelMark)` so we create a new `console` object in
* global add a format process for its methods.
*/
-const LEVELS = ['off', 'error', 'warn', 'info', 'log', 'debug']
-let levelMap = {}
+import { checkLevel, generateLevelMap, resetLevelMap } from '../utils'
const originalConsole = global.console
@@ -86,37 +86,10 @@ export function setNativeConsole () {
*/
/* istanbul ignore next */
export function resetNativeConsole () {
- levelMap = {}
+ resetLevelMap()
global.console = originalConsole
}
-/**
- * Generate map for which types of message will be sent in a certain message level
- * as the order of LEVELS.
- */
-function generateLevelMap () {
- LEVELS.forEach(level => {
- const levelIndex = LEVELS.indexOf(level)
- levelMap[level] = {}
- LEVELS.forEach(type => {
- const typeIndex = LEVELS.indexOf(type)
- if (typeIndex <= levelIndex) {
- levelMap[level][type] = true
- }
- })
- })
-}
-
-/**
- * Check if a certain type of message will be sent in current log level of env.
- * @param {string} type
- * @return {boolean}
- */
-function checkLevel (type) {
- const logLevel = (global.WXEnvironment && global.WXEnvironment.logLevel) || 'log'
- return levelMap[logLevel] && levelMap[logLevel][type]
-}
-
/**
* Convert all log arguments into primitive values.
* @param {array} args
diff --git a/runtime/shared/utils.js b/runtime/shared/utils.js
index c2ab10f02d..6dd42d1e6a 100644
--- a/runtime/shared/utils.js
+++ b/runtime/shared/utils.js
@@ -69,3 +69,50 @@ export function isEmpty (any) {
}
return true
}
+
+const LEVELS = ['off', 'error', 'warn', 'info', 'log', 'debug']
+let levelMap = {}
+
+/**
+ * Generate map for which types of message will be sent in a certain message level
+ * as the order of LEVELS.
+ */
+export function generateLevelMap () {
+ LEVELS.forEach(level => {
+ const levelIndex = LEVELS.indexOf(level)
+ levelMap[level] = {}
+ LEVELS.forEach(type => {
+ const typeIndex = LEVELS.indexOf(type)
+ if (typeIndex <= levelIndex) {
+ levelMap[level][type] = true
+ }
+ })
+ })
+}
+
+/**
+ * Reset level map to empty object,
+ * then the log level can be toggled at runtime.
+ */
+export function resetLevelMap () {
+ levelMap = {}
+}
+
+/**
+ * Check if a certain type of message will be sent in current log level of env.
+ * @param {string} type
+ * @return {boolean}
+ */
+export function checkLevel (type) {
+ const logLevel = (global.WXEnvironment && global.WXEnvironment.logLevel) || 'log'
+ return levelMap[logLevel] && levelMap[logLevel][type]
+}
+
+/**
+ * Print debug log regardless of level check.
+ *
+ * This methods can avoid "double level check" compared with using wrapped console.debug
+ */
+export function debugLog (text) {
+ global.nativeLog('wxInteractionAnalyzer: [jsfm]' + text, '__DEBUG')
+}
diff --git a/runtime/vdom/Document.js b/runtime/vdom/Document.js
index 474bf0f82c..e4374a6c46 100644
--- a/runtime/vdom/Document.js
+++ b/runtime/vdom/Document.js
@@ -20,6 +20,7 @@
import Comment from './Comment'
import Element from './Element'
import Listener from '../bridge/Listener'
+import { checkLevel, debugLog } from '../shared/utils'
import { TaskCenter } from '../bridge/TaskCenter'
import { createHandler } from '../bridge/Handler'
import { addDoc, removeDoc, appendBody, setBody } from './operation'
@@ -109,6 +110,10 @@ export default class Document {
appendBody(this, node, before)
}
})
+
+ if (checkLevel('debug')) {
+ debugLog(`Create document element (id: "${el.docId}", ref: "${el.ref}")`)
+ }
}
return this.documentElement
@@ -124,6 +129,10 @@ export default class Document {
if (!this.body) {
const el = new Element(type, props)
setBody(this, el)
+ if (checkLevel('debug')) {
+ debugLog(`[createBody](${this.id},${el.type},${el.ref}) `
+ + `(${JSON.stringify(el.toJSON(true))}).`)
+ }
}
return this.body
@@ -136,7 +145,12 @@ export default class Document {
* @return {object} element
*/
createElement (tagName, props) {
- return new Element(tagName, props)
+ const el = new Element(tagName, props)
+ if (checkLevel('debug')) {
+ debugLog(`[createElement](${this.id},${el.type},${el.ref}) `
+ + `(${JSON.stringify(el.toJSON(true))}).`)
+ }
+ return el
}
/**
@@ -182,11 +196,17 @@ export default class Document {
* Destroy current document, and remove itself form docMap.
*/
destroy () {
+ if (checkLevel('debug')) {
+ debugLog(`[destroy](${this.id},document,${this.ref}) `
+ + `Destroy document (id: "${this.id}", URL: "${this.URL}")`)
+ }
+
removeDoc(this.id)
delete this.id
delete this.URL
delete this.documentElement
delete this.ownerDocument
+ delete this.body
// remove listener and taskCenter
delete this.listener
diff --git a/runtime/vdom/Element.js b/runtime/vdom/Element.js
index 7804047aec..bf7536cf60 100644
--- a/runtime/vdom/Element.js
+++ b/runtime/vdom/Element.js
@@ -28,7 +28,7 @@ import {
moveIndex,
removeIndex
} from './operation'
-import { uniqueId, isEmpty } from '../shared/utils'
+import { uniqueId, isEmpty, checkLevel, debugLog } from '../shared/utils'
import { getWeexElement, setElement } from './WeexElement'
const DEFAULT_TAG_NAME = 'div'
@@ -75,6 +75,10 @@ export default class Element extends Node {
}
/* istanbul ignore else */
if (!node.parentNode) {
+ if (checkLevel('debug')) {
+ debugLog(`[appendChild](${this.docId},${node.type},${node.ref}) `
+ + `Append <${node.type}> to <${this.type}> (${this.ref}).`)
+ }
linkParent(node, this)
insertIndex(node, this.children, this.children.length, true)
if (this.docId) {
@@ -93,6 +97,10 @@ export default class Element extends Node {
}
}
else {
+ if (checkLevel('debug')) {
+ debugLog(`[appendChild](${this.docId},${node.type},${node.ref}) `
+ + `Move <${node.type}> to ${this.children.length} of <${this.type}> (${this.ref}).`)
+ }
moveIndex(node, this.children, this.children.length, true)
if (node.nodeType === 1) {
const index = moveIndex(node, this.pureChildren, this.pureChildren.length)
@@ -122,6 +130,10 @@ export default class Element extends Node {
return
}
if (!node.parentNode) {
+ if (checkLevel('debug')) {
+ debugLog(`[insertBefore](${this.docId},${node.type},${node.ref}) `
+ + `Insert <${node.type}> to <${this.type}> (${this.ref}), before (${before.ref}).`)
+ }
linkParent(node, this)
insertIndex(node, this.children, this.children.indexOf(before), true)
if (this.docId) {
@@ -184,6 +196,10 @@ export default class Element extends Node {
return
}
if (!node.parentNode) {
+ if (checkLevel('debug')) {
+ debugLog(`[insertAfter](${this.docId},${node.type},${node.ref}) `
+ + `Insert <${node.type}> to <${this.type}> (${this.ref}), after (${after.ref}).`)
+ }
linkParent(node, this)
insertIndex(node, this.children, this.children.indexOf(after) + 1, true)
/* istanbul ignore else */
@@ -236,6 +252,10 @@ export default class Element extends Node {
if (node.parentNode) {
removeIndex(node, this.children, true)
if (node.nodeType === 1) {
+ if (checkLevel('debug')) {
+ debugLog(`[removeChild](${this.docId},${node.type},${node.ref}) `
+ + `Remove <${node.type}> from <${this.type}> (${this.ref}).`)
+ }
removeIndex(node, this.pureChildren)
const taskCenter = getTaskCenter(this.docId)
if (taskCenter) {
@@ -403,6 +423,10 @@ export default class Element extends Node {
this.event = {}
}
if (!this.event[type]) {
+ if (checkLevel('debug')) {
+ debugLog(`[addEvent](${this.docId},${this.type},${this.ref}) `
+ + `Add "${type}" event on <${this.type}> (${this.ref}).`)
+ }
this.event[type] = { handler, params }
const taskCenter = getTaskCenter(this.docId)
if (taskCenter) {
@@ -421,6 +445,10 @@ export default class Element extends Node {
*/
removeEvent (type) {
if (this.event && this.event[type]) {
+ if (checkLevel('debug')) {
+ debugLog(`[removeEvent](${this.docId},${this.type},${this.ref}) `
+ + `Remove "${type}" event on <${this.type}> (${this.ref}).`)
+ }
delete this.event[type]
const taskCenter = getTaskCenter(this.docId)
if (taskCenter) {
@@ -446,6 +474,10 @@ export default class Element extends Node {
let isStopPropagation = false
const eventDesc = this.event[type]
if (eventDesc && event) {
+ if (checkLevel('debug')) {
+ debugLog(`[fireEvent](${this.docId},${this.type},${this.ref}) `
+ + `Fire "${type}" event on <${this.type}> (${this.ref}).`)
+ }
const handler = eventDesc.handler
event.stopPropagation = () => {
isStopPropagation = true
@@ -486,9 +518,10 @@ export default class Element extends Node {
/**
* Convert current element to JSON like object.
+ * @param {boolean} ignoreChildren whether to ignore child nodes, default false
* @return {object} element
*/
- toJSON () {
+ toJSON (ignoreChildren = false) {
const result = {
ref: this.ref.toString(),
type: this.type,
@@ -508,7 +541,7 @@ export default class Element extends Node {
if (event.length) {
result.event = event
}
- if (this.pureChildren.length) {
+ if (!ignoreChildren && this.pureChildren.length) {
result.children = this.pureChildren.map((child) => child.toJSON())
}
return result
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services