@sap/cds-compiler 4.9.6 → 5.1.0

package/lib/utils/moduleResolve.js

@@ -70,7 +70,7 @@ function makeModuleResolver( options, fileCache, messageFunctions ) {
     extensions,
     isFile: _fs.isFile,
     readFile: _fs.readFile,
-    realpath: _fs.realpath,
+    realpath: _fs.realpathNative,
     lookupDirs: _getLookupDirectories( options, messageFunctions ),
   };
 
@@ -90,7 +90,20 @@ function makeModuleResolver( options, fileCache, messageFunctions ) {
           const body = fileCache[res];
           if (body === undefined || body === true) { // use fs if no or just temp entry
             dep.absname = res;
-            _fs.realpath( res, cb );
+            _fs.realpath( res, function realPathResult(realpathErr, modulePath) {
+              if (realpathErr) {
+                cb(realpathErr, modulePath);
+              }
+              else {
+                _fs.realpathNative( res, function nativeRealPathResult(nativeErr, nativePath) {
+                  if (!nativeErr)
+                    checkFileCase( dep, modulePath, nativePath, messageFunctions );
+                  // Pass the _native_ path to ensure that we use the actual
+                  // file's path (include case-differences)
+                  cb(realpathErr, nativePath);
+                });
+              }
+            } );
           }
           else if (body && typeof body === 'object' && body.realname) {
             // dep.absname = body.realname;
@@ -138,7 +151,7 @@ function makeModuleResolverSync( options, fileCache, messageFunctions ) {
     extensions,
     isFile: _fs.isFileSync,
     readFile: _fs.readFileSync,
-    realpath: _fs.realpathSync,
+    realpath: _fs.realpathSyncNative,
     lookupDirs: _getLookupDirectories( options, messageFunctions ),
   };
 
@@ -166,11 +179,23 @@ function makeModuleResolverSync( options, fileCache, messageFunctions ) {
     const body = result ? fileCache[result] : undefined;
     if (body === undefined || body === true) { // use fs if no or just temp entry
       dep.absname = result;
-      _fs.realpathSync( result, (err, modulePath) => {
-        if (err)
-          error = err;
-        else
-          result = modulePath;
+      _fs.realpathSync( result, function realPathResult(realpathErr, modulePath) {
+        if (realpathErr) {
+          error = realpathErr;
+        }
+        else {
+          _fs.realpathSyncNative( result, function nativeRealPathResult(nativeErr, nativePath) {
+            if (nativeErr) {
+              error = nativeErr;
+            }
+            else {
+              checkFileCase(dep, modulePath, nativePath, messageFunctions);
+              // Use the _native_ path to ensure that we use the actual
+              // file's path (include case-differences)
+              result = nativePath;
+            }
+          });
+        }
       });
     }
     else if (body && typeof body === 'object' && body.realname) {
@@ -533,6 +558,32 @@ function packageCdsMain( pkg ) {
   return null;
 }
 
+/**
+ * Check if the given paths for case-differences.  If there are case differences
+ * emit a warning.  This can happen on systems with case-insensitive file
+ * systems.  As that is a hard-to-debug issue, we help the user by emitting
+ * a corresponding warning.
+ *
+ * @param {object} dep
+ * @param {string} realpath
+ * @param {string} nativeRealpath
+ * @param {Function} warning
+ */
+function checkFileCase( dep, realpath, nativeRealpath, { warning } ) {
+  if (realpath === nativeRealpath)
+    return;
+  if (realpath.toLowerCase() !== nativeRealpath.toLowerCase()) {
+    // safe-guard: in case realpath() resolved symlinks more deeply or sockets/pipes were used,
+    // which realpath.native() handles differently, don't report a possible false positive.
+    return;
+  }
+  for (const using of dep.usingFroms) {
+    warning('file-unexpected-case-mismatch', [ using.location, using ], {},
+            // eslint-disable-next-line max-len
+            'The imported filename differs on the filesystem; ensure that capitalization matches the actual file\'s name');
+  }
+}
+
 /**
  * @typedef {object} ResolveConfig
  * @property {string[]} lookupDirs

package/lib/utils/term.js

@@ -57,8 +57,9 @@ function term( useColor = 'auto' ) {
         //       > that, when present (regardless of its value), prevents the addition
         //       > of ANSI color.
         // Note: To be able to disable colors in tests, we check the environment
-        //       variable here again.
-        hasColor = hasColorShell && (process.env.NO_COLOR === undefined);
+        //       variables again.
+        hasColor = (process.env.FORCE_COLOR && process.env.FORCE_COLOR !== '0') ||
+          (hasColorShell && process.env.NO_COLOR === undefined);
         break;
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/cds-compiler",
-  "version": "4.9.6",
+  "version": "5.1.0",
   "description": "CDS (Core Data Services) compiler and backends",
   "homepage": "https://cap.cloud.sap/",
   "author": "SAP SE (https://www.sap.com)",
@@ -24,11 +24,15 @@
     "test3": "node scripts/verifyGrammarChecksum.js && mocha --reporter-option maxDiffSize=0 test3/",
     "deployHanaSql": "CDS_COMPILER_DEPLOY_HANA=1 mocha --reporter-option maxDiffSize=0 test3/test.deploy.hana-sql.js",
     "deployHdiHdbcds": "CDS_COMPILER_DEPLOY_HANA=1 mocha --reporter-option maxDiffSize=0 test3/test.deploy.hdi.hdbcds.js",
+    "deployHdi": "CDS_COMPILER_DEPLOY_HANA=1 mocha --reporter-option maxDiffSize=0 --extensions .hdi test3/test.deploy.hdi.hdbcds.js",
+    "deployHdbcds": "CDS_COMPILER_DEPLOY_HANA=1 mocha --reporter-option maxDiffSize=0 --extensions .hdbcds test3/test.deploy.hdi.hdbcds.js",
     "deployGitDiffs": "CDS_COMPILER_DEPLOY_HANA=1 mocha --reporter-option maxDiffSize=0 test3/test.deploy.git-diffs.js",
+    "deployHdbcdsGitDiffs": "CDS_COMPILER_DEPLOY_HANA=1 mocha --reporter-option maxDiffSize=0 --extensions .hdbcds test3/test.deploy.git-diffs.js",
+    "deployHdiGitDiffs": "CDS_COMPILER_DEPLOY_HANA=1 mocha --reporter-option maxDiffSize=0 --extensions .hdi test3/test.deploy.git-diffs.js",
     "gentest3": "cross-env MAKEREFS=${MAKEREFS:-'true'} mocha --reporter-option maxDiffSize=0 test3/testRefFiles.js",
     "coverage": "cross-env nyc mocha --reporter-option maxDiffSize=0 test/ test3/testRefFiles.js && nyc report --reporter=lcov",
     "coverage:piper": "cross-env nyc mocha --reporter test/TestMochaReporter.js --reporter-options mochaFile=./coverage/TEST-results.xml --reporter-option maxDiffSize=0 --timeout 10000 test/ test3/ && nyc report --reporter=cobertura && nyc report --reporter=lcov",
-    "lint": "eslint bin/ benchmark/ lib/ test/ test3/ scripts/ types/ && node scripts/linter/lintGrammar.js && node scripts/linter/lintTests.js test3/ && node scripts/linter/lintMessages.js && node scripts/linter/lintMessageIdCoverage.js lib/ && markdownlint README.md CHANGELOG.md doc/ internalDoc/ && cd share/messages && markdownlint . && cd ../../ && node scripts/check-changelog.js",
+    "lint": "eslint bin/ benchmark/ lib/ test/ test3/ scripts/ && node scripts/linter/lintGrammar.js && node scripts/linter/lintTests.js test3/ && node scripts/linter/lintMessages.js && node scripts/linter/lintMessageIdCoverage.js lib/ && markdownlint README.md CHANGELOG.md doc/ internalDoc/ && cd share/messages && markdownlint . && cd ../../ && node scripts/check-changelog.js",
     "tslint": "tsc --pretty -p .",
     "updateVocs": "node scripts/odataAnnotations/generateDictMain.js && npm run generateAllRefs",
     "updateTocs": "node scripts/update-toc.js",
@@ -60,6 +64,6 @@
     "LICENSE"
   ],
   "engines": {
-    "node": ">=16"
+    "node": ">=18"
   }
 }

package/share/messages/message-explanations.json

@@ -14,6 +14,8 @@
     "rewrite-not-supported",
     "syntax-expecting-unsigned-int",
     "type-missing-enum-value",
+    "type-unexpected-foreign-keys",
+    "type-unexpected-on-condition",
     "wildcard-excluding-one"
   ]
 }

package/share/messages/type-unexpected-foreign-keys.md

@@ -0,0 +1,52 @@
+# type-unexpected-foreign-keys
+
+Foreign keys were specified in a composition-of-aspect.
+
+Compositions of aspects are managed by the compiler.
+Specifying a foreign key list is not supported.
+If you need to specify foreign keys, use a composition
+of an entity instead.
+
+The message's severity is `Error`.
+
+## Example
+
+Erroneous code example:
+
+```cds
+aspect Item {
+  key ID : UUID;
+  field : String;
+};
+entity Model {
+  key ID : UUID;
+  Item : Composition of Item { ID }; // ❌
+};
+```
+
+`Item` is an aspect.  Because an explicit list of foreign keys is specified,
+the compiler rejects this CDS snippet.  With an explicit foreign key list,
+only entities can be used, but not aspects.
+
+## How to Fix
+
+Either remove the explicit list of foreign keys and let the compiler handle
+the composition, or use a composition of entity instead.
+
+```cds
+aspect Item {
+  key ID : UUID;
+  field : String;
+};
+entity Model {
+  key ID : UUID;
+  Item : Composition of Model.Item { ID }; // ok
+};
+entity Model.Item : Item { };
+```
+
+The snippet uses a user-defined entity, that includes the aspects.
+
+## Related Messages
+
+- `type-unexpected-on-condition`

package/share/messages/type-unexpected-on-condition.md

@@ -0,0 +1,52 @@
+# type-unexpected-on-condition
+
+An ON-condition was specified in a composition-of-aspect.
+
+Compositions of aspects are managed by the compiler.
+Specifying an ON-condition is not supported.
+If you need to specify an ON-condition, use a composition
+of an entity instead.
+
+The message's severity is `Error`.
+
+## Example
+
+Erroneous code example:
+
+```cds
+aspect Item {
+  key ID : UUID;
+  field : String;
+};
+entity Model {
+  key ID : UUID;
+  Item : Composition of Item on Item.ID = ID; // ❌
+};
+```
+
+`Item` is an aspect.  Because an ON-condition is specified, the compiler
+rejects this CDS snippet.  With an ON-condition, only entities can be used,
+but not aspects.
+
+## How to Fix
+
+Either remove the ON-condition and let the compiler handle
+the composition, or use a composition of entity instead.
+
+```cds
+aspect Item {
+  key ID : UUID;
+  field : String;
+};
+entity Model {
+  key ID : UUID;
+  Item : Composition of Model.Item on Item.ID = ID; // ok
+};
+entity Model.Item : Item { };
+```
+
+The snippet uses a user-defined entity, that includes the aspects.
+
+## Related Messages
+
+- `type-unexpected-foreign-keys`