Skip to content

[Storage] PageBlobClient request condition validation #21976

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
seanmcc-msft merged 10 commits into from
Jun 22, 2021
Merged

[Storage] PageBlobClient request condition validation #21976

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
c15f3b4
Added RequestConditions validation to PageBlobClient
seanmcc-msft Jun 18, 2021
363ebef
GetPageRangesDiff
seanmcc-msft Jun 18, 2021
c49a954
GetPageRanges
seanmcc-msft Jun 18, 2021
6b33990
Resize
seanmcc-msft Jun 18, 2021
69f6561
StartCopyIncremental
seanmcc-msft Jun 18, 2021
bb742d7
UpdateSequenceNumber
seanmcc-msft Jun 18, 2021
08f3baa
UploadPagesFromUri
seanmcc-msft Jun 18, 2021
4441514
Hopefully fixed CI
seanmcc-msft Jun 18, 2021
850d300
Merge branch 'main' into feature/storage/pageBlobRequestValidation
seanmcc-msft Jun 18, 2021
632d02d
Merge branch 'main' into feature/storage/pageBlobRequestValidation
seanmcc-msft Jun 22, 2021
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
37 changes: 37 additions & 0 deletions sdk/storage/Azure.Storage.Blobs/src/BlobExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1475,6 +1475,43 @@ internal static void ValidateConditionsNotPresent(this AppendBlobRequestConditio
throw new ArgumentException($"{nameof(AppendBlobRequestConditions.IfMaxSizeLessThanOrEqual)} is not applicable to this API.");
}
}

internal static void ValidateConditionsNotPresent(this PageBlobRequestConditions requestConditions, BlobRequestConditionProperty invalidConditions)
{
if (AppContextSwitchHelper.GetConfigValue(
Constants.DisableRequestConditionsValidationSwitchName,
Constants.DisableRequestConditionsValidationEnvVar))
{
return;
}

if (requestConditions == null)
{
return;
}

// Validate BlobRequestConditions
((BlobRequestConditions)requestConditions).ValidateConditionsNotPresent(invalidConditions);

// Validate PageBlobRequestConditions specific conditions.
if ((invalidConditions & BlobRequestConditionProperty.IfSequenceNumberLessThan) == BlobRequestConditionProperty.IfSequenceNumberLessThan
&& requestConditions.IfSequenceNumberLessThan != null)
{
throw new ArgumentException($"{nameof(PageBlobRequestConditions.IfSequenceNumberLessThan)} is not applicable to this API.");
}

if ((invalidConditions & BlobRequestConditionProperty.IfSequenceNumberLessThanOrEqual) == BlobRequestConditionProperty.IfSequenceNumberLessThanOrEqual
&& requestConditions.IfSequenceNumberLessThanOrEqual != null)
{
throw new ArgumentException($"{nameof(PageBlobRequestConditions.IfSequenceNumberLessThanOrEqual)} is not applicable to this API.");
}

if ((invalidConditions & BlobRequestConditionProperty.IfSequenceNumberEqual) == BlobRequestConditionProperty.IfSequenceNumberEqual
&& requestConditions.IfSequenceNumberEqual != null)
{
throw new ArgumentException($"{nameof(PageBlobRequestConditions.IfSequenceNumberEqual)} is not applicable to this API.");
}
}
#endregion
}
}
5 changes: 4 additions & 1 deletion sdk/storage/Azure.Storage.Blobs/src/Models/Internal/BlobRequestConditionProperty.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ internal enum BlobRequestConditionProperty
IfMatch = 16,
IfNoneMatch = 32,
IfAppendPositionEqual = 64,
IfMaxSizeLessThanOrEqual = 128
IfMaxSizeLessThanOrEqual = 128,
IfSequenceNumberLessThan = 256,
IfSequenceNumberLessThanOrEqual = 512,
IfSequenceNumberEqual = 1024
}
}
47 changes: 47 additions & 0 deletions sdk/storage/Azure.Storage.Blobs/src/PageBlobClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -969,6 +969,11 @@ private async Task<Response<BlobContentInfo>> CreateInternal(
operationName ??= $"{nameof(PageBlobClient)}.{nameof(Create)}";
DiagnosticScope scope = ClientConfiguration.ClientDiagnostics.CreateScope(operationName);

conditions.ValidateConditionsNotPresent(
BlobRequestConditionProperty.IfSequenceNumberLessThanOrEqual
| BlobRequestConditionProperty.IfSequenceNumberLessThan
| BlobRequestConditionProperty.IfSequenceNumberEqual);

try
{
scope.Start();
Expand Down Expand Up @@ -1251,6 +1256,9 @@ internal async Task<Response<PageInfo>> UploadPagesInternal(

DiagnosticScope scope = ClientConfiguration.ClientDiagnostics.CreateScope($"{nameof(PageBlobClient)}.{nameof(UploadPages)}");

// All PageBlobRequestConditions are valid.
conditions.ValidateConditionsNotPresent(BlobRequestConditionProperty.None);

try
{
scope.Start();
Expand Down Expand Up @@ -1466,6 +1474,9 @@ private async Task<Response<PageInfo>> ClearPagesInternal(

DiagnosticScope scope = ClientConfiguration.ClientDiagnostics.CreateScope($"{nameof(PageBlobClient)}.{nameof(ClearPages)}");

// All PageBlobRequestConditions are valid.
conditions.ValidateConditionsNotPresent(BlobRequestConditionProperty.None);

try
{
scope.Start();
Expand Down Expand Up @@ -1680,6 +1691,11 @@ private async Task<Response<PageRangesInfo>> GetPageRangesInternal(

DiagnosticScope scope = ClientConfiguration.ClientDiagnostics.CreateScope($"{nameof(PageBlobClient)}.{nameof(GetPageRanges)}");

conditions.ValidateConditionsNotPresent(
BlobRequestConditionProperty.IfSequenceNumberLessThanOrEqual
| BlobRequestConditionProperty.IfSequenceNumberLessThan
| BlobRequestConditionProperty.IfSequenceNumberEqual);

try
{
scope.Start();
Expand Down Expand Up @@ -1937,6 +1953,11 @@ private async Task<Response<PageRangesInfo>> GetPageRangesDiffInternal(
operationName ??= $"{nameof(PageBlobClient)}.{nameof(GetPageRangesDiff)}";
DiagnosticScope scope = ClientConfiguration.ClientDiagnostics.CreateScope(operationName);

conditions.ValidateConditionsNotPresent(
BlobRequestConditionProperty.IfSequenceNumberLessThanOrEqual
| BlobRequestConditionProperty.IfSequenceNumberLessThan
| BlobRequestConditionProperty.IfSequenceNumberEqual);

try
{
scope.Start();
Expand Down Expand Up @@ -2262,6 +2283,11 @@ private async Task<Response<PageBlobInfo>> ResizeInternal(

DiagnosticScope scope = ClientConfiguration.ClientDiagnostics.CreateScope($"{nameof(PageBlobClient)}.{nameof(Resize)}");

conditions.ValidateConditionsNotPresent(
BlobRequestConditionProperty.IfSequenceNumberLessThanOrEqual
| BlobRequestConditionProperty.IfSequenceNumberLessThan
| BlobRequestConditionProperty.IfSequenceNumberEqual);

try
{
scope.Start();
Expand Down Expand Up @@ -2505,6 +2531,11 @@ private async Task<Response<PageBlobInfo>> UpdateSequenceNumberInternal(

DiagnosticScope scope = ClientConfiguration.ClientDiagnostics.CreateScope($"{nameof(PageBlobClient)}.{nameof(UpdateSequenceNumber)}");

conditions.ValidateConditionsNotPresent(
BlobRequestConditionProperty.IfSequenceNumberLessThanOrEqual
| BlobRequestConditionProperty.IfSequenceNumberLessThan
| BlobRequestConditionProperty.IfSequenceNumberEqual);

try
{
scope.Start();
Expand Down Expand Up @@ -2888,6 +2919,12 @@ private async Task<Response<BlobCopyInfo>> StartCopyIncrementalInternal(

DiagnosticScope scope = ClientConfiguration.ClientDiagnostics.CreateScope($"{nameof(PageBlobClient)}.{nameof(StartCopyIncremental)}");

conditions.ValidateConditionsNotPresent(
BlobRequestConditionProperty.LeaseId
| BlobRequestConditionProperty.IfSequenceNumberLessThanOrEqual
| BlobRequestConditionProperty.IfSequenceNumberLessThan
| BlobRequestConditionProperty.IfSequenceNumberEqual);

try
{
scope.Start();
Expand Down Expand Up @@ -3308,6 +3345,16 @@ private async Task<Response<PageInfo>> UploadPagesFromUriInternal(

DiagnosticScope scope = ClientConfiguration.ClientDiagnostics.CreateScope($"{nameof(PageBlobClient)}.{nameof(UploadPagesFromUri)}");

// All destination PageBlobRequestConditions are valid.
conditions.ValidateConditionsNotPresent(BlobRequestConditionProperty.None);

sourceConditions.ValidateConditionsNotPresent(
BlobRequestConditionProperty.LeaseId
| BlobRequestConditionProperty.IfSequenceNumberLessThanOrEqual
| BlobRequestConditionProperty.IfSequenceNumberLessThan
| BlobRequestConditionProperty.IfSequenceNumberEqual
| BlobRequestConditionProperty.TagConditions);

try
{
scope.Start();
Expand Down
Loading