Reduce bundlesize of reference previews by making it use stable APIs

This is a precursor to moving the code out to the Cite extension.

This can be squashed into parent commit or merged at same time.

I've kept the two patches separate to make them easier to review.

Bug: T326692
Change-Id: I50dbf28a1078df6c73fd0fbf77480488dd82c7b3

extension.json

@@ -153,6 +153,9 @@
 			]
 		},
 		"ext.popups.referencePreviews": {
+			"dependencies": [
+				"ext.popups.main"
+			],
 			"styles": [
 				"resources/ext.popups.referencePreviews/referencePreview.less"
 			],

package.json

@@ -75,7 +75,7 @@
 		},
 		{
 			"path": "resources/dist/referencePreviews.js",
-			"maxSize": "2.7kB"
+			"maxSize": "2.0kB"
 		}
 	]
 }

src/ext.popups.referencePreviews/createReferenceGateway.js

@@ -3,7 +3,6 @@
  */
 
 import { TYPE_REFERENCE } from './constants.js';
-import { abortablePromise } from '../gateway/index.js';
 
 /**
  * @return {Gateway}
@@ -83,7 +82,10 @@ export default function createReferenceGateway() {
 			sourceElementId: el.parentNode.id
 		};
 
-		return abortablePromise( Promise.resolve( model ) );
+		// Make promise abortable.
+		const promise = Promise.resolve( model );
+		promise.abort = () => {};
+		return promise;
 	}
 
 	return {

src/ext.popups.referencePreviews/createReferencePreview.js

@@ -2,11 +2,11 @@
  * @module referencePreview
  */
 import { isTrackingEnabled, LOGGING_SCHEMA } from './referencePreviews';
-import { renderPopup } from '../ui/templates/popup/popup';
-import { createNodeFromTemplate, escapeHTML } from '../ui/templates/templateUtil';
 
-const templateHTML = `
+const TEMPLATE = document.createElement( 'template' );
-<div class="mwe-popups-container">
+TEMPLATE.innerHTML = `
+<div class="mwe-popups mwe-popups mwe-popups-type-reference" aria-hidden>
+	<div class="mwe-popups-container">
 		<div class="mwe-popups-extract">
 			<div class="mwe-popups-scroll">
 				<strong class="mwe-popups-title">
@@ -20,6 +20,7 @@ const templateHTML = `
 		<footer>
 			<div class="mwe-popups-settings"></div>
 		</footer>
+	</div>
 </div>`;
 
 /**
@@ -54,8 +55,12 @@ function renderReferencePreview(
 		titleMsg = mw.message( 'popups-refpreview-reference' );
 	}
 
-	const el = renderPopup( model.type, createNodeFromTemplate( templateHTML ) );
+	const el = TEMPLATE.content.cloneNode( true ).children[ 0 ];
-	replaceWith( el.querySelector( '.mwe-popups-title-placeholder' ), escapeHTML( titleMsg.text() ) );
+
+	replaceWith(
+		el.querySelector( '.mwe-popups-title-placeholder' ),
+		mw.html.escape( titleMsg.text() )
+	);
 	// The following classes are used here:
 	// * popups-icon--reference-generic
 	// * popups-icon--reference-book

src/ext.popups.referencePreviews/index.js

@@ -3,12 +3,10 @@ import { initReferencePreviewsInstrumentation } from './referencePreviews';
 import createReferenceGateway from './createReferenceGateway';
 import renderFn from './createReferencePreview';
 import { TYPE_REFERENCE, FETCH_DELAY_REFERENCE_TYPE } from './constants';
-import createUserSettings from '../userSettings';
 import setUserConfigFlags from './setUserConfigFlags';
 
 setUserConfigFlags( mw.config );
-const userSettings = createUserSettings( mw.storage );
+const referencePreviewsState = isReferencePreviewsEnabled( mw.user, mw.popups.isEnabled, mw.config );
-const referencePreviewsState = isReferencePreviewsEnabled( mw.user, userSettings, mw.config );
 const gateway = createReferenceGateway();
 
 window.refPreviews = referencePreviewsState !== null ? {

src/ext.popups.referencePreviews/isReferencePreviewsEnabled.js

@@ -3,19 +3,18 @@ import { TYPE_REFERENCE } from './constants.js';
 /**
  * @module isReferencePreviewsEnabled
  */
-const canSaveToUserPreferences = require( '../canSaveToUserPreferences.js' );
 
 /**
  * Given the global state of the application, creates a function that gets
  * whether or not the user should have Reference Previews enabled.
  *
  * @param {mw.User} user The `mw.user` singleton instance
- * @param {Object} userSettings An object returned by `userSettings.js`
+ * @param {Function} isPreviewTypeEnabled check whether preview has been disabled or enabled.
  * @param {mw.Map} config
  *
  * @return {boolean|null} Null when there is no way the popup type can be enabled at run-time.
  */
-export default function isReferencePreviewsEnabled( user, userSettings, config ) {
+export default function isReferencePreviewsEnabled( user, isPreviewTypeEnabled, config ) {
 	// TODO: This and the final `mw.user.options` check are currently redundant. Only this here
 	// should be removed when the wgPopupsReferencePreviews feature flag is not needed any more.
 	if ( !config.get( 'wgPopupsReferencePreviews' ) ) {
@@ -31,10 +30,8 @@ export default function isReferencePreviewsEnabled( user, userSettings, config )
 		return null;
 	}
 
-	// For anonymous users, the code loads always, but the feature can be toggled at run-time via
+	if ( user.isAnon() ) {
-	// local storage.
+		return isPreviewTypeEnabled( TYPE_REFERENCE );
-	if ( !canSaveToUserPreferences( user ) ) {
-		return userSettings.isPreviewTypeEnabled( TYPE_REFERENCE );
 	}
 
 	// Registered users never can enable popup types at run-time.

src/gateway/index.js

@@ -21,6 +21,8 @@
  */
 
 /**
+ * @stable this function is available to 3rd parties. Any breaking changes must
+ *  go through the MediaWiki deprecation process.
  * @param {Promise|jQuery.Promise<T>} promise
  * @param {function(): void} [abort]
  * @return {AbortPromise}

src/integrations/mwpopups.js

@@ -30,10 +30,11 @@ export default function createMwPopups( store, registerModel, registerPreviewUI,
 ) {
 	return {
 		/**
+		 * @param {string} [type] type of preview, defaults to page if not provided.
 		 * @return {boolean} If Page Previews are currently active
 		 */
-		isEnabled: function isEnabled() {
+		isEnabled: function isEnabled( type ) {
-			return !!store.getState().preview.enabled[ previewTypes.TYPE_PAGE ];
+			return !!store.getState().preview.enabled[ type || previewTypes.TYPE_PAGE ];
 		},
 		/**
 		 * @stable Do not remove properties in the type PopupModule without providing backwards

tests/node-qunit/ext.popups.referencePreviews/isReferencePreviewsEnabled.test.js

@@ -125,23 +125,24 @@ QUnit.test( 'all relevant combinations of flags', ( assert ) => {
 					get: () => {}
 				}
 			},
-			userSettings = {
+			isPreviewTypeEnabled = () => {
-				isPreviewTypeEnabled: () => data.isAnon ?
+				if ( !data.isAnon ) {
-					data.enabledByAnon :
+					assert.true( false, 'not expected to be called' );
-					assert.true( false, 'not expected to be called' )
+				}
+				return data.enabledByAnon;
 			},
 			config = {
 				get: ( key ) => key === 'skin' && data.isMobile ? 'minerva' : data[ key ]
 			};
 
 		if ( data.isAnon ) {
-			user.options.get = () => assert.true( false, 'not expected to be called' );
+			user.options.get = () => assert.true( false, 'not expected to be called 2' );
 		} else {
 			user.options.get = () => data.enabledByRegistered ? '1' : '0';
 		}
 
 		assert.strictEqual(
-			isReferencePreviewsEnabled( user, userSettings, config ),
+			isReferencePreviewsEnabled( user, isPreviewTypeEnabled, config ),
 			data.expected,
 			data.testCase
 		);