fix(stateConfig): use ip when useHost flag is passed (#327)

__tests__/server/middleware/pwa/offline.spec.jsx

@@ -30,6 +30,7 @@ import { configurePWA } from '../../../../src/server/middleware/pwa/config';
 
 import createOfflineMiddleware from '../../../../src/server/middleware/pwa/offline';
 
+jest.mock('yargs', () => ({ argv: {} })); // we are importing yargs in stateConfig and needs to be mocked
 jest.mock('../../../../src/server/middleware/sendHtml', () => jest.fn());
 jest.mock('fs', () => ({
   existsSync: () => false,

__tests__/server/utils/__snapshots__/stateConfig.spec.js.snap

@@ -1,5 +1,17 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`stateConfig methods stateConfig with dev endpoint config dev endpoints should use ip instead of localhost when useHost is passed as arg 1`] = `
+Object {
+  "someOtherApiUrl": "http://127.0.0.1:3002/some-other-api",
+}
+`;
+
+exports[`stateConfig methods stateConfig with dev endpoint config dev endpoints should use ip instead of localhost when useHost is passed as arg 2`] = `
+Object {
+  "someOtherApiUrl": "http://127.0.0.1:3002/some-other-api",
+}
+`;
+
 exports[`stateConfig methods stateConfig with dev endpoint config should show dev endpoint supplied config 1`] = `
 Object {
   "someOtherApiUrl": "http://localhost:3002/some-other-api",

__tests__/server/utils/stateConfig.spec.js

@@ -15,7 +15,9 @@
  */
 
 jest.mock('fs', () => ({ existsSync: jest.fn() }));
+jest.mock('ip', () => ({ address: jest.fn() }));
 jest.mock('fake/path/.dev/endpoints/index.js', () => jest.fn(), { virtual: true });
+jest.mock('yargs', () => ({ argv: {} }));
 jest.mock('../../../src/server/utils/envVarAllowList', () => [
   'ONE_CLIENT_FAKE_SETTING',
   'ONE_FAKE_SETTING',
@@ -32,12 +34,18 @@ describe('stateConfig methods', () => {
   let restoreModuleStateConfig;
   let backupModuleStateConfig;
   let fs;
+  let ip;
+  let yargs;
 
   const originalEnvVars = process.env;
 
   const reloadMocks = () => {
     fs = require('fs');
+    ip = require('ip');
+    yargs = require('yargs');
     jest.spyOn(process, 'cwd').mockImplementation(() => 'fake/path/');
+    ip.address.mockImplementation(() => '127.0.0.1');
+    yargs.argv = {};
     fs.existsSync.mockImplementation(() => false);
     process.env.ONE_CONFIG_ENV = 'qa';
     provideStateConfig = {
@@ -191,6 +199,24 @@ describe('stateConfig methods', () => {
         expect(getClientStateConfig()).toMatchSnapshot();
         expect(getServerStateConfig()).toMatchSnapshot();
       });
+      it('dev endpoints should use ip instead of localhost when useHost is passed as arg', () => {
+        process.env.NODE_ENV = 'development';
+        yargs.argv = { useHost: true };
+        // eslint-disable-next-line unicorn/import-index, import/no-unresolved
+        require('fake/path/.dev/endpoints/index.js').mockImplementation(() => ({
+          someOtherApiUrl: {
+            devProxyPath: 'some-other-api',
+            destination: 'https://intranet-origin-dev.example.com/some-other-api/v1',
+          },
+        }));
+        ({
+          setStateConfig,
+          getClientStateConfig,
+          getServerStateConfig,
+        } = require('../../../src/server/utils/stateConfig'));
+        expect(getClientStateConfig()).toMatchSnapshot();
+        expect(getServerStateConfig()).toMatchSnapshot();
+      });
       it('dev endpoint should not have doubled slash in path', () => {
         process.env.NODE_ENV = 'development';
         // eslint-disable-next-line unicorn/import-index, import/no-unresolved

src/server/utils/stateConfig.js

@@ -17,6 +17,8 @@
 import fs from 'fs';
 import path from 'path';
 import url from 'url';
+import ip from 'ip';
+import { argv } from 'yargs';
 import envVarAllowList from './envVarAllowList';
 import snakeCaseToCamelCase from './snakeCaseToCamelCase';
 
@@ -77,7 +79,7 @@ if (process.env.NODE_ENV === 'development' && fs.existsSync(pathToDevEndpoints))
   Object.entries(devEndpoints).forEach(([configName, { devProxyPath }]) => {
     const value = url.format({
       protocol: 'http',
-      hostname: 'localhost',
+      hostname: argv.useHost ? `${ip.address()}` : 'localhost',
       port: HTTP_ONE_APP_DEV_PROXY_SERVER_PORT,
       pathname: devProxyPath,
     });