Adds an option to start HTTPS server rather than HTTP one

birdofpreyru · birdofpreyru · commit b664431c6b0c · 2018-08-14T01:17:48.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,8 @@
 # Topcoder React Utils Changelog
 
 ### v0.8.1
+- Adds `https` option to the [standard server factory](docs/server.md),
+  which makes it easy to run the app on HTTPS instead of HTTP.
 - Adds `workbox` option to the Wepback configuration factory for app
   ([**`config/webpack/app-base`**](docs/webpack-config.md#configuration-details)).
 
diff --git a/docs/server.md b/docs/server.md
@@ -47,14 +47,6 @@ props:
 - **`Application`** &mdash; *Component* &mdash; Optional. The root ReactJS
   component of the app. If provided, server will perform server-side rendering,
   and it will inject the rendered markup into the HTML template it serves.
-- **`devMode`** &mdash; *Boolean* &mdash; Optional. Specifies, whether the
-  server should be launched in the development mode.
-- **`favicon`** &mdash; *String* &mdash; Optional. Path to the favicon to be
-  served by the server.
-- **`logger`** &mdash; *Object* &mdash; Optional. The logger to be used for
-  logging. Defaults to `console`, otherwise it is expected to provide the same
-  interface. Note that `console` is not efficient for production use, because
-  it is not async in NodeJS.
 - **`beforeRender`** &mdash; *Function(req, config)* &mdash; Optional. The hook to be
   executed right before the generation of HTML template of the page.
 
@@ -72,6 +64,24 @@ props:
     injected into the page.
   - **`store`** &mdash; *Object* &mdash; Redux store which state will be
     injected into HTML template as the initial state of the app.
+
+- **`devMode`** &mdash; *Boolean* &mdash; Optional. Specifies, whether the
+  server should be launched in the development mode.
+- **`favicon`** &mdash; *String* &mdash; Optional. Path to the favicon to be
+  served by the server.
+- **`https`** &ndash; *Object* &ndash; Optional. Should be an object with two
+  string fields:
+  - **`cert`** &ndash; *String* &ndash; SSL sertificate;
+  - **`key`** &ndash; *String* &ndash; SSL key.
+
+  For this to work on *localhost* you'll have to create and properly install
+  a self-signed SSL certificate on your system. Instructions in this article
+  should help: [How to get HTTPS working on your local development environment in 5 minutes](https://medium.freecodecamp.org/how-to-get-https-working-on-your-local-development-environment-in-5-minutes-7af615770eec)
+
+- **`logger`** &mdash; *Object* &mdash; Optional. The logger to be used for
+  logging. Defaults to `console`, otherwise it is expected to provide the same
+  interface. Note that `console` is not efficient for production use, because
+  it is not async in NodeJS.
 - **`onExpressJsSetup`** &mdash; *Function* &mdash; Custom setup of ExpressJS
   server. Express server instance will be passed in as the only argument to this
   function.
diff --git a/src/server/index.js b/src/server/index.js
@@ -4,6 +4,7 @@
 
 import _ from 'lodash';
 import http from 'http';
+import https from 'https';
 
 /* Polyfill required by ReactJS. */
 import 'raf/polyfill';
@@ -34,6 +35,11 @@ function normalizePort(value) {
  *  - logger {Object} - Optional. The logger to use. By default, the console
  *    is used (which is not a good decision performancewise, but it will be
  *    changed soon);
+ *  - https {Object} - Optional. If given, HTTPS server will be started with
+ *    the specified settings. HTTP server that hanles HTTP > HTTPS redirection
+ *    will be also started at the specified port. Expected fields:
+ *    - cert {String} - SSL Certificate;
+ *    - key {String} - SSL key;
  *  - beforeRender {Function} - The hook into server-side rendering. It will get
  *    incoming request as the argument and it should return a promise that will
  *    resolve to the object with the following fields all optional:
@@ -49,7 +55,7 @@ function normalizePort(value) {
  *    default to 3000 otherwise.
  * @return {Promise} Resolves to the result object has two fields:
  *  - express {Object} - ExpressJS server;
- *  - http {Object} - NodeJS HTTP server.
+ *  - httpServer {Object} - NodeJS HTTP(S) server.
  */
 export default async function launch(webpackConfig, options) {
   /* Options normalization. */
@@ -61,9 +67,16 @@ export default async function launch(webpackConfig, options) {
 
   /* Creates servers, resolves and sets the port. */
   const expressServer = await serverFactory(webpackConfig, ops);
-  const httpServer = http.createServer(expressServer);
 
-  /* Sets error handler for HTTP server. */
+  let httpServer;
+  if (ops.https) {
+    httpServer = https.createServer({
+      cert: ops.https.cert,
+      key: ops.https.key,
+    }, expressServer);
+  } else httpServer = http.createServer(expressServer);
+
+  /* Sets error handler for HTTP(S) server. */
   httpServer.on('error', (error) => {
     if (error.syscall !== 'listen') throw error;
     const bind = _.isString(ops.port) ? `Pipe ${ops.port}` : `Port ${ops.port}`;
@@ -83,7 +96,7 @@ export default async function launch(webpackConfig, options) {
     }
   });
 
-  /* Listening event handler for HTTP server. */
+  /* Listening event handler for HTTP(S) server. */
   httpServer.on('listening', () => {
     const addr = httpServer.address();
     const bind = _.isString(addr) ? `pipe ${addr}` : `port ${addr.port}`;
