fix(cds-build): retain more build relevant options in the deployer app (#1206)

with an allow list approach for build relevant `cds` options, we are
more flexible. Moreover, almost all `cdsc` options are build relevant,
so we now copy over the whole section, minus some selected options which
are set implicitly.

--> Would be nice if every option would be controlled through
`cds.features`, but e.g. `defaultStringLength`/`defaultBinaryLength` are
only available through `cdsc`. Those `cdsc` options are also documented
in [capire](https://cap.cloud.sap/docs/cds/cdl#built-in-types)

fixes #1167

---

follow up #1032

Author: patricebender

postgres/cds-plugin.js

@@ -5,19 +5,22 @@ if (!cds.env.fiori.lean_draft) {
   throw new Error('"@cap-js/postgres" only works if cds.fiori.lean_draft is enabled. Please adapt your configuration.')
 }
 
+// copy over build relevant cds options to the package.json of the deployer app
+const CDS_BUILD_OPTIONS = ['assert_integrity']
+
+// cdsc options are build relevant too, but we need to filter out some
+const CDSC_DISALLOW   = ['moduleLookupDirectories']
+
 // requires @sap/cds-dk version >= 7.5.0
 cds.build?.register?.('postgres', class PostgresBuildPlugin extends cds.build.Plugin {
-  
   static taskDefaults = { src: cds.env.folders.db }
-  
-  static hasTask() { return cds.requires.db?.kind === 'postgres' }
-
-  init() {
+  static hasTask () { return cds.requires.db?.kind === 'postgres' }
+  init () {
     // different from the default build output structure
     this.task.dest = path.join(cds.root, cds.env.build.target !== '.' ? cds.env.build.target : 'gen', 'pg')
   }
 
-  async build() {
+  async build () {
     const model = await this.model()
     if (!model) return
 
@@ -27,23 +30,36 @@ cds.build?.register?.('postgres', class PostgresBuildPlugin extends cds.build.Pl
     } else {
       const packageJson = {
         dependencies: {
-          '@sap/cds': '^8',
-          '@cap-js/postgres': '^1'
+          '@sap/cds': '^9',
+          '@cap-js/postgres': '^2'
         },
-        scripts: {
-          start: 'cds-deploy'
+        scripts: { start: 'cds-deploy' }
+      }
+
+      // propagate cds.env.features (allow-listed)
+      const envFeatures = cds.env?.features ?? {}
+      for (const name of CDS_BUILD_OPTIONS) {
+        const val = envFeatures[name]
+        if (val !== undefined) {
+          packageJson.cds ??= {}
+          packageJson.cds.features ??= {}
+          packageJson.cds.features[name] = val
         }
       }
-      const assertIntegrity = cds.env?.features?.assert_integrity
-      if (assertIntegrity) {
+
+      // propagate cds.env.cdsc (minus disallowed)
+      const envCdsc = cds.env?.cdsc ?? {}
+      const cdscClean = Object.fromEntries(
+        Object.entries(envCdsc).filter(([key]) => !CDSC_DISALLOW.includes(key))
+      )
+      if (Object.keys(cdscClean).length) {
         packageJson.cds ??= {}
-        packageJson.cds.features ??= {}
-        packageJson.cds.features.assert_integrity = assertIntegrity
+        packageJson.cds.cdsc = cdscClean
       }
-      promises.push(        
-        this.write(packageJson).to('package.json')
-      )
+
+      promises.push(this.write(packageJson).to('package.json'))
     }
+
     promises.push(this.write(cds.compile.to.json(model)).to(path.join('db', 'csn.json')))
 
     let data

postgres/test/cds-build.test.js

@@ -36,4 +36,13 @@ describe('cds build plugin', () => {
     const ddl = String(execSync('npx cds deploy --dry', { cwd: workDir }))
     expect(ddl).to.contain('REFERENCES')
   })
+
+  test('should retain cdsc settings', () => {
+    execSync('npx cds build --production', { cwd: workDir })
+    const packageJson = JSON.parse(fs.readFileSync(path.join(pgDest, 'package.json'), 'utf8'))
+    expect(packageJson.cds?.cdsc?.defaultStringLength).to.equal(1000)
+    expect(packageJson.cds?.cdsc?.standardDatabaseFunctions).to.be.true
+    // this is excluded from being copied over
+    expect(packageJson.cds?.cdsc?.moduleLookupDirectories).to.be.undefined
+  })
 })

postgres/test/tiny-sample/package.json

@@ -8,6 +8,10 @@
   "cds": {
     "features": {
       "assert_integrity": "db"
+    },
+    "cdsc": {
+      "defaultStringLength": 1000,
+      "standardDatabaseFunctions": true
     }
   }
 }