guardian/scribe

Scribe transactionManager assumes that selection is always inside an editor

Open

#153 opened on May 2, 2014

View on GitHub
 (10 comments) (0 reactions) (0 assignees)JavaScript (3,516 stars) (265 forks)batch import
bughelp wanted

Description

Scribe transactionManager assumes that selection is always inside an editor, but this can be wrong. I discovered issues because Scribe was modifying DOM outside editor.

We have the following scenario. User selects text outside the editor and based on that selection we prepopulate editor's content (I simply call jQuery .html(...) on the editor to set the content – should I use something else?). The issue is that as I prepopulate editor's content, mutation observer is triggered which calls transactionManager. And transaction manager calls:

var selection = new this.api.Selection();
selection.placeMarkers();

This places <em/> tags where selection is. But selection is outside the editor, not inside.

I think that code should check if selection is inside the editor element our outside.

Contributor guide

Tech stack
javascripthtmlcss
Domain
frontend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScriptDOM manipulationScribe core architecture
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Investigate transactionManager.js to identify where selection.placeMarkers() is called. Check the Selection module to see how to determine if selection is within the editor element. The fix involves adding a guard that ensures the selection is inside the editor before placing markers. Review comments in the issue for additional context.