[Ports] Cherry-pick few bug fixes to 0.9 (#1879)

## Why make this change?

This is simply cherry-picking the following PRs before creating the next
stable 0.9 version:

- #1876
- #1821 
- #1854 
- #1851 
- #1872 
- #1868

---------

Co-authored-by: Sean Leonard <[email protected]>
Co-authored-by: Abhishek  Kumar <[email protected]>
Co-authored-by: neeraj-sharma2592 <[email protected]>
Co-authored-by: Neeraj Sharma (from Dev Box) <[email protected]>
Co-authored-by: aaronburtle <[email protected]>

Author: 6 people

.pipelines/cosmos-pipelines.yml

@@ -18,11 +18,8 @@ strategy:
     linux:
       imageName: "ubuntu-latest"
       ADDITIONAL_TEST_ARGS: '--collect "XPlat Code coverage"'
-    mac:
-      imageName: "macOS-latest"
-      ADDITIONAL_TEST_ARGS: ''
     windows:
-      imageName: "windows-2022"
+      imageName: "windows-latest"
       ADDITIONAL_TEST_ARGS: '--collect "XPlat Code coverage"'
   maxParallel: 3
 pool:
@@ -32,6 +29,15 @@ variables:
   buildPlatform: 'Any CPU'
   buildConfiguration: 'Release'
 steps:
+- task: PowerShell@2
+  displayName: Start CosmosDB Emulator
+  condition: eq( variables['Agent.OS'], 'Windows_NT' )
+  inputs:
+    targetType: 'inline'
+    script: |
+      Import-Module "$env:ProgramFiles\Azure Cosmos DB Emulator\PSModules\Microsoft.Azure.CosmosDB.Emulator"
+      Start-CosmosDbEmulator
+
 - task: NuGetAuthenticate@0
   displayName: 'NuGet Authenticate'
 
@@ -57,7 +63,18 @@ steps:
     projects: '**/*.csproj'
     arguments: '-p:generateConfigFileForDbType=cosmosdb_nosql --configuration $(buildConfiguration)' # Update this to match your need
 
+- bash: |
+    echo "Waiting for CosmosDB Emulator to Start"
+    until [ "$(curl -k -s --connect-timeout 5 -o /dev/null -w "%{http_code}" https://localhost:8081/_explorer/index.html)" == "200" ]; do
+        sleep 5;
+        echo "Waiting for CosmosDB Emulator to Start"
+    done;
+    echo "CosmosDB Emulator is available"
+  condition: eq( variables['Agent.OS'], 'Windows_NT' )
+  displayName: Check CosmosDB Emulator is running
+
 - task: [email protected]
+  condition: eq( variables['Agent.OS'], 'Linux' )
   displayName: 'Generate dab-config.CosmosDb_NoSql.json'
   inputs:
     folderPath: '$(System.DefaultWorkingDirectory)'

src/Core/Resolvers/SqlPaginationUtil.cs

@@ -114,6 +114,37 @@ public static JsonDocument CreatePaginationConnectionFromJsonDocument(JsonDocume
             return result;
         }
 
+        /// <summary>
+        /// Holds the information safe to expose in the response's pagination cursor,
+        /// the NextLink. The NextLink column represents the safe to expose information
+        /// that defines the entity, field, field value, and direction of sorting to
+        /// continue to the next page. These can then be used to form the pagination
+        /// columns that will be needed for the actual query.
+        /// </summary>
+        protected class NextLinkField
+        {
+            public string EntityName { get; set; }
+            public string FieldName { get; set; }
+            public object? FieldValue { get; }
+            public string? ParamName { get; set; }
+            public OrderBy Direction { get; set; }
+
+            public NextLinkField(
+                string entityName,
+                string fieldName,
+                object? fieldValue,
+                string? paramName = null,
+                // default sorting direction is ascending so we maintain that convention
+                OrderBy direction = OrderBy.ASC)
+            {
+                EntityName = entityName;
+                FieldName = fieldName;
+                FieldValue = fieldValue;
+                ParamName = paramName;
+                Direction = direction;
+            }
+        }
+
         /// <summary>
         /// Extracts the columns from the JsonElement needed for pagination, represents them as a string in json format and base64 encodes.
         /// The JSON is encoded in base64 for opaqueness. The cursor should function as a token that the user copies and pastes
@@ -128,7 +159,7 @@ public static string MakeCursorFromJsonElement(
             string tableName = "",
             ISqlMetadataProvider? sqlMetadataProvider = null)
         {
-            List<PaginationColumn> cursorJson = new();
+            List<NextLinkField> cursorJson = new();
             JsonSerializerOptions options = new() { DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull };
             // Hash set is used here to maintain linear runtime
             // in the worst case for this function. If list is used
@@ -148,12 +179,11 @@ public static string MakeCursorFromJsonElement(
                     string? exposedColumnName = GetExposedColumnName(entityName, column.ColumnName, sqlMetadataProvider);
                     if (TryResolveJsonElementToScalarVariable(element.GetProperty(exposedColumnName), out object? value))
                     {
-                        cursorJson.Add(new PaginationColumn(tableSchema: schemaName,
-                                                        tableName: tableName,
-                                                        exposedColumnName,
-                                                        value,
-                                                        tableAlias: null,
-                                                        direction: column.Direction));
+                        cursorJson.Add(new NextLinkField(
+                            entityName: entityName,
+                            fieldName: exposedColumnName,
+                            fieldValue: value,
+                            direction: column.Direction));
                     }
                     else
                     {
@@ -181,11 +211,10 @@ public static string MakeCursorFromJsonElement(
                     string? exposedColumnName = GetExposedColumnName(entityName, column, sqlMetadataProvider);
                     if (TryResolveJsonElementToScalarVariable(element.GetProperty(exposedColumnName), out object? value))
                     {
-                        cursorJson.Add(new PaginationColumn(tableSchema: schemaName,
-                                                        tableName: tableName,
-                                                        exposedColumnName,
-                                                        value,
-                                                        direction: OrderBy.ASC));
+                        cursorJson.Add(new NextLinkField(
+                            entityName: entityName,
+                            fieldName: exposedColumnName,
+                            fieldValue: value));
                     }
                     else
                     {
@@ -233,45 +262,54 @@ public static IEnumerable<PaginationColumn> ParseAfterFromQueryParams(
         /// Validate the value associated with $after, and return list of orderby columns
         /// it represents.
         /// </summary>
-        public static IEnumerable<PaginationColumn> ParseAfterFromJsonString(string afterJsonString,
-                                                                             PaginationMetadata paginationMetadata,
-                                                                             ISqlMetadataProvider sqlMetadataProvider,
-                                                                             string entityName,
-                                                                             RuntimeConfigProvider runtimeConfigProvider
-                                                                             )
+        public static IEnumerable<PaginationColumn> ParseAfterFromJsonString(
+            string afterJsonString,
+            PaginationMetadata paginationMetadata,
+            ISqlMetadataProvider sqlMetadataProvider,
+            string entityName,
+            RuntimeConfigProvider runtimeConfigProvider
+            )
         {
-            IEnumerable<PaginationColumn>? after;
+            List<PaginationColumn>? paginationCursorColumnsForQuery = new();
+            IEnumerable<NextLinkField>? paginationCursorFieldsFromRequest;
             try
             {
                 afterJsonString = Base64Decode(afterJsonString);
-                after = JsonSerializer.Deserialize<IEnumerable<PaginationColumn>>(afterJsonString);
+                paginationCursorFieldsFromRequest = JsonSerializer.Deserialize<IEnumerable<NextLinkField>>(afterJsonString);
 
-                if (after is null)
+                if (paginationCursorFieldsFromRequest is null)
                 {
                     throw new ArgumentException("Failed to parse the pagination information from the provided token");
                 }
 
-                Dictionary<string, PaginationColumn> afterDict = new();
-                foreach (PaginationColumn column in after)
+                Dictionary<string, PaginationColumn> exposedFieldNameToBackingColumn = new();
+                foreach (NextLinkField field in paginationCursorFieldsFromRequest)
                 {
                     // REST calls this function with a non null sqlMetadataProvider
                     // which will get the exposed name for safe messaging in the response.
                     // Since we are looking for pagination columns from the $after query
                     // param, we expect this column to exist as the $after query param
                     // was formed from a previous response with a nextLink. If the nextLink
                     // has been modified and backingColumn is null we throw exception.
-                    string backingColumnName = GetBackingColumnName(entityName, column.ColumnName, sqlMetadataProvider);
+                    string backingColumnName = GetBackingColumnName(entityName, field.FieldName, sqlMetadataProvider);
                     if (backingColumnName is null)
                     {
-                        throw new DataApiBuilderException(message: $"Cursor for Pagination Predicates is not well formed, {column.ColumnName} is not valid.",
-                                                       statusCode: HttpStatusCode.BadRequest,
-                                                       subStatusCode: DataApiBuilderException.SubStatusCodes.BadRequest);
+                        throw new DataApiBuilderException(
+                            message: $"Pagination token is not well formed because {field.FieldName} is not valid.",
+                            statusCode: HttpStatusCode.BadRequest,
+                            subStatusCode: DataApiBuilderException.SubStatusCodes.BadRequest);
                     }
 
+                    PaginationColumn pageColumn = new(
+                        tableName: "",
+                        tableSchema: "",
+                        columnName: backingColumnName,
+                        value: field.FieldValue,
+                        paramName: field.ParamName,
+                        direction: field.Direction);
+                    paginationCursorColumnsForQuery.Add(pageColumn);
                     // holds exposed name mapped to exposed pagination column
-                    afterDict.Add(column.ColumnName, column);
-                    // overwrite with backing column's name for query generation
-                    column.ColumnName = backingColumnName;
+                    exposedFieldNameToBackingColumn.Add(field.FieldName, pageColumn);
                 }
 
                 // verify that primary keys is a sub set of after's column names
@@ -284,12 +322,13 @@ RuntimeConfigProvider runtimeConfigProvider
                     // which will get the exposed name for safe messaging in the response.
                     // Since we are looking for primary keys we expect these columns to
                     // exist.
-                    string safePK = GetExposedColumnName(entityName, pk, sqlMetadataProvider);
-                    if (!afterDict.ContainsKey(safePK))
+                    string exposedFieldName = GetExposedColumnName(entityName, pk, sqlMetadataProvider);
+                    if (!exposedFieldNameToBackingColumn.ContainsKey(exposedFieldName))
                     {
-                        throw new DataApiBuilderException(message: $"Cursor for Pagination Predicates is not well formed, missing primary key column: {safePK}",
-                                                       statusCode: HttpStatusCode.BadRequest,
-                                                       subStatusCode: DataApiBuilderException.SubStatusCodes.BadRequest);
+                        throw new DataApiBuilderException(
+                            message: $"Pagination token is not well formed because it is missing an expected field: {exposedFieldName}",
+                            statusCode: HttpStatusCode.BadRequest,
+                            subStatusCode: DataApiBuilderException.SubStatusCodes.BadRequest);
                     }
                 }
 
@@ -299,28 +338,28 @@ RuntimeConfigProvider runtimeConfigProvider
                 SqlQueryStructure structure = paginationMetadata.Structure!;
                 foreach (OrderByColumn column in structure.OrderByColumns)
                 {
-                    string columnName = GetExposedColumnName(entityName, column.ColumnName, sqlMetadataProvider);
+                    string exposedFieldName = GetExposedColumnName(entityName, column.ColumnName, sqlMetadataProvider);
 
-                    if (!afterDict.ContainsKey(columnName) ||
-                        afterDict[columnName].Direction != column.Direction)
+                    if (!exposedFieldNameToBackingColumn.ContainsKey(exposedFieldName) ||
+                        exposedFieldNameToBackingColumn[exposedFieldName].Direction != column.Direction)
                     {
                         // REST calls this function with a non null sqlMetadataProvider
                         // which will get the exposed name for safe messaging in the response.
                         // Since we are looking for valid orderby columns we expect
                         // these columns to exist.
-                        string safeColumnName = GetExposedColumnName(entityName, columnName, sqlMetadataProvider);
+                        string exposedOrderByFieldName = GetExposedColumnName(entityName, column.ColumnName, sqlMetadataProvider);
                         throw new DataApiBuilderException(
-                                    message: $"Could not match order by column {safeColumnName} with a column in the pagination token with the same name and direction.",
-                                    statusCode: HttpStatusCode.BadRequest,
-                                    subStatusCode: DataApiBuilderException.SubStatusCodes.BadRequest);
+                            message: $"Could not match order by column {exposedOrderByFieldName} with a column in the pagination token with the same name and direction.",
+                            statusCode: HttpStatusCode.BadRequest,
+                            subStatusCode: DataApiBuilderException.SubStatusCodes.BadRequest);
                     }
 
                     orderByColumnCount++;
                 }
 
                 // the check above validates that all orderby columns are matched with after columns
                 // also validate that there are no extra after columns
-                if (afterDict.Count != orderByColumnCount)
+                if (exposedFieldNameToBackingColumn.Count != orderByColumnCount)
                 {
                     throw new ArgumentException("After token contains extra columns not present in order by columns.");
                 }
@@ -351,7 +390,7 @@ e is NotSupportedException
                     innerException: e);
             }
 
-            return after;
+            return paginationCursorColumnsForQuery;
         }
 
         /// <summary>

src/Directory.Packages.props

@@ -7,10 +7,10 @@
     <PackageVersion Include="CommandLineParser" Version="2.9.1" />
     <PackageVersion Include="coverlet.msbuild" Version="3.2.0" />
     <PackageVersion Include="coverlet.collector" Version="3.2.0" />
-    <PackageVersion Include="HotChocolate" Version="12.18.0" />
-    <PackageVersion Include="HotChocolate.AspNetCore" Version="12.18.0" />
-    <PackageVersion Include="HotChocolate.AspNetCore.Authorization" Version="12.18.0" />
-    <PackageVersion Include="HotChocolate.Types.NodaTime" Version="12.18.0" />
+    <PackageVersion Include="HotChocolate" Version="12.22.0" />
+    <PackageVersion Include="HotChocolate.AspNetCore" Version="12.22.0" />
+    <PackageVersion Include="HotChocolate.AspNetCore.Authorization" Version="12.22.0" />
+    <PackageVersion Include="HotChocolate.Types.NodaTime" Version="12.22.0" />
     <PackageVersion Include="Humanizer" Version="2.14.1" />
     <PackageVersion Include="Humanizer.Core" Version="2.14.1" />
     <PackageVersion Include="DotNetEnv" Version="2.5.0" />

src/Service.Tests/Configuration/ConfigurationTests.cs

@@ -988,10 +988,9 @@ public void TestConnectionStringEnvVarHasHighestPrecedence()
             }
             catch (Exception e)
             {
-                Assert.AreEqual(typeof(ApplicationException), e.GetType());
+                Assert.AreEqual(typeof(ArgumentException), e.GetType());
                 Assert.AreEqual(
-                    $"Could not initialize the engine with the runtime config file: " +
-                    $"{CONFIGFILE_NAME}.{COSMOS_ENVIRONMENT}{CONFIG_EXTENSION}",
+                    $"Format of the initialization string does not conform to specification starting at index 0.",
                     e.Message);
             }
         }
@@ -1033,15 +1032,14 @@ public void TestGetConfigFileNameForEnvironment(
         [TestCategory(TestCategory.MSSQL)]
         [DataRow("/graphql/", HostMode.Development, HttpStatusCode.OK, "Banana Cake Pop",
             DisplayName = "GraphQL endpoint with no query in development mode.")]
-        [DataRow("/graphql", HostMode.Production, HttpStatusCode.BadRequest,
-            "Either the parameter query or the parameter id has to be set",
+        [DataRow("/graphql", HostMode.Production, HttpStatusCode.NotFound,
             DisplayName = "GraphQL endpoint with no query in production mode.")]
         [DataRow("/graphql/ui", HostMode.Development, HttpStatusCode.NotFound,
             DisplayName = "Default BananaCakePop in development mode.")]
         [DataRow("/graphql/ui", HostMode.Production, HttpStatusCode.NotFound,
             DisplayName = "Default BananaCakePop in production mode.")]
         [DataRow("/graphql?query={book_by_pk(id: 1){title}}",
-            HostMode.Development, HttpStatusCode.Moved,
+            HostMode.Development, HttpStatusCode.OK,
             DisplayName = "GraphQL endpoint with query in development mode.")]
         [DataRow("/graphql?query={book_by_pk(id: 1){title}}",
             HostMode.Production, HttpStatusCode.OK, "data",

src/Service.Tests/Configuration/TelemetryTests.cs

@@ -8,9 +8,11 @@
 using System.Net.Http.Json;
 using System.Threading.Tasks;
 using Azure.DataApiBuilder.Config.ObjectModel;
+using Microsoft.ApplicationInsights;
 using Microsoft.ApplicationInsights.Channel;
 using Microsoft.ApplicationInsights.DataContracts;
 using Microsoft.AspNetCore.TestHost;
+using Microsoft.Extensions.DependencyInjection;
 using Microsoft.IdentityModel.Tokens;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 using static Azure.DataApiBuilder.Service.Tests.Configuration.ConfigurationTests;
@@ -89,6 +91,7 @@ public async Task TestTelemetryItemsAreSentCorrectly_NonHostedScenario()
         using (TestServer server = new(Program.CreateWebHostBuilder(args)))
         {
             await TestRestAndGraphQLRequestsOnServerInNonHostedScenario(server);
+            Assert.IsTrue(server.Services.GetService<TelemetryClient>() is not null);
         }
 
         List<ITelemetry> telemetryItems = ((CustomTelemetryChannel)telemetryChannel).GetTelemetryItems();
@@ -157,6 +160,9 @@ public async Task TestNoTelemetryItemsSentWhenDisabled_NonHostedScenario(bool is
         using (TestServer server = new(Program.CreateWebHostBuilder(args)))
         {
             await TestRestAndGraphQLRequestsOnServerInNonHostedScenario(server);
+            // Telemetry client should be null if telemetry is disabled
+            // Using an EXOR here to assert this.
+            Assert.IsTrue(server.Services.GetService<TelemetryClient>() is null ^ isTelemetryEnabled);
         }
 
         List<ITelemetry> telemetryItems = ((CustomTelemetryChannel)telemetryChannel).GetTelemetryItems();

src/Service.Tests/SqlTests/GraphQLMutationTests/GraphQLMutationTestBase.cs

@@ -1188,7 +1188,7 @@ public virtual async Task UpdateWithInvalidIdentifier()
         /// Test adding a website placement to a book which already has a website
         /// placement
         /// </summary>
-        public async Task TestViolatingOneToOneRelashionShip(string errorMessage)
+        public async Task TestViolatingOneToOneRelationship(string errorMessage)
         {
             string graphQLMutationName = "createBookWebsitePlacement";
             string graphQLMutation = @"