Skip to content
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.

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

Personal/rajitha/continuation token limit #2971

Merged
merged 7 commits into from
Nov 28, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions src/Microsoft.Health.Fhir.CosmosDb/Constants.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,8 @@ internal static class Constants
{
public const string CollectionConfigurationName = "fhirCosmosDb";
public const string CosmosDbResponseMessagesProperty = nameof(CosmosDbResponseMessagesProperty);
public const int ContinuationTokenMinLimit = 1;
public const int ContinuationTokenMaxLimit = 3;
public const int ContinuationTokenDefaultLimit = 3;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,7 @@ public static class CosmosDbHeaders
public const string RequestCharge = "x-ms-request-charge";

public const string SubStatus = "x-ms-substatus";

public const string CosmosContinuationTokenSize = "x-ms-documentdb-responsecontinuationtokenlimitinkb";
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,25 @@ public override async Task<ResponseMessage> SendAsync(RequestMessage request, Ca

private void UpdateOptions(RequestMessage options)
{
if (_cosmosDataStoreConfiguration.ContinuationTokenSizeLimitInKb != null)
IFhirRequestContext fhirRequestContext = _fhirRequestContextAccessor.RequestContext;
if (fhirRequestContext == null)
{
return;
}

if (fhirRequestContext.RequestHeaders.TryGetValue(CosmosDbHeaders.CosmosContinuationTokenSize, out var tokenSize))
{
var intTokenSize = int.TryParse(tokenSize, out var count) ? count : 0;
if (intTokenSize != 0 && intTokenSize >= Constants.ContinuationTokenMinLimit && intTokenSize <= Constants.ContinuationTokenMaxLimit)
{
options.Headers[_continuationTokenLimitHeaderName] = intTokenSize.ToString();
}
else
{
throw new BadRequestException(string.Format(Resources.InvalidCosmosContinuationTokenSize, tokenSize));
}
}
else if (_cosmosDataStoreConfiguration.ContinuationTokenSizeLimitInKb != null)
{
options.Headers[_continuationTokenLimitHeaderName] = _cosmosDataStoreConfiguration.ContinuationTokenSizeLimitInKb.ToString();
}
Expand Down
11 changes: 10 additions & 1 deletion src/Microsoft.Health.Fhir.CosmosDb/Resources.Designer.cs

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions src/Microsoft.Health.Fhir.CosmosDb/Resources.resx
Original file line number Diff line number Diff line change
Expand Up @@ -165,4 +165,7 @@
<data name="ChainedExpressionSubqueryLimit" xml:space="preserve">
<value>Sub-queries in a chained expression cannot return more than {0} results, please use a more selective criteria.</value>
</data>
<data name="InvalidCosmosContinuationTokenSize" xml:space="preserve">
<value>ContinuationTokenSize '{0}'Kb specified in the request is invalid. Valid limits are between 1 - 3 Kb.</value>
</data>
</root>
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
using System.Net.Http;
using System.Threading.Tasks;
using Microsoft.Health.Fhir.Core.Features;
using Microsoft.Health.Fhir.CosmosDb.Features.Storage;
using Microsoft.Health.Fhir.Tests.Common;
using Microsoft.Health.Fhir.Tests.Common.FixtureParameters;
using Microsoft.Health.Fhir.Tests.E2E.Common;
Expand Down Expand Up @@ -56,5 +57,38 @@ public async Task GivenNoRequestHeader_WhenSendRequest_TheServerShouldntReturnCo
Assert.NotEmpty(response.Headers.GetValues(KnownHeaders.RequestId));
Assert.False(response.Headers.Contains(KnownHeaders.CorrelationId));
}

[Theory]
[InlineData("1")]
[InlineData("2")]
[InlineData("3")]
[Trait(Traits.Priority, Priority.One)]
[HttpIntegrationFixtureArgumentSets(DataStore.CosmosDb)]
public async Task GivenValidContinuationTokenLimitHeader_WhenSendRequest_TheServerShouldReturnSuccess(string tokenSize)
{
var message = new HttpRequestMessage(HttpMethod.Get, "Patient");
message.Headers.Add(CosmosDbHeaders.CosmosContinuationTokenSize, tokenSize);

using HttpResponseMessage response = await _client.HttpClient.SendAsync(message);

Assert.Equal(HttpStatusCode.OK, response.StatusCode);
}

[Theory]
[InlineData("invalid")]
[InlineData("5")]
[InlineData("-1")]
[InlineData("9999999999999999999999999999")]
[InlineData("1.0")]
[Trait(Traits.Priority, Priority.One)]
[HttpIntegrationFixtureArgumentSets(DataStore.CosmosDb)]
public async Task GivenInValidContinuationTokenLimitHeader_WhenSendRequest_ThenBadRequestShouldBeReturned(string tokenSize)
{
var message = new HttpRequestMessage(HttpMethod.Get, "Patient");
message.Headers.Add(CosmosDbHeaders.CosmosContinuationTokenSize, tokenSize);

using HttpResponseMessage response = await _client.HttpClient.SendAsync(message);
Assert.Equal(HttpStatusCode.BadRequest, response.StatusCode);
}
}
}