Maintain Default Data Source Name from Original Config after Hot Reloading

src/Config/FileSystemRuntimeConfigLoader.cs

@@ -115,8 +115,7 @@ public bool TryLoadConfig(
             {
                 if (!string.IsNullOrEmpty(dataSourceName))
                 {
-                    config.UpdateDefaultDataSourceNameDependantDictionaries(dataSourceName);
-                    config.DefaultDataSourceName = dataSourceName;
+                    config.UpdateDefaultDataSourceName(dataSourceName);
                 }
 
                 return true;

src/Config/ObjectModel/RuntimeConfig.cs

@@ -130,8 +130,7 @@ Runtime.GraphQL is null ||
         }
     }
 
-    [JsonIgnore]
-    public string DefaultDataSourceName;
+    public string _defaultDataSourceName;
 
     private Dictionary<string, DataSource> _dataSourceNameToDataSource;
 
@@ -170,18 +169,18 @@ public RuntimeConfig(string? Schema, DataSource DataSource, RuntimeEntities Enti
         this.DataSource = DataSource;
         this.Runtime = Runtime;
         this.Entities = Entities;
-        this.DefaultDataSourceName = Guid.NewGuid().ToString();
+        _defaultDataSourceName = Guid.NewGuid().ToString();
 
         // we will set them up with default values
         _dataSourceNameToDataSource = new Dictionary<string, DataSource>
         {
-            { DefaultDataSourceName, this.DataSource }
+            { _defaultDataSourceName, this.DataSource }
         };
 
         _entityNameToDataSourceName = new Dictionary<string, string>();
         foreach (KeyValuePair<string, Entity> entity in Entities)
         {
-            _entityNameToDataSourceName.TryAdd(entity.Key, DefaultDataSourceName);
+            _entityNameToDataSourceName.TryAdd(entity.Key, _defaultDataSourceName);
         }
 
         // Process data source and entities information for each database in multiple database scenario.
@@ -242,7 +241,7 @@ public RuntimeConfig(string Schema, DataSource DataSource, RuntimeOptions Runtim
         this.DataSource = DataSource;
         this.Runtime = Runtime;
         this.Entities = Entities;
-        this.DefaultDataSourceName = DefaultDataSourceName;
+        _defaultDataSourceName = DefaultDataSourceName;
         _dataSourceNameToDataSource = DataSourceNameToDataSource;
         _entityNameToDataSourceName = EntityNameToDataSourceName;
         this.DataSourceFiles = DataSourceFiles;
@@ -277,24 +276,25 @@ public void UpdateDataSourceNameToDataSource(string dataSourceName, DataSource d
     /// <summary>
     /// In a Hot Reload scenario we should maintain the same default data source
     /// name before the hot reload as after the hot reload. This is because we hold
-    /// references such as to the Data Source itself which depend on this data source name
+    /// references to the Data Source itself which depend on this data source name
     /// for lookups. To correctly retrieve this information after a hot reload
-    /// we need the data source name to say the same after hot reloading. This method takes
+    /// we need the data source name to stay the same after hot reloading. This method takes
     /// a default data source name, such as the one from before hot reload, and
     /// replaces the current dictionary entries of this RuntimeConfig that were
     /// built using a new, unique guid during the construction of this RuntimeConfig
-    /// with entries using the provided default data source name.
+    /// with entries using the provided default data source name. We then update the DefaultDataSourceName.
     /// </summary>
-    /// <param name="defaultDataSourceName">The name used to update the dictionaries.</param>
-    public void UpdateDefaultDataSourceNameDependantDictionaries(string initialDefaultDataSourceName)
+    /// <param name="initialDefaultDataSourceName">The name used to update the dictionaries.</param>
+    public void UpdateDefaultDataSourceName(string initialDefaultDataSourceName)
     {
-        _dataSourceNameToDataSource.Remove(DefaultDataSourceName);
+        _dataSourceNameToDataSource.Remove(_defaultDataSourceName);
         _dataSourceNameToDataSource.Add(initialDefaultDataSourceName, this.DataSource);
         foreach (KeyValuePair<string, Entity> entity in Entities)
         {
-            _entityNameToDataSourceName.Remove(entity.Key);
-            _entityNameToDataSourceName.Add(entity.Key,initialDefaultDataSourceName);
+            _entityNameToDataSourceName[entity.Key] = initialDefaultDataSourceName;
         }
+
+        _defaultDataSourceName = initialDefaultDataSourceName;
     }
 
     /// <summary>
@@ -327,6 +327,17 @@ public bool CheckDataSourceExists(string dataSourceName)
         return _dataSourceNameToDataSource.ContainsKey(dataSourceName);
     }
 
+    /// <summary>
+    /// Get the default datasource name.
+    /// </summary>
+    /// <returns>default datasourceName.</returns>
+#pragma warning disable CA1024 // Use properties where appropriate. Reason: Do not want datasource serialized and want to keep it private to restrict set;
+    public string GetDefaultDataSourceName()
+#pragma warning restore CA1024 // Use properties where appropriate
+    {
+        return _defaultDataSourceName;
+    }
+
     /// <summary>
     /// Serializes the RuntimeConfig object to JSON for writing to file.
     /// </summary>

src/Config/RuntimeConfigLoader.cs

@@ -81,7 +81,7 @@ public static bool TryParseConfig(string json,
             // set dataSourceName to default if not provided
             if (string.IsNullOrEmpty(dataSourceName))
             {
-                dataSourceName = config.DefaultDataSourceName;
+                dataSourceName = config.GetDefaultDataSourceName();
             }
 
             if (!string.IsNullOrEmpty(connectionString))
@@ -114,7 +114,7 @@ public static bool TryParseConfig(string json,
                 ds = ds with { ConnectionString = updatedConnection };
                 config.UpdateDataSourceNameToDataSource(dataSourceName, ds);
 
-                if (string.Equals(dataSourceKey, config.DefaultDataSourceName, StringComparison.OrdinalIgnoreCase))
+                if (string.Equals(dataSourceKey, config.GetDefaultDataSourceName(), StringComparison.OrdinalIgnoreCase))
                 {
                     config = config with { DataSource = ds };
                 }

src/Core/Configurations/RuntimeConfigProvider.cs

@@ -152,7 +152,7 @@ public bool TryGetLoadedConfig([NotNullWhen(true)] out RuntimeConfig? runtimeCon
     public void HotReloadConfig()
     {
         // _runtimeconfig can not be null in a hot reload scenario
-        ConfigLoader.TryLoadKnownConfig(out _runtimeConfig, replaceEnvVar: true, _runtimeConfig!.DefaultDataSourceName);
+        ConfigLoader.TryLoadKnownConfig(out _runtimeConfig, replaceEnvVar: true, _runtimeConfig!.GetDefaultDataSourceName());
     }
 
     /// <summary>
@@ -194,7 +194,7 @@ public async Task<bool> Initialize(
                 _runtimeConfig = HandleCosmosNoSqlConfiguration(schema, _runtimeConfig, _runtimeConfig.DataSource.ConnectionString);
             }
 
-            ManagedIdentityAccessToken[_runtimeConfig.DefaultDataSourceName] = accessToken;
+            ManagedIdentityAccessToken[_runtimeConfig.GetDefaultDataSourceName()] = accessToken;
         }
 
         bool configLoadSucceeded = await InvokeConfigLoadedHandlersAsync();
@@ -269,8 +269,8 @@ public async Task<bool> Initialize(
                 DatabaseType.CosmosDB_NoSQL => HandleCosmosNoSqlConfiguration(graphQLSchema, runtimeConfig, connectionString),
                 _ => runtimeConfig with { DataSource = runtimeConfig.DataSource with { ConnectionString = connectionString } }
             };
-            ManagedIdentityAccessToken[_runtimeConfig.DefaultDataSourceName] = accessToken;
-            _runtimeConfig.UpdateDataSourceNameToDataSource(_runtimeConfig.DefaultDataSourceName, _runtimeConfig.DataSource);
+            ManagedIdentityAccessToken[_runtimeConfig.GetDefaultDataSourceName()] = accessToken;
+            _runtimeConfig.UpdateDataSourceNameToDataSource(_runtimeConfig.GetDefaultDataSourceName(), _runtimeConfig.DataSource);
 
             return await InvokeConfigLoadedHandlersAsync();
         }
@@ -299,7 +299,7 @@ private static RuntimeConfig HandleCosmosNoSqlConfiguration(string? schema, Runt
     {
         if (string.IsNullOrEmpty(dataSourceName))
         {
-            dataSourceName = runtimeConfig.DefaultDataSourceName;
+            dataSourceName = runtimeConfig.GetDefaultDataSourceName();
         }
 
         DbConnectionStringBuilder dbConnectionStringBuilder = new()
@@ -342,7 +342,7 @@ private static RuntimeConfig HandleCosmosNoSqlConfiguration(string? schema, Runt
         // Update the connection string in the datasource with the one that was provided to the controller
         dataSource = dataSource with { Options = options, ConnectionString = connectionString };
 
-        if (dataSourceName == runtimeConfig.DefaultDataSourceName)
+        if (dataSourceName == runtimeConfig.GetDefaultDataSourceName())
         {
             // update default db.
             runtimeConfig = runtimeConfig with { DataSource = dataSource };

src/Core/Resolvers/MsSqlQueryExecutor.cs

@@ -107,7 +107,7 @@ public override async Task SetManagedIdentityAccessTokenIfAnyAsync(DbConnection
             // using default datasource name for first db - maintaining backward compatibility for single db scenario.
             if (string.IsNullOrEmpty(dataSourceName))
             {
-                dataSourceName = ConfigProvider.GetConfig().DefaultDataSourceName;
+                dataSourceName = ConfigProvider.GetConfig().GetDefaultDataSourceName();
             }
 
             _dataSourceAccessTokenUsage.TryGetValue(dataSourceName, out bool setAccessToken);
@@ -198,7 +198,7 @@ public override string GetSessionParamsQuery(HttpContext? httpContext, IDictiona
         {
             if (string.IsNullOrEmpty(dataSourceName))
             {
-                dataSourceName = ConfigProvider.GetConfig().DefaultDataSourceName;
+                dataSourceName = ConfigProvider.GetConfig().GetDefaultDataSourceName();
             }
 
             if (httpContext is null || !_dataSourceToSessionContextUsage[dataSourceName])

src/Core/Resolvers/MySqlQueryExecutor.cs

@@ -97,7 +97,7 @@ public override async Task SetManagedIdentityAccessTokenIfAnyAsync(DbConnection
             // using default datasource name for first db - maintaining backward compatibility for single db scenario.
             if (string.IsNullOrEmpty(dataSourceName))
             {
-                dataSourceName = ConfigProvider.GetConfig().DefaultDataSourceName;
+                dataSourceName = ConfigProvider.GetConfig().GetDefaultDataSourceName();
             }
 
             _dataSourceAccessTokenUsage.TryGetValue(dataSourceName, out bool setAccessToken);

src/Core/Resolvers/PostgreSqlExecutor.cs

@@ -93,7 +93,7 @@ public override async Task SetManagedIdentityAccessTokenIfAnyAsync(DbConnection
             // using default datasource name for first db - maintaining backward compatibility for single db scenario.
             if (string.IsNullOrEmpty(dataSourceName))
             {
-                dataSourceName = ConfigProvider.GetConfig().DefaultDataSourceName;
+                dataSourceName = ConfigProvider.GetConfig().GetDefaultDataSourceName();
             }
 
             _dataSourceAccessTokenUsage.TryGetValue(dataSourceName, out bool setAccessToken);

src/Core/Resolvers/QueryExecutor.cs

@@ -71,7 +71,7 @@ public QueryExecutor(DbExceptionParser dbExceptionParser,
         {
             if (string.IsNullOrEmpty(dataSourceName))
             {
-                dataSourceName = ConfigProvider.GetConfig().DefaultDataSourceName;
+                dataSourceName = ConfigProvider.GetConfig().GetDefaultDataSourceName();
             }
 
             if (!ConnectionStringBuilders.ContainsKey(dataSourceName))

src/Core/Resolvers/SqlMutationEngine.cs

@@ -373,7 +373,7 @@ await queryExecutor.ExecuteQueryAsync(
         public async Task<IActionResult?> ExecuteAsync(RestRequestContext context)
         {
             // for REST API scenarios, use the default datasource
-            string dataSourceName = _runtimeConfigProvider.GetConfig().DefaultDataSourceName;
+            string dataSourceName = _runtimeConfigProvider.GetConfig().GetDefaultDataSourceName();
 
             Dictionary<string, object?> parameters = PrepareParameters(context);
             ISqlMetadataProvider sqlMetadataProvider = _sqlMetadataProviderFactory.GetMetadataProvider(dataSourceName);
@@ -1194,7 +1194,7 @@ private static TransactionScope ConstructTransactionScopeWithSpecifiedIsolationL
         private string GetValidatedDataSourceName(string dataSourceName)
         {
             // For rest scenarios - no multiple db support. Hence to maintain backward compatibility, we will use the default db.
-            return string.IsNullOrEmpty(dataSourceName) ? _runtimeConfigProvider.GetConfig().DefaultDataSourceName : dataSourceName;
+            return string.IsNullOrEmpty(dataSourceName) ? _runtimeConfigProvider.GetConfig().GetDefaultDataSourceName() : dataSourceName;
         }
 
         /// <summary>

src/Core/Resolvers/SqlQueryEngine.cs

@@ -137,7 +137,7 @@ await ExecuteAsync(structure, dataSourceName),
         public async Task<JsonDocument?> ExecuteAsync(FindRequestContext context)
         {
             // for REST API scenarios, use the default datasource
-            string dataSourceName = _runtimeConfigProvider.GetConfig().DefaultDataSourceName;
+            string dataSourceName = _runtimeConfigProvider.GetConfig().GetDefaultDataSourceName();
 
             ISqlMetadataProvider sqlMetadataProvider = _sqlMetadataProviderFactory.GetMetadataProvider(dataSourceName);
             SqlQueryStructure structure = new(

src/Core/Services/OpenAPI/OpenApiDocumentor.cs

@@ -173,7 +173,7 @@ private OpenApiPaths BuildPaths()
         {
             OpenApiPaths pathsCollection = new();
 
-            string defaultDataSourceName = _runtimeConfig.DefaultDataSourceName;
+            string defaultDataSourceName = _runtimeConfig.GetDefaultDataSourceName();
             ISqlMetadataProvider metadataProvider = _metadataProviderFactory.GetMetadataProvider(defaultDataSourceName);
             foreach (KeyValuePair<string, DatabaseObject> entityDbMetadataMap in metadataProvider.EntityToDatabaseObject)
             {
@@ -952,7 +952,7 @@ private Dictionary<string, OpenApiSchema> CreateComponentSchemas()
             Dictionary<string, OpenApiSchema> schemas = new();
 
             // for rest scenario we need the default datasource name.
-            string defaultDataSourceName = _runtimeConfig.DefaultDataSourceName;
+            string defaultDataSourceName = _runtimeConfig.GetDefaultDataSourceName();
             ISqlMetadataProvider metadataProvider = _metadataProviderFactory.GetMetadataProvider(defaultDataSourceName);
 
             foreach (KeyValuePair<string, DatabaseObject> entityDbMetadataMap in metadataProvider.EntityToDatabaseObject)

src/Core/Services/RestService.cs

@@ -212,7 +212,7 @@ RequestValidator requestValidator
         private async Task<IActionResult> DispatchQuery(RestRequestContext context, DatabaseType databaseType)
         {
             IQueryEngine queryEngine = _queryEngineFactory.GetQueryEngine(databaseType);
-            string defaultDataSourceName = _runtimeConfigProvider.GetConfig().DefaultDataSourceName;
+            string defaultDataSourceName = _runtimeConfigProvider.GetConfig().GetDefaultDataSourceName();
 
             if (context is FindRequestContext findRequestContext)
             {
@@ -237,7 +237,7 @@ private async Task<IActionResult> DispatchQuery(RestRequestContext context, Data
         private Task<IActionResult?> DispatchMutation(RestRequestContext context, DatabaseType databaseType)
         {
             IMutationEngine mutationEngine = _mutationEngineFactory.GetMutationEngine(databaseType);
-            string defaultDataSourceName = _runtimeConfigProvider.GetConfig().DefaultDataSourceName;
+            string defaultDataSourceName = _runtimeConfigProvider.GetConfig().GetDefaultDataSourceName();
             return context switch
             {
                 StoredProcedureRequestContext => mutationEngine.ExecuteAsync((StoredProcedureRequestContext)context, defaultDataSourceName),
@@ -437,7 +437,7 @@ public bool TryGetRestRouteFromConfig([NotNullWhen(true)] out string? configured
         public (string, string) GetEntityNameAndPrimaryKeyRouteFromRoute(string routeAfterPathBase)
         {
 
-            string dataSourceName = _runtimeConfigProvider.GetConfig().DefaultDataSourceName;
+            string dataSourceName = _runtimeConfigProvider.GetConfig().GetDefaultDataSourceName();
             ISqlMetadataProvider sqlMetadataProvider = _sqlMetadataProviderFactory.GetMetadataProvider(dataSourceName);
 
             // Split routeAfterPath on the first occurrence of '/', if we get back 2 elements

src/Service.Tests/Authorization/AuthorizationHelpers.cs

@@ -55,7 +55,7 @@ public static AuthorizationResolver InitAuthorizationResolver(RuntimeConfig runt
             metadataProvider.Setup(x => x.GetEntityName(It.IsAny<string>()))
                 .Returns((string entity) => entity);
             Mock<IMetadataProviderFactory> metadataProviderFactory = new();
-            string dataSourceName = runtimeConfigProvider.GetConfig().DefaultDataSourceName;
+            string dataSourceName = runtimeConfigProvider.GetConfig().GetDefaultDataSourceName();
             metadataProviderFactory.Setup(x => x.GetMetadataProvider(dataSourceName)).Returns(metadataProvider.Object);
 
             return new AuthorizationResolver(runtimeConfigProvider, metadataProviderFactory.Object);

src/Service.Tests/CosmosTests/CosmosClientTests.cs

@@ -18,7 +18,7 @@ public class CosmosClientTests : TestBase
         public void CosmosClientDefaultUserAgent()
         {
             CosmosClientProvider cosmosClientProvider = _application.Services.GetService<CosmosClientProvider>();
-            CosmosClient client = cosmosClientProvider.Clients[cosmosClientProvider.RuntimeConfigProvider.GetConfig().DefaultDataSourceName];
+            CosmosClient client = cosmosClientProvider.Clients[cosmosClientProvider.RuntimeConfigProvider.GetConfig().GetDefaultDataSourceName()];
             // Validate results
             Assert.AreEqual(client.ClientOptions.ApplicationName, ProductInfo.DEFAULT_APP_NAME);
         }
@@ -33,7 +33,7 @@ public void CosmosClientEnvUserAgent()
             WebApplicationFactory<Startup> application = SetupTestApplicationFactory();
 
             CosmosClientProvider cosmosClientProvider = application.Services.GetService<CosmosClientProvider>();
-            CosmosClient client = cosmosClientProvider.Clients[cosmosClientProvider.RuntimeConfigProvider.GetConfig().DefaultDataSourceName];
+            CosmosClient client = cosmosClientProvider.Clients[cosmosClientProvider.RuntimeConfigProvider.GetConfig().GetDefaultDataSourceName()];
             // Validate results
             Assert.AreEqual(client.ClientOptions.ApplicationName, appName);
         }

src/Service.Tests/CosmosTests/MutationTests.cs

@@ -50,7 +50,7 @@ public class MutationTests : TestBase
         public void TestFixtureSetup()
         {
             CosmosClientProvider cosmosClientProvider = _application.Services.GetService<CosmosClientProvider>();
-            CosmosClient cosmosClient = cosmosClientProvider.Clients[cosmosClientProvider.RuntimeConfigProvider.GetConfig().DefaultDataSourceName];
+            CosmosClient cosmosClient = cosmosClientProvider.Clients[cosmosClientProvider.RuntimeConfigProvider.GetConfig().GetDefaultDataSourceName()];
             cosmosClient.CreateDatabaseIfNotExistsAsync(DATABASE_NAME).Wait();
             cosmosClient.GetDatabase(DATABASE_NAME).CreateContainerIfNotExistsAsync(_containerName, "/id").Wait();
             CreateItems(DATABASE_NAME, _containerName, 10);
@@ -740,7 +740,7 @@ type Planet @model(name:""Planet"") {
         public void TestFixtureTearDown()
         {
             CosmosClientProvider cosmosClientProvider = _application.Services.GetService<CosmosClientProvider>();
-            CosmosClient cosmosClient = cosmosClientProvider.Clients[cosmosClientProvider.RuntimeConfigProvider.GetConfig().DefaultDataSourceName];
+            CosmosClient cosmosClient = cosmosClientProvider.Clients[cosmosClientProvider.RuntimeConfigProvider.GetConfig().GetDefaultDataSourceName()];
             cosmosClient.GetDatabase(DATABASE_NAME).GetContainer(_containerName).DeleteContainerAsync().Wait();
         }
     }