feat: add support for cdnPrefix for static assets (#1191)

src/lib/__snapshots__/create-config.test.ts.snap

@@ -63,6 +63,7 @@ Object {
   "secureHeaders": false,
   "server": Object {
     "baseUriPath": "",
+    "cdnPrefix": undefined,
     "enableRequestLogger": false,
     "gracefulShutdownEnable": true,
     "gracefulShutdownTimeout": 1000,

src/lib/app.test.ts

@@ -11,32 +11,32 @@ jest.mock(
         },
 );
 
-const getApp = require('./app');
+const getApp = require('./app').default;
 
-test('should not throw when valid config', () => {
+test('should not throw when valid config', async () => {
     const config = createTestConfig();
-    const app = getApp(config, {}, {});
+    const app = await getApp(config, {}, {});
     expect(typeof app.listen).toBe('function');
 });
 
-test('should call preHook', () => {
+test('should call preHook', async () => {
     let called = 0;
     const config = createTestConfig({
         preHook: () => {
             called++;
         },
     });
-    getApp(config, {}, {});
+    await getApp(config, {}, {});
     expect(called).toBe(1);
 });
 
-test('should call preRouterHook', () => {
+test('should call preRouterHook', async () => {
     let called = 0;
     const config = createTestConfig({
         preRouterHook: () => {
             called++;
         },
     });
-    getApp(config, {}, {});
+    await getApp(config, {}, {});
     expect(called).toBe(1);
 });

src/lib/app.ts

@@ -1,5 +1,4 @@
 import { publicFolder } from 'unleash-frontend';
-import fs from 'fs';
 import express, { Application, RequestHandler } from 'express';
 import cors from 'cors';
 import compression from 'compression';
@@ -22,23 +21,19 @@ import ossAuthentication from './middleware/oss-authentication';
 import noAuthentication from './middleware/no-authentication';
 import secureHeaders from './middleware/secure-headers';
 
-import { rewriteHTML } from './util/rewriteHTML';
+import { loadIndexHTML } from './util/load-index-html';
 
-export default function getApp(
+export default async function getApp(
     config: IUnleashConfig,
     stores: IUnleashStores,
     services: IUnleashServices,
     unleashSession?: RequestHandler,
-): Application {
+): Promise<Application> {
     const app = express();
 
     const baseUriPath = config.server.baseUriPath || '';
 
-    let indexHTML = fs
-        .readFileSync(path.join(publicFolder, 'index.html'))
-        .toString();
-
-    indexHTML = rewriteHTML(indexHTML, baseUriPath);
+    let indexHTML = await loadIndexHTML(config, publicFolder);
 
     app.set('trust proxy', true);
     app.disable('x-powered-by');
@@ -68,7 +63,7 @@ export default function getApp(
     app.use(secureHeaders(config));
     app.use(express.urlencoded({ extended: true }));
     app.use(favicon(path.join(publicFolder, 'favicon.ico')));
-
+    app.use(baseUriPath, favicon(path.join(publicFolder, 'favicon.ico')));
     app.use(baseUriPath, express.static(publicFolder, { index: false }));
 
     if (config.enableOAS) {
@@ -151,4 +146,3 @@ export default function getApp(
     });
     return app;
 }
-module.exports = getApp;

src/lib/create-config.ts

@@ -107,6 +107,7 @@ const defaultServerOption: IServerOption = {
     host: process.env.HTTP_HOST,
     port: safeNumber(process.env.HTTP_PORT || process.env.PORT, 4242),
     baseUriPath: formatBaseUri(process.env.BASE_URI_PATH),
+    cdnPrefix: process.env.CDN_PREFIX,
     unleashUrl: process.env.UNLEASH_URL || 'http://localhost:4242',
     serverMetrics: true,
     keepAliveTimeout: minutesToMilliseconds(1),

src/lib/middleware/oss-authentication.test.ts

@@ -8,7 +8,7 @@ import getApp from '../app';
 import User from '../types/user';
 import sessionDb from './session-db';
 
-function getSetup(preRouterHook) {
+async function getSetup(preRouterHook) {
     const base = `/random${Math.round(Math.random() * 1000)}`;
     const config = createTestConfig({
         server: { baseUriPath: base },
@@ -23,25 +23,25 @@ function getSetup(preRouterHook) {
     const stores = createStores();
     const services = createServices(stores, config);
     const unleashSession = sessionDb(config, undefined);
-    const app = getApp(config, stores, services, unleashSession);
+    const app = await getApp(config, stores, services, unleashSession);
 
     return {
         base,
         request: supertest(app),
     };
 }
 
-test('should return 401 when missing user', () => {
+test('should return 401 when missing user', async () => {
     expect.assertions(0);
-    const { base, request } = getSetup(() => {});
+    const { base, request } = await getSetup(() => {});
 
     return request.get(`${base}/api/protectedResource`).expect(401);
 });
 
-test('should return 200 when user exists', () => {
+test('should return 200 when user exists', async () => {
     expect.assertions(0);
     const user = new User({ id: 1, email: 'some@mail.com' });
-    const { base, request } = getSetup((app) =>
+    const { base, request } = await getSetup((app) =>
         app.use((req, res, next) => {
             req.user = user;
             next();

src/lib/routes/admin-api/config.test.ts

@@ -10,7 +10,7 @@ const uiConfig = {
     slogan: 'hello',
 };
 
-function getSetup() {
+async function getSetup() {
     const base = `/random${Math.round(Math.random() * 1000)}`;
     const config = createTestConfig({
         server: { baseUriPath: base },
@@ -19,7 +19,7 @@ function getSetup() {
     const stores = createStores();
     const services = createServices(stores, config);
 
-    const app = getApp(config, stores, services);
+    const app = await getApp(config, stores, services);
 
     return {
         base,
@@ -36,8 +36,8 @@ let request;
 let base;
 let destroy;
 
-beforeEach(() => {
-    const setup = getSetup();
+beforeEach(async () => {
+    const setup = await getSetup();
     request = setup.request;
     base = setup.base;
     destroy = setup.destroy;

src/lib/routes/admin-api/context.test.ts

@@ -5,7 +5,7 @@ import { createServices } from '../../services';
 import permissions from '../../../test/fixtures/permissions';
 import getApp from '../../app';
 
-function getSetup() {
+async function getSetup() {
     const base = `/random${Math.round(Math.random() * 1000)}`;
     const perms = permissions();
     const config = createTestConfig({
@@ -15,7 +15,7 @@ function getSetup() {
     const stores = createStores();
 
     const services = createServices(stores, config);
-    const app = getApp(config, stores, services);
+    const app = await getApp(config, stores, services);
 
     return {
         base,
@@ -32,8 +32,8 @@ let base;
 let request;
 let destroy;
 
-beforeEach(() => {
-    const setup = getSetup();
+beforeEach(async () => {
+    const setup = await getSetup();
     base = setup.base;
     request = setup.request;
     destroy = setup.destroy;

src/lib/routes/admin-api/email.test.ts

@@ -5,7 +5,7 @@ import { createServices } from '../../services';
 import permissions from '../../../test/fixtures/permissions';
 import getApp from '../../app';
 
-function getSetup() {
+async function getSetup() {
     const base = `/random${Math.round(Math.random() * 1000)}`;
     const stores = createStores();
     const perms = permissions();
@@ -15,17 +15,17 @@ function getSetup() {
     });
 
     const services = createServices(stores, config);
-    const app = getApp(config, stores, services);
+    const app = await getApp(config, stores, services);
 
     return {
         base,
         request: supertest(app),
     };
 }
 
-test('should render html preview of template', () => {
+test('should render html preview of template', async () => {
     expect.assertions(0);
-    const { request, base } = getSetup();
+    const { request, base } = await getSetup();
     return request
         .get(
             `${base}/api/admin/email/preview/html/reset-password?name=Test%20Test`,
@@ -35,9 +35,9 @@ test('should render html preview of template', () => {
         .expect((res) => 'Test Test' in res.body);
 });
 
-test('should render text preview of template', () => {
+test('should render text preview of template', async () => {
     expect.assertions(0);
-    const { request, base } = getSetup();
+    const { request, base } = await getSetup();
     return request
         .get(
             `${base}/api/admin/email/preview/text/reset-password?name=Test%20Test`,
@@ -47,9 +47,9 @@ test('should render text preview of template', () => {
         .expect((res) => 'Test Test' in res.body);
 });
 
-test('Requesting a non-existing template should yield 404', () => {
+test('Requesting a non-existing template should yield 404', async () => {
     expect.assertions(0);
-    const { request, base } = getSetup();
+    const { request, base } = await getSetup();
     return request
         .get(`${base}/api/admin/email/preview/text/some-non-existing-template`)
         .expect(404);

src/lib/routes/admin-api/events.test.ts

@@ -6,21 +6,21 @@ import createStores from '../../../test/fixtures/store';
 
 import getApp from '../../app';
 
-function getSetup() {
+async function getSetup() {
     const base = `/random${Math.round(Math.random() * 1000)}`;
     const stores = createStores();
     const config = createTestConfig({
         server: { baseUriPath: base },
     });
     const services = createServices(stores, config);
-    const app = getApp(config, stores, services);
+    const app = await getApp(config, stores, services);
 
     return { base, eventStore: stores.eventStore, request: supertest(app) };
 }
 
-test('should get empty events list via admin', () => {
+test('should get empty events list via admin', async () => {
     expect.assertions(1);
-    const { request, base } = getSetup();
+    const { request, base } = await getSetup();
     return request
         .get(`${base}/api/admin/events`)
         .expect('Content-Type', /json/)

src/lib/routes/admin-api/metrics.test.ts

@@ -5,14 +5,14 @@ import getApp from '../../app';
 import { createTestConfig } from '../../../test/config/test-config';
 import { createServices } from '../../services';
 
-function getSetup() {
+async function getSetup() {
     const stores = createStores();
     const perms = permissions();
     const config = createTestConfig({
         preRouterHook: perms.hook,
     });
     const services = createServices(stores, config);
-    const app = getApp(config, stores, services);
+    const app = await getApp(config, stores, services);
 
     return {
         request: supertest(app),
@@ -30,8 +30,8 @@ let stores;
 let request;
 let destroy;
 
-beforeEach(() => {
-    const setup = getSetup();
+beforeEach(async () => {
+    const setup = await getSetup();
     stores = setup.stores;
     request = setup.request;
     destroy = setup.destroy;