@sap/cds-compiler 2.11.2 → 2.13.6

package/lib/transform/universalCsn/utils.js

@@ -0,0 +1,63 @@
+'use strict';
+
+const {
+  applyTransformations,
+} = require('../../model/csnUtils');
+const { setProp } = require('../../base/model');
+
+/**
+ * Set the annotation on the carrier if it is not already present.
+ *
+ * @param {object} carrier Object having/getting the annotation
+ * @param {string} name Name of the annotations
+ * @param {any} value Value of the annotation
+ */
+function setAnnotationIfNotDefined(carrier, name, value) {
+  if (carrier[name] === undefined)
+    carrier[name] = value;
+}
+
+/**
+ * Strip/change the CSN to ensure compatibility with what we have in the client CSN
+ * - Removes every occurrence of '$origin', '$generated' and '$source'
+ * - elements of subqueries become non-enumerable
+ * - remove `actions|params|virtual|notNull: null`, this stops the inheritance of the actions/params/virtual
+ *   along the $origin chain, this can be ignored for the comparison in our tests.
+ *
+ * @param {CSN.Model} csn
+ */
+function makeClientCompatible(csn) {
+  applyTransformations(csn, {
+    actions: removeNullProperty,
+    notNull: removeNullProperty,
+    params: removeNullProperty,
+    virtual: removeNullProperty,
+    $origin: (parent, prop) => delete parent[prop],
+    $generated: (parent, prop) => delete parent[prop],
+    $source: (parent, prop) => delete parent[prop],
+    SELECT: (parent, prop, query) => {
+      if (query.elements)
+        setProp(query, 'elements', query.elements);
+    },
+    SET: (parent, prop, query) => {
+      if (query.elements)
+        setProp(query, 'elements', query.elements);
+    },
+  });
+}
+
+/**
+ * Removes the `prop` from the `node` if `prop === null`
+ *
+ * @param {object} node
+ * @param {string} prop
+ */
+function removeNullProperty(node, prop) {
+  if (node[prop] === null)
+    delete node[prop];
+}
+
+module.exports = {
+  setAnnotationIfNotDefined,
+  makeClientCompatible,
+};

package/lib/utils/file.js

@@ -3,10 +3,11 @@
 'use strict';
 
 const fs = require('fs');
+const util = require('util');
 
 /**
  * Split the given source string into its lines.  Respects Unix,
- * Windows und Macintosh line breaks.
+ * Windows and Macintosh line breaks.
  *
  * @param {string} src
  * @returns {string[]}
@@ -19,8 +20,8 @@ function splitLines(src) {
  * Returns filesystem utils readFile(), isFile(), realpath() for _CDS_ usage.
  * This includes a trace as well as usage of a file cache.
  *
- * Note: The synchronous versions accept a callback as well, which is executed
- *       immediately! This is different from NodeJS's readFileSync()!
+ * Note: The synchronous versions accept a callback instead of being async (duh!), which
+ *       is executed immediately! This is different from NodeJS's readFileSync()!
  *       This is done to allow using it in places where fs.readFile (async) is used.
  *
  * @param {object} fileCache
@@ -47,10 +48,14 @@ function cdsFs(fileCache, enableTrace) {
   });
 
   return {
+    /** @type {function(string, string)} */
+    readFileAsync: util.promisify(readFile),
     readFile,
     readFileSync,
+    isFileAsync: util.promisify(isFile),
     isFile,
     isFileSync,
+    realpathAsync: util.promisify(realpath),
     realpath,
     realpathSync,
   };

package/lib/utils/objectUtils.js

@@ -42,8 +42,38 @@ function forEach(obj, callback) {
   }
 }
 
+/**
+ * Loops over all elements in an object and calls the specified callback(o[key]) for each key
+ * --> can be used as substitute for `Object.values(…).forEach(…)`
+ *
+ * @param  {object} o the object which values should be iterated
+ * @param  {Function} callback
+ */
+function forEachValue(o, callback) {
+  for (const key in o) {
+    if (Object.hasOwnProperty.call(o, key))
+      callback(o[key]);
+  }
+}
+
+/**
+ * Loops over all elements in an object and calls the specified callback(key) for each key
+ * --> can be used as substitute for `Object.keys(…).forEach(…)`
+ *
+ * @param  {object} o the object which keys should be iterated
+ * @param  {Function} callback
+ */
+function forEachKey(o, callback) {
+  for (const key in o) {
+    if (Object.hasOwnProperty.call(o, key))
+      callback(key);
+  }
+}
+
 module.exports = {
   copyPropIfExist,
   createDict,
   forEach,
+  forEachValue,
+  forEachKey,
 };

package/lib/utils/timetrace.js

@@ -1,7 +1,7 @@
 'use strict';
 
 /**
- * A single TimeTrace encapsulates the runtime of a selected code frame.
+ * A single StopWatch encapsulates the runtime of a selected code frame.
  *
  * @class TimeTrace
  */
@@ -14,6 +14,8 @@ class StopWatch {
    */
   constructor(id) {
     this.id = id;
+    // TODO: If we require Node 12, use process.hrtime.bigint()
+    //       as process.hrtime() is deprecated.
     // eslint-disable-next-line no-multi-assign
     this.startTime = this.lapTime = process.hrtime();
   }
@@ -123,4 +125,8 @@ const ignoreTimeTrace = {
 };
 
 const doTimeTrace = process && process.env && process.env.CDSC_TIMETRACING !== undefined;
-module.exports = { timetrace: (doTimeTrace ? new TimeTracer() : ignoreTimeTrace), StopWatch };
+module.exports = {
+  timetrace: (doTimeTrace ? new TimeTracer() : ignoreTimeTrace),
+  TimeTracer,
+  StopWatch,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/cds-compiler",
-  "version": "2.11.2",
+  "version": "2.13.6",
   "description": "CDS (Core Data Services) compiler and backends",
   "homepage": "https://cap.cloud.sap/",
   "author": "SAP SE (https://www.sap.com)",

package/share/messages/README.md

@@ -30,3 +30,29 @@ Furthermore:
   If users open the message in a terminal, it is often 80 characters wide.
   Even if that was not the case, longer lines are harder to read, so keep them
   short.
+
+## Example Structure
+
+```markdown
+# ‹message-id›
+
+Longer message text.  Some background info.
+Usually mentions the severity.
+
+## Example
+
+Code which also lead to the current message,
+with an explanation why it is problematic.
+
+## How to Fix
+
+Description of options how the issue can be fixed, using the example.
+
+## Notes on …
+
+Optional: more background info.
+
+## Related messages
+
+ - Optional: message ids for similar issues.
+```