@sap/cds-compiler 2.5.2 → 2.11.0

package/CHANGELOG.md

@@ -7,6 +7,226 @@
 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 2.11.0 - 2021-12-02
+
+### Added
+
+- Option `defaultBinaryLength` to set a `length` type facet for all definitions with type `cds.Binary`. This option
+  overrides the default binary length in the database backends and is also used as `MaxLength` attribute in Odata.
+- If doc-comments are ignored by the compiler, an info message is now emitted.  A doc-comment is ignored,
+  if it can't be assigned to an artifact.  For example for two subsequent doc-comments, the first doc-comment
+  is ignored.  To suppress these info messages, explicitly set option `docComment` to `false`.
+- `cdsc`:
+  - `cdsc explain list` can now be used to get a list of message IDs with explanation texts.
+  - `cdsc` now respects the environment variable `NO_COLOR`. If set, no ANSI escape codes will be used.
+    Can be overwritten by `cdsc --color always`.
+- to.sql/hdi: Support SQL Window Functions
+- to.sql/hdi/hdbcds:
+  + Support configuration of `$session` and `$user` via option `variableReplacements`.
+  + Restricted support for SQL foreign key constraints if option `assertIntegrityType` is set to `"DB"`.
+    The behavior of this feature might change in the future.
+
+### Changed
+
+- Updated OData vocabularies 'Common' and 'UI'.
+- to.sql/hdi/hdbcds: The default length of `cds.Binary` is set to `5000` similar to `cds.String`.
+
+### Removed
+
+- to.hdbcds: Doc comments on view columns are not rendered anymore. Doc comments on string literals will make the deployment fail
+  as the SAP HANA CDS compiler concatenates the doc comment with the string literal. Besides that, doc comments on view columns
+  are not transported to the database by SAP HANA CDS.
+- to.hdbcds/sql/hdi: Forbid associations in filters after `exists` (except for nested `exists`), as the final behavior is not yet specified.
+
+### Fixed
+
+- CSN parser: doc-comment extensions are no longer ignored.
+- Properly check for duplicate annotation definitions.
+- Correctly apply annotations on inherited enum symbols.
+- Correctly apply annotations on elements in an inherited structure array.
+- Fix a bug in API `defaultStringLength` value evaluation.
+- Fix crash if named arguments are used in a function that's inside a `CASE` statement.
+- to.sql/hdi/hdbcds:
+  + Properly flatten ad-hoc defined elements in `returns` / `params` of `actions` and `functions`.
+  + Correctly handle `*` in non-first position.
+  + Correctly handle action return types
+  + Correctly handle mixin association named `$self`
+- to.cdl: doc-comments are no longer rendered twice.
+- to.edm(x):
+  + Fix a bug in V2/V4 partner ship calculation.
+  + Remove warning of unknown types for Open Types in `@Core.Dictionary`.
+  + An empty CSN no longer results in a JavaScript type error
+
+## Version 2.10.4 - 2021-11-05
+
+### Fixed
+
+- to.sql/hdi/hdbcds:
+  + Correctly complain about `exists` in conjunction with non-associations/compositions
+  + Don't resolve types in action returns, as this causes issues with $self-resolution
+
+- to.edm(x): Be robust against transitively untyped keys in stacked view hierarchies
+
+## Version 2.10.2 - 2021-10-29
+
+### Fixed
+
+- to.sql/hdi/hdbcds: Correctly handle `exists` in conjunction with mixin-associations
+
+## Version 2.10.0 - 2021-10-28
+
+### Added
+
+- Support arbitrary paths after `$user` - similar to `$session`.
+- Support scale `floating` and `variable` for `cds.Decimal` in CDL and CSN. Backend specific handling is descibed in their sections.
+- Allow select item wildcard (`*`) in a `select`/`projection` at any position, not just the first.
+
+- to.edm(x):
+  + In Odata V4 generate transitive navigation property binding paths along containment hierarchies and terminate on the
+    first non-containment association. The association target is either an explicit Edm.EntitySet in the same EntityContainer
+    or in a referred EntityContainer (cross service references) or an implicit EntitySet identified by the containment path
+    originating from an explicit EntitySet. This enhancement has an observable effect only in structured format with containment
+    turned on.
+  + Support for scales `variable` and `floating`:
+    + V4: `variable` and `floating` are rendered as `Scale="variable"`. Since V4 does not support `floating`, it is aproximated as `variable`.
+    + V2: `variable` and `floating` are announced via property annotation `sap:variable-scale="true"`
+  
+- to.sql/hdi/hdbcds:
+  + Reject scale `floating` and `variable`.
+  + Reject arbitrary `$user` or `$session` paths that cannot be translated to valid SQL.
+  + Following a valid `exists`, further `exists` can be used inside of the filter-expression: `exists assoc[exists another[1=1]]`
+  + `exists` can now be followed by more than one association step.
+  `exists assoc.anotherassoc.moreassoc` is semantically equivalent to `exists assoc[exists anotherassoc[exists moreassoc]]`
+
+### Changed
+
+- to.odata: Inform when overwriting draft action annotations like `@Common.DraftRoot.ActivationAction`.
+
+## Version 2.9.0 - 2021-10-15
+
+### Changed
+
+- to.edm(x): Raise `odata-spec-violation-type` to a downgradable error.
+
+### Fixed
+
+- to.edm(x):
+  + Fix a bug in annotation propagation to foreign keys.
+  + Don't render annotations for not rendered stream element in V2.
+- to.hdi:
+  + for naming mode "hdbcds" and "quoted" parameter definitions are not quoted anymore.
+- to.hdi/sql/hdbcds:
+  + Correctly handle explicit and implicit alias during flattening.
+  + Raise an error for `@odata.draft.enabled` artifacts with elements without types - instead of crashing with internal assertions.
+
+## Version 2.8.0 - 2021-10-07
+
+### Added
+
+- Allow defining unmanaged associations in anonymous aspects of compositions.
+- Enable extensions of anonymous aspects for managed compositions of aspects.
+- When the option `addTextsLanguageAssoc` is set to true and
+  the model contains an entity `sap.common.Languages` with an element `code`,
+  all generated texts entities additionally contain an element `language`
+  which is an association to `sap.common.Languages` using element `local`.
+- for.odata:
+  + In `--odata-format=flat`, structured view parameters are flattened like elements.
+- to.hdbcds
+  + Use "smart quotes" for naming mode "plain" - automatically quote identifier which are reserved keywords or non-regular.
+
+### Changed
+
+- for.odata:
+  + In `--data-format=structured`, anonymous sub elements of primary keys and parameters are set to `notNull:true`,
+    an existing `notNull` attribute is _not_ overwritten. Referred named types are _not_ modified.
+- to.edm(x):
+  + Improve specification violation checks of (nested) keys:
+    + All (sub-)elements must be `Nullable: false` (error).
+    + Must represent a single value (error).
+    + In V4 must be a specification compliant Edm.PrimitiveType (warning).
+- to.hdi/hdbcds/sql: $user.\<xy\> now has \<xy\> added as alias - "$user.\<xy\> as \<xy\>"
+
+### Fixed
+
+- Properly generate auto-exposed entities for associations in parameters.
+- Correctly apply extensions to anonymous array item types.
+- Correctly apply/render annotations to anonymous action return types.
+- With CSN flavor `plain` (`gensrc`), correctly render annotations on elements
+  of referred structure types as `annotate` statements in the CSN's `extensions` property.
+- to.cdl:
+  + Correctly render extensions on array item types
+  + Correctly render annotations on action return types
+- to/for: Correctly handle CSN input where the prototype of objects is not the "default"
+- to.hdi:
+  + for naming mode "hdbcds" and "quoted" parameter definitions are now quoted.
+  + for naming mode "plain", smart quotation is applied to parameter definitions if they are reserved words.
+- to.hdi/hdbcds/sql:
+  + Ensure that cdl-style casts to localized types do not lose their localized property
+  + Fix a small memory leak during rendering of SQL/HDBCDS.
+- to.edm(x): Remove ambiguous `Partner` attribute from `NavigationProperty`. A forward association referred
+  to by multiple backlinks (`$self` comparisons) is no longer partner to an arbitrary backlink.
+
+## Version 2.7.0 - 2021-09-22
+
+### Added
+
+- to.hdi.migration:
+  + Support changes to HANA comments.
+
+### Changed
+
+- Updated OData vocabularies 'Common', 'Core'
+
+### Fixed
+
+- Fix memory issue: do not keep reference to last-compiled model.
+- Fix dump which occured when trying to report that the user has defined an element to be both `key` and `localized` if
+  `localized` was inherited via the provided type, or in the generated entity for a managed composition of aspect.
+- Properly auto-expose targets of associations in parameters and `many`.
+- for.Odata:
+  + Fix handling of annotation `@cds.odata.valuelist` in conjunction with associations in structures using flat-mode and sqlMapping set to plain.
+  + Set correctly the $localized property in the OData backend resulting CSN for artifacts that have localized convenience views.
+- to.edm(x):
+  + Fix rendering of structured referential constraints and nested partnerships in combination with `$self` comparisons.
+  + Fix merging of `@Capabilities` annotations while transforming them into `NavigationCapabilities` from the containee into the container.
+- to.sql/hdi/hdbcds:
+  + Fix a bug in Association to Join translation in multi-level association redirection in combination with `$self`.
+  + Correctly flatten paths with filters or parameters.
+  + Improve error message in case of invalid `exists`.
+
+## Version 2.6.2 - 2021-08-26
+
+### Fixed
+
+- to.sql/hdi/hdbcds/edm(x)/for.odata: Correctly handle tuple expansion in subqueries of Unions.
+
+## Version 2.6.0 - 2021-08-23
+
+### Added
+
+- Support managed associations without foreign keys. Associations targeting a definition without primary keys or with an
+  explicit empty foreign key tuple or with empty structured elements as foreign keys and their corresponding `$self`
+  comparisons do not describe the relationship between the source and the target entity.
+  These associations can be used to establish API navigations but cannot be used to access elements in the target
+  entity as they cannot be transformed into a valid JOIN expression.
+  Consequently, these associations are not added to the `WITH ASSOCIATIONS` clause or forwarded to HANA CDS.
+- to.sql/hdi/hdbcds/edm(x)/for.odata: Structure/managed association comparisons (tuple comparisons) are now
+  also expanded in infix filters, all expressions and all on-conditions.
+- to.hdbcds: Better locations for messages - mostly concerning keywords and duplicates
+
+### Changed
+
+- to.sql/hdi/hdbcds: Invalid (i.e. not expandable) usage of structures is now checked - an error is raised
+
+### Removed
+
+- The internal non-enumerable CSN property `$env` has been removed from the compiled CSN.
+
+### Fixed
+
+- Make `;` optional before `}` in all circumstances (was not the case with `many`).
+- to.sql/hdi/hdbcds/edm(x): More graceful handling of CSN input where associations do not have `keys` or an `on`-condition
+
 ## Version 2.5.2 - 2021-08-10
 
 ### Fixed
@@ -53,19 +273,19 @@ The compiler behavior concerning `beta` features can change at any time without
   and 'Ignoring draft node for composition target ... because it is not part of a service'
 - Doc comments are no longer ignored after enum values and on view columns in parseCdl mode.
 - to.cdl:
-  - Doc comments for enum values are correctly rendered.
-  - Enum value and doc comments are now correctly rendered if the enum is called `doc`.
-  - Doc comments at type references are correctly rendered.
-  - Empty doc comments are correctly rendered and not left out.
-  - Doc comments on view columns are correctly rendered.
+  + Doc comments for enum values are correctly rendered.
+  + Enum value and doc comments are now correctly rendered if the enum is called `doc`.
+  + Doc comments at type references are correctly rendered.
+  + Empty doc comments are correctly rendered and not left out.
+  + Doc comments on view columns are correctly rendered.
 - to.edm(x):
-  - OData V2: Ignore `@odata.singleton`.
-  - OData V4: Do not render an `edm:NavigationPropertyBinding` to a singleton if the association has
+  + OData V2: Ignore `@odata.singleton`.
+  + OData V4: Do not render an `edm:NavigationPropertyBinding` to a singleton if the association has
     cardinality 'to-many'.
 - forOData:
-  - Fix automatic renaming of shortcut annotation (eg. `@label`) with value `null`.
+  + Fix automatic renaming of shortcut annotation (eg. `@label`) with value `null`.
 - CSN parser:
-  - Empty doc comments are correctly parsed and not complained about.
+  + Empty doc comments are correctly parsed and not complained about.
 
 ## Version 2.4.4 - 2021-07-02
 
@@ -483,6 +703,12 @@ synchronously.
 - to.hdi.migration: Don't generate `ALTER` for type change from association to composition or vice versa (if the rest stays the same),
   as the resulting SQL is  identical.
 
+## Version 1.50.10 - 2021-07-30
+
+### Fixed
+
+- to.hdi.migration: Check for incompatible CSN versions to avoid wrongly generated ALTER|DROP|ADD statements.
+
 ## Version 1.50.8 - 2021-07-01
 
 ### Fixed

package/bin/cdsc.js

@@ -26,8 +26,10 @@ const path = require('path');
 const { reveal } = require('../lib/model/revealInternalProperties');
 const enrichCsn = require('../lib/model/enrichCsn');
 const { optionProcessor } = require('../lib/optionProcessor');
-const { explainMessage, hasMessageExplanation, sortMessages } = require('../lib/base/messages');
-const term = require('../lib/utils/term');
+const {
+  explainMessage, hasMessageExplanation, sortMessages, messageIdsWithExplanation,
+} = require('../lib/base/messages');
+const { term } = require('../lib/utils/term');
 const { splitLines } = require('../lib/utils/file');
 const { addLocalizationViews } = require('../lib/transform/localized');
 const { availableBetaFlags } = require('../lib/base/model');
@@ -52,9 +54,11 @@ function remapCmdOptions(options, cmdOptions) {
         options.sqlMapping = value;
         break;
       case 'user':
-        if (!options.magicVars)
-          options.magicVars = {};
-        options.magicVars.user = value;
+        if (!options.variableReplacements)
+          options.variableReplacements = {};
+        if (!options.variableReplacements.$user)
+          options.variableReplacements.$user = {};
+        options.variableReplacements.$user.id = value;
         break;
       case 'dialect':
         options.sqlDialect = value;
@@ -63,9 +67,11 @@ function remapCmdOptions(options, cmdOptions) {
         options.odataVersion = value;
         break;
       case 'locale':
-        if (!options.magicVars)
-          options.magicVars = {};
-        options.magicVars.locale = value;
+        if (!options.variableReplacements)
+          options.variableReplacements = {};
+        if (!options.variableReplacements.$user)
+          options.variableReplacements.$user = {};
+        options.variableReplacements.$user.locale = value;
         break;
       default:
         options[key] = value;
@@ -124,8 +130,6 @@ try {
       global.cds = {};
     global.cds.home = cmdLine.options.cdsHome;
   }
-  // Default color mode is 'auto'
-  term.useColor(cmdLine.options.color || 'auto');
 
   // Set default command if required
   cmdLine.command = cmdLine.command || 'toCsn';
@@ -137,10 +141,7 @@ try {
   if (cmdLine.command === 'parseCdl') {
     cmdLine.command = 'toCsn';
     cmdLine.options.parseCdl = true;
-    if (cmdLine.args.files.length > 1) {
-      const err = `'parseCdl' expects exactly one file! ${cmdLine.args.files.length} provided.`;
-      displayUsage(err, optionProcessor.commands.parseCdl.helpText, 2);
-    }
+    cmdLine.args.files = [ cmdLine.args.file ];
   }
 
   if (cmdLine.options.directBackend)
@@ -155,6 +156,14 @@ try {
     });
   }
 
+  // remap string values for `assertIntegrity` option to boolean
+  if (cmdLine.options.assertIntegrity &&
+      cmdLine.options.assertIntegrity === 'true' ||
+      cmdLine.options.assertIntegrity === 'false'
+  )
+    cmdLine.options.assertIntegrity = Boolean(cmdLine.options.assertIntegrity);
+
+
   // Enable all beta-flags if betaMode is set to true
   if (cmdLine.options.betaMode)
     cmdLine.options.beta = availableBetaFlags;
@@ -231,6 +240,8 @@ function executeCommandLine(command, options, args) {
   if (options.out && options.out !== '-' && !fs.existsSync(options.out))
     fs.mkdirSync(options.out);
 
+  // Default color mode is 'auto'
+  const colorTerm = term(options.color || 'auto');
 
   // Add implementation functions corresponding to commands here
   const commands = {
@@ -393,14 +404,15 @@ function executeCommandLine(command, options, args) {
   }
 
   function explain() {
-    if (args.length !== 1)
-      displayUsage('Command \'explain\' expects exactly one message-id.', optionProcessor.commands.explain.helpText, 2);
+    if (args.messageId === 'list') {
+      console.log(messageIdsWithExplanation().join('\n'));
+      throw new ProcessExitError(0);
+    }
 
-    const id = args.files[0];
-    if (!hasMessageExplanation(id))
-      console.error(`Message '${id}' does not have an explanation!`);
+    if (!hasMessageExplanation(args.messageId))
+      console.error(`Message '${args.messageId}' does not have an explanation!`);
     else
-      console.log(explainMessage(id));
+      console.log(explainMessage(args.messageId));
   }
 
   // Display error messages in `err` resulting from a compilation.  Also set
@@ -411,7 +423,7 @@ function executeCommandLine(command, options, args) {
       if (options.rawOutput)
         console.error( util.inspect( reveal( err.model, options.rawOutput ), false, null ));
       else
-        displayMessages( err.model, err.errors );
+        displayMessages( err.model, err.messages );
       process.exitCode = 1;
     }
     else if (err instanceof compiler.InvocationError) {
@@ -464,16 +476,20 @@ function executeCommandLine(command, options, args) {
         hasAtLeastOneExplanation = hasAtLeastOneExplanation || main.hasMessageExplanation(msg.messageId);
         const name = msg.location && msg.location.file;
         const fullFilePath = name ? path.resolve('', name) : undefined;
-        const context = fullFilePath && sourceLines(fullFilePath);
+        const context = fullFilePath ? sourceLines(fullFilePath) : [];
         log(main.messageStringMultiline(msg, {
-          normalizeFilename, noMessageId: !options.showMessageId, withLineSpacer: true, hintExplanation: true,
+          normalizeFilename,
+          noMessageId: !options.showMessageId,
+          withLineSpacer: true,
+          hintExplanation: true,
+          color: options.color,
         }));
         if (context)
-          log(main.messageContext(context, msg));
+          log(main.messageContext(context, msg, { color: options.color }));
         log(); // newline
       });
       if (options.showMessageId && hasAtLeastOneExplanation)
-        log(`${term.help('help')}: Messages marked with '…' have an explanation text. Use \`cdsc explain <message-id>\` for a more detailed error description.`);
+        log(`${colorTerm.help('help')}: Messages marked with '…' have an explanation text. Use \`cdsc explain <message-id>\` for a more detailed error description.`);
     }
     return model;
   }
@@ -528,7 +544,7 @@ function executeCommandLine(command, options, args) {
     fileName = fileName.replace(/[:/\\]/g, '_');
 
     // replace all dots with underscore to get deployable .hdbcds sources (except the one before the file extension)
-    if (options.toHana)
+    if (options.transformation === 'hdbcds')
       fileName = fileName.replace(/\.(?=.*?\.)/g, '_');
 
     if (!(content instanceof String || typeof content === 'string'))
@@ -549,10 +565,11 @@ function executeCommandLine(command, options, args) {
   }
 
   function catchErrors(err) {
+    // @ts-ignore
     if (err instanceof Error && err.hasBeenReported)
       return;
     console.error( '' );
-    console.error( 'INTERNAL ERROR: %s', err );
+    console.error( 'INTERNAL ERROR:' );
     console.error( util.inspect(err, false, null) );
     console.error( '' );
     process.exitCode = 70;

package/bin/cdsse.js

@@ -11,6 +11,7 @@
 // Planned are: gotoDefinition, highlight (for syntax highighting).
 
 /* eslint no-console:off */
+// @ts-nocheck
 
 'use strict';
 

package/doc/CHANGELOG_BETA.md

@@ -1,12 +1,47 @@
 # ChangeLog of Beta Features for cdx compiler and backends
 
 <!-- markdownlint-disable MD024 -->
+<!-- markdownlint-disable MD004 -->
 <!-- (no-duplicate-heading)-->
 
 Note: `beta` fixes, changes and features are listed in this ChangeLog just for information.
 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 2.11.0
+
+### Removed `foreignKeyConstraints`
+
+## Version 2.10.4
+
+### Fixed `nestedProjections`
+
+- to.sql/hdi/hdbcds: Correctly handle a `*` at the not-first place in the query
+
+## Version 2.6.0
+
+### Removed `pretransformedCSN`
+
+### Removed `renderSql`
+
+### Removed `keylessManagedAssoc`
+
+This is now the default - see CHANGELOG entry for 2.6.0
+
+### Fixed `nestedProjections`
+
+- to.sql/hdi/hdbcds: now work correctly when nested projections are used
+
+### Fixed `foreignKeyConstraints`
+
+- Always use the name of the association / backlink compared to
+  `$self` as name suffix for a constraint
+- Composition of one always result in:
+  + ON DELETE RESTRICT
+  + ON UPDATE RESTRICT
+- Composition of one w/o backlink will result in a constraint in
+  the entity where the composition is defined
+
 ## Version 2.4.4
 
 ### Added `nestedProjections`
@@ -15,8 +50,8 @@ The compiler behavior concerning `beta` features can change at any time without
   `longer.ref as name { *, … } excluding { … }`, `{ col_expression1 as sub1, … } as name`, etc.
 - Support `inline`: columns can look like `assoc_or_struct_or_tabalias.{ col_expression1, … }`,
   `longer.ref[filter = condition].{ *, … } excluding { … }`, `assoc_or_struct_or_tabalias.*`, etc.
-- _Some checks are missing and will be added!  Minor changes might occur._
-- __The SQL backends might not work properly yet if nested projections are used!__
+- _Some checks are missing and will be added! Minor changes might occur._
+- **The SQL backends might not work properly yet if nested projections are used!**
 
 ## Version 2.4.2
 
@@ -30,7 +65,6 @@ The compiler behavior concerning `beta` features can change at any time without
   Consequently, these associations are not added to the `WITH ASSOCIATIONS` clause or forwarded to HANA CDS.
   Managed Associations without foreign keys must be enabled with `--beta: keylessManagedAssoc`
 
-
 ## Version 2.4.0
 
 ### Changed `foreignKeyConstraints`

package/lib/api/.eslintrc.json

@@ -14,6 +14,8 @@
     "jsdoc"
   ],
   "rules": {
+    // Does not recognize TS types
+    "jsdoc/no-undefined-types": "off",
     // eslint-plugin-jsdoc warning
     "jsdoc/require-property": 0,
     // =airbnb, >eslint: