Grunt job is not ignoring hidden directories

[ewallah]

The grunt job is not ignoring hidden directories. The job copies the complete directory of a plugin to a temporary space, does an excellent job and mirrors is back. If you have for example a .git folder with special directory permissions, the restore fails with a permission denied error.

Failed to copy "/tmp/moodle-plugin-ci-grunt-backup-1711963880/.git/objects/57/..." to ".../.git/objects/57/..." because target file could not be opened for writing: fopen(../.git/objects/57/...): Failed to open stream: Permission denied

Therefore I changed the restorePlugin method

       $flags = \FilesystemIterator::SKIP_DOTS;
       $iterator = new \RecursiveDirectoryIterator($this->backupDir, $flags);
       (new Filesystem())->mirror($this->backupDir, $this->plugin->directory, $iterator, ['delete' => true, 'override' => true]);

[malteschmitz]

I do have the exact same issue of Failed to copy ...: Failed to open stream: Permission denied because restorePlugin() tries to restore something deep inside the .git structure.

Unfortunately your fix is not solving the problem but breaks the entire backup mechanism. It will randomly delete files, because Symfony's mirror is broken if you combine the iterator argument with the 'delete' => true option: symfony/symfony#14068

If you use mirror with the iterator argument set to null (as the original restorePlugin implementation does), then it internally creates two different iterators for the deletion and the copying. However, both of these iterators already include the SKIP_DOTS flag: https://github.com/symfony/symfony/blob/7.3/src/Symfony/Component/Filesystem/Filesystem.php#L522

Finally, as pointed out by stronk7 in this comment: The SKIP_DOTS flag is only about skipping . and .. and not other files starting with a dot.

[ewallah]

I am now using this patch for more than a year. I did not detect any randomly deleted files nor a corrupt or unstable backup system.

Before:

 RUN  Grunt on availability_coursecompleted
>> Running tasks for component directory availability/condition/coursecompleted

Running "eslint:yui" (eslint) task

Running "shifter" task
>> Running shifter on availability/condition/coursecompleted
shifter [info] racing to find the closest .shifter.json file
shifter [info] woohoo, found a config here: starttimeavailability/condition/coursecompleted/.shifter.json
shifter [info] override config found for coverage
shifter [info] override config found for lint
shifter [info] override config found for clean
shifter [info] revving up
shifter [info] racing the directories
shifter [info] found 1 modules to race, let's do this
shifter [warn] this will be quiet, only status will be emitted for speed. failed builds will print after .
shifter [info] done racing, the gears are toast
shifter [info] finished in 0.232 seconds, pretty fast huh?
>> Shifter build complete.

Done.
Running "gherkinlint" task

Done.

In Filesystem.php line 59:

  Failed to copy "/tmp/moodle-plugin-ci-grunt-backup-1748337977/.git/objects/info/commit-graph" to "ava
  ilability/condition/coursecompleted/.git/objects/info/commit-graph" because target file could not be opened for wri
  ting: fopen(availability/condition/coursecompleted/.git/objects/info/commit-graph): Failed to open st
  ream: Permission denied


grunt [-m|--moodle MOODLE] [-t|--tasks TASKS] [--show-lint-warnings] [--max-lint-warnings MAX-LINT-WARNINGS] [--] <plugin>

After:

 RUN  Grunt on availability_coursecompleted
>> Running tasks for component directory availability/condition/coursecompleted

Running "eslint:yui" (eslint) task

Running "shifter" task
>> Running shifter on availability/condition/coursecompleted
shifter [info] racing to find the closest .shifter.json file
shifter [info] woohoo, found a config here: starttimeavailability/condition/coursecompleted/.shifter.json
shifter [info] override config found for coverage
shifter [info] override config found for lint
shifter [info] override config found for clean
shifter [info] revving up
shifter [info] racing the directories
shifter [info] found 1 modules to race, let's do this
shifter [warn] this will be quiet, only status will be emitted for speed. failed builds will print after
.
shifter [info] done racing, the gears are toast
shifter [info] finished in 0.24 seconds, pretty fast huh?
>> Shifter build complete.

Done.
Running "gherkinlint" task

Done.