Page MenuHomeWickedGov Phorge
Files F4139739

mmv.lightboxinterface.test.js
No OneTemporary
Actions

Size
8 KB
Referenced Files
None
Subscribers
None

mmv.lightboxinterface.test.js
View Options

const { LightboxInterface } = require( 'mmv' );
const { getMultimediaViewer } = require( './mmv.testhelpers.js' );
let oldScrollTo;
function stubScrollTo() {
oldScrollTo = $.scrollTo;
$.scrollTo = function () {
return { scrollTop: () => {}, on: () => {}, off: () => {} };
};
}
function restoreScrollTo() {
$.scrollTo = oldScrollTo;
}
QUnit.module( 'mmv.lightboxInterface', QUnit.newMwEnvironment( {
beforeEach: function () {
// animation would keep running, conflict with other tests
this.sandbox.stub( $.fn, 'animate' ).returnsThis();
}
} ) );
QUnit.test( 'Sense test, object creation and ui construction', ( assert ) => {
const lightbox = new LightboxInterface();
stubScrollTo();
function checkIfUIAreasAttachedToDocument( inDocument ) {
const msg = ( inDocument === 1 ? ' ' : ' not ' ) + 'attached.';
assert.strictEqual( $( '.mw-mmv-wrapper' ).length, inDocument, 'Wrapper area' + msg );
assert.strictEqual( $( '.mw-mmv-main' ).length, inDocument, 'Main area' + msg );
assert.strictEqual( $( '.mw-mmv-title' ).length, inDocument, 'Title area' + msg );
assert.strictEqual( $( '.mw-mmv-credit' ).length, inDocument, 'Author/source area' + msg );
assert.strictEqual( $( '.mw-mmv-image-desc' ).length, inDocument, 'Description area' + msg );
assert.strictEqual( $( '.mw-mmv-image-links' ).length, inDocument, 'Links area' + msg );
}
// UI areas not attached to the document yet.
checkIfUIAreasAttachedToDocument( 0 );
// Attach lightbox to testing fixture to avoid interference with other tests.
lightbox.attach( '#qunit-fixture' );
// UI areas should now be attached to the document.
checkIfUIAreasAttachedToDocument( 1 );
// Check that the close button on the lightbox still follow the spec (being visible right away)
assert.strictEqual( $( '#qunit-fixture .mw-mmv-close' ).length, 1, 'There should be a close button' );
assert.true( $( '#qunit-fixture .mw-mmv-close' ).is( ':visible' ), 'The close button should be visible' );
// Unattach lightbox from document
lightbox.unattach();
// UI areas not attached to the document anymore.
checkIfUIAreasAttachedToDocument( 0 );
restoreScrollTo();
} );
QUnit.test( 'Handler registration and clearance work OK', function ( assert ) {
const lightbox = new LightboxInterface();
let handlerCalls = 0;
const clock = this.sandbox.useFakeTimers();
function handleEvent() {
handlerCalls++;
}
lightbox.handleEvent( 'test', handleEvent );
$( document ).trigger( 'test' );
clock.tick( 10 );
assert.strictEqual( handlerCalls, 1, 'The handler was called when we triggered the event.' );
lightbox.clearEvents();
$( document ).trigger( 'test' );
clock.tick( 10 );
assert.strictEqual( handlerCalls, 1, 'The handler was not called after calling lightbox.clearEvents().' );
clock.restore();
} );
QUnit.test( 'Fullscreen mode init', ( assert ) => {
const lightbox = new LightboxInterface();
const enterFullscreen = Element.prototype.requestFullscreen;
// Since we don't want these tests to really open fullscreen
// which is subject to user security confirmation,
// we use a mock that pretends regular jquery.fullscreen behavior happened
Element.prototype.requestFullscreen = function () {};
stubScrollTo();
lightbox.buttons.fadeOut = function () {};
// Attach lightbox to testing fixture to avoid interference with other tests.
lightbox.attach( '#qunit-fixture' );
lightbox.setupCanvasButtons();
// Entering fullscreen
lightbox.$fullscreenButton.trigger( 'click' );
assert.strictEqual( lightbox.$main.hasClass( 'jq-fullscreened' ), true,
'Fullscreened area has the fullscreen class' );
assert.strictEqual( lightbox.isFullscreen, true, 'Lightbox knows it\'s in fullscreen mode' );
// Exiting fullscreen
lightbox.$fullscreenButton.trigger( 'click' );
assert.strictEqual( lightbox.$main.hasClass( 'jq-fullscreened' ), false,
'Fullscreened area doesn\'t have the fullscreen class anymore' );
assert.strictEqual( lightbox.isFullscreen, false, 'Lightbox knows it\'s not in fullscreen mode' );
// Entering fullscreen
lightbox.$fullscreenButton.trigger( 'click' );
// Hard-exiting fullscreen
lightbox.$closeButton.trigger( 'click' );
// Re-attach after hard-exit
lightbox.attach( '#qunit-fixture' );
assert.strictEqual( lightbox.$main.hasClass( 'jq-fullscreened' ), false,
'Fullscreened area doesn\'t have the fullscreen class anymore' );
assert.strictEqual( lightbox.isFullscreen, false, 'Lightbox knows it\'s not in fullscreen mode' );
// Unattach lightbox from document
lightbox.unattach();
Element.prototype.requestFullscreen = enterFullscreen;
restoreScrollTo();
} );
QUnit.test( 'Fullscreen mode', ( assert ) => {
const lightbox = new LightboxInterface();
const viewer = getMultimediaViewer();
const enterFullscreen = Element.prototype.requestFullscreen;
stubScrollTo();
// ugly hack to avoid preloading which would require lightbox list being set up
viewer.preloadDistance = -1;
// Since we don't want these tests to really open fullscreen
// which is subject to user security confirmation,
// we use a mock that pretends regular jquery.fullscreen behavior happened
Element.prototype.requestFullscreen = function () {};
// Attach lightbox to testing fixture to avoid interference with other tests.
lightbox.attach( '#qunit-fixture' );
viewer.ui = lightbox;
viewer.ui = lightbox;
assert.strictEqual( lightbox.isFullscreen, false, 'Lightbox knows that it\'s not in fullscreen mode' );
assert.strictEqual( lightbox.panel.$imageMetadata.is( ':visible' ), true, 'Image metadata is visible' );
lightbox.buttons.fadeOut = function () {
assert.true( true, 'Opening fullscreen triggers a fadeout' );
};
// Pretend that the mouse cursor is on top of the button
const buttonOffset = lightbox.buttons.$fullscreen.offset();
lightbox.mousePosition = { x: buttonOffset.left, y: buttonOffset.top };
// Enter fullscreen
lightbox.buttons.$fullscreen.trigger( 'click' );
lightbox.buttons.fadeOut = function () {};
assert.true( lightbox.isFullscreen, 'Lightbox knows that it\'s in fullscreen mode' );
const oldRevealButtonsAndFadeIfNeeded = lightbox.buttons.revealAndFade;
lightbox.buttons.revealAndFade = function ( position ) {
assert.true( true, 'Moving the cursor triggers a reveal + fade' );
oldRevealButtonsAndFadeIfNeeded.call( this, position );
};
// Pretend that the mouse cursor moved to the top-left corner
lightbox.mousemove( { pageX: 0, pageY: 0 } );
lightbox.buttons.revealAndFadeIfNeeded = function () {};
let panelBottom = $( '.mw-mmv-post-image' ).position().top + $( '.mw-mmv-post-image' ).height();
assert.strictEqual(
panelBottom.toFixed(),
$( window ).height().toFixed(),
'Image metadata does not extend beyond the viewport'
);
lightbox.buttons.revealAndFade = function ( position ) {
assert.true( true, 'Closing fullscreen triggers a reveal + fade' );
oldRevealButtonsAndFadeIfNeeded.call( this, position );
};
// Exiting fullscreen
lightbox.buttons.$fullscreen.trigger( 'click' );
panelBottom = $( '.mw-mmv-post-image' ).position().top + $( '.mw-mmv-post-image' ).height();
assert.false( panelBottom > $( window ).height(), 'Image metadata does not extend beyond the viewport' );
assert.strictEqual( lightbox.isFullscreen, false, 'Lightbox knows that it\'s not in fullscreen mode' );
// Unattach lightbox from document
lightbox.unattach();
Element.prototype.requestFullscreen = enterFullscreen;
restoreScrollTo();
} );
QUnit.test( 'Keyboard prev/next', ( assert ) => {
const viewer = getMultimediaViewer();
const lightbox = new LightboxInterface();
viewer.setupEventHandlers();
// Since we define both, the test works regardless of RTL settings
lightbox.on( 'next', () => assert.true( true, 'Next image was open' ) );
lightbox.on( 'prev', () => assert.true( true, 'Prev image was open' ) );
lightbox.keydown( $.Event( 'keydown', { key: 'ArrowLeft' } ) );
lightbox.keydown( $.Event( 'keydown', { key: 'ArrowRight' } ) );
lightbox.off( 'next' ).on( 'next', () => assert.true( false, 'Next image should not have been open' ) );
lightbox.off( 'prev' ).on( 'prev', () => assert.true( false, 'Prev image should not have been open' ) );
lightbox.keydown( $.Event( 'keydown', { key: 'ArrowLeft', altKey: true } ) );
lightbox.keydown( $.Event( 'keydown', { key: 'ArrowRight', altKey: true } ) );
lightbox.keydown( $.Event( 'keydown', { key: 'ArrowLeft', ctrlKey: true } ) );
lightbox.keydown( $.Event( 'keydown', { key: 'ArrowRight', ctrlKey: true } ) );
lightbox.keydown( $.Event( 'keydown', { key: 'ArrowLeft', shiftKey: true } ) );
lightbox.keydown( $.Event( 'keydown', { key: 'ArrowRight', shiftKey: true } ) );
lightbox.keydown( $.Event( 'keydown', { key: 'ArrowLeft', metaKey: true } ) );
lightbox.keydown( $.Event( 'keydown', { key: 'ArrowRight', metaKey: true } ) );
viewer.cleanupEventHandlers();
} );

File Metadata

Mime Type
text/plain
Expires
Wed, Aug 19, 15:12 (3 w, 5 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
40/fa/e2a95d4935b46ca50806825e079c
Default Alt Text
mmv.lightboxinterface.test.js (8 KB)

Event Timeline