Making the plugin to js by Kronprinz03 · Pull Request #50 · cap-js/process

Kronprinz03 · 2026-03-19T21:38:03Z

Have you...

Added relevant entry to the change log?

hyperspace-insights

The PR introduces a critical circular self-import bug in lib/index.ts (the module imports from './index' — itself), which will cause all referenced symbols to be undefined at runtime. Additionally, embedding CDS plugin registration side-effects directly in the public lib/index.ts barrel means those side-effects fire for any consumer who imports from the library, not just when the plugin is bootstrapped. Both issues need to be addressed before this can be merged safely.

PR Bot Information

Version: 1.19.1 | 📖 Documentation | 🚨 Create Incident | 💬 Feedback

Event Trigger: pull_request.opened
Correlation ID: e9bc5580-23db-11f1-832f-78869b260faa
LLM: anthropic--claude-4.6-sonnet

lib/index.ts

tsconfig.build.json

srv/BTPProcessService.js

SirSimon04 · 2026-03-20T08:20:42Z

package.json

  "version": "1.0.0",
  "description": "",
-  "main": "cds-plugin.ts",
+  "main": "cds-plugin.js",


add files, like here: https://github.com/cap-js/attachments/blob/0183354e91760f09fcc5baf8903b88ec98f029c4/package.json#L10

hyperspace-insights · 2026-03-20T08:52:50Z

Summary

The following content is AI-generated and provides a summary of the pull request:

Migrate Plugin Entry Point from TypeScript to Compiled JavaScript

Refactor

♻️ Refactored the plugin to compile TypeScript sources to a dist/ directory and expose JavaScript entry points, enabling the package to be consumed without a TypeScript runtime dependency.

Changes

cds-plugin.js: New JS entry point that delegates to the compiled dist/cds-plugin output. The main field in package.json now points here instead of cds-plugin.ts.
cds-plugin.ts: Reduced to a single re-export (import './lib'). All plugin registration logic (CDS event handlers, annotation cache, build plugin, import handler) has been moved into lib/index.ts.
lib/index.ts: Now contains the full plugin initialization code previously in cds-plugin.ts, including cds.on('serving'), cds.on('served'), build plugin registration, and import handler setup.
tsconfig.build.json: New build-specific TypeScript config that compiles cds-plugin.ts, srv/**/*.ts, and lib/**/*.ts into ./dist.
package.json: Updated main to cds-plugin.js, added files array (cds-plugin.js, dist, srv), and added a compile script (tsc -p tsconfig.build.json) with prebuild and pretest hooks.
srv/BTPProcessService.js / srv/localProcessService.js: New JS shims delegating to compiled dist/srv/* modules.
srv/BTPProcessService.cds / srv/localProcessService.cds: Removed .ts extension from @impl annotations so CDS resolves to the JS shims.
lib/build/plugin.ts, lib/build/validation-utils.ts, lib/build/validations.ts, lib/processImport.ts: Fixed import paths for types/csn-extensions to use relative paths from within lib/ (e.g., ../types/ → ./types/).
lib/types/cds-extensions.d.ts, lib/types/cds-plugin.d.ts, lib/types/csn-extensions.ts: Renamed/moved type files into lib/types/.
.github/actions/integration-tests/action.yml: Added a Compile TypeScript to dist step (npm run compile) before HANA deployment steps.
tsconfig.json: Fixed include path for types from ./types/**/*.ts to lib/types/**/*.ts.
eslint.config.mjs: Added dist/** to the ignore list.
.gitignore: Added dist/ to ignored paths.
.prettierignore: Added dist/* to ignored paths.
jest.config.js: Scoped ts-jest diagnostics path regex to \.test\.ts$ to avoid false errors from compiled output.

🔄 Regenerate and Update Summary
✏️ Insert as PR Description (deletes this comment)
🗑️ Delete comment

PR Bot Information

Version: 1.19.1 | 📖 Documentation | 🚨 Create Incident | 💬 Feedback

Correlation ID: 1cac19e0-243a-11f1-895a-ad3474f63ca0
Event Trigger: pull_request.ready_for_review
Output Template: Default Template
LLM: anthropic--claude-4.6-sonnet
Summary Prompt: Default Prompt

💌 Have ideas or want to contribute? Create an issue and share your thoughts with us!
📑 Check out the documentation for more information.
📬 Subscribe to the Hyperspace PR Bot DL to get the latest announcements and pilot features!

Made with ❤️ by Hyperspace.

hyperspace-insights

The PR introduces a TypeScript-to-JavaScript compilation pipeline (tsconfig.build.json, npm run compile, JS shim files) to make the plugin publishable as plain JS. The structural changes are mostly sound, but two substantive issues were flagged:

Side-effect pollution in the barrel export (lib/index.ts): Moving CDS event registrations into the shared barrel module means any import from lib (including in tests) will trigger plugin registration as an unintended side effect. This logic should stay in the dedicated cds-plugin.ts entry point.
pretest only covers npm test: Sibling scripts like test:watch, test:hana, and test:hybrid skip the compile step and may run against a stale dist/ directory.

Please address these before merging.

PR Bot Information

Version: 1.19.1 | 📖 Documentation | 🚨 Create Incident | 💬 Feedback

Correlation ID: 1cac19e0-243a-11f1-895a-ad3474f63ca0
LLM: anthropic--claude-4.6-sonnet
Event Trigger: pull_request.ready_for_review

hyperspace-insights · 2026-03-20T08:53:20Z

tsconfig.build.json

+    "outDir": "./dist",
+    "rootDir": "."
+  },
+  "include": ["./cds-plugin.ts", "./srv/**/*.ts", "./lib/**/*.ts"],


Bug: cds-plugin.ts is included in the build but its compiled output (dist/cds-plugin.js) will never be used at runtime.

The root-level cds-plugin.js shim already requires ./dist/cds-plugin, so dist/cds-plugin.js would just re-export dist/lib/index.js. However, the real entry point consumed by consumers is the root cds-plugin.js → dist/cds-plugin.js → dist/lib/index.js chain. Including ./cds-plugin.ts in the build is harmless but creates an extra indirection layer in the output. More critically, since cds-plugin.ts only does import './lib', the compiled dist/cds-plugin.js will require ./lib — but inside dist/, lib is at dist/lib, not a sibling lib/. The relative path ./lib from dist/cds-plugin.js resolves correctly only if the output mirrors the source structure. With rootDir: "." and outDir: "./dist", dist/cds-plugin.js will emit require("./lib") which resolves to dist/lib/index.js — this is correct. No immediate breakage, but the chain is fragile. Consider verifying the compiled output resolves as expected.

Please provide feedback on the review comment by checking the appropriate box:

🌟 Awesome comment, a human might have missed that.

✅ Helpful comment

🤷 Neutral

❌ This comment is not helpful

hyperspace-insights · 2026-03-20T08:53:20Z

package.json

+  ],
  "scripts": {
+    "prebuild": "npm run compile",
+    "pretest": "npm run compile",


Bug: The pretest script runs npm run compile (TypeScript compilation), but the test:watch, test:hana, and test:hybrid scripts bypass pretest entirely since pre* hooks only fire for the exact script name they prefix. Developers running npm run test:hana or npm run test:watch may be testing against a stale dist/.

Consider either adding explicit compile calls in those scripts or documenting that npm test must be run first.

Suggested change

"pretest": "npm run compile",

"prebuild": "npm run compile",

"pretest": "npm run compile",

"test": "jest --silent --testPathIgnorePatterns=/tests/hybrid/programmaticApproach.test.ts",

"test:watch": "npm run compile && jest --watch",

"test:hana": "npm run compile && jest tests/integration --silent",

"test:hybrid": "npm run compile && jest tests/hybrid --silent",

Double-check suggestion before committing. Edit this comment for amendments.

Please provide feedback on the review comment by checking the appropriate box:

🌟 Awesome comment, a human might have missed that.

✅ Helpful comment

🤷 Neutral

❌ This comment is not helpful

hyperspace-insights · 2026-03-20T08:53:20Z

lib/index.ts

+import { importProcess } from './processImport';
+
+// Register build plugin for annotation validation during cds build
+cds.build?.register?.('process-validation', ProcessValidationPlugin);


Logic Error: Side-effect plugin code (CDS event registrations, import handler setup) has been moved into lib/index.ts, which is also a barrel re-export module. Any consumer who imports anything from lib/index.ts (e.g. in tests or programmatically) will inadvertently trigger cds.on('serving', ...), cds.on('served', ...), and cds.build?.register?.(...) as side effects.

This breaks the separation of concerns that existed when the plugin code was isolated in cds-plugin.ts. Consider moving the plugin registration logic back to cds-plugin.ts (importing from ./lib for shared utilities) and keeping lib/index.ts as a pure export barrel.

Please provide feedback on the review comment by checking the appropriate box:

🌟 Awesome comment, a human might have missed that.

✅ Helpful comment

🤷 Neutral

❌ This comment is not helpful

Kronprinz03 added 4 commits March 19, 2026 17:33

moving cds-plugin implementation to lib/index

9c28c6b

moved types folder to lib

9ed691b

fixed import paths in index

8d42607

Fixed compile to js

ef74e52

hyperspace-insights bot reviewed Mar 19, 2026

View reviewed changes

lib/index.ts Outdated Show resolved Hide resolved

tsconfig.build.json Outdated Show resolved Hide resolved

Kronprinz03 added 2 commits March 19, 2026 22:57

fixed imports

3934a0a

added compile step

0e0b2df

Kronprinz03 force-pushed the making-the-plugin-to-js branch from 994735c to 0e0b2df Compare March 19, 2026 21:57

Kronprinz03 added 3 commits March 19, 2026 23:01

Added prebuild hook

ba72c63

adding js wrapper for srv

d499a66

add back action for compile

af1be47

Kronprinz03 force-pushed the making-the-plugin-to-js branch from a19c4ae to 92378da Compare March 19, 2026 22:25

fix lint

aceca15

Kronprinz03 force-pushed the making-the-plugin-to-js branch from 92378da to aceca15 Compare March 19, 2026 22:31

SirSimon04 reviewed Mar 20, 2026

View reviewed changes

srv/BTPProcessService.js Show resolved Hide resolved

SirSimon04 approved these changes Mar 20, 2026

View reviewed changes

added files

ad4470d

Kronprinz03 force-pushed the making-the-plugin-to-js branch from dbdcb96 to ad4470d Compare March 20, 2026 08:34

Kronprinz03 marked this pull request as ready for review March 20, 2026 08:52

Kronprinz03 requested a review from a team as a code owner March 20, 2026 08:52

hyperspace-insights bot reviewed Mar 20, 2026

View reviewed changes

fixed files

cafab5b

Kronprinz03 merged commit 6dca35b into main Mar 20, 2026
8 checks passed

Kronprinz03 deleted the making-the-plugin-to-js branch March 20, 2026 09:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Making the plugin to js#50

Making the plugin to js#50
Kronprinz03 merged 12 commits intomainfrom
making-the-plugin-to-js

Kronprinz03 commented Mar 19, 2026

Uh oh!

hyperspace-insights bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

SirSimon04 Mar 20, 2026

Uh oh!

hyperspace-insights bot commented Mar 20, 2026

Uh oh!

hyperspace-insights bot left a comment

Uh oh!

hyperspace-insights bot Mar 20, 2026

Uh oh!

hyperspace-insights bot Mar 20, 2026

Uh oh!

hyperspace-insights bot Mar 20, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

-    "pretest": "npm run compile",
+    "prebuild": "npm run compile",
+    "pretest": "npm run compile",
+    "test": "jest --silent --testPathIgnorePatterns=/tests/hybrid/programmaticApproach.test.ts",
+    "test:watch": "npm run compile && jest --watch",
+    "test:hana": "npm run compile && jest tests/integration --silent",
+    "test:hybrid": "npm run compile && jest tests/hybrid --silent",

Conversation

Kronprinz03 commented Mar 19, 2026

Have you...

Uh oh!

hyperspace-insights bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

SirSimon04 Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!

hyperspace-insights bot commented Mar 20, 2026

Summary

Migrate Plugin Entry Point from TypeScript to Compiled JavaScript

Refactor

Changes

Uh oh!

hyperspace-insights bot left a comment

Choose a reason for hiding this comment

Uh oh!

hyperspace-insights bot Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!

hyperspace-insights bot Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!

hyperspace-insights bot Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants