Test: CSV UPSERT from different layers

.github/workflows/node.js.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18.x, 16.x]
+        node-version: [18.x, 16.x, 14.x]
 
     steps:
     - uses: actions/checkout@v2

README.md

@@ -54,6 +54,24 @@ npx jest
 ```
 > While mocha is a bit smaller and faster, jest runs tests in parallel and isolation, which allows to run all tests.
 
+
+### Serve `npm`
+
+We've included a simple npm registry mock, which allows you to do an `npm install @capire/<package>` locally. Use it as follows:
+
+1. Start the @capire registry:
+```sh
+npm run registry
+```
+> While running this will have `@capire:registry=http://localhost:4444` set with npmrc.
+
+2. Install one of the @capire packages wherever you like, for example:
+
+```sh
+npm add @capire/common @capire/bookshop
+```
+
+
 ## Code Tours
 
 Take one of the [guided tours](.tours) in VS Code through our CAP samples and learn which CAP features are showcased by the different parts of the repository. Just install the [CodeTour extension](https://marketplace.visualstudio.com/items?itemName=vsls-contrib.codetour) for VS Code. We'll add more code tours in the future. Stay tuned!

bookshop/cds-plugin.js

@@ -1,3 +0,0 @@
-cds.once('bootstrap',(app)=>{
-  app.serve ('/bookshop') .from ('@capire/bookshop','app/vue')
-})

bookshop/db/data/sap.capire.bookshop-Books.texts.csv

@@ -1,5 +1,5 @@
-ID,locale,title,descr
-201,de,Sturmhöhe,"Sturmhöhe (Originaltitel: Wuthering Heights) ist der einzige Roman der englischen Schriftstellerin Emily Brontë (1818–1848). Der 1847 unter dem Pseudonym Ellis Bell veröffentlichte Roman wurde vom viktorianischen Publikum weitgehend abgelehnt, heute gilt er als ein Klassiker der britischen Romanliteratur des 19. Jahrhunderts."
-201,fr,Les Hauts de Hurlevent,"Les Hauts de Hurlevent (titre original : Wuthering Heights), parfois orthographié Les Hauts de Hurle-Vent, est l'unique roman d'Emily Brontë, publié pour la première fois en 1847 sous le pseudonyme d’Ellis Bell. Loin d'être un récit moralisateur, Emily Brontë achève néanmoins le roman dans une atmosphère sereine, suggérant le triomphe de la paix et du Bien sur la vengeance et le Mal."
-207,de,Jane Eyre,"Jane Eyre. Eine Autobiographie (Originaltitel: Jane Eyre. An Autobiography), erstmals erschienen im Jahr 1847 unter dem Pseudonym Currer Bell, ist der erste veröffentlichte Roman der britischen Autorin Charlotte Brontë und ein Klassiker der viktorianischen Romanliteratur des 19. Jahrhunderts. Der Roman erzählt in Form einer Ich-Erzählung die Lebensgeschichte von Jane Eyre (ausgesprochen /ˌdʒeɪn ˈɛə/), die nach einer schweren Kindheit eine Stelle als Gouvernante annimmt und sich in ihren Arbeitgeber verliebt, jedoch immer wieder um ihre Freiheit und Selbstbestimmung kämpfen muss. Als klein, dünn, blass, stets schlicht dunkel gekleidet und mit strengem Mittelscheitel beschrieben, gilt die Heldin des Romans Jane Eyre nicht zuletzt aufgrund der Kino- und Fernsehversionen der melodramatischen Romanvorlage als die bekannteste englische Gouvernante der Literaturgeschichte"
-252,de,Eleonora,"“Eleonora” ist eine Erzählung von Edgar Allan Poe. Sie wurde 1841 erstveröffentlicht. In ihr geht es um das Paradox der Treue in der Treulosigkeit."
+ID_texts;ID;locale;title;descr
+a5fe2682-fe60-4dc0-9218-695e501e42e6;201;de;Sturmhöhe;Sturmhöhe (Originaltitel: Wuthering Heights) ist der einzige Roman der englischen Schriftstellerin Emily Brontë (1818–1848). Der 1847 unter dem Pseudonym Ellis Bell veröffentlichte Roman wurde vom viktorianischen Publikum weitgehend abgelehnt, heute gilt er als ein Klassiker der britischen Romanliteratur des 19. Jahrhunderts.
+4edebff3-8cde-4761-8cd3-bae7834fc5f5;201;fr;Les Hauts de Hurlevent;Les Hauts de Hurlevent (titre original : Wuthering Heights), parfois orthographié Les Hauts de Hurle-Vent, est l'unique roman d'Emily Brontë, publié pour la première fois en 1847 sous le pseudonyme d’Ellis Bell. Loin d'être un récit moralisateur, Emily Brontë achève néanmoins le roman dans une atmosphère sereine, suggérant le triomphe de la paix et du Bien sur la vengeance et le Mal.
+b649031b-aacc-4dc3-838f-c36bae5d266e;207;de;Jane Eyre;Jane Eyre. Eine Autobiographie (Originaltitel: Jane Eyre. An Autobiography), erstmals erschienen im Jahr 1847 unter dem Pseudonym Currer Bell, ist der erste veröffentlichte Roman der britischen Autorin Charlotte Brontë und ein Klassiker der viktorianischen Romanliteratur des 19. Jahrhunderts. Der Roman erzählt in Form einer Ich-Erzählung die Lebensgeschichte von Jane Eyre (ausgesprochen /ˌdʒeɪn ˈɛə/), die nach einer schweren Kindheit eine Stelle als Gouvernante annimmt und sich in ihren Arbeitgeber verliebt, jedoch immer wieder um ihre Freiheit und Selbstbestimmung kämpfen muss. Als klein, dünn, blass, stets schlicht dunkel gekleidet und mit strengem Mittelscheitel beschrieben, gilt die Heldin des Romans Jane Eyre nicht zuletzt aufgrund der Kino- und Fernsehversionen der melodramatischen Romanvorlage als die bekannteste englische Gouvernante der Literaturgeschichte
+aa62f0e1-763c-4c92-a304-50c2b86e21f4;252;de;Eleonora;“Eleonora” ist eine Erzählung von Edgar Allan Poe. Sie wurde 1841 erstveröffentlicht. In ihr geht es um das Paradox der Treue in der Treulosigkeit.

bookshop/db/data/sap.common-Currencies.csv

@@ -0,0 +1,3 @@
+code;descr
+EUR;EUR from bookshop
+USD;USD from bookshop

bookshop/db/init.js

@@ -4,10 +4,15 @@
  * currencies, if not obtained through @capire/common.
  */
 
-// NOTE: We use cds.on('served') to delay the UPSERTs after the db init
-// to run after all INSERTs from .csv files happened.
-module.exports = cds.on('served', ()=> cds.run(
-  UPSERT.into ('sap.common.Currencies') .columns (
+module.exports = async (tx)=>{
+
+  const has_common = tx.model.definitions['sap.common.Currencies']?.elements.numcode
+  if (has_common) return
+
+  const already_filled = await tx.exists('sap.common.Currencies',{code:'EUR'})
+  if (already_filled) return
+
+  await tx.run (INSERT.into ('sap.common.Currencies') .columns (
     [ 'code', 'symbol', 'name' ]
   ) .rows (
     [ 'EUR', '€', 'Euro' ],
@@ -15,5 +20,5 @@ module.exports = cds.on('served', ()=> cds.run(
     [ 'GBP', '£', 'British Pound' ],
     [ 'ILS', '₪', 'Shekel' ],
     [ 'JPY', '¥', 'Yen' ],
-  )
-))
+  ))
+}

bookshop/db/schema.cds

@@ -3,9 +3,9 @@ namespace sap.capire.bookshop;
 
 entity Books : managed {
   key ID : Integer;
-  title  : localized String(111) @mandatory ;
+  @mandatory title  : localized String(111);
   descr  : localized String(1111);
-  author : Association to Authors @mandatory;
+  @mandatory author : Association to Authors;
   genre  : Association to Genres;
   stock  : Integer;
   price  : Decimal;
@@ -15,7 +15,7 @@ entity Books : managed {
 
 entity Authors : managed {
   key ID : Integer;
-  name   : String(111) @mandatory;
+  @mandatory name   : String(111);
   dateOfBirth  : Date;
   dateOfDeath  : Date;
   placeOfBirth : String;

bookshop/package.json

@@ -9,9 +9,6 @@
     "index.cds",
     "index.js"
   ],
-  "devDependencies": {
-    "@cap-js/sqlite": "*"
-  },
   "dependencies": {
     "@sap/cds": ">=5.9",
     "express": "^4.17.1",
@@ -24,9 +21,7 @@
   },
   "cds": {
     "requires": {
-      "bookshop-services": {
-        "model": "@capire/bookshop"
-      }
+      "db": "sql"
     }
   }
-}
+}

bookshop/srv/admin-service.cds

@@ -1,5 +1,5 @@
 using { sap.capire.bookshop as my } from '../db/schema';
-service AdminService @(requires:'admin', path:'/admin') {
+service AdminService @(requires:'admin') {
   entity Books as projection on my.Books;
   entity Authors as projection on my.Authors;
 }

bookshop/srv/user-service.cds

@@ -1,7 +1,7 @@
 /**
  * Exposes user information
  */
-service UserService @(path: '/user') {
+service UserService {
   /**
    * The current user
    */

bookstore/package.json

@@ -6,7 +6,6 @@
     "@capire/reviews": "*",
     "@capire/orders": "*",
     "@capire/common": "*",
-    "@capire/fiori": "*",    
     "@capire/data-viewer": "*",
     "@sap/cds": ">=5",
     "express": "^4.17.1"

bookstore/server.js

@@ -1,18 +1,22 @@
 const cds = require ('@sap/cds')
 
-// Add routes to UIs from imported packages
-cds.once('bootstrap',(app)=>{
-  app.serve ('/admin-authors') .from ('@capire/fiori','app/admin-authors')
-  app.serve ('/admin-books') .from ('@capire/fiori','app/admin-books')
-  app.serve ('/browse-books') .from ('@capire/fiori','app/browse')
-})
-
 // 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')
+  app.serve ('/data') .from('@capire/data-viewer','app/viewer')
+})
+
 // 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

@@ -30,3 +30,13 @@ extend Orders 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';
+
+// Add data browser
+using from '@capire/data-viewer';
+
+// Incorporate pre-build extensions from...
+using from '@capire/common';

common/package.json

@@ -4,12 +4,5 @@
   "version": "1.0.0",
   "dependencies": {
     "@sap/cds": "*"
-  },
-  "cds": {
-    "requires": {
-      "common-data": {
-        "model": "@capire/common"
-      }
-    }
   }
-}
+}

compose/app/appconfig/fioriSandboxConfig.json

@@ -1,168 +0,0 @@
-{
-  "services": {
-    "LaunchPage": {
-      "adapter": {
-        "config": {
-          "catalogs": [],
-          "groups": [
-            {
-              "id": "Bookshop",
-              "title": "Bookshop",
-              "isPreset": true,
-              "isVisible": true,
-              "isGroupLocked": false,
-              "tiles": [
-                {
-                  "id": "BrowseBooks",
-                  "tileType": "sap.ushell.ui.tile.StaticTile",
-                  "properties": {
-                    "title": "Browse Books",
-                    "targetURL": "#Books-display"
-                  }
-                },
-                {
-                  "id": "BrowseGenres",
-                  "tileType": "sap.ushell.ui.tile.StaticTile",
-                  "properties": {
-                    "title": "Browse Genres (OData v2)",
-                    "targetURL": "#Genres-display"
-                  }
-                }
-              ]
-            },
-            {
-              "id": "Administration",
-              "title": "Administration",
-              "isPreset": true,
-              "isVisible": true,
-              "isGroupLocked": false,
-              "tiles": [
-                {
-                  "id": "ManageBooks",
-                  "tileType": "sap.ushell.ui.tile.StaticTile",
-                  "properties": {
-                    "title": "Manage Books",
-                    "targetURL": "#Books-manage"
-                  }
-                },
-                {
-                  "id": "ManageAuthors",
-                  "tileType": "sap.ushell.ui.tile.StaticTile",
-                  "properties": {
-                    "title": "Manage Authors",
-                    "targetURL": "#Authors-display"
-                  }
-                },
-                {
-                  "id": "ManageOrders",
-                  "tileType": "sap.ushell.ui.tile.StaticTile",
-                  "properties": {
-                    "title": "Manage Orders",
-                    "targetURL": "#Orders-manage"
-                  }
-                }
-              ]
-            }
-          ]
-        }
-      }
-    },
-    "NavTargetResolution": {
-      "config": {
-        "enableClientSideTargetResolution": true
-      }
-    },
-    "ClientSideTargetResolution": {
-      "adapter": {
-        "config": {
-          "inbounds": {
-            "BrowseBooks": {
-              "semanticObject": "Books",
-              "action": "display",
-              "title": "Browse Books",
-              "signature": {
-                "parameters": {
-                  "Books.ID": {
-                    "renameTo": "ID"
-                  },
-                  "Authors.books.ID": {
-                    "renameTo": "ID"
-                  }
-                },
-                "additionalParameters": "ignored"
-              },
-              "resolutionResult": {
-                "applicationType": "SAPUI5",
-                "additionalInformation": "SAPUI5.Component=bookshop",
-                "url": "/browse/webapp"
-              }
-            },
-            "BrowseAuthors": {
-              "semanticObject": "Authors",
-              "action": "display",
-              "title": "Browse Authors",
-              "signature": {
-                "parameters": {
-                  "Books.author.ID":{
-                    "renameTo": "ID"
-                  }
-                },
-                "additionalParameters": "ignored"
-              },
-              "resolutionResult": {
-                "applicationType": "SAPUI5",
-                "additionalInformation": "SAPUI5.Component=authors",
-                "url": "/admin-authors/webapp"
-              }
-            },
-            "BrowseGenres": {
-              "semanticObject": "Genres",
-              "action": "display",
-              "title": "Browse Genres",
-              "signature": {
-                "parameters": {
-                  "Genre.ID": {
-                    "renameTo": "ID"
-                  }
-                },
-                "additionalParameters": "ignored"
-              },
-              "resolutionResult": {
-                "applicationType": "SAPUI5",
-                "additionalInformation": "SAPUI5.Component=genres",
-                "url": "/genres/webapp"
-              }
-            },
-            "ManageBooks": {
-              "semanticObject": "Books",
-              "action": "manage",
-              "title": "Manage Books",
-              "signature": {
-                "parameters": {},
-                "additionalParameters": "allowed"
-              },
-              "resolutionResult": {
-                "applicationType": "SAPUI5",
-                "additionalInformation": "SAPUI5.Component=books",
-                "url": "/admin-books/webapp"
-              }
-            },
-            "ManageOrders": {
-              "semanticObject": "Orders",
-              "action": "manage",
-              "signature": {
-                "parameters": {},
-                "additionalParameters": "allowed"
-              },
-              "resolutionResult": {
-                "applicationType": "SAPUI5",
-                "additionalInformation": "SAPUI5.Component=orders",
-                "url": "/orders/webapp"
-              }
-            }
-          }
-        }
-      }
-    }
-  }
-}

compose/package.json

@@ -1,12 +0,0 @@
-{
-  "name": "@capire/bookstore",
-  "version": "1.0.0",
-  "dependencies": {
-    "@capire/bookshop": "*",
-    "@capire/reviews": "*",
-    "@capire/fiori": "*",
-    "@capire/orders": "*",
-    "@sap/cds": ">=5",
-    "express": "^4.17.1"
-  }
-}

compose/server.js

@@ -1,8 +0,0 @@
-const cds = require ('@sap/cds')
-
-// Add Swagger UI
-require('./srv/swagger-ui')
-
-// For didactic reasons in capire
-const { ReviewsService, OrdersService } = cds.requires
-if (!ReviewsService?.credentials && !OrdersService?.credentials) cds.requires.messaging = false

compose/srv/swagger-ui.js

@@ -1,10 +0,0 @@
-
-// -----------------------------------------------------------------------
-// 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
-}

data-viewer/app/viewer/app.js

@@ -1,5 +1,5 @@
 /* global Vue axios */ //> from vue.html
-const GET = (url) => axios.get('/odata/v4/-data'+url)
+const GET = (url) => axios.get('/-data'+url)
 const storageGet = (key, def) => localStorage.getItem('data-viewer:'+key) || def
 const storageSet = (key, val) => localStorage.setItem('data-viewer:'+key, val)
 const columnKeysFirst = (c1, c2) => {

data-viewer/cds-plugin.js

@@ -1,3 +0,0 @@
-cds.once('bootstrap',(app)=>{
-  app.serve ('/data') .from('@capire/data-viewer','app/viewer')
-})

data-viewer/package.json

@@ -9,12 +9,5 @@
     "app",
     "srv",
     "index.cds"
-  ],
-  "cds": {
-    "requires": {
-      "orders-service": {
-        "model": "@capire/data-viewer"
-      }
-    }
-  }
-}
+  ]
+}

fiori/app/genres/webapp/manifest.json

@@ -33,7 +33,7 @@
     "resources": "resources.json",
     "dataSources": {
       "main": {
-        "uri": "/odata/v2/browse",
+        "uri": "/v2/browse",
         "type": "OData",
         "settings": {
           "annotations": ["localAnnotations"],

fiori/cds-plugin.js

@@ -1,9 +0,0 @@
-// install OData v2 adapter
-const cds = require("@sap/cds")
-const proxy = require('@cap-js-community/odata-v2-adapter')
-const opts = global.it ? { target:'auto' } : {}   // for tests, set 'auto' to detect port dynamically
-cds.once('bootstrap', app => {
-    app.use(proxy(opts))  // install proxy
-    // cds.log('cov2ap','silent') // suppress anoying log outpout, e.g. for `npm run mocha -- --reporter nyan`
-    app.serve ('/fiori-apps') .from ('@capire/fiori','app/fiori-apps.html')
-})

fiori/db/data/sap.common-Currencies.csv

@@ -0,0 +1,3 @@
+code;name
+EUR;EUR from fiori
+USD;USD from fiori

fiori/index.cds

@@ -1,8 +1 @@
-using from './db/sqlite/index';
-using from './app/services';
-using from './app/genres/fiori-service';
-using from './app/browse/fiori-service';
-using from './app/admin-books/fiori-service';
-using from './app/admin-authors/fiori-service';
 using from './db/common';
-using from './app/common';

fiori/package.json

@@ -22,9 +22,6 @@
         "kind": "odata",
         "model": "@capire/orders"
       },
-      "self": {
-        "model": "@capire/fiori"
-      },
       "messaging": {
         "[production]": {
           "kind": "enterprise-messaging"
@@ -37,7 +34,8 @@
         }
       },
       "db": {
-        "kind": "sql"
+        "kind": "sqlite",
+        "schema_evolution": "auto"
       },
       "db-ext": {
         "[development]": {

fiori/server.js

@@ -3,6 +3,6 @@ const cds = require("@sap/cds")
 const proxy = require('@cap-js-community/odata-v2-adapter')
 const opts = global.it ? { target:'auto' } : {}   // for tests, set 'auto' to detect port dynamically
 cds.on('bootstrap', app => app.use(proxy(opts)))  // install proxy
-// cds.log('cov2ap','silent') // suppress anoying log outpout, e.g. for `npm run mocha -- --reporter nyan`
+cds.log('cov2ap','silent') // suppress anoying log outpout, e.g. for `npm run mocha -- --reporter nyan`
 
 module.exports = require('@capire/bookstore/server.js')

hello/srv/world.cds

@@ -1,3 +1,3 @@
-service say @(path: '/say') {
+service say {
   function hello (to:String) returns String;
 }

orders/app/orders/webapp/manifest.json

@@ -8,7 +8,7 @@
 		"i18n": "i18n/i18n.properties",
 		"dataSources": {
 			"OrdersService": {
-				"uri": "/odata/v4/orders/",
+				"uri": "/orders/",
 				"type": "OData",
 				"settings": {
 					"odataVersion": "4.0"

orders/cds-plugin.js

@@ -1,3 +0,0 @@
-cds.once('bootstrap',(app)=>{
-  app.serve ('/orders') .from('@capire/orders','app/orders')
-})

orders/package.json

@@ -4,12 +4,5 @@
   "dependencies": {
     "@capire/common": "*",
     "@sap/cds": ">=5"
-  },
-  "cds": {
-    "requires": {
-      "orders-service": {
-        "model": "@capire/orders"
-      }
-    }
   }
 }

package.json

@@ -5,7 +5,7 @@
   "repository": "https://github.com/sap-samples/cloud-cap-samples.git",
   "author": "daniel.hutzel@sap.com",
   "dependencies": {
-    "@sap/cds": ">=7"
+    "@sap/cds": ">=5.5.3"
   },
   "workspaces": [
     "./bookshop",

reviews/cds-plugin.js

@@ -1,3 +0,0 @@
-cds.once('bootstrap',(app)=>{
-  app.serve ('/reviews') .from ('@capire/reviews','app/vue')
-})

reviews/package.json

@@ -12,10 +12,6 @@
   },
   "cds": {
     "requires": {
-      "ReviewsService": {
-        "kind": "odata",
-        "model": "@capire/reviews"
-      },
       "messaging": {
         "[development]": { "kind": "file-based-messaging" },
         "[hybrid]": { "kind": "enterprise-messaging-shared" },

reviews/srv/reviews-service.cds

@@ -1,6 +1,6 @@
 using { sap.capire.reviews as my } from '../db/schema';
 
-service ReviewsService @(path:'/reviews') {
+service ReviewsService {
 
   // Sync API
   entity Reviews as projection on my.Reviews excluding { likes }

test/fiori.test.js

@@ -8,7 +8,7 @@ describe('cap/samples - Fiori APIs - v2', function() {
   // if (this.timeout) this.timeout(1e6)
 
   it('serves $metadata documents in v2', async () => {
-    const { headers, data } = await GET `/odata/v2/browse/$metadata`
+    const { headers, data } = await GET `/v2/browse/$metadata`
     expect(headers).to.contain({
       'content-type': 'application/xml',
       'dataserviceversion': '2.0',
@@ -17,7 +17,7 @@ describe('cap/samples - Fiori APIs - v2', function() {
   })
 
   it('serves Books in v2', async () => {
-    const { data } = await GET `/odata/v2/browse/Books`
+    const { data } = await GET `/v2/browse/Books`
     expect(data).to.containSubset({d:{results:[]}})
     expect(data.d.results.length).to.be.greaterThanOrEqual(5)
   })