@sap/cds-compiler 4.9.6 → 5.1.0

package/CHANGELOG.md

@@ -7,6 +7,98 @@
 Note: `beta` fixes, changes and features are usually not listed in this ChangeLog but [here](doc/CHANGELOG_BETA.md).
 The compiler behavior concerning `beta` features can change at any time without notice.
 
+## Version 5.1.0 - 2024-07-25
+
+### Added
+
+- cdsc: Option `--stdin` was added to support input via standard input, e.g. `cat file.cds | cdsc --stdin`
+- Allow to refer to draft state element `IsActiveEntity` via magic variable `$draft.IsActiveEntity` in annotation path expressions.
+  + for.odata: During draft augmentation `$draft.IsActiveEntity` is rewritten to `$self.IsActiveEntity` for all draft enabled
+    entities (root and sub nodes but not for named types or entity parameters).
+  + to.edm(x): (V4 only) Allow to refer to an entity element in a bound action via `$self` and not only via explicit binding parameter
+    in an annotation path expression. The API generator will prefix the path with the actual binding parameter name (explicit, annotation or
+    default).
+
+### Changed
+
+- Update OData vocabularies: 'Common', 'Core', 'HTML5', 'UI'.
+- to.cdl|hdbcds|hdi|sql: Remove `generated by` comment.
+
+### Fixed
+
+- compiler: checks for associations now work for nested projections of the form `association.{ id }`
+- to.edm(x): No `Nullable` attribute for `$ReturnType` of `Collection(<entity type>)` [OData V4 CSDL, section 12.8 Return Type](https://docs.oasis-open.org/odata/odata-csdl-xml/v4.01/odata-csdl-xml-v4.01.html#sec_ReturnType)
+- to.sql|hdi|hdbcds: Detect and error on "cross-eyed" backlinks, where we cannot construct a valid on-condition.
+- to.sql|hdi.migration: Correctly detect that a view was dropped - this was previously just silently ignored.
+
+
+## Version 5.0.6 - 2024-07-10
+
+### Fixed
+
+- for.seal: Don't generate DRAFT artifacts.
+
+## Version 5.0.4 - 2024-06-26
+
+### Fixed
+
+- CDL parser: an `extend entity` and `extend aspect` with an extensions for the
+  same element now correctly leads to an error, because it resulted in part of the
+  extension being simply dropped.  Remark: an `extend type` and the recommended
+  plain `extend` led to an error in that situation already before.
+- to.sql: Conditions inside filters in combination with foreign key aliases were
+          not properly translated in rare cases.
+- Update OData Vocabularies: 'PDF', 'UI'.
+
+## Version 5.0.2 - 2024-06-14
+
+### Changed
+
+- API `CompilationError` will serialize the first compiler error in `e.message`
+- cdsc: `--without-hana-associations` is changed to `--with-hana-associations`
+
+### Fixed
+
+- to.edm(x):
+  + Respect `AppliesTo` specification in term definitions for actions and functions.
+  + Make message `odata-spec-violation-namespace` a warning again.
+
+## Version 5.0.0 - Pre-release version - 2024-05-29
+
+This is a preview version for the major release and contains breaking changes. It should not be used for production.
+
+### Changed
+
+- Node 18 is now the minimum required version.
+- API `CompilationError`s will no longer serialize all compiler messages into `e.message`.
+  Use `e.messages[]` instead or `e.toString()` to serialize errors into a string.
+- CDL parser: Annotations that can't be applied are now rejected.
+- compiler:
+  + `extend` statements on "namespaces" (paths that are not definitions) are now always errors.
+  + non-structured events are rejected
+  + `$self` references in JOINs are rejected if they could lead to issues in SQL rendering.
+  + non-string enum definitions must have a value.
+  + A top-level definition `$self` is rejected. `$self` is considered a reserved name.
+  + `$at.from`/`$at.to` are deprecated; use `$valid.from`/`$valid.to` instead.
+- to.hdbcds: The HDBCDS backend is now considered deprecated.
+- to.edm(x):
+  + Set default nullability to `true` for collection like properties (was `false` before).
+  + Raise message ids `odata-spec-violation-namespace`, `odata-spec-violation-no-key` from warning to error.
+- to.sql:
+  + `@cds.persistence.exists` is _not_ propagated to generated localization views (`localized.*`)
+  + Option `fewerLocalizedViews` is now enabled by default.
+  + Option `betterSqliteSessionVariables` is now enabled by default.
+
+### Fixed
+
+- for.odata: Propagate all `@odata { Type, MaxLength, Precision, Scale, SRID }` to generated foreign keys.
+
+### Removed
+
+- API: Deprecated functions `preparedCsnToEdmx` and `preparedCsnToEdm` were removed.
+  Use `to.edm(x)` instead.
+
+
 ## Version 4.9.6 - 2024-07-15
 
 ### Fixed

package/bin/cds_remove_invalid_whitespace.js

@@ -64,7 +64,8 @@ function modernizeWhitespace( source, filename ) {
 
   // To avoid spam, only report errors.
   // Users should use the compiler to get all messages.
-  const errors = options.messages.filter(msg => (msg.severity === 'Error'));
+  const errors = options.messages
+    .filter(msg => (msg.severity === 'Error' && msg.messageId !== 'syntax-invalid-space'));
   if (errors.length > 0) {
     errors.forEach((msg) => {
       console.error(msg.toString());

package/bin/cdsc.js

@@ -35,6 +35,7 @@ const { addLocalizationViews } = require('../lib/transform/localized');
 const { addTenantFields } = require('../lib/transform/addTenantFields');
 const { availableBetaFlags } = require('../lib/base/model');
 const { alterConstraintsWithCsn } = require('../lib/render/manageConstraints');
+const { tmpFilePath, readStream } = require('../lib/utils/file');
 
 // Note: Instead of throwing ProcessExitError, we would rather just call process.exit(exitCode),
 // but that might truncate the output of stdout and stderr, both of which are async (or rather,
@@ -85,9 +86,12 @@ function remapCmdOptions( options, command ) {
 }
 
 function cdsc_main() {
-  // Parse the command line and translate it into options
+  if (process.argv.some(arg => arg === '-i' || arg === '--stdin'))
+    optionProcessor.makePositionalArgumentsOptional();
 
+  // Parse the command line and translate it into options
   const cmdLine = optionProcessor.processCmdLine(process.argv);
+
   // Deal with '--version' explicitly
   if (cmdLine.options.version) {
     process.stdout.write(`${main.version()}\n`);
@@ -145,6 +149,7 @@ function cdsc_main() {
   // Internally, parseCdl/parseOnly are options, so we map the command to it.
   if (cmdLine.command === 'parseCdl') {
     cmdLine.command = 'toCsn';
+    cmdLine.options.toCsn = cmdLine.options.parseCdl;
     cmdLine.options.parseCdl = true;
     cmdLine.args.files = [ cmdLine.args.file ];
   }
@@ -169,12 +174,20 @@ function cdsc_main() {
   }
 
   const to = cmdLine.options.toSql ? 'toSql' : 'toHana';
-  // remap string values for `assertIntegrity` option to boolean
-  if (cmdLine.options[to] && cmdLine.options[to].assertIntegrity &&
-     (cmdLine.options[to].assertIntegrity === 'true' ||
-      cmdLine.options[to].assertIntegrity === 'false')
-  )
-    cmdLine.options[to].assertIntegrity = cmdLine.options[to].assertIntegrity === 'true';
+  if (cmdLine.options[to]) {
+    // remap string values in options to boolean
+    if (cmdLine.options[to].assertIntegrity &&
+        (cmdLine.options[to].assertIntegrity === 'true' ||
+         cmdLine.options[to].assertIntegrity === 'false')
+    )
+      cmdLine.options[to].assertIntegrity = cmdLine.options[to].assertIntegrity === 'true';
+
+    if (cmdLine.options[to].withHanaAssociations)
+      cmdLine.options[to].withHanaAssociations = cmdLine.options[to].withHanaAssociations !== 'false';
+
+    if (cmdLine.options[to].betterSqliteSessionVariables)
+      cmdLine.options[to].betterSqliteSessionVariables = cmdLine.options[to].betterSqliteSessionVariables === 'true';
+  }
 
   // Enable all beta-flags if betaMode is set to true
   if (cmdLine.options.betaMode)
@@ -201,6 +214,9 @@ function cdsc_main() {
   if (typeof cmdLine.options.moduleLookupDirectories === 'string')
     cmdLine.options.moduleLookupDirectories = cmdLine.options.moduleLookupDirectories.split(',');
 
+  if (cmdLine.options.stdin)
+    cmdLine.options.fallbackParser ??= 'auto!';
+
   parseSeverityOptions(cmdLine);
 
   // Do the work for the selected command
@@ -221,12 +237,12 @@ function validateDirectBackendOption( command, options, args ) {
     displayUsage(`Option '--direct-backend' can't be used with command '${command}'`,
                  optionProcessor.helpText, 2);
   }
-  if (!args.files || args.files.length !== 1) {
-    displayUsage(`Option '--direct-backend' expects exactly one JSON file, but ${args.files.length} given`,
+  if (!options.stdin && (!args.files || args.files.length !== 1)) {
+    displayUsage(`Option '--direct-backend' expects exactly one JSON file, but ${args.files?.length || 'none'} given`,
                  optionProcessor.helpText, 2);
   }
-  const filename = args.files[0];
-  if (!filename.endsWith('.csn') && !filename.endsWith('.json')) {
+  const filename = args.files?.[0];
+  if (filename && !filename.endsWith('.csn') && !filename.endsWith('.json')) {
     displayUsage('Option \'--direct-backend\' expects a filename with a *.csn or *.json suffix',
                  optionProcessor.helpText, 2);
   }
@@ -250,8 +266,21 @@ function displayUsage( error, helpText, code ) {
   throw new ProcessExitError(code);
 }
 
+/**
+ * As the compiler is file-based and will always at least try to call `realpath()` on a file,
+ * we fake a "stdin" file for it.
+ *
+ * @returns {Promise<string>}
+ */
+async function createTemporaryFileFromStdin() {
+  const contents = await readStream(process.stdin);
+  const file = tmpFilePath('cds-compiler-stdin', 'cds');
+  await fs.promises.writeFile(file, contents);
+  return file;
+}
+
 // Executes a command line that has been translated to 'command' (what to do), 'options' (how) and 'args' (which files)
-function executeCommandLine( command, options, args ) {
+async function executeCommandLine( command, options, args ) {
   const normalizeFilename = options.testMode && process.platform === 'win32';
   const messageLevels = {
     Error: 0, Warning: 1, Info: 2, Debug: 3,
@@ -295,17 +324,22 @@ function executeCommandLine( command, options, args ) {
   }
 
   options.messages = [];
+  args.files ??= [];
+
+  // Load a file from stdin if no explicit file is given and stdin is not a TTY.
+  if (options.stdin)
+    args.files.push(await createTemporaryFileFromStdin());
 
   const fileCache = Object.create(null);
   const compiled = options.directBackend
     ? util.promisify(fs.readFile)( args.files[0], 'utf-8' ).then(str => JSON.parse( str ))
     : compiler.compileX( args.files, undefined, options, fileCache );
 
-  compiled.then( commands[command] )
+  await compiled.then( commands[command] )
     .then( displayMessages, displayErrors )
     .catch( catchErrors );
 
-  return; // below are only command implementations.
+  // below are only command implementations.
 
   // Execute the command line option '--to-cdl' and display the results.
   // Return the original model (for chaining)
@@ -446,11 +480,6 @@ function executeCommandLine( command, options, args ) {
   // Execute the command line option '--to-sql' and display the results.
   // Return the original model (for chaining)
   function toSql( model ) {
-    if (options.withoutHanaAssociations) {
-      options.withHanaAssociations = false;
-      delete options.withoutHanaAssociations;
-    }
-
     const csn = options.directBackend ? model : compactModel(model, options);
     if (options.src === 'hdi') {
       if (options.csn) {
@@ -720,3 +749,4 @@ function parseSeverityOptions({ options }) {
     }
   }
 }
+

package/bin/cdshi.js

@@ -13,7 +13,8 @@
 
 const compiler = require('../lib/compiler');
 const fs = require('fs');
-fs.readFile( '/dev/stdin', 'utf8', highlight );
+const stdinFd = 0;
+fs.readFile( stdinFd, 'utf8', highlight );
 
 const categoryChars = {         // default: first char of category name
   // first char lowercase = reference other than via extend/annotate:
@@ -34,6 +35,7 @@ const categoryChars = {         // default: first char of category name
   ExtBoundAction: 'B',      // highlight like bound action definition
   ExtParam: 'P',            // highlight like entity/action parameter definition
   Event: 'Y',
+  KeyImplicit: 'r',         // handle as normal ref
   // Remark: do not use `x`/`X` (hex literal `x'1e3d'`)
 };
 

package/doc/CHANGELOG_BETA.md

@@ -8,6 +8,13 @@ Note: `beta` fixes, changes and features are listed in this ChangeLog just for i
 The compiler behavior concerning `beta` features can change at any time without notice.
 **Don't use `beta` fixes, changes and features in productive mode.**
 
+
+## Version 5.0.0 - 2024-05-29
+
+## Removed `v5preview`
+
+It is now enabled by default.
+
 ## Version 4.9.0 - 2024-04-25
 
 ## Removed `odataAnnotationExpressions`

package/lib/api/main.js

@@ -596,6 +596,15 @@ function sqlMigration( csn, options, messageFunctions, beforeImage ) {
   if (constraintDeletions)
     Object.values(constraintDeletions).forEach(constraint => dropSqls.push(constraint));
 
+  if (Object.keys(drops.final).length > 0) {
+    const order = sortViews({ sql: {}, csn: beforeImage });
+
+    for (const { name } of order) {
+      if (drops.final[name])
+        dropSqls.push(drops.final[name]);
+    }
+  }
+
   // We need to drop the things without dependants first - so inversely sorted
   dropSqls.reverse();
 
@@ -679,7 +688,7 @@ function createSqlDefinitions( hdbkinds, afterImage ) {
  */
 function createSqlDeletions( deletions, beforeImage ) {
   const result = [];
-  objectUtils.forEach(deletions, name => result.push({ name: getFileName(name, beforeImage), suffix: '.hdbtable' }));
+  objectUtils.forEach(deletions, name => result.push({ name: getFileName(name, beforeImage), suffix: beforeImage.definitions[name].query ? '.hdbview' : '.hdbtable' }));
   return result;
 }
 /**
@@ -712,9 +721,9 @@ function hdbcds( csn, options, messageFunctions ) {
   internalOptions.transformation = 'hdbcds';
   messageFunctions.setOptions( internalOptions );
 
-  // no "isBetaEnabled", because this warning must also appear with "deprecated" flags
-  if (internalOptions.betaMode || internalOptions.beta?.v5preview)
-    messageFunctions.warning('api-deprecated-v5', null, null);
+  // Since v5, the HDBCDS backend is considered deprecated.
+  // TODO(v6): Make this a configurable error
+  messageFunctions.warning('api-deprecated-v5', null, null);
 
   if (options.tenantDiscriminator) {
     messageFunctions.error('api-invalid-option', null, {
@@ -741,7 +750,6 @@ function hdbcds( csn, options, messageFunctions ) {
 function edm( csn, options, messageFunctions ) {
   // If not provided at all, set service to 'undefined' to trigger validation
   const internalOptions = prepareOptions.to.edm(
-    // eslint-disable-next-line comma-dangle
     options.service ? options : Object.assign({ service: undefined }, options)
   );
   messageFunctions.setOptions( internalOptions );
@@ -810,7 +818,6 @@ function edmall( csn, options, messageFunctions ) {
 function edmx( csn, options, messageFunctions ) {
   // If not provided at all, set service to 'undefined' to trigger validation
   const internalOptions = prepareOptions.to.edmx(
-    // eslint-disable-next-line comma-dangle
     options.service ? options : Object.assign({ service: undefined }, options)
   );
   messageFunctions.setOptions( internalOptions );
@@ -880,9 +887,8 @@ function edmxall( csn, options, messageFunctions ) {
  */
 // @ts-ignore
 function odata2( csn, options, messageFunctions ) {
-  // If not provided at all, set service to undefined to trigger validation
+  // If not provided at all, set service to 'undefined' to trigger validation
   const internalOptions = prepareOptions.to.odata(
-    // eslint-disable-next-line comma-dangle
     options.service ? options : Object.assign({ service: undefined }, options)
   );
   messageFunctions.setOptions( internalOptions );
@@ -1074,15 +1080,6 @@ module.exports = {
   for_hdbcds: publishCsnProcessor(forHdbcds, 'for.hdbcds'),
   for_effective: publishCsnProcessor(forEffective, 'for.effective'),
   for_seal: publishCsnProcessor(forSeal, 'for.seal'),
-
-  /* Deprecated, will be removed in cds-compiler@v5 */ // TODO(v5): Remove
-  preparedCsnToEdmx(csn, service, options) {
-    preparedCsnToEdmx(csn, service, options, messages.makeMessageFunction( csn, options, 'to.edmx' ));
-  },
-  /* Deprecated, will be removed in cds-compiler@v5 */ // TODO(v5): Remove
-  preparedCsnToEdm(csn, service, options) {
-    preparedCsnToEdm(csn, service, options, messages.makeMessageFunction( csn, options, 'to.edm' ));
-  },
 };
 
 
@@ -1266,7 +1263,7 @@ function ensureClientCsn( csn, options, messageFunctions, module ) {
 function lazyload( moduleName ) {
   let module;
   return new Proxy(((...args) => {
-    if (!module) // eslint-disable-next-line global-require
+    if (!module)
       module = require(moduleName);
 
     if (module.apply && typeof module.apply === 'function')
@@ -1274,7 +1271,7 @@ function lazyload( moduleName ) {
     return module; // for destructured calls
   }), {
     get(target, name) {
-      if (!module) // eslint-disable-next-line global-require
+      if (!module)
         module = require(moduleName);
 
       return module[name];

package/lib/api/options.js

@@ -29,7 +29,6 @@ const publicOptionsNewAPI = [
   'magicVars', // deprecated, not removed in v3 as we have specific error messages for it
   'variableReplacements',
   'pre2134ReferentialConstraintNames',
-  'generatedByComment',
   'betterSqliteSessionVariables',
   'fewerLocalizedViews',
   'withHanaAssociations',
@@ -75,7 +74,7 @@ const privateOptions = [
   'internalMsg',
   'disableHanaComments',      // in case of issues with hana comment rendering
   'tenantDiscriminator',      // not published yet
-  'localizedWithoutCoalesce', // deprecated version of 'localizedLanguageFallback', TODO(v5): Remove option
+  'localizedWithoutCoalesce', // deprecated version of 'localizedLanguageFallback', TODO(v6): Remove option
 ];
 
 const overallOptions = publicOptionsNewAPI.concat(privateOptions);
@@ -145,15 +144,7 @@ function reclassifyErrorsForOpenApi( options ) {
     // shallow clone, so that we can modify severities without changing the user's.
     options.severities = Object.assign({}, options.severities ?? {});
 
-    options.severities['odata-spec-violation-array'] = 'Warning';
-    options.severities['odata-spec-violation-assoc'] = 'Warning';
-    options.severities['odata-spec-violation-namespace'] = 'Warning';
-    options.severities['odata-spec-violation-param'] = 'Warning';
-    options.severities['odata-spec-violation-returns'] = 'Warning';
-    options.severities['odata-spec-violation-type-unknown'] = 'Warning';
     options.severities['odata-spec-violation-no-key'] = 'Warning';
-    options.severities['odata-spec-violation-key-type'] = 'Warning';
-    options.severities['odata-spec-violation-property-name'] = 'Warning';
   }
 }
 
@@ -164,7 +155,7 @@ module.exports = {
     sql: (options) => {
       const hardOptions = { src: 'sql', toSql: true, forHana: true };
       const defaultOptions = {
-        sqlMapping: 'plain', sqlDialect: 'plain', generatedByComment: true, withHanaAssociations: true,
+        sqlMapping: 'plain', sqlDialect: 'plain', withHanaAssociations: true,
       };
       const processed = translateOptions(options, defaultOptions, hardOptions, undefined, [ 'sql-dialect-and-naming' ], 'to.sql');
 
@@ -174,7 +165,7 @@ module.exports = {
       const hardOptions = { src: 'hdi', toSql: true, forHana: true };
       // TODO: sqlDialect should be a hard option!
       const defaultOptions = {
-        sqlMapping: 'plain', sqlDialect: 'hana', generatedByComment: false, withHanaAssociations: true,
+        sqlMapping: 'plain', sqlDialect: 'hana', withHanaAssociations: true,
       };
       return translateOptions(options, defaultOptions, hardOptions, { sqlDialect: generateStringValidator([ 'hana' ]) }, undefined, 'to.hdi');
     },
@@ -216,7 +207,7 @@ module.exports = {
       return translateOptions(options, defaultOptions, hardOptions, undefined, undefined, 'for.hana');
     },
     effective: (options) => {
-      const hardOptions = {};
+      const hardOptions = { addCdsPersistenceName: false };
       const defaultOptions = {
         sqlMapping: 'plain', resolveSimpleTypes: true, resolveProjections: true, remapOdataAnnotations: false, keepLocalized: false,
       };
@@ -226,7 +217,7 @@ module.exports = {
     },
     seal: (options) => {
       const hardOptions = {
-        sqlMapping: 'plain', resolveSimpleTypes: true, resolveProjections: true, keepLocalized: false,
+        sqlMapping: 'plain', resolveSimpleTypes: true, resolveProjections: true, keepLocalized: false, addCdsPersistenceName: true,
       };
       const defaultOptions = { remapOdataAnnotations: true };
       const processed = translateOptions(options, defaultOptions, hardOptions, null, [ 'sql-dialect-and-naming' ], 'for.effective');

package/lib/api/trace.js

@@ -27,7 +27,6 @@ function traceApi( apiName, options, ...args ) {
   const argsStr = args.map(val => JSON.stringify(val)).join(', ');
   const rest = args.length > 0 ? ` | ${ argsStr }` : '';
   // Local require: Only load on-demand, not when tracing is disabled.
-  // eslint-disable-next-line global-require
   const { version } = require('../../package.json');
   // eslint-disable-next-line no-console
   console.error( `CDSC_TRACE_API | ${ version } | ${ apiName }(…) | options: ${ optStr }${ rest }`);

package/lib/base/builtins.js

@@ -64,6 +64,7 @@ const magicVariables = [
   '$now',
   '$tenant',
   '$session',
+  '$draft',
 ];
 
 /**

package/lib/base/location.js

@@ -11,13 +11,16 @@ class Location {
   col;
   endLine;
   endCol;
-  constructor(file, line, col, endLine, endCol) {
+  constructor( file, line, col, endLine, endCol ) {
     this.file = file;
     this.line = line;
     this.col = col;
     this.endLine = endLine;
     this.endCol = endCol;
   }
+  toString() {
+    return locationString( this );
+  }
 }
 
 class SemanticLocation {