[feature]: Add option to use custom https certificates with buildpack (…

…#2946)

* create option to use custom key and cert for https

* remove old variable definitions

* Add default values to the custom http env definitions

* Update logger messages

* Fix typo and update description

* Update snapshot

* update snapshots

* add test coverage

Co-authored-by: arturtreiberg <artur.treiberg@adm.ee>
Co-authored-by: Devagouda <40405790+dpatil-magento@users.noreply.github.com>

packages/pwa-buildpack/envVarDefinitions.json

@@ -196,6 +196,23 @@
                 }
             ]
         },
+        {
+            "name": "Custom HTTPS certificates",
+            "variables": [
+                {
+                    "name": "CUSTOM_HTTPS_KEY",
+                    "type": "str",
+                    "desc": "Absolute path to the custom HTTPS certificate key file.",
+                    "default": ""
+                },
+                {
+                    "name": "CUSTOM_HTTPS_CERT",
+                    "type": "str",
+                    "desc": "Absolute path to the custom HTTPS certificate cert file.",
+                    "default": ""
+                }
+            ]
+        },
         {
             "name": "Express compression settings",
             "variables": [

packages/pwa-buildpack/lib/Utilities/__tests__/__snapshots__/createDotEnvFile.spec.js.snap

@@ -167,6 +167,18 @@ BUILDBUS_DEPS_ADDITIONAL=
 #
 ################################################################################
 
+#### Custom HTTPS certificates #################################################
+#
+#   Absolute path to the custom HTTPS certificate key file.
+#   - Default when not set: 
+CUSTOM_HTTPS_KEY=
+#
+#   Absolute path to the custom HTTPS certificate cert file.
+#   - Default when not set: 
+CUSTOM_HTTPS_CERT=
+#
+################################################################################
+
 #### Express compression settings ##############################################
 #
 #   Specify if express server compression needs to be enabled. Defaults to false if not provided.

packages/pwa-buildpack/lib/Utilities/__tests__/__snapshots__/serve.spec.js.snap

@@ -115,6 +115,44 @@ UPWARD server running.",
 }
 `;
 
+exports[`should throw a warning if key and cert paths are provided but cert doesnt exist 1`] = `
+Object {
+  "error": Array [],
+  "info": Array [
+    "PORT is set in environment: 1234",
+    "NODE_ENV=production, will not attempt to use custom host or port",
+    "Launching UPWARD server
+",
+  ],
+  "success": Array [
+    "
+UPWARD server running.",
+  ],
+  "warn": Array [
+    "Custom key and cert paths provided but files not found, creating HTTP server.",
+  ],
+}
+`;
+
+exports[`should throw a warning if key and cert paths are provided but key doesnt exist 1`] = `
+Object {
+  "error": Array [],
+  "info": Array [
+    "PORT is set in environment: 1234",
+    "NODE_ENV=production, will not attempt to use custom host or port",
+    "Launching UPWARD server
+",
+  ],
+  "success": Array [
+    "
+UPWARD server running.",
+  ],
+  "warn": Array [
+    "Custom key and cert paths provided but files not found, creating HTTP server.",
+  ],
+}
+`;
+
 exports[`should throw error if unable to load env 1`] = `[Error: Can not load environment config!]`;
 
 exports[`should throw error if unable to load env 2`] = `
@@ -154,6 +192,24 @@ UPWARD server running.",
 }
 `;
 
+exports[`should use custom https if key and cert paths provided from the env 1`] = `
+Object {
+  "error": Array [],
+  "info": Array [
+    "Custom key and cert paths provided, creating HTTPS server.",
+    "PORT is set in environment: 1234",
+    "NODE_ENV=production, will not attempt to use custom host or port",
+    "Launching UPWARD server
+",
+  ],
+  "success": Array [
+    "
+UPWARD server running.",
+  ],
+  "warn": Array [],
+}
+`;
+
 exports[`should use env.PORT if provided 1`] = `
 Object {
   "error": Array [],

packages/pwa-buildpack/lib/Utilities/__tests__/serve.spec.js

@@ -1,3 +1,6 @@
+jest.mock('fs');
+const { existsSync, readFileSync } = require('fs');
+
 const { createUpwardServer } = require('@magento/upward-js');
 const compression = require('compression');
 const serve = require('../serve');
@@ -67,6 +70,7 @@ const getImageServiceConfig = jest.fn().mockReturnValue({});
 const getCustomOriginConfig = jest.fn().mockReturnValue({
     enabled: false
 });
+const getcustomHttpsConfig = jest.fn().mockReturnValue({});
 
 const getSectionData = sectionName => {
     if (sectionName === 'stagingServer') {
@@ -79,6 +83,8 @@ const getSectionData = sectionName => {
         return getImageServiceConfig();
     } else if (sectionName === 'customOrigin') {
         return getCustomOriginConfig();
+    } else if (sectionName === 'customHttps') {
+        return getcustomHttpsConfig();
     } else {
         return {};
     }
@@ -115,6 +121,11 @@ beforeEach(() => {
     );
 });
 
+afterEach(() => {
+    existsSync.mockReset();
+    readFileSync.mockReset();
+});
+
 test('should create upward server', async () => {
     const server = await serve('pwa-buildpack');
 
@@ -284,3 +295,92 @@ test('should log error if configureHost throws error', async () => {
 
     expect(logs).toMatchSnapshot();
 });
+
+test('should use custom https if key and cert paths provided from the env', async () => {
+    const key = 'path/to/key';
+    const cert = 'path/to/cert';
+    getcustomHttpsConfig.mockReturnValueOnce({
+        key,
+        cert
+    });
+    // mock that files exist
+    existsSync.mockReturnValue(true);
+    readFileSync
+        .mockReturnValueOnce('key_for_https')
+        .mockReturnValueOnce('cert_for_https');
+    await serve('pwa-buildpack');
+
+    // check if files exist
+    expect(existsSync).toBeCalledTimes(2);
+    expect(existsSync.mock.calls[0][0]).toBe(key);
+    expect(existsSync.mock.calls[1][0]).toBe(cert);
+
+    // check if both files are also read
+    expect(readFileSync).toBeCalledTimes(2);
+    expect(readFileSync.mock.calls[0]).toEqual([key, 'utf8']);
+    expect(readFileSync.mock.calls[1]).toEqual([cert, 'utf8']);
+
+    // upward server should now have custom key and cert
+    expect(createUpwardServer.mock.calls[0][0].https).toEqual({
+        key: 'key_for_https',
+        cert: 'cert_for_https'
+    });
+    // logs info that creating HTTPS server with custom cert and key
+    expect(logs).toMatchSnapshot();
+});
+
+test('should throw a warning if key and cert paths are provided but key doesnt exist', async () => {
+    const key = 'path/to/key';
+    const cert = 'path/to/cert';
+    getcustomHttpsConfig.mockReturnValueOnce({
+        key,
+        cert
+    });
+    existsSync.mockReturnValueOnce(false);
+
+    await serve('pwa-buildpack');
+
+    // will be called only once and fail on the if statement
+    expect(existsSync).toBeCalledTimes(1);
+
+    // should not try to read files
+    expect(readFileSync).not.toBeCalled();
+    expect(logs.warn.length).toBe(1);
+    expect(logs).toMatchSnapshot();
+    expect(createUpwardServer.mock.calls[0][0].https).toBe(undefined);
+});
+
+test('should throw a warning if key and cert paths are provided but cert doesnt exist', async () => {
+    const key = 'path/to/key';
+    const cert = 'path/to/cert';
+    getcustomHttpsConfig.mockReturnValueOnce({
+        key,
+        cert
+    });
+    existsSync.mockReturnValueOnce(true).mockReturnValueOnce(false);
+
+    await serve('pwa-buildpack');
+
+    // will be called twice and fail on the if statement
+    expect(existsSync).toBeCalledTimes(2);
+
+    // should not try to read files
+    expect(readFileSync).not.toBeCalled();
+    expect(logs.warn.length).toBe(1);
+    expect(logs).toMatchSnapshot();
+    expect(createUpwardServer.mock.calls[0][0].https).toBe(undefined);
+});
+
+test('should not try to read custom key and cert if one of them is missing', async () => {
+    const key = 'path/to/key';
+    getcustomHttpsConfig.mockReturnValueOnce({
+        key,
+        cert: undefined
+    });
+
+    await serve('pwa-buildpack');
+
+    expect(existsSync).not.toBeCalled();
+    expect(readFileSync).not.toBeCalled();
+    expect(createUpwardServer.mock.calls[0][0].https).toBe(undefined);
+});

packages/pwa-buildpack/lib/Utilities/serve.js

@@ -1,5 +1,6 @@
 const loadEnvironment = require('../Utilities/loadEnvironment');
 const path = require('path');
+const { existsSync, readFileSync } = require('fs');
 const compression = require('compression');
 
 module.exports = async function serve(dirname) {
@@ -12,6 +13,7 @@ module.exports = async function serve(dirname) {
     const prettyLogger = require('../util/pretty-logger');
     const addImgOptMiddleware = require('./addImgOptMiddleware');
     const stagingServerSettings = config.section('stagingServer');
+    const customHttpsSettings = config.section('customHttps');
 
     process.chdir(path.join(dirname, 'dist'));
 
@@ -41,6 +43,24 @@ module.exports = async function serve(dirname) {
         }
     );
 
+    if (customHttpsSettings.key && customHttpsSettings.cert) {
+        const { key, cert } = customHttpsSettings;
+        if (existsSync(key) && existsSync(cert)) {
+            prettyLogger.info(
+                'Custom key and cert paths provided, creating HTTPS server.'
+            );
+            const ssl = {
+                key: readFileSync(key, 'utf8'),
+                cert: readFileSync(cert, 'utf8')
+            };
+            upwardServerOptions.https = ssl;
+        } else {
+            prettyLogger.warn(
+                'Custom key and cert paths provided but files not found, creating HTTP server.'
+            );
+        }
+    }
+
     let envPort;
     /**
      * null and undefined are represented as strings in the env
@@ -86,8 +106,10 @@ module.exports = async function serve(dirname) {
                     })
                 );
                 upwardServerOptions.host = hostname;
-                upwardServerOptions.https = ssl;
                 upwardServerOptions.port = envPort || ports.staging || 0;
+                if (!upwardServerOptions.https) {
+                    upwardServerOptions.https = ssl;
+                }
             } catch (e) {
                 prettyLogger.error(
                     'Could not configure or access custom host. Using loopback...',