spandx is running! Time to configure it.
10 | Switch to...
26 |
27 |
16 |
17 | spandx mult-host example
18 |
19 | This example demonstrates using spandx to
21 | point at different remote environments based on the current local hostname.
22 |
23 |
24 |
25 | For example, visiting localhost:1337 will cause
27 | spandx to proxy to Remote Server 1, and visiting 127.0.0.1:1337 will cause
29 | spandx to proxy to Remote Server 2.
30 |
31 |
32 | Currently remote environment... REMOTE SERVER 1
33 |
34 | Switch to...
35 |
36 |
40 |
41 | Using multi-host in your own project
42 |
43 | This example is a very simplified version, using localhost and 127.0.0.1 because they work out of the box. To fully utilize this feature in your own project, please read on.
44 |
45 |
46 | This feature is most useful when paired with /etc/hosts to create custom local hostnames. If you work on the website for Foo, Inc, which has these environments:
47 |
48 |
49 |
50 | - dev.foo.com
51 | - qa.foo.com
52 | - stage.foo.com
53 | - www.foo.com
54 |
55 |
56 |
57 | You may want to use spandx to test your JS/CSS/images on each environment before deploying. To do that, you could maintain four spandx config files, which point to each of the four envs. Or, you can utilize mult-host routing.
58 |
59 |
60 |
61 | Create local hostnames for each remote environment by adding this to /etc/hosts:
62 |
63 | dev-local.foo.com 127.0.0.1
64 | qa-local.foo.com 127.0.0.1
65 | stage-local.foo.com 127.0.0.1
66 | www-local.foo.com 127.0.0.1
67 |
68 | Now visiting any of the new hostnames will simply point to localhost. Perfect. Now update your spandx config (only 'host' and 'routes' properties included for clarity).
69 |
70 | Before:
71 |
72 | module.exports = {
73 | host: "localhost",
74 | routes: {
75 | "/": {
76 | host: "http://localhost:8081"
77 | }
78 | }
79 | };
80 |
81 | After:
82 |
83 | module.exports = {
84 | host: {
85 | dev: "dev-local.foo.com",
86 | qa: "qa-local.foo.com"
87 | +---> stage: "stage-local.foo.com"
88 | | production: "wwww-local.foo.com"
89 | | },
90 | | routes: {
91 | | "/": {
92 | | host: {
93 | | dev: "http://dev.foo.com",
94 | | qa: "http://qa.foo.com",
95 | +-----------> stage: "http://stage.foo.com",
96 | production: "http://www.foo.com",
97 | }
98 | }
99 | }
100 | };
101 |
102 | The ASCII arrow is drawn to show how the name "stage" (and similarly dev,
103 | qa, and production), links the local hostname to the remote URL. It can be
104 | read as "If you visit spandx via stage-local.foo.com, then proxy to the 'stage' host, which lives at http://stage.foo.com".
105 |
106 |
107 | These names can be a string of your choice, they are not hard-coded.
108 |
109 |
110 |
111 |
112 |
113 |
--------------------------------------------------------------------------------
/app/chromeMiddleware.js:
--------------------------------------------------------------------------------
1 | const chromeCache = require("./chromeCache");
2 | const config = require("./config");
3 |
4 | function SPACommentResolver(conf) {
5 | return async function SPACommentResolverMiddleware(data, req, res) {
6 | const isHTML = (res.getHeader("content-type") || "").includes("html");
7 | if (isHTML) {
8 | const locale = getLocaleCookie(req.headers["cookie"]);
9 | const host = config.getTargetHost(
10 | conf,
11 | req.headers["x-spandx-env"],
12 | "/services/chrome/",
13 | req.headers["x-spandx-origin"]
14 | );
15 | const chromeParts = await chromeCache.getParts({
16 | host,
17 | legacy: true,
18 | locale,
19 | });
20 |
21 | return data
22 | .toString()
23 | .replace(//, chromeParts.head)
24 | .replace(//, chromeParts.header)
25 | .replace(//, chromeParts.footer);
26 | } else {
27 | return data;
28 | }
29 | };
30 | }
31 |
32 | function chromeSwapper(conf) {
33 | return async function ChromeSwapperMiddleware(data, req, res) {
34 | const isHTML = (res.getHeader("content-type") || "").includes("html");
35 | const isPrimerAlready = req.url.startsWith("/services/primer");
36 | if (isHTML && !isPrimerAlready) {
37 | const host = config.getTargetHost(
38 | conf,
39 | req.headers["x-spandx-env"],
40 | "/services/primer/",
41 | req.headers["x-spandx-origin"]
42 | );
43 | const locale = getLocaleCookie(req.headers["cookie"]);
44 | const chromeParts = await chromeCache.getParts({
45 | host,
46 | path: "/services/primer/",
47 | locale,
48 | });
49 |
50 | return data
51 | .toString()
52 | .replace(
53 | /.*/s,
54 | `${chromeParts.head}`
55 | )
56 | .replace(
57 | /.*/s,
58 | `${chromeParts.header}`
59 | )
60 | .replace(
61 | /.*/s,
62 | `${chromeParts.footer}`
63 | );
64 |
65 | // if any tokens were found, swap them
66 | // if (tokens.result.length) {
67 | // tokens.result.sort(
68 | // (a, b) => a.outer.startIndex - b.outer.startIndex
69 | // );
70 |
71 | // // TODO make this work when only 1 or 2 of the token pairs were found
72 | // const ret =
73 | // // body pre-head
74 | // body.slice(0, tokens.result[0].outer.startIndex) +
75 | // // head
76 | // chromeParts.head +
77 | // // body post-head
78 | // body.slice(
79 | // tokens.result[0].outer.endIndex,
80 | // tokens.result[1].outer.startIndex
81 | // ) +
82 | // // header
83 | // chromeParts.header +
84 | // // body post-header
85 | // body.slice(
86 | // tokens.result[1].outer.endIndex,
87 | // tokens.result[2].outer.startIndex
88 | // ) +
89 | // // footer
90 | // chromeParts.footer +
91 | // // body post-footer
92 | // body.slice(tokens.result[2].outer.endIndex, body.length);
93 |
94 | // return "HELLO";
95 | // }
96 | }
97 |
98 | return data;
99 | };
100 | }
101 |
102 | function getLocaleCookie(cookies) {
103 | let locale = "en"; // default
104 | if (cookies && cookies.includes("rh_locale")) {
105 | const localeCookie = cookies
106 | .split(";")
107 | .filter((c) => c.split("=")[0].trim() === "rh_locale")[0];
108 | if (localeCookie) {
109 | const localeCookieValue = localeCookie.split("=")[1].trim();
110 | if (chromeCache.LOCALES.includes(localeCookieValue)) {
111 | locale = localeCookieValue;
112 | } else {
113 | console.warn(
114 | `spandx received rh_locale cookie "${locale}" which is not a supported locale, falling back to "en". supported locales are ${chromeCache.LOCALES}`
115 | );
116 | }
117 | }
118 | }
119 | return locale;
120 | }
121 |
122 | module.exports = { SPACommentResolver, chromeSwapper };
123 |
--------------------------------------------------------------------------------
/RH.md:
--------------------------------------------------------------------------------
1 | # spandx & Red Hat Customer Portal
2 |
3 | This is a guide for adding spandx to any application that is part of the Red Hat Customer Portal ([access.redhat.com](https://access.redhat.com)).
4 |
5 | ## Quick-start
6 |
7 | First, add spandx as a devDependency of your project.
8 |
9 | ```
10 | npm i -D spandx
11 | ```
12 |
13 | Then, answer a few questions to create a `spandx.config.js`.
14 |
15 | ```
16 | npx spandx init cp
17 | ```
18 |
19 | If you need to, add local DNS entries for `*.foo.redhat.com`. If you aren't sure if you nee this, it's safe to go ahead and run it. Note: you'll probably need to `sudo` this command, but if you aren't comfortable doing that, run it without sudo and it will print out what you need to paste into `/etc/hosts`.
20 |
21 | ```
22 | npx spandx init cp addhosts
23 | ```
24 |
25 | ## Portal Chrome settings
26 |
27 | This section describes the Portal Chrome-specific settings in more detail. The `spandx init cp` command sets good defaults for Customer Portal work, but if you need to customize the settings, read on.
28 |
29 | Portal Chrome settings live in your spandx config file under the `portalChrome` property.
30 |
31 | ### Resolving SPA comments, such as ``
32 |
33 | spandx can replace these comments with their corresponding Portal Chrome parts:
34 |
35 | - `` ← `/services/chrome/head`
36 | - `` ← `/services/chrome/header`
37 | - `` ← `/services/chrome/footer`
38 |
39 | This can be enabled in your spandx.config.js file with the following setting.
40 |
41 | ```js
42 | module.exports = {
43 | portalChrome: {
44 | resolveSPAComments: true,
45 | },
46 | };
47 | ```
48 |
49 | If `resolveSPAComments` is true, spandx will inject Portal Chrome into any `text/html` request that passes through. It looks for the following placeholder comments and will replace them with the corresponding chrome part.
50 |
51 | | comment | location | description |
52 | | --------------------- | ------------------------ | --------------------------------------------------------------- |
53 | | `` | within your `` tag | will be replaced with the contents of `/services/chrome/head` |
54 | | `` | just after `` | will be replaced with the contents of `/services/chrome/header` |
55 | | `` | just before `` | will be replaced with the contents of `/services/chrome/footer` |
56 |
57 | This setting involves making requests to `/services/chrome/*`, which brings up the question of which host to fetch the chroming from. To make this as easy as possible, this feature taps into your existing spandx routes. In short, if you can hit `/services/chrome/head` from your spandx host, you'll be fine.
58 |
59 | For example, if you're routing `/app` to your local application and everything else to the Customer Portal, spandx will be able to resolve `/services/chrome/*` just fine.
60 |
61 | ```js
62 | routes: {
63 | '/app' : { host: "http://localhost:8080" },
64 | '/' : { host: 'https://access.redhat.com' }
65 | }
66 | ```
67 |
68 | ### Valid self-signed certs 🔒
69 |
70 | To set up valid local SSL certificates, [install mkcert](https://github.com/FiloSottile/mkcert#installation). Then run `mkcert -install` (you only need to do this once).
71 |
72 | Then you can this `mkcert` script to your package.json's `"scripts"` object. It creates self-signed certificates for spandx to use, and places them in a `ssl` directory (which should be gitignored).
73 |
74 | ```json
75 | "mkcert": "mkdir ssl > /dev/null; mkcert --cert-file ssl/spandx.pem --key-file ssl/spandx-key.pem dev.foo.redhat.com qa.foo.redhat.com stage.foo.redhat.com prod.foo.redhat.com",
76 | ```
77 |
78 | Each developer should run `npm run mkcert` or `yarn mkcert` once per clone of the project (or for users of [git worktree](https://git-scm.com/docs/git-worktree), once per worktree).
79 |
80 | Starting with spandx 2.2.4, spandx configs generated with `spandx init cp` automatically detect and use certs generated by the mkcert command above (ie, it looks for `ssl/spandx.pem` and `ssl/spandx-key.pem`). If your spandx.config.js was created before spandx 2.2.4, set your `bs.https` configuration to look like this:
81 |
82 | ```js
83 | bs: {
84 | https: { cert: "ssl/spandx.pem", key: "ssl/spandx-key.pem" }
85 | },
86 | ```
87 |
88 | And don't forget to gitignore the certs!
89 |
90 | **.gitignore**
91 | ```
92 | ssl/*
93 | ```
94 |
95 |
96 | ## Primer settings
97 |
98 | Primer is an upcoming re-imagining of Portal Chrome.
99 |
100 | ### Preview Primer head/header/footer
101 |
102 | This feature allows grafting HTML template changes into an existing page, even on a remote server, effectively previewing what the changes will look like when they are deployed to that server.
103 |
104 | With `primer.preview` set to `true`, spandx detects the head, header, and footer (the "parts") in Customer Portal pages you visit and replaces them with fresh Primer parts fetched from `/services/primer`. You can control the routing of this request in your `routes` object.
105 | ```js
106 | module.exports = {
107 | primer: {
108 | preview: true,
109 | },
110 | };
111 | ```
112 |
113 | Primer's head, header, and footer parts are wrapped with comments which are used as tokens to identify the location of each part. These tokens facilitate the removal of old parts and injection of fresh parts.
114 |
115 | The wrapper comment tokens look like this:
116 |
117 | - ` ... `
118 | - ` ... `
119 | - ` ... `
120 |
--------------------------------------------------------------------------------
/app/router.js:
--------------------------------------------------------------------------------
1 | const fs = require("fs");
2 | const path = require("path");
3 | const URL = require("url");
4 | const c = require("print-colors");
5 | const _ = require("lodash");
6 | const { flow, includes, get } = require("lodash/fp");
7 | const finalhandler = require("finalhandler");
8 | const serveStatic = require("serve-static");
9 | const resolveHome = require("./resolveHome");
10 | const ProxyAgent = require("proxy-agent");
11 | const priv = {};
12 |
13 | priv.tryPlugin = (plugin, req, res, target, cb) => {
14 | if (typeof plugin === "function") {
15 | plugin(req, res, target).then((t) => {
16 | // Plugin may have sent back a new target
17 | // if they did use it
18 | t = t || target;
19 | cb(t);
20 | }); // TODO what to do if the plugin Promise fails ??
21 | } else {
22 | // Run with the default target
23 | cb(target);
24 | }
25 | };
26 |
27 | priv.doProxy = (proxy, req, res, target, confProxy = null) => {
28 | if (target) {
29 | const options = {
30 | target,
31 | ignorePath: true,
32 | };
33 |
34 | if (confProxy) {
35 | const regex = RegExp(confProxy.pattern);
36 |
37 | // if the target URL passes the regex test based on the
38 | // pattern provided in the proxy.pattern property,
39 | // add a new HttpsProxyAgent
40 | if (regex.test(target)) {
41 | options.agent = new ProxyAgent.ProxyAgent(confProxy.host);
42 | }
43 | }
44 |
45 | proxy.web(req, res, options, (e) => {
46 | console.error(e);
47 | res.writeHead(502, { "Content-Type": "text/plain" });
48 | res.write(
49 | `HTTP 502 Bad gateway\n\nRequest to ${req.url} was proxied to ${target} which did not respond.`
50 | );
51 | res.end();
52 | });
53 | } else {
54 | res.writeHead(404);
55 | res.end();
56 | }
57 | };
58 |
59 | module.exports = (conf, proxy) => {
60 | // for each local file path in the conf, create a serveStatic object for
61 | // serving that dir
62 | const serveLocal = _(conf.routes)
63 | .omitBy(_.isObject)
64 | .mapValues((dir) =>
65 | serveStatic(path.resolve(conf.configDir, resolveHome(dir)), {
66 | redirect: true,
67 | })
68 | )
69 | .value();
70 | return (req, res, next) => {
71 | // figure out which target to proxy to based on the requested resource path
72 | const sortedRoutes = _(conf.routes)
73 | .toPairs()
74 | .filter((v) => _.startsWith(req.url, v[0]))
75 | .sortBy((v) => -v[0].length)
76 | .value();
77 |
78 | const env = req.headers["x-spandx-env"];
79 |
80 | for (let routeCandidate of sortedRoutes) {
81 | const routeKey = routeCandidate[0];
82 | const route = conf.routes[routeKey];
83 | const acceptHTML = flow(
84 | get("headers.accept"),
85 | includes("text/html")
86 | )(req);
87 | const hasExtension = URL.parse(req.url).path.includes(".");
88 | const isDoc = acceptHTML && !hasExtension;
89 | const useSingle = route.single && isDoc;
90 | const routePath = route.path || routeKey;
91 | const targetPath = useSingle
92 | ? routePath
93 | : req.url.replace(new RegExp(`^${routeKey}`), routePath);
94 |
95 | const targetHost = route.host && route.host[env];
96 | let fileExists;
97 | let needsSlash = false;
98 | const localFile = !targetHost;
99 | let target = targetHost + targetPath;
100 |
101 | // determine if the URL path maps to a local directory
102 | // if it maps to a local directory, and if the file exists, serve it
103 | // up. if the URL path maps to an HTTP server, OR if it maps to a file
104 | // but the file doesn't exist, in either case proxy to a remote server.
105 | if (localFile) {
106 | const url = URL.parse(req.url);
107 | const relativeFilePath = url.pathname.replace(
108 | new RegExp(`^${routeKey}/?`),
109 | "/"
110 | ); // remove route path (will be replaced with disk path)
111 |
112 | const absoluteFilePath = path.resolve(
113 | conf.configDir,
114 | resolveHome(route),
115 | relativeFilePath.replace(/^\//, "")
116 | );
117 | fileExists = fs.existsSync(absoluteFilePath);
118 |
119 | if (fileExists) {
120 | if (conf.verbose) {
121 | console.log(
122 | `GET ${c.fg.l.green}${req.url}${c.end} from ${c.fg.l.cyan}${absoluteFilePath}${c.end} ${env}`
123 | );
124 | }
125 |
126 | req.url = relativeFilePath; // update the request's url to be relative to the on-disk dir
127 | serveLocal[routeKey](req, res);
128 | return; // stop here, don't continue to HTTP proxy section
129 | }
130 | }
131 |
132 | if (localFile && !fileExists && routeKey.length > 1) {
133 | continue;
134 | }
135 |
136 | if (localFile && (!fileExists || needsSlash)) {
137 | target = conf.routes["/"].host
138 | ? conf.routes["/"].host[env]
139 | : undefined;
140 | }
141 |
142 | if (target === undefined) continue;
143 |
144 | if (conf.verbose) {
145 | const targetURL = URL.parse(target);
146 | console.log(
147 | `GET ${c.fg.l.green}${req.url}${c.end} from ${
148 | c.fg.l.blue
149 | }${`${targetURL.protocol}//${targetURL.host}`}${c.end}${
150 | c.fg.l.green
151 | }${req.url}${c.end}`
152 | );
153 | }
154 |
155 | priv.tryPlugin(conf.routerPlugin, req, res, target, (t) => {
156 | priv.doProxy(proxy, req, res, t, conf.proxy);
157 | });
158 |
159 | return;
160 | }
161 | };
162 | };
163 |
164 | if (process.env.NODE_ENV === "test") {
165 | // only leak in test
166 | module.exports.priv = priv;
167 | }
168 |
--------------------------------------------------------------------------------
/app/inits/cp/init.js:
--------------------------------------------------------------------------------
1 | const fs = require("fs");
2 | const { promisify } = require("util");
3 |
4 | const inquirer = require("inquirer");
5 | const c = require("print-colors");
6 |
7 | const writeFileAsync = promisify(fs.writeFile);
8 |
9 | function generateConfig(answers) {
10 | return `const fs = require("fs");
11 |
12 | const sslReady =
13 | fs.existsSync("ssl/spandx.pem") && fs.existsSync("ssl/spandx-key.pem");
14 |
15 | if (!sslReady) {
16 | console.log("Launching with invalid SSL cert 🔓");
17 | } else {
18 | console.log("Launching with valid SSL cert 🔒");
19 | }
20 |
21 | module.exports = {
22 | host: {
23 | prod: "prod.foo.redhat.com",
24 | stage: "stage.foo.redhat.com",
25 | qa: "qa.foo.redhat.com",
26 | dev: "dev.foo.redhat.com",
27 | },
28 | port: 1337,
29 | open: true,
30 | startPath: "${answers.path}",
31 | verbose: true,
32 | portalChrome: {
33 | resolveSPAComments: true
34 | },
35 | primer: {
36 | // preview: true
37 | },
38 | proxy: {
39 | host: "http://squid.corp.redhat.com:3128",
40 | pattern: "^https:\/\/(.*?).redhat.com"
41 | },
42 | bs: {
43 | https: sslReady
44 | ? { cert: "ssl/spandx.pem", key: "ssl/spandx-key.pem" } // 🔒
45 | : true, // 🔓
46 | codeSync: ${answers.livereload || true}
47 | },
48 | routes: {${
49 | /* sorry about this formatting... */
50 | answers.location === "dir"
51 | ? `
52 | "${answers.path}": "${answers.dir}",
53 | `
54 | : ""
55 | }${
56 | answers.location === "server"
57 | ? `
58 | "${answers.path}": {
59 | host: "${answers.host}"
60 | },
61 | `
62 | : ""
63 | }
64 | "/": {
65 | host: {
66 | dev: "https://access.dev.redhat.com",
67 | qa: "https://access.qa.redhat.com",
68 | stage: "https://access.stage.redhat.com",
69 | prod: "https://access.redhat.com",
70 | }
71 | }
72 | }
73 | }`;
74 | }
75 |
76 | async function writeHosts() {
77 | const hostile = require("hostile");
78 | const set = promisify(hostile.set);
79 |
80 | const hostnames = [
81 | "dev.foo.redhat.com",
82 | "qa.foo.redhat.com",
83 | "stage.foo.redhat.com",
84 | "prod.foo.redhat.com",
85 | ];
86 |
87 | try {
88 | await set("127.0.0.1", hostnames.join(" "));
89 | console.log(
90 | `Added ${c.fg.l.cyan}cp${c.end} hostnames to ${hostile.HOSTS}`
91 | );
92 | } catch (e) {
93 | console.error(
94 | `Unable to write ${hostile.HOSTS}. Either try again with sudo, or copy the following into your ${hostile.HOSTS} file.
95 | `
96 | );
97 | console.error(`127.0.0.1 ${hostnames.join(" ")}`);
98 | }
99 | }
100 |
101 | async function writeConfig() {
102 | const dirCheck = await inquirer.prompt([
103 | {
104 | type: "confirm",
105 | name: "confirmDir",
106 | message: `Your current directory, \`${process.cwd()}\`, has no package.json file, do you still wish to generate spandx.config.js here?`,
107 | when: () => !fs.existsSync("./package.json"),
108 | },
109 | {
110 | type: "confirm",
111 | name: "confirmOverwrite",
112 | message: `spandx.config.js already exists in your current directory, do you wish to overwrite it?`,
113 | when: () => fs.existsSync("./spandx.config.js"),
114 | },
115 | ]);
116 |
117 | ["confirmDir", "confirmOverwrite"].forEach((confirm) => {
118 | if (dirCheck.hasOwnProperty(confirm) && !dirCheck[confirm]) {
119 | console.log(`Aborting.`);
120 | process.exit(0);
121 | }
122 | });
123 |
124 | const answers = await inquirer.prompt([
125 | {
126 | type: "input",
127 | name: "path",
128 | message: "Path (ex: /support/cases or /search)",
129 | validate: (value) => {
130 | console.log(value);
131 | const startsWithSlash = value.startsWith("/");
132 | const noWhitespace = !/\s/.test(value);
133 | const valid = startsWithSlash && noWhitespace;
134 |
135 | const messages = [];
136 |
137 | if (!startsWithSlash) {
138 | messages.push("path must start with '/'");
139 | }
140 | if (!noWhitespace) {
141 | messages.push("path must not contain whitespace");
142 | }
143 |
144 | return valid || messages.join(", ");
145 | },
146 | },
147 | {
148 | type: "list",
149 | name: "location",
150 | message:
151 | "Should spandx load your app from a static dist directory, or from a local dev server (such as webpack-dev-server)?",
152 | choices: [
153 | {
154 | name: "dev server",
155 | value: "server",
156 | },
157 | { name: "dist directory", value: "dir" },
158 | ],
159 | },
160 | {
161 | type: "input",
162 | name: "host",
163 | default: "localhost:8080",
164 | message: "What is your local dev server's URL?",
165 | when: (answers) => answers.location === "server",
166 | filter: (answer) => {
167 | const missingProtocol = !/https?:\/\//.test(answer);
168 | if (missingProtocol) {
169 | // default to http
170 | return `http://${answer}`;
171 | } else {
172 | return answer;
173 | }
174 | },
175 | },
176 | {
177 | type: "confirm",
178 | name: "livereload",
179 | default: true,
180 | message:
181 | "Enable spandx's livereload? If your dev server provides LiveReload/browser-sync, choose No.",
182 | when: (answers) => answers.location === "server",
183 | },
184 | {
185 | type: "input",
186 | name: "dir",
187 | default: "dist",
188 | message:
189 | "What is the path to your dist directory? It should be relative to your project root (where package.json is).",
190 | when: (answers) => answers.location === "dir",
191 | },
192 | ]);
193 |
194 | try {
195 | await writeFileAsync("spandx.config.js", generateConfig(answers));
196 | } catch (e) {
197 | console.error(
198 | `Writing spandx.config.js failed. Original error below:`
199 | );
200 | console.error(e);
201 | process.exit(1);
202 | }
203 |
204 | console.log(`Created spandx.config.js`);
205 | console.log(
206 | "One last step to enable resolving local hostnames like 'stage.foo.redhat.com'"
207 | );
208 | console.log();
209 | console.log(" spandx init cp addhosts");
210 | }
211 |
212 | module.exports = async function initCP(argv) {
213 | if (argv._.length === 2) {
214 | writeConfig(argv);
215 | } else if (argv._.length === 3) {
216 | writeHosts();
217 | } else {
218 | console.error(`Couldn't initialize cp, invalid arguments given.`);
219 | }
220 | };
221 |
--------------------------------------------------------------------------------
/app/config.js:
--------------------------------------------------------------------------------
1 | const fs = require("fs");
2 | const path = require("path");
3 |
4 | const _ = require("lodash");
5 | const resolveHome = require("./resolveHome");
6 | const c = require("print-colors");
7 | const porty = require("porty");
8 |
9 | class ConfigProcessError extends Error {
10 | constructor(...args) {
11 | super(...args);
12 | this.name = this.constructor.name;
13 | Error.captureStackTrace(this, ConfigProcessError);
14 | }
15 | }
16 |
17 | class ConfigOpenError extends Error {
18 | constructor(...args) {
19 | super(...args);
20 | this.name = this.constructor.name;
21 | Error.captureStackTrace(this, ConfigOpenError);
22 | }
23 | }
24 |
25 | class PortUnavailableError extends Error {
26 | constructor(...args) {
27 | super(...args);
28 | this.name = this.constructor.name;
29 | Error.captureStackTrace(this, PortUnavailableError);
30 | }
31 | }
32 |
33 | const defaultConfig = {
34 | protocol: "http:",
35 | host: "localhost",
36 | port: 1337,
37 | verbose: false,
38 | silent: false,
39 | routes: {
40 | "/": path.resolve(__dirname, "splash"),
41 | },
42 | bs: {},
43 | };
44 |
45 | let configState = {};
46 |
47 | async function create(incomingConfig = {}, configDir = __dirname) {
48 | configState.currentConfig = _.defaults(incomingConfig, defaultConfig);
49 |
50 | if (incomingConfig.port === "auto") {
51 | incomingConfig.port = await porty.find();
52 | } else if (!(await porty.test(incomingConfig.port))) {
53 | throw new PortUnavailableError(
54 | `port ${incomingConfig.port} is already in use.`
55 | );
56 | }
57 |
58 | // choose a port for the internal proxy, avoiding the external port just chosen
59 | incomingConfig.internalPort = await porty.find({
60 | min: incomingConfig.port,
61 | avoids: [incomingConfig.port],
62 | });
63 |
64 | _.extend(
65 | configState.currentConfig,
66 | processConf(configState.currentConfig, configDir)
67 | );
68 |
69 | validateHosts(configState.currentConfig);
70 |
71 | return configState.currentConfig;
72 | }
73 |
74 | function get() {
75 | return configState.currentConfig;
76 | }
77 |
78 | async function fromFile(filePath = `${process.cwd()}/spandx.config.js`) {
79 | let confObj;
80 | const fullPath = path.resolve(__dirname, filePath);
81 | try {
82 | confObj = require(fullPath);
83 | } catch (e) {
84 | if (e.toString().indexOf("Error: Cannot find module") === 0) {
85 | throw new ConfigOpenError(
86 | `Tried to open spandx config file ${c.fg.l.cyan}${filePath}${c.end} but couldn't find it, or couldn't access it.`
87 | );
88 | } else {
89 | throw new ConfigProcessError(
90 | `Tried to process spandx config file ${c.fg.l.cyan}${filePath}${c.end} ` +
91 | `but. Got an exception loading the config: ${e}`
92 | );
93 | }
94 | }
95 | const conf = await create(confObj, path.parse(fullPath).dir);
96 | return conf;
97 | }
98 |
99 | function isSingleHost(conf) {
100 | const singleHost = _.isString(conf.host);
101 | const multiHost = _.isPlainObject(conf.host);
102 |
103 | if (singleHost === multiHost) {
104 | throw new Error(
105 | "'host' is the wrong type, must be either string or object"
106 | );
107 | }
108 |
109 | return singleHost;
110 | }
111 |
112 | function validateHosts(conf) {
113 | const routeHostMaps = _(conf.routes)
114 | .filter(_.isPlainObject) // only look at routes that are object, not strings (strings indicate local file paths)
115 | .map("host") // grab the host vaule
116 | .filter(_.isPlainObject); // grab any host values that are object
117 |
118 | // ERROR if any route hosts have maps with different keys than the spandx host map
119 | if (!validateEnvsMatch(conf, routeHostMaps)) {
120 | throw new Error(
121 | `spandx is configured for multi-host mode ('host' is an object map), but one or more routes have environment names that don't match the names from 'host'`
122 | );
123 | }
124 |
125 | return true;
126 | }
127 |
128 | function validateEnvsMatch(conf, routeHostMaps) {
129 | const sortKeys = (obj) => _(obj).keys().sortBy().value();
130 |
131 | const hasSameKeys = _.curry((envs1, envs2) =>
132 | _.isEqual(sortKeys(envs1), sortKeys(envs2))
133 | );
134 |
135 | const spandxHosts = sortKeys(conf.host);
136 |
137 | const matchesSpandxHosts = hasSameKeys(spandxHosts);
138 |
139 | const allEnvsMatch = routeHostMaps
140 | .map((h) => sortKeys(h))
141 | .filter((envs) => !matchesSpandxHosts(envs)) // filter *out* the ones that match spandx hosts
142 | .isEmpty(); // if empty, then every single route host matched
143 |
144 | return allEnvsMatch;
145 | }
146 |
147 | function processConf(conf, configDir = __dirname) {
148 | // add a conf entry indicating whetehr spandx is running in multi-host mode
149 | conf.multiHost = !isSingleHost(conf);
150 |
151 | // separate the local disk routes from the web routes
152 | const routeGroups = _(conf.routes)
153 | .toPairs()
154 | .partition((pair) => _.isObject(pair[1])); // filter out URLs, only want local file paths here
155 |
156 | const webRoutes = routeGroups.get(0);
157 | const diskRoutes = routeGroups.get(1);
158 |
159 | const webRouteHosts = _(webRoutes)
160 | .map(1) // get route value
161 | .filter((r) => _.isString(r.host)); // only select routes with strings for their host; at this point it should be ALL of them, but playing it safe anyway
162 |
163 | // convert any simplified host values into explicit host config (ie,
164 | // convert from a string like "localhost" to an object like
165 | // { default: "localhost" }
166 | if (conf.multiHost) {
167 | // multi host mode
168 |
169 | // for any web routes that have a single host, change them into a
170 | // multi-host entry where each env points to the same place
171 | webRouteHosts.forEach((r) => {
172 | const routeHost = r.host;
173 | r.host = _({})
174 | .extend(conf.host)
175 | .mapValues((v) => routeHost)
176 | .value();
177 | });
178 | } else {
179 | // single host mode
180 | conf.host = { default: conf.host };
181 | webRouteHosts.forEach((r) => (r.host = { default: r.host })); // convert host string to object
182 | }
183 |
184 | // build a list of file paths to watch for auto-reload, by combining the
185 | // local disk route paths with the web routes that provided local paths
186 | // (web routes can provide an optional path to local files if they want
187 | // browser-sync to auto-reload their stuff)
188 | const diskRouteFiles = _(diskRoutes)
189 | .map(1)
190 | .map((filePath) => path.resolve(configDir, resolveHome(filePath)))
191 | .value();
192 | const otherLocalFiles = _(webRoutes)
193 | .map(1)
194 | .filter("watch")
195 | .map("watch")
196 | .map((filePath) => path.resolve(configDir, resolveHome(filePath)))
197 | .value();
198 |
199 | const files = _.concat(diskRouteFiles, otherLocalFiles);
200 |
201 | // create a list of browserSync 'rewriteRules' that will modify the
202 | // contents of requests coming back from the proxied remote servers. this
203 | // is mainly useful for rewriting links from, say 'www.foo.com' to
204 | // 'localhost:1337' so that when you click on a link, you stay in your
205 | // spandx'd environment.
206 | const protocol = conf.bs.https ? "https:" : "http:";
207 | const rewriteRules = _(webRoutes)
208 | .map("1.host")
209 | .map((h) =>
210 | _.map(h, (v, env) => ({
211 | match: new RegExp(v, "g"),
212 | replace: `${protocol}//${conf.host[env]}:${conf.port}`,
213 | }))
214 | )
215 | .flatten()
216 | .value();
217 |
218 | const startPath = conf.startPath || "";
219 | const spandxUrl = _.map(conf.host, (host, env) => ({
220 | env,
221 | url: `${protocol}//${host}:${conf.port}${startPath}`,
222 | }));
223 |
224 | // allow 'silent' to override 'verbose'
225 | const verbose = conf.silent ? false : conf.verbose;
226 |
227 | return {
228 | routeGroups,
229 | verbose,
230 | webRoutes,
231 | diskRoutes,
232 | diskRouteFiles,
233 | otherLocalFiles,
234 | files,
235 | rewriteRules,
236 | protocol,
237 | spandxUrl,
238 | startPath,
239 | configDir,
240 | };
241 | }
242 |
243 | function getRoute(conf, urlPath) {
244 | // figure out which route to proxy to based on the requested resource path
245 | const bestMatchedRoute = _(conf.routes)
246 | .toPairs()
247 | .filter((v) => _.startsWith(urlPath, v[0]))
248 | .sortBy((v) => -v[0].length)
249 | .first();
250 | return bestMatchedRoute[1];
251 | }
252 |
253 | function getTargetURL(conf, spandxEnv, urlPath) {
254 | // figure out which target URL to proxy to based on the requested resource path
255 | const route = getRoute(conf, urlPath);
256 |
257 | if (typeof route == "string") {
258 | // local disk route
259 | return { route, routeType: "disk" };
260 | } else if (typeof route.host == "string") {
261 | return { route: route.host, routeType: "network" };
262 | } else {
263 | return { route: route.host[spandxEnv], routetype: "network" };
264 | }
265 | }
266 |
267 | function getTargetHost(conf, spandxEnv, urlPath, spandxOrigin) {
268 | const { route, routeType } = getTargetURL(conf, spandxEnv, urlPath);
269 | let host = routeType === "disk" ? spandxOrigin : route;
270 | return host;
271 | }
272 |
273 | module.exports = {
274 | create,
275 | get,
276 | fromFile,
277 | defaultConfig,
278 | process: processConf,
279 | getRoute,
280 | getTargetURL,
281 | getTargetHost,
282 | };
283 |
--------------------------------------------------------------------------------
/app/spandx.js:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env node
2 |
3 | const http = require("http");
4 | const path = require("path");
5 | const https = require("https");
6 |
7 | const browserSync = require("browser-sync");
8 | const connect = require("connect");
9 | const httpProxy = require("http-proxy");
10 | const transformerProxy = require("transformer-proxy");
11 | const _ = require("lodash");
12 | const c = require("print-colors");
13 | const opn = require("opn");
14 |
15 | const router = require("./router.js");
16 | const config = require("./config");
17 | const resolveHome = require("./resolveHome");
18 | const chromeMiddleware = require("./chromeMiddleware");
19 | const { createEsiMiddleware } = require("./esiMiddleware");
20 |
21 | let proxy;
22 | let internalProxy;
23 | let bs;
24 |
25 | async function init(confIn) {
26 | // if initialized with a string, assume it's a file path to a config file
27 | // if initialized with an object, assume it's a configuration object
28 | // if initialized with no arguments, use default configuration
29 | switch (typeof confIn) {
30 | case "string":
31 | conf = await config.fromFile(confIn);
32 | if (conf.verbose && !conf.silent) {
33 | console.log(`configuration: ${c.fg.l.cyan}${confIn}${c.end}`);
34 | }
35 | break;
36 | case "object":
37 | conf = await config.create(confIn);
38 | if (conf.verbose && !conf.silent) {
39 | console.log("configuration: custom object");
40 | }
41 | break;
42 | default:
43 | conf = await config.create();
44 | if (conf.verbose && !conf.silent) {
45 | console.log("configuration: defaults");
46 | }
47 | }
48 |
49 | // since this is a local development tool, allow self-signed ssl certificates.
50 | https.globalAgent.options.rejectUnauthorized = false;
51 |
52 | bs = browserSync.create();
53 |
54 | // connect server w/ proxy
55 |
56 | const internalProxyPort = conf.internalPort;
57 | const internalProxyOrigin = `http://localhost:${internalProxyPort}`;
58 |
59 | const app = connect();
60 |
61 | proxy = httpProxy.createProxyServer({
62 | changeOrigin: true,
63 | preserveHeaderKeyCase: true,
64 | autoRewrite: true,
65 | secure: false, // don't validate SSL/HTTPS
66 | protocolRewrite: conf.protocol.replace(":", ""),
67 | cookieDomainRewrite: true,
68 | });
69 |
70 | //
71 | // app.use((req, res, next) => {
72 | // next();
73 | // });
74 |
75 | // if configuration says to, replace Drupal SPA comments for chroming
76 | if (_.get(conf, "portalChrome.resolveSPAComments")) {
77 | app.use(transformerProxy(chromeMiddleware.SPACommentResolver(conf)));
78 | }
79 |
80 | // if configuration says to, inject fresh chrome into prechromed pages
81 | if (_.get(conf, "primer.preview")) {
82 | app.use(transformerProxy(chromeMiddleware.chromeSwapper(conf)));
83 | }
84 |
85 | if (_.get(conf, "esi")) {
86 | console.log("ESI enabled");
87 | app.use((res, req, next) => {
88 | console.log("request received");
89 | if (
90 | res.headers.accept.includes("text/html") ||
91 | res.headers.accept.includes("*/*")
92 | ) {
93 | console.log("it is html; applying ESI");
94 | transformerProxy(createEsiMiddleware(conf))(res, req, next);
95 | } else {
96 | console.log("it is not html");
97 | next();
98 | }
99 | });
100 | }
101 |
102 | // dynamically proxy to local filesystem or remote webserver
103 | app.use(router(conf, proxy));
104 | internalProxy = http.createServer(app).listen(internalProxyPort);
105 |
106 | // output for humans
107 | if (conf.verbose) {
108 | console.log("Launching spandx with the following configuration");
109 | console.log();
110 |
111 | console.log("These paths will be routed to the following remote hosts");
112 | console.log();
113 | console.log(
114 | _.map(conf.webRoutes, (route) => {
115 | return conf.spandxUrl
116 | .map(({ url }) => {
117 | const env = _.findKey(conf.host, (host) =>
118 | new RegExp(`${host}`).test(url)
119 | );
120 |
121 | return ` ${c.fg.l.blue}${url
122 | .replace(/\/$/, "")
123 | .replace(new RegExp(`${conf.startPath}$`), "")}${
124 | c.end
125 | }${c.fg.l.green}${route[0]}${c.e} will be routed to ${
126 | c.fg.l.blue
127 | }${route[1].host[env] || route[1].host}${c.e}${
128 | c.fg.l.green
129 | }${route[0]}${c.e}`;
130 | })
131 | .join("\n");
132 | }).join("\n")
133 | );
134 | console.log();
135 |
136 | console.log("These paths will be routed to your local filesystem");
137 | console.log();
138 | console.log(
139 | _.map(conf.diskRoutes, (route) => {
140 | return conf.spandxUrl
141 | .map(
142 | ({ url }) =>
143 | ` ${c.fg.l.blue}${url
144 | .replace(/\/$/, "")
145 | .replace(
146 | new RegExp(`${conf.startPath}$`),
147 | ""
148 | )}${c.end}${c.fg.l.green}${route[0]}${
149 | c.end
150 | } will be routed to ${c.fg.l.cyan}${path.resolve(
151 | conf.configDir,
152 | resolveHome(route[1])
153 | )}${c.e}`
154 | )
155 | .join("\n");
156 | }).join("\n")
157 | );
158 |
159 | console.log();
160 |
161 | console.log(
162 | "Your browser will refresh when files change under these paths"
163 | );
164 | console.log();
165 | console.log(
166 | _.map(conf.files, (file) => ` ${c.fg.l.cyan}${file}${c.e}`).join(
167 | "\n"
168 | )
169 | );
170 | console.log();
171 |
172 | console.log(
173 | "These find/replace rules will be used to fix links in remote server responses"
174 | );
175 | console.log();
176 | console.log(
177 | _.map(
178 | conf.rewriteRules,
179 | (rule) =>
180 | ` ${c.fg.l.pink}${rule.match}${c.e} will be replaced with "${c.fg.d.green}${rule.replace}${c.e}"`
181 | ).join("\n")
182 | );
183 | console.log();
184 | }
185 |
186 | // launch!
187 |
188 | // create a promise that resolves when browsersync is ready
189 | const bsReadyPromise = new Promise((resolve) => {
190 | const bsOptions = _.defaultsDeep(
191 | {
192 | // this object's browser-sync settings cannot be overridden by a user's spandx.config.js
193 | port: conf.port,
194 | open: false,
195 | startPath: conf.startPath,
196 | logLevel: "silent",
197 | files: conf.files,
198 | proxy: {
199 | target: internalProxyOrigin,
200 | proxyReq: [
201 | function (proxyReq, req, res) {
202 | // find and set a header to keep track of the spandx origin
203 | const url = new URL("http://localhost/");
204 | url.hostname = req.headers.host.split(":")[0];
205 | url.port = conf.port;
206 | url.protocol = conf.bs.https ? "https:" : "http:";
207 | const origin = url.origin;
208 |
209 | // set a header for spandx origin and env on both the request and response
210 | const env = _.findKey(
211 | conf.host,
212 | (host) => host === url.hostname
213 | );
214 |
215 | [res, proxyReq].forEach((r) => {
216 | r.setHeader("X-Spandx-Env", env || "default");
217 | r.setHeader("X-Spandx-Origin", origin);
218 | });
219 |
220 | if (typeof env === "undefined") {
221 | if (!config.silent) {
222 | console.warn(
223 | `WARN request received at ${origin} which is not in the spandx config`
224 | );
225 | }
226 | }
227 | },
228 | ],
229 | },
230 | rewriteRules: _.concat(conf.rewriteRules, conf.bs.rewriteRules),
231 | },
232 | _.omit(conf.bs, "rewriteRules"),
233 | {
234 | // this object's browser-sync settings can be overridden by a user's spandx.config.js
235 | ghostMode: false,
236 | cors: true,
237 | online: false,
238 | ui: false,
239 | }
240 | );
241 | bs.init(bsOptions, () => {
242 | if (conf.open) {
243 | opn(conf.spandxUrl[0].url);
244 | }
245 | resolve(bs);
246 | });
247 | });
248 |
249 | if (!conf.silent) {
250 | const maxEnvLength = conf.spandxUrl.reduce(
251 | (m, { env }) => Math.max(m, env.length),
252 | 0
253 | );
254 | console.log(
255 | `spandx URL${
256 | conf.spandxUrl.length > 1 ? "s" : ""
257 | }:\n\n${conf.spandxUrl
258 | .map(
259 | ({ env, url }) =>
260 | ` ${
261 | env === "default"
262 | ? ""
263 | : `${env.padEnd(maxEnvLength + 1)}: `
264 | }${c.fg.l.blue}${url}${c.end}`
265 | )
266 | .join("\n")}\n`
267 | );
268 | }
269 |
270 | return bsReadyPromise;
271 | }
272 |
273 | function exit() {
274 | if (bs && bs.exit) {
275 | bs.exit();
276 | }
277 | if (internalProxy && internalProxy.close) {
278 | internalProxy.close();
279 | }
280 | if (proxy && proxy.close) {
281 | proxy.close();
282 | }
283 | }
284 |
285 | if (require.main === module) {
286 | init();
287 | }
288 |
289 | module.exports = { init, exit };
290 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | 
2 |
3 | [![Build Status][build-img]][build]
4 |
5 | # What is spandx?
6 |
7 | spandx is an **HTTP switchboard**. With it, you can weave together pieces of a large, complex website by choosing which resources should come from your local system and which should come from a remote environment.
8 |
9 | For example, you could point spandx at your production site, but route `/static/js` to a local directory, which allows you to test your local JS against the production environment. Code in production, it's fun.
10 |
11 | More technically, spandx is a flexible, configuration-based reverse proxy for local development.
12 |
13 | # Quick-start
14 |
15 | *(Note: if you're a developer on the Customer Portal, please use [this guide][rh-quickstart])*
16 |
17 | While I recommend [local install][local-dep], if you want to quickly take spandx for a whirl, the fastest way to get started is by installing spandx as a global package.
18 |
19 | npm install -g spandx
20 |
21 | Generate a sample configuration file:
22 |
23 | spandx init > spandx.config.js
24 |
25 | Launch!
26 |
27 | spandx
28 |
29 | ---
30 |
31 | # Table of Contents
32 |
33 |
34 |
35 | - [Commands](#commands)
36 | * [spandx](#spandx)
37 | * [init](#init)
38 | - [Configuration](#configuration)
39 | * [spandx.config.js](#spandxconfigjs)
40 | * [Routes](#routes)
41 | + [Routing to a local directory](#routing-to-a-local-directory)
42 | + [Routing to a server](#routing-to-a-server)
43 | - [Multi-host routing](#multi-host-routing)
44 | - [Path rewriting](#path-rewriting)
45 | - [single mode](#single-mode)
46 | * [Setting up the proxy object](#setting-up-the-proxy-object)
47 | * [Overriding Browsersync options](#overriding-browsersync-options)
48 | + [Enabling HTTPS](#enabling-https)
49 | - [spandx as a local dependency](#spandx-as-a-local-dependency)
50 | - [Contributing](#contributing)
51 | * [Commit messages](#commit-messages)
52 | * [Running specific tests](#running-specific-tests)
53 | - [Known issues](#known-issues)
54 | * [cURLing spandx](#curling-spandx)
55 | + [Body URL rewriting](#body-url-rewriting)
56 | + [single mode URL rewriting](#single-mode-url-rewriting)
57 | - [Alternatives](#alternatives)
58 |
59 |
60 |
61 | # Commands
62 |
63 | ## spandx
64 |
65 | To launch spandx, simply run `spandx`. If a `spandx.config.js` file exists in the current directory, it will be used.
66 |
67 | Option | Description | Example
68 | --- | --- | ---
69 | `-c`, `--config` | Specify an alternate config file. Config files are JS by default (to enable commenting), but JSON is also accepted. | `spandx -c ./configs/spandx.json`
70 | `-v`, `--version` | Print the current version of spandx. | `spandx -v`
71 |
72 | ## init
73 |
74 | Generate a configuration file. When invoked with no arguments, it prints a barebones config file. Redirect to a file (this could be improved by writing the file automatically).
75 |
76 | ```
77 | spandx init > spandx.config.js
78 | ```
79 |
80 | # Configuration
81 |
82 | After `spandx init` has generated a configuration file for you, there are many ways you can tweak it.
83 |
84 | ## spandx.config.js
85 |
86 | Here are the configuration options accepted by the config file.
87 |
88 | Option | Description | Type
89 | ---|---|---
90 | `host` | The hostname you wish to use to access spandx. Usually "localhost", or a [multi-host](#multi-host-routing) object. | string or object
91 | `port` | The port for spandx to listen on, or "auto". | number or "auto"
92 | `open` | Whether to open a browser tab when spandx is launched. | boolean
93 | `startPath` | The URL path to open, if `open` is true. ex: `"/site"`. | string
94 | `verbose` | Display English summary of configuration settings and display Browsersync logs, or not. | boolean
95 | `silent` | Print nothing to stdout. | boolean
96 | `routes` | Define where to send requests for any number of URL paths, best explained in [routes by example](#routes). | object
97 | `bs` | A [Browsersync config object][bs-options], in case you need to further customize spandx's Browsersync instance. | object
98 | `portalChrome` | Settings related to Portal Chrome, see [Portal Chrome settings][portal-chrome-settings]. | object
99 | `esi` | Set to `true` to enable processing [ESI][esi] tags, or pass in a [nodesi][nodesi] config object. | boolean or object
100 | `proxy` | Define a proxy host and a URL regex pattern for target URLs that should be proxied. | object
101 |
102 | ## Routes
103 |
104 | Routes are the core of spandx's flexibility. They allow you to define where to pull assets at any given URL path.
105 |
106 | Route all requests to palebluepixel.org (a perfect reverse proxy), *unless* the request falls under `/theme`, in which case look for files in `~/projects/pbp/theme`.
107 |
108 | routes: {
109 | "/theme" : "~/projects/pbp/theme/",
110 | "/" : { host: "https://palebluepixel.org/" },
111 | },
112 |
113 | Here's how this configuration would play out.
114 |
115 | 1. visit localhost:1337 and you see what looks like palebluepixel.org
116 | 2. one exception, the page includes `/theme/site.css`
117 | 3. because it falls under the `/theme` route, spandx fetches `~/projects/pbp/theme/site.css` instead of `palebluepixel.org/theme/site.css`
118 |
119 | This effectively _overlays_ a local directory of static files on top of a remote server. In other words... test in production!
120 |
121 | In addition, because `~/projects/pbp/theme` is a local directory, changes to files inside it will trigger a Browsersync refresh.
122 |
123 | ### Routing to a local directory
124 |
125 | To route to a local directory, the destination should be a string. The directory path can be absolute or relative. If relative, it's resolved relative to the spandx.config.js file.
126 |
127 | ```
128 | routes: {
129 | "/incoming": "./destination"
130 | }
131 | ```
132 |
133 | ### Routing to a server
134 |
135 | To route to a server, the destination should be an object with a `host` property.
136 |
137 | ```js
138 | routes: {
139 | "/incoming": {
140 | host: "http://localhost:8080"
141 | }
142 | }
143 | ```
144 |
145 | In this form, requests to `/incoming` will route to `http://localhost:8080/incoming`. If you would rather route to a different path (such as `http://localhost:8080`), you can specify a `path` property as follows.
146 |
147 | #### Multi-host routing
148 |
149 | Many projects have multiple remote webservers, for example a dev server, qa, staging, and production. To simplify dealing with multiple remotes, spandx offers multi-host routing, whether the local hostname determines which remote host to proxy to. Here's an example config.
150 |
151 |
152 | ```js
153 | module.exports = {
154 | host: {
155 | +---< dev: "dev-local.foo.com",
156 | | prod: "prod-local.foo.com"
157 | | },
158 | | routes: {
159 | | "/": {
160 | | host: {
161 | +-----------> dev: "http://dev.foo.com",
162 | prod: "http://www.foo.com"
163 | }
164 | }
165 | }
166 | };
167 | ```
168 |
169 | In this case, dev-local.foo.com and prod-local.foo.com should be entered in `/etc/hosts`, pointing to `127.0.0.1`. Then, when spandx is visited at dev-local.foo.com, spandx knows it's the "dev" host and proxies to dev.foo.com. The names "dev" and "prod" can be any names you choose. See the [examples](examples) dir for a working example.
170 |
171 |
172 | #### Path rewriting
173 |
174 | ```js
175 | routes: {
176 | "/my-app": {
177 | host: "http://localhost:8080",
178 | path: "/"
179 | }
180 | }
181 | ```
182 |
183 | With this path setting, requests to `/my-app` will route to `http://localhost:8080/`. This is particularly useful when using a local development server (like webpack-dev-server) where your app lives at `/`.
184 |
185 | #### single mode
186 |
187 | When a route has `single: true`, spandx will send all requests under that route to a single index.html file (except requests for assets).
188 |
189 | This is intended to be used with [`pushState`][pushstate] and enables hash-free user-friendly URLs for single-page apps.
190 |
191 | ```js
192 | routes: {
193 | "/my-app": {
194 | host: "http://localhost:8080",
195 | single: true
196 | }
197 | }
198 | ```
199 |
200 | With this config, a request to `/my-app/users/active` would be routed to `http://localhost:8080/my-app/index.html`.
201 |
202 | `single` can also be combined with `path`.
203 |
204 | ```js
205 | routes: {
206 | "/my-app": {
207 | host: "http://localhost:8080",
208 | path: "/",
209 | single: true
210 | }
211 | }
212 | ```
213 |
214 | Here, a request to `/my-app/users/active` would be routed to `http://localhost:8080/`.
215 |
216 | ## Setting up the proxy object
217 |
218 | If you're developing an app that needs to connect to a proxy, use the proxy object to define the proxy host and define a URL regex pattern for request that should go through the proxy.
219 |
220 | ```js
221 | proxy: {
222 | host: "http://someproxy.com:1234",
223 | pattern: "^https:\/\/(.*?).someurl.com"
224 | }
225 | ```
226 |
227 | Here, when a URL like `https://api.qa.someurl.com` is requested, it would be routed through the proxy.
228 |
229 | ## Overriding Browsersync options
230 |
231 | Internally, spandx uses Browsersync to power some features like live-reloading. Custom [Browsersync options][bs-options] can be embedded in your spandx.config.js file under the `bs` property.
232 |
233 | For example, let's enable HTTPS.
234 |
235 | ### Enabling HTTPS
236 |
237 | You can enable HTTPS by
238 |
239 | ```js
240 | module.exports = {
241 | bs: {
242 | https: true,
243 | }
244 | };
245 | ```
246 |
247 | For extra customization (like providing your own certs), see [Browsersync's HTTPS options][bs-https].
248 |
249 | # spandx as a local dependency
250 |
251 | The quick-start has you install spandx as a global package for simplicity, but installing it locally per-project is a better approach in many ways.
252 |
253 | Go to your project, install spandx as a dev dependency, and create a config file:
254 |
255 | cd $YOUR_PROJECT
256 | npm install --save-dev spandx
257 | npx spandx init > spandx.config.js
258 |
259 | Modify `spandx.config.js` to reflect the needs of your application.
260 |
261 | Then edit your `package.json` and add a `start` script which launches spandx.
262 |
263 | ```json
264 | "scripts": {
265 | "start": "spandx"
266 | }
267 | ```
268 |
269 | Now you and your fellow contributors can run `yarn start` without having to install or even understand spandx!
270 |
271 | # Contributing
272 |
273 | Contributions are very welcome! There's not much here yet, but when there's enough content it can be split out into a dedicated CONTRIBUTING.md.
274 |
275 | ## Commit messages
276 |
277 | Starting with spandx v2.0.0, one goal is to adhere to the [Conventional Commits][conv-comm] style of writing commit messages. The rewards of doing so are automating semantic version bumps and CHANGELOG updates. For now, the commit style will be used and later on, the tooling ([conventional-changelog-cli][conv-cli] perhaps) will be added.
278 |
279 | ## Running specific tests
280 |
281 | When writing a test, or debugging a failing test, you may want to run *only* that test instead of the entire suite. To do that, you can filter by the name of the test. Just be specific enough to target only the test (or tests) you want to run.
282 |
283 | For example, to run the test named "should reject invalid multi-host configs":
284 |
285 | yarn test -- --filter="invalid multi"
286 |
287 | # Known issues
288 |
289 | ## cURLing spandx
290 |
291 | When curling spandx, if you are requesting an HTML document, it's important to include an appropriate `Accept` header. There are two spandx features, described below, that will not work without that header.
292 |
293 | ### Body URL rewriting
294 |
295 | The URL-rewriting feature is powered by browserSync's rewriteRules. However, Browsersync will only perform the rewrites if `text/html` is present in the request's `Accept` header. Web browsers include it by default, but if you're using [cURL][curl], you'll need to add that header in order for URLs to be rewritten.
296 |
297 | For example:
298 |
299 | curl -H 'Accept: text/html' localhost:1337
300 |
301 | ### single mode URL rewriting
302 |
303 | Just like body URL rewriting, the URL rewrite associated with the [`single`][single-mode] also needs the incoming `Accept` header to include `text/html`.
304 |
305 | All other spandx features work with or without `text/html` in the `Accept` header.
306 |
307 | # Alternatives
308 |
309 | If spandx doesn't fit, here are a few other tools that offer similar features.
310 |
311 | - [devd][devd], a local development server with a focus on flexible reverse proxying, much like spandx. Written in Go.
312 | - [http-server][http-server], a simple command-line HTTP server. The `--proxy` flag provides a remote fallback for requests that can't be resolved locally. Written in JS.
313 | - [dprox][dprox], a declarative reverse proxy for local development. Similar configuration philosophy to spandx.'
314 | - [traefik][traefik]
315 |
316 |
317 |
318 | [curl]: https://curl.haxx.se/
319 | [npm]: https://www.npmjs.com/package/spandx
320 | [build-img]: https://travis-ci.org/redhataccess/spandx.png?branch=master
321 | [build]: https://travis-ci.org/redhataccess/spandx
322 | [bs-options]: https://browsersync.io/docs/options
323 | [devd]: https://github.com/cortesi/devd
324 | [http-server]: https://github.com/http-party/http-server#readme
325 | [dprox]: https://github.com/FND/dprox
326 | [single-mode]: #single-mode
327 | [local-dep]: #spandx-as-a-local-dependency
328 | [bs-https]: https://www.browsersync.io/docs/options#option-https
329 | [rh-quickstart]: ./RH.md
330 | [portal-chrome-settings]: ./RH.md#portal-chrome-settings
331 | [pushstate]: https://developer.mozilla.org/en-US/docs/Web/API/History_API
332 | [esi]: https://en.wikipedia.org/wiki/Edge_Side_Includes
333 | [nodesi]: https://github.com/Schibsted-Tech-Polska/nodesi
334 | [conv-comm]: https://www.conventionalcommits.org/#summary
335 | [conv-cli]: https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli
336 | [traefik]: https://github.com/traefik/traefik
337 |
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # [3.0.0](https://github.com/redhataccess/spandx/compare/v2.2.7...v3.0.0) (2023-10-23)
2 |
3 | * test!: remove support for node 16 ([111e79a](https://github.com/redhataccess/spandx/commit/111e79a409a43de55962e94ed08752f68cbc9d0c))
4 |
5 | ### Features
6 |
7 | * apply localized primer/chrome based on rh_locale cookie ([86dff14](https://github.com/redhataccess/spandx/commit/86dff145dca27689782068d4c44a6b05a5f739b2))
8 |
9 | ### BREAKING CHANGES
10 |
11 | * remove support for node 16
12 |
13 | ## [2.2.7](https://github.com/redhataccess/spandx/compare/v2.2.6...v2.2.7) (2023-08-30)
14 |
15 | This patch reverts the breakage caused by a browser-sync upgrade in 2.2.6.
16 |
17 | ## [2.2.6](https://github.com/redhataccess/spandx/compare/v2.2.5...v2.2.6) (2023-06-20)
18 |
19 | DEPRECATED: This patch inadvertently introduced a breakage caused an upgrade of browser-sync. Please use 2.2.7 instead.
20 |
21 | ### Bug Fixes
22 |
23 | * **deps:** downgrade browsersync ([#282](https://github.com/redhataccess/spandx/issues/282)) ([8445edb](https://github.com/redhataccess/spandx/commit/8445edbfc86d2a931c8a3307de3ca57bfbf1ff82))
24 | * **deps:** update dependency conventional-changelog-cli to v2.2.2 ([#276](https://github.com/redhataccess/spandx/issues/276)) ([11c144d](https://github.com/redhataccess/spandx/commit/11c144d8022c6ce636f7ead712e752f195f2bd92))
25 | * **deps:** update dependency finalhandler to v1.2.0 ([#301](https://github.com/redhataccess/spandx/issues/301)) ([9fb4e74](https://github.com/redhataccess/spandx/commit/9fb4e74fd4e47e681e17f626794861963a6caa71))
26 | * **deps:** update dependency got to v11.8.6 ([#270](https://github.com/redhataccess/spandx/issues/270)) ([448b9e3](https://github.com/redhataccess/spandx/commit/448b9e3c733c212e12141111e7233b6fa20c4a16))
27 | * **deps:** update dependency http-proxy to v1.18.1 ([#304](https://github.com/redhataccess/spandx/issues/304)) ([b0922b3](https://github.com/redhataccess/spandx/commit/b0922b32b5d71876d07818a7efcfcf8711b4b82b))
28 | * **deps:** update dependency https-proxy-agent to v5.0.1 ([#296](https://github.com/redhataccess/spandx/issues/296)) ([ed5a2b3](https://github.com/redhataccess/spandx/commit/ed5a2b3fe8080ab51f8cf06fd6eaafff06f4677f))
29 | * **deps:** update dependency https-proxy-agent to v6 ([#322](https://github.com/redhataccess/spandx/issues/322)) ([d2ade82](https://github.com/redhataccess/spandx/commit/d2ade820539b56cdba06f4e5802b841f305f6bf4))
30 | * **deps:** update dependency https-proxy-agent to v7 ([#329](https://github.com/redhataccess/spandx/issues/329)) ([a0bebfa](https://github.com/redhataccess/spandx/commit/a0bebfa0e0d6046d20272c2b713037e1d07e167b))
31 | * **deps:** update dependency inquirer to v8.2.5 ([#244](https://github.com/redhataccess/spandx/issues/244)) ([dbb4ebf](https://github.com/redhataccess/spandx/commit/dbb4ebf55824117585393f2b59475d2b2b56ece1))
32 | * **deps:** update dependency inquirer to v9 ([#316](https://github.com/redhataccess/spandx/issues/316)) ([3d9ac91](https://github.com/redhataccess/spandx/commit/3d9ac911b2d742dd7d6d94173bd89b5914a0cb97))
33 | * **deps:** update dependency inquirer to v9.2.4 ([#321](https://github.com/redhataccess/spandx/issues/321)) ([f0b6eb5](https://github.com/redhataccess/spandx/commit/f0b6eb5dd6bed5da38dc2eee2e74552dacc51861))
34 | * **deps:** update dependency inquirer to v9.2.6 ([#326](https://github.com/redhataccess/spandx/issues/326)) ([ecf1f99](https://github.com/redhataccess/spandx/commit/ecf1f990065b48e8356d84d1d50248e52453e55e))
35 | * **deps:** update dependency proxy-agent to v6 ([#323](https://github.com/redhataccess/spandx/issues/323)) ([884888a](https://github.com/redhataccess/spandx/commit/884888a0f3891dc1a18a5e92e59232708b0b06b4))
36 | * **deps:** update dependency proxy-agent to v6.2.1 ([#328](https://github.com/redhataccess/spandx/issues/328)) ([86ed53b](https://github.com/redhataccess/spandx/commit/86ed53b229ab66684372ec4ed61023d101c3f466))
37 | * **deps:** update dependency serve-static to v1.15.0 ([#305](https://github.com/redhataccess/spandx/issues/305)) ([8d229a2](https://github.com/redhataccess/spandx/commit/8d229a22cd36d7b0f2f23934c9f8f62ee269b6f7))
38 | * **deps:** update dependency yargs to v17.7.1 ([#306](https://github.com/redhataccess/spandx/issues/306)) ([fe2d533](https://github.com/redhataccess/spandx/commit/fe2d53375a6424401ffa8e4f471b349be0c12dcb))
39 | * **deps:** update dependency yargs to v17.7.2 ([#320](https://github.com/redhataccess/spandx/issues/320)) ([af9fcf5](https://github.com/redhataccess/spandx/commit/af9fcf5b1710c53c8dd8b8901663d4ccc44d82a1))
40 |
41 |
42 |
43 | ## [2.2.5](https://github.com/redhataccess/spandx/compare/v2.2.4...v2.2.5) (2022-03-25)
44 |
45 |
46 | ### Bug Fixes
47 |
48 | * **deps:** update dependency browser-sync to v2.27.9 ([#248](https://github.com/redhataccess/spandx/issues/248)) ([f7dfa3a](https://github.com/redhataccess/spandx/commit/f7dfa3afd049fa6fa3b5e39bd5c9243de267cd59))
49 |
50 |
51 |
52 | ## [2.2.4](https://github.com/redhataccess/spandx/compare/v2.2.3...v2.2.4) (2022-03-23)
53 |
54 |
55 | ### Features
56 |
57 | * update `init cp` config, including valid SSL support and proxy settings ([9c2c9a7](https://github.com/redhataccess/spandx/commit/9c2c9a73ff010dae31a46a30d1b9dd54f33667a1))
58 |
59 |
60 |
61 | ## [2.2.3](https://github.com/redhataccess/spandx/compare/v2.2.2...v2.2.3) (2021-12-14)
62 |
63 |
64 | ### Bug Fixes
65 |
66 | * **deps:** update dependency inquirer to v8.1.5 ([#238](https://github.com/redhataccess/spandx/issues/238)) ([ee40f73](https://github.com/redhataccess/spandx/commit/ee40f73cc1dcda34bb6c1d276dc0d55943818466))
67 | * **deps:** update dependency token-slice to v0.0.6 ([#232](https://github.com/redhataccess/spandx/issues/232)) ([5fdca7f](https://github.com/redhataccess/spandx/commit/5fdca7f8b7504315a42210aaf72ca196aca01843))
68 | * **deps:** update dependency yargs to v17.1.0 ([#227](https://github.com/redhataccess/spandx/issues/227)) ([9778cc8](https://github.com/redhataccess/spandx/commit/9778cc8636fcc324318d8ed6523e196a8de1f3fd))
69 | * **deps:** update dependency yargs to v17.1.1 ([#233](https://github.com/redhataccess/spandx/issues/233)) ([f3ee374](https://github.com/redhataccess/spandx/commit/f3ee3748b12ceb299bb71c23fbe342256312c491))
70 |
71 |
72 |
73 | ## [2.2.2](https://github.com/redhataccess/spandx/compare/v2.2.1...v2.2.2) (2021-08-03)
74 |
75 |
76 | ### Bug Fixes
77 |
78 | * declutter up startup logs ([#226](https://github.com/redhataccess/spandx/issues/226)) ([29c4833](https://github.com/redhataccess/spandx/commit/29c4833d2c6f9e06f9b3c1570b93a8d4bb8b3101))
79 |
80 |
81 |
82 | ## [2.2.1](https://github.com/redhataccess/spandx/compare/v2.2.0...v2.2.1) (2021-07-27)
83 |
84 |
85 | ### Bug Fixes
86 |
87 | * de-dupe URL path logging ([#225](https://github.com/redhataccess/spandx/issues/225)) ([bcfa416](https://github.com/redhataccess/spandx/commit/bcfa416091c512a4ac34dda5946f0e7d8f7ee8cd))
88 |
89 |
90 |
91 | # [2.2.0](https://github.com/redhataccess/spandx/compare/v2.1.2...v2.2.0) (2021-07-26)
92 |
93 |
94 | ### Bug Fixes
95 |
96 | * allow certain bs settings to be overridden ([#167](https://github.com/redhataccess/spandx/issues/167)) ([3b55ea1](https://github.com/redhataccess/spandx/commit/3b55ea11d7bb5c0c52bb1f2cd3964128b89b0045))
97 | * **deps:** update dependency connect to v3.7.0 ([#213](https://github.com/redhataccess/spandx/issues/213)) ([7126e16](https://github.com/redhataccess/spandx/commit/7126e16d61aa70c9760b91789d152a32dd9c39ba))
98 | * **deps:** update dependency conventional-changelog-cli to v2.1.1 ([#214](https://github.com/redhataccess/spandx/issues/214)) ([9763b14](https://github.com/redhataccess/spandx/commit/9763b143182fcbefdf86f5f3c9dfd5c314c5b4a4))
99 | * **deps:** update dependency finalhandler to v1.1.2 ([#208](https://github.com/redhataccess/spandx/issues/208)) ([fd4b7e1](https://github.com/redhataccess/spandx/commit/fd4b7e1aadd83e01872646d409324b3aeac80c24))
100 | * **deps:** update dependency hostile to v1.3.3 ([#209](https://github.com/redhataccess/spandx/issues/209)) ([c20b887](https://github.com/redhataccess/spandx/commit/c20b887bfd095e3fb759f77654e596f1f4b4a401))
101 | * **deps:** update dependency http-proxy to v1.18.1 [security] ([#178](https://github.com/redhataccess/spandx/issues/178)) ([57f4f9a](https://github.com/redhataccess/spandx/commit/57f4f9af5041d18f95c99e8ece534cb5551c01fd))
102 | * **deps:** update dependency inquirer to v7.3.2 ([#155](https://github.com/redhataccess/spandx/issues/155)) ([d4f7ec8](https://github.com/redhataccess/spandx/commit/d4f7ec8bd706d2e502341857eadce7dec6bab948))
103 | * **deps:** update dependency inquirer to v7.3.3 ([#157](https://github.com/redhataccess/spandx/issues/157)) ([df66f07](https://github.com/redhataccess/spandx/commit/df66f073c1fd879a45603d3e119a27719c57d44c))
104 | * **deps:** update dependency inquirer to v8 ([#180](https://github.com/redhataccess/spandx/issues/180)) ([67e95b9](https://github.com/redhataccess/spandx/commit/67e95b9fbeb50058cd275d2b1629914544aee1cb))
105 | * **deps:** update dependency inquirer to v8.1.2 ([#210](https://github.com/redhataccess/spandx/issues/210)) ([60953d0](https://github.com/redhataccess/spandx/commit/60953d02f5a5263c4ee44be4e8e17cf6a74986c3))
106 | * **deps:** update dependency lodash to v4.17.21 [security] ([#179](https://github.com/redhataccess/spandx/issues/179)) ([3d01eae](https://github.com/redhataccess/spandx/commit/3d01eae3e0241b1d7112793afbea4e63a6fa79b8))
107 | * **deps:** update dependency proxy-agent to v5 ([#218](https://github.com/redhataccess/spandx/issues/218)) ([d2c2673](https://github.com/redhataccess/spandx/commit/d2c2673a1ba0203f81d2d562d7e371629602c778))
108 | * **deps:** update dependency serve-static to v1.14.1 ([#215](https://github.com/redhataccess/spandx/issues/215)) ([17f0bb3](https://github.com/redhataccess/spandx/commit/17f0bb3d6d8d30d9c756c71501cab26851db5298))
109 | * **deps:** update dependency transformer-proxy to v0.3.5 ([#211](https://github.com/redhataccess/spandx/issues/211)) ([646d551](https://github.com/redhataccess/spandx/commit/646d551a2e59dd783a23b842004de3ab6ab0e025))
110 | * **deps:** update dependency yargs to v16 ([#164](https://github.com/redhataccess/spandx/issues/164)) ([64dd001](https://github.com/redhataccess/spandx/commit/64dd001be12ca6200d1d9a0bbc7edfeac52c9b58))
111 | * **deps:** update dependency yargs to v16.2.0 ([#216](https://github.com/redhataccess/spandx/issues/216)) ([d58e5dc](https://github.com/redhataccess/spandx/commit/d58e5dc31d64ecf4942910682da7eb648ef6aa7a))
112 | * **deps:** update dependency yargs to v17 ([#203](https://github.com/redhataccess/spandx/issues/203)) ([dd088e5](https://github.com/redhataccess/spandx/commit/dd088e55cd6d57966e9565e01d619e9b0efbce6a))
113 | * lock dependency versions ([#207](https://github.com/redhataccess/spandx/issues/207)) ([5c17e73](https://github.com/redhataccess/spandx/commit/5c17e739b84cf1c9276a830b53e8044a213e69d0))
114 | * print correct target url for remote requests ([012b011](https://github.com/redhataccess/spandx/commit/012b01167e44329bec7a94a12333a8154940f5e6))
115 |
116 |
117 | ### Features
118 |
119 | * add primer preview ([#205](https://github.com/redhataccess/spandx/issues/205)) ([2c07cce](https://github.com/redhataccess/spandx/commit/2c07cce8dd0b0d2e3711abd39bfdc13aee1c03e2)), closes [#151](https://github.com/redhataccess/spandx/issues/151) [#180](https://github.com/redhataccess/spandx/issues/180) [#190](https://github.com/redhataccess/spandx/issues/190) [#178](https://github.com/redhataccess/spandx/issues/178) [#175](https://github.com/redhataccess/spandx/issues/175) [#172](https://github.com/redhataccess/spandx/issues/172)
120 |
121 |
122 |
123 | ## [2.1.2](https://github.com/redhataccess/spandx/compare/v2.1.1...v2.1.2) (2020-07-01)
124 |
125 |
126 | ### Bug Fixes
127 |
128 | * Do not use ESI middleware for text streams ([#141](https://github.com/redhataccess/spandx/issues/141)) ([8a291d6](https://github.com/redhataccess/spandx/commit/8a291d6006e55d465d863bfbc8742a8448c9de0c))
129 |
130 |
131 |
132 | ## [2.1.1](https://github.com/redhataccess/spandx/compare/v2.1.0...v2.1.1) (2020-06-25)
133 |
134 | ### Bug Fixes
135 |
136 | * respond with a 502 when remote is unreachable ([#145](https://github.com/redhataccess/spandx/issues/145)) ([4ac3e24](https://github.com/redhataccess/spandx/commit/4ac3e24f8c3752c4691b08d9285fda4ac8932f6d))
137 |
138 |
139 | # [2.1.0](https://github.com/redhataccess/spandx/compare/v2.0.1...v2.1.0) (2020-05-27)
140 |
141 |
142 | ### Features
143 |
144 | * adding the ability to use a proxy server for certain paths ([#143](https://github.com/redhataccess/spandx/issues/143)) ([a220c9e](https://github.com/redhataccess/spandx/commit/a220c9eb189aed3f7dfe0721c793ac39e1fd090c))
145 |
146 |
147 |
148 | ## [2.0.1](https://github.com/redhataccess/spandx/compare/v2.0.0...v2.0.1) (2019-10-18)
149 |
150 |
151 | ### Bug Fixes
152 |
153 | * npm install error related to 'opn' dependency ([fcbf726](https://github.com/redhataccess/spandx/commit/fcbf726e014b5609726c95e96240dcea4b992e50))
154 |
155 |
156 | # 2.0.0
157 |
158 | ## Breaking changes
159 |
160 | ESI is no longer enabled by default. Adding `esi: true` to spandx.config.js will re-enable it.
161 |
162 | ## Changes
163 |
164 | - 28b8a39 allow custom configuration of ESI
165 | - b614c96 revamp README
166 | - 62e285c add `single` setting for routes
167 | - 6c03e75 add `path` setting for routes
168 | - f6da858 fix esi config with multiple hosts, allow overwriting esi config
169 | - c21e2bb extract esi middleware into a separate file
170 | - 2ac5661 restore esi
171 | - cdd9f39 add `init cp` for bootstrapping Customer Portal spandx projects
172 | - 83e9a77 set X-Spandx headers to responses as well as requests
173 | - addde0d fix remote route logging of [object Object] (#56)
174 | - bb8cb2e fix console output of path in local filesystem routes
175 | - c58af4b ensure that test cases wait for static server to close (#53)
176 | - fcb00d9 add Portal Chrome injection settings
177 | - adff1fb Introduce a plugin system for router.js (#31)
178 | - 530f8aa Add renovate for automatic dependency version updates
179 | -
180 | ## Dependency updates
181 |
182 | - a3cad89 Bump lodash from 4.17.10 to 4.17.11
183 | - 80eeb68 Bump ecstatic from 3.2.0 to 3.3.2
184 | - 194ec24 Update dependency nodemon to v1.19.2
185 | - 4248c2d Update dependency husky to v3.0.5
186 | - 9761bae Update dependency lint-staged to v9.2.5
187 | - 69128d9 Update dependency inquirer to v7
188 | - 5f877c7 Update dependency yargs to v14
189 | - fdd9692 Update dependency prettier to v1.18.2
190 | - b4424e2 Update dependency frisby to v2.1.2
191 | - 81e268e Update dependency jasmine to v3.4.0 (#47)
192 | - dfbaadd Update dependency opn to v5.5.0 (#32)
193 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.