|
| 1 | +// Copyright (c) Microsoft Corporation. |
| 2 | +// Licensed under the MIT License. |
| 3 | + |
| 4 | +using System.Diagnostics.CodeAnalysis; |
| 5 | +using System.Net; |
| 6 | +using System.Text.Json.Serialization; |
| 7 | +using Azure.DataApiBuilder.Service.Exceptions; |
| 8 | + |
| 9 | +namespace Azure.DataApiBuilder.Config.ObjectModel; |
| 10 | + |
| 11 | +/// <summary> |
| 12 | +/// Pagination options for the dab setup. |
| 13 | +/// Properties are nullable to support DAB CLI merge config |
| 14 | +/// expected behavior. |
| 15 | +/// </summary> |
| 16 | +public record PaginationOptions |
| 17 | +{ |
| 18 | + /// <summary> |
| 19 | + /// Default page size. |
| 20 | + /// </summary> |
| 21 | + public const uint DEFAULT_PAGE_SIZE = 100; |
| 22 | + |
| 23 | + /// <summary> |
| 24 | + /// Max page size. |
| 25 | + /// </summary> |
| 26 | + public const uint MAX_PAGE_SIZE = 100000; |
| 27 | + |
| 28 | + /// <summary> |
| 29 | + /// The default page size for pagination. |
| 30 | + /// </summary> |
| 31 | + [JsonPropertyName("default-page-size")] |
| 32 | + public int? DefaultPageSize { get; init; } = null; |
| 33 | + |
| 34 | + /// <summary> |
| 35 | + /// The max page size for pagination. |
| 36 | + /// </summary> |
| 37 | + [JsonPropertyName("max-page-size")] |
| 38 | + public int? MaxPageSize { get; init; } = null; |
| 39 | + |
| 40 | + [JsonConstructor] |
| 41 | + public PaginationOptions(int? DefaultPageSize = null, int? MaxPageSize = null) |
| 42 | + { |
| 43 | + if (MaxPageSize is not null) |
| 44 | + { |
| 45 | + ValidatePageSize((int)MaxPageSize); |
| 46 | + this.MaxPageSize = MaxPageSize == -1 ? Int32.MaxValue : (int)MaxPageSize; |
| 47 | + UserProvidedMaxPageSize = true; |
| 48 | + } |
| 49 | + else |
| 50 | + { |
| 51 | + this.MaxPageSize = (int)MAX_PAGE_SIZE; |
| 52 | + } |
| 53 | + |
| 54 | + if (DefaultPageSize is not null) |
| 55 | + { |
| 56 | + ValidatePageSize((int)DefaultPageSize); |
| 57 | + this.DefaultPageSize = DefaultPageSize == -1 ? (int)this.MaxPageSize : (int)DefaultPageSize; |
| 58 | + UserProvidedDefaultPageSize = true; |
| 59 | + } |
| 60 | + else |
| 61 | + { |
| 62 | + this.DefaultPageSize = (int)DEFAULT_PAGE_SIZE; |
| 63 | + } |
| 64 | + |
| 65 | + if (this.DefaultPageSize > this.MaxPageSize) |
| 66 | + { |
| 67 | + throw new DataApiBuilderException( |
| 68 | + message: "Pagination options invalid. The default page size cannot be greater than max page size", |
| 69 | + statusCode: HttpStatusCode.ServiceUnavailable, |
| 70 | + subStatusCode: DataApiBuilderException.SubStatusCodes.ConfigValidationError); |
| 71 | + } |
| 72 | + } |
| 73 | + |
| 74 | + /// <summary> |
| 75 | + /// Flag which informs CLI and JSON serializer whether to write default page size. |
| 76 | + /// property and value to the runtime config file. |
| 77 | + /// When user doesn't provide the default-page-size property/value, which signals DAB to use the default, |
| 78 | + /// the DAB CLI should not write the default value to a serialized config. |
| 79 | + /// This is because the user's intent is to use DAB's default value which could change |
| 80 | + /// and DAB CLI writing the property and value would lose the user's intent. |
| 81 | + /// This is because if the user were to use the CLI created config, a default-page-size |
| 82 | + /// property/value specified would be interpreted by DAB as "user explicitly default-page-size." |
| 83 | + /// </summary> |
| 84 | + [JsonIgnore(Condition = JsonIgnoreCondition.Always)] |
| 85 | + [MemberNotNullWhen(true, nameof(DefaultPageSize))] |
| 86 | + public bool UserProvidedDefaultPageSize { get; init; } = false; |
| 87 | + |
| 88 | + /// <summary> |
| 89 | + /// Flag which informs CLI and JSON serializer whether to write max-page-size |
| 90 | + /// property and value to the runtime config file. |
| 91 | + /// When user doesn't provide the max-page-size property/value, which signals DAB to use the default, |
| 92 | + /// the DAB CLI should not write the default value to a serialized config. |
| 93 | + /// This is because the user's intent is to use DAB's default value which could change |
| 94 | + /// and DAB CLI writing the property and value would lose the user's intent. |
| 95 | + /// This is because if the user were to use the CLI created config, a max-page-size |
| 96 | + /// property/value specified would be interpreted by DAB as "user explicitly max-page-size." |
| 97 | + /// </summary> |
| 98 | + [JsonIgnore(Condition = JsonIgnoreCondition.Always)] |
| 99 | + [MemberNotNullWhen(true, nameof(MaxPageSize))] |
| 100 | + public bool UserProvidedMaxPageSize { get; init; } = false; |
| 101 | + |
| 102 | + private static void ValidatePageSize(int pageSize) |
| 103 | + { |
| 104 | + if (pageSize < -1 || pageSize == 0 || pageSize > Int32.MaxValue) |
| 105 | + { |
| 106 | + throw new DataApiBuilderException( |
| 107 | + message: "Pagination options invalid. Page size arguments cannot be 0, exceed max int value or be less than -1", |
| 108 | + statusCode: HttpStatusCode.ServiceUnavailable, |
| 109 | + subStatusCode: DataApiBuilderException.SubStatusCodes.ConfigValidationError); |
| 110 | + } |
| 111 | + } |
| 112 | +} |
0 commit comments