(#217) Support non-AzureWebJobsStorage connection strings (#219)

* #217, implementation for inproc * #217, implementation for isolated * #217, implementation for vscode ext
microsoft · Nov 2, 2024 · 88455a5 · 88455a5
1 parent 9a99d06
commit 88455a5
Show file tree

Hide file tree

Showing 9 changed files with 58 additions and 8 deletions.
diff --git a/durablefunctionsmonitor-vscodeext/src/MonitorViewList.ts b/durablefunctionsmonitor-vscodeext/src/MonitorViewList.ts
@@ -115,7 +115,7 @@ export class MonitorViewList {
         return this._monitorViews[keys[0]];
     }
 
-    // Parses local project files and tries to infer connction settings from them
+    // Parses local project files and tries to infer connection settings from them
     getStorageConnectionSettingsFromCurrentProject(defaultTaskHubName?: string, projectPath?: string): StorageConnectionSettings | null {
 
         const hostJson = this.readHostJson(projectPath);
@@ -158,7 +158,7 @@ export class MonitorViewList {
             return new StorageConnectionSettings(ConnStringUtils.ExpandEmulatorShortcutIfNeeded(storageConnString), hubName, hubsConnString);
         }
 
-        const storageConnString = this.getValueFromLocalSettings('AzureWebJobsStorage', projectPath);
+        const storageConnString = this.getValueFromLocalSettings(hostJson.connectionStringName || 'AzureWebJobsStorage', projectPath);
         if (!storageConnString) {
             return null;
         }
@@ -512,6 +512,8 @@ export class MonitorViewList {
                             result.connectionStringName = durableTask.storageProvider.StorageConnectionName || 'AzureWebJobsStorage';
                             result.otherConnectionStringName = durableTask.storageProvider.EventHubsConnectionName || 'EventHubsConnection';
                         break;
+                        default:
+                            result.connectionStringName = durableTask.storageProvider.connectionStringName;
                     }
                 }
             }

diff --git a/durablefunctionsmonitor.dotnetbackend/Common/Auth.cs b/durablefunctionsmonitor.dotnetbackend/Common/Auth.cs
@@ -204,7 +204,7 @@ public static async Task<HashSet<string>> GetAllowedTaskHubNamesAsync()
             try
             {
                 var hubNames = new HashSet<string>(
-                    await DfmEndpoint.ExtensionPoints.GetTaskHubNamesRoutine(EnvVariableNames.AzureWebJobsStorage),
+                    await DfmEndpoint.ExtensionPoints.GetTaskHubNamesRoutine(DfmEndpoint.StorageConnStringEnvVarName),
                     StringComparer.InvariantCultureIgnoreCase
                 );
 

diff --git a/durablefunctionsmonitor.dotnetbackend/Common/Globals.cs b/durablefunctionsmonitor.dotnetbackend/Common/Globals.cs
@@ -100,7 +100,7 @@ public static string GetFullConnectionStringEnvVariableName(string connName)
         {
             if (IsDefaultConnectionStringName(connName))
             {
-                return EnvVariableNames.AzureWebJobsStorage;
+                return DfmEndpoint.StorageConnStringEnvVarName;
             }
             else
             {

diff --git a/durablefunctionsmonitor.dotnetbackend/Common/Setup.cs b/durablefunctionsmonitor.dotnetbackend/Common/Setup.cs
@@ -8,6 +8,7 @@
 using System.Reflection;
 using System.Threading.Tasks;
 using Microsoft.Azure.WebJobs.Extensions.DurableTask;
+using Newtonsoft.Json.Linq;
 
 namespace DurableFunctionsMonitor.DotNetBackend
 {
@@ -185,6 +186,22 @@ public static void Setup(DfmSettings settings = null, DfmExtensionPoints extensi
             {
                 _customUserAgent = $"DurableFunctionsMonitor-Injected/{GetVersion()}";
             }
+
+            // Checking host.json for a custom dedicated Storage account
+            string hostJsonFileName = Globals.GetHostJsonPath();
+            if (File.Exists(hostJsonFileName))
+            {
+                dynamic hostJson = JObject.Parse(File.ReadAllText(hostJsonFileName));
+
+                string connStringNameFromHostJson = 
+                    hostJson?.extensions?.durableTask?.storageProvider?.azureStorageConnectionStringName ??
+                    hostJson?.extensions?.durableTask?.storageProvider?.connectionStringName;
+
+                if (!string.IsNullOrEmpty(connStringNameFromHostJson))
+                {
+                    _storageConnStringEnvVarName = connStringNameFromHostJson;
+                }
+            }
         }
 
         internal static DfmSettings Settings 
@@ -220,9 +237,18 @@ internal static string CustomUserAgent
             get { return _customUserAgent; }
         }
 
+        /// <summary>
+        /// Provides support for dedicated Storage accounts (different from AzureWebJobsStorage)
+        /// </summary>
+        internal static string StorageConnStringEnvVarName
+        {
+            get { return _storageConnStringEnvVarName; }
+        }
+
         private static DfmSettings _settings = null;
         private static DfmExtensionPoints _extensionPoints = new DfmExtensionPoints();
         private static string _customUserAgent;
+        private static string _storageConnStringEnvVarName = EnvVariableNames.AzureWebJobsStorage;
 
         /// <summary>
         /// Checks whether we should do our internal initialization (Standalone mode)

diff --git a/durablefunctionsmonitor.dotnetbackend/Functions/TaskHubNames.cs b/durablefunctionsmonitor.dotnetbackend/Functions/TaskHubNames.cs
@@ -30,7 +30,7 @@ ILogger log
                 if (!string.IsNullOrEmpty(dfmNonce))
                 {
                     // For VsCode loading Task Hubs directly and without validation
-                    hubNames = await DfmEndpoint.ExtensionPoints.GetTaskHubNamesRoutine(EnvVariableNames.AzureWebJobsStorage);
+                    hubNames = await DfmEndpoint.ExtensionPoints.GetTaskHubNamesRoutine(DfmEndpoint.StorageConnStringEnvVarName);
                 }
                 else
                 {

diff --git a/durablefunctionsmonitor.dotnetisolated.core/Common/Auth.cs b/durablefunctionsmonitor.dotnetisolated.core/Common/Auth.cs
@@ -200,7 +200,7 @@ public static async Task<HashSet<string>> GetAllowedTaskHubNamesAsync(DfmExtensi
             try
             {
                 var hubNames = new HashSet<string>(
-                    await extensionPoints.GetTaskHubNamesRoutine(EnvVariableNames.AzureWebJobsStorage),
+                    await extensionPoints.GetTaskHubNamesRoutine(Globals.StorageConnStringEnvVarName),
                     StringComparer.InvariantCultureIgnoreCase
                 );
 

diff --git a/durablefunctionsmonitor.dotnetisolated.core/Common/ExtensionMethods.cs b/durablefunctionsmonitor.dotnetisolated.core/Common/ExtensionMethods.cs
@@ -7,6 +7,7 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
+using Newtonsoft.Json.Linq;
 
 namespace DurableFunctionsMonitor.DotNetIsolated
 {
@@ -52,6 +53,22 @@ public static IFunctionsWorkerApplicationBuilder UseDurableFunctionsMonitor(
             builder.Services.AddSingleton(settings);
             builder.Services.AddSingleton(extensionPoints);
 
+            // Checking host.json for a custom dedicated Storage account
+            string hostJsonFileName = Globals.GetHostJsonPath();
+            if (File.Exists(hostJsonFileName))
+            {
+                dynamic hostJson = JObject.Parse(File.ReadAllText(hostJsonFileName));
+
+                string connStringNameFromHostJson = 
+                    hostJson?.extensions?.durableTask?.storageProvider?.azureStorageConnectionStringName ??
+                    hostJson?.extensions?.durableTask?.storageProvider?.connectionStringName;
+
+                if (!string.IsNullOrEmpty(connStringNameFromHostJson))
+                {
+                    Globals.StorageConnStringEnvVarName = connStringNameFromHostJson;
+                }
+            }
+
             // Adding middleware
             builder.UseWhen
             (

diff --git a/durablefunctionsmonitor.dotnetisolated.core/Common/Globals.cs b/durablefunctionsmonitor.dotnetisolated.core/Common/Globals.cs
@@ -65,6 +65,11 @@ static class Globals
 
         public const string DfmModeContextValue = "DfmModeContextValue";
 
+        /// <summary>
+        /// Provides support for dedicated Storage accounts (different from AzureWebJobsStorage)
+        /// </summary>
+        internal static string StorageConnStringEnvVarName = EnvVariableNames.AzureWebJobsStorage;
+
         public static void SplitConnNameAndHubName(string connAndHubName, out string connName, out string hubName)
         {
             int pos = connAndHubName.LastIndexOf("-");
@@ -99,7 +104,7 @@ public static string GetFullConnectionStringEnvVariableName(string connName)
         {
             if (IsDefaultConnectionStringName(connName))
             {
-                return EnvVariableNames.AzureWebJobsStorage;
+                return StorageConnStringEnvVarName;
             }
             else
             {

diff --git a/durablefunctionsmonitor.dotnetisolated.core/Functions/TaskHubNames.cs b/durablefunctionsmonitor.dotnetisolated.core/Functions/TaskHubNames.cs
@@ -25,7 +25,7 @@ public async Task<HttpResponseData> DfmGetTaskHubNamesFunction(
             if (!string.IsNullOrEmpty(dfmNonce))
             {
                 // For VsCode loading Task Hubs directly and without validation
-                hubNames = await this.ExtensionPoints.GetTaskHubNamesRoutine(EnvVariableNames.AzureWebJobsStorage);
+                hubNames = await this.ExtensionPoints.GetTaskHubNamesRoutine(Globals.StorageConnStringEnvVarName);
             }
             else
             {