Relay: Document Relay network debugger

Created on 2 Jun 2016  路  4Comments  路  Source: facebook/relay

RelayNetworkDebug

From Relay@^0.8.0 available relay requests debugger RelayNetworkDebug

import RelayNetworkDebug from 'react-relay/lib/RelayNetworkDebug';  
RelayNetworkDebug.init();

screenshot

_ _ DEV _ _=true

From Relay@^0.9.0 became availiable relay's extended mutation debugger.
screen shot 2016-06-02 at 12 34 35

For activation via browser's console: type __DEV__=true.
Due webpack build process you may use webpack.BannerPlugin('__DEV__=true;', {raw: true}) or webpack.DefinePlugin({__DEV__: true}).

In Changelog 0.9.0 absent underscores for __DEV__. Not clean understandable how to turn this debugger.

docs help wanted

Most helpful comment

PSA: If you're using a custom relay environment, be sure to do

let myEnv = new Relay.Environment();
RelayNetworkDebug.init(myEnv)

All 4 comments

And again about Documentation

May be somebody add a Debugging article to documentation. Also will be great if leave article about scheduling (thanks to last Joseph talk, I don't know that this cool feature exists).

My english right now is to bad to write articles, and I hate to do it, cause spent a lot of time. I prefer to write some code.

May be at facebook exists so-so-coders that under dismissal ;), and may be somebody will became a brilliant technical writer ;) Good coder IS NOT good writer and vise versa. So for documentation I think should exist dedicated person.

Also it will be interesting to read about Docker's OSS results: https://blog.docker.com/2016/05/open-source-docker-part-1-people/ I think they can not reach such results without their clean documentation.

PSA: If you're using a custom relay environment, be sure to do

let myEnv = new Relay.Environment();
RelayNetworkDebug.init(myEnv)

My english right now is to bad to write articles, and I hate to do it, cause spent a lot of time. I prefer to write some code.

This is a legit stance!

Is anybody else able to whip up a PR? I'm cleaning house trying to prepare the next release this week, so I can't promise getting to it myself, but a "Debugging" page in the docs would be great.

Thanks for bringing this up @nodkz, and thanks @BlooJeans for the PSA.

Closing this as we're unlikely to further document the Relay Classic APIs now that Relay Modern is out. PRs improving the Relay Modern docs, however, would be very welcome.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

fedbalves picture fedbalves  路  3Comments

MartinDawson picture MartinDawson  路  3Comments

staylor picture staylor  路  3Comments

amccloud picture amccloud  路  3Comments

leebyron picture leebyron  路  3Comments