TNL-213: Let Students Add Personal Notes to Course Content.
Co-Authored-By: Jean-Michel Claus <jmc@edx.org> Co-Authored-By: Brian Talbot <btalbot@edx.org> Co-Authored-By: Tim Babych <tim@edx.org> Co-Authored-By: Oleg Marshev <oleg@edx.org> Co-Authored-By: Chris Rodriguez <crodriguez@edx.org>
This commit is contained in:
polesye
158
lms/static/js/spec/edxnotes/plugins/events_spec.js
Normal file
158
lms/static/js/spec/edxnotes/plugins/events_spec.js
Normal file
@@ -0,0 +1,158 @@
|
||||
define([
|
||||
'jquery', 'underscore', 'js/common_helpers/ajax_helpers', 'js/spec/edxnotes/helpers',
|
||||
'annotator', 'logger', 'js/edxnotes/views/notes_factory'
|
||||
], function($, _, AjaxHelpers, Helpers, Annotator, Logger, NotesFactory) {
|
||||
'use strict';
|
||||
describe('EdxNotes Events Plugin', function() {
|
||||
var note = {
|
||||
user: 'user-123',
|
||||
id: 'note-123',
|
||||
text: 'text-123',
|
||||
quote: 'quote-123',
|
||||
usage_id: 'usage-123'
|
||||
},
|
||||
noteWithoutId = {
|
||||
user: 'user-123',
|
||||
text: 'text-123',
|
||||
quote: 'quote-123',
|
||||
usage_id: 'usage-123'
|
||||
};
|
||||
|
||||
beforeEach(function() {
|
||||
this.annotator = NotesFactory.factory(
|
||||
$('<div />').get(0), {
|
||||
endpoint: 'http://example.com/'
|
||||
}
|
||||
);
|
||||
spyOn(Logger, 'log');
|
||||
});
|
||||
|
||||
afterEach(function () {
|
||||
_.invoke(Annotator._instances, 'destroy');
|
||||
});
|
||||
|
||||
it('should log edx.course.student_notes.viewed event properly', function() {
|
||||
this.annotator.publish('annotationViewerShown', [
|
||||
this.annotator.viewer,
|
||||
[note, {user: 'user-456'}, {user: 'user-789', id: 'note-789'}]
|
||||
]);
|
||||
expect(Logger.log).toHaveBeenCalledWith(
|
||||
'edx.course.student_notes.viewed', {
|
||||
'notes': [{'note_id': 'note-123'}, {'note_id': 'note-789'}]
|
||||
}
|
||||
);
|
||||
});
|
||||
|
||||
it('should not log edx.course.student_notes.viewed event if all notes are new', function() {
|
||||
this.annotator.publish('annotationViewerShown', [
|
||||
this.annotator.viewer, [{user: 'user-456'}, {user: 'user-789'}]
|
||||
]);
|
||||
expect(Logger.log).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('should log edx.course.student_notes.added event properly', function() {
|
||||
var requests = AjaxHelpers.requests(this),
|
||||
newNote = {
|
||||
user: 'user-123',
|
||||
text: 'text-123',
|
||||
quote: 'quote-123',
|
||||
usage_id: 'usage-123'
|
||||
};
|
||||
|
||||
this.annotator.publish('annotationCreated', newNote);
|
||||
AjaxHelpers.respondWithJson(requests, note);
|
||||
expect(Logger.log).toHaveBeenCalledWith(
|
||||
'edx.course.student_notes.added', {
|
||||
'note_id': 'note-123',
|
||||
'note_text': 'text-123',
|
||||
'note_text_truncated': false,
|
||||
'highlighted_content': 'quote-123',
|
||||
'highlighted_content_truncated': false,
|
||||
'component_usage_id': 'usage-123'
|
||||
}
|
||||
);
|
||||
});
|
||||
|
||||
it('should log the edx.course.student_notes.edited event properly', function() {
|
||||
var oldNote = note,
|
||||
newNote = $.extend({}, note, {text: 'text-456'});
|
||||
|
||||
this.annotator.publish('annotationEditorShown', [this.annotator.editor, oldNote]);
|
||||
expect(this.annotator.plugins.Events.oldNoteText).toBe('text-123');
|
||||
this.annotator.publish('annotationUpdated', newNote);
|
||||
this.annotator.publish('annotationEditorHidden', [this.annotator.editor, newNote]);
|
||||
|
||||
expect(Logger.log).toHaveBeenCalledWith(
|
||||
'edx.course.student_notes.edited', {
|
||||
'note_id': 'note-123',
|
||||
'old_note_text': 'text-123',
|
||||
'old_note_text_truncated': false,
|
||||
'note_text': 'text-456',
|
||||
'note_text_truncated': false,
|
||||
'highlighted_content': 'quote-123',
|
||||
'highlighted_content_truncated': false,
|
||||
'component_usage_id': 'usage-123'
|
||||
}
|
||||
);
|
||||
expect(this.annotator.plugins.Events.oldNoteText).toBeNull();
|
||||
});
|
||||
|
||||
it('should not log the edx.course.student_notes.edited event if the note is new', function() {
|
||||
var oldNote = noteWithoutId,
|
||||
newNote = $.extend({}, noteWithoutId, {text: 'text-456'});
|
||||
|
||||
this.annotator.publish('annotationEditorShown', [this.annotator.editor, oldNote]);
|
||||
expect(this.annotator.plugins.Events.oldNoteText).toBe('text-123');
|
||||
this.annotator.publish('annotationUpdated', newNote);
|
||||
this.annotator.publish('annotationEditorHidden', [this.annotator.editor, newNote]);
|
||||
expect(Logger.log).not.toHaveBeenCalled();
|
||||
expect(this.annotator.plugins.Events.oldNoteText).toBeNull();
|
||||
});
|
||||
|
||||
it('should log the edx.course.student_notes.deleted event properly', function() {
|
||||
this.annotator.publish('annotationDeleted', note);
|
||||
expect(Logger.log).toHaveBeenCalledWith(
|
||||
'edx.course.student_notes.deleted', {
|
||||
'note_id': 'note-123',
|
||||
'note_text': 'text-123',
|
||||
'note_text_truncated': false,
|
||||
'highlighted_content': 'quote-123',
|
||||
'highlighted_content_truncated': false,
|
||||
'component_usage_id': 'usage-123'
|
||||
}
|
||||
);
|
||||
});
|
||||
|
||||
it('should not log the edx.course.student_notes.deleted event if the note is new', function() {
|
||||
this.annotator.publish('annotationDeleted', noteWithoutId);
|
||||
expect(Logger.log).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('should truncate values of some fields', function() {
|
||||
var oldNote = $.extend({}, note, {text: Helpers.LONG_TEXT}),
|
||||
newNote = $.extend({}, note, {
|
||||
text: Helpers.LONG_TEXT + '123',
|
||||
quote: Helpers.LONG_TEXT + '123'
|
||||
});
|
||||
|
||||
this.annotator.publish('annotationEditorShown', [this.annotator.editor, oldNote]);
|
||||
expect(this.annotator.plugins.Events.oldNoteText).toBe(Helpers.LONG_TEXT);
|
||||
this.annotator.publish('annotationUpdated', newNote);
|
||||
this.annotator.publish('annotationEditorHidden', [this.annotator.editor, newNote]);
|
||||
|
||||
expect(Logger.log).toHaveBeenCalledWith(
|
||||
'edx.course.student_notes.edited', {
|
||||
'note_id': 'note-123',
|
||||
'old_note_text': Helpers.TRUNCATED_TEXT,
|
||||
'old_note_text_truncated': true,
|
||||
'note_text': Helpers.TRUNCATED_TEXT,
|
||||
'note_text_truncated': true,
|
||||
'highlighted_content': Helpers.TRUNCATED_TEXT,
|
||||
'highlighted_content_truncated': true,
|
||||
'component_usage_id': 'usage-123'
|
||||
}
|
||||
);
|
||||
expect(this.annotator.plugins.Events.oldNoteText).toBeNull();
|
||||
});
|
||||
});
|
||||
});
|
||||
94
lms/static/js/spec/edxnotes/plugins/scroller_spec.js
Normal file
94
lms/static/js/spec/edxnotes/plugins/scroller_spec.js
Normal file
@@ -0,0 +1,94 @@
|
||||
define([
|
||||
'jquery', 'underscore', 'annotator', 'js/edxnotes/views/notes_factory',
|
||||
'js/spec/edxnotes/custom_matchers'
|
||||
], function($, _, Annotator, NotesFactory, customMatchers) {
|
||||
'use strict';
|
||||
describe('EdxNotes Scroll Plugin', function() {
|
||||
var annotators, highlights;
|
||||
|
||||
function checkAnnotatorIsFrozen(annotator) {
|
||||
expect(annotator.isFrozen).toBe(true);
|
||||
expect(annotator.onHighlightMouseover).not.toHaveBeenCalled();
|
||||
expect(annotator.startViewerHideTimer).not.toHaveBeenCalled();
|
||||
}
|
||||
|
||||
function checkAnnotatorIsUnfrozen(annotator) {
|
||||
expect(annotator.isFrozen).toBe(false);
|
||||
expect(annotator.onHighlightMouseover).toHaveBeenCalled();
|
||||
expect(annotator.startViewerHideTimer).toHaveBeenCalled();
|
||||
}
|
||||
|
||||
beforeEach(function() {
|
||||
customMatchers(this);
|
||||
loadFixtures('js/fixtures/edxnotes/edxnotes_wrapper.html');
|
||||
annotators = [
|
||||
NotesFactory.factory($('div#edx-notes-wrapper-123').get(0), {
|
||||
endpoint: 'http://example.com/'
|
||||
}),
|
||||
NotesFactory.factory($('div#edx-notes-wrapper-456').get(0), {
|
||||
endpoint: 'http://example.com/'
|
||||
})
|
||||
];
|
||||
|
||||
highlights = _.map(annotators, function(annotator) {
|
||||
spyOn(annotator, 'onHighlightClick').andCallThrough();
|
||||
spyOn(annotator, 'onHighlightMouseover').andCallThrough();
|
||||
spyOn(annotator, 'startViewerHideTimer').andCallThrough();
|
||||
return $('<span></span>', {
|
||||
'class': 'annotator-hl',
|
||||
'tabindex': -1,
|
||||
'text': 'some content'
|
||||
}).appendTo(annotator.element);
|
||||
});
|
||||
|
||||
spyOn(annotators[0].plugins.Scroller, 'getIdFromLocationHash').andReturn('abc123');
|
||||
spyOn($.fn, 'unbind').andCallThrough();
|
||||
});
|
||||
|
||||
afterEach(function () {
|
||||
_.invoke(Annotator._instances, 'destroy');
|
||||
});
|
||||
|
||||
it('should scroll to a note, open it and freeze the annotator if its id is part of the url hash', function() {
|
||||
annotators[0].plugins.Scroller.onNotesLoaded([{
|
||||
id: 'abc123',
|
||||
highlights: [highlights[0]]
|
||||
}]);
|
||||
annotators[0].onHighlightMouseover.reset();
|
||||
expect(highlights[0]).toBeFocused();
|
||||
highlights[0].mouseover();
|
||||
highlights[0].mouseout();
|
||||
checkAnnotatorIsFrozen(annotators[0]);
|
||||
});
|
||||
|
||||
it('should not do anything if the url hash contains a wrong id', function() {
|
||||
annotators[0].plugins.Scroller.onNotesLoaded([{
|
||||
id: 'def456',
|
||||
highlights: [highlights[0]]
|
||||
}]);
|
||||
expect(highlights[0]).not.toBeFocused();
|
||||
highlights[0].mouseover();
|
||||
highlights[0].mouseout();
|
||||
checkAnnotatorIsUnfrozen(annotators[0]);
|
||||
});
|
||||
|
||||
it('should not do anything if the url hash contains an empty id', function() {
|
||||
annotators[0].plugins.Scroller.onNotesLoaded([{
|
||||
id: '',
|
||||
highlights: [highlights[0]]
|
||||
}]);
|
||||
expect(highlights[0]).not.toBeFocused();
|
||||
highlights[0].mouseover();
|
||||
highlights[0].mouseout();
|
||||
checkAnnotatorIsUnfrozen(annotators[0]);
|
||||
});
|
||||
|
||||
it('should unbind onNotesLoaded on destruction', function() {
|
||||
annotators[0].plugins.Scroller.destroy();
|
||||
expect($.fn.unbind).toHaveBeenCalledWith(
|
||||
'annotationsLoaded',
|
||||
annotators[0].plugins.Scroller.onNotesLoaded
|
||||
);
|
||||
});
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user