@sap/cds 6.8.4 → 7.0.1

package/bin/build/provider/mtx-extension/index.js

@@ -1,131 +0,0 @@
-const path = require('path')
-const fs = require('fs')
-const cds = require('../../cds')
-
-const BuildTaskHandlerInternal = require('../buildTaskHandlerInternal')
-const { FOLDER_GEN, EXTENSION_POINT_VALIDATION } = require('../../constants')
-const ResourcesTarBuilder = require('../mtx/resourcesTarBuilder')
-const { BuildError, BuildMessage } = require('../../util')
-
-class MtxExtensionModuleBuilder extends BuildTaskHandlerInternal {
-    init() {
-        super.init()
-        if (this.buildOptions.root === this.buildOptions.target) {
-            this.task.dest = path.join(this.task.dest, FOLDER_GEN)
-        }
-    }
-
-    async build() {
-        const { src, dest } = this.task
-        const destExt = path.join(dest, 'ext')
-        // check existence of appPackage folder only
-        // REVISIT: cds.resolve will fail as no index.csn file exists in this folder for the extension migration use case
-        // a compilation error is thrown anyhow if any base model refs cannot be resolved
-        const appPackageFolder = this._getAppPackageFolder()
-        if (!fs.existsSync(path.join(src, appPackageFolder))) {
-            throw new BuildError(`The SaaS application base model '${appPackageFolder}' is missing. Have you run the 'cds pull' command?`)
-        }
-
-        // full compile of the extension using base model - ensuring consistency
-        const model = await this.model()
-
-        if (model) {
-            // extension CSN using parsed format
-            const options = { ...this.options(), flavor: 'parsed' }
-            const extModel = await cds.load(this._resolveExtensionFiles(model), options)
-            if (extModel.requires) {
-                extModel.requires.length = 0
-            }
-
-            if (!this.hasBuildOption(EXTENSION_POINT_VALIDATION, false)) {
-                this._lintExtModel(extModel, model) // throws error in case of linting errors
-            }
-
-            await this.compileToJson(extModel, path.join(destExt, 'extension.csn'))
-
-            await this.collectLanguageBundles(extModel, path.join(destExt, 'i18n'))
-
-            const files = Object.keys(await cds.deploy.resources(model))
-            if (files.length > 0) {
-                const dataDest = path.join(destExt, 'data')
-                await Promise.all(
-                    files
-                        .filter(file => /\.csv$/.test(file))
-                        .map(csv => {
-                            return this.copy(csv).to(path.join(dataDest, path.basename(csv)))
-                        })
-                )
-            }
-        }
-
-        const packageJson = path.join(src, 'package.json')
-        if (!fs.existsSync(packageJson)) {
-            throw new BuildError(`package.json file not found in ${src}`)
-        }
-        await this.copy(packageJson).to(path.join(destExt, 'package.json'))
-
-        // copy handlers
-        const folders = [path.join(src, cds.env.folders.srv, 'handlers')]
-        await this.copyNativeContent(src, destExt, res => {
-            if (fs.statSync(res).isDirectory()) {
-                return folders.some(folder => folder.startsWith(res))
-            }
-            if (folders.includes(path.dirname(res)) && /\.js$/.test(res)) {
-                return true
-            }
-        })
-
-        // add all resources contained in 'gen/ext' folder
-        await new ResourcesTarBuilder(this).writeTarFile(path.join(this.task.dest, 'extension.tgz'), destExt)
-    }
-
-    _resolveExtensionFiles(model) {
-        const node_modules = path.join(this.task.src, 'node_modules')
-        const paths = model['$sources'].reduce((acc, file) => {
-            if (file.startsWith(this.task.src) && !file.startsWith(node_modules)) {
-                acc.push(file)
-            }
-            return acc
-        }, [])
-
-        return paths
-    }
-
-    _lintExtModel(extModel, model) {
-        const linter = this._linter()
-        if (!linter) {
-            return
-        }
-        const env = cds.env.for('cds', path.join(this.task.src, this._getAppPackageFolder()))
-        this.logger._debug && this.logger.debug(`Saas extension point restrictions:\n${env.requires?.['cds.xt.ExtensibilityService']}`)
-
-        const messages = linter.lint(extModel, model, env)
-        if (messages.length) {
-            // REVISIT: lint messages can be passed as is with cds-mtxs version >= 1.7
-            throw new BuildError('SaaS extension point restrictions violated. Check the concrete restrictions defined by the SaaS app provider.',
-                messages.map(f => new BuildMessage(f.message, f.severity, f.location || f.element?.$location)))
-        }
-    }
-
-    _linter() {
-        let linter
-        try {
-            // Make sure cds-mtxs APIs are loaded
-            linter = require('@sap/cds-mtxs').xt?.linter // eslint-disable-line cds/no-missing-dependencies
-            if (!linter) {
-                this.pushMessage('MTXS linter cannot be loaded. Update of @sap/cds-dk and @sap/cds-mtxs modules required? Skipping extension model lint step.')
-                return null // too old mtxs
-            }
-        } catch (e) {
-            if (e.code !== 'MODULE_NOT_FOUND') throw e
-            this.pushMessage('MTXS linter cannot be loaded, @sap/cds-mtxs not installed. Skipping extension model lint step.')
-        }
-        return linter
-    }
-
-    _getAppPackageFolder() {
-        return path.join('node_modules', cds.env.extends || '_base');
-    }
-}
-
-module.exports = MtxExtensionModuleBuilder

package/bin/build/provider/mtx-sidecar/index.js

@@ -1,137 +0,0 @@
-const path = require('path')
-const cds = require('../../cds')
-const fs = require('fs')
-const { FOLDER_GEN, DEFAULT_CSN_FILE_NAME } = require('../../constants')
-const NodeCfModuleBuilder = require('../nodejs')
-const ResourcesTarProvider = require('../mtx/resourcesTarBuilder')
-const { INFO, ERROR } = NodeCfModuleBuilder
-const { relativePaths, BuildError, resolveRequiredSapModels } = require('../../util')
-
-const DEFAULT_MAIN_FOLDER = "_main"
-
-class MtxSidecarModuleBuilder extends NodeCfModuleBuilder {
-    get priority() {
-        // should be scheduled after 'hana' build tasks are finished
-        return NodeCfModuleBuilder.PRIORITY_MIN_VALUE
-    }
-    init() {
-        super.init()
-        if (this.buildOptions.root === this.buildOptions.target) {
-            this.task.dest = path.join(this.task.dest, FOLDER_GEN)
-        }
-    }
-
-    /**
-     * Builds the mtx sidecar app consisting of:
-     * - nodejs app model defined by the required sidecar services
-     * - main app model defined by the build task's model options including feature models and resources TAR
-     *
-     * build.target=".": 'dest' -> 'model-provider/gen'
-     * build.target="gen": 'dest' -> 'gen/model-provider'
-     */
-    async build() {
-        // nodejs app parts have to be built using sidecar env
-        const sidecarEnv = cds.env.for("cds", this.task.src)
-        // build main application
-        await this._buildMainApp(sidecarEnv)
-        // build node application
-        await this._buildNodeApp(sidecarEnv)
-    }
-
-    /**
-     * Builds the mtx sidecar nodejs app parts.
-     * @param {object} sidecarEnv cds env based on the sidecar dir
-     */
-    async _buildNodeApp(sidecarEnv) {
-        const destSidecar = this.task.dest
-        const destSidecarSrc = path.join(destSidecar, cds.env.folders.srv)
-        const i18nFolder = cds.env.i18n.folders?.[0] || 'i18n'
-        const model = this._compileSidecarSync(sidecarEnv)
-        await this.compileToJson(model, path.join(destSidecarSrc, DEFAULT_CSN_FILE_NAME))
-
-        await this.collectLanguageBundles(model, path.join(destSidecarSrc, i18nFolder))
-        await this.copyProjectRootContent(this.task.src, destSidecar)
-    }
-
-    /**
-     * Builds the main app parts containing base model CSN with feature CSNs and resources TAR.
-     * @param {object} sidecarEnv cds env based on the sidecar dir
-     */
-    async _buildMainApp(sidecarEnv) {
-        let main = sidecarEnv.requires['cds.xt.ModelProviderService']?.root
-        if (!main) {
-            throw new BuildError(`Invalid MTX sidecar configuration. Make sure that the profile 'mtx-sidecar' is configured and an up-to-date version of @sap/cds-mtxs is installed.`)
-        }
-        const profiles = cds.env.profiles || []
-
-        if (!profiles.includes("production") && !profiles.includes("prod")) {
-            main = DEFAULT_MAIN_FOLDER
-            // root should represent the production use case and not development
-            this.pushMessage(`MTX sidecar build results are created in folder '${main}'. Enable 'production' or 'prod' profile if the folder is configured differently.`, INFO)
-        }
-        const destRoot = this.task.dest
-        const destMain = path.join(destRoot, main)
-        const destMainSrv = path.join(destMain, cds.env.folders.srv)
-        const csn = await this.model()
-        if (!csn) {
-            return
-        }
-        const { dictionary, sources } = await this.compileAll(csn, destMainSrv, destMain)
-        await this.collectAllLanguageBundles(dictionary, sources, destMainSrv, destMain)
-
-        // create resources TAR
-        // resources are determined based on available database build task, SQLite as fallback
-        await new ResourcesTarProvider(this).createTar(destMain, csn)
-
-        // copy package.json and .cdsrc.json from project root
-        await this._copyMainConfigFiles(cds.root, destMain)
-    }
-
-    /**
-     * Synchronous compilation using the sidecar context.
-     * @param {object} sidecarEnv cds env based on the sidecar dir
-     * @returns the compiled mtx sidecar CSN
-     */
-    _compileSidecarSync(sidecarEnv) {
-        const env = cds.env
-        try {
-            cds.root = this.task.src
-            cds.env = sidecarEnv
-            const modelPaths = cds.resolve('*', false)
-            const modelFilePaths = cds.resolve(modelPaths)
-
-            if (!modelFilePaths || modelFilePaths.length === 0) {
-                throw new BuildError("No CDS models found in MTX sidecar. Make sure up-to-date versions of the required npm modules are installed.")
-            }
-            this._logger._debug && this._logger.debug(`sidecar model: ${relativePaths(this.buildOptions.root, modelFilePaths).join(", ")}`)
-
-            // check whether all models belonging to the @sap namespace can be resolved
-            const unresolved = resolveRequiredSapModels(modelPaths)
-            if (unresolved.length > 0) {
-                // log error, but don't fail
-                throw new BuildError(`CDS models [${unresolved.join(', ')}] required by MTX sidecar cannot be resolved. Make sure up-to-date versions of the corresponding npm modules are installed.`, ERROR)
-            }
-
-            // synchronous compilation
-            return cds.load(modelFilePaths, { sync: true, ...this.options() })
-        } finally {
-            // restore project scope
-            cds.root = this.buildOptions.root
-            cds.env = env
-        }
-    }
-
-    async _copyMainConfigFiles(src, dest) {
-        const packageJson = path.join(src, 'package.json')
-        const cdsrcJson = path.join(src, '.cdsrc.json')
-        const promises = []
-        if (fs.existsSync(packageJson)) {
-            promises.push(this.copy(packageJson).to(path.join(dest, 'package.json')))
-        }
-        if (fs.existsSync(cdsrcJson)) {
-            promises.push(this.copy(cdsrcJson).to(path.join(dest, '.cdsrc.json')))
-        }
-        return promises
-    }
-}
-module.exports = MtxSidecarModuleBuilder

package/bin/build/provider/node-cf/index.js

@@ -1 +0,0 @@
-module.exports = require('../nodejs')

package/bin/build/provider/nodejs/index.js

@@ -1,192 +0,0 @@
-const fs = require('fs')
-const path = require('path')
-const cds = require('../../cds')
-const BuildTaskHandlerEdmx = require('../buildTaskHandlerEdmx')
-const { BuildError } = require('../../util')
-const { BUILD_OPTION_OUTPUT_MODE, OUTPUT_MODE_RESULT_ONLY, ODATA_VERSION_V2, FOLDER_GEN, BUILD_NODEJS_EDMX_GENERATION, EDMX_GENERATION,
-    SKIP_PACKAGE_JSON_GENERATION, CONTENT_EDMX, CONTENT_PACKAGE_JSON, CONTENT_PACKAGELOCK_JSON, CONTENT_NPMRC, CONTENT_CDSRC_JSON,
-    CONTENT_ENV, CONTENT_DEFAULT_ENV_JSON } = require('../../constants')
-const { WARNING } = BuildTaskHandlerEdmx
-
-class NodejsModuleBuilder extends BuildTaskHandlerEdmx {
-    init() {
-        super.init()
-        // set unified option values in order to ease access later on
-        // default value true
-        this.task.options[CONTENT_PACKAGE_JSON] = !this.hasBuildOption(CONTENT_PACKAGE_JSON, false) && !this.hasBuildOption(SKIP_PACKAGE_JSON_GENERATION, true) ? true : false
-        this.task.options[CONTENT_PACKAGELOCK_JSON] = !this.hasBuildOption(CONTENT_PACKAGELOCK_JSON, false) ? true : false
-        this.task.options[CONTENT_NPMRC] = !this.hasBuildOption(CONTENT_NPMRC, false) ? true : false
-        this.task.options[CONTENT_CDSRC_JSON] = !this.hasBuildOption(CONTENT_CDSRC_JSON, false) ? true : false
-
-        // default value false
-        this.task.options[CONTENT_EDMX] = this.hasBuildOption(CONTENT_EDMX, true) || this.hasCdsEnvOption(BUILD_NODEJS_EDMX_GENERATION, true) || this.hasBuildOption(EDMX_GENERATION, true) ? true : false
-        this.task.options[CONTENT_ENV] = this.hasBuildOption(CONTENT_ENV, true) ? true : false
-        this.task.options[CONTENT_DEFAULT_ENV_JSON] = this.hasBuildOption(CONTENT_DEFAULT_ENV_JSON, true) ? true : false
-
-        if (this.task.options.compileDest) {
-            throw new BuildError("Option not supported - compileDest")
-        }
-        // fallback if src has been defined as '.'
-        this.destSrv = this.isStagingBuild() ? path.resolve(this.task.dest, cds.env.folders.srv) : path.join(this.task.dest, FOLDER_GEN)
-    }
-
-    options() {
-        const options = super.options()
-        if (cds.env.requires.extensibility || cds.env.requires.toggles) {
-            options.flavor = 'xtended'
-        }
-        return options
-    }
-
-    async build() {
-        const destSrv = this.isStagingBuild() ? this.destSrv : path.resolve(this.destSrv, cds.env.folders.srv)
-        const destRoot = this.isStagingBuild() ? this.task.dest : this.destSrv
-
-        if (cds.env.odata?.version === ODATA_VERSION_V2) {
-            // log warning as nodejs is only supporting odata version V4
-            this.pushMessage("OData v2 is not supported by node runtime. Make sure to define OData v2 in cds configuration.", WARNING)
-        }
-        // by default model contains all features
-        const model = await this.model()
-        if (!model) {
-            return this._result
-        }
-
-        const { dictionary, sources } = await this.compileAll(model, destSrv, destRoot)
-
-        // collect and write language bundles into single i18n.json file
-        await this.collectAllLanguageBundles(dictionary, sources, destSrv, destRoot)
-
-        if (this.hasBuildOption(CONTENT_EDMX, true)) {
-            const m = await cds.load(sources.base, super.options()) // REVISIT: Quick hack to get inferred model as expected by cds.compile.to.edmx()
-            await this.compileToEdmx(m, this.destSrv)
-        }
-
-        if (this.isStagingBuild() && !this.hasBuildOption(BUILD_OPTION_OUTPUT_MODE, OUTPUT_MODE_RESULT_ONLY)) {
-            const srcSrv = this.task.src === this.buildOptions.root ? path.resolve(this.task.src, cds.env.folders.srv) : this.task.src
-            await this._copyNativeContent(this.buildOptions.root, srcSrv, destRoot, destSrv)
-            await this._fixCapireSamplesDeps(destRoot)
-        }
-        return this._result
-    }
-
-    // REVISIT: fix for capire samples - needs to be reworked
-    // Instead of adding relative paths we may better delete the entire entry as relative paths
-    // cannot be resolved in cloud deployments anyway.
-    // Support for HANA native artifacts defined in sub-modules required
-    async _fixCapireSamplesDeps(dest) {
-        const packageJson = path.join(dest, 'package.json')
-        try {
-            const content = require(packageJson)
-            const { dependencies } = content
-            let changed
-            for (let dependency in dependencies) {
-                if (dependency.startsWith('@capire/')) {
-                    dependencies[dependency] = path.relative(dest, path.dirname(require.resolve(dependency + '/package.json')))
-                    changed = true
-                }
-            }
-            if (changed) {
-                return this.write(JSON.stringify(content, null, '  ')).to(packageJson)
-            }
-        } catch (e) {/*ignore*/ }
-    }
-
-    async clean() {
-        // staging build content is deleted by BuildTaskEngine
-        if (this.buildOptions.target === this.buildOptions.root) {
-            // delete the entire 'task.dest' folder otherwise, for details see #constructor
-            // - the value of the folder 'src' has been appended to the origin 'task.dest' dir
-            this.logger._debug && this.logger.debug(`Deleting build target folder ${this.destSrv}`)
-            await fs.promises.rm(this.isStagingBuild() ? this.task.dest : this.destSrv, { force: true, recursive: true })
-        }
-    }
-
-    async _copyNativeContent(srcRoot, srcSrv, destRoot, destSrv) {
-        // project/srv/** -> 'gen/srv/srv/**'
-        const filesFilter = await this._copySrvContent(srcSrv, destRoot, destSrv)
-
-        // project/* -> 'gen/srv/*'
-        await this.copyProjectRootContent(srcRoot, destRoot, (entry) => !filesFilter.includes(path.basename(entry)))
-    }
-
-    /**
-     * Copy files for nodejs staging builds from the given <em>src</em>' folder (e.g. 'project/srv') to either <em>destRoot</em> (e.g. 'project/gen/srv')
-     * or <em>destSrv</em> (e.g. 'project/gen/srv/srv') folders according to the file semantics.
-     * Files with project semantics like 'package.json' or '.npmrc' file are copied to <em>destRoot</em> while others like '.js' service handlers
-     * are copied to <em>destSrv</em>.
-     * @param {*} src
-     * @param {*} destRoot - folder name representing the app root folder (e.g. gen/srv)
-     * @param {*} destSrv - folder name representing the app sub-folder (e.g. gen/srv/srv)
-     * @returns the list of files that have been copied
-     */
-    async _copySrvContent(src, destRoot, destSrv) {
-        const srvRootBlockList = RegExp('package\\.json$|package-lock\\.json$|\\.npmrc$|\\.cdsrc\\.json$')
-        const srvBlockList = RegExp('\\.cds$|csn\\.json$|\\.csn$|manifest\\.y.?ml$|\\.env($|\\..*$)|default-env\\.json$')
-        const srvRootFileNames = []
-
-        // 1. copy all files to 'destSrv' except those contained in the blocklist (including node_modules)
-        // project/srv -> 'gen/srv/srv'
-        await super.copyNativeContent(src, destSrv, (entry) => {
-            if (fs.statSync(entry).isDirectory()) {
-                // TODO shall not copy language bundles - return !/(\/|\\)(node_modules|_i18n)(\/|\\)?$/.test(entry)
-                return !/(\/|\\)node_modules(\/|\\)?$/.test(entry)
-            }
-            // make sure the file exists on srv root level - see https://github.tools.sap/cap/issues/issues/12077
-            if (srvRootBlockList.test(entry) && path.dirname(entry) === src) {
-                srvRootFileNames.push(path.basename(entry))
-                return false
-            }
-            return !srvBlockList.test(entry)
-        })
-
-        // 2. copy dedicated files like package.json, .npmrc to 'destRoot'
-        // project/srv -> 'gen/srv'
-        let srvAllowList = "package\\.json$" // always copy package.json, modify only if CONTENT_PACKAGE_JSON is true
-        srvAllowList += this.hasBuildOption(CONTENT_PACKAGELOCK_JSON, true) ? "|package-lock\\.json$" : ""
-        srvAllowList += this.hasBuildOption(CONTENT_NPMRC, true) ? "|\\.npmrc$" : ""
-        srvAllowList += this.hasBuildOption(CONTENT_CDSRC_JSON, true) ? "|\\.cdsrc\\.json$" : ""
-        srvAllowList += this.hasBuildOption(CONTENT_ENV, true) ? "|\\.env($|\\..*$)" : ""
-        srvAllowList += this.hasBuildOption(CONTENT_DEFAULT_ENV_JSON, true) ? "|default-env\\.json$" : ""
-        srvAllowList = new RegExp(srvAllowList)
-        await Promise.all(srvRootFileNames.map(fileName => {
-            if (srvAllowList.test(fileName)) {
-                return this.copy(path.join(src, fileName)).to(path.join(destRoot, fileName))
-            }
-        }))
-
-        return srvRootFileNames
-    }
-
-    /**
-     * Copy dedicated files (files with project semantics like package.json, .npmrc, .cdsrc, etc.)
-     * from the given <em>src</em> folder (e.g. 'project') into the given <em>dest</em> folder (e.g. 'project/gen/srv')
-     * @param {*} src
-     * @param {*} dest
-     * @param {*} filter - copy file if filter function returns true
-     */
-    async copyProjectRootContent(src, dest, filter) {
-        let { folders = ['i18n'] } = cds.env.i18n
-        folders.push('handlers')
-        folders = folders.map(folder => path.join(src, folder))
-        let srvAllowList = "package\\.json$" // always copy package.json, modify only if CONTENT_PACKAGE_JSON is true
-        srvAllowList += this.hasBuildOption(CONTENT_PACKAGELOCK_JSON, true) ? "|package-lock\\.json$" : ""
-        srvAllowList += this.hasBuildOption(CONTENT_NPMRC, true) ? "|\\.npmrc$" : ""
-        srvAllowList += this.hasBuildOption(CONTENT_CDSRC_JSON, true) ? "|\\.cdsrc\\.json$" : ""
-        srvAllowList += this.hasBuildOption(CONTENT_ENV, true) ? "|\\.env($|\\..*$)" : ""
-        srvAllowList += this.hasBuildOption(CONTENT_DEFAULT_ENV_JSON, true) ? "|default-env\\.json$" : ""
-        srvAllowList = new RegExp(srvAllowList)
-
-        await super.copyNativeContent(src, dest, (entry) => {
-            if (fs.statSync(entry).isDirectory()) {
-                return folders.some(folder => entry.startsWith(folder))
-            }
-            if (/\.js$|\.properties$/.test(entry)) {
-                return true
-            }
-            return srvAllowList.test(entry) && (!filter || filter.call(this, entry))
-        })
-    }
-}
-
-module.exports = NodejsModuleBuilder