feat: multitenancy support (#39)

SirSimon04 · KoblerS · schiwekM · web-flow · commit 24a48dfee450 · 2025-12-19T14:22:08.000+01:00
* add manual req * fixes * fix * fix * update to bearer * update to jwt * update for print function * update * update * fix * update to fetch * use res.jsn * fixes * fix * update * udpate * add tentant id t request * refactoring to use cache and utils * update token cache * fixes * fix * update * remove cloud sdk * fix * fix * update * update * changes * polished * comment * update lint config * Update srv/BTPPrintService.js Co-authored-by: Simon Kobler <32038731+KoblerS@users.noreply.github.com> * Update srv/BTPPrintService.js Co-authored-by: Simon Kobler <32038731+KoblerS@users.noreply.github.com> * Update srv/BTPPrintService.js Co-authored-by: Simon Kobler <32038731+KoblerS@users.noreply.github.com> * update error handling * update error handling * updates * update creds * try to use xssec * update vcap.tag * update cds.requires * update label * remove param * add cache back in * update deps * try * change name to PrintService * try * Revert "try" This reverts commit b0fd21d. * add zone id * remoce zid * add zoneid back in finally, wurde aber auch mal zeit * lint * change name to print again * only add zid when needed * make service internal * remove package update * Update srv/BTPPrintService.js Co-authored-by: Marten Schiwek <marten.schiwek@sap.com> * update error handling * update test package.json * Changelog * Update srv/localPrintService.js Co-authored-by: Simon Kobler <32038731+KoblerS@users.noreply.github.com> * prettier * update error handling match queue and file reading to print error handling behaviour --------- Co-authored-by: Simon Kobler <32038731+KoblerS@users.noreply.github.com> Co-authored-by: Marten Schiwek <marten.schiwek@sap.com>
diff --git a/.eslintrc b/.eslintrc
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -40,6 +40,16 @@
       "runtimeArgs": ["run", "test"],
       "skipFiles": ["<node_internals>/**"],
       "console": "integratedTerminal"
+    },
+    {
+      "type": "pwa-node",
+      "request": "launch",
+      "name": "watch sample hybrid",
+      "cwd": "${workspaceFolder}/test/bookshop",
+      "runtimeExecutable": "cds",
+      "runtimeArgs": ["bind", "--exec", "--", "cds", "w"],
+      "skipFiles": ["<node_internals>/**"],
+      "console": "integratedTerminal"
     }
   ]
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,18 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
-## Version 0.1.0 - TBD
+## Version 0.2.0 - 2025-12-19
+
+### Added
+
+- Multitenancy support
+
+### Fixed
+
+- Draft enabled entities can be print enabled
+- Entities with composite keys can be print enabled
+
+## Version 0.1.0 - 2025-11-28
 
 ### Added
 
diff --git a/_i18n/messages.properties b/_i18n/messages.properties
@@ -1,4 +1,6 @@
 PRINT_UNKNOWN_ERROR=An unknown error occurred while attempting to print.
+QUEUE_UNKNOWN_ERROR=An unknown error occurred while accessing the print queues.
+FILE_UNKNOWN_ERROR=An unknown error occurred while accessing the print files.
 PRINT_JOB_SENT=Print job for file "{0}" has been sent to queue "{1}".
 PRINT_PROVIDE_FILTER=Please provide a filter to retrieve files for the object.
 PRINT_OBJECT_NOT_FOUND=Object '{0}' was not found in the model.
diff --git a/cds-plugin.js b/cds-plugin.js
@@ -23,7 +23,17 @@ cds.once("served", async () => {
           srv.on("READ", entity, async (req) => {
             req.target = printer.entities.Queues;
             req.query.SELECT.from.ref[0] = "PrintService.Queues";
-            return await printer.run(req.query);
+            try {
+              return await printer.run(req.query);
+            } catch (error) {
+              LOG.error(error);
+              // Only return client errors to not show technical errors to the user
+              if (error.code >= 400 && error.code < 500) {
+                req.reject(error.code, error.message);
+              } else {
+                req.reject(500, "QUEUE_UNKNOWN_ERROR");
+              }
+            }
           }),
         );
         continue;
@@ -34,7 +44,17 @@ cds.once("served", async () => {
           srv.on("READ", entity, async (req) => {
             req.target = printer.entities.Files;
             req.query.SELECT.from.ref[0] = "PrintService.Files";
-            return await printer.run(req.query);
+            try {
+              return await printer.run(req.query);
+            } catch (error) {
+              LOG.error(error);
+              // Only return client errors to not show technical errors to the user
+              if (error.code >= 400 && error.code < 500) {
+                req.reject(error.code, error.message);
+              } else {
+                req.reject(500, "FILE_UNKNOWN_ERROR");
+              }
+            }
           }),
         );
       }
@@ -90,14 +110,19 @@ cds.once("served", async () => {
                 ],
               });
 
-              return req.info({
+              return req.notify({
                 status: 200,
                 message: "PRINT_JOB_SENT",
                 args: [object[fileNameAttribute], queueID],
               });
             } catch (error) {
-              LOG.error("Print error:", error);
-              return req.reject({ status: 500, message: "PRINT_UNKNOWN_ERROR" });
+              LOG.error(error);
+              // Only return client errors to not show technical errors to the user
+              if (error.code >= 400 && error.code < 500) {
+                req.reject(error.code, error.message);
+              } else {
+                req.reject(500, "PRINT_UNKNOWN_ERROR");
+              }
             }
           });
         }
diff --git a/eslint.config.js b/eslint.config.js
@@ -4,6 +4,21 @@ export default [
   ...cds,
   {
     files: ["**/*.js"],
+    languageOptions: {
+      globals: {
+        SELECT: "readonly",
+        INSERT: "readonly",
+        UPSERT: "readonly",
+        UPDATE: "readonly",
+        DELETE: "readonly",
+        CREATE: "readonly",
+        DROP: "readonly",
+        CDL: "readonly",
+        CQL: "readonly",
+        CXL: "readonly",
+        cds: "readonly",
+      },
+    },
     rules: {
       "no-await-in-loop": "error",
       "no-console": ["error", { allow: ["warn", "error"] }],
diff --git a/lib/btp-utils.js b/lib/btp-utils.js
@@ -0,0 +1,29 @@
+const { XsuaaService } = require("@sap/xssec");
+
+const getServiceCredentials = (name) => (cds?.env?.requires[name] || [])?.credentials;
+
+async function getServiceToken(serviceName) {
+  const srvCredentials = getServiceCredentials(serviceName);
+  if (!srvCredentials) {
+    throw new Error(`Missing binding credentials for service "${serviceName}"`);
+  }
+
+  const tenantId = cds.context?.tenant;
+  const xsuaaService = new XsuaaService(srvCredentials.uaa);
+  const { access_token: jwt, expires_in } = await xsuaaService.fetchClientCredentialsToken({
+    ...(tenantId && { zid: tenantId }),
+  });
+
+  if (!jwt) {
+    throw new Error(
+      `Empty JWT returned from authorization service for bound service "${serviceName}"`,
+    );
+  }
+
+  return { jwt, expires_in };
+}
+
+module.exports = {
+  getServiceToken,
+  getServiceCredentials,
+};
diff --git a/lib/token-cache.js b/lib/token-cache.js
@@ -0,0 +1,29 @@
+const cds = require("@sap/cds");
+const LOG = cds.log("print");
+
+module.exports = class TokenCache {
+  constructor() {
+    this.cache = new Map();
+  }
+
+  set(key, token, expiresIn) {
+    const expiresAt = Date.now() + expiresIn * 1000;
+    this.cache.set(key, { token, expiresAt });
+    LOG.debug(`Token set for key: ${key}, expires in ${expiresIn} seconds.`);
+  }
+
+  get(key) {
+    const entry = this.cache.get(key);
+    if (!entry) {
+      LOG.debug(`No token found for key: ${key}.`);
+      return undefined;
+    }
+    if (Date.now() >= entry.expiresAt) {
+      this.cache.delete(key);
+      LOG.debug(`Token expired for key: ${key}.`);
+      return undefined;
+    }
+    LOG.debug(`Token retrieved for key: ${key}.`);
+    return entry.token;
+  }
+};
diff --git a/package.json b/package.json
@@ -22,9 +22,9 @@
     "plugin"
   ],
   "dependencies": {
-    "@sap-cloud-sdk/connectivity": "^3.26.4",
-    "@sap-cloud-sdk/http-client": "^4.1.2",
-    "@sap/xssec": "^3.6.2"
+    "@sap-cloud-sdk/connectivity": "^4.2.0",
+    "@sap-cloud-sdk/http-client": "^4.2.0",
+    "@sap-cloud-sdk/resilience": "^4.2.0"
   },
   "peerDependencies": {
     "@sap/cds": ">= 9"
@@ -38,8 +38,7 @@
   ],
   "cds": {
     "requires": {
-      "destinations": true,
-      "PrintService": {
+      "print": {
         "[development]": {
           "kind": "print-to-console"
         },
@@ -53,7 +52,10 @@
           "kind": "print-to-service"
         },
         "vcap": {
-          "tag": "print"
+          "label": "print"
+        },
+        "subscriptionDependency": {
+          "uaa": "xsappname"
         },
         "outbox": true
       },
diff --git a/srv/BTPPrintService.cds b/srv/BTPPrintService.cds
@@ -1,5 +1,6 @@
 @impl: './BTPPrintService.js'
 @requires: 'authenticated-user'
+@protocol: 'none'
 service PrintService {
 
   @UI.HeaderInfo: {
diff --git a/srv/BTPPrintService.js b/srv/BTPPrintService.js
diff --git a/srv/localPrintService.js b/srv/localPrintService.js
diff --git a/srv/service.js b/srv/service.js

Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,16 @@`
`40`	`40`	`"runtimeArgs": ["run", "test"],`
`41`	`41`	`"skipFiles": ["<node_internals>/**"],`
`42`	`42`	`"console": "integratedTerminal"`
	`43`	`+ },`
	`44`	`+ {`
	`45`	`+ "type": "pwa-node",`
	`46`	`+ "request": "launch",`
	`47`	`+ "name": "watch sample hybrid",`
	`48`	`+ "cwd": "${workspaceFolder}/test/bookshop",`
	`49`	`+ "runtimeExecutable": "cds",`
	`50`	`+ "runtimeArgs": ["bind", "--exec", "--", "cds", "w"],`
	`51`	`+ "skipFiles": ["<node_internals>/**"],`
	`52`	`+ "console": "integratedTerminal"`
`43`	`53`	`}`
`44`	`54`	`]`
`45`	`55`	`}`