Merge pull request #187727 from diberry/diberry/0207-azure-functions-context-done

[BULK] Azure Functions JS - context.done

Author: denrea

articles/azure-functions/durable/durable-functions-bindings.md

@@ -2,7 +2,7 @@
 title: Bindings for Durable Functions - Azure
 description: How to use triggers and bindings for the Durable Functions extension for Azure Functions.
 ms.topic: conceptual
-ms.date: 08/03/2021
+ms.date: 02/08/2022
 ms.author: azfuncdf
 ---
 
@@ -85,7 +85,7 @@ module.exports = df.orchestrator(function*(context) {
 ```
 
 > [!NOTE]
-> The `durable-functions` library takes care of calling the `context.done` method when the generator function exits.
+> The `durable-functions` library takes care of calling the synchronous `context.done` method when the generator function exits.
 
 # [Python](#tab/python)
 

articles/azure-functions/durable/durable-functions-sequence.md

@@ -3,7 +3,7 @@ title: Function chaining in Durable Functions - Azure
 description: Learn how to run a Durable Functions sample that executes a sequence of functions.
 author: cgillum
 ms.topic: conceptual
-ms.date: 11/29/2019
+ms.date: 02/08/2022
 ms.author: azfuncdf
 ms.devlang: csharp, javascript, python
 ---
@@ -22,7 +22,7 @@ This article explains the following functions in the sample app:
 * `E1_SayHello`: An [activity function](durable-functions-bindings.md#activity-trigger) that prepends a string with "Hello".
 * `HttpStart`: An HTTP triggered [durable client](durable-functions-bindings.md#orchestration-client) function that starts an instance of the orchestrator.
 
-### E1_HelloSequence orchestrator function
+## E1_HelloSequence orchestrator function
 
 # [C#](#tab/csharp)
 
@@ -58,7 +58,7 @@ All JavaScript orchestration functions must include the [`durable-functions` mod
 
 1. The orchestrator function is a [generator function](/scripting/javascript/advanced/iterators-and-generators-javascript).
 2. The function is wrapped in a call to the `durable-functions` module's `orchestrator` method (here `df`).
-3. The function must be synchronous. Because the 'orchestrator' method handles calling 'context.done', the function should simply 'return'.
+3. The function must be synchronous. Because the 'orchestrator' method handles the final call to 'context.done', the function should simply 'return'.
 
 The `context` object contains a `df` durable orchestration context object that lets you call other *activity* functions and pass input parameters using its `callActivity` method. The code calls `E1_SayHello` three times in sequence with different parameter values, using `yield` to indicate the execution should wait on the async activity function calls to be returned. The return value of each call is added to the `outputs` array, which is returned at the end of the function.
 
@@ -94,7 +94,7 @@ The `context` object lets you call other *activity* functions and pass input par
 
 ---
 
-### E1_SayHello activity function
+## E1_SayHello activity function
 
 # [C#](#tab/csharp)
 
@@ -148,7 +148,7 @@ Unlike the orchestrator function, an activity function needs no special setup. T
 
 ---
 
-### HttpStart client function
+## HttpStart client function
 
 You can start an instance of orchestrator function using a client function. You will use the `HttpStart` HTTP triggered function to start instances of `E1_HelloSequence`.
 

articles/azure-functions/functions-bindings-cosmosdb-v2-input.md

@@ -1090,10 +1090,9 @@ Here's the JavaScript code:
 
 ```javascript
     // Change input document contents using Azure Cosmos DB input binding, using context.bindings.inputDocumentOut
-    module.exports = function (context) {
-    context.bindings.inputDocumentOut = context.bindings.inputDocumentIn;
-    context.bindings.inputDocumentOut.text = "This was updated!";
-    context.done();
+    module.exports = async function (context) {
+        context.bindings.inputDocumentOut = context.bindings.inputDocumentIn;
+        context.bindings.inputDocumentOut.text = "This was updated!";
     };
 ```
 
@@ -1141,7 +1140,7 @@ Here's the *function.json* file:
 Here's the JavaScript code:
 
 ```javascript
-module.exports = function (context, req, toDoItem) {
+module.exports = async function (context, req, toDoItem) {
     context.log('JavaScript queue trigger function processed work item');
     if (!toDoItem)
     {
@@ -1151,8 +1150,6 @@ module.exports = function (context, req, toDoItem) {
     {
         context.log("Found ToDo item, Description=" + toDoItem.Description);
     }
-
-    context.done();
 };
 ```
 
@@ -1201,7 +1198,7 @@ Here's the *function.json* file:
 Here's the JavaScript code:
 
 ```javascript
-module.exports = function (context, req, toDoItem) {
+module.exports = async function (context, req, toDoItem) {
     context.log('JavaScript queue trigger function processed work item');
     if (!toDoItem)
     {
@@ -1211,8 +1208,6 @@ module.exports = function (context, req, toDoItem) {
     {
         context.log("Found ToDo item, Description=" + toDoItem.Description);
     }
-
-    context.done();
 };
 ```
 
@@ -1243,13 +1238,12 @@ The [configuration](#configuration) section explains these properties.
 Here's the JavaScript code:
 
 ```javascript
-module.exports = function (context, input) {
+module.exports = async function (context, input) {
   var documents = context.bindings.documents;
   for (var i = 0; i < documents.length; i++) {
     var document = documents[i];
     // operate on each document
   }
-  context.done();
 };
 ```
 

articles/azure-functions/functions-bindings-cosmosdb-v2-output.md

@@ -488,23 +488,21 @@ The [configuration](#configuration) section explains these properties.
 Here's the JavaScript code:
 
 ```javascript
-    module.exports = function (context) {
+    module.exports = async function (context) {
 
       context.bindings.employeeDocument = JSON.stringify({
         id: context.bindings.myQueueItem.name + "-" + context.bindings.myQueueItem.employeeId,
         name: context.bindings.myQueueItem.name,
         employeeId: context.bindings.myQueueItem.employeeId,
         address: context.bindings.myQueueItem.address
       });
-
-      context.done();
     };
 ```
 
 For bulk insert form the objects first and then run the stringify function. Here's the JavaScript code:
 
 ```javascript
-    module.exports = function (context) {
+    module.exports = async function (context) {
 
         context.bindings.employeeDocument = JSON.stringify([
         {
@@ -519,8 +517,6 @@ For bulk insert form the objects first and then run the stringify function. Here
             "employeeId": "123457",
             "address": "A town far away"
         }]);
-    
-      context.done();
     };
 ```
 

articles/azure-functions/functions-bindings-cosmosdb-v2-trigger.md

@@ -171,10 +171,8 @@ Here's the binding data in the *function.json* file:
 Here's the JavaScript code:
 
 ```javascript
-    module.exports = function (context, documents) {
+    module.exports = async function (context, documents) {
       context.log('First document Id modified : ', documents[0].id);
-
-      context.done();
     }
 ```
 

articles/azure-functions/functions-bindings-cosmosdb.md

@@ -130,10 +130,8 @@ Here's the binding data in the *function.json* file:
 Here's the JavaScript code:
 
 ```javascript
-    module.exports = function (context, documents) {
+    module.exports = async function (context, documents) {
         context.log('First document Id modified : ', documents[0].id);
-
-        context.done();
     }
 ```
 
@@ -926,10 +924,9 @@ Here's the JavaScript code:
 
 ```javascript
     // Change input document contents using Azure Cosmos DB input binding, using context.bindings.inputDocumentOut
-    module.exports = function (context) {
-    context.bindings.inputDocumentOut = context.bindings.inputDocumentIn;
-    context.bindings.inputDocumentOut.text = "This was updated!";
-    context.done();
+    module.exports = async function (context) {
+        context.bindings.inputDocumentOut = context.bindings.inputDocumentIn;
+        context.bindings.inputDocumentOut.text = "This was updated!";
     };
 ```
 
@@ -976,7 +973,7 @@ Here's the *function.json* file:
 Here's the JavaScript code:
 
 ```javascript
-module.exports = function (context, req, toDoItem) {
+module.exports = async function (context, req, toDoItem) {
     context.log('JavaScript queue trigger function processed work item');
     if (!toDoItem)
     {
@@ -986,8 +983,6 @@ module.exports = function (context, req, toDoItem) {
     {
         context.log("Found ToDo item, Description=" + toDoItem.Description);
     }
-
-    context.done();
 };
 ```
 
@@ -1035,7 +1030,7 @@ Here's the *function.json* file:
 Here's the JavaScript code:
 
 ```javascript
-module.exports = function (context, req, toDoItem) {
+module.exports = async function (context, req, toDoItem) {
     context.log('JavaScript queue trigger function processed work item');
     if (!toDoItem)
     {
@@ -1045,8 +1040,6 @@ module.exports = function (context, req, toDoItem) {
     {
         context.log("Found ToDo item, Description=" + toDoItem.Description);
     }
-
-    context.done();
 };
 ```
 
@@ -1077,13 +1070,12 @@ The [configuration](#input---configuration) section explains these properties.
 Here's the JavaScript code:
 
 ```javascript
-    module.exports = function (context, input) {
+    module.exports = async function (context, input) {
         var documents = context.bindings.documents;
         for (var i = 0; i < documents.length; i++) {
             var document = documents[i];
             // operate on each document
         }
-        context.done();
     };
 ```
 
@@ -1403,16 +1395,14 @@ The [configuration](#output---configuration) section explains these properties.
 Here's the JavaScript code:
 
 ```javascript
-    module.exports = function (context) {
+    module.exports = async function (context) {
 
       context.bindings.employeeDocument = JSON.stringify({
         id: context.bindings.myQueueItem.name + "-" + context.bindings.myQueueItem.employeeId,
         name: context.bindings.myQueueItem.name,
         employeeId: context.bindings.myQueueItem.employeeId,
         address: context.bindings.myQueueItem.address
       });
-
-      context.done();
     };
 ```
 

articles/azure-functions/functions-bindings-event-grid-output.md

@@ -282,14 +282,13 @@ module.exports = async function (context, myTimer) {
         data: "event-data",
         eventTime: timeStamp
     };
-    context.done();
 };
 ```
 
 Here's JavaScript code that creates multiple events:
 
 ```javascript
-module.exports = function(context) {
+module.exports = async function(context) {
     var timeStamp = new Date().toISOString();
 
     context.bindings.outputEvent = [];
@@ -310,7 +309,6 @@ module.exports = function(context) {
         data: "event-data",
         eventTime: timeStamp
     });
-    context.done();
 };
 ```
 

articles/azure-functions/functions-bindings-event-grid-trigger.md

@@ -264,12 +264,11 @@ Here's the binding data in the *function.json* file:
 Here's the JavaScript code:
 
 ```javascript
-module.exports = function (context, eventGridEvent) {
+module.exports = async function (context, eventGridEvent) {
     context.log("JavaScript Event Grid function processed a request.");
     context.log("Subject: " + eventGridEvent.subject);
     context.log("Time: " + eventGridEvent.eventTime);
     context.log("Data: " + JSON.stringify(eventGridEvent.data));
-    context.done();
 };
 ```
 

articles/azure-functions/functions-bindings-example.md

@@ -6,7 +6,7 @@ author: craigshoemaker
 ms.topic: reference
 ms.devlang: csharp, javascript
 ms.custom: devx-track-csharp
-ms.date: 02/18/2019
+ms.date: 02/08/2022
 ms.author: cshoe
 ---
 
@@ -48,7 +48,7 @@ To view and edit the contents of *function.json* in the Azure portal, click the
 > [!NOTE]
 > The value of `connection` is the name of an app setting that contains the connection string, not the connection string itself. Bindings use connection strings stored in app settings to enforce the best practice that *function.json* does not contain service secrets.
 
-## C# script example
+# [C# script](#tab/csharp)
 
 Here's C# script code that works with this trigger and binding. Notice that the name of the parameter that provides the queue message content is `order`; this name is required because the `name` property value in *function.json* is `order` 
 
@@ -78,27 +78,7 @@ public class Person
 }
 ```
 
-## JavaScript example
-
-The same *function.json* file can be used with a JavaScript function:
-
-```javascript
-// From an incoming queue message that is a JSON object, add fields and write to Table Storage
-// The second parameter to context.done is used as the value for the new row
-module.exports = function (context, order) {
-    order.PartitionKey = "Orders";
-    order.RowKey = generateRandomId(); 
-
-    context.done(null, order);
-};
-
-function generateRandomId() {
-    return Math.random().toString(36).substring(2, 15) +
-        Math.random().toString(36).substring(2, 15);
-}
-```
-
-## Class library example
+# [C# class library](#tab/csharp-class-library)
 
 In a class library, the same trigger and binding information — queue and table names, storage accounts, function parameters for input and output — is provided by attributes instead of a function.json file. Here's an example:
 
@@ -128,6 +108,29 @@ public class Person
 }
 ```
 
+# [JavaScript](#tab/javascript)
+
+
+
+The same *function.json* file can be used with a JavaScript function:
+
+```javascript
+// From an incoming queue message that is a JSON object, add fields and write to Table Storage
+module.exports = async function (context, order) {
+    order.PartitionKey = "Orders";
+    order.RowKey = generateRandomId(); 
+
+    context.bindings.order = order;
+};
+
+function generateRandomId() {
+    return Math.random().toString(36).substring(2, 15) +
+        Math.random().toString(36).substring(2, 15);
+}
+```
+
+---
+
 You now have a working function that is triggered by an Azure Queue and outputs data to Azure Table storage.
 
 ## Next steps