.Net MEVD: Dependency Injection for SqlServer connector

dotnet/src/Connectors/Connectors.Memory.SqlServer/SqlServerServiceCollectionExtensions.cs

@@ -0,0 +1,212 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+using System;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection.Extensions;
+using Microsoft.Extensions.VectorData;
+
+namespace Microsoft.SemanticKernel.Connectors.SqlServer;
+
+/// <summary>
+/// Extension methods to register <see cref="SqlServerVectorStore"/> instances on an <see cref="IServiceCollection"/>.
+/// </summary>
+public static class SqlServerServiceCollectionExtensions
+{
+    /// <summary>
+    /// Registers a <see cref="SqlServerVectorStore"/> as <see cref="IVectorStore"/>, with the specified connection string and service lifetime.
+    /// </summary>
+    /// <param name="services">The <see cref="IServiceCollection"/> to register the <see cref="IVectorStore"/> on.</param>
+    /// <param name="connectionStringProvider">The connection string provider.</param>
+    /// <param name="optionsProvider">Options provider to further configure the vector store.</param>
+    /// <param name="lifetime">The service lifetime for the store. Defaults to <see cref="ServiceLifetime.Singleton"/>.</param>
+    /// <returns>The service collection.</returns>
+    public static IServiceCollection AddSqlServerVectorStore(this IServiceCollection services,
+        Func<IServiceProvider, string> connectionStringProvider,
+        Func<IServiceProvider, SqlServerVectorStoreOptions>? optionsProvider = null,
+        ServiceLifetime lifetime = ServiceLifetime.Singleton)
+    {
+        Verify.NotNull(services);
+        Verify.NotNull(connectionStringProvider);
+
+        services.Add(new ServiceDescriptor(typeof(SqlServerVectorStore), sp =>
+        {
+            var connectionString = connectionStringProvider(sp);
+            var options = optionsProvider?.Invoke(sp);
+            return new SqlServerVectorStore(connectionString, options);
+        }, lifetime));
+
+        // We try to add the SqlServerVectorStore as an IVectorStore,
+        // but if it already exists, we don't override it.
+        // Sample scenario: one app using two different vector stores.
+        services.TryAdd(new ServiceDescriptor(typeof(IVectorStore),
+            static sp => sp.GetRequiredService<SqlServerVectorStore>(), lifetime));
+
+        return services;
+    }
+
+    /// <summary>
+    /// Registers a keyed <see cref="SqlServerVectorStore"/> as <see cref="IVectorStore"/>, with the specified connection string and service lifetime.
+    /// </summary>
+    /// <param name="services">The <see cref="IServiceCollection"/> to register the <see cref="IVectorStore"/> on.</param>
+    /// <param name="serviceKey">The key with which to associate the vector store.</param>
+    /// <param name="connectionStringProvider">The connection string provider.</param>
+    /// <param name="optionsProvider">Options provider to further configure the vector store.</param>
+    /// <param name="lifetime">The service lifetime for the store. Defaults to <see cref="ServiceLifetime.Singleton"/>.</param>
+    /// <returns>The service collection.</returns>
+    public static IServiceCollection AddKeyedSqlServerVectorStore(this IServiceCollection services,
+        object serviceKey,
+        Func<IServiceProvider, string> connectionStringProvider,
+        Func<IServiceProvider, SqlServerVectorStoreOptions>? optionsProvider = null,
+        ServiceLifetime lifetime = ServiceLifetime.Singleton)
+    {
+        Verify.NotNull(services);
+        Verify.NotNull(serviceKey);
+        Verify.NotNull(connectionStringProvider);
+
+        services.Add(new ServiceDescriptor(typeof(SqlServerVectorStore), serviceKey, (sp, _) =>
+        {
+            var connectionString = connectionStringProvider(sp);
+            var options = optionsProvider?.Invoke(sp);
+            return new SqlServerVectorStore(connectionString, options);
+        }, lifetime));
+
+        services.TryAdd(new ServiceDescriptor(typeof(IVectorStore), serviceKey,
+            static (sp, key) => sp.GetRequiredKeyedService<SqlServerVectorStore>(key), lifetime));
+
+        return services;
+    }
+
+    /// <summary>
+    /// Registers a <see cref="SqlServerVectorStoreRecordCollection{TKey, TRecord}"/> as <see cref="IVectorStoreRecordCollection{TKey, TRecord}"/>, with the specified connection string and service lifetime.
+    /// </summary>
+    /// <param name="services">The <see cref="IServiceCollection"/> to register the <see cref="IVectorStoreRecordCollection{TKey, TRecord}"/> on.</param>
+    /// <param name="collectionName">The name of the collection.</param>
+    /// <param name="connectionStringProvider">The connection string provider.</param>
+    /// <param name="optionsProvider">Options provider to further configure the collection.</param>
+    /// <param name="lifetime">The service lifetime for the store. Defaults to <see cref="ServiceLifetime.Singleton"/>.</param>
+    /// <returns>The service collection.</returns>
+    public static IServiceCollection AddSqlServerVectorStoreCollection<TKey, TRecord>(this IServiceCollection services,
+        string collectionName,
+        Func<IServiceProvider, string> connectionStringProvider,
+        Func<IServiceProvider, SqlServerVectorStoreRecordCollectionOptions<TRecord>>? optionsProvider = null,
+        ServiceLifetime lifetime = ServiceLifetime.Singleton)
+        where TKey : notnull
+        where TRecord : notnull
+    {
+        Verify.NotNull(services);
+        Verify.NotNullOrWhiteSpace(collectionName);
+        Verify.NotNull(connectionStringProvider);
+
+        services.Add(new ServiceDescriptor(typeof(SqlServerVectorStoreRecordCollection<TKey, TRecord>), sp =>
+        {
+            var connectionString = connectionStringProvider(sp);
+            var options = optionsProvider?.Invoke(sp);
+            return new SqlServerVectorStoreRecordCollection<TKey, TRecord>(connectionString, collectionName, options);
+        }, lifetime));
+
+        services.TryAdd(new ServiceDescriptor(typeof(IVectorStoreRecordCollection<TKey, TRecord>),
+            static sp => sp.GetRequiredService<SqlServerVectorStoreRecordCollection<TKey, TRecord>>(), lifetime));
+
+        return services;
+    }
+
+    /// <summary>
+    /// Registers a keyed <see cref="SqlServerVectorStoreRecordCollection{TKey, TRecord}"/> as <see cref="IVectorStoreRecordCollection{TKey, TRecord}"/>, with the specified connection string and service lifetime.
+    /// </summary>
+    /// <param name="services">The <see cref="IServiceCollection"/> to register the <see cref="IVectorStoreRecordCollection{TKey, TRecord}"/> on.</param>
+    /// <param name="serviceKey">The key with which to associate the collection.</param>
+    /// <param name="collectionName">The name of the collection.</param>
+    /// <param name="connectionStringProvider">The connection string provider.</param>
+    /// <param name="optionsProvider">Options provider to further configure the collection.</param>
+    /// <param name="lifetime">The service lifetime for the store. Defaults to <see cref="ServiceLifetime.Singleton"/>.</param>
+    /// <returns>The service collection.</returns>
+    public static IServiceCollection AddKeyedSqlServerVectorStoreCollection<TKey, TRecord>(this IServiceCollection services,
+        object serviceKey,
+        string collectionName,
+        Func<IServiceProvider, string> connectionStringProvider,
+        Func<IServiceProvider, SqlServerVectorStoreRecordCollectionOptions<TRecord>>? optionsProvider = null,
+        ServiceLifetime lifetime = ServiceLifetime.Singleton)
+        where TKey : notnull
+        where TRecord : notnull
+    {
+        Verify.NotNull(services);
+        Verify.NotNull(serviceKey);
+        Verify.NotNullOrWhiteSpace(collectionName);
+        Verify.NotNull(connectionStringProvider);
+
+        services.Add(new ServiceDescriptor(typeof(SqlServerVectorStoreRecordCollection<TKey, TRecord>), serviceKey, (sp, _) =>
+        {
+            var connectionString = connectionStringProvider(sp);
+            var options = optionsProvider?.Invoke(sp);
+            return new SqlServerVectorStoreRecordCollection<TKey, TRecord>(connectionString, collectionName, options);
+        }, lifetime));
+
+        services.TryAdd(new ServiceDescriptor(typeof(IVectorStoreRecordCollection<TKey, TRecord>), serviceKey,
+            static (sp, key) => sp.GetRequiredKeyedService<SqlServerVectorStoreRecordCollection<TKey, TRecord>>(key), lifetime));
+
+        return services;
+    }
+
+    /// <summary>
+    /// Registers a <see cref="SqlServerVectorStoreRecordCollection{TKey, TRecord}"/> as <see cref="IVectorStoreRecordCollection{TKey, TRecord}"/>, with the specified connection string and service lifetime.
+    /// </summary>
+    /// <param name="services">The <see cref="IServiceCollection"/> to register the <see cref="IVectorStoreRecordCollection{TKey, TRecord}"/> on.</param>
+    /// <param name="collectionName">The name of the collection.</param>
+    /// <param name="connectionString">The connection string.</param>
+    /// <param name="options">Options to further configure the collection.</param>
+    /// <param name="lifetime">The service lifetime for the store. Defaults to <see cref="ServiceLifetime.Singleton"/>.</param>
+    /// <returns>The service collection.</returns>
+    public static IServiceCollection AddSqlServerVectorStoreCollection<TKey, TRecord>(this IServiceCollection services,
+        string collectionName,
+        string connectionString,
+        SqlServerVectorStoreRecordCollectionOptions<TRecord>? options = null,
+        ServiceLifetime lifetime = ServiceLifetime.Singleton)
+        where TKey : notnull
+        where TRecord : notnull
+    {
+        Verify.NotNull(services);
+        Verify.NotNullOrWhiteSpace(collectionName);
+        Verify.NotNullOrWhiteSpace(connectionString);
+
+        services.Add(new ServiceDescriptor(typeof(SqlServerVectorStoreRecordCollection<TKey, TRecord>),
+            sp => new SqlServerVectorStoreRecordCollection<TKey, TRecord>(connectionString, collectionName, options), lifetime));
+
+        services.TryAdd(new ServiceDescriptor(typeof(IVectorStoreRecordCollection<TKey, TRecord>),
+            static sp => sp.GetRequiredService<SqlServerVectorStoreRecordCollection<TKey, TRecord>>(), lifetime));
+
+        return services;
+    }
+
+    /// <summary>
+    /// Registers a keyed <see cref="SqlServerVectorStoreRecordCollection{TKey, TRecord}"/> as <see cref="IVectorStoreRecordCollection{TKey, TRecord}"/>, with the specified connection string and service lifetime.
+    /// </summary>
+    /// <param name="services">The <see cref="IServiceCollection"/> to register the <see cref="IVectorStoreRecordCollection{TKey, TRecord}"/> on.</param>
+    /// <param name="serviceKey">The key with which to associate the collection.</param>
+    /// <param name="collectionName">The name of the collection.</param>
+    /// <param name="connectionString">The connection string.</param>
+    /// <param name="options">Options to further configure the collection.</param>
+    /// <param name="lifetime">The service lifetime for the store. Defaults to <see cref="ServiceLifetime.Singleton"/>.</param>
+    /// <returns>The service collection.</returns>
+    public static IServiceCollection AddKeyedSqlServerVectorStoreCollection<TKey, TRecord>(this IServiceCollection services,
+        object serviceKey,
+        string collectionName,
+        string connectionString,
+        SqlServerVectorStoreRecordCollectionOptions<TRecord>? options = null,
+        ServiceLifetime lifetime = ServiceLifetime.Singleton)
+        where TKey : notnull
+        where TRecord : notnull
+    {
+        Verify.NotNull(services);
+        Verify.NotNull(serviceKey);
+        Verify.NotNullOrWhiteSpace(collectionName);
+        Verify.NotNullOrWhiteSpace(connectionString);
+
+        services.Add(new ServiceDescriptor(typeof(SqlServerVectorStoreRecordCollection<TKey, TRecord>), serviceKey,
+            (sp, _) => new SqlServerVectorStoreRecordCollection<TKey, TRecord>(connectionString, collectionName, options), lifetime));
+
+        services.TryAdd(new ServiceDescriptor(typeof(IVectorStoreRecordCollection<TKey, TRecord>), serviceKey,
+            static (sp, key) => sp.GetRequiredKeyedService<SqlServerVectorStoreRecordCollection<TKey, TRecord>>(key), lifetime));
+
+        return services;
+    }
+}

dotnet/src/VectorDataIntegrationTests/SqlServerIntegrationTests/DependencyInjection/SqlServerDependencyInjectionTests.cs

@@ -0,0 +1,122 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Hosting;
+using Microsoft.SemanticKernel.Connectors.SqlServer;
+using VectorDataSpecificationTests.DependencyInjection;
+using VectorDataSpecificationTests.Models;
+using Xunit;
+
+namespace SqlServerIntegrationTests.DependencyInjection;
+
+public class SqlServerDependencyInjectionTests
+    : DependencyInjectionTests<SqlServerVectorStore, SqlServerVectorStoreRecordCollection<string, SimpleRecord<string>>, string, SimpleRecord<string>>
+{
+    protected const string ConnectionString = "Server=localhost;Database=master;Integrated Security=True;";
+
+    protected override void PopulateConfiguration(ConfigurationManager configuration, object? serviceKey = null)
+        => configuration.AddInMemoryCollection(
+        [
+            new(CreateConfigKey("SqlServer", serviceKey, "ConnectionString"), ConnectionString),
+        ]);
+
+    protected override void RegisterVectorStore(IServiceCollection services, ServiceLifetime lifetime, object? serviceKey = null)
+    {
+        if (serviceKey is null)
+        {
+            services.AddSqlServerVectorStore(
+                sp => sp.GetRequiredService<IConfiguration>().GetRequiredSection("SqlServer:ConnectionString").Value!,
+                lifetime: lifetime);
+        }
+        else
+        {
+            services.AddKeyedSqlServerVectorStore(
+                serviceKey,
+                sp => sp.GetRequiredService<IConfiguration>().GetRequiredSection(CreateConfigKey("SqlServer", serviceKey, "ConnectionString")).Value!,
+                lifetime: lifetime);
+        }
+    }
+
+    protected override void RegisterCollection(IServiceCollection services, ServiceLifetime lifetime, string collectionName = "name", object? serviceKey = null)
+    {
+        if (serviceKey is null)
+        {
+            services.AddSqlServerVectorStoreCollection<string, SimpleRecord<string>>(
+                collectionName,
+                sp => sp.GetRequiredService<IConfiguration>().GetRequiredSection("SqlServer:ConnectionString").Value!,
+                lifetime: lifetime);
+        }
+        else
+        {
+            services.AddKeyedSqlServerVectorStoreCollection<string, SimpleRecord<string>>(
+                serviceKey,
+                collectionName,
+                sp => sp.GetRequiredService<IConfiguration>().GetRequiredSection(CreateConfigKey("SqlServer", serviceKey, "ConnectionString")).Value!,
+                lifetime: lifetime);
+        }
+    }
+
+    [Fact]
+    public void ConnectionStringProviderCantBeNull()
+    {
+        HostApplicationBuilder builder = this.CreateHostBuilder();
+
+        Assert.Throws<ArgumentNullException>(() => builder.Services.AddSqlServerVectorStore(connectionStringProvider: null!));
+        Assert.Throws<ArgumentNullException>(() => builder.Services.AddKeyedSqlServerVectorStore(serviceKey: "notNull", connectionStringProvider: null!));
+        Assert.Throws<ArgumentNullException>(() => builder.Services.AddSqlServerVectorStoreCollection<string, SimpleRecord<string>>(collectionName: "notNull", connectionStringProvider: null!));
+        Assert.Throws<ArgumentNullException>(() => builder.Services.AddKeyedSqlServerVectorStoreCollection<string, SimpleRecord<string>>(serviceKey: "notNull", collectionName: "notNull", connectionStringProvider: null!));
+    }
+
+    [Fact]
+    public void ConnectionStringCantBeNullOrEmpty()
+    {
+        HostApplicationBuilder builder = this.CreateHostBuilder();
+
+        Assert.Throws<ArgumentNullException>(() => builder.Services.AddSqlServerVectorStoreCollection<string, SimpleRecord<string>>(
+            collectionName: "notNull", connectionString: null!));
+        Assert.Throws<ArgumentException>(() => builder.Services.AddSqlServerVectorStoreCollection<string, SimpleRecord<string>>(
+            collectionName: "notNull", connectionString: ""));
+        Assert.Throws<ArgumentNullException>(() => builder.Services.AddKeyedSqlServerVectorStoreCollection<string, SimpleRecord<string>>(
+            serviceKey: "notNull", collectionName: "notNull", connectionString: null!));
+        Assert.Throws<ArgumentException>(() => builder.Services.AddKeyedSqlServerVectorStoreCollection<string, SimpleRecord<string>>(
+            serviceKey: "notNull", collectionName: "notNull", connectionString: ""));
+    }
+}
+
+public class SqlServerDependencyInjectionTests_ConnectionStrings : SqlServerDependencyInjectionTests
+{
+    protected override void PopulateConfiguration(ConfigurationManager configuration, object? serviceKey = null)
+    {
+        // do nothing, as in this scenario config should not be used at all
+    }
+
+    protected override void RegisterCollection(IServiceCollection services, ServiceLifetime lifetime, string collectionName = "name", object? serviceKey = null)
+    {
+        if (serviceKey is null)
+        {
+            services.AddSqlServerVectorStoreCollection<string, SimpleRecord<string>>(
+                collectionName,
+                connectionString: ConnectionString,
+                lifetime: lifetime);
+        }
+        else
+        {
+            services.AddKeyedSqlServerVectorStoreCollection<string, SimpleRecord<string>>(
+                serviceKey,
+                collectionName,
+                connectionString: ConnectionString,
+                lifetime: lifetime);
+        }
+    }
+
+    public override void CanRegisterVectorStore(ServiceLifetime lifetime, object? serviceKey)
+    {
+        // do nothing, we don't provide a test for this scenario with raw connection string
+    }
+
+    public override void CanRegisterConcreteTypeVectorStoreAfterSomeAbstractionHasBeenRegistered(ServiceLifetime lifetime, object? serviceKey)
+    {
+        // do nothing, we don't provide a test for this scenario with raw connection string
+    }
+}