Fb/unmanaged values (#71)

* approach 1 of wip 1

* give semaphore a one-time transformation

* infos are an object not an array

* approach 1 wip 2

* fix makeOne repeated calling problem

* make redisRead endpoint work in NO_REDIS mode

* approach 1 wip 3

* better serve detection for cds >= 8.2.3

* approach 1.1 wip 4

* approach 1.1 wip 5

* redis in code is usually lower case

* fix serve detection version compare

* upgrade to @sap/cds 8.2.3 for serve mode detection

* remote only change option

* add remote only to validation

* remoteOnly should not be part of messages

* make redisWrapper *Object functions more resilient

* better wording

* better wording 2

* better wording 3

* make lint non-fixing by default and add jsdoc to lint script

* clean up exports and some jsdoc

* finally fix service to class links in jsdoc

* jsdoc polish

* jsdoc polish 2

* consistent wording

* add jsdoc to dev dependencies

* consistency

* isValid should be determined via config, not fallback values

* jsdoc modules with lower dash case

* jsdoc can ignore handler collection

* add npm redis link to redis wrapper

* polish for Semaphore

Author: rlindner81

.eslintignore

@@ -1,4 +1,7 @@
 node_modules/
 temp/
+
 docs/vendor/
 docs/_site/
+
+out/

.github/workflows/main-ci.yml

@@ -36,4 +36,4 @@ jobs:
           node-version: 18
           cache: npm
       - run: npm ci --package-lock
-      - run: npm run lint:ci
+      - run: npm run lint

.github/workflows/main-pr.yml

@@ -36,4 +36,4 @@ jobs:
           node-version: 18
           cache: npm
       - run: npm ci --package-lock
-      - run: npm run lint:ci
+      - run: npm run lint

.github/workflows/publish-release.yml

@@ -22,7 +22,7 @@ jobs:
           registry-url: https://registry.npmjs.org/
       - run: npm ci --package-lock
       - run: npm test
-      - run: npm run lint:ci
+      - run: npm run lint
       - run: npm publish --access public
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

.gitignore

@@ -14,3 +14,6 @@ gen/
 
 # test
 coverage
+
+ # jsdoc
+out/

.prettierignore

@@ -1,6 +1,8 @@
 node_modules/
-package-lock.json
 temp/
+package-lock.json
 
 docs/vendor/
 docs/_site/
+
+out/

docs/usage/index.md

@@ -21,7 +21,8 @@ Redis don't access the same data, unless this is intended. Whenever two or more
 must be _initialized_ with the same configuration.
 
 ```javascript
-const { FeatureToggles } = require("@cap-js-community/feature-toggle-library");
+const toggles = require("@cap-js-community/feature-toggle-library");
+const FeatureToggles = toggles.constructor;
 const instance = new FeatureToggles({ uniqueName: "snowflake" });
 ```
 
@@ -186,8 +187,8 @@ feature toggles.
 ```javascript
 const pathlib = require("path");
 const toggles = require("@cap-js-community/feature-toggle-library");
+const FeatureToggles = toggles.constructor;
 const FEATURES_FILEPATH = pathlib.join(__dirname, ".toggles.yml");
-const { FeatureToggles } = toggles;
 
 // ... during application bootstrap
 const config = await FeatureToggles.readConfigFromFile(FEATURES_FILEPATH);

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

@@ -2,6 +2,25 @@
 GET {{base_url}}/rest/feature/state
 Authorization: Basic system system
 
+### redis_read
+POST {{base_url}}/rest/feature/redisRead
+Authorization: Basic system system
+Content-Type: application/json
+
+### redis_update | reset toggles that are not configured
+POST {{base_url}}/rest/feature/redisUpdate
+Authorization: Basic system system
+Content-Type: application/json
+
+{
+  "key": "/srv/memoryStatistics/logInterval",
+  "value": null,
+  "options": {
+    "clearSubScopes": true,
+    "remoteOnly": true
+  }
+}
+
 ### redis_update | fts 1
 POST {{base_url}}/rest/feature/redisUpdate
 Authorization: Basic system system

example-cap-server/package.json

@@ -19,7 +19,7 @@
   },
   "dependencies": {
     "@cap-js-community/feature-toggle-library": "*",
-    "@sap/cds": "^8.2.2",
+    "@sap/cds": "^8.2.3",
     "@sap/cds-mtxs": "^1.18.3",
     "express": "^4.21.0"
   },