Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature - HTML report on turn processing #27

Open
mikelid-zz opened this issue Oct 28, 2020 · 0 comments
Open

Feature - HTML report on turn processing #27

mikelid-zz opened this issue Oct 28, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@mikelid-zz
Copy link
Contributor

I'm submitting a...


[ ] Regression (a behavior that used to work and stopped working in a new release)
[ ] Bug report  
[ ] Performance issue
[x] Feature request
[ ] Documentation issue or request
[ ] Other... Please describe:

Currently there are logs generated by the framework and the builtin-controls. These logs help to describe what is happening during processing and also include text-format tree-diagram of controls and a brief summary of their state. While useful, we can perhaps offer more by generating HTML documents with stylesheets to control presentation, similar to test-output and profiler reports.

Likely mechanism

  • add a new instrumentation module that allows framework and controls to add typed content that is associated to modules.
  • the instrumentation module collates the information then formats it as structured data. CSS stylesheets or similar provide presentation and affordances such as collapsible sections.

Likely content

  • Start of turn tree diagram with props & state information available for viewing. (likely only the props that are simple types)
  • Tree diagram describing what happened during canHandle. Which controls return canHandle=true, what decision was made by containers (and why).
  • Information from the handling control about it processing and the acts generated
  • Post handling tree diagram with all state information available for viewing.
  • Tree diagram describing what happened during canTakeInitiative.
  • Information from the initiative control about its processing and the acts generated
  • Information about the rendering phases. Which render functions ran, how was the output pieced together.
  • End of turn tree diagram with all state information available for viewing.
@mikelid-zz mikelid-zz added the enhancement New feature or request label Oct 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant