Skip to content

Cosmos DB: Add UserAgentSuffix #763

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ealsur merged 4 commits into from
Feb 8, 2022
Merged

Cosmos DB: Add UserAgentSuffix #763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a4c5c24
Adding options
ealsur Feb 1, 2022
d38acc4
Wiring through provider
ealsur Feb 1, 2022
5cf2d1d
tests
ealsur Feb 1, 2022
dc31d34
only allocate if there is a config
ealsur Feb 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/WebJobs.Extensions.CosmosDB/Config/CosmosDBExtensionConfigProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,11 @@ internal Task<IValueBinder> BindForItemAsync(CosmosDBAttribute attribute, Type t
internal CosmosClient GetService(string connection, string preferredLocations = "", string userAgent = "")
{
string cacheKey = BuildCacheKey(connection, preferredLocations);
if (!string.IsNullOrEmpty(_options.UserAgentSuffix))
{
userAgent += _options.UserAgentSuffix;
}

CosmosClientOptions cosmosClientOptions = CosmosDBUtility.BuildClientOptions(_options.ConnectionMode, _cosmosSerializerFactory.CreateSerializer(), preferredLocations, userAgent);
return ClientCache.GetOrAdd(cacheKey, (c) => _cosmosDBServiceFactory.CreateService(connection, cosmosClientOptions));
}
Expand Down
11 changes: 11 additions & 0 deletions src/WebJobs.Extensions.CosmosDB/Config/CosmosDBOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@ public class CosmosDBOptions : IOptionsFormatter
/// <remarks>Default is Gateway mode.</remarks>
public ConnectionMode? ConnectionMode { get; set; }

/// <summary>
/// Gets or sets a string to be included in the User Agent for all operations by Cosmos DB bindings and triggers.
/// </summary>
public string UserAgentSuffix { get; set; }

public string Format()
{
StringWriter sw = new StringWriter();
Expand All @@ -26,6 +31,12 @@ public string Format()
writer.WritePropertyName(nameof(this.ConnectionMode));
writer.WriteValue(this.ConnectionMode);

if (!string.IsNullOrEmpty(UserAgentSuffix))
{
writer.WritePropertyName(nameof(this.UserAgentSuffix));
writer.WriteValue(this.UserAgentSuffix);
}

writer.WriteEndObject();
}

Expand Down
95 changes: 92 additions & 3 deletions test/WebJobs.Extensions.CosmosDB.Tests/CosmosDBHostBuilderExtensionsTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,33 @@ namespace Microsoft.Azure.WebJobs.Extensions.CosmosDB.Tests
{
public class CosmosDBHostBuilderExtensionsTests
{
[Fact]
public void ConfigurationBindsToDefaults()
{
IHost host = new HostBuilder()
.ConfigureAppConfiguration(c =>
{
c.Sources.Clear();

var source = new MemoryConfigurationSource
{
InitialData = new Dictionary<string, string>()
};

c.Add(source);
})
.ConfigureWebJobs(builder =>
{
builder.AddCosmosDB();
})
.Build();

var options = host.Services.GetService<IOptions<CosmosDBOptions>>().Value;

Assert.Null(options.ConnectionMode);
Assert.Null(options.UserAgentSuffix);
}

[Fact]
public void ConfigurationBindsToOptions()
{
Expand All @@ -33,7 +60,8 @@ public void ConfigurationBindsToOptions()
{
InitialData = new Dictionary<string, string>
{
{ "AzureWebJobs:extensions:cosmosDB:ConnectionMode", "Direct" }
{ "AzureWebJobs:extensions:cosmosDB:ConnectionMode", "Direct" },
{ "AzureWebJobs:extensions:cosmosDB:UserAgentSuffix", "randomtext" }
}
};

Expand All @@ -48,6 +76,7 @@ public void ConfigurationBindsToOptions()
var options = host.Services.GetService<IOptions<CosmosDBOptions>>().Value;

Assert.Equal(ConnectionMode.Direct, options.ConnectionMode);
Assert.Equal("randomtext", options.UserAgentSuffix);
}

[Fact]
Expand All @@ -61,13 +90,18 @@ public void ConfigurationBindsToOptions_WithConfigureServices()
.ConfigureServices(s =>
{
// Verifies that you can modify the bound options
s.Configure<CosmosDBOptions>(o => o.ConnectionMode = ConnectionMode.Direct);
s.Configure<CosmosDBOptions>(o =>
{
o.ConnectionMode = ConnectionMode.Direct;
o.UserAgentSuffix = "randomtext";
});
})
.Build();

var options = host.Services.GetService<IOptions<CosmosDBOptions>>().Value;

Assert.Equal(ConnectionMode.Direct, options.ConnectionMode);
Assert.Equal("randomtext", options.UserAgentSuffix);
}

[Fact]
Expand Down Expand Up @@ -113,7 +147,7 @@ public void ConfigurationBindsToOptions_WithSerializer_Before()
c.Sources.Clear();
c.AddInMemoryCollection(new Dictionary<string, string>
{
{ Constants.DefaultConnectionStringName, "AccountEndpoint=https://defaultUri;AccountKey=c29tZV9rZXk=;" }
{ Constants.DefaultConnectionStringName, "AccountEndpoint=https://defaultUri;AccountKey=c29tZV9rZXk=;" }
});
})
.ConfigureServices(s =>
Expand All @@ -136,6 +170,61 @@ public void ConfigurationBindsToOptions_WithSerializer_Before()
Assert.True(customFactory.CreateWasCalled);
}

[Fact]
public void ConfigurationGetService_WithUserAgentOverride()
{
IHost host = new HostBuilder()
.ConfigureAppConfiguration(c =>
{
c.Sources.Clear();
c.AddInMemoryCollection(new Dictionary<string, string>
{
{ Constants.DefaultConnectionStringName, "AccountEndpoint=https://defaultUri;AccountKey=c29tZV9rZXk=;" },
{ "AzureWebJobs:extensions:cosmosDB:UserAgentSuffix", "randomtext" }
});
})
.ConfigureWebJobs(builder =>
{
builder.AddCosmosDB();
})
.Build();

var extensionConfig = host.Services.GetServices<IExtensionConfigProvider>().Single();
Assert.NotNull(extensionConfig);
Assert.IsType<CosmosDBExtensionConfigProvider>(extensionConfig);

CosmosDBExtensionConfigProvider cosmosDBExtensionConfigProvider = (CosmosDBExtensionConfigProvider)extensionConfig;
CosmosClient dummyClient = cosmosDBExtensionConfigProvider.GetService(Constants.DefaultConnectionStringName, userAgent: "knownSuffix");
Assert.Equal(dummyClient.ClientOptions.ApplicationName, "knownSuffix" + "randomtext");
}

[Fact]
public void ConfigurationGetService_WithoutUserAgentOverride()
{
IHost host = new HostBuilder()
.ConfigureAppConfiguration(c =>
{
c.Sources.Clear();
c.AddInMemoryCollection(new Dictionary<string, string>
{
{ Constants.DefaultConnectionStringName, "AccountEndpoint=https://defaultUri;AccountKey=c29tZV9rZXk=;" }
});
})
.ConfigureWebJobs(builder =>
{
builder.AddCosmosDB();
})
.Build();

var extensionConfig = host.Services.GetServices<IExtensionConfigProvider>().Single();
Assert.NotNull(extensionConfig);
Assert.IsType<CosmosDBExtensionConfigProvider>(extensionConfig);

CosmosDBExtensionConfigProvider cosmosDBExtensionConfigProvider = (CosmosDBExtensionConfigProvider)extensionConfig;
CosmosClient dummyClient = cosmosDBExtensionConfigProvider.GetService(Constants.DefaultConnectionStringName, userAgent: "knownSuffix");
Assert.Equal(dummyClient.ClientOptions.ApplicationName, "knownSuffix");
}

private class CustomFactory : ICosmosDBSerializerFactory
{
public bool CreateWasCalled { get; private set; } = false;
Expand Down
29 changes: 29 additions & 0 deletions ...WebJobs.Extensions.CosmosDB.Tests/Trigger/CosmosDBTriggerAttributeBindingProviderTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,35 @@ public async Task ValidParametersWithEnvironment_ConnectionMode_Succeed(Paramete
Assert.Equal(new Uri("https://fromEnvironment"), binding.MonitoredContainer.Database.Client.Endpoint);
Assert.Equal(new Uri("https://fromEnvironment"), binding.LeaseContainer.Database.Client.Endpoint);
Assert.Equal(ConnectionMode.Direct, binding.LeaseContainer.Database.Client.ClientOptions.ConnectionMode);
Assert.Equal(ConnectionMode.Direct, binding.MonitoredContainer.Database.Client.ClientOptions.ConnectionMode);
Assert.Equal("CosmosDBTriggerFunctions", binding.LeaseContainer.Database.Client.ClientOptions.ApplicationName);
Assert.Equal("CosmosDBTriggerFunctions", binding.MonitoredContainer.Database.Client.ClientOptions.ApplicationName);
}

[Theory]
[MemberData(nameof(ValidCosmosDBTriggerBindingsWithEnvironmentParameters))]
public async Task ValidParametersWithEnvironment_UserAgent_Succeed(ParameterInfo parameter)
{
var nameResolver = new TestNameResolver();
var config = new ConfigurationBuilder()
.AddInMemoryCollection(new Dictionary<string, string>
{
{ "ConnectionStrings:CosmosDB", "AccountEndpoint=https://fromEnvironment;AccountKey=c29tZV9rZXk=;" },
{ "ConnectionStrings:CosmosDBConnectionString", "AccountEndpoint=https://fromSettings;AccountKey=c29tZV9rZXk=;" }
})
.Build();

_options.UserAgentSuffix = "randomtext";

CosmosDBTriggerAttributeBindingProvider<dynamic> provider = new CosmosDBTriggerAttributeBindingProvider<dynamic>(nameResolver, _options, CreateExtensionConfigProvider(_options, config), _loggerFactory);

CosmosDBTriggerBinding<dynamic> binding = (CosmosDBTriggerBinding<dynamic>)await provider.TryCreateAsync(new TriggerBindingProviderContext(parameter, CancellationToken.None));

Assert.Equal(typeof(IReadOnlyCollection<dynamic>), binding.TriggerValueType);
Assert.Equal(new Uri("https://fromEnvironment"), binding.MonitoredContainer.Database.Client.Endpoint);
Assert.Equal(new Uri("https://fromEnvironment"), binding.LeaseContainer.Database.Client.Endpoint);
Assert.Equal("CosmosDBTriggerFunctionsrandomtext", binding.LeaseContainer.Database.Client.ClientOptions.ApplicationName);
Assert.Equal("CosmosDBTriggerFunctionsrandomtext", binding.MonitoredContainer.Database.Client.ClientOptions.ApplicationName);
}

[Theory]
Expand Down