mirror of
https://github.com/MindWorkAI/AI-Studio.git
synced 2025-08-20 20:12:57 +00:00
Added IConfigurationObject
interface and refactored cleanup logic
This commit is contained in:
parent
be11efed67
commit
80c1d72ca2
@ -3,7 +3,16 @@ using AIStudio.Tools.PluginSystem;
|
|||||||
|
|
||||||
namespace AIStudio.Settings;
|
namespace AIStudio.Settings;
|
||||||
|
|
||||||
public record ChatTemplate(uint Num, string Id, string Name, string SystemPrompt, string PredefinedUserPrompt, List<ContentBlock> ExampleConversation, bool AllowProfileUsage, bool IsEnterpriseConfiguration = false, Guid EnterpriseConfigurationPluginId = default)
|
public record ChatTemplate(
|
||||||
|
uint Num,
|
||||||
|
string Id,
|
||||||
|
string Name,
|
||||||
|
string SystemPrompt,
|
||||||
|
string PredefinedUserPrompt,
|
||||||
|
List<ContentBlock> ExampleConversation,
|
||||||
|
bool AllowProfileUsage,
|
||||||
|
bool IsEnterpriseConfiguration = false,
|
||||||
|
Guid EnterpriseConfigurationPluginId = default) : IConfigurationObject
|
||||||
{
|
{
|
||||||
public ChatTemplate() : this(0, Guid.Empty.ToString(), string.Empty, string.Empty, string.Empty, [], false)
|
public ChatTemplate() : this(0, Guid.Empty.ToString(), string.Empty, string.Empty, string.Empty, [], false)
|
||||||
{
|
{
|
||||||
|
@ -2,6 +2,8 @@ using System.Text.Json.Serialization;
|
|||||||
|
|
||||||
using AIStudio.Provider;
|
using AIStudio.Provider;
|
||||||
using AIStudio.Provider.HuggingFace;
|
using AIStudio.Provider.HuggingFace;
|
||||||
|
using AIStudio.Tools.PluginSystem;
|
||||||
|
|
||||||
using Host = AIStudio.Provider.SelfHosted.Host;
|
using Host = AIStudio.Provider.SelfHosted.Host;
|
||||||
|
|
||||||
namespace AIStudio.Settings;
|
namespace AIStudio.Settings;
|
||||||
@ -27,7 +29,7 @@ public readonly record struct Provider(
|
|||||||
Guid EnterpriseConfigurationPluginId = default,
|
Guid EnterpriseConfigurationPluginId = default,
|
||||||
string Hostname = "http://localhost:1234",
|
string Hostname = "http://localhost:1234",
|
||||||
Host Host = Host.NONE,
|
Host Host = Host.NONE,
|
||||||
HFInferenceProvider HFInferenceProvider = HFInferenceProvider.NONE) : ISecretId
|
HFInferenceProvider HFInferenceProvider = HFInferenceProvider.NONE) : ISecretId, IConfigurationObject
|
||||||
{
|
{
|
||||||
#region Overrides of ValueType
|
#region Overrides of ValueType
|
||||||
|
|
||||||
@ -57,4 +59,10 @@ public readonly record struct Provider(
|
|||||||
public string SecretName => this.InstanceName;
|
public string SecretName => this.InstanceName;
|
||||||
|
|
||||||
#endregion
|
#endregion
|
||||||
|
|
||||||
|
#region Implementation of IConfigurationObject
|
||||||
|
|
||||||
|
public string Name => this.InstanceName;
|
||||||
|
|
||||||
|
#endregion
|
||||||
}
|
}
|
@ -0,0 +1,32 @@
|
|||||||
|
namespace AIStudio.Tools.PluginSystem;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Represents a configuration object, such as a chat template or a LLM provider.
|
||||||
|
/// </summary>
|
||||||
|
public interface IConfigurationObject
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// The unique ID of the configuration object.
|
||||||
|
/// </summary>
|
||||||
|
public string Id { get; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// The continuous number of the configuration object.
|
||||||
|
/// </summary>
|
||||||
|
public uint Num { get; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// The name of the configuration object.
|
||||||
|
/// </summary>
|
||||||
|
public string Name { get; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Is this configuration object an enterprise configuration?
|
||||||
|
/// </summary>
|
||||||
|
public bool IsEnterpriseConfiguration { get; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// The ID of the enterprise configuration plugin.
|
||||||
|
/// </summary>
|
||||||
|
public Guid EnterpriseConfigurationPluginId { get; }
|
||||||
|
}
|
@ -1,3 +1,8 @@
|
|||||||
|
using System.Linq.Expressions;
|
||||||
|
|
||||||
|
using AIStudio.Settings;
|
||||||
|
using AIStudio.Settings.DataModel;
|
||||||
|
|
||||||
namespace AIStudio.Tools.PluginSystem;
|
namespace AIStudio.Tools.PluginSystem;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
@ -6,6 +11,9 @@ namespace AIStudio.Tools.PluginSystem;
|
|||||||
/// </summary>
|
/// </summary>
|
||||||
public sealed record PluginConfigurationObject
|
public sealed record PluginConfigurationObject
|
||||||
{
|
{
|
||||||
|
private static readonly SettingsManager SETTINGS_MANAGER = Program.SERVICE_PROVIDER.GetRequiredService<SettingsManager>();
|
||||||
|
private static readonly ILogger LOG = Program.LOGGER_FACTORY.CreateLogger<PluginConfigurationObject>();
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// The id of the configuration plugin to which this configuration object belongs.
|
/// The id of the configuration plugin to which this configuration object belongs.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
@ -20,4 +28,52 @@ public sealed record PluginConfigurationObject
|
|||||||
/// The type of the configuration object.
|
/// The type of the configuration object.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public required PluginConfigurationObjectType Type { get; init; } = PluginConfigurationObjectType.NONE;
|
public required PluginConfigurationObjectType Type { get; init; } = PluginConfigurationObjectType.NONE;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Cleans up configuration objects of a specified type that are no longer associated with any available plugin.
|
||||||
|
/// </summary>
|
||||||
|
/// <typeparam name="TClass">The type of configuration object to clean up.</typeparam>
|
||||||
|
/// <param name="configObjectType">The type of configuration object to process.</param>
|
||||||
|
/// <param name="configObjectSelection">A selection expression to retrieve the configuration objects from the main configuration.</param>
|
||||||
|
/// <param name="availablePlugins">A list of currently available plugins.</param>
|
||||||
|
/// <param name="configObjectList">A list of all existing configuration objects.</param>
|
||||||
|
/// <returns>Returns true if the configuration was altered during cleanup; otherwise, false.</returns>
|
||||||
|
public static bool CleanLeftOverConfigurationObjects<TClass>(
|
||||||
|
PluginConfigurationObjectType configObjectType,
|
||||||
|
Expression<Func<Data, List<TClass>>> configObjectSelection,
|
||||||
|
IList<IAvailablePlugin> availablePlugins,
|
||||||
|
IList<PluginConfigurationObject> configObjectList) where TClass : IConfigurationObject
|
||||||
|
{
|
||||||
|
var wasConfigurationChanged = false;
|
||||||
|
var configuredObjects = configObjectSelection.Compile()(SETTINGS_MANAGER.ConfigurationData);
|
||||||
|
foreach (var configuredObject in configuredObjects)
|
||||||
|
{
|
||||||
|
if(!configuredObject.IsEnterpriseConfiguration)
|
||||||
|
continue;
|
||||||
|
|
||||||
|
var configObjectSourcePluginId = configuredObject.EnterpriseConfigurationPluginId;
|
||||||
|
if(configObjectSourcePluginId == Guid.Empty)
|
||||||
|
continue;
|
||||||
|
|
||||||
|
var templateSourcePlugin = availablePlugins.FirstOrDefault(plugin => plugin.Id == configObjectSourcePluginId);
|
||||||
|
if(templateSourcePlugin is null)
|
||||||
|
{
|
||||||
|
LOG.LogWarning($"The configured object '{configuredObject.Name}' (id={configuredObject.Id}) is based on a plugin that is not available anymore. Removing the chat template from the settings.");
|
||||||
|
configuredObjects.Remove(configuredObject);
|
||||||
|
wasConfigurationChanged = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
if(!configObjectList.Any(configObject =>
|
||||||
|
configObject.Type == configObjectType &&
|
||||||
|
configObject.ConfigPluginId == configObjectSourcePluginId &&
|
||||||
|
configObject.Id.ToString() == configuredObject.Id))
|
||||||
|
{
|
||||||
|
LOG.LogWarning($"The configured object '{configuredObject.Name}' (id={configuredObject.Id}) is not present in the configuration plugin anymore. Removing the chat template from the settings.");
|
||||||
|
configuredObjects.Remove(configuredObject);
|
||||||
|
wasConfigurationChanged = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return wasConfigurationChanged;
|
||||||
|
}
|
||||||
}
|
}
|
@ -92,10 +92,10 @@ public static partial class PluginFactory
|
|||||||
|
|
||||||
case { IsValid: false }:
|
case { IsValid: false }:
|
||||||
LOG.LogError($"Was not able to load plugin '{pluginMainFile}', because the Lua code is not a valid AI Studio plugin. There are {plugin.Issues.Count()} issues to fix. First issue is: {plugin.Issues.FirstOrDefault()}");
|
LOG.LogError($"Was not able to load plugin '{pluginMainFile}', because the Lua code is not a valid AI Studio plugin. There are {plugin.Issues.Count()} issues to fix. First issue is: {plugin.Issues.FirstOrDefault()}");
|
||||||
#if DEBUG
|
#if DEBUG
|
||||||
foreach (var pluginIssue in plugin.Issues)
|
foreach (var pluginIssue in plugin.Issues)
|
||||||
LOG.LogError($"Plugin issue: {pluginIssue}");
|
LOG.LogError($"Plugin issue: {pluginIssue}");
|
||||||
#endif
|
#endif
|
||||||
continue;
|
continue;
|
||||||
|
|
||||||
case { IsMaintained: false }:
|
case { IsMaintained: false }:
|
||||||
@ -125,89 +125,24 @@ public static partial class PluginFactory
|
|||||||
|
|
||||||
//
|
//
|
||||||
// =========================================================
|
// =========================================================
|
||||||
// Next, we have to clean up our settings. It is possible that a configuration plugin was removed.
|
// Next, we have to clean up our settings. It is possible
|
||||||
// We have to remove the related settings as well:
|
// that a configuration plugin was removed. We have to
|
||||||
|
// remove the related settings as well:
|
||||||
// =========================================================
|
// =========================================================
|
||||||
//
|
//
|
||||||
var wasConfigurationChanged = false;
|
|
||||||
|
|
||||||
//
|
|
||||||
// Check LLM providers:
|
// Check LLM providers:
|
||||||
//
|
var wasConfigurationChanged = PluginConfigurationObject.CleanLeftOverConfigurationObjects(PluginConfigurationObjectType.LLM_PROVIDER, x => x.Providers, AVAILABLE_PLUGINS, configObjectList);
|
||||||
#pragma warning disable MWAIS0001
|
|
||||||
var configuredProviders = SETTINGS_MANAGER.ConfigurationData.Providers.ToList();
|
|
||||||
foreach (var configuredProvider in configuredProviders)
|
|
||||||
{
|
|
||||||
if(!configuredProvider.IsEnterpriseConfiguration)
|
|
||||||
continue;
|
|
||||||
|
|
||||||
var providerSourcePluginId = configuredProvider.EnterpriseConfigurationPluginId;
|
|
||||||
if(providerSourcePluginId == Guid.Empty)
|
|
||||||
continue;
|
|
||||||
|
|
||||||
var providerSourcePlugin = AVAILABLE_PLUGINS.FirstOrDefault(plugin => plugin.Id == providerSourcePluginId);
|
|
||||||
if(providerSourcePlugin is null)
|
|
||||||
{
|
|
||||||
LOG.LogWarning($"The configured LLM provider '{configuredProvider.InstanceName}' (id={configuredProvider.Id}) is based on a plugin that is not available anymore. Removing the provider from the settings.");
|
|
||||||
SETTINGS_MANAGER.ConfigurationData.Providers.Remove(configuredProvider);
|
|
||||||
wasConfigurationChanged = true;
|
|
||||||
}
|
|
||||||
|
|
||||||
if(!configObjectList.Any(configObject =>
|
|
||||||
configObject.Type is PluginConfigurationObjectType.LLM_PROVIDER &&
|
|
||||||
configObject.ConfigPluginId == providerSourcePluginId &&
|
|
||||||
configObject.Id.ToString() == configuredProvider.Id))
|
|
||||||
{
|
|
||||||
LOG.LogWarning($"The configured LLM provider '{configuredProvider.InstanceName}' (id={configuredProvider.Id}) is not present in the configuration plugin anymore. Removing the provider from the settings.");
|
|
||||||
SETTINGS_MANAGER.ConfigurationData.Providers.Remove(configuredProvider);
|
|
||||||
wasConfigurationChanged = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
#pragma warning restore MWAIS0001
|
|
||||||
|
|
||||||
//
|
|
||||||
// Check chat templates:
|
// Check chat templates:
|
||||||
//
|
if(PluginConfigurationObject.CleanLeftOverConfigurationObjects(PluginConfigurationObjectType.CHAT_TEMPLATE, x => x.ChatTemplates, AVAILABLE_PLUGINS, configObjectList))
|
||||||
var configuredTemplates = SETTINGS_MANAGER.ConfigurationData.ChatTemplates.ToList();
|
|
||||||
foreach (var configuredTemplate in configuredTemplates)
|
|
||||||
{
|
|
||||||
if(!configuredTemplate.IsEnterpriseConfiguration)
|
|
||||||
continue;
|
|
||||||
|
|
||||||
var templateSourcePluginId = configuredTemplate.EnterpriseConfigurationPluginId;
|
|
||||||
if(templateSourcePluginId == Guid.Empty)
|
|
||||||
continue;
|
|
||||||
|
|
||||||
var templateSourcePlugin = AVAILABLE_PLUGINS.FirstOrDefault(plugin => plugin.Id == templateSourcePluginId);
|
|
||||||
if(templateSourcePlugin is null)
|
|
||||||
{
|
|
||||||
LOG.LogWarning($"The configured chat template '{configuredTemplate.Name}' (id={configuredTemplate.Id}) is based on a plugin that is not available anymore. Removing the chat template from the settings.");
|
|
||||||
SETTINGS_MANAGER.ConfigurationData.ChatTemplates.Remove(configuredTemplate);
|
|
||||||
wasConfigurationChanged = true;
|
wasConfigurationChanged = true;
|
||||||
}
|
|
||||||
|
|
||||||
if(!configObjectList.Any(configObject =>
|
// Check for update behavior:
|
||||||
configObject.Type is PluginConfigurationObjectType.CHAT_TEMPLATE &&
|
|
||||||
configObject.ConfigPluginId == templateSourcePluginId &&
|
|
||||||
configObject.Id.ToString() == configuredTemplate.Id))
|
|
||||||
{
|
|
||||||
LOG.LogWarning($"The configured chat template '{configuredTemplate.Name}' (id={configuredTemplate.Id}) is not present in the configuration plugin anymore. Removing the chat template from the settings.");
|
|
||||||
SETTINGS_MANAGER.ConfigurationData.ChatTemplates.Remove(configuredTemplate);
|
|
||||||
wasConfigurationChanged = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
//
|
|
||||||
// ==========================================================
|
|
||||||
// Check all possible settings:
|
|
||||||
// ==========================================================
|
|
||||||
//
|
|
||||||
|
|
||||||
// Check for updates, and if so, how often?
|
|
||||||
if(ManagedConfiguration.IsConfigurationLeftOver<DataApp, UpdateBehavior>(x => x.App, x => x.UpdateBehavior, AVAILABLE_PLUGINS))
|
if(ManagedConfiguration.IsConfigurationLeftOver<DataApp, UpdateBehavior>(x => x.App, x => x.UpdateBehavior, AVAILABLE_PLUGINS))
|
||||||
wasConfigurationChanged = true;
|
wasConfigurationChanged = true;
|
||||||
|
|
||||||
// Allow the user to add providers?
|
// Check for users allowed to added providers:
|
||||||
if(ManagedConfiguration.IsConfigurationLeftOver<DataApp, bool>(x => x.App, x => x.AllowUserToAddProvider, AVAILABLE_PLUGINS))
|
if(ManagedConfiguration.IsConfigurationLeftOver<DataApp, bool>(x => x.App, x => x.AllowUserToAddProvider, AVAILABLE_PLUGINS))
|
||||||
wasConfigurationChanged = true;
|
wasConfigurationChanged = true;
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user