soajs.controller 4.3.18 → 4.3.20

package/mw/idempotency/model/memory.js

@@ -75,7 +75,7 @@ let model = {
 		return entry;
 	},
 
-	'lock': (key, ttl) => {
+	'lock': (key, ttl, lockId) => {
 		if (!dataHolder[key.l1]) {
 			dataHolder[key.l1] = {};
 		}
@@ -85,6 +85,7 @@ let model = {
 		}
 		dataHolder[key.l1][key.l2] = {
 			'status': 'in_flight',
+			'lockId': lockId || null,
 			'lockedAt': Date.now(),
 			'expiresAt': Date.now() + ttl
 		};
@@ -103,8 +104,17 @@ let model = {
 		};
 	},
 
-	'unlock': (key) => {
+	//NOTE: only an entry still in flight is removed, never a completed one, and with a lockId only
+	//		the lock of that request, not one taken by a retry after the ttl
+	'unlock': (key, lockId) => {
 		if (dataHolder[key.l1] && dataHolder[key.l1][key.l2]) {
+			const entry = dataHolder[key.l1][key.l2];
+			if (entry.status !== 'in_flight') {
+				return;
+			}
+			if (lockId && entry.lockId !== lockId) {
+				return;
+			}
 			delete dataHolder[key.l1][key.l2];
 		}
 	},

package/mw/idempotency/model/mongo.js

@@ -58,7 +58,7 @@ let model = {
 		}
 	},
 
-	'lock': async (key, ttl) => {
+	'lock': async (key, ttl, lockId) => {
 		let condition = {
 			'l1': key.l1,
 			'l2': key.l2
@@ -73,6 +73,7 @@ let model = {
 				'l1': key.l1,
 				'l2': key.l2,
 				'status': 'in_flight',
+				'lockId': lockId || null,
 				'lockedAt': new Date(),
 				'expiresAt': new Date(Date.now() + ttl)
 			};
@@ -108,11 +109,17 @@ let model = {
 		}
 	},
 
-	'unlock': async (key) => {
+	//NOTE: only a record still in flight is removed, never a completed one, and with a lockId only
+	//		the lock of that request, not one taken by a retry after the ttl
+	'unlock': async (key, lockId) => {
 		let condition = {
 			'l1': key.l1,
-			'l2': key.l2
+			'l2': key.l2,
+			'status': 'in_flight'
 		};
+		if (lockId) {
+			condition.lockId = lockId;
+		}
 		try {
 			await model.mongo.deleteOne(idempotency_store, condition);
 		} catch (e) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "soajs.controller",
   "description": "soajs multi tenant API gateway",
-  "version": "4.3.18",
+  "version": "4.3.20",
   "author": {
     "name": "soajs team",
     "email": "team@soajs.org"

package/server/maintenance.js

@@ -11,6 +11,7 @@
 const get = (p, o) => p.reduce((xs, x) => (xs && xs[x]) ? xs[x] : null, o);
 
 const registryModule = require("./../modules/registry");
+const cacheInvalidate = require("./../mw/cache/invalidate.js");
 
 const httpProxy = require('http-proxy');
 const http = require('http');
@@ -311,6 +312,46 @@ let Maintenance = (core, log, param, serviceIp, regEnvironment, awareness_mw, so
 			};
 			proxy.web(req, res, {target: haTarget});
 		}
+		else if (parsedUrl.pathname === '/cache/invalidate') {
+			let response = maintenanceResponse(parsedUrl, param);
+			let reply = (status, extra) => {
+				res.writeHead(status, {'Content-Type': 'application/json'});
+				return res.end(JSON.stringify(Object.assign(response, extra)));
+			};
+			if (req.method !== 'POST') {
+				return reply(405, {"error": "Use POST."});
+			}
+			let body = "";
+			let tooLarge = false;
+			req.on('data', function (chunk) {
+				body += chunk;
+				//NOTE: the body only names what to remove, anything larger is not a valid request
+				if (body.length > 16384) {
+					tooLarge = true;
+					req.destroy();
+				}
+			});
+			req.on('end', function () {
+				if (tooLarge) {
+					return;
+				}
+				let input = null;
+				try {
+					input = body ? JSON.parse(body) : null;
+				} catch (e) {
+					return reply(400, {"error": "The body is not valid JSON."});
+				}
+				cacheInvalidate(registryModule.get(), input).then((outcome) => {
+					if (outcome.status !== 200) {
+						return reply(outcome.status, {"error": outcome.error});
+					}
+					log.info("Cache invalidated for tenant [" + input.tenant + "] service [" + input.service + "]" +
+						(input.api ? " api [" + input.api + "]" : "") + (input.user ? " user [" + input.user + "]" : "") +
+						", removed [" + outcome.removed + "]");
+					return reply(200, {"result": true, "data": {"removed": outcome.removed}});
+				});
+			});
+		}
 		else if (parsedUrl.pathname === '/loadProvision') {
 			provision.loadProvision(function (loaded) {
 				let response = maintenanceResponse(parsedUrl, param);

package/test/data/provision/customRegistry/gateway.js

@@ -0,0 +1,47 @@
+'use strict';
+let doc = {
+	"_id": "5d7f8e43edf21900fed08cf7",
+	"name": "gateway",
+	"locked": false,
+	"plugged": true,
+	"shared": false,
+	"value": {
+		"idempotency": {
+			"model": "mongo",
+			"services": {
+				"idempotent": {
+					"enabled": true,
+					"ttl": 60000,
+					"apis": ["POST /ok", "POST /fail", "POST /bad", "POST /slow", "POST /throttled"]
+				}
+			}
+		},
+		"cache": {
+			"model": "mongo",
+			"defaultTTL": 60000,
+			"services": {
+				"spaces": {
+					"enabled": true,
+					"apis": {
+						"GET /spaces": { "enabled": true, "scope": "tenant_user" },
+						"GET /space/:id": { "enabled": true, "scope": "tenant_user" },
+						"GET /slow": { "enabled": true, "scope": "tenant_user" },
+						"GET /catalog": { "enabled": true, "scope": "tenant" }
+					}
+				}
+			}
+		},
+		"traffic": {
+			"throttling": {
+				"idempotent": {
+					"publicAPIStrategy": "idempotent_tight",
+					"apis": ["/throttled"]
+				}
+			}
+		}
+	},
+	"created": "DEV",
+	"author": "owner"
+};
+
+module.exports = doc;

package/test/data/provision/environment/dev.js

@@ -115,6 +115,15 @@ let env = {
 	            "accessTokenLifetime": 7200,
 	            "refreshTokenLifetime": 1209600
             },
+            "throttling": {
+                "idempotent_tight": {
+                    "type": 1,
+                    "window": 60000,
+                    "limit": 1,
+                    "retries": 0,
+                    "delay": 100
+                }
+            },
             "ports": {
 	            "controller": 4000,
 	            "maintenanceInc": 1001,

package/test/data/provision/hosts/idempotent.js

@@ -0,0 +1,12 @@
+'use strict';
+
+let host = {
+    _id: "5da078e22357684b57effcf3",
+    env: "dev",
+    ip: "127.0.0.1",
+    name: "idempotent",
+    version: "1",
+    port: 4014
+};
+
+module.exports = host;

package/test/data/provision/hosts/spaces.js

@@ -0,0 +1,12 @@
+'use strict';
+
+let host = {
+    _id: "5da078e22357684b57effcf5",
+    env: "dev",
+    ip: "127.0.0.1",
+    name: "spaces",
+    version: "1",
+    port: 4015
+};
+
+module.exports = host;

package/test/data/provision/marketplace/idempotent.js

@@ -0,0 +1,37 @@
+'use strict';
+
+let service = {
+	_id: "5da078c92357684b57effcf2",
+	"type": "service",
+	name: "idempotent",
+	configuration: {
+		group: "SOAJS test",
+		port: 4014,
+		requestTimeout: 30,
+		requestTimeoutRenewal: 5
+	},
+	versions: [{
+		"version": "1",
+		maintenance: {
+			"port": {
+				"type": "maintenance"
+			},
+			"readiness": "/heartbeat"
+		},
+		oauth: true,
+		extKeyRequired: true,
+		urac: true,
+		urac_Profile: false,
+		urac_ACL: false,
+		provision_ACL: false,
+		apis: [
+			{ l: "Answers 200", v: "/ok", m: "post", group: "Integration test" },
+			{ l: "Answers 503 the first time", v: "/fail", m: "post", group: "Integration test" },
+			{ l: "Answers 400", v: "/bad", m: "post", group: "Integration test" },
+			{ l: "Answers 200 after a delay", v: "/slow", m: "post", group: "Integration test" },
+			{ l: "Answers 200, throttled", v: "/throttled", m: "post", group: "Integration test" }
+		]
+	}
+	]
+};
+module.exports = service;

package/test/data/provision/marketplace/spaces.js

@@ -0,0 +1,36 @@
+'use strict';
+
+let service = {
+	_id: "5da078c92357684b57effcf4",
+	"type": "service",
+	name: "spaces",
+	configuration: {
+		group: "SOAJS test",
+		port: 4015,
+		requestTimeout: 30,
+		requestTimeoutRenewal: 5
+	},
+	versions: [{
+		"version": "1",
+		maintenance: {
+			"port": {
+				"type": "maintenance"
+			},
+			"readiness": "/heartbeat"
+		},
+		oauth: true,
+		extKeyRequired: true,
+		urac: true,
+		urac_Profile: false,
+		urac_ACL: false,
+		provision_ACL: false,
+		apis: [
+			{ l: "Spaces of the user", v: "/spaces", m: "get", group: "Integration test" },
+			{ l: "One space", v: "/space/:id", m: "get", group: "Integration test" },
+			{ l: "Spaces after a delay", v: "/slow", m: "get", group: "Integration test" },
+			{ l: "Same for the whole tenant", v: "/catalog", m: "get", group: "Integration test" }
+		]
+	}
+	]
+};
+module.exports = service;

package/test/data/provision/oauth/token/second_owner_token.js

@@ -0,0 +1,72 @@
+'use strict';
+
+let token = {
+    _id: "5cdc190fd52c82e0ddb1dcd8",
+    type: "accessToken",
+    token: "c4c4e5e5f6f6a7a7b8b8c9c9d0d0e1e1f2f2a301",
+    clientId: "5c0e74ba9acc3c5a84a51259",
+    user: {
+        _id: "5c8d0c505653de3985aa2001",
+        locked: true,
+        username: "second_owner",
+        firstName: "owner3'sèį",
+        lastName: "owner",
+        email: "me@localhost.com",
+        "ts": new Date().getTime(),
+        status: "active",
+        profile: {},
+        groups: [
+            "owner"
+        ],
+        config: {
+            packages: {},
+            keys: {},
+            allowedTenants: [
+                {
+                    tenant: {
+                        id: "THYME_tID",
+                        code: "THYME_CODE",
+                        pin: {
+                            code: "5678",
+                            allowed: true
+                        }
+                    },
+                    groups: [
+                        "waiter"
+                    ]
+                },
+                {
+                    tenant: {
+                        id: "ELVIRA_tID",
+                        code: "ELVIRA_CODE"
+                    },
+                    groups: [
+                        "manager"
+                    ]
+                }
+            ]
+        },
+        tenant: {
+            id: "5c0e74ba9acc3c5a84a51259",
+            code: "DBTN",
+            pin: {
+                code: "1235",
+                allowed: true
+            }
+        },
+        lastLogin: new Date().getTime(),
+        groupsConfig: {
+            allowedPackages: {
+                DSBRD: [
+                    "DSBRD_OWNER"
+                ]
+            },
+            allowedEnvironments: {}
+        },
+        loginMode: "urac",
+        id: "5c8d0c505653de3985aa2001"
+    },
+    env: "dev",
+    expires: new Date((new Date().getFullYear()) + 2, 0, 1)
+};
+module.exports = token;

package/test/data/provision/products/dsbrd.js

@@ -9,6 +9,39 @@ let prod = {
 	"scope": {
 		"acl": {
 			"dev": {
+				"spaces": {
+					"1": {
+						"access": true,
+						"get": [
+							{
+								"group": "Spaces group",
+								"apis": {
+									"/spaces": {},
+									"/space/:id": {},
+									"/slow": {},
+									"/catalog": {}
+								}
+							}
+						]
+					}
+				},
+				"idempotent": {
+					"1": {
+						"access": true,
+						"post": [
+							{
+								"group": "Idempotent group",
+								"apis": {
+									"/ok": {},
+									"/fail": {},
+									"/bad": {},
+									"/slow": {},
+									"/throttled": {}
+								}
+							}
+						]
+					}
+				},
 				"httpmethods": {
 					"1": {
 						"access": true,
@@ -200,6 +233,22 @@ let prod = {
 			"locked": true,
 			"acl": {
 				"dev": {
+					"spaces": [
+						{
+							"version": "1",
+							"get": [
+								"Spaces group"
+							]
+						}
+					],
+					"idempotent": [
+						{
+							"version": "1",
+							"post": [
+								"Idempotent group"
+							]
+						}
+					],
 					"httpmethods": [
 						{
 							"version": "1",

package/test/data/provision/urac/users/second_owner.js

@@ -0,0 +1,61 @@
+'use strict';
+let user = {
+    _id: "5c8d0c505653de3985aa2001",
+    locked: true,
+    username: "second_owner",
+    password: "$2a$12$geJJfv33wkYIXEAlDkeeuOgiQ6y6MjP/YxbqLdHdDSK7LDG.7n7Pq",
+    firstName: "owner3'sèį",
+    lastName: "owner",
+    email: "second_owner@localhost.com",
+    ts: 1552747600152,
+    status: "active",
+    profile: {
+
+    },
+    groups: [
+        "owner"
+    ],
+    config: {
+        packages: {
+
+        },
+        keys: {
+
+        },
+        allowedTenants: [
+            {
+                tenant: {
+                    id: "THYME_tID",
+                    code: "THYME_CODE",
+                    pin: {
+                        code: "5678",
+                        allowed: true
+                    }
+                },
+                groups: [
+                    "waiter"
+                ]
+            },
+            {
+                tenant: {
+                    id: "ELVIRA_tID",
+                    code: "ELVIRA_CODE"
+                },
+                groups: [
+                    "manager"
+                ]
+            }
+        ]
+    },
+    tenant: {
+        id: "5c0e74ba9acc3c5a84a51259",
+        code: "DBTN",
+        pin: {
+            code: "1235",
+            allowed: true
+        }
+    },
+    lastLogin: 1559836949372
+};
+
+module.exports = user;