Patch of _reduceStock() under @sap/cds 4 (#136)

* Bump to cds 4
* Cosmetics in handler code
  * await and cds.run([...]) instead of Promise.all

Co-authored-by: Christian Georgi <christian.georgi@sap.com>

.npmrc

@@ -1 +1 @@
-@sap:registry=https://npm.sap.com
+registry=https://registry.npmjs.org

.vscode/launch.json

@@ -5,18 +5,45 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "bookshop", "request": "launch", "type": "node", "runtimeExecutable": "npx", "runtimeArgs": [ "-n" ],
-      "args": [ "--", "cds", "run", "--in-memory" ],
+      "name": "bookshop",
+      "request": "launch",
+      "type": "node",
+      "runtimeExecutable": "npx",
+      "runtimeArgs": [
+        "-n"
+      ],
+      "args": [
+        "--",
+        "cds",
+        "run",
+        "--in-memory"
+      ],
       "cwd": "${workspaceFolder}/packages/bookshop",
       "console": "integratedTerminal",
-      "skipFiles": ["<node_internals>/**"]
+      "skipFiles": [
+        "<node_internals>/**"
+      ]
     },
     {
-      "name": "cds run ...", "request": "launch", "type": "node", "runtimeExecutable": "npx", "runtimeArgs": [ "-n" ],
-      "args": [ "--", "cds", "run", "--with-mocks", "--in-memory?" ],
+      "name": "cds run ...",
+      "request": "launch",
+      "type": "node",
+      "runtimeExecutable": "npx",
+      "runtimeArgs": [
+        "-n"
+      ],
+      "args": [
+        "--",
+        "cds",
+        "run",
+        "--with-mocks",
+        "--in-memory?"
+      ],
       "cwd": "${workspaceFolder}/packages/${input:service}",
       "console": "integratedTerminal",
-      "skipFiles": ["<node_internals>/**"]
+      "skipFiles": [
+        "<node_internals>/**"
+      ]
     }
   ],
   "inputs": [
@@ -34,4 +61,4 @@
       "default": "bookshop"
     }
   ]
-}
+}

README.md

@@ -11,7 +11,7 @@ In SAP Business Application Studio, open a terminal.
 Then clone the repo with this specific branch:
 
 ```sh
-git clone https://github.com/sap-samples/cloud-cap-samples projects/cloud-cap-samples -b openSAP-week2-unit3
+git clone https://github.com/sap-samples/cloud-cap-samples projects/cloud-cap-samples -b openSAP-week3-unit5
 cd projects/cloud-cap-samples
 ```
 
@@ -25,11 +25,87 @@ npm install
 Now you're ready to run the samples, for example:
 ```sh
 cd packages/bookshop
+cds deploy
 cds watch
 ```
 
 After that, watch out for the little popup in the lower right corner of SAP Business Application Studio that asks you to open the application in your browser.
 
+## Hints
+- If your demo user logon window does not show up:  clear the browsers login data
+- If your port is still in use run in your terminal:
+```
+> pkill node      //kill running node proceses
+```
+
+## Deploy to Cloud Foundry
+
+Clean-up the CF space in your trial account if you already used it before. Make sure that there are no services or applications deployed.
+
+Generation of the XSUAA service configuration file xs-security.json:
+```sh
+cds compile srv/ --to xsuaa > xs-security.json
+```
+
+In this unit we use  [MTA](https://sap.github.io/cloud-mta-build-tool/) to do the deployment to CF
+```sh
+npm install -g mbt
+```
+You can generate the MTA.yaml from CDS and do manual modifications or simply use the already generated and adapted  mta.yaml in the branch and directly generate the .mtar file
+
+
+
+#### BEGIN OPTIONAL PART
+
+If you want to generate the MTA.YAML yourself please do the following:
+
+- Generate the mta.yaml with the HANA dependency
+```sh
+cds add hana --force
+cds add mta
+```
+
+- Add the path to the generated xs-security.json in the MTA.YAML
+```
+    parameters:
+         path: ./xs-security.json
+         service:xsuaa
+         service-plan: application
+         ....
+```
+- Add the application block in the MTA.YAML
+```
+     ##############    APP   #########################
+     - name: capire-bookshop-app
+       type: nodejs
+       path: gen/app
+       parameters:
+          memory: 256M
+       build-parameters:
+         requires:
+           - name: capire-bookshop-srv
+       requires:
+        - name: capire-bookshop-uaa
+        - name: srv-binding
+          group: destinations
+          properties:
+             forwardAuthToken: true
+             name: srv-binding
+             url: ~{srv-url}
+```
+- Make sure to use service hanatrial instead of hana in the MTA.YAML
+```
+   parameters:
+     service: hanatrial
+```
+#### END OPTIONAL PART
+
+Generate the .mtar file for the deployment and deploy to cloud foundry:
+```sh
+mbt build -t ./
+cf login -a https://api.cf.eu10.hana.ondemand.com
+cf deploy sap.capire-bookshop_1.0.0.mtar
+```
 
 ## Get Support
 

db/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "deploy",
+  "dependencies": {
+    "@sap/hdi-deploy": "^3.8.2"
+  },
+  "engines": {
+    "node": "^8"
+  },
+  "scripts": {
+    "start": "node node_modules/@sap/hdi-deploy/deploy.js"
+  }
+}

package.json

@@ -11,7 +11,7 @@
     "bookshop": "cds watch packages/bookshop"
   },
   "dependencies": {
-    "@sap/cds": "^3",
+    "@sap/cds": "^4",
     "express": "^4"
   },
   "devDependencies": {

packages/bookshop/.cdsrc.json

@@ -0,0 +1,67 @@
+{
+    "odata": {
+        "version": "v4"
+    },
+    "build": {
+        "target": "gen",
+        "tasks": [
+            {
+                "src": "db",
+                "for": "hana",
+                "options": {
+                    "model": [
+                        "db",
+                        "srv"
+                    ]
+                }
+            },
+            {
+                "src": "srv",
+                "for": "node-cf",
+                "options": {
+                    "model": [
+                        "db",
+                        "srv",
+                        "app"
+                    ]
+                }
+            },
+            {
+                "src": "app",
+                "for": "fiori",
+                "options": {
+                    "model": [
+                        "app"
+                    ]
+                }
+            }
+        ]
+    },
+    "auth": {
+        "passport": {
+            "strategy": "mock",
+            "users": {
+                "alice": {
+                    "password": "123",
+                    "ID": "alice",
+                    "roles": [
+                        "admin",
+                        "authenticated-user"
+                    ],
+                    "xs.user.attributes": {
+                        "currency": [
+                            "USD"
+                        ]
+                    }
+                },
+                "bob": {
+                    "password": "123",
+                    "ID": "bob",
+                    "roles": [
+                        "authenticated-user"
+                    ]
+                }
+            }
+        }
+    }
+}

packages/bookshop/.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Run bookshop",
+      "request": "launch",
+      "type": "node",
+      "cwd": "/home/user/projects/cloud-cap-samples/packages/bookshop",
+      "runtimeExecutable": "npx",
+      "runtimeArgs": [
+        "-n"
+      ],
+      "args": [
+        "--",
+        "cds",
+        "run",
+        "--in-memory?"
+      ],
+      "console": "internalConsole",
+      "internalConsoleOptions": "openOnSessionStart",
+      "skipFiles": [
+        "<node_internals>/**"
+      ],
+      "env": {
+        "run.config": "{\"handlerId\":\"cap_run_config_handler_id\",\"runnableId\":\"/home/user/projects/cloud-cap-samples/packages/bookshop\"}"
+      }
+    }
+  ]
+}

packages/bookshop/app/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "capire-bookshop-approuter",
+  "version": "0.0.1",
+  "description": "",
+  "dependencies": {
+    "@sap/approuter": "^8"
+  },
+  "scripts": {
+    "start": "node node_modules/@sap/approuter/approuter.js"
+  }
+}

packages/bookshop/app/xs-app.json

@@ -0,0 +1,22 @@
+{
+  "welcomeFile": "/fiori.html",
+  "authenticationMethod": "route",
+  "routes": [
+    {
+      "source": "^/.*(html|js)$",
+      "localDir": "."
+    },
+    {
+      "source": "^/sapui5/.*",
+      "localDir": "."
+    },
+    {
+      "source": "^/.*/webapp/.*",
+      "localDir": "."
+    },
+    {
+      "source": "/",
+      "destination": "srv-binding"
+    }
+  ]
+}

packages/bookshop/db/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "deploy",
+  "dependencies": {
+    "@sap/hdi-deploy": "^3.8.2"
+  },
+  "engines": {
+    "node": "^12"
+  },
+  "scripts": {
+    "start": "node node_modules/@sap/hdi-deploy/deploy.js"
+  }
+}

packages/bookshop/db/schema.cds

@@ -11,7 +11,6 @@ entity Books : managed {
   currency : Currency;
 }
 
-@cds.autoexpose
 entity Authors : managed {
   key ID : Integer;
   name   : String(111);

packages/bookshop/db/src/.hdiconfig

@@ -0,0 +1,136 @@
+{
+    "file_suffixes": {
+        "csv": {
+            "plugin_name": "com.sap.hana.di.tabledata.source"
+        },
+        "hdbafllangprocedure": {
+            "plugin_name": "com.sap.hana.di.afllangprocedure"
+        },
+        "hdbanalyticprivilege": {
+            "plugin_name": "com.sap.hana.di.analyticprivilege"
+        },
+        "hdbcalculationview": {
+            "plugin_name": "com.sap.hana.di.calculationview"
+        },
+        "hdbcollection": {
+            "plugin_name": "com.sap.hana.di.collection"
+        },
+        "hdbconstraint": {
+            "plugin_name": "com.sap.hana.di.constraint"
+        },
+        "hdbdropcreatetable": {
+            "plugin_name": "com.sap.hana.di.dropcreatetable"
+        },
+        "hdbflowgraph": {
+            "plugin_name": "com.sap.hana.di.flowgraph"
+        },
+        "hdbfunction": {
+            "plugin_name": "com.sap.hana.di.function"
+        },
+        "hdbgraphworkspace": {
+            "plugin_name": "com.sap.hana.di.graphworkspace"
+        },
+        "hdbhadoopmrjob": {
+            "plugin_name": "com.sap.hana.di.virtualfunctionpackage.hadoop"
+        },
+        "hdbindex": {
+            "plugin_name": "com.sap.hana.di.index"
+        },
+        "hdblibrary": {
+            "plugin_name": "com.sap.hana.di.library"
+        },
+        "hdbmigrationtable": {
+            "plugin_name": "com.sap.hana.di.table.migration"
+        },
+        "hdbprocedure": {
+            "plugin_name": "com.sap.hana.di.procedure"
+        },
+        "hdbprojectionview": {
+            "plugin_name": "com.sap.hana.di.projectionview"
+        },
+        "hdbprojectionviewconfig": {
+            "plugin_name": "com.sap.hana.di.projectionview.config"
+        },
+        "hdbreptask": {
+            "plugin_name": "com.sap.hana.di.reptask"
+        },
+        "hdbresultcache": {
+            "plugin_name": "com.sap.hana.di.resultcache"
+        },
+        "hdbrole": {
+            "plugin_name": "com.sap.hana.di.role"
+        },
+        "hdbroleconfig": {
+            "plugin_name": "com.sap.hana.di.role.config"
+        },
+        "hdbsearchruleset": {
+            "plugin_name": "com.sap.hana.di.searchruleset"
+        },
+        "hdbsequence": {
+            "plugin_name": "com.sap.hana.di.sequence"
+        },
+        "hdbstatistics": {
+            "plugin_name": "com.sap.hana.di.statistics"
+        },
+        "hdbstructuredprivilege": {
+            "plugin_name": "com.sap.hana.di.structuredprivilege"
+        },
+        "hdbsynonym": {
+            "plugin_name": "com.sap.hana.di.synonym"
+        },
+        "hdbsynonymconfig": {
+            "plugin_name": "com.sap.hana.di.synonym.config"
+        },
+        "hdbsystemversioning": {
+            "plugin_name": "com.sap.hana.di.systemversioning"
+        },
+        "hdbtable": {
+            "plugin_name": "com.sap.hana.di.table"
+        },
+        "hdbtabledata": {
+            "plugin_name": "com.sap.hana.di.tabledata"
+        },
+        "hdbtabletype": {
+            "plugin_name": "com.sap.hana.di.tabletype"
+        },
+        "hdbtrigger": {
+            "plugin_name": "com.sap.hana.di.trigger"
+        },
+        "hdbview": {
+            "plugin_name": "com.sap.hana.di.view"
+        },
+        "hdbvirtualfunction": {
+            "plugin_name": "com.sap.hana.di.virtualfunction"
+        },
+        "hdbvirtualfunctionconfig": {
+            "plugin_name": "com.sap.hana.di.virtualfunction.config"
+        },
+        "hdbvirtualpackagehadoop": {
+            "plugin_name": "com.sap.hana.di.virtualpackage.hadoop"
+        },
+        "hdbvirtualpackagesparksql": {
+            "plugin_name": "com.sap.hana.di.virtualpackage.sparksql"
+        },
+        "hdbvirtualprocedure": {
+            "plugin_name": "com.sap.hana.di.virtualprocedure"
+        },
+        "hdbvirtualprocedureconfig": {
+            "plugin_name": "com.sap.hana.di.virtualprocedure.config"
+        },
+        "hdbvirtualtable": {
+            "plugin_name": "com.sap.hana.di.virtualtable"
+        },
+        "hdbvirtualtableconfig": {
+            "plugin_name": "com.sap.hana.di.virtualtable.config"
+        },
+        "properties": {
+            "plugin_name": "com.sap.hana.di.tabledata.properties"
+        },
+        "tags": {
+            "plugin_name": "com.sap.hana.di.tabledata.properties"
+        },
+        "txt": {
+            "plugin_name": "com.sap.hana.di.copyonly"
+        }
+    }
+}

packages/bookshop/mta.yaml

@@ -0,0 +1,94 @@
+####### Generated mta.yaml based on template version 0.2.0
+####### appName = capire-bookshop
+####### language=nodejs; multiTenant=
+####### approuter=
+_schema-version: '3.1'
+ID: sap.capire-bookshop
+version: 1.0.0
+description: "A simple bookshop application, build in a self-contained all-in-one fashion, i.e. w/o reusing other packages."
+
+build-parameters:
+  before-all:
+   - builder: custom
+     commands:
+      - npm install
+      - cds build/all
+
+parameters:
+  enable-parallel-deployments: true  
+
+modules:
+ ##############    SERVER MODULE   ##########################
+ - name: capire-bookshop-srv
+   type: nodejs
+   path: gen/srv
+   properties:
+     EXIT: 1  # required by deploy.js task to terminate 
+
+   
+   requires:
+    #### Resources extracted from CAP configuration ####
+    - name: capire-bookshop-db
+    - name: capire-bookshop-uaa
+
+   provides:
+    - name: srv-binding    # required by consumers of CAP services (e.g. approuter)
+      properties:
+        srv-url: ${default-url}
+
+ ############################################################
+
+ ##############    SIDECAR MODULE   #########################
+ - name: db
+    
+   type: hdb
+   path: gen/db  
+   parameters:
+     app-name: capire-bookshop-db  
+   requires:
+    #### Hana and xsuaa resources extracted from CAP configuration ####
+    - name: capire-bookshop-db
+    - name: capire-bookshop-uaa
+ ############################################################
+
+  ##############    APP   #########################
+ - name: capire-bookshop-app
+   type: nodejs
+   path: gen/app
+   parameters:
+      memory: 256M
+   build-parameters:
+     requires:
+       - name: capire-bookshop-srv
+   requires:
+    - name: capire-bookshop-uaa
+    - name: srv-binding
+      group: destinations
+      properties:
+         forwardAuthToken: true
+         name: srv-binding
+         url: ~{srv-url}
+
+##############  RESOURCES  ##################################
+resources:
+ ##### Services extracted from CAP configuration  ####
+ ##### 'service-plan' can be configured via 'cds.requires.<name>.vcap.plan'
+ - name: capire-bookshop-db
+   type: com.sap.xs.hdi-container 
+   
+   parameters:
+     service: hanatrial
+   properties:
+     hdi-service-name: ${service-name}   # required for Java case
+ - name: capire-bookshop-uaa
+    
+   type: org.cloudfoundry.managed-service
+   parameters:
+    ##### Path to xs-security.json to add roles and scopes   ####    
+     path: ./xs-security.json
+     service: xsuaa
+     service-plan: application  
+     config:
+       xsappname: capire-bookshop-${space}    #  name + space dependency
+       tenant-mode: dedicated
+############################################################

packages/bookshop/package.json

@@ -1,21 +1,29 @@
 {
-  "name": "@sap/capire-bookshop",
-  "version": "1.0.0",
-  "description": "A simple bookshop application, build in a self-contained all-in-one fashion, i.e. w/o reusing other packages.",
-  "license": "SAP SAMPLE CODE LICENSE",
-  "dependencies": {
-    "@sap/cds": "^3",
-    "express": "^4"
-  },
-  "scripts": {
-    "start": "cds run --in-memory?",
-    "watch": "cds watch"
-  },
-  "cds": {
-    "requires": {
-      "db": {
-        "kind": "sql"
-      }
+    "name": "@sap/capire-bookshop",
+    "version": "1.0.0",
+    "description": "A simple bookshop application, build in a self-contained all-in-one fashion, i.e. w/o reusing other packages.",
+    "license": "SAP SAMPLE CODE LICENSE",
+    "dependencies": {
+        "@sap/cds": "^4",
+        "express": "^4",
+        "hdb": "^0.18.1",
+        "passport": "^0.4.1"
+    },
+    "scripts": {
+        "start": "cds run --in-memory?",
+        "watch": "cds watch"
+    },
+    "cds": {
+        "requires": {
+            "db": {
+                "kind": "sql",
+                "[production]": {
+                    "kind": "hana"
+                }
+            },
+            "uaa": {
+                "kind": "xsuaa"
+            }
+        }
     }
-  }
-}
+}

packages/bookshop/srv/admin-service.cds

@@ -1,6 +1,6 @@
 using { sap.capire.bookshop as my } from '../db/schema';
 
-service AdminService @(_requires:'authenticated-user',path:'/admin') {
+service AdminService @(_requires:'authenticated-user') {
   entity Books as projection on my.Books;
   entity Authors as projection on my.Authors;
   entity Orders as select from my.Orders;
@@ -10,7 +10,11 @@ service AdminService @(_requires:'authenticated-user',path:'/admin') {
 annotate AdminService.Orders with @odata.draft.enabled;
 // annotate AdminService.Books with @odata.draft.enabled;
 
-// Temporary workaround -> cap/issues#3121
+// Temporary workaround -> https://github.wdf.sap.corp/cap/issues/issues/3121
 extend service AdminService with {
   entity OrderItems as select from my.OrderItems;
 }
+// Restrict access to orders to users with role "admin"
+ annotate AdminService.Orders with  @(restrict: [
+   { grant: 'READ', to: 'admin' } 
+  ]);

packages/bookshop/srv/admin-service.js

@@ -0,0 +1,10 @@
+/** Service implementation for AdminService */
+module.exports = cds.service.impl(function() {
+    this.before ('CREATE', 'Orders', _checkOrderCreateAuth)
+  })
+  
+  
+  /** Check authorization  */
+  function _checkOrderCreateAuth (req) {
+    req.user.currency[0] === req.data.currency_code || req.reject(403)
+  }

packages/bookshop/srv/cat-service.cds

@@ -3,9 +3,15 @@ using { sap.capire.bookshop as my } from '../db/schema';
 @path:'/browse'
 service CatalogService {
 
-  @readonly entity Books as SELECT from my.Books { * } excluding { createdBy, modifiedBy };
+  @readonly entity Books as SELECT from my.Books {*,
+    author.name as author
+  } excluding { createdBy, modifiedBy };
 
   @requires_: 'authenticated-user'
-  @insertonly entity Orders as projection on my.Orders;
+  entity Orders as projection on my.Orders;
 
 }
+// Example for an instance restriction
+ annotate CatalogService.Orders with  @(restrict: [
+   { grant: 'READ', where: 'currency_code = $user.currency'  } 
+  ]);

packages/bookshop/srv/cat-service.js

@@ -14,13 +14,20 @@ function _addDiscount2 (each,discount) {
 
 /** Reduce stock of ordered books if available stock suffices */
 async function _reduceStock (req) {
-  const { Items: OrderItems } = req.data
-  return cds.transaction(req) .run (()=> OrderItems.map (order =>
-    UPDATE (Books) .set ('stock -=', order.amount)
-    .where ('ID =', order.book_ID) .and ('stock >=', order.amount)
-  )) .then (all => all.forEach ((affectedRows,i) => {
-    if (affectedRows === 0)  req.error (409,
-      `${OrderItems[i].amount} exceeds stock for book #${OrderItems[i].book_ID}`
-    )
-  }))
+  const { Items: orderItems } = req.data
+  if (!Array.isArray(orderItems))  return
+
+  const all = await cds.transaction(req).run(orderItems.map(item =>
+    UPDATE(Books)
+      .set('stock -=', item.amount)
+      .where('ID =', item.book_ID).and('stock >=', item.amount)
+  ))
+  all.forEach((affectedRows, i) => {
+    if (affectedRows === 0) {
+      req.error(409, `${orderItems[i].amount} exceeds stock for book #${orderItems[i].book_ID}`)
+    }
+  })
+
+ return all
+
 }

packages/bookshop/tests/bookshop.http

@@ -1,14 +1,18 @@
-### Browse Books
-GET http://localhost:4004/browse/Books
+### Service Document
+GET http://localhost:4004/browse
 
-### Browse Books with expanded Authors
-GET http://localhost:4004/browse/Books?$expand=author
+### Service $metadata document
+GET http://localhost:4004/browse/$metadata
 
-### Try to insert into Books
-POST http://localhost:4004/browse/Books
-Content-Type: application/json
+### Browsing Books
+GET http://localhost:4004/browse/Books?
+# &$select=title,author
+# &$expand=currency
+# &sap-language=de
 
-{ 
-    "title": "Anna Karenina",
-    "stock": 10
-}
+### Browsing Authors
+GET http://localhost:4004/admin/Authors?
+# &$select=name,dateOfBirth,placeOfBirth
+# &$expand=books($select=title;$expand=currency)
+# &$filter=ID eq 101
+# &sap-language=de

packages/bookshop/tests/orders.http

@@ -1,15 +1,18 @@
-### List all Orders - deep read
+
+### List Books with their current stocks
+GET http://localhost:4004/admin/Books?$select=ID,stock
+
+### List all Orders
 GET http://localhost:4004/admin/Orders?
 &$expand=Items
 
-### Submit Orders - deep insert
+### Submit Orders
 POST http://localhost:4004/browse/Orders
 Content-Type: application/json
 
-{ "OrderNo":"1234", "Items":[
+{ "OrderNo":"2019-09...", "Items":[
     { "book_ID":201, "amount":5 },
     { "book_ID":207, "amount":3 }
 ]}
 
-### Try to get the Orders
-GET http://localhost:4004/browse/Orders
+# Sending this three times should result in a 409: 5 exceeds stock for book #201

packages/bookshop/xs-security.json

@@ -0,0 +1,37 @@
+{
+  "xsappname": "capire-bookshop",
+  "tenant-mode": "dedicated",
+  "scopes": [
+    {
+      "name": "$XSAPPNAME.admin",
+      "description": "admin"
+    }
+  ],
+  "attributes": [
+    {
+      "name": "currency",
+      "description": "currency",
+      "valueType": "s",
+      "valueRequired": false
+    }
+  ],
+  "role-templates": [
+    {
+      "name": "admin",
+      "description": "generated",
+      "scope-references": [
+        "$XSAPPNAME.admin"
+      ],
+      "attribute-references": []
+    },
+    {
+      "name": "userattributes",
+      "description": "generated",
+      "default-role-name": "Attributes of a User",
+      "scope-references": [],
+      "attribute-references": [
+        "currency"
+      ]
+    }
+  ]
+}