Exposing the field mappings helpers through interface. (#1965)

## Why make this change?
We use the ISqlMetadataProvider to interact with the metadataprovider of
a class. This method helps get access to the field mappings for an
entity.
With the current code, it is not possible to access field mappings of an
entity.

## What is this change?
Add interface definitions in the ISqlMetadataProvider class.

## How was this tested?

Current tests should cover this

Author: rohkhann

src/Core/Services/MetadataProviders/CosmosSqlMetadataProvider.cs

@@ -351,5 +351,15 @@ public bool IsDevelopmentMode()
         {
             return _runtimeConfig.IsDevelopmentMode();
         }
+
+        public bool TryGetExposedFieldToBackingFieldMap(string entityName, [NotNullWhen(true)] out IReadOnlyDictionary<string, string>? mappings)
+        {
+            throw new NotImplementedException();
+        }
+
+        public bool TryGetBackingFieldToExposedFieldMap(string entityName, [NotNullWhen(true)] out IReadOnlyDictionary<string, string>? mappings)
+        {
+            throw new NotImplementedException();
+        }
     }
 }

src/Core/Services/MetadataProviders/ISqlMetadataProvider.cs

@@ -123,6 +123,16 @@ bool VerifyForeignKeyExistsInDB(
         /// <returns></returns>
         public IReadOnlyDictionary<string, DatabaseObject> GetEntityNamesAndDbObjects();
 
+        /// <summary>
+        /// Given entity name, gets the map of exposed field to backing field mappings.
+        /// </summary>
+        public bool TryGetExposedFieldToBackingFieldMap(string entityName, [NotNullWhen(true)] out IReadOnlyDictionary<string, string>? mappings);
+
+        /// <summary>
+        /// Given entity name, gets the map of backing field to exposed field mappings.
+        /// </summary>
+        public bool TryGetBackingFieldToExposedFieldMap(string entityName, [NotNullWhen(true)] out IReadOnlyDictionary<string, string>? mappings);
+
         /// <summary>
         /// Gets Partition Key Path of a database container.
         /// </summary>

src/Core/Services/MetadataProviders/SqlMetadataProvider.cs

@@ -284,10 +284,8 @@ public async Task InitializeAsync()
             _logger.LogTrace($"Done inferring Sql database schema in {timer.ElapsedMilliseconds}ms.");
         }
 
-        /// <summary>
-        /// Given entity name, gets the entity to column mappings if present.
-        /// </summary>
-        public bool TryGetEntityToColumnMappings(string entityName, [NotNullWhen(true)] out IReadOnlyDictionary<string, string>? mappings)
+        /// <inheritdoc/>
+        public bool TryGetExposedFieldToBackingFieldMap(string entityName, [NotNullWhen(true)] out IReadOnlyDictionary<string, string>? mappings)
         {
             Dictionary<string, string>? entityToColumnMappings;
             mappings = null;
@@ -300,10 +298,8 @@ public bool TryGetEntityToColumnMappings(string entityName, [NotNullWhen(true)]
             return false;
         }
 
-        /// <summary>
-        /// Given entity name, gets the column to entity mappings if present.
-        /// </summary>
-        public bool TryGetColumnToEntityMappings(string entityName, [NotNullWhen(true)] out IReadOnlyDictionary<string, string>? mappings)
+        /// <inheritdoc/>
+        public bool TryGetBackingFieldToExposedFieldMap(string entityName, [NotNullWhen(true)] out IReadOnlyDictionary<string, string>? mappings)
         {
             Dictionary<string, string>? columntoEntityMappings;
             mappings = null;

src/Service.Tests/Unittests/SqlMetadataProviderUnitTests.cs

@@ -250,10 +250,10 @@ public async Task CheckGetFieldMappings()
             await _sqlMetadataProvider.InitializeAsync();
 
             MsSqlMetadataProvider metadataProvider = (MsSqlMetadataProvider)_sqlMetadataProvider;
-            Assert.IsFalse(metadataProvider.TryGetColumnToEntityMappings("InvalidEntity", out _), "Column to entity mappings should not exist for invalid entity.");
-            Assert.IsFalse(metadataProvider.TryGetEntityToColumnMappings("invalidEntity", out _), "Entity to column mappings should not exist for invalid entity.");
-            Assert.IsTrue(metadataProvider.TryGetEntityToColumnMappings("Publisher", out IReadOnlyDictionary<string, string> _), "Entity to column mappings should exist for valid entity.");
-            Assert.IsTrue(metadataProvider.TryGetColumnToEntityMappings("Publisher", out IReadOnlyDictionary<string, string> _), "Column to entity mappings should exist for valid entity.");
+            Assert.IsFalse(metadataProvider.TryGetBackingFieldToExposedFieldMap("InvalidEntity", out _), "Column to entity mappings should not exist for invalid entity.");
+            Assert.IsFalse(metadataProvider.TryGetExposedFieldToBackingFieldMap("invalidEntity", out _), "Entity to column mappings should not exist for invalid entity.");
+            Assert.IsTrue(metadataProvider.TryGetExposedFieldToBackingFieldMap("Publisher", out IReadOnlyDictionary<string, string> _), "Entity to column mappings should exist for valid entity.");
+            Assert.IsTrue(metadataProvider.TryGetBackingFieldToExposedFieldMap("Publisher", out IReadOnlyDictionary<string, string> _), "Column to entity mappings should exist for valid entity.");
 
             TestHelper.UnsetAllDABEnvironmentVariables();
         }