Allow FileWatcher watch directories to be configured (#608)

mathewc · mathewc · commit 4356ab514546 · 2016-08-26T14:04:31.000-07:00
diff --git a/WebJobs.Script.sln b/WebJobs.Script.sln
@@ -349,6 +349,12 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "WebHook-Azure-FSharp", "Web
 		sample\WebHook-Azure-FSharp\run.fsx = sample\WebHook-Azure-FSharp\run.fsx
 	EndProjectSection
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Shared", "Shared", "{C9FCBCFD-0AD1-44B0-A15B-EE2F5219A345}"
+	ProjectSection(SolutionItems) = preProject
+		sample\Shared\Message.csx = sample\Shared\Message.csx
+		sample\Shared\Order.csx = sample\Shared\Order.csx
+	EndProjectSection
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -443,5 +449,6 @@ Global
 		{5C25CC30-5E4B-4E17-A0CB-AB0E72B70D8E} = {FF9C0818-30D3-437A-A62D-7A61CA44F459}
 		{49A40362-2EB9-424C-B605-6BEE16A1C8B6} = {FF9C0818-30D3-437A-A62D-7A61CA44F459}
 		{94B16BEB-70BD-4357-A21A-D1E70C8CDDF1} = {FF9C0818-30D3-437A-A62D-7A61CA44F459}
+		{C9FCBCFD-0AD1-44B0-A15B-EE2F5219A345} = {FF9C0818-30D3-437A-A62D-7A61CA44F459}
 	EndGlobalSection
 EndGlobal
diff --git a/sample/QueueTrigger-CSharp/run.csx b/sample/QueueTrigger-CSharp/run.csx
@@ -1,3 +1,5 @@
+#load "..\Shared\Message.csx"
+
 using System;
 using System.Linq;
 using System.Threading.Tasks;
@@ -8,10 +10,4 @@ public static void Run(Message message, out string result, TraceWriter log)
     log.Info($"C# Queue trigger function processed message: {message.Id}");
 
     result = message.Value;
-}
-
-public class Message
-{
-    public string Id { get; set; }
-    public string Value { get; set; }
 }
diff --git a/sample/SendGrid-CSharp/run.csx b/sample/SendGrid-CSharp/run.csx
@@ -1,4 +1,5 @@
 #r "SendGridMail"
+#load "..\Shared\Message.csx"
 
 using System;
 using SendGrid;
@@ -14,11 +15,4 @@ public static void Run(Order order, out SendGridMessage message, TraceWriter log
         Text = string.Format("{0}, your order ({1}) is being processed!", order.CustomerName, order.OrderId)
     };
     message.AddTo(order.CustomerEmail);
-}
-
-public class Order
-{
-    public string OrderId { get; set; }
-    public string CustomerName { get; set; }
-    public string CustomerEmail { get; set; }
 }
diff --git a/sample/Shared/Message.csx b/sample/Shared/Message.csx
@@ -0,0 +1,5 @@
+public class Message
+{
+    public string Id { get; set; }
+    public string Value { get; set; }
+}
diff --git a/sample/Shared/Order.csx b/sample/Shared/Order.csx
@@ -0,0 +1,6 @@
+public class Order
+{
+    public string OrderId { get; set; }
+    public string CustomerName { get; set; }
+    public string CustomerEmail { get; set; }
+}
diff --git a/sample/host.json b/sample/host.json
@@ -1,5 +1,6 @@
 {
     "id": "5a709861cab44e68bfed5d2c2fe7fc0c",
+    "watchDirectories": [ "Shared" ],
     "sendGrid": {
         "from": "Azure Functions <samples@functions.com>"
     }
diff --git a/src/WebJobs.Script/Config/ScriptHostConfiguration.cs b/src/WebJobs.Script/Config/ScriptHostConfiguration.cs
@@ -2,6 +2,7 @@
 // Licensed under the MIT License. See License.txt in the project root for license information.
 
 using System;
+using System.Collections.Generic;
 using System.Collections.ObjectModel;
 using System.IO;
 using Microsoft.Azure.WebJobs.Host;
@@ -48,6 +49,14 @@ public ScriptHostConfiguration()
         /// </summary>
         public bool FileWatchingEnabled { get; set; }
 
+        /// <summary>
+        /// Gets the or sets the collection of directories (relative to RootScriptPath) that
+        /// should be monitored for changes. If FileWatchingEnabled is true, these directories
+        /// will be monitored. When a file is added/modified/deleted in any of these
+        /// directories, the host will restart.
+        /// </summary>
+        public ICollection<string> WatchDirectories { get; set; }
+
         /// <summary>
         /// Gets or sets a value governing when logs should be written to disk.
         /// When enabled, logs will be written to the directory specified by 
@@ -61,12 +70,12 @@ public ScriptHostConfiguration()
         /// function directories. When left null (the default) all discovered functions will
         /// be run.
         /// </summary>
-        public Collection<string> Functions { get; set; }
+        public ICollection<string> Functions { get; set; }
 
         /// <summary>
         /// Gets the set of <see cref="ScriptBindingProviders"/> to use when loading functions.
         /// </summary>
         [CLSCompliant(false)]
-        public Collection<ScriptBindingProvider> BindingProviders { get; internal set; }
+        public ICollection<ScriptBindingProvider> BindingProviders { get; internal set; }
     }
 }
diff --git a/src/WebJobs.Script/Description/DotNet/ExtensionSharedAssemblyProvider.cs b/src/WebJobs.Script/Description/DotNet/ExtensionSharedAssemblyProvider.cs
@@ -17,13 +17,13 @@ namespace Microsoft.Azure.WebJobs.Script.Description
     [CLSCompliant(false)]
     public class ExtensionSharedAssemblyProvider : ISharedAssemblyProvider
     {
-        private readonly Collection<ScriptBindingProvider> _bindingProviders;
+        private readonly ICollection<ScriptBindingProvider> _bindingProviders;
         
         /// <summary>
         /// Constructs a new instance.
         /// </summary>
         /// <param name="bindingProviders">The collection of <see cref="ScriptBindingProvider"/>s.</param>
-        public ExtensionSharedAssemblyProvider(Collection<ScriptBindingProvider> bindingProviders)
+        public ExtensionSharedAssemblyProvider(ICollection<ScriptBindingProvider> bindingProviders)
         {
             _bindingProviders = bindingProviders;
         }
diff --git a/src/WebJobs.Script/Description/DotNet/FunctionMetadataResolver.cs b/src/WebJobs.Script/Description/DotNet/FunctionMetadataResolver.cs
@@ -70,7 +70,7 @@ public sealed class FunctionMetadataResolver : MetadataReferenceResolver, IFunct
                 "Microsoft.Azure.WebJobs.Host"
             };
 
-        public FunctionMetadataResolver(FunctionMetadata metadata, Collection<ScriptBindingProvider> bindingProviders, TraceWriter traceWriter)
+        public FunctionMetadataResolver(FunctionMetadata metadata, ICollection<ScriptBindingProvider> bindingProviders, TraceWriter traceWriter)
         {
             _functionMetadata = metadata;
             _traceWriter = traceWriter;
diff --git a/src/WebJobs.Script/GlobalSuppressions.cs b/src/WebJobs.Script/GlobalSuppressions.cs
@@ -91,4 +91,6 @@
 [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Reliability", "CA2000:Dispose objects before losing scope", Scope = "member", Target = "Microsoft.Azure.WebJobs.Script.Binding.Http.HttpTriggerAttributeBindingProvider+HttpTriggerBinding.#ToParameterDescriptor()")]
 [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Reliability", "CA2000:Dispose objects before losing scope", Scope = "member", Target = "Microsoft.Azure.WebJobs.Script.Binding.Http.HttpTriggerAttributeBindingProvider+HttpTriggerBinding.#FromInvokeString(System.String)")]
 [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Maintainability", "CA1502:AvoidExcessiveComplexity", Scope = "member", Target = "Microsoft.Azure.WebJobs.Script.Description.DotNetFunctionDescriptorProvider.#GetFunctionParameters(Microsoft.Azure.WebJobs.Script.Description.IFunctionInvoker,Microsoft.Azure.WebJobs.Script.Description.FunctionMetadata,Microsoft.Azure.WebJobs.Script.Description.BindingMetadata,System.Collections.ObjectModel.Collection`1<System.Reflection.Emit.CustomAttributeBuilder>,System.Collections.ObjectModel.Collection`1<Microsoft.Azure.WebJobs.Script.Binding.FunctionBinding>,System.Collections.ObjectModel.Collection`1<Microsoft.Azure.WebJobs.Script.Binding.FunctionBinding>)")]
-[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Reliability", "CA2000:Dispose objects before losing scope", Scope = "member", Target = "Microsoft.Azure.WebJobs.Script.FunctionTraceWriterFactory.#Create()")]
+[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Reliability", "CA2000:Dispose objects before losing scope", Scope = "member", Target = "Microsoft.Azure.WebJobs.Script.FunctionTraceWriterFactory.#Create()")]
+[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly", Scope = "member", Target = "Microsoft.Azure.WebJobs.Script.ScriptHostConfiguration.#WatchDirectories")]
+
diff --git a/src/WebJobs.Script/Host/ScriptHost.cs b/src/WebJobs.Script/Host/ScriptHost.cs
@@ -732,10 +732,26 @@ internal static void ApplyConfiguration(JObject config, ScriptHostConfiguration
                 throw new InvalidOperationException("An 'id' must be specified in the host configuration.");
             }
 
-            JToken watchFiles = (JToken)config["watchFiles"];
-            if (watchFiles != null && watchFiles.Type == JTokenType.Boolean)
+            JToken fileWatchingEnabled = (JToken)config["fileWatchingEnabled"];
+            if (fileWatchingEnabled != null && fileWatchingEnabled.Type == JTokenType.Boolean)
             {
-                scriptConfig.FileWatchingEnabled = (bool)watchFiles;
+                scriptConfig.FileWatchingEnabled = (bool)fileWatchingEnabled;
+            }
+
+            // Configure the set of watched directories, adding the standard built in
+            // set to any the user may have specified
+            if (scriptConfig.WatchDirectories == null)
+            {
+                scriptConfig.WatchDirectories = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
+            }
+            scriptConfig.WatchDirectories.Add("node_modules");
+            JToken watchDirectories = config["watchDirectories"];
+            if (watchDirectories != null && watchDirectories.Type == JTokenType.Array)
+            {
+                foreach (JToken directory in watchDirectories.Where(p => p.Type == JTokenType.String))
+                {
+                    scriptConfig.WatchDirectories.Add((string)directory);
+                }
             }
 
             // Apply Singleton configuration
@@ -891,9 +907,17 @@ private void NotifyInvoker(string functionName, Exception ex)
 
         private void OnFileChanged(object sender, FileSystemEventArgs e)
         {
+            string directory = GetRelativeDirectory(e.FullPath, ScriptConfig.RootScriptPath);
+            bool isWatchedDirectory = ScriptConfig.WatchDirectories.Contains(directory);
+
+            // We will perform a host restart in the following cases:
+            // - the file change was under one of the configured watched directories (e.g. node_modules, shared code directories, etc.)
+            // - the host.json file was changed
+            // - a function.json file was changed
+            // - a function directory was added/removed
             string fileName = Path.GetFileName(e.Name);
-
-            if (((string.Compare(fileName, ScriptConstants.HostMetadataFileName, StringComparison.OrdinalIgnoreCase) == 0) ||
+            if (isWatchedDirectory ||
+                ((string.Compare(fileName, ScriptConstants.HostMetadataFileName, StringComparison.OrdinalIgnoreCase) == 0) ||
                 string.Compare(fileName, ScriptConstants.FunctionMetadataFileName, StringComparison.OrdinalIgnoreCase) == 0) ||
                 (Directory.EnumerateDirectories(ScriptConfig.RootScriptPath).Count() != _directoryCountSnapshot))
             {
@@ -903,6 +927,23 @@ private void OnFileChanged(object sender, FileSystemEventArgs e)
             }
         }
 
+        internal static string GetRelativeDirectory(string path, string scriptRoot)
+        {
+            if (path.StartsWith(scriptRoot))
+            {
+                string directory = path.Substring(scriptRoot.Length).TrimStart(Path.DirectorySeparatorChar);
+                int idx = directory.IndexOf(Path.DirectorySeparatorChar);
+                if (idx != -1)
+                {
+                    directory = directory.Substring(0, idx);
+                }
+
+                return directory;
+            }
+
+            return string.Empty;
+        }
+
         private static bool IsDisabled(JToken isDisabledValue)
         {
             if (isDisabledValue != null)
diff --git a/test/WebJobs.Script.Tests/ScriptHostTests.cs b/test/WebJobs.Script.Tests/ScriptHostTests.cs
@@ -5,6 +5,7 @@
 using System.Collections.ObjectModel;
 using System.Diagnostics;
 using System.IO;
+using System.Linq;
 using System.Reflection;
 using System.Threading;
 using System.Threading.Tasks;
@@ -26,6 +27,15 @@ public ScriptHostTests(TestFixture fixture)
             _fixture = fixture;
         }
 
+        [Theory]
+        [InlineData(@"C:\Functions\Scripts\Shared\Test.csx", "Shared")]
+        [InlineData(@"C:\Functions\Scripts\Shared\Sub1\Sub2\Test.csx", "Shared")]
+        [InlineData(@"C:\Functions\Scripts\Shared", "Shared")]
+        public static void GetRelativeDirectory_ReturnsExpectedDirectoryName(string path, string expected)
+        {
+            Assert.Equal(expected, ScriptHost.GetRelativeDirectory(path, @"C:\Functions\Scripts"));
+        }
+
         [Fact]
         public async Task OnDebugModeFileChanged_TriggeredWhenDebugFileUpdated()
         {
@@ -380,6 +390,38 @@ public void ApplyConfiguration_Tracing()
             Assert.Equal(FileLoggingMode.DebugOnly, scriptConfig.FileLoggingMode);
         }
 
+        [Fact]
+        public void ApplyConfiguration_FileWatching()
+        {
+            JObject config = new JObject();
+            config["id"] = ID;
+
+            ScriptHostConfiguration scriptConfig = new ScriptHostConfiguration();
+            Assert.True(scriptConfig.FileWatchingEnabled);
+
+            scriptConfig = new ScriptHostConfiguration();
+            config["fileWatchingEnabled"] = new JValue(true);
+            ScriptHost.ApplyConfiguration(config, scriptConfig);
+            Assert.True(scriptConfig.FileWatchingEnabled);
+            Assert.Equal(1, scriptConfig.WatchDirectories.Count);
+            Assert.Equal("node_modules", scriptConfig.WatchDirectories.ElementAt(0));
+
+            scriptConfig = new ScriptHostConfiguration();
+            config["fileWatchingEnabled"] = new JValue(false);
+            ScriptHost.ApplyConfiguration(config, scriptConfig);
+            Assert.False(scriptConfig.FileWatchingEnabled);
+
+            scriptConfig = new ScriptHostConfiguration();
+            config["fileWatchingEnabled"] = new JValue(true);
+            config["watchDirectories"] = new JArray("Shared", "Tools");
+            ScriptHost.ApplyConfiguration(config, scriptConfig);
+            Assert.True(scriptConfig.FileWatchingEnabled);
+            Assert.Equal(3, scriptConfig.WatchDirectories.Count);
+            Assert.Equal("node_modules", scriptConfig.WatchDirectories.ElementAt(0));
+            Assert.Equal("Shared", scriptConfig.WatchDirectories.ElementAt(1));
+            Assert.Equal("Tools", scriptConfig.WatchDirectories.ElementAt(2));
+        }
+
         [Fact]
         public void ApplyFunctionsFilter()
         {
@@ -393,8 +435,8 @@ public void ApplyFunctionsFilter()
 
             ScriptHost.ApplyConfiguration(config, scriptConfig);
             Assert.Equal(2, scriptConfig.Functions.Count);
-            Assert.Equal("Function1", scriptConfig.Functions[0]);
-            Assert.Equal("Function2", scriptConfig.Functions[1]);
+            Assert.Equal("Function1", scriptConfig.Functions.ElementAt(0));
+            Assert.Equal("Function2", scriptConfig.Functions.ElementAt(1));
         }
 
         [Fact]

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"id": "5a709861cab44e68bfed5d2c2fe7fc0c",`
	`3`	`+ "watchDirectories": [ "Shared" ],`
`3`	`4`	`"sendGrid": {`
`4`	`5`	`"from": "Azure Functions <[email protected]>"`
`5`	`6`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,13 +17,13 @@ namespace Microsoft.Azure.WebJobs.Script.Description`
`17`	`17`	`[CLSCompliant(false)]`
`18`	`18`	`public class ExtensionSharedAssemblyProvider : ISharedAssemblyProvider`
`19`	`19`	`{`
`20`		`- private readonly Collection<ScriptBindingProvider> _bindingProviders;`
	`20`	`+ private readonly ICollection<ScriptBindingProvider> _bindingProviders;`
`21`	`21`
`22`	`22`	`/// <summary>`
`23`	`23`	`/// Constructs a new instance.`
`24`	`24`	`/// </summary>`
`25`	`25`	`/// <param name="bindingProviders">The collection of <see cref="ScriptBindingProvider"/>s.</param>`
`26`		`- public ExtensionSharedAssemblyProvider(Collection<ScriptBindingProvider> bindingProviders)`
	`26`	`+ public ExtensionSharedAssemblyProvider(ICollection<ScriptBindingProvider> bindingProviders)`
`27`	`27`	`{`
`28`	`28`	`_bindingProviders = bindingProviders;`
`29`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ public sealed class FunctionMetadataResolver : MetadataReferenceResolver, IFunct`
`70`	`70`	`"Microsoft.Azure.WebJobs.Host"`
`71`	`71`	`};`
`72`	`72`
`73`		`- public FunctionMetadataResolver(FunctionMetadata metadata, Collection<ScriptBindingProvider> bindingProviders, TraceWriter traceWriter)`
	`73`	`+ public FunctionMetadataResolver(FunctionMetadata metadata, ICollection<ScriptBindingProvider> bindingProviders, TraceWriter traceWriter)`
`74`	`74`	`{`
`75`	`75`	`_functionMetadata = metadata;`
`76`	`76`	`_traceWriter = traceWriter;`