Merge pull request #268 from GoogleChromeLabs/fix/workbox-cache-busting

Include workbox version in library path to ensure cache busting
GoogleChromeLabs · Mar 31, 2020 · 87c8274 · 87c8274
2 parents f5ecce4 + 1263be6
commit 87c8274
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 5 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,4 +4,4 @@
 /phpcs.xml
 /.phpcs.xml
 *.zip
-/wp-includes/js/workbox/
+/wp-includes/js/workbox*
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -32,7 +32,7 @@ module.exports = function (grunt) {
 			},
 			install_workbox: {
 				command:
-					"if [ -e wp-includes/js/workbox* ]; then rm -r wp-includes/js/workbox*; fi; npx workbox copyLibraries wp-includes/js/ && mv wp-includes/js/workbox-v* wp-includes/js/workbox",
+					"if [ -e wp-includes/js/workbox* ]; then rm -r wp-includes/js/workbox*; fi; npx workbox copyLibraries wp-includes/js/",
 			},
 			create_build_zip: {
 				command:
@@ -97,7 +97,7 @@ module.exports = function (grunt) {
 						file
 					);
 				});
-			paths.push("wp-includes/js/workbox/*");
+			paths.push("wp-includes/js/workbox*/**");
 
 			grunt.task.run("clean");
 			grunt.task.run("readme");
@@ -124,6 +124,13 @@ module.exports = function (grunt) {
 										"$1" + version
 									);
 								}
+
+								const workboxVersion = grunt.file.readJSON("package.json")
+									.devDependencies["workbox-cli"];
+								content = content.replace(
+									/define\(.+?PWA_WORKBOX_VERSION.+/,
+									`define( 'PWA_WORKBOX_VERSION', '${workboxVersion}' );`
+								);
 							}
 							return content;
 						},

diff --git a/pwa.php b/pwa.php
@@ -20,6 +20,7 @@
 define( 'PWA_VERSION', '0.4.0' );
 define( 'PWA_PLUGIN_FILE', __FILE__ );
 define( 'PWA_PLUGIN_DIR', dirname( __FILE__ ) );
+define( 'PWA_WORKBOX_VERSION', json_decode( file_get_contents( PWA_PLUGIN_DIR . '/package.json' ), true )['devDependencies']['workbox-cli'] ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents -- Replaced with version literal build.
 define( 'PWA_PLUGIN_URL', plugin_dir_url( __FILE__ ) );
 
 /**
@@ -95,7 +96,7 @@ function _pwa_print_build_needed_notice() {
 	</div>
 	<?php
 }
-if ( ! file_exists( __DIR__ . '/wp-includes/js/workbox/' ) || ! file_exists( __DIR__ . '/wp-includes/js/workbox/workbox-sw.js' ) ) {
+if ( ! file_exists( __DIR__ . '/wp-includes/js/workbox-v' . PWA_WORKBOX_VERSION ) || ! file_exists( __DIR__ . '/wp-includes/js/workbox-v' . PWA_WORKBOX_VERSION . '/workbox-sw.js' ) ) {
 	add_action( 'admin_notices', '_pwa_print_build_needed_notice' );
 	return;
 }

diff --git a/wp-includes/components/class-wp-service-worker-configuration-component.php b/wp-includes/components/class-wp-service-worker-configuration-component.php
@@ -52,7 +52,7 @@ public function get_priority() {
 	 */
 	public function get_script() {
 		$current_scope = wp_service_workers()->get_current_scope();
-		$workbox_dir   = 'wp-includes/js/workbox/';
+		$workbox_dir   = sprintf( 'wp-includes/js/workbox-v%s/', PWA_WORKBOX_VERSION );
 
 		$script = '';
 		if ( SCRIPT_DEBUG ) {