added a bunch of comments

Author: TylerLeonhardt

examples/PSCoreApp/MyHttpTrigger/function.json

@@ -1,6 +1,5 @@
 {
   "disabled": false,
-  "entryPoint":"FunctionName",
   "bindings": [
     {
       "authLevel": "function",
@@ -15,7 +14,7 @@
     {
       "type": "http",
       "direction": "out",
-      "name": "$return"
+      "name": "res"
     }
   ]
 }

examples/PSCoreApp/MyHttpTrigger/run.ps1

@@ -1,6 +1,12 @@
-function FunctionName {
-    $global:res = $req.GetHttpResponseContext()
-    "hello verbose"
-    $res.Json('{"Hello":"World"}')
-    $res.SetHeader("foo", "bar")
+$name = 'World'
+if($req.Query.Name) {
+    $name = $req.Query.Name
+}
+
+Write-Verbose "Hello $name" -Verbose
+Write-Warning "Warning $name"
+
+$res = [HttpResponseContext]@{
+    Body = @{ Hello = $name }
+    ContentType = 'application/json'
 }

src/Azure.Functions.PowerShell.Worker.Messaging/FunctionMessagingClient.cs

@@ -21,6 +21,9 @@ public FunctionMessagingClient(string host, int port)
         public async Task WriteAsync(StreamingMessage message)
         {
             if(isDisposed) return;
+
+            // Wait for the handle to be released because we can't have
+            // more than one message being sent at the same time
             await _writeStreamHandle.WaitAsync();
             try
             {

src/Azure.Functions.PowerShell.Worker/Function/FunctionInfo.cs

@@ -24,12 +24,10 @@ public FunctionInfo(RpcFunctionMetadata metadata)
             {
                 Bindings.Add(binding.Key, binding.Value);
 
+                // Only add Out and InOut bindings to the OutputBindings
                 if (binding.Value.Direction != BindingInfo.Types.Direction.In)
                 {
                     if(binding.Value.Type == "http")
-                    {
-                        HttpOutputName = binding.Key;
-                    }if(binding.Value.Type == "http")
                     {
                         HttpOutputName = binding.Key;
                     }

src/Azure.Functions.PowerShell.Worker/Http/HttpRequestContext.cs

@@ -13,10 +13,5 @@ public class HttpRequestContext
         public MapField<string, string> Params {get; set;}
         public object Body {get; set;}
         public object RawBody {get; set;}
-
-        public HttpResponseContext GetHttpResponseContext()
-        {
-            return new HttpResponseContext();
-        }
     }
 }

src/Azure.Functions.PowerShell.Worker/Http/HttpResponseContext.cs

@@ -1,82 +1,15 @@
+using System.Collections;
 using Google.Protobuf.Collections;
 using Microsoft.Azure.WebJobs.Script.Grpc.Messages;
 
 namespace Microsoft.Azure.Functions.PowerShellWorker
 {
     public class HttpResponseContext
     {
-#region properties
         public string StatusCode {get; set;} = "200";
-        public MapField<string, string> Headers {get; set;} = new MapField<string,string>();
-        public TypedData Body {get; set;} = new TypedData { String = "" };
+        public Hashtable Headers {get; set;} = new Hashtable();
+        public object Body {get; set;}
+        public string ContentType {get; set;} = "text/plain";
         public bool EnableContentNegotiation {get; set;} = false;
-#endregion
-#region Helper functions for user to use to set data
-        public HttpResponseContext Header(string field, string value) =>
-            SetHeader(field, value);
-        public HttpResponseContext SetHeader(string field, string value)
-        {
-            Headers.Add(field, value);
-            return this;
-        }
-
-        public string GetHeader(string field) =>
-            Headers[field];
-
-        public HttpResponseContext RemoveHeader(string field)
-        {
-            Headers.Remove(field);
-            return this;
-        }
-
-        public HttpResponseContext Status(int statusCode) =>
-            SetStatus(statusCode);
-        public HttpResponseContext Status(string statusCode) =>
-            SetStatus(statusCode);
-        public HttpResponseContext SetStatus(int statusCode) =>
-            SetStatus(statusCode);
-        public HttpResponseContext SetStatus(string statusCode)
-        {
-            StatusCode = statusCode;
-            return this;
-        }
-
-        public HttpResponseContext Type(string type) =>
-            SetHeader("content-type", type);
-        public HttpResponseContext SetContentType(string type) =>
-            SetHeader("content-type", type);
-
-        public HttpResponseContext Send(int val)
-        {
-            Body = new TypedData
-            {
-                Int = val
-            };
-            return this;
-        }
-        public HttpResponseContext Send(double val)
-        {
-            Body = new TypedData
-            {
-                Double = val
-            };
-            return this;
-        }
-        public HttpResponseContext Send(string val)
-        {
-            Body = new TypedData
-            {
-                String = val
-            };
-            return this;
-        }
-        public HttpResponseContext Json(string val) {
-            Body = new TypedData
-            {
-                Json = val
-            };
-            return Type("application/json");
-        }
-#endregion
     }
 }

…owerShell.Worker/PowerShell/Host/Host.cs …er/PowerShell/Host/AzureFunctionsHost.cssrc/Azure.Functions.PowerShell.Worker/PowerShell/Host/Host.cs renamed to src/Azure.Functions.PowerShell.Worker/PowerShell/Host/AzureFunctionsHost.cs src/Azure.Functions.PowerShell.Worker/PowerShell/Host/Host.cs renamed to src/Azure.Functions.PowerShell.Worker/PowerShell/Host/AzureFunctionsHost.cs

@@ -10,8 +10,11 @@ namespace Microsoft.Azure.Functions.PowerShellWorker.PowerShell.Host
     /// applications. Not all members are implemented. Those that aren't throw a
     /// NotImplementedException.
     /// </summary>
-    internal class Host : PSHost
+    internal class AzureFunctionsHost : PSHost
     {
+        /// <summary>
+        /// The private reference of the logger.
+        /// </summary>
         private RpcLogger _logger;
 
         /// <summary>
@@ -80,23 +83,22 @@ internal class Host : PSHost
         /// </summary>
         public override Version Version => new Version(1, 0, 0, 0);
 
-        public Host(RpcLogger logger)
+        public AzureFunctionsHost(RpcLogger logger)
         {
             _logger = logger;
-
             HostUI = new HostUserInterface(logger);
         }
 
         /// <summary>
-        /// Not implemented by this example class. The call fails with an exception.
+        /// Not implemented by this class. The call fails with an exception.
         /// </summary>
         public override void EnterNestedPrompt()
         {
             throw new NotImplementedException("The method or operation is not implemented.");
         }
 
         /// <summary>
-        /// Not implemented by this example class. The call fails with an exception.
+        /// Not implemented by this class. The call fails with an exception.
         /// </summary>
         public override void ExitNestedPrompt()
         {
@@ -106,7 +108,7 @@ public override void ExitNestedPrompt()
         /// <summary>
         /// This API is called before an external application process is started. Typically
         /// it's used to save state that the child process may alter so the parent can
-        /// restore that state when the child exits. In this sample, we don't need this so
+        /// restore that state when the child exits. In this, we don't need this so
         /// the method simple returns.
         /// </summary>
         public override void NotifyBeginApplication()
@@ -116,8 +118,8 @@ public override void NotifyBeginApplication()
 
         /// <summary>
         /// This API is called after an external application process finishes. Typically
-        /// it's used to restore state that the child process may have altered. In this
-        /// sample, we don't need this so the method simple returns.
+        /// it's used to restore state that the child process may have altered. In this,
+        /// we don't need this so the method simple returns.
         /// </summary>
         public override void NotifyEndApplication()
         {

src/Azure.Functions.PowerShell.Worker/PowerShell/Host/HostUserInterface.cs

@@ -15,6 +15,9 @@ namespace Microsoft.Azure.Functions.PowerShellWorker.PowerShell.Host
     /// </summary>
     internal class HostUserInterface : PSHostUserInterface
     {
+        /// <summary>
+        /// The private reference of the logger.
+        /// </summary>
         private RpcLogger _logger;
 
         /// <summary>
@@ -40,7 +43,7 @@ public HostUserInterface(RpcLogger logger)
         /// <param name="message">The text of the prompt.</param>
         /// <param name="descriptions">A collection of FieldDescription objects that 
         /// describe each field of the prompt.</param>
-        /// <returns>Throws a NotImplementedException exception.</returns>
+        /// <returns>Throws a NotImplementedException exception because we don't need a prompt.</returns>
         public override Dictionary<string, PSObject> Prompt(string caption, string message, System.Collections.ObjectModel.Collection<FieldDescription> descriptions)
         {
             throw new NotImplementedException("The method or operation is not implemented.");
@@ -55,7 +58,7 @@ public override Dictionary<string, PSObject> Prompt(string caption, string messa
         /// each choice.</param>
         /// <param name="defaultChoice">The index of the label in the Choices parameter 
         /// collection. To indicate no default choice, set to -1.</param>
-        /// <returns>Throws a NotImplementedException exception.</returns>
+        /// <returns>Throws a NotImplementedException exception because we don't need a prompt.</returns>
         public override int PromptForChoice(string caption, string message, System.Collections.ObjectModel.Collection<ChoiceDescription> choices, int defaultChoice)
         {
             throw new NotImplementedException("The method or operation is not implemented.");
@@ -69,7 +72,7 @@ public override int PromptForChoice(string caption, string message, System.Colle
         /// <param name="message">The text of the message.</param>
         /// <param name="userName">The user name whose credential is to be prompted for.</param>
         /// <param name="targetName">The name of the target for which the credential is collected.</param>
-        /// <returns>Throws a NotImplementedException exception.</returns>
+        /// <returns>Throws a NotImplementedException exception because we don't need a prompt.</returns>
         public override PSCredential PromptForCredential(string caption, string message, string userName, string targetName)
         {
             throw new NotImplementedException("The method or operation is not implemented.");
@@ -88,7 +91,7 @@ public override PSCredential PromptForCredential(string caption, string message,
         /// identifies the type of credentials that can be returned.</param>
         /// <param name="options">A PSCredentialUIOptions constant that identifies the UI 
         /// behavior when it gathers the credentials.</param>
-        /// <returns>Throws a NotImplementedException exception.</returns>
+        /// <returns>Throws a NotImplementedException exception because we don't need a prompt.</returns>
         public override PSCredential PromptForCredential(string caption, string message, string userName, string targetName, PSCredentialTypes allowedCredentialTypes, PSCredentialUIOptions options)
         {
             throw new NotImplementedException("The method or operation is not implemented.");
@@ -98,7 +101,7 @@ public override PSCredential PromptForCredential(string caption, string message,
         /// Reads characters that are entered by the user until a newline 
         /// (carriage return) is encountered.
         /// </summary>
-        /// <returns>The characters that are entered by the user.</returns>
+        /// <returns>Throws a NotImplemented exception because we are in a non-interactive experience.</returns>
         public override string ReadLine()
         {
             throw new NotImplementedException("The method or operation is not implemented.");
@@ -108,7 +111,7 @@ public override string ReadLine()
         /// Reads characters entered by the user until a newline (carriage return) 
         /// is encountered and returns the characters as a secure string.
         /// </summary>
-        /// <returns>Throws a NotImplemented exception.</returns>
+        /// <returns>Throws a NotImplemented exception because we are in a non-interactive experience.</returns>
         public override System.Security.SecureString ReadLineAsSecureString()
         {
             throw new NotImplementedException("The method or operation is not implemented.");
@@ -161,7 +164,7 @@ public override void WriteErrorLine(string value)
         /// </summary>
         public override void WriteLine()
         {
-            //do nothing
+            //do nothing because we don't need to log empty lines
         }
 
         /// <summary>
@@ -203,7 +206,6 @@ public override void WriteProgress(long sourceId, ProgressRecord record)
         /// <param name="message">The verbose message that is displayed.</param>
         public override void WriteVerboseLine(string message)
         {
-            //Console.WriteLine(String.Format(CultureInfo.CurrentCulture, "VERBOSE: {0}", message));
             _logger.LogTrace(String.Format(CultureInfo.CurrentCulture, "VERBOSE: {0}", message));
         }
 
@@ -213,7 +215,6 @@ public override void WriteVerboseLine(string message)
         /// <param name="message">The warning message that is displayed.</param>
         public override void WriteWarningLine(string message)
         {
-            //Console.WriteLine(String.Format(CultureInfo.CurrentCulture, "WARNING: {0}", message));
             _logger.LogWarning(String.Format(CultureInfo.CurrentCulture, "WARNING: {0}", message));
         }
     }