Skip to content

fix: remove RuleQueryMatchCriteria hacks and prefer env vars over secrets #3462

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
Mpdreamz merged 1 commit into from
Jun 3, 2026
Merged

fix: remove RuleQueryMatchCriteria hacks and prefer env vars over secrets #3462

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions Directory.Packages.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@
<PackageVersion Include="FakeItEasy" Version="9.0.1" />
<PackageVersion Include="Elastic.Ingest.Elasticsearch" Version="0.41.2" />
<PackageVersion Include="Elastic.Mapping" Version="0.46.0" />
<PackageVersion Include="Elastic.Internal.Search.Contract" Version="0.9.0" />
<PackageVersion Include="Elastic.Internal.Search.Elasticsearch" Version="0.9.0" />
<PackageVersion Include="Elastic.Internal.Search.Contract" Version="0.9.2" />
<PackageVersion Include="Elastic.Internal.Search.Elasticsearch" Version="0.9.2" />
<PackageVersion Include="InMemoryLogger" Version="1.0.66" />
<PackageVersion Include="MartinCostello.Logging.XUnit.v3" Version="0.7.1" />
<PackageVersion Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="10.0.8" />
Expand Down
27 changes: 16 additions & 11 deletions src/Elastic.Documentation.ServiceDefaults/ElasticsearchEndpointFactory.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,14 @@

namespace Elastic.Documentation.ServiceDefaults;

/// <summary>Centralizes user-secrets + env-var reading for Elasticsearch configuration.</summary>
/// <summary>Centralizes env-var + user-secrets reading for Elasticsearch configuration.</summary>
public static class ElasticsearchEndpointFactory
{
private const string UserSecretsId = "72f50f33-6fb9-4d08-bff3-39568fe370b3";

/// <summary>
/// Creates <see cref="DocumentationEndpoints"/> from user secrets and environment variables.
/// Environment variables take priority over user secrets.
/// </summary>
public static DocumentationEndpoints Create(IConfiguration? appConfiguration = null, string? buildType = null, string? environment = null)
{
Expand All @@ -23,20 +24,20 @@ public static DocumentationEndpoints Create(IConfiguration? appConfiguration = n
var config = configBuilder.Build();

var url =
config["Parameters:DocumentationElasticUrl"]
?? config["DOCUMENTATION_ELASTIC_URL"];
config["DOCUMENTATION_ELASTIC_URL"]
?? config["Parameters:DocumentationElasticUrl"];

var apiKey =
config["Parameters:DocumentationElasticApiKey"]
?? config["DOCUMENTATION_ELASTIC_APIKEY"];
config["DOCUMENTATION_ELASTIC_APIKEY"]
?? config["Parameters:DocumentationElasticApiKey"];

var password =
config["Parameters:DocumentationElasticPassword"]
?? config["DOCUMENTATION_ELASTIC_PASSWORD"];
config["DOCUMENTATION_ELASTIC_PASSWORD"]
?? config["Parameters:DocumentationElasticPassword"];

var username =
config["Parameters:DocumentationElasticUsername"]
?? config["DOCUMENTATION_ELASTIC_USERNAME"]
config["DOCUMENTATION_ELASTIC_USERNAME"]
?? config["Parameters:DocumentationElasticUsername"]
?? "elastic";

if (string.IsNullOrEmpty(url))
Expand All @@ -59,8 +60,8 @@ public static DocumentationEndpoints Create(IConfiguration? appConfiguration = n
buildType ??= appConfiguration?["DOCS_BUILD_TYPE"] ?? config["DOCS_BUILD_TYPE"] ?? "isolated";

var searchIndexOverride =
config["Parameters:DocumentationElasticIndexOverride"]
?? config["DOCUMENTATION_ELASTIC_INDEX_OVERRIDE"];
config["DOCUMENTATION_ELASTIC_INDEX_OVERRIDE"]
?? config["Parameters:DocumentationElasticIndexOverride"];

return new DocumentationEndpoints
{
Expand All @@ -84,6 +85,10 @@ private static string ResolveEnvironment(IConfiguration config, IConfiguration?
?? config["DOTNET_ENVIRONMENT"]
?? config["ENVIRONMENT"];

string[] allowedEnvironements = ["dev", "prod", "staging"];
if (!allowedEnvironements.Contains(envVar))
envVar = "dev";

return !string.IsNullOrEmpty(envVar) ? envVar.ToLowerInvariant() : "dev";
}
}
3 changes: 2 additions & 1 deletion src/api/Elastic.Documentation.Mcp.Remote/appsettings.development.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
"Logging": {
"LogLevel": {
"Default": "Debug",
"Microsoft.AspNetCore": "Information"
"Microsoft.AspNetCore": "Information",
"OpenTelemetry": "Warning"
}
}
}
3 changes: 2 additions & 1 deletion src/api/Elastic.Documentation.Mcp.Remote/appsettings.edge.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
"Logging": {
"LogLevel": {
"Default": "Information",
"Microsoft.AspNetCore": "Warning"
"Microsoft.AspNetCore": "Warning",
"OpenTelemetry": "Warning"
}
}
}
3 changes: 2 additions & 1 deletion src/api/Elastic.Documentation.Mcp.Remote/appsettings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
"Logging": {
"LogLevel": {
"Default": "Information",
"Microsoft.AspNetCore": "Warning"
"Microsoft.AspNetCore": "Warning",
"OpenTelemetry": "Warning"
}
},
"AllowedHosts": "*"
Expand Down
5 changes: 3 additions & 2 deletions src/services/search/Elastic.Documentation.Search/Common/ElasticsearchClientAccessor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,9 @@ SearchConfiguration searchConfiguration
_nodePool,
sourceSerializer: (_, settings) => new DefaultSourceSerializer(
settings,
ElasticsearchClientJsonResolver.Default,
static jsonOptions => jsonOptions.Converters.Add(RuleQueryMatchCriteriaJsonConverterFactory.Instance)))
ElasticsearchClientJsonResolver.Default
)
)
.DefaultIndex(SearchIndex)
.Authentication(auth);

Expand Down
12 changes: 5 additions & 7 deletions src/services/search/Elastic.Documentation.Search/Common/ElasticsearchClientJsonResolver.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,10 @@ internal static class ElasticsearchClientJsonResolver
{
public static IJsonTypeInfoResolver Default { get; } = Create();

private static IJsonTypeInfoResolver Create()
{
var combined = JsonTypeInfoResolver.Combine(
private static IJsonTypeInfoResolver Create() =>
JsonTypeInfoResolver.Combine(
InternalSearch.SourceGenerationContext.Default,
SourceGenerationContext.Default);

return new RuleQueryMatchCriteriaTypeInfoResolver(combined);
}
InternalSearch.Elasticsearch.SourceGenerationContext.Default,
SourceGenerationContext.Default
);
}
76 changes: 0 additions & 76 deletions ...ervices/search/Elastic.Documentation.Search/Common/RuleQueryMatchCriteriaJsonConverter.cs
View file
Open in desktop

This file was deleted.

46 changes: 0 additions & 46 deletions ...ices/search/Elastic.Documentation.Search/Common/RuleQueryMatchCriteriaTypeInfoResolver.cs
View file
Open in desktop

This file was deleted.

6 changes: 2 additions & 4 deletions tests-integration/Mcp.Remote.IntegrationTests/McpToolsIntegrationTestsBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,7 @@ protected async Task LogIndexCount(ElasticsearchClientAccessor clientAccessor, C
return (coherenceTools, clientAccessor);
}

private static FullSearchService BuildFullSearchAdapter(
ElasticsearchClientAccessor clientAccessor,
Elastic.Documentation.Configuration.Products.ProductsConfiguration productsConfig)
private static FullSearchService BuildFullSearchAdapter(ElasticsearchClientAccessor clientAccessor, ProductsConfiguration productsConfig)
{
var sharedConfig = new Elastic.Internal.Search.Configuration.SearchConfiguration
{
Expand All @@ -101,7 +99,7 @@ private static FullSearchService BuildFullSearchAdapter(
/// </summary>
private static ElasticsearchClientAccessor CreateElasticsearchClientAccessor()
{
var endpoints = ElasticsearchEndpointFactory.Create(buildType: "assembler", environment: "dev");
var endpoints = ElasticsearchEndpointFactory.Create(buildType: "assembler");

var searchConfig = new SearchConfiguration
{
Expand Down
2 changes: 1 addition & 1 deletion tests-integration/Search.IntegrationTests/SearchRelevanceTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ public async Task ExplainTopResultAndExpectedAsyncReturnsDetailedScoring()
/// </summary>
private static (NavigationSearchService Gateway, ElasticsearchClientAccessor ClientAccessor) CreateFindPageGateway()
{
var endpoints = ElasticsearchEndpointFactory.Create(buildType: "assembler", environment: "dev");
var endpoints = ElasticsearchEndpointFactory.Create(buildType: "assembler");
var configProvider = new ConfigurationFileProvider(NullLoggerFactory.Instance, new FileSystem(), configurationSource: ConfigurationSource.Embedded);
var searchConfig = configProvider.CreateSearchConfiguration();

Expand Down
Loading