Merge pull request #32 from newfold-labs/enhance/PRESS7-76-lazy-load-…

…images

Image Optimization: Add Lazy Loading Support

.github/workflows/lint.yml

@@ -4,10 +4,12 @@ on:
   push:
     paths:
       - '**.php'
+      - '!build/**'
   pull_request:
     types: [opened, edited, reopened, ready_for_review]
     paths:
       - '**.php'
+      - '!build/**'
   workflow_dispatch:
 
 concurrency:
@@ -36,6 +38,11 @@ jobs:
             **/*.php
             !build/**/*.php
 
+      - name: Exclude build folder from diff
+        run: |
+          export GIT_DIFF=$(echo "$GIT_DIFF" | grep -v '^build/')
+          echo "Filtered diff: $GIT_DIFF"
+
       - name: Get Composer cache directory
         id: composer-cache
         run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT

assets/bulk-optimizer.js

@@ -0,0 +1,312 @@
+document.addEventListener( 'DOMContentLoaded', () => {
+	const { __ } = wp.i18n;
+
+	const bulkOptimizeButtonId = 'nfd-bulk-optimize-btn';
+	let cancelRequested = false;
+
+	const bulkSelectButtonClasses = [
+		'button',
+		'media-button',
+		'select-mode-toggle-button',
+	];
+	const deletePermanentlyButtonClasses = [
+		'button',
+		'media-button',
+		'button-primary',
+		'button-large',
+		'delete-selected-button',
+	];
+
+	const removeBulkOptimizeButton = () => {
+		const bulkOptimizeButton =
+			document.getElementById( bulkOptimizeButtonId );
+		if ( bulkOptimizeButton ) bulkOptimizeButton.remove();
+	};
+
+	const createModal = () => {
+		const modal = document.createElement( 'div' );
+		modal.id = 'nfd-bulk-modal';
+		modal.style.cssText = `
+            position: fixed;
+            top: 0;
+            left: 0;
+            width: 100%;
+            height: 100%;
+            background: rgba(0, 0, 0, 0.5);
+            display: flex;
+            justify-content: center;
+            align-items: center;
+            z-index: 9999;
+        `;
+
+		const modalContent = document.createElement( 'div' );
+		modalContent.style.cssText = `
+            background: white;
+            padding: 2rem;
+            border-radius: 8px;
+            text-align: center;
+            width: 400px;
+            box-shadow: 0 0 15px rgba(0, 0, 0, 0.2);
+        `;
+
+		const modalTitle = document.createElement( 'h2' );
+		modalTitle.id = 'nfd-modal-title';
+		modalTitle.textContent = __(
+			'Optimizing Images…',
+			'wp-module-performance'
+		);
+
+		const currentFileName = document.createElement( 'p' );
+		currentFileName.id = 'nfd-current-file';
+		currentFileName.textContent = __(
+			'Preparing files…',
+			'wp-module-performance'
+		);
+
+		const progressContainer = document.createElement( 'div' );
+		progressContainer.id = 'nfd-progress-container';
+		progressContainer.style.cssText = `
+            width: 100%;
+            height: 20px;
+            background: #eee;
+            border-radius: 10px;
+            margin: 1rem 0;
+            overflow: hidden;
+            position: relative;
+        `;
+
+		const progressBar = document.createElement( 'div' );
+		progressBar.id = 'nfd-progress-bar';
+		progressBar.style.cssText = `
+            height: 100%;
+            width: 0;
+            background: #007cba;
+            transition: width 0.3s ease;
+        `;
+
+		const resultList = document.createElement( 'ul' );
+		resultList.id = 'nfd-result-list';
+		resultList.style.cssText = `
+            text-align: center;
+            margin: 1rem auto;
+            max-height: 200px;
+            overflow-y: auto;
+        `;
+
+		const doneButton = document.createElement( 'button' );
+		doneButton.textContent = __( 'Done', 'wp-module-performance' );
+		doneButton.className = 'button button-secondary';
+		doneButton.style.marginTop = '1rem';
+		doneButton.style.display = 'none'; // Hidden initially
+		doneButton.addEventListener( 'click', () => {
+			modal.remove();
+		} );
+
+		progressContainer.appendChild( progressBar );
+		modalContent.append(
+			modalTitle,
+			currentFileName,
+			progressContainer,
+			resultList,
+			doneButton
+		);
+		modal.appendChild( modalContent );
+		document.body.appendChild( modal );
+
+		return {
+			modal,
+			progressBar,
+			modalTitle,
+			currentFileName,
+			resultList,
+			doneButton,
+			progressContainer,
+		};
+	};
+
+	const openModal = () => {
+		cancelRequested = false;
+		const {
+			progressBar,
+			modalTitle,
+			currentFileName,
+			resultList,
+			doneButton,
+			progressContainer,
+		} = createModal();
+		progressBar.style.width = '0%';
+		currentFileName.textContent = '';
+		return {
+			progressBar,
+			modalTitle,
+			currentFileName,
+			resultList,
+			doneButton,
+			progressContainer,
+		};
+	};
+
+	const getFileName = ( attachment ) => {
+		return attachment.getAttribute( 'aria-label' );
+	};
+
+	const handleBulkOptimize = async () => {
+		const selectedItems = Array.from(
+			document.querySelectorAll( '.attachment.selected' )
+		).map( ( attachment ) => ( {
+			id: attachment.getAttribute( 'data-id' ),
+			name: getFileName( attachment ),
+		} ) );
+
+		if ( ! selectedItems.length ) return;
+
+		const apiUrl =
+			window.nfdPerformance?.imageOptimization?.bulkOptimizer?.apiUrl;
+
+		if ( ! apiUrl ) {
+			return;
+		}
+
+		const {
+			progressBar,
+			modalTitle,
+			currentFileName,
+			resultList,
+			doneButton,
+			progressContainer,
+		} = openModal();
+		const results = [];
+
+		try {
+			for ( let i = 0; i < selectedItems.length; i++ ) {
+				if ( cancelRequested ) {
+					modalTitle.textContent = __(
+						'Optimization Canceled',
+						'wp-module-performance'
+					);
+					break;
+				}
+
+				const { id: mediaId, name: fileName } = selectedItems[ i ];
+				currentFileName.textContent =
+					__( 'Optimizing:', 'wp-module-performance' ) +
+					` ${ fileName }`;
+
+				try {
+					await wp.apiFetch( {
+						url: apiUrl,
+						method: 'POST',
+						data: { media_id: parseInt( mediaId, 10 ) },
+					} );
+
+					results.push( { name: fileName, status: 'passed' } );
+				} catch ( error ) {
+					results.push( { name: fileName, status: 'failed' } );
+				}
+
+				const progress = ( ( i + 1 ) / selectedItems.length ) * 100;
+				progressBar.style.width = `${ progress }%`;
+			}
+
+			modalTitle.textContent = __(
+				'Optimization Complete!',
+				'wp-module-performance'
+			);
+			progressContainer.style.display = 'none';
+			currentFileName.style.display = 'none';
+
+			results.forEach( ( { name, status } ) => {
+				const listItem = document.createElement( 'li' );
+				const statusText =
+					status === 'passed'
+						? __( 'Passed', 'wp-module-performance' )
+						: __( 'Failed', 'wp-module-performance' );
+
+				listItem.textContent = `${ name } - ${ statusText }`;
+				resultList.appendChild( listItem );
+			} );
+
+			resultList.style.textAlign = 'center';
+			doneButton.style.display = 'block';
+		} catch ( error ) {
+			modalTitle.textContent = __(
+				'An error occurred.',
+				'wp-module-performance'
+			);
+		}
+	};
+
+	const createBulkOptimizeButton = () => {
+		const bulkOptimizeButton = document.createElement( 'button' );
+		bulkOptimizeButton.id = bulkOptimizeButtonId;
+		bulkOptimizeButton.className =
+			'button media-button button-large button-primary';
+		bulkOptimizeButton.textContent = __(
+			'Optimize',
+			'wp-module-performance'
+		);
+		bulkOptimizeButton.disabled = true;
+		bulkOptimizeButton.addEventListener( 'click', handleBulkOptimize );
+		return bulkOptimizeButton;
+	};
+
+	const addBulkOptimizeButton = () => {
+		if ( document.getElementById( bulkOptimizeButtonId ) ) return;
+
+		const deletePermanentlyButton = document.querySelector(
+			'.button.media-button.button-primary.button-large.delete-selected-button'
+		);
+
+		if (
+			! hasExactClassList(
+				deletePermanentlyButton,
+				deletePermanentlyButtonClasses
+			)
+		)
+			return;
+
+		const bulkOptimizeButton = createBulkOptimizeButton();
+		deletePermanentlyButton.parentElement.insertBefore(
+			bulkOptimizeButton,
+			deletePermanentlyButton.nextSibling
+		);
+
+		monitorSelectedItems( bulkOptimizeButton );
+	};
+
+	const monitorSelectedItems = ( bulkOptimizeButton ) => {
+		const updateButtonState = () => {
+			const hasSelectedItems =
+				document.querySelectorAll( '.attachment.selected' ).length > 0;
+			bulkOptimizeButton.disabled = ! hasSelectedItems;
+		};
+
+		const mediaFrameContent = document.querySelector(
+			'.media-frame-content'
+		);
+		if ( mediaFrameContent ) {
+			const observer = new MutationObserver( updateButtonState );
+			observer.observe( mediaFrameContent, {
+				childList: true,
+				subtree: true,
+			} );
+			updateButtonState();
+		}
+	};
+
+	const hasExactClassList = ( element, classList ) =>
+		element?.classList.length === classList.length &&
+		classList.every( ( cls ) => element.classList.contains( cls ) );
+
+	const observer = new MutationObserver( () => {
+		const bulkSelectButton = document.querySelector(
+			'.button.media-button.select-mode-toggle-button'
+		);
+
+		hasExactClassList( bulkSelectButton, bulkSelectButtonClasses )
+			? removeBulkOptimizeButton()
+			: addBulkOptimizeButton();
+	} );
+
+	observer.observe( document.body, { childList: true, subtree: true } );
+} );

assets/image-optimized-marker/image-optimized-marker.css

@@ -0,0 +1,11 @@
+/* image-optimized-marker.css */
+.nfd-performance-image-optimized-marker {
+	position: absolute;
+	top: 8px;
+	right: 8px;
+	background: #007cba;
+	color: #fff;
+	padding: 2px 6px;
+	border-radius: 4px;
+	font-size: 12px;
+}

assets/image-optimized-marker/image-optimized-marker.js

@@ -0,0 +1,37 @@
+import './image-optimized-marker.css';
+
+import { __ } from '@wordpress/i18n';
+
+document.addEventListener( 'DOMContentLoaded', () => {
+	/**
+	 * Adds a marker to optimized images in the media library
+	 */
+	const markOptimizedImages = () => {
+		document.querySelectorAll( '.attachment' ).forEach( ( attachment ) => {
+			// Get media library data
+			const mediaId = attachment.getAttribute( 'data-id' );
+			const mediaData = wp.media.attachment( mediaId ).attributes;
+
+			// Check if the image is optimized
+			if (
+				mediaData.nfdPerformanceImageOptimized &&
+				! attachment.querySelector(
+					'.nfd-performance-image-optimized-marker'
+				)
+			) {
+				const marker = document.createElement( 'span' );
+				marker.textContent = __( 'Optimized', 'wp-module-performance' );
+				marker.className = 'nfd-performance-image-optimized-marker';
+
+				attachment.querySelector( '.thumbnail' )?.appendChild( marker );
+			}
+		} );
+	};
+
+	// Monitor for changes in the media library
+	const observer = new MutationObserver( markOptimizedImages );
+	observer.observe( document.body, { childList: true, subtree: true } );
+
+	// Initial run
+	markOptimizedImages();
+} );