@sap/cds-dk 7.4.0 → 7.5.0

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
-}

package/lib/init/util/projectReader.js

@@ -1,94 +0,0 @@
-const cds = require('../../cds')
-const { join, resolve, basename } = require('path')
-const { fs, exists } = cds.utils
-const { parseXml } = require('./xml')
-const { REGEX_JAVA_VERSION } = require('../constants')
-const DEBUG = cds.debug('cli')
-
-module.exports = new class ProjectReader {
-
-    constructor() {
-        this.readProject = this.readProject.bind(this)
-
-        // 1. Use project name and static default values
-        this.appVersion = cds.cli.options.add?.has('java') ? '1.0.0-SNAPSHOT' : '1.0.0'
-        this.appName = this.appId = basename(cds.root)
-        this.appDescription = 'A simple CAP project.'
-
-        // 2. Use either pom.xml or package.json
-        if (exists('pom.xml')) {
-            const { artifactId = [], description = [], version = [], properties = [] } = parseXml(resolve(cds.root, 'pom.xml')) ?? {}
-            const v = version[0] === '${revision}' ? properties[0]?.revision[0] : version[0]
-            if (v && REGEX_JAVA_VERSION.test(v)) this.appVersion = v
-            if (artifactId[0])  this.appName = this.appId = artifactId[0].split(/-parent/)[0]
-            if (description[0]) this.appDescription = description[0]
-        }
-        else if (exists('package.json')) {
-            const { name, version, description } = JSON.parse(fs.readFileSync(join(cds.root, 'package.json')))
-            this.appVersion = version
-            const segments = name.trim().replace(/@/g, '').split('/').map(encodeURIComponent)
-            this.appName = segments[segments.length - 1]
-            this.appId = segments.join('.')
-            this.appDescription = description ?? this.appDescription
-        }
-    }
-
-    // REVISIT: There should be a better (and parallelizable) API provided by cds.env
-    /**
-     * Returns cds.env using 'production' profile by default as mta deployment is executed with having production profile set.
-     */
-    getEnv(profile = 'production') {
-        const cdsEnvVar = process.env.CDS_ENV
-        process.env.CDS_ENV = profile
-        try {
-            // REVISIT: this is invoked 5 times for cds add multitenancy
-            return cds.env.for('cds')
-        } finally {
-            cdsEnvVar ? process.env.CDS_ENV = cdsEnvVar : delete process.env.CDS_ENV
-        }
-    }
-
-    async readProject() {
-        const env = this.getEnv()
-        const { appVersion, appName, appId, appDescription } = this
-        DEBUG?.({ env })
-
-        const _hasFacet = template => require(`../template/${template}`).hasFacet(env)
-        const project = {
-            get profile()  { return cds.cli.options?.for },
-            get language() { return exists('pom.xml') ? 'java' : 'nodejs' },
-            get srvPath()  { return join(env.build.target, env.folders.srv.replace(/\/$/, '')).replace(/\\/g, '/') },
-            get archiveName() {
-                const pom = parseXml(resolve(cds.root, env.folders.srv, 'pom.xml'))
-                return (pom?.artifactId?.[0] ?? basename(cds.root)) + '-exec.' + pom?.packaging?.[0]
-            },
-            get db() {
-                const folder = env.folders.db
-                const name = folder.replace(/\/$/, '')
-                const path = join(env.build.target, name).replace(/\\/g, '/')
-                return { folder, name, path }
-            },
-            get configFile()     { return exists('pom.xml') ? '.cdsrc.json' : 'package.json' },
-            get isNodejs()       { return _hasFacet('nodejs') },
-            get isJava()         { return _hasFacet('java') },
-            get isMultitenant()  { return _hasFacet('multitenancy') },
-            get isExtensible()   { return _hasFacet('extensibility') },
-            get hasHana()        { return _hasFacet('hana') },
-            get hasXsuaa()       { return _hasFacet('xsuaa') },
-            get hasApprouter()   { return _hasFacet('approuter') },
-            get hasDestination() { return _hasFacet('destination') },
-            get hasHtml5Repo()   { return _hasFacet('html5-repo') },
-            get hasMta()         { return _hasFacet('mta') },
-            get hasHelm()        { return _hasFacet('helm') },
-            get appPath()        { return env.folders.app ?? 'app' },
-            get appVersion()     { return appVersion },
-            get appName()        { return appName },
-            get cleanedAppName() { return appName.replace('_', '-') }, // Required when _ isn't allowed in the namespace
-            get appId()          { return appId },
-            get appDescription() { return appDescription },
-        }
-
-        DEBUG?.({ project })
-        return project
-    }
-}