@sap/cds 6.8.3 → 7.0.0

package/bin/build/buildTaskProviderFactory.js

@@ -1,175 +0,0 @@
-const fs = require('fs')
-const path = require('path')
-const cds = require('./cds')
-const { OUTPUT_MODE_DEFAULT, LOG_MODULE_NAMES } = require("./constants")
-const BuildTaskProviderInternal = require('./provider/buildTaskProviderInternal')
-const BuildTaskProvider = require('./buildTaskProvider')
-
-class BuildTaskProviderFactory {
-    constructor(logger, buildOptions) {
-        this._logger = logger || cds.log(LOG_MODULE_NAMES)
-        buildOptions.for = buildOptions.for || {}
-        buildOptions.outputMode = buildOptions.outputMode || OUTPUT_MODE_DEFAULT
-        this._buildOptions = buildOptions
-    }
-    get logger() {
-        return this._logger
-    }
-    get buildOptions() {
-        return this._buildOptions
-    }
-    get providers() {
-        if (!this._providers) {
-            this._providers = this._loadProviders()
-        }
-        return this._providers
-    }
-
-    async applyTaskDefaults(tasks) {
-        return Promise.all(tasks.map(async task => {
-            if (!task.for && !task.use) {
-                throw new Error("Invalid build task definition - property 'for' and property 'use' missing")
-            }
-            const provider = this.providers.find(provider => {
-                try {
-                    return provider.canHandleTask(task)
-                } catch (e) {
-                    this.logger.error(`Build task provider ${provider.constructor.name} returned error:\n` + e)
-                    throw e
-                }
-            })
-            if (!provider) {
-                throw new Error(`No provider found for build task '${task.for || task.use}'`)
-            }
-            if (provider instanceof DefaultBuildTaskProvider) {
-                this.logger._debug && this.logger.debug(`No provider found for build task '${task.use}', using default provider`)
-            }
-            await this._applyTaskDefaults(provider, [task])
-        }))
-    }
-
-    async lookupTasks(tasks = []) {
-        await Promise.all(this.providers.map(async (provider) => {
-            const snapShot = tasks
-            await this._lookupTasks(provider, tasks)
-            // apply defaults
-            const newTasks = tasks.filter(task => !snapShot.includes(task))
-            await this._applyTaskDefaults(provider, newTasks)
-            this.logger._debug && this.logger.debug(`Build task provider ${provider.constructor.name} returned build tasks ${JSON.stringify(newTasks)}`)
-        }))
-        return tasks
-    }
-
-    /**
-     * Create a BuildTaskHandler instance for the given build task.
-     * The implementation is loaded based on the build task's 'for' or 'use' option.
-     * @param {*} task
-     * @param {*} buildOptions
-     */
-    createHandler(task) {
-        const BuildTaskHandlerClass = this.loadHandler(task)
-        const resolvedTask = this.resolveTask(task)
-        this.logger._debug && this.logger.debug(`loaded build task handler [${resolvedTask.use}]`)
-
-        const handler = new BuildTaskHandlerClass()
-        handler._task = resolvedTask
-        handler._logger = this.logger
-        handler._buildOptions = this.buildOptions
-        this.logger._debug && this.logger.debug(`created BuildTaskHandler [${resolvedTask.use}]`)
-        return handler
-    }
-
-    /**
-     * Loads the build task handler implementation for the given build task.
-     * 'for' defines an alias for built-in handlers like 'hana', 'java', 'node', 'fiori' or 'mtx'.
-     * 'use' defines the fully qualified module name of external build task handler implemenations.
-     * @param {object} task
-     */
-    loadHandler(task) {
-        let provider = this.providers.find(provider => provider.canHandleTask(task))
-        if (!provider) {
-            throw new Error(`No provider found for build task '${task.for || task.use}'`)
-        }
-        try {
-            return provider.loadHandler(task)
-        }
-        catch (e) {
-            this.logger.error(`Provider failed to load handler class - provider: ${provider.constructor.name}, task: ${task.for || task.use} :\n` + e)
-            throw e
-        }
-    }
-
-    resolveTasks(tasks) {
-        return tasks.map(task => this.resolveTask(task))
-    }
-
-    /**
-     * Resolves the given build task based on the project root folder.<br>
-     * The task is validated in order to ensure that 'src' refers to a valid folder and 'for' or 'use' reference can be required.
-     * @param {*} task
-     * @param {*} buildOptions
-     */
-    resolveTask(task) {
-        // first validate handler implementation
-        this.loadHandler(task)
-
-        // second valdiate src path
-        const resolvedTask = JSON.parse(JSON.stringify(task))
-
-        // Do not store resolved symlinks as this is causing issues on Windows, e.g. if git projects are
-        // located under 'C:\SAPDevelop\git\...' using a sym-link from '%USERHOME%\git' to 'C:\SAPDevelop\git'.
-        // see cap/issues/#8694
-        resolvedTask.src = path.resolve(this.buildOptions.root, task.src)
-        try {
-            //validate source path
-            fs.realpathSync(resolvedTask.src)
-        } catch (e) {
-            throw new Error(`Build task [${resolvedTask.for || resolvedTask.use}] could not be resolved - folder src [${path.resolve(this.buildOptions.root, task.src)}] does not exist`)
-        }
-        resolvedTask.dest = path.resolve(this.buildOptions.target, task.dest || task.src)
-        resolvedTask.options = task.options || {}
-        return resolvedTask
-    }
-
-    async _lookupTasks(provider, tasks) {
-        return provider.lookupTasks(tasks, this.buildOptions)
-    }
-
-    async _applyTaskDefaults(provider, tasks) {
-        return Promise.all(tasks.map(task => provider.applyTaskDefaults(task, this.buildOptions)))
-    }
-
-    _loadProviders() {
-        // order is important - the DefaultBuildTaskProvider has to be the last provider in the list
-        return [this._createProvider(BuildTaskProviderInternal), this._createProvider(DefaultBuildTaskProvider)]
-    }
-
-    _createProvider(clazz, plugin) {
-        const provider = new clazz()
-        provider._logger = this.logger
-        provider._plugin = plugin
-        return provider
-    }
-}
-
-/**
- * Default provider implementation handling fully qualified custom build task declarations.
- * Has to be the last entry in the providers list.
- */
-class DefaultBuildTaskProvider extends BuildTaskProvider {
-    canHandleTask(task) {
-        return !!task.use
-    }
-    loadHandler(task) {
-        if (!task.use) {
-            throw new Error(`Invalid build task definition [${task.for}] - property 'use' missing`)
-        }
-        try {
-            return require(require.resolve(task.use, { paths: [cds.root] }))
-        }
-        catch (e) {
-            throw new Error(`Build task could not be resolved - module [${task.use}] cannot be loaded:\n` + e)
-        }
-    }
-}
-module.exports = BuildTaskProviderFactory

package/bin/build/cds.js

@@ -1,5 +0,0 @@
-/**
- * This is the single depedency to @sap/cds/lib.
- * There shall be no other/direct dependencies from other modules in ./**.
- */
-module.exports = require ('../../lib')

package/bin/build/constants.js

@@ -1,66 +0,0 @@
-exports.BUILD_OPTION_OUTPUT_MODE = "outputMode"
-
-exports.OUTPUT_MODE_DEFAULT = "default"
-exports.OUTPUT_MODE_PREVIEW = "preview"
-exports.OUTPUT_MODE_RESULT_ONLY = "resultOnly"
-
-exports.BUILD_TASK_NPM_SCOPE = "@sap"
-exports.BUILD_TASK_PREFIX = exports.BUILD_TASK_NPM_SCOPE + "/cds/build"
-exports.BUILD_TASK_JAVA = "java"
-exports.BUILD_TASK_JAVA_CF = "java-cf"
-exports.BUILD_TASK_NODEJS = "nodejs"
-exports.BUILD_TASK_NODE_CF = "node-cf"
-exports.BUILD_TASK_HANA = "hana"
-exports.BUILD_TASK_FIORI = "fiori"
-exports.BUILD_TASK_MTX = "mtx"
-exports.BUILD_TASK_MTX_SIDECAR = "mtx-sidecar"
-exports.BUILD_TASK_MTX_EXTENSION = "mtx-extension"
-exports.BUILD_TASKS = [this.BUILD_TASK_JAVA, this.BUILD_TASK_JAVA_CF, this.BUILD_TASK_NODEJS, this.BUILD_TASK_NODE_CF, this.BUILD_TASK_HANA, this.BUILD_TASK_FIORI, this.BUILD_TASK_MTX, this.BUILD_TASK_MTX_SIDECAR, this.BUILD_TASK_MTX_EXTENSION]
-
-exports.ODATA_VERSION_V2 = "v2"
-exports.ODATA_VERSION_V4 = "v4"
-
-exports.BUILD_NODEJS_EDMX_GENERATION = "build.nodejs.edmxgeneration" // WebIDE Fullstack
-exports.EDMX_GENERATION = "edmxGeneration"
-
-exports.SKIP_MANIFEST_GENERATION = "skipManifestGeneration"
-exports.SKIP_PACKAGE_JSON_GENERATION = "skipPackageJsonGeneration"
-exports.SKIP_HDBTABLEDATA_GENERATION = "skipHdbtabledataGeneration"
-
-exports.CONTENT_LANGUAGE_BUNDLES = "contentLanguageBundles" // create i18n.json language bundles
-exports.CONTENT_DEFAULT_CSN = "contentDefaultCsn"           // create default CSN format flavor: "inferred"
-exports.CONTENT_EDMX = "contentEdmx"                        // create EDMX for required languages
-exports.CONTENT_MANIFEST = "contentManifest"                // create manifest.yml and .cfignore files
-exports.CONTENT_PACKAGE_JSON = "contentPackageJson"         // create package.json file if not existing, or modify existing package.json
-exports.CONTENT_PACKAGELOCK_JSON = "contentPackageLockJson" // copy package-lock.json file if existing into deployment folder
-exports.CONTENT_HDBTABLEDATA = "contentHdbtabledata"        // create .hdbtabledata files for .csv files if not existing
-exports.CONTENT_NPMRC = "contentNpmrc"                      // copy .npmrc file if existing into deployment folder
-exports.CONTENT_CDSRC_JSON = "contentCdsrcJson"             // copy .cdsrc.json file if existing into deployment folder
-exports.CONTENT_NODE_MODULES = "contentNodeModules"         // copy node_modules folder if existing into deployment folder
-exports.CONTENT_ENV = "contentEnv"                          // copy .env file if existing into deployment folder
-exports.CONTENT_DEFAULT_ENV_JSON = "contentDefaultEnvJson"  // copy default-env.json file if existing into deployment folder
-exports.CSV_FILE_DETECTION = "csvFileDetection"             // detect CSV files based on CDS model location
-exports.EXTENSION_POINT_VALIDATION = "extensionPointValidation" // validate extension point restrictions defined by the extended SaaS app
-exports.DEFAULT_BUILT_IN_MODELS = "defaultBuiltInModels"    // add @sap/cds* built-in models to build tasks
-
-exports.FOLDER_GEN = "gen"
-exports.FILE_EXT_CDS = ".cds"
-exports.MTX_SIDECAR_FOLDER = "mtx/sidecar"                  // default name of the mtx sidecar folder
-exports.DEFAULT_CSN_FILE_NAME = "csn.json"
-// REVISIT: the models are not required if a custom server.js file is used for MTX bootstrap
-exports.NODEJS_MODEL_EXCLUDE_LIST = ['@sap/cds/srv/mtx', '@sap/cds-mtxs/srv/bootstrap']
-
-exports.CDS_CONFIG_PATH_SEP = "/"
-exports.SKIP_ASSERT_COMPILER_V2 = "skip-assert-compiler-v2"
-exports.SEVERITY_ERROR = "Error"
-exports.SEVERITY_WARNING = "Warning"
-exports.SEVERITY_INFO = "Info"
-exports.SEVERITY_DEBUG = "Debug"
-exports.SEVERITIES = [exports.SEVERITY_ERROR, exports.SEVERITY_WARNING, exports.SEVERITY_INFO, exports.SEVERITY_DEBUG]
-exports.LOG_LEVEL_ERROR = "error"
-exports.LOG_LEVEL_WARN = "warn"
-exports.LOG_LEVEL_INFO = "info"
-exports.LOG_LEVEL_DEBUG = "debug"
-exports.LOG_LEVELS = [exports.LOG_LEVEL_ERROR, exports.LOG_LEVEL_WARN, exports.LOG_LEVEL_INFO, exports.LOG_LEVEL_DEBUG]
-exports.LOG_MODULE_NAMES = "cds|build"
-exports.OVERRIDE_METHOD_MSG = "Must override method"

package/bin/build/index.js

@@ -1,58 +0,0 @@
-const path = require('path')
-const fs = require('fs')
-const BuildTaskEngine = require('./buildTaskEngine')
-const BuildTaskFactory = require('./buildTaskFactory')
-const BuildTaskHandler = require('./buildTaskHandler')
-const { LOG_MODULE_NAMES } = require('./constants')
-const { BuildError } = require('./util')
-
-module.exports = Object.assign(build,
-    { build, BuildTaskFactory, BuildTaskEngine, BuildTaskHandler, BuildError }
-)
-
-/**
- * New modular build.
- *
- * @param {object} options - command options as defined by build command.
- */
-async function build(options = {}) {
-    const projectPath = path.resolve(options.project || '.')
-    if (!fs.lstatSync(projectPath).isDirectory()) {
-        return Promise.reject(`Project [${projectPath}] does not exist`)
-    }
-
-    const cds = require('./cds')
-    const cdsEnv = cds.env, cdsRoot = cds.root
-    if (projectPath !== process.cwd()) {
-        const env = cds.env.for('cds', projectPath);
-        cds.env = env // REVISIT: not good / fragile
-        cds.root = projectPath // REVISIT: not good / fragile
-    }
-    const logger = options.logger || cds.log(LOG_MODULE_NAMES)
-    const buildOptions = _mergeCliOptions({ root: cds.root }, options)
-    const buildTaskFactory = new BuildTaskFactory(logger)
-    const buildTaskEngine = new BuildTaskEngine(logger)
-    let buildResult
-
-    try {
-        const tasks = await buildTaskFactory.getTasks(buildOptions)
-        buildResult = await buildTaskEngine.processTasks(tasks, buildOptions)
-    } catch (e) {
-        // cds CLI layer logs if invoked from CLI
-        if (!buildOptions.cli) {
-            buildTaskEngine._logMessages(buildOptions, [e])
-        }
-        throw e
-    } finally {
-        cds.root = cdsRoot
-        cds.env = cdsEnv
-    }
-    return buildResult
-}
-
-function _mergeCliOptions(buildOptions, options) {
-    buildOptions["log-level"] = options["log-level"]
-    buildOptions.cli = options.cli
-    buildOptions.cmdOptions = options
-    return buildOptions
-}

package/bin/build/provider/buildTaskHandlerEdmx.js

@@ -1,82 +0,0 @@
-const path = require('path')
-const cds = require('../cds')
-const BuildTaskHandlerFeatureToggles = require('./buildTaskHandlerFeatureToggles')
-const { BUILD_OPTION_OUTPUT_MODE, OUTPUT_MODE_RESULT_ONLY } = require('../constants')
-
-class BuildTaskHandlerEdmx extends BuildTaskHandlerFeatureToggles {
-    async compileToEdmx(model, edmxDest, compileOptions = {}) { // NOSONAR
-        const promises = []
-
-        // generate edmx for services only that have the odata protocol
-        const serviceNames = cds.reflect(model).services
-            .filter(service => this._isOdataProtocol(service))
-            .map(service => service.name)
-
-        // TODO mtx build_helper tests currently expects this, strange...
-        this._result.languages.add('')
-
-        // new compile impl is throwing error in case no services exist!
-        if (serviceNames.length > 0) {
-            const options = {
-                ...this._options4edmx(),
-                ...compileOptions,
-                serviceNames
-            }
-            this.logger._debug && this.logger.debug(`compiling edmx files using OData version ${options.version}`)
-
-            const result = cds.compile.to.edmx(model, options)
-
-            if (result) {
-                let langs = this.task.options.lang || cds.env.i18n.languages
-                if (langs.split) { // string to array
-                    langs = langs.split(',')
-                }
-                if (langs.length > 0 && langs[0] !== 'all' && langs.indexOf('') < 0) {
-                    langs.push('')  // make sure fallback language is in, runtimes expect it
-                }
-                for (let [content, key] of result) {
-                    const serviceName = key.file ? key.file : key.name
-                    this._result.services.add(serviceName)
-                    const locResult = cds.localize(model, langs, content)
-                    if (locResult[Symbol.iterator]) { // multi result
-                        for (let [localizedContent, { lang }] of locResult) {
-                            promises.push(this._writeEdmxForLang(localizedContent, serviceName, lang, edmxDest))
-                        }
-                    } else { // single result
-                        promises.push(this._writeEdmxForLang(locResult, serviceName, langs[0], edmxDest))
-                    }
-                }
-            }
-        }
-        return Promise.all(promises)
-    }
-
-    _isOdataProtocol(srv) {
-        return cds.service.protocols.protocol4(srv).startsWith('odata')
-    }
-
-    _options4odata() {
-        const o = this.options()
-        o.version = cds.env.odata.version
-        return o
-    }
-
-    _options4edmx() {
-        const o = this._options4odata()
-        o.service = 'all'
-        return o
-    }
-
-    _writeEdmxForLang(content, serviceName, lang, edmxDest) {
-        this._result.languages.add(lang)
-        const fileName = serviceName + (lang ? '_' + lang + '.xml' : '.xml')
-        this._result.edmx.set(fileName, content)
-
-        //edmxDest might be null
-        if (edmxDest && !this.hasBuildOption(BUILD_OPTION_OUTPUT_MODE, OUTPUT_MODE_RESULT_ONLY)) {
-            return this.write(content).to(path.join(edmxDest, fileName))
-        }
-        return Promise.resolve()
-    }
-}
-module.exports = BuildTaskHandlerEdmx

package/bin/build/provider/buildTaskHandlerFeatureToggles.js

@@ -1,131 +0,0 @@
-const fs = require('fs')
-const path = require('path')
-const cds = require('../cds')
-const { DEFAULT_CSN_FILE_NAME } = require('../constants')
-const BuildTaskHandlerInternal = require('./buildTaskHandlerInternal')
-
-class FeatureToggleBuilder extends BuildTaskHandlerInternal {
-    init() {
-        this._result = {
-            dest: this.task.dest,
-            csn: {},
-            edmx: new Map(),
-            languages: new Set(),
-            services: new Set(),
-            languageBundles: {}
-        }
-    }
-
-    get ftsName() {
-        return path.dirname(cds.env.features.folders || 'fts/*')
-    }
-
-    async compileAll(csn, destBase, destFts) {
-        const sources = await this._resolveSourcePaths(csn)
-        const dictionary = { base: null, features: null }
-
-        if (sources.features) {
-            // create base model as the given CSN is containing all features
-            dictionary.base = await cds.load(sources.base, this.options())
-        } else {
-            // CSN already represents the base model as no features exist
-            dictionary.base = csn
-        }
-        // preserve @location as @source properties
-        const csnStr = await this.compileToJson(dictionary.base, path.join(destBase, DEFAULT_CSN_FILE_NAME))
-        const csnModel = JSON.parse(csnStr)
-        csnModel.meta = csn.meta
-        this._result.csn = csnModel
-
-        if (sources.features) {
-            dictionary.features = await this._compileFeatures(sources.features, destBase, destFts)
-        }
-        return { dictionary, sources }
-    }
-
-    async collectAllLanguageBundles(dictionary, paths, destBase, destFts) {
-        const i18nFolder = cds.env.i18n.folders?.[0] || 'i18n'
-        // create language bundle for base model
-        const i18n = await this.collectLanguageBundles(dictionary.base, path.join(destBase, i18nFolder))
-        if (i18n) {
-            this._result.languageBundles = i18n.bundles
-        }
-
-        if (dictionary.features) {
-            // create language bundles for all features
-            for (const ftName in dictionary.features) {
-                // attach the sources information for i18n location reference
-                dictionary.features[ftName]['$sources'] = paths.features[ftName]
-                await this.collectLanguageBundles(dictionary.features[ftName], path.join(destFts, this.ftsName, ftName, i18nFolder))
-            }
-        }
-    }
-
-    async _resolveSourcePaths(csn) {
-        const regex = new RegExp(path.resolve(this.buildOptions.root, this.ftsName).replace(/\\/g, '\\\\') + '[/|\\\\](?<ftName>[^/|\\\\]*)')
-        let paths = { base: [] }
-
-        // add ROOT source file paths for the base model
-        paths.base = this._resolveModel().reduce((acc, file) => {
-            const match = file.match(regex)
-            if (!match) {
-                acc.push(file)
-            }
-            return acc
-        }, [])
-
-        // keep existing behavior and return paths returned by cds.resolve if features are not supported by this project
-        if (!fs.existsSync(path.join(this.buildOptions.root, this.ftsName))) {
-            return paths
-        }
-
-        // add source file paths for the features
-        paths.features = csn['$sources'].reduce((acc, file) => {
-            const match = file.match(regex)
-            if (match) {
-                const { ftName } = match.groups
-                //feature
-                if (!acc[ftName]) {
-                    acc[ftName] = []
-                }
-                acc[ftName].push(file)
-            }
-            return acc
-        }, {})
-
-        return paths
-    }
-
-    async _compileFeatures(ftsPaths, destBase, destFts) {
-        if (!ftsPaths) {
-            return
-        }
-        const features = {}
-        const options = { ...this.options(), flavor: 'parsed' }
-
-        // create feature models
-        for (const ftName in ftsPaths) {
-            const ftCsn = await cds.load(ftsPaths[ftName], options)
-            const ftPath = path.join(destFts, this.ftsName, ftName)
-
-            // replace require paths by base model path to ensure precedence of feature annotations
-            // see https://pages.github.tools.sap/cap/docs/cds/compiler-messages#anno-duplicate-unrelated-layer
-            ftCsn.requires = [path.join(path.relative(ftPath, destBase), DEFAULT_CSN_FILE_NAME).replace(/\\/g, '/')]
-
-            await this.compileToJson(ftCsn, path.join(ftPath, DEFAULT_CSN_FILE_NAME))
-            await this._validateFeature(ftPath)
-            features[ftName] = ftCsn
-        }
-        return features
-    }
-
-    async _validateFeature(ftPath) {
-        // features must not have other than base model dependencies, cross feature dependencies are not supported
-        // do not pass options.messages in order to avoid duplicate compiler messages
-        return cds.load([ftPath])
-        // version 2.13.9 of compileSources does not read the requires definition of parsed CSNs
-        // require('@sap/cds-compiler').compileSources({ '../..csn.json': baseCsn, 'feature.csn': ftCsn }, this.options())
-    }
-}
-
-module.exports = FeatureToggleBuilder