ui5-middleware-proxy-debug
v0.7.2
Published
UI5 simple proxy middleware
Downloads
2
Readme
UI5 simple proxy middleware
Middleware for ui5-server, enabling proxy support.
Install
npm install ui5-middleware-simpleproxy --save-dev
Configuration options (in $yourapp/ui5.yaml
)
- baseUri:
string
The baseUri to proxy. Can also be set using theUI5_MIDDLEWARE_SIMPLE_PROXY_BASEURI
environment variable. - strictSSL:
boolean
Ignore strict SSL checks. Default valuetrue
. Can also be set using theUI5_MIDDLEWARE_SIMPLE_PROXY_STRICT_SSL
environment variable. - limit:
string
This sets the body size limit (default:1mb
). If the body size is larger than the specified (or default) limit, a413 Request Entity Too Large
error will be returned. See bytes.js for a list of supported formats. - removeETag:
boolean
Removes the ETag header from the response to avoid conditional requests. - username:
string
Username used for Basic Authentication. - password:
string
Password used for Basic Authentication. - httpHeaders:
map
Http headers set for the proxied request. Will overwrite the http headers from the request. - query:
map
Query parameters set for the proxied request. Will overwrite the parameters from the request. - excludePatterns:
string[]
Array of exclude patterns using glob syntax
In general, use of environment variables or values set in a .env
file will override configuration values in the ui5.yaml
.
Usage
- Define the dependency in
$yourapp/package.json
:
"devDependencies": {
// ...
"ui5-middleware-simpleproxy": "*"
// ...
},
"ui5": {
"dependencies": [
// ...
"ui5-middleware-simpleproxy",
// ...
]
}
As the devDependencies are not recognized by the UI5 tooling, they need to be listed in the
ui5 > dependencies
array. In addition, once using theui5 > dependencies
array you need to list all UI5 tooling relevant dependencies.
- configure it in
$yourapp/ui5.yaml
:
server:
customMiddleware:
- name: ui5-middleware-simpleproxy
afterMiddleware: compression
mountPath: /odata
configuration:
baseUri: "https://services.odata.org"
username: myUsername
password: myPassword
httpHeaders:
Any-Header: AnyHeader
query:
sap-client: 206
excludePatterns:
- "/local/**"
How it works
The middleware launches a simple proxy
-server which proxies the requests to the given uri. Internally, it uses the express proxy middleware.
How to ignore self-signed certificates?
In case you are using HTTPS and self-signed certificates, you may see an error as displayed below:
Error: unable to verify the first certificate
at TLSSocket.onConnectSecure (_tls_wrap.js:1321:34)
at TLSSocket.emit (events.js:210:5)
at TLSSocket._finishInit (_tls_wrap.js:794:8)
at TLSWrap.ssl.onhandshakedone (_tls_wrap.js:608:12)
To avoid it, you can set the strictSSL
value in proxy request to be false
. Its default value is true
.
server:
customMiddleware:
- name: ui5-middleware-simpleproxy
afterMiddleware: compression
mountPath: /odata
configuration:
baseUri: "http://services.odata.org"
strictSSL: false
.env support
This plugin supports use of a .env
file to declare environment variable values for configuration as described above. The file should be put in the same directory where you run ui5 build
, ui5 serve
, etc. The file might have contents like:
UI5_MIDDLEWARE_SIMPLE_PROXY_BASEURI=https://host.tld:1234/sap
UI5_MIDDLEWARE_SIMPLE_PROXY_STRICT_SSL=false
UI5_MIDDLEWARE_SIMPLE_PROXY_USERNAME=myUsername
UI5_MIDDLEWARE_SIMPLE_PROXY_PASSWORD=myPassword
Hints
If you are using the Microsoft OData services for testing purposes, like Northwind, please ensure to use the https
URLs instead of the http
URLs. The http
URL will redirect to https
but instead of the proxy it will try to directly connect to the Microsoft OData services.
License
This work is dual-licensed under Apache 2.0 and the Derived Beer-ware License. The official license will be Apache 2.0 but finally you can choose between one of them if you use this work.
When you like this stuff, buy @vobu a beer or buy @pmuessig a coke when you see them.