@sap/cds-dk 10.0.5 → 10.0.7

package/node_modules/@sap/cds-mtxs/lib/migration/extension-project-builder.js

@@ -1,129 +0,0 @@
-const path = require('path')
-const fs = require('fs')
-const cds = require('@sap/cds')
-const DEBUG = cds.debug('mtx') //Note: cds.debug returns false for @sap/cds@(< 6.2)
-
-module.exports.build = async function (options) {
-    const { project } = options
-    const env = cds.env
-    const root = cds.root
-    try {
-        cds.root = project
-        cds.env = cds.env.for('cds', project)
-        options.dest = path.join(project, cds.env.build.target, 'ext')
-        await new ExtensionBuilder(options).run()
-    } finally {
-        cds.root = root
-        cds.env = env
-    }
-}
-
-class ExtensionBuilder {
-    constructor(options) {
-        this._files = []
-        this._options = options
-    }
-
-    async run() {
-        const { project, dest } = this._options
-
-        // clean any existing content
-        await fs.promises.rm(dest, { force: true, recursive: true })
-
-        // check existence of appPackage folder only
-        const appPackageFolder = this._getAppPackageFolder()
-        if (!fs.existsSync(path.join(project, appPackageFolder))) {
-            throw new Error(`The SaaS application base model '${appPackageFolder}' is missing.`)
-        }
-
-        // full compile of the extension using base model - ensuring consistency
-        const modelFolders = cds.resolve('*', false).filter(p => !p.startsWith('@sap/cds-mtx'))
-        DEBUG && DEBUG(`Extension model folders: ${modelFolders}`)
-
-        // throws an error if no model is found -> e.code === MODEL_NOT_FOUND
-        const model = await cds.load(modelFolders)
-
-        // extension CSN using parsed format
-        const extModel = await cds.load(this._resolveExtensionFiles(model, project), { flavor: 'parsed' })
-        if (extModel.requires) {
-            extModel.requires.length = 0
-        }
-
-        const csn = cds.compile.to.json(extModel)
-        await this._write(csn, path.join(dest, 'extension.csn'))
-        await this._collectLanguageBundles(extModel, path.join(dest, 'i18n'))
-
-        const files = Object.keys(await cds.deploy.resources(model))
-        if (files.length > 0) {
-            const dataDest = path.join(dest, 'data')
-            await Promise.all(
-                files
-                    .filter(file => /\.csv$/.test(file))
-                    .map(csv => this._copy(csv, path.join(dataDest, path.basename(csv))))
-            )
-        }
-        await this._copy(path.join(project, 'package.json'), path.join(dest, 'package.json'))
-        // add all resources contained in 'gen/ext' folder
-        await this._writeTarFile(path.join(project, cds.env.build.target, 'extension.tgz'), dest)
-
-        DEBUG && DEBUG('build output:\n' + this._files.map(file => `  ${path.relative(project, file)}`).join('\n'))
-    }
-
-    _getAppPackageFolder() {
-        return path.join('node_modules', cds.env.extends || '_base');
-    }
-
-    _resolveExtensionFiles(model, project) {
-        const node_modules = path.join(project, 'node_modules')
-        const paths = model['$sources'].reduce((acc, file) => {
-            if (file.startsWith(project) && !file.startsWith(node_modules)) {
-                acc.push(file)
-            }
-            return acc
-        }, [])
-
-        return paths
-    }
-
-    async _write(data, dest) {
-        this._files.push(dest)
-        await fs.promises.mkdir(path.dirname(dest), { recursive: true })
-        await fs.promises.writeFile(dest, typeof data === "object" && !Buffer.isBuffer(data) ? JSON.stringify(data, null, 2) : data)
-    }
-
-    async _copy(src, dest) {
-        this._files.push(dest)
-        await fs.promises.mkdir(path.dirname(dest), { recursive: true })
-        await fs.promises.copyFile(src, dest)
-    }
-
-    async _writeTarFile(tarFile, root, resources) {
-        const { tar } = cds.utils
-        await tar.czfd(tarFile, root, resources)
-        this._files.push(tarFile)
-    }
-
-    async _collectLanguageBundles(model, dest) {
-        // collect effective i18n properties...
-        let bundles = {}
-        const bundleGenerator = cds.localize.bundles4(model)
-        if (bundleGenerator && bundleGenerator[Symbol.iterator]) {
-            for (let [locale, bundle] of bundleGenerator) {
-                // fallback bundle has the name ""
-                if (typeof locale === 'string') {
-                    bundles[locale] = bundle
-                }
-            }
-        }
-        // omit bundles in case the fallback bundle is the only existing entry
-        const keys = Object.keys(bundles)
-        if (keys.length === 1 && keys[0] === "" && Object.keys(bundles[keys[0]]).length === 0) {
-            bundles = {}
-        }
-        // copied from ../compile/i18n.js
-        const { file: base = 'i18n' } = cds.env.i18n
-        if (Object.keys(bundles).length > 0) {
-            await this._write(bundles, path.join(dest, base + '.json'))
-        }
-    }
-}

package/node_modules/@sap/cds-mtxs/lib/migration/extension-project.js

@@ -1,89 +0,0 @@
-const cds = require('@sap/cds')
-const path = require('path')
-const fs = require('fs').promises
-const mtxAdapter = require('./mtx-adapter')
-const { build } = require('./extension-project-builder')
-module.exports.DEFAULT_TAG = 'migrated'
-
-module.exports.getExtensionTag = function (filename, tagRegexString, defaultTag = module.exports.DEFAULT_TAG) {
-    if (!tagRegexString) return defaultTag
-    const regex = new RegExp(tagRegexString)
-    const match = filename.match(regex)
-    return match?.[1] ? match[1] : defaultTag
-}
-
-module.exports.createProjects = async function (mtxExtension, dir, tagRegex, defaultTag = module.exports.DEFAULT_TAG) {
-
-    const validTags = []
-
-    const extensions = _splitExtensionByTag(mtxExtension, tagRegex, defaultTag)
-
-    for (const [tag, extension] of Object.entries(extensions)) {
-
-        const projectFolder = path.join(dir, tag)
-        try {
-            await fs.rm(projectFolder, { recursive: true, force: true })
-        } catch {
-            // ignore
-        }
-        await fs.mkdir(projectFolder, { recursive: true })
-        // extension is a map of files
-        await mtxAdapter.writeFilesFromMap(Array.from(extension), projectFolder)
-        // overwrite package.json
-        await _writePackageJson(projectFolder, tag, '_base')
-
-        // keep in mind to avoid parallel execution !! - use runner from old mtx?
-
-        try {
-            await build({ project: projectFolder })
-        } catch (error) {
-            if (error.code !== 'MODEL_NOT_FOUND') throw error
-            // ignore extensions with no model
-            continue
-        }
-        validTags.push(tag)
-    }
-
-    return validTags
-}
-
-function _splitExtensionByTag(mtxExtension, tagRegex, defaultTag) {
-
-    const result = {}
-
-    // create separate tags
-    for (const [file, content] of mtxExtension) {
-        if (!file.startsWith('node_modules')) {
-            const tag = module.exports.getExtensionTag(file, tagRegex, defaultTag)
-            if (!result[tag]) result[tag] = new Map()
-            result[tag].set(file, content)
-        }
-    }
-
-    // add node modules to each project to allow build
-    for (const [file, content] of mtxExtension) {
-        if (file.startsWith('node_modules')) {
-            for (const tag in result) {
-                result[tag].set(file, content)
-            }
-        }
-    }
-
-    return result
-}
-
-async function _writePackageJson(dir, name, main) {
-    const packageJson = {
-        "name": name,
-        "version": "1.0.0",
-        "description": "Generated extension project",
-        "cds": {
-            "extends": main
-        }
-    }
-
-    // add compiler settings from main
-    packageJson.cds.cdsc = cds.env.cdsc
-
-    await fs.writeFile(path.join(dir, 'package.json'), JSON.stringify(packageJson, 2))
-}

package/node_modules/@sap/cds-mtxs/lib/migration/mtx-adapter.js

@@ -1,230 +0,0 @@
-const cds = require('@sap/cds')
-
-const { fs, path } = cds.utils
-const tempDir = fs.realpathSync(require('os').tmpdir());
-const LOG = cds.log('mtx')
-
-module.exports.getDbId = async () => {
-    LOG.info('Retrieving database ID from existing containers...')
-    const hana = require('@sap/cds-mtxs/srv/plugins/hana/hdi-ctnr-mgr').defaultInstance()
-    const all = await hana.getAll()
-    const foundDbId = all.length ? all[0].credentials?.database_id : null
-    LOG.info('Found database ID:', foundDbId || 'none')
-    return foundDbId
-}
-
-module.exports.getAllTenantIds = async () => {
-
-    const hana = require('@sap/cds-mtxs/srv/plugins/hana/hdi-ctnr-mgr').defaultInstance()
-
-    // copied from mtx
-    const META_TENANT_REGEX = /TENANT-(.*)-META/i
-    const MT_LIB_TENANT_REGEX = /MT_LIB_TENANT-(.*)/i
-    const GLOBAL_DATA_META_TENANT = '__META__'
-    function _tenantFilter(tenantId, index, allTenants) {
-        const t0 = cds.env.requires.multitenancy?.t0 ?? 't0'
-        return tenantId
-            && !META_TENANT_REGEX.test(tenantId)
-            && !MT_LIB_TENANT_REGEX.test(tenantId)
-            && tenantId.toLowerCase() !== GLOBAL_DATA_META_TENANT.toLowerCase()
-            && tenantId !== t0
-            && allTenants.includes(_prefixTenant(tenantId))
-    }
-
-    // TODO remove duplicates resulting from multiple bindings
-    // replaces Tenant.getAllTenantIds()
-    return (await hana.getAll()).reduce((result, t) => [ ...result, t.labels.tenant_id[0]] , []).filter(_tenantFilter)
-}
-
-function _prefixTenant(tenantId) {
-    return `TENANT-${tenantId}-META`
-}
-
-module.exports.getMetaTenantName = (tenant) => {
-    return _prefixTenant(tenant)
-}
-
-module.exports.getMetadata = async (tenant) => {
-    return getMetadata(tenant)
-}
-
-async function getMetadata(tenant, type = 'onboarding') {
-
-    // replaces Tenant.getMetadata(tenant)
-    const CONTENT_METADATA_QUERY = 'SELECT CONTENT FROM TENANT_METADATA WHERE ID = ? AND DOMAIN = ? LIMIT 1'
-    const domain = cds.env.mtx && cds.env.mtx.domain || '__default__'
-
-    try {
-        const result = (await cds.tx({ tenant: _prefixTenant(tenant) }, tx => tx.run(CONTENT_METADATA_QUERY, [type, domain])))
-        const CONTENT = result?.[0]?.CONTENT || result?.[0]?.content // small tribute to sqlite for testing
-        if (type === 'onboarding') {
-            const metadata = CONTENT ? JSON.parse(CONTENT) : {}
-            // more robust behaviour
-            if (!metadata.subscribedTenantId) metadata.subscribedTenantId = tenant
-            return metadata
-        } else {
-            return CONTENT ? JSON.parse(CONTENT) : null
-        }
-
-    } catch (error) {
-        LOG.error('Failed to query metadata for tenant', tenant, '(domain:', domain, '):', error)
-        throw error;
-    }
-}
-
-module.exports.saveMetadata = async (tenant, type, data) => {
-    const domain = cds.env.mtx && cds.env.mtx.domain || '__default__'
-    const statement = 'UPSERT TENANT_METADATA (ID, CONTENT, DOMAIN) VALUES(?, ?, ?) WHERE ID = ? AND DOMAIN = ?';
-    await cds.tx({ tenant: _prefixTenant(tenant) }, tx => tx.run(statement, [type, JSON.stringify(data), domain, type, domain]))
-}
-
-const COMPILED_FILES = {
-    CSN_NODE: 'csn_node.json', // deprecated
-    CSN: 'csn.json',
-    ODATA_CSN: 'odata_csn.json',
-    I18N: '_i18n/i18n.json'
-}
-
-const MODEL_TYPE = {
-    base: 'base',
-    extension: 'extension',
-    compiled: 'compiled',
-    migration: 'migration'
-}
-
-module.exports.getCsn = async (tenant) => {
-
-    const CONTENT_FILE_QUERY = 'SELECT CONTENT FROM TENANT_FILES WHERE TYPE = ? AND FILENAME = ? AND DOMAIN = ? LIMIT 1';
-
-    const domain = cds.env.mtx && cds.env.mtx.domain || '__default__'
-
-    try {
-        const result = (await cds.tx({ tenant: _prefixTenant(tenant) }, tx => tx.run(CONTENT_FILE_QUERY, [MODEL_TYPE.compiled, COMPILED_FILES.CSN_NODE, domain])))
-        const { CONTENT } = result && result[0] || {}
-        return CONTENT ? JSON.parse(CONTENT) : null
-
-    } catch (error) {
-        this.logger.error(`Failed to query collectedSources for tenant '${tenant}' (domain: ${domain}): ${error}`)
-        throw error;
-    }
-
-    // const loadedModel = await Tenant.getModel(tenant, 'collectedSources');
-    // return JSON.parse(loadedModel);
-}
-
-// replaces Content.getExtension(tenant)
-module.exports.getExtension = async (tenant) => {
-
-    function _isModelFile(filename) {
-        const BASE_MODEL_EXTENSION_PROJECT_FILTER = /(.*\.cds$|.*\.csn$|.*\/csn.json$|^csn.json$|.*\/i18n(|_.*)(\.json|\.properties)$)/
-        return BASE_MODEL_EXTENSION_PROJECT_FILTER.test(filename);
-    }
-
-    function _convertToExtensionProject(files) {
-        const BASE_MODEL_NAME = '_base'
-        const basemodelFiles = new Map();
-
-        for (const [file, content] of files) {
-            if (_isModelFile(file)) {
-                const prefixedPath = path.join('node_modules', BASE_MODEL_NAME, file);
-                basemodelFiles.set(prefixedPath, content);
-            }
-        }
-
-        return basemodelFiles;
-    }
-
-    async function readFiles(modelType) {
-        const MODEL_FILE_QUERY = 'SELECT FILENAME, CONTENT, TYPE FROM TENANT_FILES WHERE TYPE = ? AND DOMAIN = ?';
-        const domain = cds.env.mtx && cds.env.mtx.domain || '__default__'
-        try {
-            const files = (await cds.tx({ tenant: _prefixTenant(tenant) }, tx => tx.run(MODEL_FILE_QUERY, [modelType, domain])));
-            return files.map(({ FILENAME, CONTENT }) => [FILENAME, CONTENT.toString('utf-8')]);
-
-        } catch (error) {
-            LOG.error('Failed to query extensions for tenant', tenant, '(domain:', domain, '):', error);
-            throw error;
-        }
-    }
-
-    const extensions = await readFiles(MODEL_TYPE.extension);
-    if (!extensions?.length) return // return nothing if no extensions exist
-
-    const base = await readFiles(MODEL_TYPE.base);
-
-    return [...extensions, ..._convertToExtensionProject(base)]
-}
-
-module.exports.hasExtensions = async (tenant) => {
-    if (!(await module.exports.wasOldMtx())) return false
-    const MODEL_FILE_QUERY = 'SELECT FILENAME FROM TENANT_FILES WHERE TYPE = ? AND DOMAIN = ?';
-    const domain = cds.env.mtx && cds.env.mtx.domain || '__default__'
-    try {
-        const files = (await cds.tx({ tenant: _prefixTenant(tenant) }, tx => tx.run(MODEL_FILE_QUERY, ['extension', domain])));
-        return files.length
-    } catch (error) {
-        LOG.debug('Upgrade check: No @sap/mtx (old mtx) extensions found for tenant', tenant, '(domain:', domain, '):', error);
-        return false;
-    }
-}
-
-const wasOldMtx = []
-
-// use this before automatic tenant list update in upgrade
-module.exports.wasOldMtx = async () => {
-    if (!wasOldMtx.length) {
-        if (cds.env.requires.db?.credentials?.sm_url) { // old mtx was service-manager based
-            const hana = require('@sap/cds-mtxs/srv/plugins/hana/hdi-ctnr-mgr').defaultInstance()
-            try {
-                wasOldMtx.push(!!(await hana.get('__META__')))
-            } catch (error) {
-                if (error.status === 404) wasOldMtx.push(false)
-                else throw error
-            }
-        } else {
-            wasOldMtx.push(false)
-        }
-    }
-    return wasOldMtx[0]
-}
-
-module.exports.isMigrated = async (tenant) => {
-    return getMetadata(tenant, 'migrated')
-}
-
-module.exports.getMigrationParameters = async (tenant) => {
-    return getMetadata(tenant, 'migrationParameters')
-}
-
-module.exports.setMigrated = async (tenant, tagRule, defaultTag, force) => {
-    const timestamp = new Date();
-    const timestampIso = timestamp.toISOString();
-    const data = {
-        timestamp: timestampIso
-    }
-    await module.exports.saveMetadata(tenant, 'migrated', data)
-    await module.exports.saveMetadata(tenant, 'migrationParameters', { tagRule, defaultTag, force })
-}
-
-function unixPath(filename) {
-    return filename.replace(/\\/g, '/');
-}
-
-module.exports.writeFilesFromMap =  async (files, baseDir) => {
-    for (const [filename, content] of files) {
-        const unixFilename = unixPath(filename);
-        const absoluteFilename = path.resolve(baseDir, unixFilename);
-
-        if (absoluteFilename.includes(baseDir)) {
-            //this.logger.debug(`Writing file: ${absoluteFilename}`);
-            await fs.promises.mkdir(path.dirname(absoluteFilename), { recursive: true });
-            await fs.promises.writeFile(absoluteFilename, content);
-        } else {
-            //this.logger.debug(`Do not write file outside of target: ${absoluteFilename}`);
-        }
-    }
-}
-
-module.exports.mkdirTemp = async () => {
-    return fs.promises.mkdtemp(`${tempDir}${path.sep}`);
-}