That is a secure http/2 (or insecure http1.1) reverse-proxy installed on your machine
- with 0 transitive dependency
- with 1 install step
- with a startup time of a few milliseconds
- with one 58kb index.js file
How simple is that ?
node.js >= 8
npx local-trafficsudo prefix only required for Linux, when port number < 1024
- Change the mapping object in the
.local-traffic.jsonfile:
{
"mapping": {
"/npm/": "https://www.npmjs.com/",
"/my-static-webapp/": "file:///home/user/projects/my-static-webapp/",
"/config/": "config://",
"/logs/": "logs://",
"/recorder/": "recorder://",
"/jquery-local/jquery.js": {
"replaceBody": "https://mycdn.net/jquery/jquery-3.6.4.js",
"downstreamUrl": "file:///home/user/projects/zepto/dist/zepto.js"
},
"": "https://github.com/"
}
}if you need to deactivate a mapping entry, move it below the "" key
- Go to http://localhost:8080/prettier with your browser
- Go to http://localhost:8080/npm/ with your browser
- Go to http://localhost:8080/my-static-webapp/index.html with your browser (given your project name is my-static-webapp, but I am not 100% sure)
- Go to http://localhost:8080/logs/ to watch the request logs
- Go to http://localhost:8080/config/ to change the config in a web editor
- You can use the http://localhost:8080/recorder/ to turn your proxy into a mock server. There is a user interface and also an API (documented here)
- From the web config editor, create a SSL keypair and start working with a self signed SSL certificate right away
- Your page will use /jquery-local/jquery.js instead of the CDN asset, and will serve the file from your hard drive
- Your server now proxies the mapping that you have configured
npx local-traffic [location-of-the-local-traffic-config-file]When not specified, the location of the config file will be
$HOME/.local-traffic.json
node -e 'const { start } = require("local-traffic"); start({ /* configuration goes here */ })'- Open
.local-traffic.jsonwhile running it, or use the config web editor - Edit the mapping keys and downstream urls
- See the status update in the terminal, that's it.
All boolean settings default to false when unspecified.
mapping: ({[path: string]: string | {replaceBody: string ; downstreamUrl: string}) routing rules (required)ssl: SSL options (can be generated from the config web editor if you don't know how to set them)ssl.cert: (string) Certificate (PEM format)ssl.key: (string) Private Key (PEM format)
port: (number) port numberreplaceRequestBodyUrls: (boolean) replace every matching string from the mapping in the request body.replaceResponseBodyUrls: (boolean) replace every matching string from the mapping in the response body.dontTranslateLocationHeader: (boolean) when getting a response location header, in casereplaceResponseBodyUrlsdoes not change the URL, change the origin to the proxy anywaydontUseHttp2Downstream: (boolean) force calling downstream services in http1.1 only (to save some time)simpleLogs: (boolean) disable colored logs for text terminalslogAccessInTerminal: (boolean) write an access log in the terminal on each call (defaults to false)websocket: (boolean) true to activate websocket connections proxying via sockets. Required for logs UI.disableWebSecurity: (boolean) true for easygoing values in cross origin requests or content security policy headersconnectTimeout: (number) max time before aborting the connection (defaults to 3000ms)socketTimeout: (number) max time waiting for a response (defaults to 3000ms)
(>= 0.0.86) The recorder can be used programmatically with an API. This can be used if someone needs to automatically record mocks during instance provisioning (when the machine boots up using a cloud provider for example)
The API always matches the route targetting recorder://.
Arguments :
| parameter | Type | Description | Defaults |
|---|---|---|---|
| mode | "proxy" or "mock" | server mode | "proxy" |
| strict | boolean | errors when no mock is found | false |
| autoRecord | boolean | adds mocks from server | false |
| mocks | {uniqueHash,response}[] | mocks definition | [] |
The recorder webapp can take care of the mocks by itself,
so autoRecord is only necessary when using local-traffic headless or without human
intervention
The mock config will be reset to empty :
autoRecordwill be set to falsemockswill be purged
Retrieves the current mock configuration.
use Accept: application/json to use the API mode.
$ curl https://localhost:8443/recorder/ -XGET -k -H'Accept: application/json'
{"mocks":[],"strict":false,"autoRecord":false,"mode":"proxy"}