--- versions: cdsjs: 6.1.3 cdsdk: 6.1.5 cdsc: 3.1.2 cdsmtxs: 1.1.2 java: 1.27.3 --- # August 2022 [[toc]] ## CAP on Kyma/K8s { #tools} ### Important Changes ❗️ { #changes-in-kyma .important } #### New Component Minimum Version The latest version of the [CAP Helm chart](/@external/guides/deploy/to-kyma#deploy-to-kyma) (`cds add helm`) introduces new minimum version requirements for the following components: | Component | Minimum Version | |-|-| | `cds` (Java) | 1.27.0 | | `@sap/hdi-deploy` (SAP HANA Deployer) | 4.4.1 | | `@sap/html5-app-deployer` ([HTML5 application deployer](/@external/guides/deploy/to-kyma#html5-applications)) | 4.1.2 | #### Don't Use `CDS_ENVIRONMENT_K8S_SERVICEBINDINGS_*` Environment Variables Make sure that no environment variables starting with `CDS_ENVIRONMENT_K8S_SERVICEBINDINGS_` are in your `chart/values.yaml` file of your Helm chart, as they conflict with the [new service bindings](#cap-java-support-for-servicebindingio-service-bindings). These variables were previously added by the `cds add helm:connectivity` command. ### CAP Java Support for `servicebinding.io` Service Bindings CAP Java now makes use of the new open source [Service Binding Access library](https://github.com/SAP/btp-environment-variable-access) as default source to obtain service bindings. On K8s/Kyma it integrates better with the SAP BTP Service Operator, which uses a [servicebinding.io based format](https://blogs.sap.com/2022/07/12/the-new-way-to-consume-service-bindings-on-kyma-runtime/). This allows reading service bindings with the same set of metadata as in Cloud Foundry, which makes it fully transparent to the CAP application if the service bindings are read in the K8s/Kyma or Cloud Foundry environment. ### Configure Resources for Content Deployment Jobs You can now configure the Kubernetes resources for [HTML5 application](/@external/guides/deploy/to-kyma#html5-applications) and HANA deployment jobs. The default configuration is added by running `cds add helm`. ### Add Environment Variables for Content Deployment Jobs [HTML5 application](/@external/guides/deploy/to-kyma#html5-applications) and SAP HANA deployment jobs allow adding environment variables. For example, the following snippet from the Helm chart adds an environment variable `DEBUG` with value `*` to the HTML5 applications deployer job: ```yaml html5_apps_deployer: env: DEBUG: '*' ``` ### Schema Validation The Helm chart now contains a JSON schema that `helm` uses to validate the `values.yaml` file. Development tools, such as Visual Studio Code, can use the schema to show validation errors, descriptions and suggestions. ## Improved VS Code Support for CDS Configuration { #tools-config-schema } Code completion and validation for the `cds` configuration has been improved in VS Code. In both `package.json` and `.cdsrc.json`, you get hints on the possible values plus warnings for invalid values based on the installed `@sap/cds` version. Especially filling out the `cds.requires` section is now much easier. ![A gif showing the code completion for CDS configuration in VS Code.](assets/aug22/json_code_completion.gif) ## CDS Language & Compiler { #cds} ### SAP HANA Regex Functions CDS natively supports the [SAP HANA Regex functions](https://help.sap.com/docs/HANA_CLOUD_DATABASE/c1d3f60099654ecfb3fe36ac93c121bb/20a24d4b75191014afc5ac3b997d3ce2.html?locale=en-US) `locate_regexpr`, `occurrences_regexpr`, `replace_regexpr`, and `substring_regexpr`: ```cds entity Foo as select from Bar { /* ... */ substring_regexpr(pattern in name from 5) as sub }; ``` ### Actions and Functions in Aspects Aspects now can have bound actions and functions: ```cds aspect TravelActions { } actions { action rejectTravel(); action acceptTravel(); function isValid() returns Boolean; } ``` Reuse these aspects for example in services: ```cds service TravelService { entity Travel as projection on my.Travel; extend Travel with TravelActions; } ``` [Learn more about Aspects.](/@external/cds/cdl#aspects){ .learn-more} ## Java SDK { #cds-java} ### Important Changes ❗️ { .important #important-changes-in-java} #### Minimum Spring Boot Version 2.7.x - CAP Java SDK now requires Spring Boot version `2.7.x` or later. Most notably the deprecated `WebSecurityConfigurerAdapter` has been migrated to `SecurityFilterChain` in CAP Java. As both can't coexist, custom security configurations in applications **need to be migrated** to `SecurityFilterChain` as well. See an [example](/@external/java/security#custom-spring-security-config) in our documentation. In addition, Spring Boot `2.7.x` defaults to H2 version `2.x`, which is not fully compatible with DDL artifacts generated by CDS compiler. If you use H2, make sure to pin your application to H2 version `1.x` as shown in the bookshop [example](https://github.com/SAP-samples/cloud-cap-samples-java/blob/709b095df53d39dc675a78ac7dc930829f04b5d1/pom.xml#L70). In addition, read the Spring Boot [upgrade instructions](https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-2.7-Release-Notes#upgrading-from-spring-boot-26). - The deprecated path access via `CdsData::get` has been removed. Instead use `data.getPath("deeply.nested.key")` to access values in deeply nested maps. ### Error Response Handler Exceptions thrown during event handler processing, are caught by OData V2 and V4 protocol adapters and are turned into corresponding OData error responses. So far, it wasn't possible to change error responses as exceptions were thrown by the framework. Now, you can customize these responses by handling the `ERROR_RESPONSE` event of the [Application Lifecycle Service](https://www.javadoc.io/doc/com.sap.cds/cds-services-api/latest/com/sap/cds/services/application/ApplicationLifecycleService.html) emitted by the protocol adapter. You can control the error message text, code and the list of [messages](https://www.javadoc.io/doc/com.sap.cds/cds-services-api/latest/com/sap/cds/services/messages/Messages.html) collected during request processing for specific or general error situations. The following example demonstrates how to change the error text of authorization errors: ```java @Component @ServiceName(ApplicationLifecycleService.DEFAULT_NAME) public class SimpleExceptionHandler implements EventHandler { @After public void overrideMissingAuthMessage(ErrorResponseEventContext context) { if (context.getException().getErrorStatus().equals(CdsErrorStatuses.EVENT_FORBIDDEN)) { context.getResult().getMessages().set(0, Message.create(Severity.ERROR, "You cannot execute this action")); } } } ``` Find the details in our [documentation](/@external/java/event-handlers/indicating-errors#errorhandler). ### Messaging via Redis PubSub ::: warning This is a beta feature. Beta features are not part of the officially delivered scope that SAP guarantees for future releases. ::: There's a new `MessagingService` based on Redis PubSub, which is suitable for asynchronous communication between tightly-coupled microservices. To configure this messaging service, bind your CAP application to an appropriate platform service, for example of type `redis-cache`, and add the following feature in your _pom.xml_: ```xml com.sap.cds cds-feature-redis ``` In the _application.yaml_ you can configure a Redis messaging service explicitly: ```yaml cds: messaging.services: my-redis-service: kind: redis-pubsub ``` ### Enhanced TenantProviderService The [TenantProviderService](https://www.javadoc.io/doc/com.sap.cds/cds-services-api/latest/com/sap/cds/services/mt/TenantProviderService.html) now offers a new `readProviderTenant()` method, which provides the tenant ID of the provider. This method tries to retrieve the information from an existing XSUAA, Identity (IAS) or SaaS Registry service binding. ### Character-based Media Streams Besides media types based on binary data (`LargeBinary`), CAP Java now also supports character-based media streams (`LargeString`): ```cds entity Books : cuid { title : String; content : LargeString @Core.MediaType: 'text/plain'; } ``` Programmatically you consume `content` in custom handlers using `java.io.Reader`. Refer to the [media type](/@external/java/cds-data#mediatypeprocessing) documentation for details. ### Simplified Authentication Configuration We introduced a new property `cds.security.authentication.mode`, which controls the _authentication_ strategy for CAP endpoints: - `model-strict` authenticates endpoints based on `@requires/@restrict`. Paths to model elements without annotation are _authenticated_. - `model-relaxed` authenticates endpoints based on `@requires/@restrict`. Paths to model elements without annotation are _public_. - `never` disables authentication of _all_ CAP endpoints (use in local development scenario only!). - `always` authenticates _all_ CAP endpoints. Mode `model-strict` is set by default. Note that the authentication mode has no impact on the _authorization_ behaviour. ### Miscellaneous - The generated data [accessor interfaces](/@external/java/cds-data#generated-accessor-interfaces) for entities with a single key element now come with a `create` method that takes the key value. ```java Books book = Books.create(201); Integer bookId = book.getId(); // 201 ``` - The [CqnAnalyzer](/@external/java/working-with-cql/query-introspection#cqnanalyzer) now can extract (key) values from more complex predicates. - The `cds-services-archetype` now provides the new parameter `inMemoryDatabase` to choose the in-memory database configuration for local testing in the newly created CAP Java project. Supported values are `h2` (default) and `sqlite`. - Annotations `@Capabilities.Readable` and `@Capabilities.ReadRestrictions.Readable` are now handled. - Authentication-related settings in section `cds.security` have been moved to new subsection `cds.security.authentication`: - `authenticateUnknownEndpoints` is replaced by `authentication.authenticateUnknownEndpoints`. - `openMetadataEndpoints` is replaced by `authentication.authenticateMetadataEndpoints` (mind the negation!). - `openUnrestrictedEndpoints` and `defaultRestrictionLevel` are subsumed under the new property `authentication.mode`. All previous properties are deprecated and can still be used for compatibility. ## Node.js Runtime { #cds-js} ### Important Changes ❗️ { #changes-in-node-js .important } You can now use `cds.ql` fluent API to query tables not in the model, but in the database. For example, within `cap/samples/bookshop` this works now: ```js await SELECT.from('sqlite_master') await cds.read('sqlite_master') ``` Caveat: the following undocumented usage of unqualified names happened to work in the past. But this was very fragile and caused lots of issues, and therefore was removed: ```js await SELECT.from('Books') await cds.read('Books') ``` Always use qualified names, or reflected definitions instead: ```js const Books = 'sap.capire.bookshop.Books' await SELECT.from(Books) await cds.read(Books) ``` ```js const {Books} = cds.entities ('sap.capire.bookshop') await SELECT.from(Books) await cds.read(Books) ``` ### Improved REST Adapter - Aliased parameters in requests like `/submitOrder(ID=@p)?@p=1` are now supported. - `in` operator in requests like `/Books?$filter=ID in (1,2,3)` are now converted to the correct CQN syntax. ### Improved Consumption of Remote OData V2 Services - `cds.Time` is now converted to the correct format `PTHMS`. - The CQN property `search` is now converted into a SAP-specific custom query option: ```js { SELECT: { from: [{ ref: ['Books'] }], search: [{ val: 'wut' }] } } ``` This query is translated into the URL `/Books?search=wut`.