Allow file system operations to be tracked for safe deletion of untouched files #27
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We avoid unnecessary file operations where possible, because avoiding file IO is faster, and it also helps build systems that depend on file modification times to detect modification. Unfortunately, this means we can't just delete an entire folder and start from scratch again. Stale files may still exist after re-copying a set of files where some of the original files have since been deleted. By tracking all files in a folder before starting file operations, and determining which files are still live based on the file operations performed, we can then safely delete all files which are determined to be stale. markAllFilesInFolderAsUntouched is to be called before a batch of file operations targeting a specific folder. If any file operations are performed by third-party libraries, those should be accompanied by markFileAsTouched. Finally, deleteUntouchedFiles can be called to remove stale files from the destination folder.
If certain external file operations cannot be tracked, markAllFilesStateAsUnknown should be used. This will prevent any files from being deleted. The project should be manually cleaned by the user in this case.
|
This can be closed now that we've merged openfl/lime#1790. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is the hxp part of a potential solution to openfl/lime#1546 (Stale output from previous builds can cause errors).
By tracking all files in a folder before starting file operations, and determining which files are still live based on the file operations performed, we can then safely delete all files which are determined to be stale.
markAllFilesInFolderAsUntouchedis to be called before a batch of file operations targeting a specific folder. If any file operations are performed directly by the caller instead of using hxp's System functions, those file operations should be accompanied bymarkFileAsTouched. Finally,deleteUntouchedFilescan be called to remove stale files from the destination folder.