Migrate file I/O tasks to multithreadable task API #12914
Conversation
…n status Co-authored-by: JanProvaznik <[email protected]>
…s section Co-authored-by: JanProvaznik <[email protected]>
- Updated FileState.cs to accept TaskEnvironment parameter - Migrated 7 File I/O tasks to IMultiThreadableTask: * Copy - added attribute, interface, TaskEnvironment property and updated path/environment access * Delete - migrated with proper path resolution * MakeDir - migrated with path deduplication * RemoveDir - migrated with directory operations * Touch - migrated with file timestamp operations * ReadLinesFromFile - migrated for file reading * WriteLinesToFile - migrated for file writing - All tasks use MSBuildMultiThreadableTaskAttribute for routing - All tasks implement IMultiThreadableTask for TaskEnvironment access - Tasks use TaskEnvironment.GetAbsolutePath() for thread-safe path resolution - Tasks use TaskEnvironment.GetEnvironmentVariable() for thread-safe environment access Co-authored-by: JanProvaznik <[email protected]>
JanProvaznik
changed the title
There was a problem hiding this comment.
Pull request overview
This PR converts several file I/O tasks to support multi-threaded execution by implementing IMultiThreadableTask and using TaskEnvironment for thread-safe path resolution. The changes replace static path resolution methods with instance-based TaskEnvironment.GetAbsolutePath() calls to ensure proper path handling in concurrent scenarios.
Key Changes:
- Added
IMultiThreadableTaskinterface and[MSBuildMultiThreadableTask]attribute to 7 file I/O task classes - Introduced
TaskEnvironmentproperty to all modified tasks for thread-safe operations - Modified
FileStateconstructor to requireTaskEnvironmentparameter and use it for path resolution
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| src/Tasks/Touch.cs | Added multithreading support; uses TaskEnvironment for path resolution in TouchFile method |
| src/Tasks/RemoveDir.cs | Added multithreading support; resolves paths using TaskEnvironment in Execute and RemoveDirectory methods |
| src/Tasks/MakeDir.cs | Added multithreading support; uses TaskEnvironment for path resolution and deduplication |
| src/Tasks/FileState.cs | Modified constructor to require TaskEnvironment parameter; uses it for absolute path resolution in Lazy initialization |
| src/Tasks/FileIO/WriteLinesToFile.cs | Added multithreading support; uses TaskEnvironment for path resolution instead of FileUtilities.NormalizePath |
| src/Tasks/FileIO/ReadLinesFromFile.cs | Added multithreading support; resolves file paths using TaskEnvironment before file operations |
| src/Tasks/Delete.cs | Added multithreading support; uses TaskEnvironment for path resolution in delete operations |
| src/Tasks/Copy.cs | Added multithreading support; uses TaskEnvironment for path resolution, environment variables, and FileState construction; changed PathsAreIdentical from static to instance method |
AR-May
left a comment
AR-May
left a comment
There was a problem hiding this comment.
LGTM, but I would like one more review to ensure there is no behavior change in multi process mode.
src/Tasks/Touch.cs
Outdated
| SetLastWriteTime fileSetLastWriteTime) | ||
| { | ||
| if (!fileExists(file)) | ||
| AbsolutePath absoluteFile = TaskEnvironment.GetAbsolutePath(file); |
There was a problem hiding this comment.
please normalize it one level higher to avoid inconsistency with the logged messages that still rely on file
There was a problem hiding this comment.
the same is relevant for other Tasks
There was a problem hiding this comment.
side note: very good catch, I didn't realize that file is implicitly computed from cwd of the node during logging if it is not specified
There was a problem hiding this comment.
hm actually it might be a general issue for location of errors/warnings and might need to use FileUtilities.CurrentThreadWorkingDirectory in more places, need to look into that after this PR
3 participants
fixes #12484
This PR migrates several file I/O tasks to use the new multithreadable task API by implementing the \IMultiThreadableTask\ interface and using \TaskEnvironment\ for thread-safe path resolution.
Changes
The following tasks now implement \IMultiThreadableTask\ and use \TaskEnvironment.GetAbsolutePath()\ instead of \Path.GetFullPath():
Why
\Path.GetFullPath()\ uses process-global state (current working directory) which is not thread-safe when multiple tasks run in parallel. The \TaskEnvironment.GetAbsolutePath()\ method provides thread-safe path resolution by using the task's execution context.
This enables these tasks to be safely executed in parallel when MSBuild's multithreading is enabled.