@sap/cds-dk 6.0.4 → 6.1.1

package/CHANGELOG.md

@@ -1,3 +1,4 @@
+
 # Change Log
 
 All notable changes to this project will be documented in this file.
@@ -6,6 +7,43 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## Version 6.1.1 - 2022-08-11
+
+### Added
+
+- `cds import` now supports OData and SAP annotations for OData V4 imports.
+- `cds compile --to openapi` defines operation-specific HTTP error response status codes with descriptions via `ErrorResponses` property of certain annotations.
+- `cds compile --to openapi` now supports `--openapi:servers` option.
+- `cds add multitenancy` will add feature multitenancy-specific configuration, without extensibility.
+- `cds add toggles` will add feature toggle-specific configuration.
+- `cds add extensibility` will add configuration for project extensibility.
+- `cds add helm` now supports resource configuration for HANA deployment job and HTML5 app deployment job.
+- `cds add helm` added JSON Schema for values.yaml
+- `cds pull` will download the current CDS model of an extended SaaS app running with @sap/cds-mtxs.
+- `cds push` will upload an extension to a SaaS app running with @sap/cds-mtxs.
+
+### Changed
+
+- `cds add helm` updated default resource requirements for both `java` and `nodejs` projects.
+- `cds add helm` uses servicebinding.io bindings for CAP Java services, HANA and HTML5 app deployment jobs.
+- `cds compile --to openapi` creates only component schemas for schemas referenced in operations and in other schemas.
+- `cds import` switch from `@openapi.schema` to `@JSON.Schema`.
+- `cds add mtx` will now add configuration for streamlined MTX. It effectively acts as a shortcut for `cds add multitenancy,toggles,extensibility`
+- `cds add mtx` no longer includes `hana` and `xsuaa`.  To achieve the same effect as before, run `cds add mtx && cds add hana,xsuaa --for production`.
+- `cds bind -2 <xsuaa service instance>` binds the CDS `auth` service to the xsuaa instance. Previously `uaa` was used.  This requires `@sap/cds` 6 or higher.
+- `cds add lint:dev` updated to adjust to new api structure of `@sap/eslint-plugin-cds` v2.5.0
+- `cds init` uses latest Maven Java archetype version 1.27.0 for creating Java projects.
+- `cds login localhost:<port> -u <username>` now saves username (and empty password, if applicable) with project settings for convenience.
+
+### Fixed
+
+- `cds add helm:connectivity`: `connectivity.configMapName` was not used for the `connectivity-proxy-info`.
+- `cds import` replaced occurrences of `\\` with `/` in the `package.json` for Linux platforms.
+- `cds import` fixed `@Core.Description` and `doc` property duplication.
+- `cds extend` and `cds activate` no longer save any data (this is reserved to `cds login`).
+- Extensibility commands now add http (not https) to local app URLs without schema.
+- Extensibility commands don't query CF any longer when run against local apps.
+
 ## Version 6.0.4 - 2022-08-02
 
 ### Changed
@@ -14,7 +52,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - Use `@sap/cds` 6.0.4
 - `cds bind` handles orgs and spaces containing commas correctly.
 
-
 ## Version 6.0.3 - 2022-07-14
 
 ### Changed
@@ -24,6 +61,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
 ### Fixed
 
+- `--vap-file` parameter of `cds deploy` is available again (removed in 6.0.0)
+- `cds add helm:connectivity`: `connectivity.configMapName` was not used for the `connectivity-proxy-info`.
 - `--vcap-file` parameter of `cds deploy` is available again (removed in 6.0.0)
 - `cds add helm:connectivity`: `connectivity.configMapName` was not used for the `connectivity-proxy-info`.
 - `cds add helm:connectivity`: Environment variables added for connectivity service for Java.

package/bin/add.js

@@ -13,30 +13,40 @@ module.exports = Object.assign(add, {
 
     The following <features> are supported so far:
 
-    *hana*        - adds configuration for SAP HANA deployment
+    *hana*          - adds configuration for SAP HANA deployment
 
-    *xsuaa*       - adds configuration for authentication via XSUAA
+    *xsuaa*         - adds configuration for authentication via XSUAA
 
-    *mtx*         - adds configuration for multitenancy and extensibility
+    *multitenancy*  - adds configuration for multitenancy
 
-    *approuter*   - adds configuration for the Cloud Foundry approuter
+    *toggles*       - adds configuration for feature toggles
 
-    *mta*         - adds an _mta.yaml_ file for MTA-based SAP Business Technology Platform deployment
+    *extensibility* - adds configuration for extensibility
 
-    *cf-manifest* - adds _manifest.yml_ and _services-manifest.yml_ files for Cloud Foundry native deployment
+    *mtx*           - adds configuration for multitenancy, feature toggles and extensibility
 
-                  This approach makes use of the 'Create-Service-Push Plugin' that has to be installed
-                  separately using _cf install-plugin Create-Service-Push_.
-                  _cf create-service-push_ creates the service(s) and pushes the application(s) to the
-                  SAP Business Technology Platform.
+    *approuter*     - adds configuration for the Cloud Foundry approuter
 
-    *pipeline*    - adds files for CI/CD pipeline integration
+    *mta*           - adds an _mta.yaml_ file for MTA-based SAP Business Technology Platform deployment
 
-    *samples*     - adds simple sample files
+    *cf-manifest*   - adds _manifest.yml_ and _services-manifest.yml_ files for Cloud Foundry native deployment
 
-    *notebook*    - adds a Jupyter Notebook (beta)
+                    This approach makes use of the 'Create-Service-Push Plugin' that has to be installed
+                    separately using _cf install-plugin Create-Service-Push_.
+                    _cf create-service-push_ creates the service(s) and pushes the application(s) to the
+                    SAP Business Technology Platform.
+
+    *pipeline*      - adds files for CI/CD pipeline integration
+
+    *samples*       - adds simple sample files
+
+    *data*          - adds data content for CSN model entities (as csv files)
+
+    *helm*          - adds helm chart folder that contains the files needed to deploy the application using Kyma.
+
+                    To add a specific feature in the helm chart you can use the command 'cds add helm:<featureName>'.
+                    For example cds add helm:xsuaa and cds add helm:html5_apps_deployer.
 
-    *data*        - adds data content for CSN model entities (as csv files)
 
 # OPTIONS
 
@@ -56,10 +66,13 @@ module.exports = Object.assign(add, {
 
 # EXAMPLES
 
-    *cds add* hana,mta,pipeline
-    *cds add* mtx --for production
+    *cds add* mta,pipeline
+    *cds add* mtx
+    *cds add* hana,xsuaa --for production
     *cds add* cf-manifest
     *cds add* data --for my.namspace.MyEntity
+    *cds add* helm
+
 
 # SEE ALSO
 

package/bin/compile/index.js

@@ -1,6 +1,6 @@
 module.exports = Object.assign ( compile, {
   options: [
-  '--from', '--service', '--lang', '--for', '--to', '--dest', '--log-level', '--flavor', '--dialect', '--sql-dialect', '--openapi:url'
+  '--from', '--service', '--lang', '--for', '--to', '--dest', '--log-level', '--flavor', '--dialect', '--sql-dialect', '--openapi:url', '--openapi:servers'
   ],
   shortcuts: [
   undefined, '-s', '-l', '-4', '-2', '-o', undefined, '-f'
@@ -105,6 +105,11 @@ module.exports = Object.assign ( compile, {
     base path as declared in the CDS source.
     Use the \${service-path} variable to have the service path included in the URL.
 
+  *--openapi:servers* <Stringified JSON Object for Open API export>
+
+    The servers definition used in the generated OpenAPI document. *--openapi:url* is
+    ignored when this option is specified.
+
   *--openapi:diagram*
 
     Include YUML diagram in the generated OpenAPI document, default: *false*.

package/bin/fix-redirects.js

@@ -1,5 +1,6 @@
 const [arg0, arg1, _, ...args] = process.argv  // eslint-disable-line no-unused-vars
-const files = require('../lib/cds').resolve(args.length ? args : '*')
+const cds = require('../lib/cds')
+const files = cds.resolve(args.length ? args : '*')
 process.argv = [ arg0, arg1, 'ria', ...files ]
 
 console.log ('[cds] - searching for ambiguous redirects in', files)
@@ -7,6 +8,7 @@ const log = console.log; console.log = (...args) => {
   if (!log.found) log (log.found = '> found ambiguous redirects in these models -> please fix as follows:\n')
   log (...args)
 }
-require ('@sap/cds-compiler/bin/cdsv2m')
+
+require(require.resolve ('@sap/cds-compiler/bin/cdsv2m', {paths: [ cds.home, process.cwd(), __dirname ]}))
 
 module.exports = ()=>{}

package/bin/init.js

@@ -50,6 +50,11 @@ module.exports = Object.assign(init, {
 
         *notebook*    - adds a Jupyter Notebook (beta)
 
+        *helm*        - adds helm chart folder that contains the files needed to deploy the application using Kyma.
+
+                      To add a specific feature in the helm chart you can use the command 'cds add helm:<featureName>'. 
+                      For example cds add helm:xsuaa and cds add helm:html5_apps_deployer.
+
     *--java:mvn* <Comma separated maven archetype specific parameters>
 
         Add the given parameters to the archetype call.

package/bin/login.js

@@ -71,6 +71,11 @@ module.exports = Object.assign(login, {
 
         Tenant-specific passcode for authentication.
 
+    *-u* | *--username* <name>
+
+        Username for authentication with Basic Auth in test scenarios. For security reasons,
+        username will only be saved for app URLs that look like localhost.
+
     *-c* | *--clientid* <clientid>
 
         Client ID for authentication. This will override the default Client ID from environment.
@@ -103,11 +108,12 @@ async function login ([url], options = {}) {
     Object.assign(options, {
         url,
         tokenStorage: options.plain ? 'plain' : 'keyring',
-        renewLogin: true
+        renewLogin: true,
+        saveData: true
     })
     delete options.plain
 
-    await require('../lib/client/auth_manager').loginAndUpdateSettings(options)
+    await require('../lib/client/auth_manager').login(options)
 }
 
 

package/bin/pull.js

@@ -0,0 +1,58 @@
+module.exports = Object.assign(pull, {
+    options: ['--directory', '--subdomain', '--passcode', '--username', '--clientid'],
+    flags: [],
+    shortcuts: ['-d', '-s', '-p', '-u', '-c'],
+    help: `
+# SYNOPSIS
+
+    *cds pull* [ <app-url> ]
+
+    Pull the base model for your SaaS app extension.
+    
+    To run this command, you need to obtain from the SaaS application provider:
+    - the app URL
+    - a template for your extension project.
+
+    Then create your extension project from the template and run *cds pull* to update your copy of the CDS model of the
+    SaaS app (also known as the base model).
+
+    To facilitate running this multiple times against the same app, refer to the *cds login* command.
+
+    If the app URL is omitted, it is determined from the current user's active CDS or Cloud Foundry login.
+
+
+# OPTIONS
+
+    *-d* | *--directory* <project-extension-directory>
+
+        Specify the target directory of your extension project. By default, the current working directory is used.
+
+    *-s* | *--subdomain* <tenant-subdomain>
+
+        Specify your tenant's subdomain. By default, it's determined from the app URL.
+
+    *-p* | *--passcode* <passcode>
+
+        Tenant-specific passcode for authentication.
+
+    *-u* | *--username* <name>
+
+        Username for authentication with Basic Auth in test scenarios.
+
+    *-c* | *--clientid* <clientid>
+
+        Client ID for authentication. This will override the default Client ID from environment.
+
+# SEE ALSO
+
+    *cds push* to push an extension to the SaaS app.
+    
+`})
+
+
+async function pull([url], options = {}) {
+    await require('../lib/client/pull').run({
+        ...options,
+        url
+    })
+}

package/bin/push.js

@@ -0,0 +1,52 @@
+module.exports = Object.assign(push, {
+    options: ['--subdomain', '--passcode', '--username', '--clientid', '--to'],
+    flags: [],
+    shortcuts: ['-s', '-p', '-u', '-c'],
+    help: `
+# SYNOPSIS
+
+    *cds push* [ <extension-project-directory> ]
+
+    Push your extension to the SaaS app in order to enable or update it.
+    
+    By default, the current working directory is used as project directory.
+
+    To facilitate running this multiple times against the same app, refer to the *cds login* command.
+
+
+# OPTIONS
+
+    *--to* <url>
+
+        Specify the URL of the extensible SaaS app. By default, it is determined from
+        the current user's active CDS or Cloud Foundry login.
+
+    *-s* | *--subdomain* <tenant-subdomain>
+
+        Specify your tenant's subdomain. By default, it's determined from project settings.
+
+    *-p* | *--passcode* <passcode>
+
+        Tenant-specific passcode for authentication.
+
+    *-u* | *--username* <name>
+
+        Username for authentication with Basic Auth in test scenarios.
+
+    *-c* | *--clientid* <clientid>
+
+        Client ID for authentication. This will override the default Client ID from environment.
+
+# SEE ALSO
+
+    *cds pull* to get the CDS model of the SaaS app.
+
+`})
+
+
+async function push([projectFolder], options = {}) {
+    await require('../lib/client/push').run({
+        ...options,
+        projectFolder
+    })
+}

package/bin/subscribe.js

@@ -0,0 +1,45 @@
+module.exports = Object.assign(subscribe, {
+  options: ['--to', '--user'],
+  flags: [],
+  shortcuts: ['-2', '-u'],
+  help: `
+# SYNOPSIS
+
+  *cds subscribe* <tenant>
+
+  Subscribe a tenant to a multi-tenant SaaS app.
+
+  *cds subscribe* only supports Basic Authentication and is intended for non-productive use,
+  including SaaS apps running on localhost with mock authentication.
+
+# OPTIONS
+
+  *-2* | *--to* <url>
+
+    Specify the URL of the extensible SaaS app. Required setting.
+
+  *-u* | *--user* <name>[:<password>]
+
+    Username and optionally password for authentication. Required setting.
+    See https://cap.cloud.sap/docs/guides/multitenancy/#send-subscribe-events for information on suitable mock users.
+    
+    If password is omitted, it is assumed empty.
+    Note: productive passwords should not be specified on the command line.
+
+`})
+
+
+
+async function subscribe([tenant], { to: url, user } = {}) {
+  const Logger = require('../lib/client/helper/logging');
+
+  if (!tenant)  throw new Error('Must provide a tenant')
+  if (!url)  throw new Error('Must provide an app URL via `--to`')  // for now, if we don't infer it from the project
+  if (typeof user !== 'string')  throw new Error('Must provide a username')
+  const [, username, , password = ''] = /([^:]+)(:(.*))?/.exec(user);
+  Logger.log(`Subscribing to ${url} for tenant '${tenant}' with user '${username}'${password === '' ? ' and empty password' : ''}`);
+  const options = { auth: { username, password } };
+  return require('axios').post (url+'/-/cds/deployment/subscribe', { tenant }, options);
+}
+
+// cds subscribe t1 --to http://localhost:4004 -u yves

package/lib/bind/bindingUtil.js

@@ -3,8 +3,7 @@ const os = require('os');
 const IS_WIN = os.platform() === 'win32';
 
 const KindToRequiresNameMap = {
-    xsuaa: 'uaa',
-    'xsuaa-auth': 'uaa',
+    xsuaa: 'auth',
     'hana-cloud': 'db',
     hana: 'db',
     destinations: 'destinations',

package/lib/client/activate.js

@@ -42,7 +42,7 @@ module.exports = class Activate extends BaseCommand {
 
     static async run(injection, paramValues) {
         try {
-            const params = await AuthManager.loginAndUpdateSettings(paramValues);
+            const params = await AuthManager.login(paramValues);
 
             if (process.env.DEBUG) {
                 Logger.log('Activating extension with parameters ' + JSON.stringify({

package/lib/client/auth_manager.js

@@ -77,7 +77,7 @@ async function retrieveTokenOrPasscodeUrl(params) {
 
 module.exports = class AuthManager {
 
-    static async loginAndUpdateSettings(paramValues) {
+    static async login(paramValues) {
         SettingsManager.init();
         const params = new ParamCollection(paramValues);
         await SettingsManager.loadAndMergeSettings(params);
@@ -86,7 +86,9 @@ module.exports = class AuthManager {
         } else {
             await retrieveTokenOrPasscodeUrl(params);
             if (!params.has('token')) {
-                await SettingsManager.saveSettings(params);
+                if (params.get('saveData')) {
+                    await SettingsManager.saveSettings(params);
+                }
                 throw new Error('Failed to login: no valid token or passcode provided. ' +
                     'Get a passcode' + (params.get('passcodeUrl') ? ' from ' + params.get('passcodeUrl') : '') +
                     ' and supply the code when re-running the command');
@@ -94,7 +96,9 @@ module.exports = class AuthManager {
             params.set('reqAuth', { headers: { Authorization: 'Bearer ' + params.get('token') } });
         }
 
-        await SettingsManager.saveSettings(params); // saves token conditionally
+        if (params.get('saveData')) {
+            await SettingsManager.saveSettings(params); // saves token conditionally
+        }
 
         return params;
     }

package/lib/client/extend.js

@@ -71,7 +71,7 @@ module.exports = class Extend extends BaseCommand {
 
     static async run(paramValues) {
         try {
-            const params = await AuthManager.loginAndUpdateSettings(paramValues);
+            const params = await AuthManager.login(paramValues);
 
             if (process.env.DEBUG) {
                 Logger.log(`\n\nCreating extension project with parameters ${JSON.stringify({

package/lib/client/helper/cf_helper.js

@@ -33,6 +33,7 @@ select one by entering a number or leave empty to quit:
 ${formatObjectsFixedWidth(apps, ['name', 'url'], 3, { numbering: true })}
 
 Your choice: `);
+        console.log();
 
         if (!choice) {
             Logger.debug('No app URL selected');

package/lib/client/helper/url_helper.js

@@ -1,10 +1,12 @@
 const IP_ADDR = /^[1-9][0-9]{0,2}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$/;
 const schemaRegex = /^https?:\/\//;
-const defaultSchema = 'https://';
+const localhostRegex = /^(https?:\/\/)?(localhost|127\.0\.0\.1|\[?::1]?)\b/;
+const httpSchema = 'http://';
+const httpsSchema = 'https://';
 
 function extractSubdomain(url) {
     const hostname = new URL(url).hostname;
-    if (hostname === 'localhost' || IP_ADDR.test(hostname)) {
+    if (localhostRegex.test(hostname) || IP_ADDR.test(hostname)) {
         return undefined;
     }
     return hostname.split('.')[0];
@@ -12,6 +14,8 @@ function extractSubdomain(url) {
 
 module.exports = {
     schemaRegex,
-    defaultSchema,
+    localhostRegex,
+    httpSchema,
+    httpsSchema,
     extractSubdomain
 };

package/lib/client/index.js

@@ -7,7 +7,7 @@ const { SettingsManager } = require('./settings_manager');
 module.exports = {
     extend: Extend.run,
     activate: Activate.run,
-    login: AuthManager.loginAndUpdateSettings,
+    login: AuthManager.login,
     logout: AuthManager.logout,
     question: Question,
     config: SettingsManager.config

package/lib/client/params.js

@@ -163,11 +163,13 @@ class BasicParams {
 
         // - auth-related
         this.passcode               = new Param('passcode',               '', { obfuscate: ObfuscationLevel.partial });
-        this.tokenStorage           = new Param('tokenStorage', undefined, { allowedValues: ['plain', 'keyring'] });
+        this.tokenStorage           = new Param('tokenStorage',           undefined, { allowedValues: ['plain', 'keyring'] });
         this.plain                  = new Param('plain',                  false, { internal: true }); // for backward compatibility - ignored
+        this.saveData               = new Param('saveData',               false, { internal: true });
         this.renewLogin             = new Param('renewLogin',             false);
-        this.username               = new Param('username',               '');
+        this.username               = new Param('username',               '', { persist: Persistence.setting }); // only saved against localhost (non-productive); as setting due to ambiguous app URL
         this.password               = new Param('password',               '', { obfuscate: ObfuscationLevel.full });
+        this.isEmptyPassword        = new Param('isEmptyPassword',        false, { internal: true, persist: Persistence.setting }); // extra param so we can ensure we never save a password
         this.clientid               = new Param('clientid',               '');
         this.clientsecret           = new Param('clientsecret',           '', { obfuscate: ObfuscationLevel.partial });
 

package/lib/client/pull.js

@@ -0,0 +1,51 @@
+const fs = require('fs');
+const { join } = require('path');
+const axios = require('axios');
+
+const { unpackTarArchive } = require('@sap/cds/lib/utils/resources');
+
+const { login } = require('./auth_manager');
+const BaseCommand = require('./base_command');
+const Logger = require('./helper/logging');
+
+module.exports = class Pull extends BaseCommand {
+
+    static async run(paramValues) {
+        try {
+            const params = await login(paramValues);
+
+            Logger.log(`Pulling base model from ${params.get('appUrl')}, for subdomain '${params.get('subdomain')}', to project folder '${params.get('projectFolder')}'`);
+
+            const projectFolder = params.get('projectFolder');
+            const targetDir = join(projectFolder, 'node_modules', this.getAppPackageName(projectFolder));
+            fs.rmSync(targetDir, { force: true, recursive: true });
+            fs.mkdirSync(targetDir, { recursive: true });
+
+            const tgzBuffer = Buffer.from(await this.getTgz(params));
+            return unpackTarArchive(tgzBuffer, targetDir, false);
+
+        } catch (mainError) {
+            Logger.error(undefined, mainError);
+        }
+    }
+
+    static getAppPackageName(projectFolder) {
+        try {
+            return require(join(projectFolder, 'package.json')).cds.extends;
+        } catch (error) {
+            return '_base';
+        }
+    }
+
+    static async getTgz(params) {
+        const pullUrl = `${(params.get('appUrl'))}/-/cds/extensibility/pull`;
+        const options = { ...params.get('reqAuth'), responseType: 'arraybuffer' };
+
+        try {
+            const response = await axios.post(pullUrl, {}, options);
+            return response.data;
+        } catch (error) {
+            return this.handleHttpError(error, params);
+        }
+    }
+}

package/lib/client/push.js

@@ -0,0 +1,49 @@
+const fs = require('fs');
+const { join } = require('path');
+const axios = require('axios');
+
+const { login } = require('./auth_manager');
+const BaseCommand = require('./base_command');
+const Logger = require('./helper/logging');
+
+module.exports = class Push extends BaseCommand {
+
+    static async run(paramValues) {
+        try {
+            const params = await login(paramValues);
+
+            const projectFolder = params.get('projectFolder');
+            Logger.log(`Pushing extension from project folder '${projectFolder}', for subdomain '${params.get('subdomain')}', to app URL ${params.get('appUrl')}`);
+
+            const tgzPath = join(projectFolder, 'gen', 'extension.tgz');
+            const tgz = fs.readFileSync(tgzPath, { encoding: 'base64' });
+            const extensionName = this.getExtensionName(projectFolder);
+            return this.pushTgz(params, tgz, extensionName);
+
+        } catch (mainError) {
+            Logger.error(undefined, mainError);
+        }
+    }
+
+    static getExtensionName(projectFolder) {
+        try {
+            return require(join(projectFolder, 'package.json')).name;
+        } catch (error) {
+            throw new Error(`Extension project at ${projectFolder} is missing package.json`);
+        }
+    }
+
+    static async pushTgz(params, tgz, extensionName) {
+        const pushUrl = `${params.get('appUrl')}/-/cds/extensibility/push`;
+        const options = { ...params.get('reqAuth') };
+
+        try {
+            return axios.post(pushUrl, {
+                extension: tgz,
+                tag: extensionName
+            }, options);
+        } catch (error) {
+            return this.handleHttpError(error, params);
+        }
+    }
+}