rm server.js (#327)

NPM registry: more robust,  work on Windows

.github/workflows/node.js.yml

@@ -5,9 +5,9 @@ name: CI
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
 jobs:
   build:

.registry/server.js

@@ -1,17 +1,22 @@
 const { exec } = require ('child_process')
+const isWin = process.platform === 'win32'
 const express = require ('express')
 const fs = require ('fs')
 const app = express()
 
 const { PORT=4444 } = process.env
-const [,,port=PORT] = process.argv
+const [,,port=PORT,scope='@capire'] = process.argv
 const cwd = __dirname
 
+// clean up on start (exit handler might not complete on Windows)
+exec(isWin ? 'del *.tgz' : 'rm *.tgz', {cwd})
+
+
 app.use('/-/:tarball', (req,res,next) => {
   console.debug ('GET', req.params)
   try {
     const { tarball } = req.params
-    const [, pkg ] = /^capire-(\w+)/.exec(tarball)
+    const [, pkg ] = /^\w+-(\w+)/.exec(tarball)
     fs.lstat(tarball,(err => {
       if (err) exec(`npm pack ../${pkg}`,{cwd},next)
       else next()
@@ -25,12 +30,14 @@ app.use('/-/:tarball', (req,res,next) => {
 app.use('/-', express.static(__dirname))
 
 app.get('/*', (req,res)=>{
+  const urlRegex = /^\/(@\w+)\/(\w+)/
   const url = decodeURIComponent(req.url)
   console.debug ('GET',url)
   try {
-    const [, capire, pkg ] = /^\/(@capire)\/(\w+)/.exec(url)
+    if (!urlRegex.test(url))  return res.sendStatus(404)
-    const package = require (`${capire}/${pkg}/package.json`)
+    const [, scpe, pkg ] = urlRegex.exec(url)
-    const tarball = `capire-${pkg}-${package.version}.tgz`
+    const package = require (`${scpe}/${pkg}/package.json`)
+    const tarball = `${scpe.slice(1)}-${pkg}-${package.version}.tgz`
     // https://github.com/npm/registry/blob/master/docs/responses/package-metadata.md
     res.json({
       "name": package.name,
@@ -42,29 +49,30 @@ app.get('/*', (req,res)=>{
           "name": package.name,
           "version": package.version,
           "dist": {
-            "tarball": `http://localhost:${port}/-/${tarball}`
+            "tarball": `/-/${tarball}`
           },
         }
       },
     })
   } catch (e) {
-    console.error(e)
+    if (e.code === 'MODULE_NOT_FOUND')  return res.sendStatus(404)
-    res.sendStatus(404)
+    console.error(e);  throw e
   }
 })
 
-app.listen(port, ()=>{
+const server = app.listen(port, ()=>{
-  console.log (`npm set @capire:registry=http://localhost:${port}`)
+  const url = `http://localhost:${server.address().port}`
-  console.log (`@capire registry listening on http://localhost:${port}`)
+  console.log (`npm set ${scope}:registry=${url}`)
-  exec(`npm set @capire:registry=http://localhost:${port}`)
+  exec(`npm set ${scope}:registry=${url}`)
+  console.log (`${scope} registry listening on ${url}`)
 })
 
+
 const _exit = ()=>{
-  console.log ('\nnpm conf rm @capire:registry')
+  server.close()
-  exec('npm conf rm @capire:registry')
+  exec(`npm conf rm "${scope}:registry"`, ()=> { process.exit() })
-  exec('rm *.tgz')
-  process.exit()
 }
+
 process.on ('SIGTERM',_exit)
 process.on ('SIGHUP',_exit)
 process.on ('SIGINT',_exit)

.tours/db-native.tour

@@ -105,5 +105,5 @@
       "description": "### Summary\n\nThat's it!  You have seen: \n- How to integrate database-specific functions in a CDS model.\n- How to switch between the two implementations for SQLite and SAP HANA."
     }
   ],
-  "ref": "master"
+  "ref": "main"
 }

README.md

@@ -17,7 +17,7 @@ Find here a collection of samples for the [SAP Cloud Application Programming Mod
 
 ### Download
 
-If you've [Git](https://git-scm.com/downloads) installed, clone this repo as shown below, otherwise [download as ZIP file](archive/master.zip).
+If you've [Git](https://git-scm.com/downloads) installed, clone this repo as shown below, otherwise [download as ZIP file](archive/main.zip).
 
 ```sh
 git clone https://github.com/sap-samples/cloud-cap-samples samples

bookshop/app/vue/app.js

@@ -10,7 +10,7 @@ const books = new Vue ({
     data: {
         list: [],
         book: undefined,
-        order: { amount:1, succeeded:'', failed:'' }
+        order: { quantity:1, succeeded:'', failed:'' }
     },
 
     methods: {
@@ -26,18 +26,18 @@ const books = new Vue ({
             const book = books.book = books.list [eve.currentTarget.rowIndex-1]
             const res = await GET(`/Books/${book.ID}?$select=descr,stock,image`)
             Object.assign (book, res.data)
-            books.order = { amount:1 }
+            books.order = { quantity:1 }
             setTimeout (()=> $('form > input').focus(), 111)
         },
 
         async submitOrder () {
-            const {book,order} = books, amount = parseInt (order.amount) || 1 // REVISIT: Okra should be less strict
+            const {book,order} = books, quantity = parseInt (order.quantity) || 1 // REVISIT: Okra should be less strict
             try {
-                const res = await POST(`/submitOrder`, { amount, book: book.ID })
+                const res = await POST(`/submitOrder`, { quantity, book: book.ID })
                 book.stock = res.data.stock
-                books.order = { amount, succeeded: `Successfully ordered ${amount} item(s).` }
+                books.order = { quantity, succeeded: `Successfully ordered ${quantity} item(s).` }
             } catch (e) {
-                books.order = { amount, failed: e.response.data.error.message }
+                books.order = { quantity, failed: e.response.data.error.message }
             }
         }
 

bookshop/app/vue/index.html

@@ -34,7 +34,7 @@
             <td>{{ book.author }}</td>
             <td>{{ book.genre.name }}</td>
             <td class="rating-stars">
-                {{ ('★'.repeat(Math.round(book.rating))+'☆☆☆☆☆').slice(0,5) }}
+                {{ ('★'.repeat(Math.round(book.rating))+'☆☆☆☆☆').slice(0,5) }} ({{ book.numberOfReviews }})
             </td>
             <td>{{ book.currency && book.currency.symbol }} {{ book.price }}</td>
         </tr>
@@ -48,7 +48,7 @@
             &nbsp;&nbsp; {{ book.stock }} in stock
         </label>
         <form @submit.prevent="submitOrder" style="float:right; display:flex; flex-direction:row-reverse">
-            <input type="number" v-model="order.amount" v-bind:class="{ failed: order.failed }" style="width:5em">
+            <input type="number" v-model="order.quantity" v-bind:class="{ failed: order.failed }" style="width:5em">
             <input type="submit" value="Order:" class="muted-button">
         </form>
         <h4> {{ book.title }} </h4>

bookshop/index.js

@@ -1 +1,2 @@
-exports.CatalogService = require('./srv/cat-service')
+const { CatalogService } = require('./srv/cat-service')
+module.exports = { CatalogService }

bookshop/srv/cat-service.cds

@@ -11,6 +11,6 @@ service CatalogService @(path:'/browse') {
   } excluding { createdBy, modifiedBy };
 
   @requires: 'authenticated-user'
-  action submitOrder ( book: Books:ID, amount: Integer ) returns { stock: Integer };
+  action submitOrder ( book: Books:ID, quantity: Integer ) returns { stock: Integer };
-  event OrderedBook : { book: Books:ID; amount: Integer; buyer: String };
+  event OrderedBook : { book: Books:ID; quantity: Integer; buyer: String };
 }

bookshop/srv/cat-service.js

@@ -1,18 +1,19 @@
 const cds = require('@sap/cds')
-const { Books } = cds.entities ('sap.capire.bookshop')
 
 class CatalogService extends cds.ApplicationService { init(){
 
+  const { Books } = cds.entities ('sap.capire.bookshop')
+
   // Reduce stock of ordered books if available stock suffices
   this.on ('submitOrder', async req => {
-    const {book,amount} = req.data
+    const {book,quantity} = req.data
     let {stock} = await SELECT `stock` .from (Books,book)
-    if (stock >= amount) {
+    if (stock >= quantity) {
-      await UPDATE (Books,book) .with (`stock -=`, amount)
+      await UPDATE (Books,book) .with (`stock -=`, quantity)
-      await this.emit ('OrderedBook', { book, amount, buyer:req.user.id })
+      await this.emit ('OrderedBook', { book, quantity, buyer:req.user.id })
       return { stock }
     }
-    else return req.error (409,`${amount} exceeds stock for book #${book}`)
+    else return req.error (409,`${quantity} exceeds stock for book #${book}`)
   })
 
   // Add some discount for overstocked books

bookshop/test/requests.http

@@ -71,7 +71,7 @@ POST {{server}}/browse/submitOrder
 Content-Type: application/json
 {{me}}
 
-{ "book":201, "amount":5 }
+{ "book":201, "quantity":5 }
 
 
 ### ------------------------------------------------------------------------

bookstore/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@capire/bookstore",
+  "version": "1.0.0",
+  "dependencies": {
+    "@capire/bookshop": "*",
+    "@capire/reviews": "*",
+    "@capire/orders": "*",
+    "@capire/common": "*",
+    "@sap/cds": "^5",
+    "express": "^4.17.1"
+  },
+  "cds": {
+    "requires": {
+      "ReviewsService": {
+        "kind": "odata",
+        "model": "@capire/reviews"
+      },
+      "OrdersService": {
+        "kind": "odata",
+        "model": "@capire/orders"
+      },
+      "messaging": {
+        "[development]": { "kind": "file-based-messaging" },
+        "[hybrid]": { "kind": "enterprise-messaging-shared" },
+        "[production]": { "kind": "enterprise-messaging" }
+      },
+      "db": {
+        "kind": "sql",
+        "[development]": {
+          "model": "db/sqlite"
+        },
+        "[production]": {
+          "model": "db/hana"
+        }
+      }
+    },
+    "log": { "service": true }
+  }
+}

bookstore/server.js

@@ -0,0 +1,21 @@
+const cds = require ('@sap/cds')
+
+// Add mashup logic
+cds.once('served', require('./srv/mashup'))
+
+// Add routes to UIs from imported packages
+cds.once('bootstrap',(app)=>{
+  app.serve ('/bookshop') .from ('@capire/bookshop','app/vue')
+  app.serve ('/reviews') .from ('@capire/reviews','app/vue')
+  app.serve ('/orders') .from('@capire/orders','app/orders')
+})
+
+// Add Swagger UI
+require('./srv/swagger-ui')
+
+// Returning cds.server
+module.exports = cds.server
+
+// For didactic reasons in capire
+const { ReviewsService, OrdersService } = cds.requires
+if (!ReviewsService.credentials && !OrdersService.credentials) cds.requires.messaging = false

bookstore/srv/mashup.cds

@@ -1,6 +1,7 @@
 ////////////////////////////////////////////////////////////////////////////
 //
-//    Mashing up imported models...
+//    Enhancing bookshop with Reviews and Orders provided through
+//    respective reuse packages and services
 //
 
 using { sap.capire.bookshop.Books } from '@capire/bookshop';
@@ -8,18 +9,22 @@ using { sap.capire.bookshop.Books } from '@capire/bookshop';
 //
 //  Extend Books with access to Reviews and average ratings
 //
-
 using { ReviewsService.Reviews } from '@capire/reviews';
 extend Books with {
   reviews : Composition of many Reviews on reviews.subject = $self.ID;
   rating  : Decimal;
+  numberOfReviews : Integer;
 }
 
+
 //
 //  Extend Orders with Books as Products
 //
-
 using { sap.capire.orders.Orders_Items } from '@capire/orders';
 extend Orders_Items with {
   book : Association to Books on product.ID = book.ID
 }
+
+
+// Add orders fiori app (in case of embedded orders service)
+using from '@capire/orders/app/fiori';

bookstore/srv/mashup.js

@@ -1,6 +1,6 @@
 ////////////////////////////////////////////////////////////////////////////
 //
-//    Mashing up provided and required services...
+//    Mashing up bookshop services with required services...
 //
 module.exports = async()=>{ // called by server.js
 
@@ -20,30 +20,29 @@ module.exports = async()=>{ // called by server.js
   CatalogService.prepend (srv => srv.on ('READ', 'Books/reviews', (req) => {
     console.debug ('> delegating request to ReviewsService')
     const [id] = req.params, { columns, limit } = req.query.SELECT
-    return ReviewsService.tx(req).read ('Reviews',columns).limit(limit).where({subject:String(id)})
+    return ReviewsService.read ('Reviews',columns).limit(limit).where({subject:String(id)})
   }))
 
   //
   // Create an order with the OrdersService when CatalogService signals a new order
   //
   CatalogService.on ('OrderedBook', async (msg) => {
-    const { book, amount, buyer } = msg.data
+    const { book, quantity, buyer } = msg.data
     const { title, price } = await db.tx(msg).read (Books, book, b => { b.title, b.price })
     return OrdersService.tx(msg).create ('Orders').entries({
       OrderNo: 'Order at '+ (new Date).toLocaleString(),
-      Items: [{ product:{ID:`${book}`}, title, price, amount }],
+      Items: [{ product:{ID:`${book}`}, title, price, quantity }],
       buyer, createdBy: buyer
     })
   })
 
   //
-  // Update Books' average ratings when ReviewsService signals updatd reviews
+  // Update Books' average ratings when ReviewsService signals updated reviews
   //
   ReviewsService.on ('reviewed', (msg) => {
     console.debug ('> received:', msg.event, msg.data)
-    const { subject, rating } = msg.data
+    const { subject, count, rating } = msg.data
-    return UPDATE(Books,subject).with({rating})
+    return UPDATE(Books,subject).with({ numberOfReviews:count, rating })
-    // ^ Note: the framework will execute this and take care for db.tx
   })
 
   //
@@ -51,9 +50,9 @@ module.exports = async()=>{ // called by server.js
   //
   OrdersService.on ('OrderChanged', (msg) => {
     console.debug ('> received:', msg.event, msg.data)
-    const { product, deltaAmount } = msg.data
+    const { product, deltaQuantity } = msg.data
     return UPDATE (Books) .where ('ID =', product)
-    .and ('stock >=', deltaAmount)
+    .and ('stock >=', deltaQuantity)
-    .set ('stock -=', deltaAmount)
+    .set ('stock -=', deltaQuantity)
   })
 }

bookstore/srv/swagger-ui.js

@@ -0,0 +1,10 @@
+
+// -----------------------------------------------------------------------
+// Adding Swagger UI - see https://cap.cloud.sap/docs/advanced/openapi
+const cds = require ('@sap/cds')
+try {
+  const cds_swagger = require ('cds-swagger-ui-express')
+  cds.once ('bootstrap', app => app.use (cds_swagger()) )
+} catch (err) {
+  if (err.code !== 'MODULE_NOT_FOUND')  throw err
+}

bookstore/test/requests.http

@@ -2,7 +2,7 @@
 @bookshop = http://localhost:4004
 @reviews-service = {{bookshop}}/reviews
 # Uncomment this when running a separate reviews service
-@reviews-service = http://localhost:4005/reviews
+# @reviews-service = http://localhost:4005/reviews
 
 
 

fiori/.env

@@ -1,2 +0,0 @@
-# cds.requires.messaging.kind = file-based-messaging
-PORT = 4004

fiori/app/admin/fiori-service.cds

@@ -1,4 +1,5 @@
-using { AdminService, sap.capire.bookshop } from '../../db/schema';
+using { AdminService } from '@capire/bookshop';
+using from '../common'; // to help UI linter get the complete annotations
 
 ////////////////////////////////////////////////////////////////////////////
 //
@@ -86,9 +87,8 @@ annotate AdminService.Books.texts with @(
 annotate AdminService.Books.texts {
 	locale @ValueList:{entity:'Languages',type:#fixed}
 }
-// In addition we need to expose Languages and Books.texts through AdminService
+// In addition we need to expose Languages through AdminService as a target for ValueList
 using { sap } from '@sap/cds/common';
 extend service AdminService {
-	entity Languages as projection on sap.common.Languages;
+	@readonly entity Languages as projection on sap.common.Languages;
-	entity Books.texts as projection on bookshop.Books.texts;
 }

fiori/app/bookshop.html

@@ -1,3 +0,0 @@
-<head>
-  <meta http-equiv="refresh" content="0;url=bookshop/index.html">
-</head>

fiori/app/reviews.html

@@ -1,3 +0,0 @@
-<head>
-  <meta http-equiv="refresh" content="0;url=reviews/index.html">
-</head>

fiori/app/services.cds

@@ -6,7 +6,4 @@ using from './admin/fiori-service';
 using from './browse/fiori-service';
 using from './common';
 
-using from '@capire/common';
+using from '@capire/bookstore/srv/mashup';
-
-// only works in case of embedded orders service
-using from '@capire/orders/app/orders/fiori-service';

fiori/package.json

@@ -2,10 +2,7 @@
   "name": "@capire/fiori",
   "version": "1.0.0",
   "dependencies": {
-    "@capire/bookshop": "*",
+    "@capire/bookstore": "*",
-    "@capire/reviews": "*",
-    "@capire/orders": "*",
-    "@capire/common": "*",
     "@sap/cds": "^5",
     "express": "^4.17.1",
     "passport": "^0.4.1"
@@ -15,9 +12,6 @@
     "watch": "cds watch"
   },
   "cds": {
-    "hana": {
-      "deploy-format": "hdbtable"
-    },
     "requires": {
       "auth": {
         "strategy": "dummy"
@@ -26,18 +20,17 @@
         "kind": "odata",
         "model": "@capire/reviews"
       },
-      "--> OrdersService": {
+      "OrdersService": {
         "kind": "odata",
         "model": "@capire/orders"
       },
-      "db": {
+      "messaging": {
-        "kind": "sql",
+        "[production]": { "kind": "enterprise-messaging" },
-        "[development]": {
+        "[development]": { "kind": "file-based-messaging" },
-          "model": "db/sqlite"
+        "[hybrid!]": { "kind": "enterprise-messaging-shared" }
       },
-        "[production]": {
+      "hana": {
-          "model": "db/hana"
+        "deploy-format": "hdbtable"
-        }
       }
     }
   }

fiori/server.js

@@ -1,23 +1 @@
-const cds = require ('@sap/cds')
+module.exports = require('@capire/bookstore/server.js')
-module.exports = cds.server
-
-cds.once('bootstrap',(app)=>{
-  app.use ('/orders/webapp', _from('@capire/orders/app/orders/webapp/manifest.json'))
-  app.use ('/bookshop', _from('@capire/bookshop/app/vue/index.html'))
-  app.use ('/reviews', _from('@capire/reviews/app/vue/index.html'))
-})
-
-cds.once('served', require('./srv/mashup'))
-
-// Swagger UI - see https://cap.cloud.sap/docs/advanced/openapi
-if (process.env.NODE_ENV !== 'production') {
-  const cds_swagger = require ('cds-swagger-ui-express')
-  cds.once ('bootstrap', app => app.use (cds_swagger()) )
-}
-
-
-// -----------------------------------------------------------------------
-// Helper for serving static content from npm-installed packages
-const {static} = require('express')
-const {dirname} = require('path')
-const _from = target => static (dirname (require.resolve(target)))

graphql/.env

@@ -0,0 +1 @@
+PORT = 4007

graphql/db/data/sap.capire.graphql-Chapters.csv

@@ -0,0 +1,4 @@
+book_ID;number;title
+201;1;Chapter 1
+201;2;Chapter 2
+201;3;Chapter 3