Merge pull request #19 from john-shaffer/14-selective-cloudfront-invalidations

Selective CloudFront Invalidations

Author: leonstafford

src/Controller.php

@@ -20,13 +20,6 @@ public function run() : void {
             1
         );
 
-        add_action(
-            'wp2static_post_deploy_trigger',
-            [ 'WP2StaticS3\Deployer', 'cloudfront_invalidate_all_items' ],
-            15,
-            1
-        );
-
         if ( defined( 'WP_CLI' ) ) {
             \WP_CLI::add_command(
                 'wp2static s3',
@@ -185,6 +178,16 @@ public static function seedOptions() : void {
         );
 
         $wpdb->query( $query );
+
+        $query = $wpdb->prepare(
+            $query_string,
+            'cfMaxPathsToInvalidate',
+            '',
+            'Maximum number of paths to invalidate before triggering a full invalidation',
+            ''
+        );
+
+        $wpdb->query( $query );
     }
 
     /**
@@ -410,6 +413,12 @@ public static function saveOptionsFromUI() : void {
             [ 'name' => 's3CacheControl' ]
         );
 
+        $wpdb->update(
+            $table_name,
+            [ 'value' => sanitize_text_field( $_POST['cfMaxPathsToInvalidate'] ) ],
+            [ 'name' => 'cfMaxPathsToInvalidate' ]
+        );
+
         wp_safe_redirect( admin_url( 'admin.php?page=wp2static-s3' ) );
         exit;
     }

src/Deployer.php

@@ -45,6 +45,10 @@ public function upload_files( string $processed_site_path ) : void {
             $put_data['CacheControl'] = $cache_control;
         }
 
+        $cf_max_paths = Controller::getValue( 'cfMaxPathsToInvalidate' );
+        $cf_max_paths = $cf_max_paths ? intval( $cf_max_paths ) : 0;
+        $cf_stale_paths = [];
+
         foreach ( $iterator as $filename => $file_object ) {
             $base_name = basename( $filename );
             if ( $base_name != '.' && $base_name != '..' ) {
@@ -87,12 +91,32 @@ public function upload_files( string $processed_site_path ) : void {
 
                 if ( $result['@metadata']['statusCode'] === 200 ) {
                     \WP2Static\DeployCache::addFile( $cache_key );
+
+                    if ( $cf_max_paths >= count( $cf_stale_paths ) ) {
+                        $cf_key = $cache_key;
+                        if ( 0 === substr_compare( $cf_key, '/index.html', -11) ) {
+                            $cf_key = substr( $cf_key, 0, -10 );
+                        }
+                        array_push( $cf_stale_paths, $cf_key );
+                    }
                 }
             }
         }
+
+        $distribution_id = Controller::getValue( 'cfDistributionID' );
+        $num_stale = count ( $cf_stale_paths );
+        if ( $distribution_id && $num_stale > 0 ) {
+            if ( $num_stale > $cf_max_paths ) {
+                self::cloudfront_invalidate_all_items();
+            } else {
+                $path_text = ( $num_stale === 1 ) ? 'path' : 'paths';
+                \WP2Static\WsLog::l( "Invalidating $num_stale CloudFront $path_text" );
+                self::create_invalidation( $distribution_id, $cf_stale_paths );
+            }
+        }
     }
 
-    public function s3_client() : \Aws\S3\S3Client {
+    public static function s3_client() : \Aws\S3\S3Client {
         $client_options = [
             'version' => 'latest',
             'region' => Controller::getValue( 's3Region' ),
@@ -124,7 +148,7 @@ public function s3_client() : \Aws\S3\S3Client {
         return new \Aws\S3\S3Client( $client_options );
     }
 
-    public function cloudfront_client() : \Aws\CloudFront\CloudFrontClient {
+    public static function cloudfront_client() : \Aws\CloudFront\CloudFrontClient {
         /*
             If no credentials option, SDK attempts to load credentials from
             your environment in the following order:
@@ -173,29 +197,34 @@ public function cloudfront_client() : \Aws\CloudFront\CloudFrontClient {
         return $client;
     }
 
-    public function cloudfront_invalidate_all_items() : void {
+    public static function create_invalidation( string $distribution_id, array $items )
+    : string {
+        $client = self::cloudfront_client();
+
+        return $client->createInvalidation(
+            [
+                'DistributionId' => $distribution_id,
+                'InvalidationBatch' => [
+                    'CallerReference' => 'WP2Static S3 Add-on ' . time(),
+                    'Paths' => [
+                        'Items' => $items,
+                        'Quantity' => count( $items ),
+                    ],
+                ],
+            ]
+        );
+    }
+
+    public static function cloudfront_invalidate_all_items() : void {
         if ( ! Controller::getValue( 'cfDistributionID' ) ) {
             return;
         }
 
-        \WP2Static\WsLog::l( 'Invalidating all CloudFront items' );
-
-        $client = self::cloudfront_client();
+        \WP2Static\WsLog::l( 'Invalidating all CloudFront paths' );
 
         try {
-            $result = $client->createInvalidation(
-                [
-                    'DistributionId' => Controller::getValue( 'cfDistributionID' ),
-                    'InvalidationBatch' => [
-                        'CallerReference' => 'WP2Static S3 Add-on ' . time(),
-                        'Paths' => [
-                            'Items' => [ '/*' ],
-                            'Quantity' => 1,
-                        ],
-                    ],
-                ]
-            );
-
+            self::create_invalidation( Controller::getValue( 'cfDistributionID' ),
+                                       [ '/*' ]);
         } catch ( AwsException $e ) {
             // output error message if fails
             error_log( $e->getMessage() );

views/s3-page.php

@@ -217,6 +217,21 @@
             </td>
         </tr>
 
+        <tr>
+            <td style="width:50%;">
+                <label
+                    for="<?php echo $view['options']['cfMaxPathsToInvalidate']->name; ?>"
+                ><?php echo $view['options']['cfMaxPathsToInvalidate']->label; ?></label>
+            </td>
+            <td>
+                <input
+                    id="<?php echo $view['options']['cfMaxPathsToInvalidate']->name; ?>"
+                    name="<?php echo $view['options']['cfMaxPathsToInvalidate']->name; ?>"
+                    type="text"
+                    value="<?php echo $view['options']['cfMaxPathsToInvalidate']->value !== '' ? $view['options']['cfMaxPathsToInvalidate']->value : ''; ?>"
+                />
+            </td>
+        </tr>
 
     </tbody>
 </table>