Run typer once before cds watch starts (#517)

Shoehorn tests for #506

---------

Co-authored-by: Christian Georgi <[email protected]>
Co-authored-by: Christian Georgi <[email protected]>

Author: daogrady

CHANGELOG.md

@@ -8,6 +8,7 @@ All notable changes to this project will be documented in this file.
 - Improved performance of repeated `cds-typer` runs by introducing an option to cache CDS model between runs. By default, typer will only regenerate the files if the model has changed between runs, using `blake2s256` as algorithm.
 ### Changed
 - [breaking] The config `use_entities_proxy` (allowing for static imports) is now set to `true` as default. You can set it to `false` to revert to the old behaviour.
+- Running `cds watch` will trigger `cds-typer "*"` before the initial startup
 ### Deprecated
 ### Removed
 ### Fixed
@@ -17,7 +18,6 @@ All notable changes to this project will be documented in this file.
 
 ### Added
 ### Changed
-- Running `cds watch` will trigger `cds-typer "*"` before the initial startup
 ### Deprecated
 ### Removed
 ### Fixed

package.json

@@ -16,8 +16,8 @@
     "test:unit": "node test/testRunner.js ./test/unit ./test/unit/setup.mjs",
     "test:integration": "node test/testRunner.js ./test/integration ./test/integration/setup.mjs",
     "test:smoke": "node test/testRunner.js ./test/smoke ./test/smoke/setup.mjs",
-    "test:all": "npm run test:smoke && npm run test:unit",
-    "test": "npm run test:smoke && npm run test:unit",
+    "test:all": "npm run test:smoke && npm run test:unit && npm run test:integration",
+    "test": "npm run test:all",
     "lint": "npx eslint .",
     "lint:fix": "npx eslint . --fix",
     "cli": "node lib/cli.js",

test/integration/cds-watch.test.js

@@ -0,0 +1,44 @@
+'use strict'
+
+const fs = require('node:fs')
+const path = require('node:path')
+const { describe, it, before } = require('node:test')
+const assert = require('node:assert')
+const { execSync } = require('node:child_process')
+const cds = require('@sap/cds')
+
+const dir = path.join(__dirname, 'dummy-project')
+// use a slightly different model directory to avoid race-conditions with
+// vscode, as our extension eagerly creates @cds-models when creating a new .cds file
+// as part of our tests
+const modelsDir = path.join(dir, '@cds-models-test')
+const logs = []
+
+describe('cds watch', () => {
+    before(async () => {
+        // spy on cds.debug('cli|build')
+        const cdsLog = cds.debug
+        cds.debug = (...args) => {
+            return args[0] === 'cli|build'
+                ? (...largs) => {
+                  logs.push(args, largs)
+                  return cdsLog(...args)(...largs)
+                }                
+                : cdsLog(...args)}
+    })
+
+    it('runs once before cds watch', async () => {
+        await fs.promises.rm(modelsDir, { recursive: true, force: true })
+        cds.watched = true
+        cds.root = dir
+        // need to set manually, as we don't go through the regular cds bootstrap
+        cds.env.typer = { output_directory: modelsDir }
+        cds.env.log.levels.cli = 'debug'
+        await require('../../cds-plugin')
+        assert.ok(logs.some(log => log.some(line => line.match(/start.*cds-typer/))))
+        logs.length = 0
+        await require('../../cds-plugin')
+        // should not run when models are already there
+        assert.ok(!logs.some(log => log.some(line => line.match(/end.*cds-typer/))))
+    })
+})