Enh/5943 DropIns - Prevention of File Locks and Unloading #5944
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
Changed DropInDescriptor from Record to Class to be able to add the suggested DynamicallyAccesedMembers decorator.
The `DropIn` class in `DropIn.cs` now includes a new `Unconfigure` method. This method handles the unconfiguration process when a drop-in is deleted. It retrieves the `ILogger<DropIn>` and `IActivityRegistry` services from the `IServiceProvider`, removes the `SampleActivity` from the activity registry, and logs the outcome. The `IDropIn` interface in `IDropIn.cs` has been updated to include the new `Unconfigure` method, ensuring that it is called when the drop-in is deleted. Additional using directives have been added to `DropIn.cs` for `Elsa.Workflows`, and `Microsoft.Extensions.Logging`.
Modified the `LoadPath` method in the `AssemblyLoader` class to load assemblies from a memory stream instead of directly from the file. This change prevents file locking issues by copying the file contents to a memory stream and then loading the assembly from this stream.
Ensure the packageReader is disposed of after loading the assembly from the memory stream. This change adds a call to `packageReader.Dispose()` to close the package reader and the associated `.nupkg` file, which helps in releasing resources and preventing potential file locks or memory leaks.
Updated DropInDirectoryMonitorHostedService to handle unloading of drop-ins when files are deleted. Added `_debouncedUnloader` and `_installedDropIns` fields. Modified constructor to initialize these fields. Updated `ExecuteAsync` to call `LoadDropInAssemblyAsync` initially and handle file deletion events. Added `OnDeleted` method to manage file deletions and invoke the debounced unloader. Enhanced `LoadDropInAssemblyAsync` to track loaded drop-ins. Introduced `UnloadDropInAssemblyAsync` to remove drop-ins on file deletion.
Modified the assembly loading process to use a MemoryStream instead of a FileStream. This change ensures that the FileStream is properly closed before the assembly is loaded, improving resource management and preventing potential file access issues.
andrenevesgomes
approved these changes
Sep 5, 2024
sfmskywalker
approved these changes
Sep 5, 2024
Removed logging from DropIn.Unconfigure method and added ILogger dependency to DropInDirectoryMonitorHostedService. Updated csproj to include Microsoft.Extensions.Logging.Abstractions. Enhanced error handling in UnloadDropInAssemblyAsync method. Minor formatting improvements for readability.
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.
PR Classification
New feature and code improvement.
PR Summary
Introduces an
Unconfiguremethod for drop-ins and improves assembly loading to avoid file locking issues.DropIn.csandIDropIn.cs: AddedUnconfiguremethod for drop-ins.NuGetPackageAssemblyLoadContext.cs: DisposedpackageReaderto close.nupkgfile.AssemblyLoader.cs: Modified to load assemblies from a memory stream.DropInDirectoryMonitorHostedService.cs: Added debounced unloader, async loading, and handling of file deletion events.DropInDescriptor.cs: Changed to class withDynamicallyAccessedMembersattribute to suppress IL2072 warning.Fixes #5943
This change is