Fixing bug when patching/updating a file the user has deleted

Author: weaverryan

src/Update/RecipePatcher.php

@@ -19,12 +19,14 @@ class RecipePatcher
 {
     private string $rootDir;
     private Filesystem $filesystem;
+    private IOInterface $io;
     private ProcessExecutor $processExecutor;
 
     public function __construct(string $rootDir, IOInterface $io)
     {
         $this->rootDir = $rootDir;
         $this->filesystem = new Filesystem();
+        $this->io = $io;
         $this->processExecutor = new ProcessExecutor($io);
     }
 
@@ -50,6 +52,7 @@ public function applyPatch(RecipePatch $patch): bool
 
             $output = '';
             $statusCode = $this->processExecutor->execute('git apply "_flex_recipe_update.patch" -3', $output, $this->rootDir);
+            $this->io->debug('git apply output: '.$output);
 
             if ($statusCode === 0) {
                 // successful with no conflicts
@@ -88,6 +91,16 @@ public function generatePatch(array $originalFiles, array $newFiles): RecipePatc
             }
         }
 
+        // If a file is being modified, but does not exist in the current project,
+        // it cannot be patched. Ignore these files and leave them deleted.
+        $modifiedFiles = array_intersect_key(array_keys($originalFiles), array_keys($newFiles));
+        foreach ($modifiedFiles as $modifiedFile) {
+            if (!file_exists($this->rootDir.'/'.$modifiedFile)) {
+                unset($originalFiles[$modifiedFile]);
+                unset($newFiles[$modifiedFile]);
+            }
+        }
+
         $tmpPath = sys_get_temp_dir().'/_flex_recipe_update'.uniqid(mt_rand(), true);
         $this->filesystem->mkdir($tmpPath);
 

tests/Update/RecipePatcherTest.php

@@ -174,6 +174,19 @@ public function getGeneratePatchTests(): iterable
         ];
     }
 
+    public function testGeneratePatchOnDeletedFile()
+    {
+        // make sure the target directory is empty
+        $this->getFilesystem()->remove(FLEX_TEST_DIR);
+        $this->getFilesystem()->mkdir(FLEX_TEST_DIR);
+
+        $patcher = new RecipePatcher(FLEX_TEST_DIR, $this->createMock(IOInterface::class));
+
+        // try to update a file that does not exist in the project
+        $patch = $patcher->generatePatch(['.env' => 'original contents'], ['.env' => 'new contents']);
+        $this->assertSame('', $patch->getPatch());
+    }
+
     /**
      * @dataProvider getApplyPatchTests
      */
@@ -294,11 +307,30 @@ public function testIntegration(bool $useNullForMissingFiles)
         $files = $this->getFilesForPatching();
         (new Process(['git', 'init'], FLEX_TEST_DIR))->mustRun();
 
+        $startingFiles = [
+            '.env' => $files['dot_env_clean']['in_app'],
+            'package.json' => $files['package_json_conflict']['in_app'],
+            // no webpack_encore.yaml in app
+            'config/packages/security.yaml' => $files['security_removed']['in_app'],
+            // no cache.yaml in app - the update patch will be skipped
+        ];
+        foreach ($startingFiles as $file => $contents) {
+            if (!file_exists(dirname(FLEX_TEST_DIR.'/'.$file))) {
+                @mkdir(dirname(FLEX_TEST_DIR.'/'.$file), 0777, true);
+            }
+
+            file_put_contents(FLEX_TEST_DIR.'/'.$file, $contents);
+        }
+        // commit the files in the app
+        (new Process(['git', 'add', '-A'], FLEX_TEST_DIR))->mustRun();
+        (new Process(['git', 'commit', '-m', 'committing in app start files'], FLEX_TEST_DIR))->mustRun();
+
         $patcher = new RecipePatcher(FLEX_TEST_DIR, $this->createMock(IOInterface::class));
         $originalFiles = [
             '.env' => $files['dot_env_clean']['original_recipe'],
             'package.json' => $files['package_json_conflict']['original_recipe'],
             'config/packages/security.yaml' => $files['security_removed']['original_recipe'],
+            'config/packages/cache.yaml' => 'original cache.yaml',
         ];
         if ($useNullForMissingFiles) {
             $originalFiles['config/packages/webpack_encore.yaml'] = null;
@@ -307,31 +339,16 @@ public function testIntegration(bool $useNullForMissingFiles)
         $updatedFiles = [
             '.env' => $files['dot_env_clean']['updated_recipe'],
             'package.json' => $files['package_json_conflict']['updated_recipe'],
-            'config/packages/webpack_encore.yaml' => $files['webpack_encore_added']['updated_recipe']
+            'config/packages/webpack_encore.yaml' => $files['webpack_encore_added']['updated_recipe'],
+            'config/packages/cache.yaml' => 'updated cache.yaml',
         ];
         if ($useNullForMissingFiles) {
             $updatedFiles['config/packages/security.yaml'] = null;
         }
-        $recipePatch = $patcher->generatePatch($originalFiles, $updatedFiles);
-
-        $startingFiles = [
-            '.env' => $files['dot_env_clean']['in_app'],
-            'package.json' => $files['package_json_conflict']['in_app'],
-            // no webpack_encore.yaml in app
-            'config/packages/security.yaml' => $files['security_removed']['in_app'],
-        ];
-        foreach ($startingFiles as $file => $contents) {
-            if (!file_exists(dirname(FLEX_TEST_DIR.'/'.$file))) {
-                @mkdir(dirname(FLEX_TEST_DIR.'/'.$file), 0777, true);
-            }
-
-            file_put_contents(FLEX_TEST_DIR.'/'.$file, $contents);
-        }
-        // commit the files in the app
-        (new Process(['git', 'add', '-A'], FLEX_TEST_DIR))->mustRun();
-        (new Process(['git', 'commit', '-m', 'committing in app start files'], FLEX_TEST_DIR))->mustRun();
 
+        $recipePatch = $patcher->generatePatch($originalFiles, $updatedFiles);
         $appliedCleanly = $patcher->applyPatch($recipePatch);
+
         $this->assertFalse($appliedCleanly);
         $this->assertSame($files['dot_env_clean']['expected'], file_get_contents(FLEX_TEST_DIR.'/.env'));
         $this->assertSame($files['package_json_conflict']['expected'], file_get_contents(FLEX_TEST_DIR.'/package.json'));