feat(plugin): add SquidStd.Plugin loader package#65
Merged
Conversation
Moves BootstrapStateType from SquidStd.Services.Core (internal) to SquidStd.Core.Types.Bootstrap (public) and adds a read-only State property so external packages can guard pre-start-only operations.
… context keys New loader package skeleton referencing Core and Plugin.Abstractions: PluginCollectionBuilder (internal plugins by type or instance, external directories), PluginLoadException, standard PluginContextKeys, and host-agnostic wording in the abstractions docs.
Topological sort across the whole plugin set with fail-fast errors for duplicate ids, missing dependencies, and cycles (the message names the cycle members). Plugins with no dependency relation keep registration order.
Scans a directory for *.dll files, loads them into the default AssemblyLoadContext (trusted plugins, shared type identity), and instantiates every concrete ISquidStdPlugin. Assemblies without plugins are skipped with a debug log; load and instantiation failures and a missing directory fail fast with PluginLoadException. Tests emit plugin assemblies at run time with Roslyn, so no binary fixtures are committed.
UsePlugins collects internal and external plugins, sorts them across the whole set, and configures each against the bootstrap container before startup, populating the standard PluginContext keys. Guarded to the Created bootstrap state. The plugins sample now boots through the loader.
Package README with the UsePlugins example, loading rules, context keys and the trusted-plugin contract; docs article and toc entry; pointer from the abstractions README.
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Comment on lines
+53
to
+60
| foreach (var directory in builder.Directories) | ||
| { | ||
| var resolved = Path.IsPathRooted(directory) | ||
| ? directory | ||
| : Path.Combine(bootstrap.Options.RootDirectory, directory); | ||
|
|
||
| plugins.AddRange(PluginAssemblyScanner.Scan(resolved)); | ||
| } |
| { | ||
| var resolved = Path.IsPathRooted(directory) | ||
| ? directory | ||
| : Path.Combine(bootstrap.Options.RootDirectory, directory); |
Comment on lines
+50
to
+53
| catch (Exception ex) | ||
| { | ||
| throw new PluginLoadException($"Failed to load plugin assembly '{dllPath}'.", ex); | ||
| } |
Comment on lines
+68
to
+74
| catch (Exception ex) | ||
| { | ||
| throw new PluginLoadException( | ||
| $"Failed to instantiate plugin type '{pluginType.FullName}' from '{dllPath}'.", | ||
| ex | ||
| ); | ||
| } |
Comment on lines
+17
to
+23
| foreach (var plugin in plugins) | ||
| { | ||
| if (!byId.TryAdd(plugin.Metadata.Id, plugin)) | ||
| { | ||
| throw new PluginLoadException($"Duplicate plugin id '{plugin.Metadata.Id}'."); | ||
| } | ||
| } |
| [Fact] | ||
| public void Scan_MissingDirectory_Throws() | ||
| { | ||
| var missing = Path.Combine(Path.GetTempPath(), Guid.NewGuid().ToString("N")); |
|
|
||
| try | ||
| { | ||
| File.WriteAllBytes(Path.Combine(directory.FullName, "broken.dll"), [1, 2, 3, 4]); |
| new CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary) | ||
| ); | ||
|
|
||
| var path = Path.Combine(directory, fileName); |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
SquidStd.Plugin: the loader forSquidStd.Plugin.Abstractions. Single entry point on the bootstrap:PluginMetadata.Dependencies, case-insensitive, stable topological sort with actionable errors for duplicates, missing dependencies and cycles) and eachConfigure(container, context)runs before the bootstrap starts, hence before the configuration load - plugins can register config sections, services and Lua modules.PluginLoadException.PluginContextnow carries standard keys (PluginContextKeys.RootDirectory/AppName).BootstrapStateTypeis now public inSquidStd.Core.Types.BootstrapandISquidStdBootstrapexposes read-onlyState(used by the pre-start guard).SquidStd.Samples.Pluginsboots through the loader; new docs article "SquidStd.Plugin" + toc + READMEs.Test plan