Skip to content

Commit

Permalink
Tweak ContentSafetyOptions.Enabled attribution and stream-line Servic…
Browse files Browse the repository at this point in the history
…eExtensiosn (#234)

### Motivation and Context

```
Unhandled exception. Microsoft.Extensions.Options.OptionsValidationException: DataAnnotation validation failed for 'ContentSafetyOptions' members: '' with the error: ''Enabled' must be a string.'.
   at Microsoft.Extensions.Options.OptionsFactory`1.Create(String name)
   at System.Lazy`1.ViaFactory(LazyThreadSafetyMode mode)
   at System.Lazy`1.ExecutionAndPublication(LazyHelper executionAndPublication, Boolean useDefaultConstructor)
   at System.Lazy`1.CreateValue()
   at Microsoft.Extensions.Options.OptionsCache`1.GetOrAdd[TArg](String name, Func`3 createOptions, TArg factoryArgument)
   at Microsoft.Extensions.Options.OptionsMonitor`1.Get(String name)
   at Microsoft.Extensions.DependencyInjection.OptionsBuilderExtensions.<>c__DisplayClass0_1`1.<ValidateOnStart>b__1()
   at Microsoft.Extensions.DependencyInjection.ValidationHostedService.StartAsync(CancellationToken cancellationToken)
--- End of stack trace from previous location ---
   at Microsoft.Extensions.DependencyInjection.ValidationHostedService.StartAsync(CancellationToken cancellationToken)
   at Microsoft.Extensions.Hosting.Internal.Host.StartAsync(CancellationToken cancellationToken)
   at Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.RunAsync(IHost host, CancellationToken token)
   at Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.RunAsync(IHost host, CancellationToken token)
   at CopilotChat.WebApi.Program.Main(String[] args) in C:\Users\crickman\source\repos\sk-chat-copilot\webapi\Program.cs:line 115
   at CopilotChat.WebApi.Program.<Main>(String[] args)
```
<!-- Thank you for your contribution to the copilot-chat repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

### Description

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

- I think the whitespace instruction confused the validation on the
type.
- Reducing repeated code / increase consistency in
`ServiceExtensions.cs`
### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [ ] The code builds clean without any errors or warnings
- [ ] The PR follows the [Contribution
Guidelines](https://github.com/microsoft/copilot-chat/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/copilot-chat/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [ ] All unit tests pass, and I have added new tests where possible
- [ ] I didn't break anyone 😄
  • Loading branch information
crickman authored Aug 21, 2023
1 parent 9fed552 commit ec746e8
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 59 deletions.
86 changes: 28 additions & 58 deletions webapi/Extensions/ServiceExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -34,88 +34,58 @@ public static class CopilotChatServiceExtensions
public static IServiceCollection AddOptions(this IServiceCollection services, ConfigurationManager configuration)
{
// General configuration
services.AddOptions<ServiceOptions>()
.Bind(configuration.GetSection(ServiceOptions.PropertyName))
.ValidateDataAnnotations()
.ValidateOnStart()
.PostConfigure(TrimStringProperties);
AddOptions<ServiceOptions>(ServiceOptions.PropertyName);

// Default AI service configurations for Semantic Kernel
services.AddOptions<AIServiceOptions>()
.Bind(configuration.GetSection(AIServiceOptions.PropertyName))
.ValidateDataAnnotations()
.ValidateOnStart()
.PostConfigure(TrimStringProperties);
AddOptions<AIServiceOptions>(AIServiceOptions.PropertyName);

// Memory store configuration
services.AddOptions<MemoryStoreOptions>()
.Bind(configuration.GetSection(MemoryStoreOptions.PropertyName))
.ValidateDataAnnotations()
.ValidateOnStart()
.PostConfigure(TrimStringProperties);
AddOptions<MemoryStoreOptions>(MemoryStoreOptions.PropertyName);

// Authentication configuration
services.AddOptions<ChatAuthenticationOptions>()
.Bind(configuration.GetSection(ChatAuthenticationOptions.PropertyName))
.ValidateOnStart()
.PostConfigure(TrimStringProperties);
AddOptions<ChatAuthenticationOptions>(ChatAuthenticationOptions.PropertyName);

// Chat log storage configuration
services.AddOptions<ChatStoreOptions>()
.Bind(configuration.GetSection(ChatStoreOptions.PropertyName))
.ValidateDataAnnotations()
.ValidateOnStart()
.PostConfigure(TrimStringProperties);
AddOptions<ChatStoreOptions>(ChatStoreOptions.PropertyName);

// Azure speech token configuration
services.AddOptions<AzureSpeechOptions>()
.Bind(configuration.GetSection(AzureSpeechOptions.PropertyName))
.ValidateDataAnnotations()
.ValidateOnStart()
.PostConfigure(TrimStringProperties);
AddOptions<AzureSpeechOptions>(AzureSpeechOptions.PropertyName);

// Bot schema configuration
services.AddOptions<BotSchemaOptions>()
.Bind(configuration.GetSection(BotSchemaOptions.PropertyName))
.ValidateDataAnnotations()
.ValidateOnStart()
.PostConfigure(TrimStringProperties);
AddOptions<BotSchemaOptions>(BotSchemaOptions.PropertyName);

// Document memory options
services.AddOptions<DocumentMemoryOptions>()
.Bind(configuration.GetSection(DocumentMemoryOptions.PropertyName))
.ValidateDataAnnotations()
.ValidateOnStart()
.PostConfigure(TrimStringProperties);
AddOptions<DocumentMemoryOptions>(DocumentMemoryOptions.PropertyName);

// Chat prompt options
services.AddOptions<PromptsOptions>()
.Bind(configuration.GetSection(PromptsOptions.PropertyName))
.ValidateDataAnnotations()
.ValidateOnStart()
.PostConfigure(TrimStringProperties);
AddOptions<PromptsOptions>(PromptsOptions.PropertyName);

// Planner options
services.AddOptions<PlannerOptions>()
.Bind(configuration.GetSection(PlannerOptions.PropertyName))
.ValidateDataAnnotations()
.ValidateOnStart()
.PostConfigure(TrimStringProperties);
AddOptions<PlannerOptions>(PlannerOptions.PropertyName);

// OCR support options
services.AddOptions<OcrSupportOptions>()
.Bind(configuration.GetSection(OcrSupportOptions.PropertyName))
.ValidateDataAnnotations()
.ValidateOnStart()
.PostConfigure(TrimStringProperties);
AddOptions<OcrSupportOptions>(OcrSupportOptions.PropertyName);

// Content safety options
services.AddOptions<ContentSafetyOptions>()
.Bind(configuration.GetSection(ContentSafetyOptions.PropertyName))
.ValidateOnStart()
.PostConfigure(TrimStringProperties);
AddOptions<ContentSafetyOptions>(ContentSafetyOptions.PropertyName);

return services;

void AddOptions<TOptions>(string propertyName)
where TOptions : class
{
services.AddOptions<TOptions>(configuration.GetSection(propertyName));
}
}

internal static void AddOptions<TOptions>(this IServiceCollection services, IConfigurationSection section)
where TOptions : class
{
services.AddOptions<TOptions>()
.Bind(section)
.ValidateDataAnnotations()
.ValidateOnStart()
.PostConfigure(TrimStringProperties);
}

internal static IServiceCollection AddUtilities(this IServiceCollection services)
Expand Down
2 changes: 1 addition & 1 deletion webapi/Options/ContentSafetyOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ public class ContentSafetyOptions
/// <summary>
/// Whether to enable content safety.
/// </summary>
[Required, NotEmptyOrWhitespace]
[Required]
public bool Enabled { get; set; } = false;

/// <summary>
Expand Down

0 comments on commit ec746e8

Please sign in to comment.