Add node v4 programming model sample (#830)

lucyzhang929 · web-flow · commit 11a28a9f7f9c · 2023-04-26T14:31:29.000-07:00
* add node v4 model sample

* add local settings json and set trace logging

* add samples-js-v4 to docs
diff --git a/docs/SetupGuide_Javascript.md b/docs/SetupGuide_Javascript.md
@@ -19,6 +19,7 @@
     - [Samples for Output Bindings](#samples-for-output-bindings)
       - [Array](#array)
       - [Single Row](#single-row)
+  - [Node V4 Model](#node-v4-model)
 
 ## Setup Function Project
 
@@ -201,3 +202,7 @@ See the [AddProductsArray](https://github.com/Azure/azure-functions-sql-extensio
 #### Single Row
 
 See the [AddProduct](https://github.com/Azure/azure-functions-sql-extension/tree/main/samples/samples-js/AddProduct) sample
+
+## Node V4 Model
+
+See the Node V4 Model samples [here](https://github.com/Azure/azure-functions-sql-extension/tree/main/samples/samples-js-v4/). More information about the Node V4 Model can be found [here](https://learn.microsoft.com/azure/azure-functions/functions-node-upgrade-v4?tabs=azure-cli-set-indexing-flag%2Cv4).
diff --git a/samples/samples-js-v4/.funcignore b/samples/samples-js-v4/.funcignore
@@ -0,0 +1,10 @@
+*.js.map
+*.ts
+.git*
+.vscode
+__azurite_db*__.json
+__blobstorage__
+__queuestorage__
+local.settings.json
+test
+tsconfig.json
diff --git a/samples/samples-js-v4/.gitignore b/samples/samples-js-v4/.gitignore
@@ -0,0 +1,99 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TypeScript output
+dist
+out
+
+# Azure Functions artifacts
+bin
+obj
+appsettings.json
+local.settings.json
+
+# Azurite artifacts
+__blobstorage__
+__queuestorage__
+__azurite_db*__.json
diff --git a/samples/samples-js-v4/.vscode/extensions.json b/samples/samples-js-v4/.vscode/extensions.json
@@ -0,0 +1,5 @@
+{
+  "recommendations": [
+    "ms-azuretools.vscode-azurefunctions"
+  ]
+}
diff --git a/samples/samples-js-v4/.vscode/launch.json b/samples/samples-js-v4/.vscode/launch.json
@@ -0,0 +1,12 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Attach to Node Functions",
+            "type": "node",
+            "request": "attach",
+            "port": 9229,
+            "preLaunchTask": "func: host start"
+        }
+    ]
+}
diff --git a/samples/samples-js-v4/.vscode/settings.json b/samples/samples-js-v4/.vscode/settings.json
@@ -0,0 +1,9 @@
+{
+    "azureFunctions.deploySubpath": ".",
+    "azureFunctions.postDeployTask": "npm install (functions)",
+    "azureFunctions.projectLanguage": "JavaScript",
+    "azureFunctions.projectRuntime": "~4",
+    "debug.internalConsoleOptions": "neverOpen",
+    "azureFunctions.projectLanguageModel": 4,
+    "azureFunctions.preDeployTask": "npm prune (functions)"
+}
diff --git a/samples/samples-js-v4/.vscode/tasks.json b/samples/samples-js-v4/.vscode/tasks.json
@@ -0,0 +1,24 @@
+{
+	"version": "2.0.0",
+	"tasks": [
+		{
+			"type": "func",
+			"label": "func: host start",
+			"command": "host start",
+			"problemMatcher": "$func-node-watch",
+			"isBackground": true,
+			"dependsOn": "npm install (functions)"
+		},
+		{
+			"type": "shell",
+			"label": "npm install (functions)",
+			"command": "npm install"
+		},
+		{
+			"type": "shell",
+			"label": "npm prune (functions)",
+			"command": "npm prune --production",
+			"problemMatcher": []
+		}
+	]
+}
diff --git a/samples/samples-js-v4/host.json b/samples/samples-js-v4/host.json
@@ -0,0 +1,18 @@
+{
+  "version": "2.0",
+  "logging": {
+    "applicationInsights": {
+      "samplingSettings": {
+        "isEnabled": true,
+        "excludedTypes": "Request"
+      }
+    },
+    "logLevel": {
+      "default": "Trace"
+    }
+  },
+  "extensionBundle": {
+    "id": "Microsoft.Azure.Functions.ExtensionBundle.Preview",
+    "version": "[4.*, 5.0.0)"
+  }
+}
diff --git a/samples/samples-js-v4/local.settings.json b/samples/samples-js-v4/local.settings.json
@@ -0,0 +1,9 @@
+{
+  "IsEncrypted": false,
+  "Values": {
+    "AzureWebJobsStorage": "UseDevelopmentStorage=true",
+    "FUNCTIONS_WORKER_RUNTIME": "node",
+    "AzureWebJobsFeatureFlags": "EnableWorkerIndexing",
+    "SqlConnectionString": ""
+  }
+}
diff --git a/samples/samples-js-v4/package-lock.json b/samples/samples-js-v4/package-lock.json
diff --git a/samples/samples-js-v4/package.json b/samples/samples-js-v4/package.json
@@ -0,0 +1,14 @@
+{
+  "name": "samples-js-v4",
+  "version": "1.0.0",
+  "description": "",
+  "scripts": {
+    "start": "func start",
+    "test": "echo \"No tests yet...\""
+  },
+  "dependencies": {
+    "@azure/functions": "^4.0.0-alpha.7"
+  },
+  "devDependencies": {},
+  "main": "src/functions/*.js"
+}
diff --git a/samples/samples-js-v4/src/functions/AddProduct.js b/samples/samples-js-v4/src/functions/AddProduct.js
@@ -0,0 +1,26 @@
+const { app, output } = require('@azure/functions');
+
+const sqlOutput = output.generic({
+    type: 'sql',
+    commandText: 'Products',
+    connectionStringSetting: 'SqlConnectionString'
+})
+
+// Upsert the product, which will insert it into the Products table if the primary key (ProductId) for that item doesn't exist.
+// If it does then update it to have the new name and cost.
+app.http('AddProduct', {
+    methods: ['POST'],
+    authLevel: 'anonymous',
+    extraOutputs: [sqlOutput],
+    handler: async (request, context) => {
+        // Note that this expects the body to be a JSON object or array of objects which have a property
+        // matching each of the columns in the table to upsert to.
+        const product = await request.json();
+        context.extraOutputs.set(sqlOutput, product);
+
+        return {
+            status: 201,
+            body: JSON.stringify(product)
+        };
+    }
+});
diff --git a/samples/samples-js-v4/src/functions/GetProducts.js b/samples/samples-js-v4/src/functions/GetProducts.js
@@ -0,0 +1,27 @@
+const { app, input } = require('@azure/functions');
+
+// The input binding executes the `select * from Products where Cost = @Cost` query, returning the result as json object in the body.
+// The *parameters* argument passes the `{cost}` specified in the URL that triggers the function,
+// `getproducts/{cost}`, as the value of the `@Cost` parameter in the query.
+// *commandType* is set to `Text`, since the constructor argument of the binding is a raw query.
+const sqlInput = input.generic({
+    type: 'sql',
+    commandText: 'select * from Products where Cost = @Cost',
+    parameters: '@Cost={cost}',
+    connectionStringSetting: 'SqlConnectionString'
+})
+
+app.http('GetProducts', {
+    methods: ['GET', 'POST'],
+    authLevel: 'anonymous',
+    route: 'getproducts/{cost}',
+    extraInputs: [sqlInput],
+    handler: async (request, context) => {
+        const products = JSON.stringify(context.extraInputs.get(sqlInput));
+
+        return {
+            status: 200,
+            body: products
+        };
+    }
+});

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +{
 +  "recommendations": [
 +    "ms-azuretools.vscode-azurefunctions"
 +  ]
 +}