@sap/cds-dk 7.4.1 → 7.5.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/cds-dk",
-  "version": "7.4.1",
+  "version": "7.5.1",
   "description": "Command line client and development toolkit for the SAP Cloud Application Programming Model",
   "homepage": "https://cap.cloud.sap/",
   "keywords": [

package/lib/client/base_command.js

@@ -1,54 +0,0 @@
-const path = require('path');
-const fs = require('fs').promises;
-
-require('../util/pruneAxiosErrors');
-
-const { getMessage } = require('./helper/logging');
-
-const MTX_URL_PATH_PREFIX = 'mtx/v1/model/';
-const CUSTOM_FILE_URL_SUFFIX = 'customTenantContent';
-
-module.exports = class BaseCommand {
-
-    static get CUSTOM_FILE_URL_SUFFIX() { return CUSTOM_FILE_URL_SUFFIX; }
-
-    static async checkProject(folder) {
-        const exists = await fs.access(path.join(folder, 'package.json')).then(() => true).catch(() => false)
-        return exists;
-    }
-
-    static handleHttpError(error, params, { url, command } = {}) {
-        url = url ?? params.get('appUrl');
-        const prefix = `Request to ${url} failed`;
-        switch (error.status) {
-            case 401:
-                throw getMessage(`${prefix}: invalid authentication.\nRetry with valid passcode${
-                    params.has('passcodeUrl') ? ` from ${params.get('passcodeUrl')}` : ''
-                } or username/password (required if SaaS app is configured with mocked-auth).`, { error, command });
-            case 403:
-                throw getMessage(prefix + ': insufficient authorization. Ensure client has all necessary roles.', { error, command });
-            case 404:
-                throw getMessage(prefix + ': resource not found.', { error, command });
-            case 422:
-                // Compilation or native-extension error.
-                throw getMessage(prefix + '.', { error, command });
-            default:
-                // Unexpected error should be transparent to user.
-                throw error;
-        }
-    }
-
-    static concatUrls(...parts) {
-        return parts
-            .map((p, i) => i === 0
-                ? p.replace(/\/$/ /*end slash*/, '')
-                : i === parts.length - 1
-                    ? p.replace(/^\// /*begin slash*/, '')
-                    : p.replace(/^\/|\/$/g /*both*/, ''))
-            .join('/');
-    }
-
-    static getMtxApiUrl(url, action) {
-        return BaseCommand.concatUrls(url, MTX_URL_PATH_PREFIX, action);
-    }
-}

package/lib/init/template/_merging/registry-mta.js

@@ -1,304 +0,0 @@
-// Registry of sequence matchers in mta.yaml files
-
-const srvNode4 = path => ({
-    in: 'modules',
-    where: [{
-        property: 'type',
-        isEqualTo: 'nodejs',
-    }, {
-        property: 'path',
-        isEqualTo: path
-    }],
-})
-
-const srvJava4 = path => ({
-    in: 'modules',
-    where: [{
-        property: 'type',
-        isEqualTo: 'java'
-    }, {
-        property: 'path',
-        isEqualTo: path
-    }],
-})
-
-const approuter = {
-    in: 'modules',
-    where: [{
-        property: 'type',
-        isEqualTo: 'approuter.nodejs'
-    }]
-}
-
-const xsuaa = {
-    in: 'resources',
-    where: [{
-        property: 'parameters.service',
-        isEqualTo: 'xsuaa',
-    }]
-}
-
-const destination = {
-    in: 'resources',
-    where: [{
-        property: 'type',
-        isEqualTo: 'org.cloudfoundry.managed-service',
-    }, {
-        property: 'parameters.service',
-        isEqualTo: 'destination',
-    }]
-}
-
-const connectivity = {
-    in: 'resources',
-    where: [{
-        property: 'type',
-        isEqualTo: 'org.cloudfoundry.managed-service',
-    }, {
-        property: 'parameters.service',
-        isEqualTo: 'connectivity',
-    }]
-}
-
-const redis = {
-    in: 'resources',
-    where: [{
-        property: 'type',
-        isEqualTo: 'org.cloudfoundry.managed-service',
-    }, {
-        property: 'parameters.service',
-        isEqualTo: 'redis-cache',
-    }]
-}
-
-const enterpriseMessaging = {
-    in: 'resources',
-    where: [{
-        property: 'type',
-        isEqualTo: 'org.cloudfoundry.managed-service',
-    }, {
-        property: 'parameters.service',
-        isEqualTo: 'enterprise-messaging',
-    }]
-}
-
-const kibana = {
-    in: 'resources',
-    where: [{
-        property: 'type',
-        isEqualTo: 'org.cloudfoundry.managed-service',
-    }, {
-        property: 'parameters.service',
-        isEqualTo: 'application-logs',
-    }, {
-        property: 'parameters.service-plan',
-        isEqualTo: 'lite',
-    }]
-}
-
-const hdbDeployer = {
-    in: 'modules',
-    where: [{
-        property: 'type',
-        isEqualTo: 'hdb'
-    }]
-}
-
-const hdiContainer = {
-    in: 'resources',
-    where: [{
-        property: 'type',
-        isEqualTo: 'com.sap.xs.hdi-container',
-    }]
-}
-
-const notificationTypesDeployer = {
-    in: 'modules',
-    where: [{
-        property: 'name',
-        isEqualTo: 'notification-content-deployment'
-    }, {
-        property: 'type',
-        isEqualTo: 'nodejs'
-    }]
-}
-
-const serviceManager = {
-    in: 'resources',
-    where: [{
-        property: 'type',
-        isEqualTo: 'org.cloudfoundry.managed-service',
-    }, {
-        property: 'parameters.service',
-        isEqualTo: 'service-manager',
-    }, {
-        property: 'parameters.service-plan',
-        isEqualTo: 'container'
-    }]
-}
-
-const postgres = {
-    in: 'resources',
-    where: [{
-        property: 'parameters.service',
-        isEqualTo: 'postgresql-db',
-    }]
-}
-
-const postgresDeployer = {
-    in: 'modules',
-    where: [{
-        property: 'type',
-        isEqualTo: 'nodejs',
-    }, {
-        property: 'path',
-        isEqualTo: 'gen/pg',
-    }]
-}
-
-const saasRegistry = {
-    in: 'resources',
-    where: [{
-        property: 'type',
-        isEqualTo: 'org.cloudfoundry.managed-service',
-    }, {
-        property: 'parameters.service',
-        isEqualTo: 'saas-registry',
-    }]
-}
-
-const srvApi4 = srv => ({
-    in: [srv, 'provides'],
-    where: [{
-        property: 'name',
-        isEqualTo: 'srv-api'
-    }, {
-        property: 'properties.srv-url',
-        isEqualTo: '${default-url}'
-    }]
-})
-
-const mtxSidecar4 = path => ({
-    in: 'modules',
-    where: [{
-        property: 'type',
-        isEqualTo: `nodejs`
-    }, {
-        property: 'path',
-        isEqualTo: path // 'gen/mtx/sidecar' REVISIT: Same build destination for Java/Node.js would simplify this a lot
-    }]
-})
-
-const providedMtxApiSidecar4 = mtxSidecar => ({
-    in: [mtxSidecar, 'provides'],
-    where: [{
-        property: 'name',
-        isEqualTo: 'mtx-api'
-    }, {
-        property: 'properties.mtx-url',
-        isEqualTo: '${default-url}'
-    }]
-})
-
-const requiredMtxApi = {
-    in: [approuter, 'requires'],
-    where: [{
-        property: 'properties.name',
-        isEqualTo: 'mtx-api'
-    }, {
-        property: 'properties.url',
-        isEqualTo: '~{mtx-url}'
-    }]
-}
-
-const providedAppApi = {
-    in: [approuter, 'provides'],
-    where: [{
-        property: 'name',
-        isEqualTo: 'app-api'
-    }, {
-        property: 'properties.app-protocol',
-        isEqualTo: '${protocol}'
-    }, {
-        property: 'properties.app-uri',
-        isEqualTo: '${default-uri}'
-    }],
-}
-
-const requiredAppApi4 = module => ({
-    in: [module, 'requires'],
-    where: [{
-        property: 'name',
-        isEqualTo: 'app-api'
-    }, {
-        property: 'properties.SUBSCRIPTION_URL',
-        isEqualTo: '~{app-protocol}://\\${tenant_subdomain}-~{app-uri}'
-    }]
-})
-
-const requiredMtxSidecarApi4 = srv => ({
-    in: [srv, 'requires'],
-    where: [{
-        property: 'properties.CDS_MULTITENANCY_SIDECAR_URL',
-        isEqualTo: '~{mtx-url}'
-    }]
-})
-
-const providedJavaApprouterApi4 = srv => ({
-    in: [srv, 'requires'],
-    where: [{
-        property: 'properties.CDS_MULTITENANCY_APPUI_URL',
-        isEqualTo: '~{url}'
-    }]
-})
-
-const providedJavaApprouterApi = {
-    in: [approuter, 'requires'],
-    where: [{
-        property: 'properties.url',
-        isEqualTo: '${default-url}'
-    }]
-}
-
-const approuterExtensibility = {
-    in: 'routes',
-    where: [{
-        property: 'source',
-        isEqualTo: '^/-/cds/.*'
-    }, {
-        property: 'destination',
-        isEqualTo: 'mtx-api',
-    }, {
-        property: 'authenticationType',
-        isEqualTo: 'none',
-    }]
-}
-
-module.exports = {
-    srvNode4,
-    srvJava4,
-    approuter,
-    xsuaa,
-    destination,
-    connectivity,
-    enterpriseMessaging,
-    hdbDeployer,
-    hdiContainer,
-    notificationTypesDeployer,
-    serviceManager,
-    postgres,
-    postgresDeployer,
-    saasRegistry,
-    redis,
-    srvApi4,
-    mtxSidecar4,
-    providedMtxApiSidecar4,
-    requiredMtxApi,
-    requiredMtxSidecarApi4,
-    providedAppApi,
-    requiredAppApi4,
-    providedJavaApprouterApi4,
-    providedJavaApprouterApi,
-    kibana,
-    approuterExtensibility
-}

package/lib/init/template/helm/Model.d.ts

@@ -1,53 +0,0 @@
-
-/**
- * CDS Kubernetes Configuration
- */
-interface BaseConfig {
-    /** image prefix */
-    image: string,
-    cloudService: string
-}
-
-interface RegistryConfig {
-    imageRegistry: string
-}
-
-interface DeployConfig {
-    releaseName: string,
-    namespace: string,
-    imagePullSecret: string,
-    dbSecret: string,
-    domain: string
-}
-
-interface Service {
-    binding: string;
-    name: string;
-    label: string;
-}
-
-interface ApplicationModel {
-    isJava: boolean;
-    destinations: Map<string,string>; // Unfortunately today needed at build time
-    services: Service[]; // Need to know if destination service is required?
-}
-
-interface BuildModel extends BaseConfig, ApplicationModel {
-}
-
-/**
- * Data required at image push and deploy time
- */
-interface PushModel extends BaseConfig, RegistryConfig {
-}
-
-/**
- * Data required at chart add time
- */
-interface AddChartModel extends BaseConfig, ApplicationModel {
-}
-
-interface Model extends BaseConfig, ApplicationModel {
-    registry : RegistryConfig,
-    deployment : DeployConfig
-}

package/lib/init/template/kibana/files/package.json.hbs

@@ -1,17 +0,0 @@
-{
-  {{#isNodejs}}
-  "cds": {
-  {{/isNodejs}}
-    "features": {
-      {{#profile}}
-      "[{{profile}}]": {
-      {{/profile}}
-        "kibana_formatter": true
-      {{#profile}}
-      }
-      {{/profile}}
-    }
-  {{#isNodejs}}
-  }
-  {{/isNodejs}}
-}

package/lib/init/template/kibana/index.js

@@ -1,54 +0,0 @@
-const { join } = require('path')
-const { readProject } = require('../../util/projectReader')
-const { mergeJSON, mergeYAML } = require('../../util/merge')
-const { srvNode4, srvJava4, mtxSidecar4, kibana, approuter } = require('../_merging/registry-mta')
-
-module.exports = class KibanaTemplate extends require('../templateBase') {
-
-    static hasFacet(env) {
-        return env.features.kibana_formatter
-    }
-
-    async canRun() {
-        const { hasMta, hasHelm, isJava } = await readProject()
-        if (hasHelm && !hasMta) throw `'cds add kibana' is not available for Kyma yet`
-        if (isJava) throw `'cds add kibana' is not available for Java yet`
-        return true
-    }
-
-    async run() {
-        const project = await readProject()
-        const { configFile } = project
-        await mergeJSON(configFile, join(__dirname, 'files', 'package.json.hbs'), project)
-    }
-
-    async runDependentMerging() {
-        const project = await readProject()
-        const { hasMta, hasApprouter, isJava, isMultitenant, srvPath } = project
-
-        if (hasMta) {
-            const srv = (isJava ? srvJava4 : srvNode4)(srvPath)
-            const additions = [srv, kibana]
-            const relationships = [{
-                insert: [kibana, 'name'],
-                into: [srv, 'requires', 'name']
-            }]
-            if (isMultitenant) {
-                const mtxSidecar = mtxSidecar4(isJava ? 'mtx/sidecar' : 'gen/mtx/sidecar')
-                additions.push(mtxSidecar)
-                relationships.push({
-                    insert: [kibana, 'name'],
-                    into: [mtxSidecar, 'requires', 'name']
-                })
-            }
-            if (hasApprouter) {
-                additions.push(approuter)
-                relationships.push({
-                    insert: [kibana, 'name'],
-                    into: [approuter, 'requires', 'name']
-                })
-            }
-            await mergeYAML('mta.yaml', join(__dirname, 'files', 'mta.yaml.hbs'), project, { additions, relationships })
-        }
-    }
-}

package/lib/init/template/templateBase.js

@@ -1,100 +0,0 @@
-const cds = require('../../cds')
-
-module.exports = class TemplateBase {
-
-    /**
-     * @constructor
-     */
-    constructor() {
-        this.name = this.constructor.name.replace(/template/i, '').replace(/([a-z0-9])([A-Z])/g, '$1-$2').toLowerCase()
-    }
-
-    /**
-     * Returns an array of required templates. These templates will also be added if not already included.
-     * @function getDependencies
-     * @returns {Array} Dependent facets. Default is an empty array.
-     */
-    getDependencies() {
-        return []
-    }
-
-    /**
-     * Returns an array of related facets that might change the result of applying the current facet.
-     * Important: there must not be circular relationships between facets.
-     * @function getRelatedFacets()
-     * @returns {Array} Related facets. Default is an empty array.
-     */
-    getRelatedFacets() {
-        return []
-    }
-
-    /**
-     * Checks whether the given template should handle this request
-     * @returns true, if template should handle this request, false otherwise
-     * @throws Error, if request is invalid, e.g. a file exists already
-     */
-    async canRun() {
-        return true;
-    }
-
-    // eslint-disable-next-line no-unused-vars
-    static hasFacet(env) {
-        return true;
-    }
-
-    /**
-     * calls cds env and caches result
-     * @returns {object} the current cds env
-     */
-     async getEnv(profile = 'production') {
-        const cdsEnvVar = process.env.CDS_ENV
-        process.env.CDS_ENV = profile
-        try {
-            return cds.env.for('cds');
-        } finally {
-            cdsEnvVar ? process.env.CDS_ENV = cdsEnvVar : delete process.env.CDS_ENV
-        }
-    }
-
-    /**
-     * @abstract
-     * Executes the given template's merging steps which are dependent on another template.
-     * The separation from `run()` is necessary to preserve templating associativity,
-     * i.e. the order in which you apply them does not matter.
-     * Ex.: Assume `cds add hana` is called before `cds add mta`. We want `cds add mta`
-     * to create the base mta.yaml template and merge the hana mta.yaml in, but _don't_
-     * want any other steps from the hana template performed (e.g. creating the .hdiconfig).
-     * Separating the two let's us run this _only_ the merging part of the template.
-     * In addition, this partial merging avoids cyclic template dependencies.
-     */
-    async runDependentMerging() {
-
-    }
-
-    /**
-     * @abstract
-     * Executes steps for related facets that are set up for the project.
-     */
-    async runRelatedMerging() {
-        for (const facet of this.getRelatedFacets()) {
-            const Template = require('./'+facet)
-            const template = new Template()
-            if (Template.hasFacet(await this.getEnv())) await template.runDependentMerging()
-        }
-    }
-
-    /**
-     * @abstract
-     * Executes the given template.
-     * @throws Error, if handling failed.
-     */
-    async run() {
-    }
-
-    /**
-     * @abstract
-     * Called when generation is finished
-     */
-    async finalize() {
-    }
-}

package/lib/init/util/md5.js

@@ -1,86 +0,0 @@
-const cds = require('../../cds')
-const { exists, mkdirp, isdir, readdir, read, write, copy, path } = cds.utils;
-const { dirname, join } = path
-
-const crypto = require('crypto');
-const os = require('os');
-const { copyRenderedYAML } = require('../../util/fs');
-
-async function copyAndTrack(source, dest, context = {}, { force = false, project } = {}) {
-    await mkdirp(dirname(dest));
-    if (isdir(source)) {
-        const dirents = await readdir(source);
-        return Promise.all(dirents.map(each => copyAndTrack(join(source, each), join(dest, each), context)))
-    } else {
-        const data = exists(source) ? await read(source, 'utf-8') : undefined
-        if (!force && await _isChartFileModified(dest, context)) {
-            console.log('Chart file ' + dest + ' has been modified and will not be updated.');
-        } else {
-            _track(dest, data, context);
-            if (project) return copyRenderedYAML(source, dest, project)
-            return copy(source).to(dest);
-        }
-    }
-}
-
-
-/**
-* Takes path of md5 file as an argument and returns a JSON object containing hashes of files stored in MD5 file.
-* @param {String} file
-* @returns {Promise<JSON>}
-*/
-async function parseMd5File(file) {
-    const md5 = exists(file) ? await read(file) : undefined
-    if (!md5) return {}
-    return Object.fromEntries(md5.split(os.EOL).map(line => line.split(' ').reverse()))
-}
-
-/**
-* Takes json object containing key as filename and value as MD5 hash and generates a md5sum format file.
-* @param {String} file
-* @param {Promise<JSON>} data
-*/
-async function writeMd5File(file, data) {
-    await write(Object.entries(data).map(([filename, hash]) =>
-        `${hash} ${filename}` + os.EOL
-    ).join('')).to(file)
-}
-
-
-// REVISIT: Why pass entire 'context' if we're only interested in one key in the old tracking data? -> decrease coupling
-async function _isChartFileModified(file, context = {}) {
-    const data = exists(file) ? await read(file, 'utf-8') : undefined
-    if (!data) return false;
-    const key = _pathKey(join(cds.root, 'chart'), file);
-    const hashedContent = _hash(data);
-    return context.newTrackingData[key] ? context.newTrackingData[key] !== hashedContent : context.oldTrackingData?.[key] !== hashedContent;
-}
-
-function _hash(data) {
-    return crypto.createHash('md5').update(data).digest('base64');
-}
-
-function _pathKey(basePath, cPath) {
-    return path.posix.normalize(_toPosix(path.relative(basePath, cPath)))
-}
-
-function _toPosix(path) {
-    return path.replace(/\\/g, '/');
-}
-
-// REVISIT: Replace inout parameter 'context' by return value of new tracking data
-async function _track(filePath, data, context = {}) {
-    const key = _pathKey(path.join(cds.root, 'chart'), filePath);
-    const hashedContent = _hash(data);
-    if (context.oldTrackingData != undefined && context.oldTrackingData[key] != undefined) {
-        context.oldTrackingData[key] = hashedContent;
-    }
-    context.newTrackingData[key] = hashedContent;
-}
-
-// REVISIT: Can we make copyAndTrack the only public API?
-module.exports = {
-    copyAndTrack,
-    parseMd5File,
-    writeMd5File
-}