@sap/cds-compiler 4.0.0 → 4.1.2

package/CHANGELOG.md

@@ -7,6 +7,89 @@
 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 4.1.2 - 2023-07-31
+
+### Fixed
+
+- to.hdi.migration: Changes in constraints are not rendered as part of the .hdbmigrationtable file, as they belong in other HDI artifacts
+
+## Version 4.1.0 - 2023-07-28
+
+### Added
+
+- Calculated elements "on-read" can now reference localized elements.
+- Aliases for columns inside sub-queries are now optional, also for expressions.
+- for.odata/to.hdi/to.sql: Specified default value on a managed association is forwarded to a foreign key
+  if association has exactly one foreign key.
+- CDL: Annotation-only aspects having no `elements` and `actions` can now be defined with
+  the CDL syntax `@Anno… aspect Name;`.  They cannot be extended with elements or actions
+  in order to ensure that they can always be used to extend non-structures.
+  To allow the former but not the latter, use `@Anno… aspect Name {…};`.
+- to.sql: Support session variables for h2
+
+### Changed
+
+- api: Function `isInReservedNamespace(name)` handles name `cds` as being in a reserved namespace as well.
+- `CompilationError.messages` are now sorted severity aware. Errors are listed first.
+- Compiler:
+  + Improve the calculation of semantic code completion candidates.
+  + Some checks, like those for valid `on` conditions of associations,
+    are now already done with `compile` and not just the backends.
+  + SQL `cast()`s must always have a `type` property
+  + Type properties such as `precision` or `length` must be accompanied by a type (possibly inferred).
+- for.odata/to.hdi/to.sql: No longer reject unmanaged associations as foreign keys of a managed association.
+  Instead, ignore such references during ON-condition rewriting and foreign key generation. Referring to
+  unmanaged associations is incompatible with SAP HANA CDS naming mode 'hdbcds'.
+- to.sql: Rework session variables for postgres.
+- Update OData vocabularies: 'Common', 'HTML5', 'PersonalData', 'UI'.
+
+### Fixed
+
+- Compiler:
+  + ensure that annotations of elements in anonymous aspects of managed compositions
+    are not lost.
+  + issue error for definitions like `entity Self as projection on Base { $self.* };`
+    instead of simply concluding that the projection has zero elements.
+  + do not report a invalid cyclic dependency if associations between two entities
+    are valid cycles.
+  + Element type references can again follow associations (removed v4.0 incompatibility).
+- to.sql:
+  + `$self` references inside a nested projection using `$self` was incorrectly resolved.
+  + associations to entities marked with `@cds.persistence.skip` were not properly
+    checked inside nested projections.
+  + Select items casting `null` to an arrayed type work again, e.g. `null as ManyType`.
+- to.sql/hdi/hdbcds: Raise a nice error message for `@sql.append` on managed associations/compositions,
+  as we do for structured error messages.
+- to.cdl: Annotations with multiple qualifiers (`#`) are now rendered correctly.
+- to.edm(x): Revert change introduced with [3.9.0](#version-390---2023-04-20)
+    "Correct referential constraint calculation for `[0..1]` backlink associations".
+- for.odata: Process shortcut annotations sequence independent.
+- to.sql.migration:
+  + Respect unique and referential constraints for delta calculation.
+  + Added a configurable error for primary key additions, as those will lead to errors if the table
+    contains data. This could lead to inconsistent states if
+    some deployments succeed and others fail, so by default it is an error.
+
+### Removed
+
+- Compiler:
+  + forbid wildcards in projection extensions: `extend … with columns { * )`.
+  + forbid column references such as `$user.*`, `$user.{id}` and `$user {id}`.
+
+## Version 4.0.2 - 2023-06-22
+
+### Fixed
+
+- to.sql.migration: When drop-creating views, also drop-create (transitively) dependent views.
+- to.edm(x):
+  + Forward `@odata.singleton { nullable }` annotation to parameter entity.
+  + Annotations assigned to a parameterized entity are propagated to the parameter entity if the annotation is
+    applicable to either an `edm.EntitySet` or `edm.Singleton`. This especially covers all `@Capabilities` and their
+    shortcut forms like `@readonly` and `@insertonly`. The original annotation is not removed from the original entity.
+    Annotations that should be rendered at the parameter `edm.EntityType` can be qualified with `$parameters`.
+    Explicitly qualified annotations are removed from the original entity allowing individual assignments.
+
+
 ## Version 4.0.0 - 2023-06-06
 
 ### Added
@@ -62,8 +145,6 @@ The compiler behavior concerning `beta` features can change at any time without
   + Table alias and mixin names can no longer start with `$`. Choose a different name. With this change
     we avoid unexpected name resolution effects in combination with built-in `$`-variables.
   + A semicolon is now required after a type definition like `type T : many {} null`.
-  + It is no longer possible to write `type of $self.‹elem›` to refer to the element `‹Def›.‹elem›`
-    where `‹Def›` is the main artifact where the type expression is embedded in. Replace by `type of <Def>:‹elem›`.
   + Message ID `duplicate-autoexposed` was changed to `def-duplicate-autoexposed`.
 - Update OData vocabularies 'Common', 'UI'.
 - to.sql:
@@ -81,7 +162,12 @@ The compiler behavior concerning `beta` features can change at any time without
   + `parseCdl` CSN did not include correct `...` entries for annotations containing `... up to`
   + Type references inside calculated elements were not always correctly resolved.
   + `USING` empty files were incorrectly marked as "not found".
+  + Correct the handling of `$self` references in nested projections and filters in queries.
   + If an association was inside `items`, e.g. via type chains, the compiler crashes instead of emitting proper errors.
+  + References in the user-provided `on` conditions of associations with a to be
+    auto-redirected model entity as target were not always resolved correctly.
+    Complain in error situations.
+  + Make extend code robust against prototype-polluted JS classes.
 - Localized convenience views for projections (not views) did not have references rewritten.
   This only affects CSN, the SQL result was correct.
 - Calculated elements in composition-of-aspect lost their `value` when generating composition targets.
@@ -101,9 +187,33 @@ The compiler behavior concerning `beta` features can change at any time without
 - NodeJs 14 is no longer supported.
 - `CompileMessage` no longer has property `location`, which was deprecated in v2.1.0, but `$location`,
   which is supported since v2.1.0
-- "Smart type references" such as `Entity.myElement` instead of `Entity:myElement` are removed, because since
-  compiler v2, `Entity.myElement` could also be a definition, creating ambiguities.
-- Element type references can no longer follow associations, i.e. `E:assoc.id` is not allowed.
+- compiler:
+  + It is no longer possible to write `type of $self.‹elem›` to refer to the element `‹Def›.‹elem›`
+    where `‹Def›` is the main artifact where the type expression is embedded in. Replace by `type of <Def>:‹elem›`.
+  + Element type references can no longer follow associations, i.e. `E:assoc.id` is not allowed
+    (v4.0 only, re-introduced with v4.1).
+  + "Smart type references" such as `Entity.myElement` instead of `Entity:myElement`
+    are removed, because since - `Entity.myElement` could also be a definition,
+    creating ambiguities. This did not work always, anyway.
+
+
+## Version 3.9.6 - 2023-07-27
+
+### Fixed
+
+- to.edm(x): Revert change introduced with [3.9.0](#version-390---2023-04-20)
+    "Correct referential constraint calculation for `[0..1]` backlink associations".
+- for.odata: Process shortcut annotations sequence independent.
+
+## Version 3.9.4 - 2023-06-07
+
+### Fixed
+
+- compiler: `USING` empty files were incorrectly marked as "not found".
+- Localized convenience views for projections (not views) did not have references rewritten.
+  This only affects CSN, the SQL result was correct.
+- to.edm(x): Render correct EntitySetPath and annotation target path for actions/functions
+  with explicit binding parameter.
 
 ## Version 3.9.2 - 2023-04-27
 

package/bin/cdsc.js

@@ -499,29 +499,29 @@ function executeCommandLine( command, options, args ) {
 
     sortMessages(messages);
 
+    const msgConfig = {
+      normalizeFilename,
+      noMessageId: !!options.noMessageId,
+      hintExplanation: true,
+      color: options.color,
+      module: options.testMode && 'compile', // TODO: use module name
+      sourceMap: fileCache,
+      cwd: '',
+    };
+
     if (options.internalMsg) {
       messages.map(msg => util.inspect( msg, { depth: null, maxArrayLength: null } ) )
         .forEach(msg => log(msg));
     }
     else if (options.noMessageContext) {
       messages.filter(msg => (messageLevels[msg.severity] <= options.warning))
-        .forEach(msg => log(main.messageString(msg, normalizeFilename, !!options.noMessageId, false, options.testMode && 'compile'))); // TODO: use module name
+        .forEach(msg => log(main.messageString( msg, msgConfig )));
     }
     else {
       let hasAtLeastOneExplanation = false;
-      const config = {
-        normalizeFilename,
-        noMessageId: !!options.noMessageId,
-        hintExplanation: true,
-        color: options.color,
-        module: options.testMode && 'compile', // TODO: use module name
-        sourceMap: fileCache,
-        cwd: '',
-      };
-
       messages.filter(msg => messageLevels[msg.severity] <= options.warning).forEach((msg) => {
         hasAtLeastOneExplanation = hasAtLeastOneExplanation || main.hasMessageExplanation(msg.messageId);
-        log(main.messageStringMultiline(msg, config));
+        log(main.messageStringMultiline(msg, msgConfig));
         log(); // newline
       });
       if (!options.noMessageId && hasAtLeastOneExplanation)

package/doc/CHANGELOG_BETA.md

@@ -8,6 +8,17 @@ 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 4.1.0 - 2023-07-28
+
+### Added `associationDefault`
+
+With this beta flag enabled, managed associations with exactly one foreign key can now
+have a default value.
+
+### Removed `aspectWithoutElements`
+
+Aspects without elements can now be defined without beta flag, e.g. `aspect A;`.
+
 ## Version 4.0.0 - 2023-06-06
 
 ### Removed `v4preview`

package/lib/api/main.js

@@ -8,7 +8,7 @@ const location = lazyload('../base/location');
 const messages = lazyload('../base/messages');
 const compiler = lazyload('../compiler/index');
 const toCsn = lazyload('../json/to-csn');
-const forOdataNew = lazyload('../transform/forOdataNew.js');
+const forOdataNew = lazyload('../transform/forOdata.js');
 const toSql = lazyload('../render/toSql');
 const toCdl = require('../render/toCdl');
 const modelCompare = lazyload('../modelCompare/compare');
@@ -95,14 +95,14 @@ function checkPreTransformedCsn( csn, options, relevantOptionNames, warnAboutMis
 
   for (const name of relevantOptionNames ) {
     if (options[name] !== csn.meta.options?.[name]) {
-      error('wrong-pretransformed-csn', null, { prop: name, value: options[name], othervalue: csn.meta.options[name] },
+      error('api-invalid-option-preprocessed', null, { prop: name, value: options[name], othervalue: csn.meta.options[name] },
             'Expected pre-processed CSN to have option $(PROP) set to $(VALUE). Found: $(OTHERVALUE)');
     }
   }
 
   for (const name of warnAboutMismatch ) {
     if (options[name] !== csn.meta.options[name]) {
-      warning('options-mismatch-pretransformed-csn', null, { prop: name, value: options[name], othervalue: csn.meta.options[name] },
+      warning('api-mismatched-option-preprocessed', null, { prop: name, value: options[name], othervalue: csn.meta.options[name] },
               'Expected pre-processed CSN to have option $(PROP) set to $(VALUE). Found: $(OTHERVALUE)');
     }
   }
@@ -242,8 +242,10 @@ function sql( csn, options = {} ) {
   const sqls = toSql.toSqlDdl(transformedCsn, internalOptions);
 
   const result = sortViews({ csn: transformedCsn, sql: sqls.sql });
-
-  return result.map(obj => obj.sql).filter(create => create);
+  return [
+    ...result.map(obj => obj.sql).filter(create => create),
+    ...Object.values(sqls.constraints || {}),
+  ];
 }
 
 /**
@@ -359,7 +361,9 @@ function remapName( key, csn, filter = () => true ) {
 function sqlMigration( csn, options, beforeImage ) {
   traceApi("Options passed into 'to.sql.migration'", options);
   const internalOptions = prepareOptions.to.sql(options);
-  const { error, throwWithError } = messages.makeMessageFunction(csn, internalOptions, 'to.sql.migration');
+  const {
+    error, warning, info, throwWithError, message,
+  } = messages.makeMessageFunction(csn, internalOptions, 'to.sql.migration');
 
   // Prepare after-image.
   const afterImage = internalOptions.filterCsn
@@ -369,8 +373,12 @@ function sqlMigration( csn, options, beforeImage ) {
   const diffFilterObj = diffFilter[internalOptions.sqlDialect];
 
   if (diffFilterObj) {
-    diff.extensions.forEach(ex => diffFilterObj.extension(ex, error));
-    diff.migrations.forEach(migration => diffFilterObj.migration(migration, error));
+    diff.extensions = diff.extensions.filter(ex => diffFilterObj.extension(ex, {
+      error, warning, info, throwWithError, message,
+    }));
+    diff.migrations.forEach(migration => diffFilterObj.migration(migration, {
+      error, warning, info, throwWithError, message,
+    }));
     Object.entries(diff.deletions).forEach(entry => diffFilterObj.deletion(entry, error));
   }
 
@@ -384,6 +392,7 @@ function sqlMigration( csn, options, beforeImage ) {
     }, {}),
   };
 
+  const markedSkipByUs = {};
   const cleanup = [];
   // Delete artifacts that are already present in csn
   if (beforeImage?.definitions) {
@@ -404,22 +413,51 @@ function sqlMigration( csn, options, beforeImage ) {
       ) { // don't render again, but need info for primary key extension
         diffArtifact['@cds.persistence.skip'] = true;
         cleanup.push(() => delete diffArtifact['@cds.persistence.skip']);
+        markedSkipByUs[artifactName] = true;
       }
     });
   }
 
+  const sortOrder = sortViews({ sql: {}, csn: afterImage });
+
+  const dependentsDict = {};
+  sortOrder.forEach(({ name, dependents }) => {
+    dependentsDict[name] = dependents;
+  });
+
+  const stack = Object.keys(drops.creates);
+  while (stack.length > 0) {
+    const name = stack.pop();
+    const artifact = diff.definitions[name];
+    if (drops.creates[name] === undefined) {
+      if (artifact['@cds.persistence.skip'] && markedSkipByUs[name]) {
+        // Remove the skip so we render a CREATE VIEW
+        diff.definitions[name]['@cds.persistence.skip'] = false;
+        drops.creates[name] = `DROP VIEW ${ identifierUtils.renderArtifactName(name) };`;
+      }
+    }
+
+    const dependents = dependentsDict[name];
+    if (dependents) { // schedule any dependents for processing that don't have a drop-create yet
+      for (const dependantName in dependents) {
+        if (!drops.creates[dependantName])
+          stack.push(dependantName);
+      }
+    }
+  }
   // Convert the diff to SQL.
   if (!internalOptions.beta)
     internalOptions.beta = {};
 
   internalOptions.beta.sqlExtensions = true;
 
-  // eslint-disable-next-line no-unused-vars
-  const { deletions, migrations, ...hdbkinds } = toSql.toSqlDdl(diff, internalOptions);
+  const {
+    // eslint-disable-next-line no-unused-vars
+    deletions, constraintDeletions, migrations, constraints, ...hdbkinds
+  } = toSql.toSqlDdl(diff, internalOptions);
 
   cleanup.forEach(fn => fn());
   // TODO: Handle `ADD CONSTRAINT` etc!
-  const sortOrder = sortViews({ sql: {}, csn: afterImage });
 
   const dropSqls = [];
   const createAndAlterSqls = [];
@@ -445,6 +483,12 @@ function sqlMigration( csn, options, beforeImage ) {
       createAndAlterSqls.push(...migrations[name].map(m => m.sql));
   }
 
+  if (constraints)
+    Object.values(constraints).forEach(constraint => createAndAlterSqls.push(constraint));
+
+  if (constraintDeletions)
+    Object.values(constraintDeletions).forEach(constraint => dropSqls.push(constraint));
+
   // We need to drop the things without dependants first - so inversely sorted
   dropSqls.reverse();
 
@@ -482,7 +526,11 @@ function hdiMigration( csn, options, beforeImage ) {
 
   internalOptions.beta.sqlExtensions = true;
 
-  const { deletions, migrations, ...hdbkinds } = toSql.toSqlDdl(diff, internalOptions);
+  // Ignore constraint drops - that is handled by .hdbconstraint et. al.
+  const {
+    // eslint-disable-next-line no-unused-vars
+    deletions, migrations, constraintDeletions, ...hdbkinds
+  } = toSql.toSqlDdl(diff, internalOptions);
 
   return {
     afterImage,

package/lib/api/validate.js

@@ -115,7 +115,7 @@ const validators = {
     found: val => `type ${ typeof val }`,
   },
   testMode: {
-    validate: val => typeof val === 'boolean' || typeof val === 'number',
+    validate: val => typeof val === 'boolean' || typeof val === 'number' || val === '$noAssertConsistency',
     expected: () => 'type boolean|number',
     found: val => `type ${ typeof val }`,
   },

package/lib/base/location.js

@@ -4,6 +4,7 @@
 // but not semantic locations (which are message-specific),
 
 const { copyPropIfExist } = require('../utils/objectUtils');
+const { CsnLocation } = require('../compiler/classes');
 
 /**
  * Create a location with properties `file`, `line` and `col` from argument
@@ -41,6 +42,7 @@ function combinedLocation( start, end ) {
  */
 function emptyLocation( filename ) {
   return {
+    __proto__: CsnLocation.prototype,
     file: filename,
     line: 1,
     col: 1,
@@ -60,9 +62,12 @@ function emptyLocation( filename ) {
  */
 function emptyWeakLocation( filename ) {
   return {
+    __proto__: CsnLocation.prototype,
     file: filename,
     line: 1,
     col: 1,
+    endLine: undefined,
+    endCol: undefined,
   };
 }
 
@@ -140,13 +145,7 @@ function dictLocation( dict, extraLocation ) {
     const lineB = (b.endLine || b.line);
     return (lineA > lineB || (lineA === lineB && (a.endCol || a.col) > (b.endCol || b.col)) ? a : b);
   });
-  return {
-    file: min.file,
-    line: min.line,
-    col: min.col,
-    endLine: max.endLine,
-    endCol: max.endCol,
-  };
+  return new CsnLocation( min.file, min.line, min.col, max.endLine, max.endCol );
 }
 
 function _objLocations( obj ) {