reverse-proxy-middleware 0.0.52 → 0.0.53

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/index.js +1 -1
  2. package/package.json +2 -1
  3. package/readme.md +314 -25
  4. package/type.d.ts +6 -4
package/index.js CHANGED
@@ -1,3 +1,3 @@
1
1
  #!/usr/bin/env node
2
2
  // -*- coding: utf-8 -*-
3
- 'use strict';if(typeof module!=='undefined'&&module!==null&&eval('typeof require')!=='undefined'&&eval('require')!==null&&'main'in eval('require')&&eval('typeof require.main')!=='undefined'&&eval('require.main')!==null){var ORIGINAL_MAIN_MODULE=module;if(module!==eval('require.main')&&'paths'in module&&'paths'in eval('require.main')&&typeof __dirname!=='undefined'&&__dirname!==null)module.paths=eval('require.main.paths').concat(module.paths.filter(function(path){return eval('require.main.paths').includes(path)}))};if(module===eval('require.main'))module.paths.unshift('/application/node_modules');(()=>{"use strict";var __webpack_modules__=[(e,r,t)=>{t.d(r,{addParsedContentToRequest:()=>h,applyStateAPIs:()=>E,default:()=>P,determineForwarder:()=>O,resolveForwarders:()=>v});const n=require("@babel/runtime/helpers/extends");var o=t.n(n),_=t(1),a=t.n(_),s=t(2),i=t.n(s),u=t(3),c=t.n(u);const p=require("net"),l=require("tls");function f(e,r){var t="undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(t)return(t=t.call(e)).next.bind(t);if(Array.isArray(e)||(t=function(e,r){if(e){if("string"==typeof e)return d(e,r);var t=Object.prototype.toString.call(e).slice(8,-1);return"Object"===t&&e.constructor&&(t=e.constructor.name),"Map"===t||"Set"===t?Array.from(e):"Arguments"===t||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t)?d(e,r):void 0}}(e))||r&&e&&"number"==typeof e.length){t&&(e=t);var n=0;return function(){return n>=e.length?{done:!0}:{done:!1,value:e[n++]}}}throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}function d(e,r){(null==r||r>e.length)&&(r=e.length);for(var t=0,n=Array(r);t<r;t++)n[t]=e[t];return n}var b=["data","error","request","response","stateAPIs","Tools"],E=function(){var e=a()(i().mark((function e(r,t,n){var o,_,a,s,u,p,l,d,b,E,O,v,h,m,P;return i().wrap((function(e){for(;;)switch(e.prev=e.next){case 0:o={},_=f(n.stateAPIs);case 2:if((a=_()).done){e.next=66;break}s=a.value,o[s.name]={configuration:s,error:null,response:null},u=!1,p=1,l=f(s.expressions.pre);case 8:if((d=l()).done){e.next=29;break}b=d.value,E="break";try{E=b(s.data,null,r,t,o,c())}catch(e){console.warn("Failed running pre "+p+". expression of state api:",e)}if("number"!=typeof E){e.next=17;break}return console.info('Break request caused by state api "'+s.name+'" with status code '+E+"."),t.statusCode=E,t.end(),e.abrupt("return",{result:!1,scope:o});case 17:if("break"!==E){e.next=19;break}return e.abrupt("break",29);case 19:if("continue"!==E){e.next=21;break}return e.abrupt("continue",27);case 21:if(!E){e.next=25;break}u=!0,e.next=26;break;case 25:return e.abrupt("break",29);case 26:p+=1;case 27:e.next=8;break;case 29:if(!u){e.next=64;break}return console.info("Use state api:",c().represent(s)),O=null,e.prev=32,e.next=35,fetch(s.url,s.options);case 35:return o[s.name].response=e.sent,e.next=38,o[s.name].response.json();case 38:o[s.name].response.data=e.sent,e.next=45;break;case 41:e.prev=41,e.t0=e.catch(32),O=e.t0,console.warn('State api "'+s.name+'" throws error:',O);case 45:console.info("State api response is:",c().represent(o[s.name].response)),p=1,v=f(s.expressions.post);case 48:if((h=v()).done){e.next=64;break}m=h.value,P="break";try{P=m(s.data,O,r,t,o,c())}catch(e){console.warn("Failed running "+p+". post expression of state api:",e)}if("number"!=typeof P){e.next=57;break}return console.info('Break request caused by state api "'+s.name+'" with status code '+P+"."),t.statusCode=P,t.end(),e.abrupt("return",{result:!1,scope:o});case 57:if("break"!==P){e.next=59;break}return e.abrupt("break",64);case 59:if("continue"!==P){e.next=61;break}return e.abrupt("continue",62);case 61:p+=1;case 62:e.next=48;break;case 64:e.next=2;break;case 66:return e.abrupt("return",{result:!0,scope:o});case 67:case"end":return e.stop()}}),e,null,[[32,41]])})));return function(){return e.apply(this,arguments)}}(),O=function(e,r,t){for(var n,o=f(Object.entries(t).sort((function(e,r){var t=e[0],n=r[0];return t.localeCompare(n)})));!(n=o()).done;){var _,a=n.value,s=a[0],i=a[1];if(i.useExpression(i,null,e,r,((_={})[s]={configuration:i,error:null,response:null},_),c()))return console.info('Determined forwarder "'+s+'".'),i}return null},v=function(e){for(var r={},t=0,n=Object.entries(e);t<n.length;t++){var _=n[t],a=_[0],s=_[1];if("base"!==a){for(var i,u=c().extend(!0,{name:a},c().modifyObject(c().copy(e.base),s),s),p={retrieve:[],send:[]},l=f(["retrieve","send"]);!(i=l()).done;)for(var d,E=i.value,O=function(){var e=d.value,r=o()({},e,{sourceRun:function(){return""},targetRun:function(){return""}});if(Object.prototype.hasOwnProperty.call(r,"source"))if(r.source instanceof RegExp)r.sourceRun=function(){return r.source};else if("string"==typeof r.source){var t=c().stringCompile(r.source,b);if(t.error)throw new Error(t.error);r.sourceRun=t.templateFunction}else r.sourceRun=r.source;if(Object.prototype.hasOwnProperty.call(r,"target"))if("string"==typeof r.target){var n=c().stringCompile(r.target,b);if(n.error)throw new Error(n.error);r.targetRun=n.templateFunction}else r.targetRun=r.target;p[E].push(r)},v=f([].concat(u.headerTransformations[E]));!(d=v()).done;)O();u.headerTransformations=p;for(var h,m,P=[],y=[].concat(u.stateAPIs||[]),k=y.filter((function(e){return"base"===e.name}))[0],w=[],A=f(y);!(h=A()).done;)"base"!==(m=h.value).name&&w.push(c().extend(!0,{},c().modifyObject(c().copy(k),m),m));for(var I=0,M=w;I<M.length;I++){for(var D,g=M[I],T={pre:[],post:[]},R=f([].concat((null==(C=g.expressions)?void 0:C.pre)||[]));!(D=R()).done;){var C,x=D.value;if("string"==typeof x){var U=c().stringCompile(x,b);if(U.error)throw new Error(U.error);T.pre.push(U.templateFunction)}else T.pre.push(x)}for(var q,L=f([].concat((null==(B=g.expressions)?void 0:B.post)||[]));!(q=L()).done;){var B,S=q.value;if("string"==typeof S){var K=c().stringCompile(S,b);if(K.error)throw new Error(K.error);T.post.push(K.templateFunction)}else T.post.push(S)}g.expressions=T,P.push(g)}if(u.stateAPIs=P,"string"==typeof u.useExpression){var W=c().stringCompile(u.useExpression,b);if(W.error)throw new Error(W.error);u.useExpression=W.templateFunction}r[a]=u}}return r},h=function(e){if("application/json"===e.headers["content-type"])try{var r=Buffer.concat(e.socket.buffer.data).toString();e.socket.buffer.body=r.replace(/^[\s\S]+\s*\n\s*\n\s*([\s\S]+)$/m,"$1"),e.socket.buffer.content=JSON.parse(e.socket.buffer.body)}catch(r){console.warn("Error parsing given request.",e)}},m=function(e,r,t){for(var n,o=function(){var r=n.value;try{var o=r.sourceRun.apply(r,t),_=r.targetRun.apply(r,t);if([null,void 0].includes(o)||"string"==typeof o&&""===o.trim()){if([null,void 0].includes(_)||"string"==typeof _&&""===_.trim())return"continue";e=e.replace(/(\s*\n)\s*\n\s*/,(function(e,r){for(var t=arguments.length,n=Array(2<t?t-2:0),o=2;o<t;o++)n[o-2]=arguments[o];var a="string"==typeof _?_:_.apply(void 0,[e,r].concat(n));return""+r+a+e}))}else console.debug('Search for "'+o+'" and replace with',c().represent(_)+"."),e=e.replace(o,_)}catch(e){console.warn("Could not apply header transformation with source "+(r.source?c().represent(r.source):'"add"')+" and replacement "+(r.target?c().represent(r.target):'"remove"')+":",e)}},_=f(r);!(n=_()).done;)o();return e};const P=function(e,r,t,n){var _=r.socket,a=t.tls?l.connect:p.createConnection,s=t.tls&&443!==t.port||!t.tls&&80!==t.port?":"+t.port:"",i=a(o()({host:t.host,port:t.port},t.tls?{servername:t.host,rejectUnauthorized:!1}:{}),(function(){console.info("Proxy to: http"+(t.tls?"s":"")+"://"+t.host+s)}));i.on("error",(function(e){console.error("Proxy to server error",e)}));var u=[{clientSocket:_,serverSocket:i},null,e,r,n,c()];if(t.headerTransformations.retrieve.length){var d=!1;i.on("data",(function(e){if(d)_.write(e);else{var r=e.toString();console.info("Got response header from backend:\n"+r),r=m(r,t.headerTransformations.retrieve,u),console.info("Send response header to client:\n"+r),_.write(r),d=!0}}))}else i.pipe(_);i.on("connect",(function(){for(var r,n,o=!1,_=f(e.socket.buffer.data);!(r=_()).done;)if(n=r.value,o)i.write(n);else{var a=n.toString();console.info("Got request header from client:\n"+a),t.tls&&(a=a.replace(/HTTP\/1\.0/i,"HTTP/1.1")),a=a.replace(/(($|\n)host: )[^\n]+/i,"$1"+t.host+s),a=m(a,t.headerTransformations.send,u),console.info("Send request header to backend:\n"+a),i.write(a),o=!0}}))}},e=>{e.exports=require("@babel/runtime/helpers/asyncToGenerator")},e=>{e.exports=require("@babel/runtime/regenerator")},e=>{e.exports=require("clientnode")},(module,__webpack_exports__,__webpack_require__)=>{__webpack_require__.r(__webpack_exports__),__webpack_require__.d(__webpack_exports__,{default:()=>__WEBPACK_DEFAULT_EXPORT__});var _babel_runtime_helpers_asyncToGenerator__WEBPACK_IMPORTED_MODULE_0__=__webpack_require__(1),_babel_runtime_helpers_asyncToGenerator__WEBPACK_IMPORTED_MODULE_0___default=__webpack_require__.n(_babel_runtime_helpers_asyncToGenerator__WEBPACK_IMPORTED_MODULE_0__),_babel_runtime_regenerator__WEBPACK_IMPORTED_MODULE_1__=__webpack_require__(2),_babel_runtime_regenerator__WEBPACK_IMPORTED_MODULE_1___default=__webpack_require__.n(_babel_runtime_regenerator__WEBPACK_IMPORTED_MODULE_1__),clientnode__WEBPACK_IMPORTED_MODULE_2__=__webpack_require__(3),clientnode__WEBPACK_IMPORTED_MODULE_2___default=__webpack_require__.n(clientnode__WEBPACK_IMPORTED_MODULE_2__),http__WEBPACK_IMPORTED_MODULE_3__=__webpack_require__(5),http__WEBPACK_IMPORTED_MODULE_3___default=__webpack_require__.n(http__WEBPACK_IMPORTED_MODULE_3__),http2__WEBPACK_IMPORTED_MODULE_4__=__webpack_require__(6),http2__WEBPACK_IMPORTED_MODULE_4___default=__webpack_require__.n(http2__WEBPACK_IMPORTED_MODULE_4__),path__WEBPACK_IMPORTED_MODULE_5__=__webpack_require__(7),path__WEBPACK_IMPORTED_MODULE_5___default=__webpack_require__.n(path__WEBPACK_IMPORTED_MODULE_5__),_helper__WEBPACK_IMPORTED_MODULE_6__=__webpack_require__(0),_package_json__WEBPACK_IMPORTED_MODULE_7__=__webpack_require__(8);function _createForOfIteratorHelperLoose(e,r){var t="undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(t)return(t=t.call(e)).next.bind(t);if(Array.isArray(e)||(t=_unsupportedIterableToArray(e))||r&&e&&"number"==typeof e.length){t&&(e=t);var n=0;return function(){return n>=e.length?{done:!0}:{done:!1,value:e[n++]}}}throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}function _unsupportedIterableToArray(e,r){if(e){if("string"==typeof e)return _arrayLikeToArray(e,r);var t=Object.prototype.toString.call(e).slice(8,-1);return"Object"===t&&e.constructor&&(t=e.constructor.name),"Map"===t||"Set"===t?Array.from(e):"Arguments"===t||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t)?_arrayLikeToArray(e,r):void 0}}function _arrayLikeToArray(e,r){(null==r||r>e.length)&&(r=e.length);for(var t=0,n=Array(r);t<r;t++)n[t]=e[t];return n}module=__webpack_require__.hmd(module);for(var _step,onIncomingMessage=function(e,r){var t=e;_babel_runtime_helpers_asyncToGenerator__WEBPACK_IMPORTED_MODULE_0___default()(_babel_runtime_regenerator__WEBPACK_IMPORTED_MODULE_1___default().mark((function e(){var n,o,_,a;return _babel_runtime_regenerator__WEBPACK_IMPORTED_MODULE_1___default().wrap((function(e){for(;;)switch(e.prev=e.next){case 0:return e.next=3,clientnode__WEBPACK_IMPORTED_MODULE_2___default().timeout();case 3:if(!t.socket.buffer.finished){e.next=5;break}return e.abrupt("break",7);case 5:e.next=0;break;case 7:if(CONFIGURATION.parseBody&&(0,_helper__WEBPACK_IMPORTED_MODULE_6__.addParsedContentToRequest)(t),null!==(n=(0,_helper__WEBPACK_IMPORTED_MODULE_6__.determineForwarder)(t,r,FORWARDERS))){e.next=14;break}return console.error("No forwarder found for given request:",t),r.statusCode=502,r.end(),e.abrupt("return");case 14:return e.next=16,(0,_helper__WEBPACK_IMPORTED_MODULE_6__.applyStateAPIs)(t,r,n);case 16:o=e.sent,_=o.result,a=o.scope,_&&(0,_helper__WEBPACK_IMPORTED_MODULE_6__.default)(t,r,n,a);case 20:case"end":return e.stop()}}),e)})))()},onIncomingStream=function(e,r){console.info("Got stream",e,r)},BASE_CONFIGURATION=_package_json__WEBPACK_IMPORTED_MODULE_7__.DN,_iterator=_createForOfIteratorHelperLoose(["configuration.json","secure-configuration.json"]);!(_step=_iterator()).done;){var path=_step.value,configurationPath=(0,path__WEBPACK_IMPORTED_MODULE_5__.resolve)(process.cwd(),path);if(clientnode__WEBPACK_IMPORTED_MODULE_2___default().isFileSync(configurationPath)){var configuration=eval("require('"+configurationPath+"')");clientnode__WEBPACK_IMPORTED_MODULE_2___default().extend(!0,clientnode__WEBPACK_IMPORTED_MODULE_2___default().modifyObject(BASE_CONFIGURATION,configuration),configuration)}}var CONFIGURATION=clientnode__WEBPACK_IMPORTED_MODULE_2___default().evaluateDynamicData(BASE_CONFIGURATION,{configuration:BASE_CONFIGURATION,environment:process.env,Tools:clientnode__WEBPACK_IMPORTED_MODULE_2___default()}),FORWARDERS=(0,_helper__WEBPACK_IMPORTED_MODULE_6__.resolveForwarders)(CONFIGURATION.forwarders),server={instance:CONFIGURATION.publicKeyPath&&CONFIGURATION.privateKeyPath?(0,http2__WEBPACK_IMPORTED_MODULE_4__.createSecureServer)(CONFIGURATION.nodeServerOptions,onIncomingMessage):(0,http__WEBPACK_IMPORTED_MODULE_3__.createServer)(onIncomingMessage),streams:[],sockets:[],start:function(){server.instance.listen(CONFIGURATION.port,(function(){return console.info("Listen on port "+CONFIGURATION.port+" for incoming requests.")}))},stop:function(){server.instance.close((function(){console.info("Shut server down.")}));for(var e,r=0,t=[server.sockets,server.streams];r<t.length;r++)if(e=t[r],Array.isArray(e))for(var n,o=_createForOfIteratorHelperLoose(e);!(n=o()).done;)n.value.destroy()}};if(server.instance.on("connection",(function(e){server.sockets.push(e),e.buffer={data:[],finished:!1},e.on("data",(function(r){e.buffer.data.push(r)}));for(var r,t=0,n=["done","finish","writableEnded","writableFinished"];t<n.length;t++)r=n[t],e.on(r,(function(){e.buffer.finished=!0}));clientnode__WEBPACK_IMPORTED_MODULE_2___default().timeout((function(){e.buffer.finished=!0})),e.on("close",(function(){e.buffer.finished=!0,server.sockets.splice(server.sockets.indexOf(e),1)}))})),server.instance.on("stream",(function(e,r){server.streams.push(e),onIncomingStream(e,r),e.on("close",(function(){server.streams.splice(server.streams.indexOf(e),1)}))})),__webpack_require__.c[__webpack_require__.s]===module||eval("require.main")!==__webpack_require__.c[__webpack_require__.s]&&"undefined"!=typeof ORIGINAL_MAIN_MODULE&&ORIGINAL_MAIN_MODULE===eval("require.main")){console.info("Start server with configuration:",clientnode__WEBPACK_IMPORTED_MODULE_2___default().represent(CONFIGURATION)),console.debug("Apply resolved forwarder:",clientnode__WEBPACK_IMPORTED_MODULE_2___default().represent(FORWARDERS)),server.start();for(var _step3,_loop=function(){var e=_step3.value;process.on(e,(function(){console.info('\nGot "'+e+'" signal: stopping server.'),server.stop()}))},_iterator3=_createForOfIteratorHelperLoose(clientnode__WEBPACK_IMPORTED_MODULE_2__.CloseEventNames);!(_step3=_iterator3()).done;)_loop()}const __WEBPACK_DEFAULT_EXPORT__=server},e=>{e.exports=require("http")},e=>{e.exports=require("http2")},e=>{e.exports=require("path")},e=>{e.exports=JSON.parse('{"DN":{"publicKeyPath":"","privateKeyPath":"","nodeServerOptions":{"allowHTTP1":true},"host":"localhost","port":8080,"parseBody":false,"forwarders":{"base":{"headerTransformations":{"retrieve":[],"send":[]},"host":"localhost","port":443,"stateAPIs":[{"data":{},"expressions":{"pre":"false","post":"true"},"name":"base","options":{},"url":""}],"tls":true,"useExpression":"true"}}}}')}],__webpack_module_cache__={};function __webpack_require__(e){var r=__webpack_module_cache__[e];if(void 0!==r)return r.exports;var t=__webpack_module_cache__[e]={id:e,loaded:!1,exports:{}};return __webpack_modules__[e](t,t.exports,__webpack_require__),t.loaded=!0,t.exports}__webpack_require__.c=__webpack_module_cache__,__webpack_require__.n=e=>{var r=e&&e.__esModule?()=>e.default:()=>e;return __webpack_require__.d(r,{a:r}),r},__webpack_require__.d=(e,r)=>{for(var t in r)__webpack_require__.o(r,t)&&!__webpack_require__.o(e,t)&&Object.defineProperty(e,t,{enumerable:!0,get:r[t]})},__webpack_require__.hmd=e=>((e=Object.create(e)).children||(e.children=[]),Object.defineProperty(e,"exports",{enumerable:!0,set:()=>{throw new Error("ES Modules may not assign module.exports or exports.*, Use ESM export syntax, instead: "+e.id)}}),e),__webpack_require__.o=(e,r)=>Object.prototype.hasOwnProperty.call(e,r),__webpack_require__.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var __webpack_exports__=__webpack_require__(__webpack_require__.s=4);module.exports=__webpack_exports__})();
3
+ 'use strict';if(typeof module!=='undefined'&&module!==null&&eval('typeof require')!=='undefined'&&eval('require')!==null&&'main'in eval('require')&&eval('typeof require.main')!=='undefined'&&eval('require.main')!==null){var ORIGINAL_MAIN_MODULE=module;if(module!==eval('require.main')&&'paths'in module&&'paths'in eval('require.main')&&typeof __dirname!=='undefined'&&__dirname!==null)module.paths=eval('require.main.paths').concat(module.paths.filter(function(path){return eval('require.main.paths').includes(path)}))};if(module===eval('require.main'))module.paths.unshift('/application/node_modules');(()=>{"use strict";var __webpack_modules__=[(e,r,t)=>{t.d(r,{addParsedContentToRequest:()=>h,applyStateAPIs:()=>E,default:()=>P,determineForwarder:()=>O,resolveForwarders:()=>v});const n=require("@babel/runtime/helpers/extends");var o=t.n(n),_=t(1),a=t.n(_),s=t(2),i=t.n(s),c=t(3),u=t.n(c);const p=require("net"),l=require("tls");function f(e,r){var t="undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(t)return(t=t.call(e)).next.bind(t);if(Array.isArray(e)||(t=function(e,r){if(e){if("string"==typeof e)return d(e,r);var t=Object.prototype.toString.call(e).slice(8,-1);return"Object"===t&&e.constructor&&(t=e.constructor.name),"Map"===t||"Set"===t?Array.from(e):"Arguments"===t||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t)?d(e,r):void 0}}(e))||r&&e&&"number"==typeof e.length){t&&(e=t);var n=0;return function(){return n>=e.length?{done:!0}:{done:!1,value:e[n++]}}}throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}function d(e,r){(null==r||r>e.length)&&(r=e.length);for(var t=0,n=Array(r);t<r;t++)n[t]=e[t];return n}var b=["data","error","request","response","stateAPIs","Tools"],E=function(){var e=a()(i().mark((function e(r,t,n){var o,_,a,s,c,p,l,d,b,E,O,v,h,m,P;return i().wrap((function(e){for(;;)switch(e.prev=e.next){case 0:o={},_=f(n.stateAPIs);case 2:if((a=_()).done){e.next=71;break}s=a.value,o[s.name]={configuration:s,error:null,response:null},c=!1,p=1,l=f(s.expressions.pre);case 8:if((d=l()).done){e.next=28;break}b=d.value,E=void 0;try{E=b(s.data,null,r,t,o,u())}catch(e){console.warn("Failed running pre "+p+". expression of state api:",e)}if("number"!=typeof E){e.next=17;break}return console.info('Break request caused by state api "'+s.name+'" with status code '+E+"."),t.statusCode=E,t.end(),e.abrupt("return",{result:!1,scope:o});case 17:if("break"!==E){e.next=19;break}return e.abrupt("break",28);case 19:if(p+=1,"boolean"!=typeof E){e.next=26;break}if(!E){e.next=25;break}c=!0,e.next=26;break;case 25:return e.abrupt("break",28);case 26:e.next=8;break;case 28:if(!c){e.next=69;break}return console.info("Use state api:",u().represent(s)),O=null,e.prev=31,e.next=34,fetch(s.url,s.options);case 34:o[s.name].response=e.sent,e.next=41;break;case 37:e.prev=37,e.t0=e.catch(31),O=e.t0,console.warn('Running state api request for "'+s.name+'" throws',"error:",O);case 41:if(!o[s.name].response||!o[s.name].response.headers.has("content-type")||"application/json"!==o[s.name].response.headers.get("content-type")[0]){e.next=52;break}return e.prev=42,e.next=45,o[s.name].response.json();case 45:o[s.name].response.data=e.sent,e.next=52;break;case 48:e.prev=48,e.t1=e.catch(42),O=e.t1,console.warn("Parsing state api json response for",'"'+s.name+'" throws error:',O);case 52:console.info("State api response is:",u().represent(o[s.name].response)),p=1,v=f(s.expressions.post);case 55:if((h=v()).done){e.next=69;break}m=h.value,P=void 0;try{P=m(s.data,O,r,t,o,u())}catch(e){console.warn("Failed running "+p+". post expression of state api:",e)}if("number"!=typeof P){e.next=64;break}return console.info('Break request caused by state api "'+s.name+'" with status code '+P+"."),t.statusCode=P,t.end(),e.abrupt("return",{result:!1,scope:o});case 64:if("break"!==P){e.next=66;break}return e.abrupt("break",69);case 66:p+=1;case 67:e.next=55;break;case 69:e.next=2;break;case 71:return e.abrupt("return",{result:!0,scope:o});case 72:case"end":return e.stop()}}),e,null,[[31,37],[42,48]])})));return function(){return e.apply(this,arguments)}}(),O=function(e,r,t){for(var n,o=f(Object.entries(t).sort((function(e,r){var t=e[0],n=r[0];return t.localeCompare(n)})));!(n=o()).done;){var _,a=n.value,s=a[0],i=a[1];if(i.useExpression(i,null,e,r,((_={})[s]={configuration:i,error:null,response:null},_),u()))return console.info('Determined forwarder "'+s+'".'),i}return null},v=function(e){for(var r={},t=0,n=Object.entries(e);t<n.length;t++){var _=n[t],a=_[0],s=_[1];if("base"!==a){for(var i,c=u().extend(!0,{name:a},u().modifyObject(u().copy(e.base),s),s),p={retrieve:[],send:[]},l=f(["retrieve","send"]);!(i=l()).done;)for(var d,E=i.value,O=function(){var e=d.value,r=o()({},e,{sourceRun:function(){return""},targetRun:function(){return""}});if(Object.prototype.hasOwnProperty.call(r,"source"))if(r.source instanceof RegExp)r.sourceRun=function(){return r.source};else if("string"==typeof r.source){var t=u().stringCompile(r.source,b);if(t.error)throw new Error(t.error);r.sourceRun=t.templateFunction}else r.sourceRun=r.source;if(Object.prototype.hasOwnProperty.call(r,"target"))if("string"==typeof r.target){var n=u().stringCompile(r.target,b);if(n.error)throw new Error(n.error);r.targetRun=n.templateFunction}else r.targetRun=r.target;p[E].push(r)},v=f([].concat(c.headerTransformations[E]));!(d=v()).done;)O();c.headerTransformations=p;for(var h,m,P=[],y=[].concat(c.stateAPIs||[]),w=y.filter((function(e){return"base"===e.name}))[0],A=[],I=f(y);!(h=I()).done;)"base"!==(m=h.value).name&&A.push(u().extend(!0,{},u().modifyObject(u().copy(w),m),m));for(var M=0,k=A;M<k.length;M++){for(var D,g=k[M],T={pre:[],post:[]},R=f([].concat((null==(C=g.expressions)?void 0:C.pre)||[]));!(D=R()).done;){var C,x=D.value;if("string"==typeof x){var U=u().stringCompile(x,b);if(U.error)throw new Error(U.error);T.pre.push(U.templateFunction)}else T.pre.push(x)}for(var q,L=f([].concat((null==(B=g.expressions)?void 0:B.post)||[]));!(q=L()).done;){var B,S=q.value;if("string"==typeof S){var K=u().stringCompile(S,b);if(K.error)throw new Error(K.error);T.post.push(K.templateFunction)}else T.post.push(S)}g.expressions=T,P.push(g)}if(c.stateAPIs=P,"string"==typeof c.useExpression){var W=u().stringCompile(c.useExpression,b);if(W.error)throw new Error(W.error);c.useExpression=W.templateFunction}r[a]=c}}return r},h=function(e){if("application/json"===e.headers["content-type"])try{var r=Buffer.concat(e.socket.buffer.data).toString();e.socket.buffer.body=r.replace(/^[\s\S]+\s*\n\s*\n\s*([\s\S]+)$/m,"$1"),e.socket.buffer.content=JSON.parse(e.socket.buffer.body)}catch(r){console.warn("Error parsing given request.",e)}},m=function(e,r,t){for(var n,o=function(){var r=n.value;try{var o=r.sourceRun.apply(r,t),_=r.targetRun.apply(r,t);if([null,void 0].includes(o)||"string"==typeof o&&""===o.trim()){if([null,void 0].includes(_)||"string"==typeof _&&""===_.trim())return"continue";e=e.replace(/(\s*\n)\s*\n\s*/,(function(e,r){for(var t=arguments.length,n=Array(2<t?t-2:0),o=2;o<t;o++)n[o-2]=arguments[o];var a="string"==typeof _?_:_.apply(void 0,[e,r].concat(n));return""+r+a+e}))}else console.debug('Search for "'+o+'" and replace with',u().represent(_)+"."),e=e.replace(o,_)}catch(e){console.warn("Could not apply header transformation with source "+(r.source?u().represent(r.source):'"add"')+" and replacement "+(r.target?u().represent(r.target):'"remove"')+":",e)}},_=f(r);!(n=_()).done;)o();return e};const P=function(e,r,t,n){var _=r.socket,a=t.tls?l.connect:p.createConnection,s=t.tls&&443!==t.port||!t.tls&&80!==t.port?":"+t.port:"",i=a(o()({host:t.host,port:t.port},t.tls?{servername:t.host,rejectUnauthorized:!1}:{}),(function(){console.info("Proxy to: http"+(t.tls?"s":"")+"://"+t.host+s)}));i.on("error",(function(e){console.error("Proxy to server error",e)}));var c=[{clientSocket:_,serverSocket:i},null,e,r,n,u()];if(t.headerTransformations.retrieve.length){var d=!1;i.on("data",(function(e){if(d)_.write(e);else{var r=e.toString();console.info("Got response header from backend:\n"+r),r=m(r,t.headerTransformations.retrieve,c),console.info("Send response header to client:\n"+r),_.write(r),d=!0}}))}else i.pipe(_);i.on("connect",(function(){for(var r,n,o=!1,_=f(e.socket.buffer.data);!(r=_()).done;)if(n=r.value,o)i.write(n);else{var a=n.toString();console.info("Got request header from client:\n"+a),t.tls&&(a=a.replace(/HTTP\/1\.0/i,"HTTP/1.1")),a=a.replace(/(($|\n)host: )[^\n]+/i,"$1"+t.host+s),a=m(a,t.headerTransformations.send,c),console.info("Send request header to backend:\n"+a),i.write(a),o=!0}}))}},e=>{e.exports=require("@babel/runtime/helpers/asyncToGenerator")},e=>{e.exports=require("@babel/runtime/regenerator")},e=>{e.exports=require("clientnode")},(module,__webpack_exports__,__webpack_require__)=>{__webpack_require__.r(__webpack_exports__),__webpack_require__.d(__webpack_exports__,{default:()=>__WEBPACK_DEFAULT_EXPORT__});var _babel_runtime_helpers_asyncToGenerator__WEBPACK_IMPORTED_MODULE_0__=__webpack_require__(1),_babel_runtime_helpers_asyncToGenerator__WEBPACK_IMPORTED_MODULE_0___default=__webpack_require__.n(_babel_runtime_helpers_asyncToGenerator__WEBPACK_IMPORTED_MODULE_0__),_babel_runtime_regenerator__WEBPACK_IMPORTED_MODULE_1__=__webpack_require__(2),_babel_runtime_regenerator__WEBPACK_IMPORTED_MODULE_1___default=__webpack_require__.n(_babel_runtime_regenerator__WEBPACK_IMPORTED_MODULE_1__),clientnode__WEBPACK_IMPORTED_MODULE_2__=__webpack_require__(3),clientnode__WEBPACK_IMPORTED_MODULE_2___default=__webpack_require__.n(clientnode__WEBPACK_IMPORTED_MODULE_2__),http__WEBPACK_IMPORTED_MODULE_3__=__webpack_require__(5),http__WEBPACK_IMPORTED_MODULE_3___default=__webpack_require__.n(http__WEBPACK_IMPORTED_MODULE_3__),http2__WEBPACK_IMPORTED_MODULE_4__=__webpack_require__(6),http2__WEBPACK_IMPORTED_MODULE_4___default=__webpack_require__.n(http2__WEBPACK_IMPORTED_MODULE_4__),path__WEBPACK_IMPORTED_MODULE_5__=__webpack_require__(7),path__WEBPACK_IMPORTED_MODULE_5___default=__webpack_require__.n(path__WEBPACK_IMPORTED_MODULE_5__),_helper__WEBPACK_IMPORTED_MODULE_6__=__webpack_require__(0),_package_json__WEBPACK_IMPORTED_MODULE_7__=__webpack_require__(8);function _createForOfIteratorHelperLoose(e,r){var t="undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(t)return(t=t.call(e)).next.bind(t);if(Array.isArray(e)||(t=_unsupportedIterableToArray(e))||r&&e&&"number"==typeof e.length){t&&(e=t);var n=0;return function(){return n>=e.length?{done:!0}:{done:!1,value:e[n++]}}}throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}function _unsupportedIterableToArray(e,r){if(e){if("string"==typeof e)return _arrayLikeToArray(e,r);var t=Object.prototype.toString.call(e).slice(8,-1);return"Object"===t&&e.constructor&&(t=e.constructor.name),"Map"===t||"Set"===t?Array.from(e):"Arguments"===t||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t)?_arrayLikeToArray(e,r):void 0}}function _arrayLikeToArray(e,r){(null==r||r>e.length)&&(r=e.length);for(var t=0,n=Array(r);t<r;t++)n[t]=e[t];return n}module=__webpack_require__.hmd(module);for(var _step,onIncomingMessage=function(e,r){var t=e;_babel_runtime_helpers_asyncToGenerator__WEBPACK_IMPORTED_MODULE_0___default()(_babel_runtime_regenerator__WEBPACK_IMPORTED_MODULE_1___default().mark((function e(){var n,o,_,a;return _babel_runtime_regenerator__WEBPACK_IMPORTED_MODULE_1___default().wrap((function(e){for(;;)switch(e.prev=e.next){case 0:return e.next=3,clientnode__WEBPACK_IMPORTED_MODULE_2___default().timeout();case 3:if(!t.socket.buffer.finished){e.next=5;break}return e.abrupt("break",7);case 5:e.next=0;break;case 7:if(CONFIGURATION.parseBody&&(0,_helper__WEBPACK_IMPORTED_MODULE_6__.addParsedContentToRequest)(t),null!==(n=(0,_helper__WEBPACK_IMPORTED_MODULE_6__.determineForwarder)(t,r,FORWARDERS))){e.next=14;break}return console.error("No forwarder found for given request:",t),r.statusCode=502,r.end(),e.abrupt("return");case 14:return e.next=16,(0,_helper__WEBPACK_IMPORTED_MODULE_6__.applyStateAPIs)(t,r,n);case 16:o=e.sent,_=o.result,a=o.scope,_&&(0,_helper__WEBPACK_IMPORTED_MODULE_6__.default)(t,r,n,a);case 20:case"end":return e.stop()}}),e)})))()},onIncomingStream=function(e,r){console.info("Got stream",e,r)},BASE_CONFIGURATION=_package_json__WEBPACK_IMPORTED_MODULE_7__.DN,_iterator=_createForOfIteratorHelperLoose(["configuration.json","secure-configuration.json"]);!(_step=_iterator()).done;){var path=_step.value,configurationPath=(0,path__WEBPACK_IMPORTED_MODULE_5__.resolve)(process.cwd(),path);if(clientnode__WEBPACK_IMPORTED_MODULE_2___default().isFileSync(configurationPath)){var configuration=eval("require('"+configurationPath+"')");clientnode__WEBPACK_IMPORTED_MODULE_2___default().extend(!0,clientnode__WEBPACK_IMPORTED_MODULE_2___default().modifyObject(BASE_CONFIGURATION,configuration),configuration)}}var CONFIGURATION=clientnode__WEBPACK_IMPORTED_MODULE_2___default().evaluateDynamicData(BASE_CONFIGURATION,{configuration:BASE_CONFIGURATION,environment:process.env,Tools:clientnode__WEBPACK_IMPORTED_MODULE_2___default()}),FORWARDERS=(0,_helper__WEBPACK_IMPORTED_MODULE_6__.resolveForwarders)(CONFIGURATION.forwarders),server={instance:CONFIGURATION.publicKeyPath&&CONFIGURATION.privateKeyPath?(0,http2__WEBPACK_IMPORTED_MODULE_4__.createSecureServer)(CONFIGURATION.nodeServerOptions,onIncomingMessage):(0,http__WEBPACK_IMPORTED_MODULE_3__.createServer)(onIncomingMessage),streams:[],sockets:[],start:function(){server.instance.listen(CONFIGURATION.port,(function(){return console.info("Listen on port "+CONFIGURATION.port+" for incoming requests.")}))},stop:function(){server.instance.close((function(){console.info("Shut server down.")}));for(var e,r=0,t=[server.sockets,server.streams];r<t.length;r++)if(e=t[r],Array.isArray(e))for(var n,o=_createForOfIteratorHelperLoose(e);!(n=o()).done;)n.value.destroy()}};if(server.instance.on("connection",(function(e){server.sockets.push(e),e.buffer={data:[],finished:!1},e.on("data",(function(r){e.buffer.data.push(r)}));for(var r,t=0,n=["done","finish","writableEnded","writableFinished"];t<n.length;t++)r=n[t],e.on(r,(function(){e.buffer.finished=!0}));clientnode__WEBPACK_IMPORTED_MODULE_2___default().timeout((function(){e.buffer.finished=!0})),e.on("close",(function(){e.buffer.finished=!0,server.sockets.splice(server.sockets.indexOf(e),1)}))})),server.instance.on("stream",(function(e,r){server.streams.push(e),onIncomingStream(e,r),e.on("close",(function(){server.streams.splice(server.streams.indexOf(e),1)}))})),__webpack_require__.c[__webpack_require__.s]===module||eval("require.main")!==__webpack_require__.c[__webpack_require__.s]&&"undefined"!=typeof ORIGINAL_MAIN_MODULE&&ORIGINAL_MAIN_MODULE===eval("require.main")){console.info("Start server with configuration:",clientnode__WEBPACK_IMPORTED_MODULE_2___default().represent(CONFIGURATION)),console.debug("Apply resolved forwarder:",clientnode__WEBPACK_IMPORTED_MODULE_2___default().represent(FORWARDERS)),server.start();for(var _step3,_loop=function(){var e=_step3.value;process.on(e,(function(){console.info('\nGot "'+e+'" signal: stopping server.'),server.stop()}))},_iterator3=_createForOfIteratorHelperLoose(clientnode__WEBPACK_IMPORTED_MODULE_2__.CloseEventNames);!(_step3=_iterator3()).done;)_loop()}const __WEBPACK_DEFAULT_EXPORT__=server},e=>{e.exports=require("http")},e=>{e.exports=require("http2")},e=>{e.exports=require("path")},e=>{e.exports=JSON.parse('{"DN":{"publicKeyPath":"","privateKeyPath":"","nodeServerOptions":{"allowHTTP1":true},"host":"localhost","port":8080,"parseBody":false,"forwarders":{"base":{"headerTransformations":{"retrieve":[],"send":[]},"host":"localhost","port":443,"stateAPIs":[{"data":{},"expressions":{"pre":"false","post":"true"},"name":"base","options":{},"url":""}],"tls":true,"useExpression":"true"}}}}')}],__webpack_module_cache__={};function __webpack_require__(e){var r=__webpack_module_cache__[e];if(void 0!==r)return r.exports;var t=__webpack_module_cache__[e]={id:e,loaded:!1,exports:{}};return __webpack_modules__[e](t,t.exports,__webpack_require__),t.loaded=!0,t.exports}__webpack_require__.c=__webpack_module_cache__,__webpack_require__.n=e=>{var r=e&&e.__esModule?()=>e.default:()=>e;return __webpack_require__.d(r,{a:r}),r},__webpack_require__.d=(e,r)=>{for(var t in r)__webpack_require__.o(r,t)&&!__webpack_require__.o(e,t)&&Object.defineProperty(e,t,{enumerable:!0,get:r[t]})},__webpack_require__.hmd=e=>((e=Object.create(e)).children||(e.children=[]),Object.defineProperty(e,"exports",{enumerable:!0,set:()=>{throw new Error("ES Modules may not assign module.exports or exports.*, Use ESM export syntax, instead: "+e.id)}}),e),__webpack_require__.o=(e,r)=>Object.prototype.hasOwnProperty.call(e,r),__webpack_require__.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var __webpack_exports__=__webpack_require__(__webpack_require__.s=4);module.exports=__webpack_exports__})();
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "reverse-proxy-middleware",
3
- "version": "0.0.52",
3
+ "version": "0.0.53",
4
4
  "description": "A reverse proxy blocking bot requests.",
5
5
  "keywords": [
6
6
  "api",
@@ -50,6 +50,7 @@
50
50
  "serve:headers": "ln --force --symbolic examples/headers.json configuration.json && yarn serve",
51
51
  "serve:random": "ln --force --symbolic examples/random.json configuration.json && yarn serve",
52
52
  "serve:simple": "ln --force --symbolic examples/simple.json configuration.json && yarn serve",
53
+ "serve:state-apis": "ln --force --symbolic examples/state-apis.json configuration.json && yarn serve",
53
54
  "start": "./index.js",
54
55
  "test": "weboptimizer test",
55
56
  "test:coverage": "weboptimizer test:coverage",
package/readme.md CHANGED
@@ -73,6 +73,7 @@ Here is how to distribute incoming requests randomly between google and bing:
73
73
  "host": "www.bing.com",
74
74
  "useExpression": "Math.random() < 0.5"
75
75
  },
76
+
76
77
  "google": {
77
78
  "host": "www.google.com"
78
79
  }
@@ -87,55 +88,343 @@ outcome of bing's expression if it is beeing used or not.
87
88
  Since this proxy just streams the whole request through it could be used as
88
89
  basic load balancer with this configuration.
89
90
 
90
- #### Rewriting headers for underlying backend
91
+ ### Rewriting headers for underlying backend
91
92
 
92
93
  Headers can be replaced in both directions. Client-Request to forward or
93
94
  retrieved responses given from configured backend:
94
95
 
95
- # TODO test
96
+ ```
97
+ {
98
+ "forwarders": {
99
+ "bing": {
100
+ "host": "www.bing.com",
101
+
102
+ "headerTransformations": {
103
+ "send": {
104
+ "source": "/X-Special-Client-Header-Name: (.+)/gi",
105
+ "target": "'New-Header-Name: $1'"
106
+ },
107
+
108
+ "retrieve": {
109
+ "source": "/set-cookie: (.+)/gi",
110
+ "target": "'X-Prevented-Cookie: $1'"
111
+ }
112
+ }
113
+ }
114
+ }
115
+ }
116
+ ```
117
+
118
+ Test via:
119
+
120
+ ```
121
+ curl \
122
+ --header 'X-Special-Client-Header-Name: value' \
123
+ --verbose \
124
+ http://localhost:8080 \
125
+ 1>/dev/null
126
+ ```
127
+
128
+ You should see a lot of cookie header ("set-cookie: ..." replaced by
129
+ "X-Prevented-Cookie: ...".
130
+ Note that muting the standart output ("1>/dev/null") enables you to focus on
131
+ retrieved headers printed via secondary error output.
132
+
133
+ ### State-APIs
134
+
135
+ State-APIs enables you to trigger requests conditionally to third party
136
+ endpoints and use responses for further expressions.
137
+ Expression which transform subsequent api requests, decide which backend to use
138
+ or transform the final backend request.
139
+
140
+ Here is an example:
96
141
 
97
142
  ```
98
143
  {
99
144
  "forwarders": {
100
145
  "bing": {
101
146
  "host": "www.bing.com",
147
+
148
+ "stateAPIs": {
149
+ "name": "sense",
150
+ "url": "https://www.google.com/search?q=${data.question}",
151
+
152
+ "data": {
153
+ "question": "What is the meaning of life?"
154
+ },
155
+
156
+ "expressions": {
157
+ "pre": "request.headers['ask-for-sense-of-live'] ? true : null",
158
+ "post": "response.statusCode >= 200 && response.statusCode < 300 ? null : response.statusCode"
159
+ }
160
+ }
161
+ }
162
+ }
163
+ }
164
+ ```
165
+
166
+ What is going on here?
167
+ We generally forward requests to "www.bing.com" but if there is a header called
168
+ "ask-for-sense-of-live" present in client request we will first ask google for
169
+ the meaning of life. If google answers with a "negative" response code not
170
+ between 200 and 300 we will just do the final forwarding to bing. If google
171
+ responses in a positive manner the resulting status code we will be used for
172
+ answering client and no forwarding to "www.bing.com" happens.
173
+
174
+ Here es a test curl command:
175
+
176
+ ```
177
+ curl \
178
+ --header 'ask-for-sense-of-live: value' \
179
+ --verbose \
180
+ http://localhost:8080 \
181
+ 1>/dev/null
182
+ ```
183
+
184
+ This should result in a simple response but:
185
+
186
+ ```curl --verbose http://localhost:8080 1>/dev/null```
187
+
188
+ will finally request "www.bing.com".
189
+
190
+ Pre and post evaluations can have various results. The meanings of them are
191
+ described here:
192
+
193
+ #### Pre-Evaluation Results
194
+
195
+ | Result | Meaning |
196
+ |-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
197
+ | break (string) | Do not evaluate subsequent pre evaluations. |
198
+ | null or undefined | Just jump to the next evaluation to run. |
199
+ | true (boolean) | Use this state api configuration. Run the configured request. |
200
+ | false (boolean) | Do not use this state api and to not run subsequent pre evaluations. |
201
+ | code (number) | Answer client request with provided http status code and do not run any subsequent pre-evaluations, state-api request or request forwarding to the underlying backend. |
202
+
203
+ #### Post-Evaluation Results
204
+
205
+ | Result | Meaning |
206
+ |-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
207
+ | break (string) | Do not evaluate subsequent post evaluations. |
208
+ | null or undefined | Just jump to the next evaluation to run. |
209
+ | code (number) | Answer client request with provided http status code and do not run any subsequent post-evaluations, state-api request or request forwarding to the underlying backend. |
210
+
211
+ ### Smart configurations
212
+
213
+ Whenever you can configure list of items you can either use just one or a list
214
+ of them. Consider this configuration example:
215
+
216
+ ```
217
+ {
218
+ "forwarders": {
219
+ "bing": {
220
+ "host": "www.bing.com",
221
+
222
+ "headerTransformations": [{...}, {...}, ...],
223
+
224
+ "stateAPIs": {
225
+ "expressions": {
226
+ "pre": ["...", "...", ...],
227
+ "post": ["...", "...", ...]
228
+ }
229
+ }
230
+ }
231
+ }
232
+ }
233
+ ```
234
+
235
+ If only one item is needed please consider that:
236
+
237
+ ```
238
+ {
239
+ "forwarders": {
240
+ "bing": {
241
+ "host": "www.bing.com",
242
+
243
+ "headerTransformations": [{...}],
244
+
245
+ "stateAPIs": {
246
+ "expressions": {
247
+ "pre": ["..."],
248
+ "post": ["..."]
249
+ }
250
+ }
251
+ }
252
+ }
253
+ }
254
+ ```
255
+
256
+ is equivalent to:
257
+
258
+ ```
259
+ {
260
+ "forwarders": {
261
+ "bing": {
262
+ "host": "www.bing.com",
263
+
264
+ "headerTransformations": {...},
265
+
266
+ "stateAPIs": {
267
+ "expressions": {
268
+ "pre": "...",
269
+ "post": "..."
270
+ }
271
+ }
272
+ }
273
+ }
274
+ }
275
+ ```
276
+
277
+ #### Use environment variables
278
+
279
+ While some configuration values are interpret as expression to be evalued at
280
+ runtime e.g. to decide which endpoint to use:
281
+
282
+ ```
283
+ {
284
+ "forwarders": {
285
+ "endpoint": {
286
+ ...
287
+ "useExpression": "..."
288
+ }
289
+ }
290
+ }
291
+ ```
292
+
293
+ Every item can utilize expression to dynamically derive intial configurations:
294
+
295
+ ```
296
+ {
297
+ "port": {
298
+ "__evaluate__": "environment.PORT ?? 8080"
299
+ },
300
+ ...
301
+ }
302
+ ```
303
+
304
+ If an environment variabel "PORT" is set it will be used or "8080" as a
305
+ fallback.
306
+
307
+ #### Use Base Forwarder
308
+
309
+ Base forwarder are inherited by every specific forwarder. This configuration:
310
+
311
+ ```
312
+ {
313
+ "forwarders": {
314
+ "base: {
102
315
  "headerTransformations": {
103
- "send": [
104
- {
105
- "source": "/X-Special-Client-Header-Name: (.+)/",
106
- "target": "'New-Header-Name: $1'"
107
- }
108
- ],
109
-
110
- "retrieve": [
111
- {
112
- "source": "/set-cookie: (.+)/",
113
- "target": "'X-Prevented-Cookie: $1'"
114
- }
115
- ]
316
+ "send": {
317
+ "source": "/(GET|POST) \\/.* (.*)/",
318
+ "target": "'$1 /sub/path/to/forward/to $2'"
319
+ }
116
320
  }
321
+ },
322
+
323
+ "bing": {
324
+ "host": "www.bing.com",
325
+ "useExpression": "Math.random() < 0.5"
326
+ },
327
+
328
+ "google": {
329
+ "host": "www.google.com"
117
330
  }
118
331
  }
119
332
  }
120
333
  ```
121
334
 
335
+ is equivalent to:
336
+
337
+ ```
338
+ {
339
+ "forwarders": {
340
+ "bing": {
341
+ "host": "www.bing.com",
342
+
343
+ "useExpression": "Math.random() < 0.5",
344
+
345
+ "headerTransformations": {
346
+ "send": {
347
+ "source": "/(GET|POST) \\/.* (.*)/",
348
+ "target": "'$1 /sub/path/to/forward/to $2'"
349
+ }
350
+ }
351
+ },
352
+
353
+ "google": {
354
+ "host": "www.google.com",
355
+
356
+ "headerTransformations": {
357
+ "send": {
358
+ "source": "/(GET|POST) \\/.* (.*)/",
359
+ "target": "'$1 /sub/path/to/forward/to $2'"
360
+ }
361
+ }
362
+ }
363
+ }
364
+ }
122
365
  ```
123
- curl \
124
- --header 'X-Special-Client-Header-Name: value' \
125
- --verbose \
126
- http://localhost:8080 \
127
- 1>/dev/null
366
+
367
+ #### Use base State-APIs
368
+
369
+ As we support generic base forwarder confgurations there are also base state
370
+ api configuraton sections. Consider the follwing configuration example:
371
+
128
372
  ```
373
+ {
374
+ "forwarders": {
375
+ "bing": {
376
+ "host": "www.bing.com",
129
377
 
130
- #### Validating request via external service
378
+ "stateAPIs": [
379
+ {
380
+ "name": "base",
381
+ "url": "https://www.google.com/search?q=${data.query}",
131
382
 
132
- To configure the middleware for providing a bot-filtering mechanism add a
133
- `configure.json` file and mount them into a docker container.
383
+ "expressions": {
384
+ "pre": "request.headers['ask-google'] ? true : null",
385
+ "post": "response.statusCode >= 200 && response.statusCode < 300 ? null : response.statusCode"
386
+ }
387
+ }
134
388
 
135
- ```JavaScript
136
- TODO
389
+ {
390
+ "name": "sense",
391
+
392
+ "data": {
393
+ "query": "What is the meaning of life?"
394
+ }
395
+ },
396
+
397
+ {
398
+ "name": "nonesense",
399
+
400
+ "data": {
401
+ "query": "baby cats"
402
+ }
403
+ }
404
+ ]
405
+ }
406
+ }
407
+ }
137
408
  ```
138
409
 
410
+ Note that url and expression are inherited to the state apis "sense" and
411
+ "nonsense".
412
+ The Data field can save various configuration items to be used in runtime
413
+ expressions.
414
+ Please also note that it is possible to access configuration, request or
415
+ response informations from other state apis in every runtime expression.
416
+
417
+ Every expression can access the following environment:
418
+
419
+ | Name | Meaning |
420
+ |-----------|--------------------------------------------------------|
421
+ | data | Generic configuration items. |
422
+ | error | Error object if some occured. |
423
+ | request | Client request informations. |
424
+ | response | Response informations (available in post evaluations). |
425
+ | stateAPIs | Access oher state api informations. |
426
+ | Tools | [see](https://www.npmjs.com/package/clientnode) |
427
+
139
428
  <!-- region modline
140
429
  vim: set tabstop=4 shiftwidth=4 expandtab:
141
430
  vim: foldmethod=marker foldmarker=region,endregion:
package/type.d.ts CHANGED
@@ -50,8 +50,10 @@ export type EvaluationParameters = [
50
50
  EvaluationScope['stateAPIs'],
51
51
  EvaluationScope['Tools']
52
52
  ];
53
- export type APIPreEvaluationExpression = (string | ((...parameters: EvaluationParameters) => 'break' | boolean | 'continue' | number));
54
- export type APIPostEvaluationExpression = (string | ((...parameters: EvaluationParameters) => 'break' | 'continue' | number | true));
53
+ export type APIPreEvaluationResult = 'break' | boolean | null | number | undefined | void;
54
+ export type APIPreEvaluationExpression = string | ((...parameters: EvaluationParameters) => APIPreEvaluationResult);
55
+ export type APIPostEvaluationResult = 'break' | null | number | void;
56
+ export type APIPostEvaluationExpression = string | ((...parameters: EvaluationParameters) => APIPostEvaluationResult);
55
57
  export interface APIExpressions {
56
58
  pre?: Array<APIPreEvaluationExpression> | APIPreEvaluationExpression;
57
59
  post?: Array<APIPostEvaluationExpression> | APIPostEvaluationExpression;
@@ -64,8 +66,8 @@ export interface StateAPI {
64
66
  url: string;
65
67
  }
66
68
  export interface ResolvedAPIExpressions {
67
- pre: Array<(...parmaters: EvaluationParameters) => 'break' | boolean | 'continue' | number>;
68
- post: Array<(...parameters: EvaluationParameters) => 'break' | number | 'continue' | true>;
69
+ pre: Array<(...parmaters: EvaluationParameters) => APIPreEvaluationResult>;
70
+ post: Array<(...parameters: EvaluationParameters) => APIPostEvaluationResult>;
69
71
  }
70
72
  export type ResolvedStateAPI = NonNullable<Omit<StateAPI, 'expressions'>> & {
71
73
  expressions: ResolvedAPIExpressions;