Add application name for PGSQL connections (#2208)

## Why make this change?
Closes #1635 

## What is this change?

Checking if Application Name is already present in the PgSql connection
string. I f yes, we append DAB APP NAME with ',' as separator else, we
add an Application Name property to connection string.

## How was this tested?

- [ ] Unit Tests

## Sample Request(s)

If Application Name is specified by the developer, then DAB will append
to it, else will add Application Name property

---------

Co-authored-by: Aniruddh Munde <[email protected]>

Author: 2 people

src/Cli.Tests/EndToEndTests.cs

@@ -178,7 +178,7 @@ public void TestInitializingRestAndGraphQLGlobalSettings()
     [DataRow(CliBool.None, "cosmosdb_nosql", DatabaseType.CosmosDB_NoSQL, DisplayName = "Init command without '--graphql.multiple-create.enabled' option for cosmosdb_nosql database type")]
     public void TestEnablingMultipleCreateOperation(CliBool isMultipleCreateEnabled, string dbType, DatabaseType expectedDbType)
     {
-        List<string> args = new() { "init", "-c", TEST_RUNTIME_CONFIG_FILE, "--connection-string", SAMPLE_TEST_CONN_STRING, "--database-type", dbType };
+        List<string> args = new() { "init", "-c", TEST_RUNTIME_CONFIG_FILE, "--connection-string", dbType == "postgresql" ? SAMPLE_TEST_PGSQL_CONN_STRING : SAMPLE_TEST_CONN_STRING, "--database-type", dbType };
 
         if (string.Equals("cosmosdb_nosql", dbType, StringComparison.OrdinalIgnoreCase))
         {

src/Cli.Tests/TestHelper.cs

@@ -13,6 +13,8 @@ public static class TestHelper
 
         public const string SAMPLE_TEST_CONN_STRING = "Data Source=<>;Initial Catalog=<>;User ID=<>;Password=<>;";
 
+        public const string SAMPLE_TEST_PGSQL_CONN_STRING = "Host=<>;Database=<>;username=<>;password=<>";
+
         // test schema for cosmosDB
         public const string TEST_SCHEMA_FILE = "test-schema.gql";
         public const string DAB_DRAFT_SCHEMA_TEST_PATH = "https://github.com/Azure/data-api-builder/releases/download/vmajor.minor.patch/dab.draft.schema.json";

src/Config/Azure.DataApiBuilder.Config.csproj

@@ -27,6 +27,7 @@
       </PackageReference>
       <PackageReference Include="Microsoft.SourceLink.GitHub" PrivateAssets="All" />
       <PackageReference Include="Humanizer" />
+      <PackageReference Include="Npgsql" />
   </ItemGroup>
 
     <ItemGroup>

src/Config/RuntimeConfigLoader.cs

@@ -14,6 +14,8 @@
 using Azure.DataApiBuilder.Service.Exceptions;
 using Microsoft.Data.SqlClient;
 using Microsoft.Extensions.Logging;
+using Microsoft.IdentityModel.Tokens;
+using Npgsql;
 
 [assembly: InternalsVisibleTo("Azure.DataApiBuilder.Service.Tests")]
 namespace Azure.DataApiBuilder.Config;
@@ -105,11 +107,15 @@ public static bool TryParseConfig(string json,
 
                 DataSource ds = config.GetDataSourceFromDataSourceName(dataSourceKey);
 
-                // Add Application Name for telemetry for MsSQL
+                // Add Application Name for telemetry for MsSQL or PgSql
                 if (ds.DatabaseType is DatabaseType.MSSQL && replaceEnvVar)
                 {
                     updatedConnection = GetConnectionStringWithApplicationName(connectionValue);
                 }
+                else if (ds.DatabaseType is DatabaseType.PostgreSQL && replaceEnvVar)
+                {
+                    updatedConnection = GetPgSqlConnectionStringWithApplicationName(connectionValue);
+                }
 
                 ds = ds with { ConnectionString = updatedConnection };
                 config.UpdateDataSourceNameToDataSource(dataSourceName, ds);
@@ -235,4 +241,52 @@ internal static string GetConnectionStringWithApplicationName(string connectionS
         // Return the updated connection string.
         return connectionStringBuilder.ConnectionString;
     }
+
+    /// <summary>
+    /// It adds or replaces a property in the connection string with `Application Name` property.
+    /// If the connection string already contains the property, it appends the property `Application Name` to the connection string,
+    /// else add the Application Name property with DataApiBuilder Application Name based on hosted/oss platform.
+    /// </summary>
+    /// <param name="connectionString">Connection string for connecting to database.</param>
+    /// <returns>Updated connection string with `Application Name` property.</returns>
+    internal static string GetPgSqlConnectionStringWithApplicationName(string connectionString)
+    {
+        // If the connection string is null, empty, or whitespace, return it as is.
+        if (string.IsNullOrWhiteSpace(connectionString))
+        {
+            return connectionString;
+        }
+
+        string applicationName = ProductInfo.GetDataApiBuilderUserAgent();
+
+        // Create a StringBuilder from the connection string.
+        NpgsqlConnectionStringBuilder connectionStringBuilder;
+        try
+        {
+            connectionStringBuilder = new NpgsqlConnectionStringBuilder(connectionString);
+        }
+        catch (Exception ex)
+        {
+            throw new DataApiBuilderException(
+                message: DataApiBuilderException.CONNECTION_STRING_ERROR_MESSAGE,
+                statusCode: HttpStatusCode.ServiceUnavailable,
+                subStatusCode: DataApiBuilderException.SubStatusCodes.ErrorInInitialization,
+                innerException: ex);
+        }
+
+        // If the connection string does not contain the `Application Name` property, add it.
+        // or if the connection string contains the `Application Name` property, replace it with the DataApiBuilder Application Name.
+        if (connectionStringBuilder.ApplicationName.IsNullOrEmpty())
+        {
+            connectionStringBuilder.ApplicationName = applicationName;
+        }
+        else
+        {
+            // If the connection string contains the `ApplicationName` property with a value, update the value by adding the DataApiBuilder Application Name.
+            connectionStringBuilder.ApplicationName += $",{applicationName}";
+        }
+
+        // Return the updated connection string.
+        return connectionStringBuilder.ConnectionString;
+    }
 }

src/Service.Tests/Configuration/ConfigurationTests.cs

@@ -652,11 +652,64 @@ public void MsSqlConnStringSupplementedWithAppNameProperty(
                 message: "DAB did not properly set the 'Application Name' connection string property.");
         }
 
+        /// <summary>
+        /// Validates that DAB supplements the PgSQL database connection strings with the property "ApplicationName" and
+        /// 1. Adds the property/value "Application Name=dab_oss_Major.Minor.Patch" when the env var DAB_APP_NAME_ENV is not set.
+        /// 2. Adds the property/value "Application Name=dab_hosted_Major.Minor.Patch" when the env var DAB_APP_NAME_ENV is set to "dab_hosted".
+        /// (DAB_APP_NAME_ENV is set in hosted scenario or when user sets the value.)
+        /// NOTE: "#pragma warning disable format" is used here to avoid removing intentional, readability promoting spacing in DataRow display names.
+        /// </summary>
+        /// <param name="configProvidedConnString">connection string provided in the config.</param>
+        /// <param name="expectedDabModifiedConnString">Updated connection string with Application Name.</param>
+        /// <param name="dabEnvOverride">Whether DAB_APP_NAME_ENV is set in environment. (Always present in hosted scenario or if user supplies value.)</param>
+        [DataTestMethod]
+        [DataRow("Host=foo;Username=testuser;", "Host=foo;Username=testuser;Application Name=", false, DisplayName = "[PGSQL]:DAB adds version 'dab_oss_major_minor_patch' to non-provided connection string property 'ApplicationName']")]
+        [DataRow("Host=foo;Username=testuser;", "Host=foo;Username=testuser;Application Name=", true, DisplayName = "[PGSQL]:DAB adds DAB_APP_NAME_ENV value 'dab_hosted' and version suffix '_major_minor_patch' to non-provided connection string property 'ApplicationName'.]")]
+        [DataRow("Host=foo;Username=testuser;Application Name=UserAppName", "Host=foo;Username=testuser;Application Name=UserAppName,", false, DisplayName = "[PGSQL]:DAB appends version 'dab_oss_major_minor_patch' to user supplied 'Application Name' property.]")]
+        [DataRow("Host=foo;Username=testuser;Application Name=UserAppName", "Host=foo;Username=testuser;Application Name=UserAppName,", true, DisplayName = "[PGSQL]:DAB appends version string 'dab_hosted' and version suffix '_major_minor_patch' to user supplied 'ApplicationName' property.]")]
+        public void PgSqlConnStringSupplementedWithAppNameProperty(
+            string configProvidedConnString,
+            string expectedDabModifiedConnString,
+            bool dabEnvOverride)
+        {
+            // Explicitly set the DAB_APP_NAME_ENV to null to ensure that the DAB_APP_NAME_ENV is not set.
+            if (dabEnvOverride)
+            {
+                Environment.SetEnvironmentVariable(ProductInfo.DAB_APP_NAME_ENV, "dab_hosted");
+            }
+            else
+            {
+                Environment.SetEnvironmentVariable(ProductInfo.DAB_APP_NAME_ENV, null);
+            }
+
+            // Resolve assembly version. Not possible to do in DataRow as DataRows expect compile-time constants.
+            string resolvedAssemblyVersion = ProductInfo.GetDataApiBuilderUserAgent();
+            expectedDabModifiedConnString += resolvedAssemblyVersion;
+
+            RuntimeConfig runtimeConfig = CreateBasicRuntimeConfigWithNoEntity(DatabaseType.PostgreSQL, configProvidedConnString);
+
+            // Act
+            bool configParsed = RuntimeConfigLoader.TryParseConfig(
+                runtimeConfig.ToJson(),
+                out RuntimeConfig updatedRuntimeConfig,
+                replaceEnvVar: true);
+
+            // Assert
+            Assert.AreEqual(
+                expected: true,
+                actual: configParsed,
+                message: "Runtime config unexpectedly failed parsing.");
+            Assert.AreEqual(
+                expected: expectedDabModifiedConnString,
+                actual: updatedRuntimeConfig.DataSource.ConnectionString,
+                message: "DAB did not properly set the 'Application Name' connection string property.");
+        }
+
         /// <summary>
         /// Validates that DAB doesn't append nor modify
         /// - the 'Application Name' or 'App' properties in MySQL database connection strings.
         /// - the 'Application Name' property in
-        /// PostgreSQL, CosmosDB_PostgreSQl, CosmosDB_NoSQL database connection strings.
+        /// CosmosDB_PostgreSQL, CosmosDB_NoSQL database connection strings.
         /// This test validates that this behavior holds true when the DAB_APP_NAME_ENV environment variable
         /// - is set (dabEnvOverride==true) -> (DAB hosted)
         /// - is not set (dabEnvOverride==false) -> (DAB OSS).
@@ -673,10 +726,6 @@ public void MsSqlConnStringSupplementedWithAppNameProperty(
         [DataRow(DatabaseType.MySQL, "Something;"                                 , "Something;"                                 , true , DisplayName = "[MYSQL|DAB hosted]:No addition of 'Application Name' or 'App' property to connection string.")]
         [DataRow(DatabaseType.MySQL, "Something;Application Name=CustAppName;"    , "Something;Application Name=CustAppName;"    , true , DisplayName = "[MYSQL|DAB hosted]:No modification of customer overridden 'Application Name' property.")]
         [DataRow(DatabaseType.MySQL, "Something1;App=CustAppName;Something2;"     , "Something1;App=CustAppName;Something2;"     , true, DisplayName = "[MySQL|DAB hosted]:No modification of customer overridden 'App' property.")]
-        [DataRow(DatabaseType.PostgreSQL, "Something;"                             , "Something;"                             , false, DisplayName = "[PGSQL|DAB OSS]:No addition of 'Application Name' property to connection string.]")]
-        [DataRow(DatabaseType.PostgreSQL, "Something;Application Name=CustAppName;", "Something;Application Name=CustAppName;", false, DisplayName = "[PGSQL|DAB OSS]:No modification of customer overridden 'Application Name' property.")]
-        [DataRow(DatabaseType.PostgreSQL, "Something;"                             , "Something;"                             , true , DisplayName = "[PGSQL|DAB hosted]:No addition of 'Application Name' property to connection string.")]
-        [DataRow(DatabaseType.PostgreSQL, "Something;Application Name=CustAppName;", "Something;Application Name=CustAppName;", true , DisplayName = "[PGSQL|DAB hosted]:No modification of customer overridden 'Application Name' property.")]
         [DataRow(DatabaseType.CosmosDB_NoSQL, "Something;"                             , "Something;"                             , false, DisplayName = "[COSMOSDB_NOSQL|DAB OSS]:No addition of 'Application Name' property to connection string.")]
         [DataRow(DatabaseType.CosmosDB_NoSQL, "Something;Application Name=CustAppName;", "Something;Application Name=CustAppName;", false, DisplayName = "[COSMOSDB_NOSQL|DAB OSS]:No modification of customer overridden 'Application Name' property.")]
         [DataRow(DatabaseType.CosmosDB_NoSQL, "Something;"                             , "Something;"                             , true , DisplayName = "[COSMOSDB_NOSQL|DAB hosted]:No addition of 'Application Name' property to connection string.")]

src/Service.Tests/Unittests/RuntimeConfigLoaderJsonDeserializerTests.cs

@@ -42,12 +42,6 @@ public class RuntimeConfigLoaderJsonDeserializerTests
         /// <param name="repKeys">Replacement used as key to get environment variable.</param>
         /// <param name="repValues">Replacement value.</param>
         [DataTestMethod]
-        [DataRow(
-            new string[] { "@env(')", "@env()", "@env(')'@env('()", "@env('@env()'", "@@eennvv((''''))" },
-            new string[] { "@env(')", "@env()", "@env(')'@env('()", "@env('@env()'", "@@eennvv((''''))" },
-            true,
-            true,
-            DisplayName = "Replacement strings that won't match.")]
         [DataRow(
             new string[] { "@env('envVarName')", "@env(@env('envVarName'))", "@en@env('envVarName')", "@env'()@env'@env('envVarName')')')" },
             new string[] { "envVarValue", "@env(envVarValue)", "@enenvVarValue", "@env'()@env'envVarValue')')" },
@@ -539,6 +533,7 @@ private static string GetDataSourceConfigForGivenDatabase(string databaseType)
         {
             string options = "";
             string databaseTypeEnvVariable = "";
+            string connectionStringEnvVarName = "DATABASE_CONNECTION_STRING";
 
             switch (databaseType)
             {
@@ -561,6 +556,7 @@ private static string GetDataSourceConfigForGivenDatabase(string databaseType)
                     break;
                 case "postgresql":
                     databaseTypeEnvVariable = $"@env('POSTGRESQL_DB_TYPE')";
+                    connectionStringEnvVarName = "DATABASE_CONNECTION_STRING_PGSQL";
                     options = @",""options"": null";
                     break;
                 case "dwsql":
@@ -572,7 +568,7 @@ private static string GetDataSourceConfigForGivenDatabase(string databaseType)
             return $@"
             {{
                 ""database-type"": ""{databaseTypeEnvVariable}"",
-                ""connection-string"": ""@env('DATABASE_CONNECTION_STRING')""
+                ""connection-string"": ""@env('{connectionStringEnvVarName}')""
                 {options}
             }}";
         }
@@ -621,7 +617,8 @@ private static void ClearEnvironmentVariablesFromDictionary(Dictionary<string, s
             { "DATABASE_CONTAINER", "xyz"},
             { "DATABASE_NAME", "planet" },
             { "GRAPHQL_SCHEMA_PATH", "gql-schema.gql" },
-            { "DATABASE_CONNECTION_STRING", "Data Source=<>;Initial Catalog=<>;User ID=<>;Password=<>;" }
+            { "DATABASE_CONNECTION_STRING", "Data Source=<>;Initial Catalog=<>;User ID=<>;Password=<>;" },
+            { "DATABASE_CONNECTION_STRING_PGSQL", "Host=<>;Database=<>;username=<>;password=<>" }
         };
 
         /// <summary>

src/Service.Tests/Unittests/SqlMetadataProviderUnitTests.cs

@@ -166,8 +166,14 @@ public async Task CheckExceptionForBadConnectionStringForMySql(string connection
         [DataRow("")]
         public async Task CheckExceptionForBadConnectionStringForPgSql(string connectionString)
         {
+
+            // For strings that are an invalid format for the connection string builder, need to
+            // redirect std error to a string writer for comparison to expected error messaging later.
+            StringWriter sw = new();
+            Console.SetError(sw);
+
             DatabaseEngine = TestCategory.POSTGRESQL;
-            await CheckExceptionForBadConnectionStringHelperAsync(DatabaseEngine, connectionString);
+            await CheckExceptionForBadConnectionStringHelperAsync(DatabaseEngine, connectionString, sw);
         }
 
         /// <summary>
@@ -192,6 +198,10 @@ private static async Task CheckExceptionForBadConnectionStringHelperAsync(string
             {
                 _queryBuilder = new MySqlQueryBuilder();
             }
+            else if (string.Equals(databaseType, TestCategory.POSTGRESQL))
+            {
+                _queryBuilder = new PostgresQueryBuilder();
+            }
 
             try
             {
@@ -213,16 +223,13 @@ private static async Task CheckExceptionForBadConnectionStringHelperAsync(string
             }
             catch (DataApiBuilderException ex)
             {
-                // use contains to correctly cover db/user unique error messaging
-                // if sw is not null it holds the error messaging
-                string error = sw is null ? ex.Message : sw.ToString();
-                Assert.IsTrue(error.Contains(DataApiBuilderException.CONNECTION_STRING_ERROR_MESSAGE));
+                // Combine both the console and exception messages because they both
+                // may contain the connection string errors this function expects to exist.
+                string consoleMessages = sw is not null ? sw.ToString() : string.Empty;
+                string allErrorMessages = ex.Message + " " + consoleMessages;
+                Assert.IsTrue(allErrorMessages.Contains(DataApiBuilderException.CONNECTION_STRING_ERROR_MESSAGE));
                 Assert.AreEqual(DataApiBuilderException.SubStatusCodes.ErrorInInitialization, ex.SubStatusCode);
                 Assert.AreEqual(HttpStatusCode.ServiceUnavailable, ex.StatusCode);
-                if (sw is not null)
-                {
-                    Assert.IsTrue(error.StartsWith("Deserialization of the configuration file failed during a post-processing step."));
-                }
             }
 
             TestHelper.UnsetAllDABEnvironmentVariables();