Placeholder for Worker Directory Path (#8473)

Added log for formatting arguments

Author: shreyas-gopalakrishna

src/WebJobs.Script/Workers/Rpc/Configuration/RpcWorkerConfigFactory.cs

@@ -130,6 +130,7 @@ internal void AddProvider(string workerDir)
                     if (ShouldAddWorkerConfig(workerDescription.Language))
                     {
                         workerDescription.FormatWorkerPathIfNeeded(_systemRuntimeInformation, _environment, _logger);
+                        workerDescription.FormatArgumentsIfNeeded(_logger);
                         workerDescription.ThrowIfFileNotExists(workerDescription.DefaultWorkerPath, nameof(workerDescription.DefaultWorkerPath));
                         workerDescription.ExpandEnvironmentVariables();
 
@@ -246,4 +247,4 @@ internal void ReadLanguageWorkerFile(string workerPath)
             }
         }
     }
-}
+}

src/WebJobs.Script/Workers/Rpc/RpcWorkerConstants.cs

@@ -33,6 +33,7 @@ public static class RpcWorkerConstants
         public const string OSPlaceholder = "{os}";
         public const string ArchitecturePlaceholder = "{architecture}";
         public const string RuntimeVersionPlaceholder = "%" + FunctionWorkerRuntimeVersionSettingName + "%";
+        public const string WorkerDirectoryPath = "{workerDirectoryPath}";
 
         // Rpc message length
         public const int DefaultMaxMessageLengthBytes = int.MaxValue;

src/WebJobs.Script/Workers/Rpc/RpcWorkerDescription.cs

@@ -203,6 +203,24 @@ internal void FormatWorkerPathIfNeeded(ISystemRuntimeInformation systemRuntimeIn
                              .Replace(RpcWorkerConstants.RuntimeVersionPlaceholder, DefaultRuntimeVersion);
         }
 
+        internal void FormatArgumentsIfNeeded(ILogger logger)
+        {
+            if (Arguments?.Any() == false)
+            {
+                return;
+            }
+
+            for (int i = 0; i < Arguments.Count; i++)
+            {
+                if (!string.IsNullOrEmpty(Arguments[i]))
+                {
+                    Arguments[i] = Arguments[i].Replace(RpcWorkerConstants.WorkerDirectoryPath, WorkerDirectory);
+                }
+            }
+
+            logger.LogDebug($"Worker description arguments after formatting: {Arguments}");
+        }
+
         internal bool ShouldFormatWorkerPath(string workerPath)
         {
             if (string.IsNullOrEmpty(workerPath))

test/WebJobs.Script.Tests/Workers/Rpc/RpcWorkerConfigTests.cs

@@ -615,6 +615,58 @@ public void LanguageWorker_FormatWorkerPath_DefualtRuntimeVersion_WorkerRuntimeM
             Assert.Equal("3.7", workerDescription.DefaultRuntimeVersion);
         }
 
+        public static IEnumerable<object[]> RpcWorkerDescriptionArgumentsWithPlaceholder()
+        {
+            yield return new object[] { "D:/Code/Host/workers/java", new List<string> { RpcWorkerConstants.WorkerDirectoryPath } };
+            yield return new object[] { "/java", new List<string> { string.Concat("/path/version/", RpcWorkerConstants.WorkerDirectoryPath) } };
+            yield return new object[] { "/", new List<string> { string.Concat("version/", RpcWorkerConstants.WorkerDirectoryPath) } };
+        }
+
+        [Theory]
+        [MemberData(nameof(RpcWorkerDescriptionArgumentsWithPlaceholder))]
+        public void LanguageWorker_FormatArguments_ReplacePlaceholder(string workerDirectory, List<string> arguments)
+        {
+            RpcWorkerDescription workerDescription = new RpcWorkerDescription()
+            {
+                Arguments = arguments,
+                DefaultExecutablePath = "python",
+                WorkerDirectory = workerDirectory,
+                Language = "python"
+            };
+            workerDescription.FormatArgumentsIfNeeded(new TestLogger(testLanguage));
+
+            for (int i = 0; i < arguments.Count; i++)
+            {
+                Assert.Contains(workerDirectory, workerDescription.Arguments[i]);
+            }
+        }
+
+        public static IEnumerable<object[]> RpcWorkerDescriptionArgumentsWithoutPlaceholder()
+        {
+            yield return new object[] { "D:/Code/Host/workers/java", new List<string> { } };
+            yield return new object[] { "D:/Code/Host/workers/", new List<string> { string.Empty, null } };
+            yield return new object[] { "/worker/path", new List<string> { string.Empty, null, "/path/version/" } };
+        }
+
+        [Theory]
+        [MemberData(nameof(RpcWorkerDescriptionArgumentsWithoutPlaceholder))]
+        public void LanguageWorker_FormatArguments_DoNotReplacePlaceholder(string workerDirectory, List<string> arguments)
+        {
+            RpcWorkerDescription workerDescription = new RpcWorkerDescription()
+            {
+                Arguments = arguments,
+                DefaultExecutablePath = "python",
+                WorkerDirectory = workerDirectory,
+                Language = "python"
+            };
+            workerDescription.FormatArgumentsIfNeeded(new TestLogger(testLanguage));
+
+            for (int i = 0; i < arguments.Count; i++)
+            {
+                Assert.DoesNotContain(workerDirectory, workerDescription.Arguments[i]);
+            }
+        }
+
         private IEnumerable<RpcWorkerConfig> TestReadWorkerProviderFromConfig(IEnumerable<TestRpcWorkerConfig> configs, ILogger testLogger, TestMetricsLogger testMetricsLogger, string language = null, Dictionary<string, string> keyValuePairs = null, bool appSvcEnv = false)
         {
             Mock<IEnvironment> mockEnvironment = new Mock<IEnvironment>();