@sap/cds 6.1.3 → 6.2.1

package/srv/model-provider.cds

@@ -1,61 +0,0 @@
-context cds.xt { // IMPORTANT: we don't use namespaces to avoid issues with cds.db default namespace
-
-  @open type CSN {};
-  type TAR : LargeBinary;
-  type XML : LargeString;
-  type Locale : String;
-  type TenantID : String;
-  type CSNConsumer : String enum { nodejs; java; };
-
-
-  /**
-   * Used by CAP runtimes to retrieve tenant-specific variants of
-   * deployed models used to serve requests.
-   */
-  @protocol: 'rest'
-  @requires: [ 'internal-user' ] //> we check that ourselves programmatically in production only
-  service ModelProviderService @(path:'/-/cds/model-provider', impl:'@sap/cds/srv/model-provider.js') {
-
-    action getCsn(
-      tenant  : TenantID,
-      toggles : array of String,
-      for     : CSNConsumer @cds.java.name: 'runtime',
-      flavor  : String enum { parsed ; xtended ; inferred },
-      base    : Boolean,
-    ) returns CSN;
-
-    action getExtCsn(
-      tenant  : TenantID,
-      toggles : array of String,
-      for     : CSNConsumer @cds.java.name: 'runtime',
-    ) returns CSN;
-
-    action getEdmx(
-      tenant  : TenantID,
-      toggles : array of String,
-      service : String,
-      locale  : Locale,
-      flavor  : String enum { v2; v4; w4; x4 },
-      for     : CSNConsumer @cds.java.name: 'runtime',
-    ) returns XML;
-
-    action isExtended(
-      tenant  : TenantID,
-    ) returns Boolean;
-
-    action getExtensions(
-      tenant  : TenantID,
-    ) returns CSN;
-
-    action getResources () returns TAR;
-    action getExtResources() returns TAR;
-
-    // -------------------------------
-    // Later, possibly:
-    // function GET csn(...)
-    // function GET edmx(...)
-    // function GET extended(...)
-    // function GET resources(...)
-  }
-
-}

package/srv/model-provider.js

@@ -1,143 +0,0 @@
-const { packTarArchive, unpackTarArchive } = require('../lib/utils/resources')
-const { collectFiles } = require('../libx/_runtime/extensibility/utils')
-const fs = require('fs').promises
-const os = require('os')
-const path = require('path')
-
-const cds = require('../lib')
-const conf = cds.requires['cds.xt.ModelProviderService'] || cds.requires.kinds['cds.xt.ModelProviderService']
-const main = conf.root ? new class { //> we're running in sidecar -> use env of main app
-  get env() { return super.env = cds.env.for ('cds', this.root) }
-  get root() { return super.root = path.resolve (cds.root, conf.root) }
-  get requires() { return super.requires = this.env.requires }
-  cache = {} //> for cds.resolve()
-} : { //> not in sidecar
-  requires: cds.requires,
-  root: cds.root,
-  env: cds.env,
-}
-const fts = main.env.features.folders
-const DEBUG = cds.debug('mtx')
-if (DEBUG) cds.once('served', ()=> DEBUG ('model provider options:', conf))
-
-
-module.exports = class ModelProviderService extends cds.ApplicationService {
-
-  /**
-   * Overload `.on` to decorate handlers to set `cds.context.tenant` based on incoming arg `tenant`.
-   */
-  on (event, handler) {
-    return super.on(event, (req) => {
-      if (req.data.tenant) cds.context = { tenant: req.data.tenant }
-      // REVISIT: might not be correct when called via ExtensibilityService.add(...)
-      //> const tenant = req.tenant || (req.user.is('internal-user') && req.data.tenant)
-      return handler(req)
-    })
-  }
-
-  init() {
-
-    // REVISIT: We should do the enforcement only in production
-    // let requires = this.definition['@requires_']
-    // if (requires && process.env.NODE_ENV === 'production') this.before ('*', req => {
-    //   if (!cds.context?.http) return //> not called from external
-    //   if (req.user._is_anonymous) return req.reject({ code:401 })
-    //   if (!requires.some(r => req.user.is(r))) return req.reject({ code:403 })
-    // })
-
-    this._in_sidecar = (conf.kind === 'in-sidecar') // REVISIT: eliminate this 'private API' if possible
-
-    this.on('getCsn', req => _getCsn(req))
-    this.on('getExtCsn', req => {
-      if (!main.requires.extensibility) return req.reject(400, 'Missing extensibility parameter')
-      return _getCsn (req, true)
-    })
-
-    this.on('getEdmx', async req => {
-      const { res } = req._; if (res) res.set('Content-Type', 'application/xml')
-      const { service, locale, flavor } = req.data
-      delete req.data.flavor // we need to delete the OData 'flavor' argument, as getCsn has a different CSN `flavor` argument
-      const csn = await _getCsn(req)
-      const edmx = cds.compile.to.edmx(csn, { service, flavor })
-      return cds.localize(csn, locale, edmx)
-    })
-
-    this.on('getResources', async req => {
-      if (req._.res) req._.res.set('content-type', 'application/octet-stream; charset=binary')
-      // REVISIT: Works only w/o encoding parameter. Default encoding is 'utf8'.
-      // try { return await cds.utils.read('resources.tgz') }
-      // root is defined in cds.requires, in case of the sidecar scenario it is set to "_main"
-      try { return await fs.readFile (path.resolve (main.root, 'resources.tgz')) }
-      catch(e) { if (e.code !== 'ENOENT') throw e }
-      const files = Object.keys(await cds.deploy.resources(['*', cds.env.features.folders]))
-      if (!files.length) return req.reject(404)
-      if (req._.res) req._.res.set('content-type', 'application/octet-stream; charset=binary')
-      return packTarArchive (files, cds.root)
-    })
-
-    this.on('getExtResources', async req => {
-      if (!main.requires.extensibility) return req.reject(400, 'Missing extensibility parameter')
-      const rs = await SELECT('sources').from('cds.xt.Extensions')
-      if (!rs.length) return req.reject(404, 'Missing extensions')
-      if (rs.every(row => row.sources === null)) return req.reject(404, 'Extension resources not found')
-      if (req._.res) req._.res.set('content-type', 'application/octet-stream; charset=binary')
-      const tmp = await fs.realpath(os.tmpdir())
-      const dir = await fs.mkdtemp(tmp + path.sep + 'tar-') // REVISIT: hase to be exactly this folder -> weird
-      try {
-        await Promise.all (rs.map (row => unpackTarArchive (Buffer.from(row.sources), dir, false))) // REVISIT: use pipe instead
-        return await packTarArchive (collectFiles (dir, ['.csv', '.properties']), dir) // REVISIT: better tar APIs -> collectFiles should not be required
-      } finally {
-        await fs.rm (dir, { recursive: true, force: true }).catch(()=>{})
-      }
-    })
-
-    this.on('isExtended', async req => {
-      if (!main.requires.extensibility) return false
-      if (!req.data.tenant && main.requires.multitenancy) return false
-      const one = await SELECT.one(1).from('cds.xt.Extensions')
-      return !!one
-    })
-
-    this.on('getExtensions', async req => {
-      if (!main.requires.extensibility) return req.reject(400, 'Missing extensibility parameter')
-      return await _getExtensions4(req.data.tenant) || req.reject(404, 'Missing extensions')
-    })
-
-    /** Implementation for getCsn */
-    async function _getCsn (req, checkExt) {
-      const { tenant, toggles, base, flavor, for:javaornode } = req.data
-      const extensions = !base && await _getExtensions4 (req.data.tenant)
-      if (!extensions && checkExt) req.reject(404, 'Missing extensions')
-
-      const features = (!toggles || !main.requires.toggles) ? [] : toggles === '*' || toggles.includes('*') ? [fts] : toggles.map (f => fts.replace('*',f))
-      const models = cds.resolve (['*',...features], main); if (!models) return
-
-      DEBUG && DEBUG ('loading models for', { tenant, toggles } ,'from', models.map (cds.utils.local))
-      let csn = await cds.load (models, { flavor, silent:true })
-      if (csn.meta?.flavor === 'inferred') csn = cds.minify (csn)
-      if (extensions) csn = cds.extend (csn) .with (extensions)
-      if (javaornode) csn = cds.compile.for[javaornode] (csn)
-
-      // Dirty hack for cds.localize in Node sidecar setup
-      Object.defineProperty (csn,'$sources',{ value:csn.$sources, enumerable:true })
-      return csn
-    }
-
-    /** Implementation for getExtensions */
-    async function _getExtensions4 (tenant) {
-      if (!main.requires.extensibility || !tenant && main.requires.multitenancy) return
-      const exts = await SELECT('csn').from('cds.xt.Extensions'); if (!exts.length) return
-      const merged = { extensions: [], definitions: {} }
-      for (let each of exts) {
-        let {definitions,extensions} = JSON.parse(each.csn)
-        if (definitions) Object.assign (merged.definitions, definitions)
-        if (extensions) merged.extensions.push (...extensions)
-      }
-      return merged
-    }
-
-  }
-
-  get isExtensible () { return false } // REVISIT: Do we want to keep this?
-}
-module.exports.prototype._add_stub_methods = true