Feature request: Debug Mode

[mmorris8]

I just spent two weeks wrestling with getting tabs driven by react-router-dom and react-aria to work. I'm now two weeks behind on a project as I didn't think this functionality would take more than a couple hours to put in. We need to be able to put instant search into debug mode.

const search = instantsearch({
  debug: {} // object or true
});

In debug mode console.log statements will be executed at strategic points in the execution flow. True can be passed for a logical default, or an object can be passed to detail which log statements will be executed and what data will be shown.

Hook points

Critical functions will be monitored with the args fed to them logged and their output logged.

• Refine
• Clear Facets
• stateMapping - routeToState
• stateMapping - stateToRoute
• history - createUrl
• history - parseUrl

Flags

• uiState - whether to log the uiState before and after a hook function is called

This is a quick draft. I'm still tired. I'm prepared to fork and write this, but I want some input from the community on whether anyone else would find this useful and what other sorts of information could be logged. Also, instead of simply doing "true" perhaps string descriptions of what to log.

[Haroenv]

This seems like an interesting idea. In the past we've experimented with a browser extension as well, but found it tough to narrow down what to expose, so that doesn't exist.

I think the way to go would be a middleware that logs out the uiState changes, as well as on-demand which widgets are mounted, this way it doesn't have impact on all the parts of the code and become hard to tree shake out (text for logs is usually quite large).