Make MessageQueue to emit "SPY" events in a way that can be extensible #9160

jondot · 2016-08-02T11:10:50Z

This PR adds a capability for MessageQueue to emit "SPY" events in a way that can be extensible, to later allow for a tooling ecosystem to grow, one example is the existing Snoopy tool that is, for now, forced to work with monkeypatches, and after this PR will be able to use a "formal" way to trace queue events.

After this change, we can wire a "spy" into a queue that will expose the events in different and interesting ways, see below (done with Snoopy):

This removes the hardcoded SPY_MODE flag and instead uses a function that can be injected from outside world.

MessageQueue.spy((info)=>console.log("event!", info)

It also creates a structured descriptor for an event, so in the above example, console.log will accept the following object shape:

{
   type: integer, (0:TO_JS, 1:TO_NATIVE)
   module:string,
   method:string,
   args:[object]
}

Once a spy exists (and we're in __DEV__ mode), the queue will start using it.

In terms of core changes - I feel this was a low-hanging-fruit, small enough to pick.

in a way that can be extensible. After this change, we can wire a "spy" into a queue that will expose the events in different and interesting ways. This removes the hardcoded `SPY_MODE` flag and instead uses a function that can be injected from outside. This change will enable a tool like Snoopy to exist, without its internal monkeypatching of MessageQueue: https://github.com/jondot/rn-snoopy This was a low-hanging-fruit waiting to be picked. And now, we have deeper and more elaborate introspection at the React Native bridge traffic, empowering optimization and debugging scenarios alike.

ghost · 2016-08-02T11:12:07Z

By analyzing the blame information on this pull request, we identified @javache and @lexs to be potential reviewers.

eslint-bot · 2016-08-02T11:16:04Z

Libraries/Utilities/MessageQueue.js

@@ -26,9 +26,10 @@ const METHOD_IDS = 1;
 const PARAMS = 2;
 const MIN_TIME_BETWEEN_FLUSHES_MS = 5;

-const TRACE_TAG_REACT_APPS = 1 << 17;
+const TO_NATIVE = 1
+const TO_JS = 0


semi: Missing semicolon.

facebook-github-bot · 2016-08-02T11:30:41Z

@jondot updated the pull request.

ghost · 2016-08-02T11:30:55Z

@jondot updated the pull request.

javache · 2016-08-03T10:18:15Z

Libraries/Utilities/MessageQueue.js

@@ -182,18 +188,22 @@ class MessageQueue {
      this._lastFlush = now;
    }
    Systrace.counterEvent('pending_js_to_native_queue', this._queue[0].length);
-    if (__DEV__ && SPY_MODE && isFinite(module)) {
-      console.log('JS->N : ' + this._remoteModuleTable[module] + '.' +


Can you keep the original console.log feature around somewhere?

Yes!
I'm thinking perhaps a default 'spy' implementation, that you can use and is built-in.
Something like I did with this and this.

The ergonomics would look like this:

MessageQueue.spy()

sets the default logging strategy in place.

Then clearing a spy, disables tracing, and would have to be done like so

MessageQueue.spy(null)

WDYT?

Maybe MessageQueue.spy(true) to turn on the default function, MessageQueue.spy(fn) to provide a custom function and MessageQueue.spy(false) to turn it off?

sounds even better, thanks for the idea!

Changes are in!

facebook-github-bot · 2016-08-03T20:04:27Z

@jondot updated the pull request.

javache · 2016-08-03T20:08:00Z

Libraries/Utilities/MessageQueue.js

-const TRACE_TAG_REACT_APPS = 1 << 17;
+const TO_NATIVE = 1;
+const TO_JS = 0;
+const defaultSpy = (info)=>console.log(`${info.type == TO_JS ? 'N->JS' : 'JS->N'} : ${info.module ? (info.module+'.') : ''}${info.method}(${JSON.stringify(info.args)})`);


Can you split this over multiple lines? Since it's also only used in one spot, I'd just define it inline in spy

eslint-bot · 2016-08-03T20:20:28Z

Libraries/Utilities/MessageQueue.js

keyword-spacing: Expected space(s) after "if".

ghost · 2016-08-03T20:29:43Z

@jondot updated the pull request.

eslint-bot · 2016-08-03T20:36:06Z

Libraries/Utilities/MessageQueue.js

@@ -90,6 +91,19 @@ class MessageQueue {
  /**
   * Public APIs


eqeqeq: Expected '===' and instead saw '=='.

facebook-github-bot · 2016-08-04T05:43:08Z

@jondot updated the pull request.

eslint-bot · 2016-08-04T05:47:22Z

Libraries/Utilities/MessageQueue.js


-const SPY_MODE = false;
+const TRACE_TAG_REACT_APPS = 1 << 17;

 const MethodTypes = keyMirror({


semi: Missing semicolon.

eslint-bot · 2016-08-04T05:47:22Z

Libraries/Utilities/MessageQueue.js


-const SPY_MODE = false;
+const TRACE_TAG_REACT_APPS = 1 << 17;


space-infix-ops: Infix operators must be spaced.

javache · 2016-08-04T09:20:27Z

@facebook-github-bot shipit

ghost · 2016-08-04T09:21:19Z

Thanks for importing.

Summary: This PR adds a capability for MessageQueue to emit "SPY" events in a way that can be extensible, to later allow for a tooling ecosystem to grow, one example is the existing [Snoopy](https://github.com/jondot/rn-snoopy) tool that is, for now, forced to work with monkeypatches, and after this PR will be able to use a "formal" way to trace queue events. After this change, we can wire a "spy" into a queue that will expose the events in different and interesting ways, see below (done with Snoopy): <img src="https://github.com/jondot/rn-snoopy/blob/master/media/snoopy.gif?raw=true" alt="Aggregating and Charting Events with Bar" width="400px"/> <img src="https://github.com/jondot/rn-snoopy/blob/master/media/snoopy-filter.gif?raw=true" alt="Aggregating and Charting Events with Bar" width="400px"/> This removes the hardcoded `SPY_MODE` flag and instead uses a function that can be injected from outside world. ```javascript MessageQueue.spy((info)=>console.log("event!", info) ``` It also creates Closes facebook#9160 Differential Revision: D3669053 Pulled By: javache fbshipit-source-id: 3e4462aa77fc8514d2ea4f15430f7bec57b583a4

see: facebook/react-native#9160 Bump version so that it's visibly clear this is React Native 0.33 and up (v1.33.0) Update example and make notes of this in README.

jondot added 2 commits August 2, 2016 13:53

make compatible with rn-snoopy

d4c26c5

ghost added GH Review: review-needed CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. labels Aug 2, 2016

eslint-bot reviewed Aug 2, 2016
View reviewed changes

add semicolons

71b4d40

ghost added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Aug 2, 2016

javache reviewed Aug 3, 2016
View reviewed changes

add default spy, better spy() interface. /cc @javache

0ab77fe

javache reviewed Aug 3, 2016
View reviewed changes

facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Aug 3, 2016

eslint-bot reviewed Aug 3, 2016
View reviewed changes

Libraries/Utilities/MessageQueue.js

@@ -90,6 +92,17 @@ class MessageQueue {

Copy link

eslint-bot Aug 3, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

keyword-spacing: Expected space(s) after "if".

inline log, cosmetics

8f98429

ghost added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Aug 3, 2016

eslint-bot reviewed Aug 3, 2016
View reviewed changes

Libraries/Utilities/MessageQueue.js

@@ -90,6 +91,19 @@ class MessageQueue {

/**

* Public APIs

Copy link

eslint-bot Aug 3, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

eqeqeq: Expected '===' and instead saw '=='.

some more cosmetics

fbcf3c1

eslint-bot reviewed Aug 4, 2016
View reviewed changes

ghost added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Aug 4, 2016

ghost added GH Review: accepted Import Started This pull request has been imported. This does not imply the PR has been approved. and removed GH Review: review-needed labels Aug 4, 2016

ghost added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Aug 4, 2016

ghost closed this in 77e48f1 Aug 4, 2016

yenda mentioned this pull request Jan 8, 2018

Make an MVP for a Github bot status-im/status-github-bot#1

Closed

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make MessageQueue to emit "SPY" events in a way that can be extensible #9160

Make MessageQueue to emit "SPY" events in a way that can be extensible #9160

jondot commented Aug 2, 2016

ghost commented Aug 2, 2016

eslint-bot Aug 2, 2016

facebook-github-bot commented Aug 2, 2016

ghost commented Aug 2, 2016

javache Aug 3, 2016

jondot Aug 3, 2016 •

edited

Loading

javache Aug 3, 2016

jondot Aug 3, 2016

jondot Aug 3, 2016

facebook-github-bot commented Aug 3, 2016

javache Aug 3, 2016

jondot Aug 3, 2016

eslint-bot Aug 3, 2016

ghost commented Aug 3, 2016

eslint-bot Aug 3, 2016

facebook-github-bot commented Aug 4, 2016

eslint-bot Aug 4, 2016

eslint-bot Aug 4, 2016

javache commented Aug 4, 2016

ghost commented Aug 4, 2016


		const SPY_MODE = false;
		const TRACE_TAG_REACT_APPS = 1 << 17;

Make MessageQueue to emit "SPY" events in a way that can be extensible #9160

Make MessageQueue to emit "SPY" events in a way that can be extensible #9160

Conversation

jondot commented Aug 2, 2016

ghost commented Aug 2, 2016

Choose a reason for hiding this comment

facebook-github-bot commented Aug 2, 2016

ghost commented Aug 2, 2016

Choose a reason for hiding this comment

jondot Aug 3, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

facebook-github-bot commented Aug 3, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost commented Aug 3, 2016

Choose a reason for hiding this comment

facebook-github-bot commented Aug 4, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

javache commented Aug 4, 2016

ghost commented Aug 4, 2016

jondot Aug 3, 2016 •

edited

Loading