Merge pull request #230 from JocaPC/master

Updated Node.js todo sample

Author: jovanpop-msft

samples/features/json/todo-app/nodejs-express4-rest-api/.gitignore

@@ -2,4 +2,6 @@ node_modules/*
 bin/*.dll
 obj/*
 *.sln
-*.log
+*.log
+config/Development.json
+config/Production.json

samples/features/json/todo-app/nodejs-express4-rest-api/README.md

@@ -17,7 +17,7 @@ This project contains an example implementation of NodeJS REST API with CRUD ope
 
 - **Applies to:** SQL Server 2016 (or higher), Azure SQL Database
 - **Key features:** JSON Functions in SQL Server 2016/Azure SQL Database - FOR JSON and OPENJSON
-- **Programming Language:** JavaScript (NodeJS)
+- **Programming Language:** JavaScript (NodeJS), T-SQL
 - **Authors:** Jovan Popovic
 
 <a name=before-you-begin></a>
@@ -31,7 +31,6 @@ To run this sample, you need the following prerequisites.
 1. SQL Server 2016 (or higher) or an Azure SQL Database
 2. Node.js runtime.
 
-
 **Azure prerequisites:**
 
 1. Permission to create an Azure SQL Database
@@ -40,26 +39,30 @@ To run this sample, you need the following prerequisites.
 
 ## Run this sample
 
-1. Navigate to the folder where you have downloaded sample and run **npm install** in command window.
+1. Navigate to the folder where you have downloaded sample and run **npm update** in the command window.
 
 2. From SQL Server Management Studio or SQL Server Data Tools connect to your SQL Server 2016 or Azure SQL database and
-execute setup.sql script that will create and populate Todo table in the database.
-
-3. Locate db.js file in the project, change database connection info in createConnection() method to reference your database. the following tokens should be replaced:
- 1. SERVERNAME - name of the database server.
- 2. DATABASE - Name of database where Todo table is stored.
- 3. USERNAME - SQL Server login that can access table data and execute stored procedures.
- 4. PASSWORD - Password associated to SQL Server login.
+execute setup.sql script that will create and populate Todo table in the database and create necessary stored procedures.
 
+3. Locate config folder in the project and setup connection info in default.json file. The content of the file should look like:
 ```
-    var config = {
-        server  : "SERVER.database.windows.net",
-        userName: "USER",
-        password: "PASSWORD",
-        // If you're on Azure, you will need this:
-        options: { encrypt: true, database: 'DATABASE' }
-    };
+{
+    "connection":{
+        "server"  : "<<server name or ip>>",
+        "userName": "<<user name>>",
+        "password": "<<password>>",
+        "options": { "encrypt": true, "database": "<<database name>>" }
+    }
+}
 ```
+Content under connection key will be passed to Tedious package, which is used to
+interact with SQL Database. You can find more information
+about the properties in this object on [Tedious site](http://tediousjs.github.io/tedious/getting-started.html).
+
+As an alternative, you can put connection info into Development.json or
+Production.json file. This sample uses [config](https://www.npmjs.com/package/config)
+npm module to read configurations from a file, so you can find more information about
+the configuration there.
 
 4. Run sample app from the command line using **node app.js**
  1. Open http://localhost:3000/todo Url to get list of all Todo items from a table,
@@ -73,8 +76,7 @@ execute setup.sql script that will create and populate Todo table in the databas
 This sample application shows how to create simple REST API service that performs CRUD operations on a simple Todo table.
 NodeJS REST API is used to implement REST Service in the example.
 1. app.js file that contains startup code.
-2. db.js file that contains functions that wrap Tedious library
-3. todo.js file that contains action that will be called on GET, POST, PUT, and DELETE Http requests.
+3. routes/todo.js file that contains action that will be called on GET, POST, PUT, and DELETE Http requests.
 
 Service uses Tedious library for data access and built-in JSON functionalities that are available in SQL Server 2016 and Azure SQL Database.
 

samples/features/json/todo-app/nodejs-express4-rest-api/app.js

@@ -1,13 +1,20 @@
 var express = require('express');
+var config = require('config');
 var bodyParser = require('body-parser');
+var tediousExpress = require('express4-tedious');
 
 var app = express();
+app.use(function (req, res, next) {
+    req.query = tediousExpress(req, config.get('connection'));
+    next();
+});
+
 app.use(bodyParser.text()); 
 app.use('/todo', require('./routes/todo'));
 
 // catch 404 and forward to error handler
 app.use(function (req, res, next) {
-    var err = new Error('Not Found');
+    var err = new Error('Not Found: '+ req.method + ":" + req.originalUrl);
     err.status = 404;
     next(err);
 });

samples/features/json/todo-app/nodejs-express4-rest-api/config/default.json

@@ -0,0 +1,8 @@
+{
+    "connection":{
+        "server"  : "<<server name or ip>>",
+        "userName": "<<user name>>",
+        "password": "<<password>>",
+        "options": { "encrypt": true, "database": "<<database name>>" }
+    }
+}

samples/features/json/todo-app/nodejs-express4-rest-api/db.js

@@ -12,8 +12,10 @@
   },
   "dependencies": {
     "body-parser": "^1.15.2",
+    "config": "^1.26.1",
     "debug": "^2.2.0",
     "express": "^4.14.0",
-    "tedious": "^1.14.0"
+    "tedious": "^1.14.0",
+    "express4-tedious": "^0.1.0"
   }
 }

samples/features/json/todo-app/nodejs-express4-rest-api/package.json

@@ -1,56 +1,49 @@
-var express = require('express');
-var router = express.Router();
-
-var db = require('../db.js');
+var router = require('express').Router();
 var TYPES = require('tedious').TYPES;
 
 /* GET task listing. */
 router.get('/', function (req, res) {
-    db.stream("select * from todo for json path", db.createConnection(), res, '[]');
+
+    req.query("select * from todo for json path")
+        .into(res, '[]');
+
 });
 
 /* GET single task. */
 router.get('/:id', function (req, res) {
 
-    var conn = db.createConnection();
+    req.query("select * from todo where id = @id for json path, without_array_wrapper")
+        .param('id', req.params.id, TYPES.Int)
+        .into(res, '{}');
 
-    var request = db.createRequest("select * from todo where id = @id for json path, without_array_wrapper", conn); 
-    request.addParameter('id', TYPES.Int, req.params.id);
-    db.stream(request, conn, res, '{}');
 });
 
 /* POST create task. */
 router.post('/', function (req, res) {
 
-    var connection = db.createConnection();
-    var request = db.createRequest("exec createTodo @todo", connection);
-    
-    request.addParameter('todo', TYPES.NVarChar, req.body);
-    
-    db.executeRequest(request, connection);
+    req.query("exec createTodo @todo")
+        .param('todo', req.body, TYPES.NVarChar)
+        .exec(res);
+
 });
 
 /* PUT update task. */
 router.put('/:id', function (req, res) {
 
-    var connection = db.createConnection();
-    var request = db.createRequest("exec updateTodo @id, @todo", connection);
-    
-    request.addParameter('id', TYPES.Int, req.params.id);
-    request.addParameter('todo', TYPES.NVarChar, req.body);
-    
-    db.executeRequest(request, connection);
+    req.query("exec updateTodo @id, @todo")
+        .param('id', req.params.id, TYPES.Int)
+        .param('todo', req.body, TYPES.NVarChar)
+        .exec(res);
+
 });
 
 /* DELETE single task. */
 router.delete('/:id', function (req, res) {
 
-    var connection = db.createConnection();
-    var request = db.createRequest("delete from todo where id = @id", connection);
+    req.query("delete from todo where id = @id")
+        .param('id', req.params.id, TYPES.Int)
+        .exec(res);
 
-    request.addParameter('id', TYPES.Int, req.params.id);
-    
-    db.executeRequest(request, connection);
 });
 
 module.exports = router;