feat: add support for parameter prefixes in order to be able to explicitly bind to a desired origin

This feature allows us to use parameters from different sources. See example for testing PUT methods
in the tests.

BREAKING CHANGE: every :parameter should be revised and modified to be :b.parameter to bind to
request body or :p.parameter to bind to path parameter.

See also #8

Author: php-coder

README.md

@@ -23,22 +23,23 @@ Generates the endpoints (or a whole app) from a mapping (SQL query -> URL)
          FROM categories
      post: >-
        INSERT INTO categories(name, slug, created_at, created_by, updated_at, updated_by)
-       VALUES (:name, :slug, NOW(), :userId, NOW(), :userId)
+       VALUES (:b.name, :b.slug, NOW(), :b.userId, NOW(), :b.userId)
 
    - path: /v1/categories/:categoryId
      get: >-
        SELECT id, name, name_ru, slug
          FROM categories
-        WHERE id = :categoryId
+        WHERE id = :p.categoryId
      put: >-
        UPDATE categories
-          SET name = :name, name_ru = :nameRu, slug = :slug, updated_at = NOW(), updated_by = :userId
-        WHERE id = :categoryId
+          SET name = :b.name, name_ru = :b.nameRu, slug = :b.slug, updated_at = NOW(), updated_by = :b.userId
+        WHERE id = :p.categoryId
      delete: >-
        DELETE
          FROM categories
-        WHERE id = :categoryId
+        WHERE id = :p.categoryId
    ```
+   Note that the queries use a little unusual named parameters: `:b.name`, `p.categoryId`, etc The prefixes `b` (body) and `p` (path) are used here in order to bind to parameters from the appropriate sources. The prefixes are needed only during code generation and they will absent from the resulted code.
 
 1. Generate code
    ```console

examples/js/endpoints.yaml

@@ -7,7 +7,7 @@
       FROM collections_series cs
       JOIN series s
         ON s.id = cs.series_id
-     WHERE cs.collection_id = :collectionId
+     WHERE cs.collection_id = :p.collectionId
 
 - path: /v1/categories
   get_list: >-
@@ -28,13 +28,13 @@
          , updated_by
          )
     VALUES
-        ( :name
-        , :nameRu
-        , :slug
+        ( :b.name
+        , :b.nameRu
+        , :b.slug
         , NOW()
-        , :userId
+        , :b.userId
         , NOW()
-        , :userId
+        , :b.userId
         )
 
 - path: /v1/categories/:categoryId
@@ -44,16 +44,16 @@
          , name_ru
          , slug
       FROM categories
-     WHERE id = :categoryId
+     WHERE id = :p.categoryId
   put: >-
     UPDATE categories
-       SET name = :name
-         , name_ru = :nameRu
-         , slug = :slug
+       SET name = :b.name
+         , name_ru = :b.nameRu
+         , slug = :b.slug
          , updated_at = NOW()
-         , updated_by = :userId
-     WHERE id = :categoryId
+         , updated_by = :b.userId
+     WHERE id = :p.categoryId
   delete: >-
     DELETE
       FROM categories
-     WHERE id = :categoryId
+     WHERE id = :p.categoryId

examples/js/routes.js

@@ -79,7 +79,7 @@ app.get('/v1/categories/:categoryId', (req, res) => {
 app.put('/v1/categories/:categoryId', (req, res) => {
     pool.query(
         'UPDATE categories SET name = :name , name_ru = :nameRu , slug = :slug , updated_at = NOW() , updated_by = :userId WHERE id = :categoryId',
-        { "name": req.body.name, "nameRu": req.body.nameRu, "slug": req.body.slug, "userId": req.body.userId, "categoryId": req.body.categoryId },
+        { "name": req.body.name, "nameRu": req.body.nameRu, "slug": req.body.slug, "userId": req.body.userId, "categoryId": req.params.categoryId },
         (err, rows, fields) => {
             if (err) {
                 throw err

src/cli.js

@@ -32,50 +32,58 @@ const createApp = async (destDir, fileName) => {
 // "SELECT *\n   FROM foo" => "SELECT * FROM foo"
 const flattenQuery = (query) => query.replace(/\n[ ]*/g, ' ');
 
+// "WHERE id = :p.categoryId OR id = :b.id" => "WHERE id = :categoryId OR id = :id"
+const removePlaceholders = (query) => query.replace(/:[pb]\./g, ':');
+
 const createEndpoints = async (destDir, fileName, config) => {
     console.log('Generate', fileName);
     const resultFile = path.join(destDir, fileName);
 
     for (let endpoint of config) {
         if (endpoint.hasOwnProperty('get')) {
-            console.log('GET', endpoint.path, '=>', flattenQuery(endpoint.get));
+            console.log('GET', endpoint.path, '=>', removePlaceholders(flattenQuery(endpoint.get)));
         } else if (endpoint.hasOwnProperty('get_list')) {
-            console.log('GET', endpoint.path, '=>', flattenQuery(endpoint.get_list));
+            console.log('GET', endpoint.path, '=>', removePlaceholders(flattenQuery(endpoint.get_list)));
         }
         if (endpoint.hasOwnProperty('post')) {
-            console.log('POST', endpoint.path, '=>', flattenQuery(endpoint.post));
+            console.log('POST', endpoint.path, '=>', removePlaceholders(flattenQuery(endpoint.post)));
         }
         if (endpoint.hasOwnProperty('put')) {
-            console.log('PUT', endpoint.path, '=>', flattenQuery(endpoint.put));
+            console.log('PUT', endpoint.path, '=>', removePlaceholders(flattenQuery(endpoint.put)));
         }
         if (endpoint.hasOwnProperty('delete')) {
-            console.log('DELETE', endpoint.path, '=>', flattenQuery(endpoint.delete));
+            console.log('DELETE', endpoint.path, '=>', removePlaceholders(flattenQuery(endpoint.delete)));
         }
     }
 
+    const placeholdersMap = {
+        'p': 'req.params',
+        'b': 'req.body'
+    }
+
     const resultedCode = await ejs.renderFile(
         __dirname + '/templates/routes.js.ejs',
         {
             "endpoints": config,
 
-            // "... WHERE id = :id" => [ ":id" ] => [ "id" ]
+            // "... WHERE id = :p.id" => [ "p.id" ] => [ "p.id" ]
             "extractParams": (query) => {
-                const params = query.match(/:\w+/g) || [];
+                const params = query.match(/:[pb]\.\w+/g) || [];
                 return params.length > 0
                     ? params.map(p => p.substring(1))
                     : params;
             },
 
-            // [ "page", "num" ] => '{ "page" : req.params.page, "num": req.params.num }'
-            "formatParams": (params, targetObject) => {
+            // [ "p.page", "b.num" ] => '{ "page" : req.params.page, "num": req.body.num }'
+            "formatParams": (params) => {
                 return params.length > 0
-                    ? '{ ' + Array.from(new Set(params), p => `"${p}": ${targetObject}.${p}`).join(', ') + ' }'
+                    ? '{ ' + Array.from(new Set(params), p => `"${p.substring(2)}": ${placeholdersMap[p.substring(0, 1)]}.${p.substring(2)}`).join(', ') + ' }'
                     : params;
             },
 
             // "SELECT *\n   FROM foo" => "'SELECT * FROM foo'"
             "formatQuery": (query) => {
-                return "'" + flattenQuery(query) + "'";
+                return "'" + removePlaceholders(flattenQuery(query)) + "'";
             }
         }
     );

src/templates/routes.js.ejs

@@ -10,7 +10,7 @@ endpoints.forEach(function(endpoint) {
 %>
 app.get('<%- endpoint.path %>', (req, res) => {
     pool.query(
-        <%- formatQuery(sql) %>,<%- params.length > 0 ? '\n        ' + formatParams(params, 'req.params') + ',' : '' %>
+        <%- formatQuery(sql) %>,<%- params.length > 0 ? '\n        ' + formatParams(params) + ',' : '' %>
         (err, rows, fields) => {
             if (err) {
                 throw err
@@ -34,7 +34,7 @@ app.get('<%- endpoint.path %>', (req, res) => {
 %>
 app.post('<%- endpoint.path %>', (req, res) => {
     pool.query(
-        <%- formatQuery(endpoint.post) %>,<%- params.length > 0 ? '\n        ' + formatParams(params, 'req.body') + ',' : '' %>
+        <%- formatQuery(endpoint.post) %>,<%- params.length > 0 ? '\n        ' + formatParams(params) + ',' : '' %>
         (err, rows, fields) => {
             if (err) {
                 throw err
@@ -50,7 +50,7 @@ app.post('<%- endpoint.path %>', (req, res) => {
 %>
 app.put('<%- endpoint.path %>', (req, res) => {
     pool.query(
-        <%- formatQuery(endpoint.put) %>,<%- params.length > 0 ? '\n        ' + formatParams(params, 'req.body') + ',' : '' %>
+        <%- formatQuery(endpoint.put) %>,<%- params.length > 0 ? '\n        ' + formatParams(params) + ',' : '' %>
         (err, rows, fields) => {
             if (err) {
                 throw err
@@ -66,7 +66,7 @@ app.put('<%- endpoint.path %>', (req, res) => {
 %>
 app.delete('<%- endpoint.path %>', (req, res) => {
     pool.query(
-        <%- formatQuery(endpoint.delete) %>,<%- params.length > 0 ? '\n        ' + formatParams(params, 'req.params') + ',' : '' %>
+        <%- formatQuery(endpoint.delete) %>,<%- params.length > 0 ? '\n        ' + formatParams(params) + ',' : '' %>
         (err, rows, fields) => {
             if (err) {
                 throw err

tests/crud.robot

@@ -29,7 +29,7 @@ GET should return not found
     Should Be Equal   ${response.headers['Content-Type']}  application/json; charset=utf-8
 
 PUT should update an object
-    &{payload}=       Create Dictionary  name=Fauna  nameRu=Фауна  slug=fauna  userId=1  categoryId=1
+    &{payload}=       Create Dictionary  name=Fauna  nameRu=Фауна  slug=fauna  userId=1
     ${response}=      Put Request  api  /v1/categories/1  json=${payload}
     Status Should Be  204  ${response}