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

Engine debugging tools. #3978

Closed
scofalik opened this issue Feb 8, 2017 · 0 comments · Fixed by ckeditor/ckeditor5-engine#813
Closed

Engine debugging tools. #3978

scofalik opened this issue Feb 8, 2017 · 0 comments · Fixed by ckeditor/ckeditor5-engine#813
Assignees
Labels
package:engine type:improvement This issue reports a possible enhancement of an existing feature.
Milestone

Comments

@scofalik
Copy link
Contributor

scofalik commented Feb 8, 2017

As some may already experienced, debugging engine may be difficult and tiring. Especially some more complicated parts like: operational transformation or model-view conversion could use a tool that will help in debugging.

In this issue I propose introducing a method, that when called, will enhance engine classes with additional functionalities. For now we could settle with calling the function manually (i.e. at the beginning of manual sample or unit test that we want to debug).

The list of features introduced by the debug tools is not closed, for now I propose:

  • add log method to model deltas, operations, ranges and positions - the function will output clean and brief information about object so it is easier to check if, for example an operation has correct parameters,
  • print model tree, view tree and DOM tree for given root,
  • store model document state since last n operations ("history" of model document states) - to be able to easier track what changed in the model after applying an operation, stored model document will have to be printable (and maybe diffable with current model?), I think that 5-10 operations history will be enough,
  • logs in transforming operations (to see what operations/deltas where input and what was the transformation result) - possible addition, I am not sure if it will be doable this way,
  • at some point we will also probably need some help debugging LiveRanges / Markers but these will be added if and when needed.
@scofalik scofalik self-assigned this Feb 8, 2017
szymonkups referenced this issue in ckeditor/ckeditor5-engine Feb 15, 2017
Feature: Introduced debugging tools for the engine. Closes #808.
@mlewand mlewand transferred this issue from ckeditor/ckeditor5-engine Oct 9, 2019
@mlewand mlewand added this to the iteration 8 milestone Oct 9, 2019
@mlewand mlewand added status:confirmed type:improvement This issue reports a possible enhancement of an existing feature. package:engine labels Oct 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package:engine type:improvement This issue reports a possible enhancement of an existing feature.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants