Fb/cds plugin (#21)

* wip 1

* wip 2

* wip 3

* wip 4

* wip 5

* wip 6

* wip 7

* wip 8

* wip 8.1

* wip 8.2

* wip 8.3

* wip 8.4

* wip 8.5

* wip 8.6

* wip 8.7

* wip 8.8

* wip 8.9

* wip 8.10

* wip 8.11

* wip 8.12

Author: rlindner81

cds-plugin.js

@@ -0,0 +1,30 @@
+// https://pages.github.tools.sap/cap/docs/node.js/cds-plugins
+"use strict";
+
+const cds = require("@sap/cds");
+const { initializeFeatures } = require("./src/singleton");
+
+const activate = async () => {
+  if (cds.env.featureToggles?.config || cds.env.featureToggles?.configFile) {
+    cds.env.requires = Object.assign(cds.env.requires, {
+      FeatureService: { model: "@cap-js-community/feature-toggle-library" },
+    });
+
+    if (Array.isArray(cds.env.featureToggles.serviceAccessRoles)) {
+      cds.on("loaded", (csn) => {
+        if (csn.definitions.FeatureService) {
+          csn.definitions.FeatureService["@requires"] = cds.env.featureToggles.serviceAccessRoles;
+        }
+      });
+    }
+
+    await initializeFeatures({
+      config: cds.env.featureToggles.config,
+      configFile: cds.env.featureToggles.configFile,
+    });
+  }
+};
+
+module.exports = {
+  activate,
+};

example-cap-server/.cdsrc.json

@@ -3,6 +3,12 @@
     "auth": {
       "kind": "mocked-auth",
       "users": {
+        "system": {
+          "tenant": "system",
+          "password": "system",
+          "id": "system-user",
+          "roles": ["system-user"]
+        },
         "alice": {
           "tenant": "people",
           "password": "alice",

example-cap-server/http/feature-service.http

@@ -1,10 +1,10 @@
 ### state
 GET {{base_url}}/rest/feature/state
-Authorization: Basic {{username}} {{password}}
+Authorization: Basic system system
 
 ### redis_update | check 1
 POST {{base_url}}/rest/feature/redisUpdate
-Authorization: Basic {{username}} {{password}}
+Authorization: Basic system system
 Content-Type: application/json
 
 {
@@ -14,7 +14,7 @@ Content-Type: application/json
 
 ### redis_update | check 2
 POST {{base_url}}/rest/feature/redisUpdate
-Authorization: Basic {{username}} {{password}}
+Authorization: Basic system system
 Content-Type: application/json
 
 {
@@ -25,7 +25,7 @@ Content-Type: application/json
 
 ### redis_update | check 3
 POST {{base_url}}/rest/feature/redisUpdate
-Authorization: Basic {{username}} {{password}}
+Authorization: Basic system system
 Content-Type: application/json
 
 {
@@ -37,7 +37,7 @@ Content-Type: application/json
 
 ### redis_update | memory 1
 POST {{base_url}}/rest/feature/redisUpdate
-Authorization: Basic {{username}} {{password}}
+Authorization: Basic system system
 Content-Type: application/json
 
 {
@@ -47,7 +47,7 @@ Content-Type: application/json
 
 ### redis_update | memory 2
 POST {{base_url}}/rest/feature/redisUpdate
-Authorization: Basic {{username}} {{password}}
+Authorization: Basic system system
 Content-Type: application/json
 
 {
@@ -57,7 +57,7 @@ Content-Type: application/json
 
 ### redis_update | reset
 POST {{base_url}}/rest/feature/redisUpdate
-Authorization: Basic {{username}} {{password}}
+Authorization: Basic system system
 Content-Type: application/json
 
 [

example-cap-server/http/http-client.env.json

@@ -1,7 +1,5 @@
 {
   "local": {
-    "base_url": "http://localhost:4004",
-    "username": "alice",
-    "password": "alice"
+    "base_url": "http://localhost:4004"
   }
 }

example-cap-server/package.json

@@ -3,12 +3,20 @@
   "name": "example-cap-server",
   "version": "1.0.0",
   "scripts": {
-    "start": "cds-serve",
-    "cloc": "npx cloc --vcs=git --read-lang-def=cloc.def ."
+    "start": "npm run copy-library && npm run serve",
+    "copy-library": "npx shx rm -rf node_modules/@cap-js-community/feature-toggle-library && npx shx mkdir -p node_modules/@cap-js-community/feature-toggle-library && npx shx cp -R ../package.json ../index.cds ../cds-plugin.js ../src node_modules/@cap-js-community/feature-toggle-library",
+    "serve": "cds-serve",
+    "cloc": "npx cloc --vcs=git --read-lang-def=cloc.def .",
+    "upgrade": "npm up --save && npx shx rm -rf node_modules && npm i"
   },
   "dependencies": {
-    "@cap-js-community/feature-toggle-library": "file:..",
-    "@sap/cds": "^7.0.0",
+    "@cap-js-community/feature-toggle-library": "*",
+    "@sap/cds": "^7.1.2",
     "express": "^4.18.2"
+  },
+  "cds": {
+    "featureToggles": {
+      "configFile": "./srv/feature/features.yaml"
+    }
   }
 }

example-cap-server/srv/index.cds

@@ -1,2 +1 @@
 using from './service/check-service';
-using from './service/feature-service';

example-cap-server/srv/server.js

@@ -1,14 +1,8 @@
 "use strict";
 
 const cds = require("@sap/cds");
-const {
-  singleton: { initializeFeatures },
-} = require("@cap-js-community/feature-toggle-library");
-
-const { FEATURES_FILEPATH } = require("./feature");
 const { initializeMemoryStatistics } = require("./memoryStatistics");
 
 cds.on("bootstrap", async () => {
-  await initializeFeatures({ configFile: FEATURES_FILEPATH });
   await initializeMemoryStatistics();
 });

example-cap-server/srv/service/check-service.cds

@@ -1,5 +1,5 @@
 @protocol: 'rest'
-@impl: './../handler/check-service.js'
+@impl: './check-service.js'
 service CheckService {
     function priority() returns String;
 }

example-cap-server/srv/handler/check-service.js renamed to example-cap-server/srv/service/check-service.js

@@ -0,0 +1 @@
+using from './src/service/feature-service';

index.cds

@@ -4,7 +4,9 @@
   "description": "SAP BTP feature toggle library enables Node.js applications using the SAP Cloud Application Programming Model to maintain live-updatable feature toggles via Redis.",
   "main": "src/index.js",
   "files": [
-    "src"
+    "src",
+    "cds-plugin.js",
+    "index.cds"
   ],
   "scripts": {
     "test": "jest",

package.json

@@ -12,8 +12,7 @@
 "use strict";
 
 // TODO locale for validation messages
-// TODO investigate how to turn library into a cds plugin similar to https://github.com/cap-js-community/event-queue
-//      this would incorporate a ready-made feature-service interface copied from example-cap-server
+// TODO custom validation should be configurable in yaml file
 
 const { promisify } = require("util");
 const path = require("path");

src/featureToggles.js

@@ -1,7 +1,6 @@
 @protocol: 'rest'
-@impl: './../handler/feature-service.js'
-@(requires: 'authenticated-user')
-// NOTE: in practice this needs proper security restrictions
+@impl: './feature-service.js'
+@(requires: ['system-user'])
 service FeatureService {
     type JSON {};
     function state() returns JSON;

example-cap-server/srv/service/feature-service.cds renamed to src/service/feature-service.cds

@@ -1,10 +1,8 @@
 "use strict";
 
-const {
-  redis,
-  singleton: { getFeaturesInfos, refreshFeatureValues, changeFeatureValue },
-} = require("@cap-js-community/feature-toggle-library");
 const cds = require("@sap/cds");
+const redis = require("../redisWrapper");
+const { getFeaturesInfos, refreshFeatureValues, changeFeatureValue } = require("../singleton");
 
 const COMPONENT_NAME = "featureService";
 const VALIDATION_ERROR_HTTP_CODE = 422;