Merge tag 'dspace-7.4' into fully-qualified-sitemap-urls-7.4

server.ts

@@ -15,10 +15,11 @@
  * import for `ngExpressEngine`.
  */
 
-import 'zone.js/dist/zone-node';
+import 'zone.js/node';
 import 'reflect-metadata';
 import 'rxjs';
 
+import axios from 'axios';
 import * as pem from 'pem';
 import * as https from 'https';
 import * as morgan from 'morgan';
@@ -26,6 +27,7 @@ import * as express from 'express';
 import * as ejs from 'ejs';
 import * as bodyParser from 'body-parser';
 import * as compression from 'compression';
+import * as expressStaticGzip from 'express-static-gzip';
 
 import { existsSync, readFileSync } from 'fs';
 import { join } from 'path';
@@ -38,15 +40,16 @@ import { REQUEST, RESPONSE } from '@nguniversal/express-engine/tokens';
 
 import { environment } from './src/environments/environment';
 import { createProxyMiddleware } from 'http-proxy-middleware';
-import { hasValue, hasNoValue } from './src/app/shared/empty.util';
+import { hasNoValue, hasValue } from './src/app/shared/empty.util';
 
 import { UIServerConfig } from './src/config/ui-server-config.interface';
 
 import { ServerAppModule } from './src/main.server';
 
 import { buildAppConfig } from './src/config/config.server';
-import { AppConfig, APP_CONFIG } from './src/config/app-config.interface';
+import { APP_CONFIG, AppConfig } from './src/config/app-config.interface';
 import { extendEnvironmentWithAppConfig } from './src/config/config.util';
+import { logStartupMessage } from './startup-message';
 
 /*
  * Set path for the browser application's dist folder
@@ -67,19 +70,29 @@ extendEnvironmentWithAppConfig(environment, appConfig);
 // The Express app is exported so that it can be used by serverless Functions.
 export function app() {
 
+  const router = express.Router();
+
   /*
    * Create a new express application
    */
   const server = express();
 
+  // Tell Express to trust X-FORWARDED-* headers from proxies
+  // See https://expressjs.com/en/guide/behind-proxies.html
+  server.set('trust proxy', environment.ui.useProxies);
+
   /*
    * If production mode is enabled in the environment file:
    * - Enable Angular's production mode
-   * - Enable compression for response bodies. See [compression](https://github.com/expressjs/compression)
+   * - Enable compression for SSR reponses. See [compression](https://github.com/expressjs/compression)
    */
   if (environment.production) {
     enableProdMode();
-    server.use(compression());
+    server.use(compression({
+      // only compress responses we've marked as SSR
+      // otherwise, this middleware may compress files we've chosen not to compress via compression-webpack-plugin
+      filter: (_, res) => res.locals.ssr,
+    }));
   }
 
   /*
@@ -147,7 +160,11 @@ export function app() {
   /**
    * Proxy the sitemaps
    */
-  server.use('/sitemap**', createProxyMiddleware({ target: `${environment.rest.baseUrl}/sitemaps`, changeOrigin: true }));
+  router.use('/sitemap**', createProxyMiddleware({
+    target: `${environment.rest.baseUrl}/sitemaps`,
+    pathRewrite: path => path.replace(environment.ui.nameSpace, '/'),
+    changeOrigin: true
+  }));
 
   /**
    * Checks if the rateLimiter property is present
@@ -164,15 +181,28 @@ export function app() {
 
   /*
    * Serve static resources (images, i18n messages, …)
+   * Handle pre-compressed files with [express-static-gzip](https://github.com/tkoenig89/express-static-gzip)
    */
-  server.get('*.*', cacheControl, express.static(DIST_FOLDER, { index: false }));
+  router.get('*.*', cacheControl, expressStaticGzip(DIST_FOLDER, {
+    index: false,
+    enableBrotli: true,
+    orderPreference: ['br', 'gzip'],
+  }));
+
   /*
   * Fallthrough to the IIIF viewer (must be included in the build).
   */
-  server.use('/iiif', express.static(IIIF_VIEWER, {index:false}));
+  router.use('/iiif', express.static(IIIF_VIEWER, { index: false }));
+
+  /**
+   * Checking server status
+   */
+  server.get('/app/health', healthCheck);
 
   // Register the ngApp callback function to handle incoming requests
-  server.get('*', ngApp);
+  router.get('*', ngApp);
+
+  server.use(environment.ui.nameSpace, router);
 
   return server;
 }
@@ -194,6 +224,7 @@ function ngApp(req, res) {
       providers: [{ provide: APP_BASE_HREF, useValue: req.baseUrl }]
     }, (err, data) => {
       if (hasNoValue(err) && hasValue(data)) {
+        res.locals.ssr = true;  // mark response as SSR
         res.send(data);
       } else if (hasValue(err) && err.code === 'ERR_HTTP_HEADERS_SENT') {
         // When this error occurs we can't fall back to CSR because the response has already been
@@ -205,13 +236,25 @@ function ngApp(req, res) {
         if (hasValue(err)) {
           console.warn('Error details : ', err);
         }
-        res.sendFile(DIST_FOLDER + '/index.html');
+        res.render(indexHtml, {
+          req,
+          providers: [{
+            provide: APP_BASE_HREF,
+            useValue: req.baseUrl
+          }]
+        });
       }
     });
   } else {
     // If preboot is disabled, just serve the client
     console.log('Universal off, serving for direct CSR');
-    res.sendFile(DIST_FOLDER + '/index.html');
+    res.render(indexHtml, {
+      req,
+      providers: [{
+        provide: APP_BASE_HREF,
+        useValue: req.baseUrl
+      }]
+    });
   }
 }
 
@@ -257,6 +300,8 @@ function run() {
 }
 
 function start() {
+  logStartupMessage(environment);
+
   /*
   * If SSL is enabled
   * - Read credentials from configuration files
@@ -301,6 +346,21 @@ function start() {
   }
 }
 
+/*
+ * The callback function to serve health check requests
+ */
+function healthCheck(req, res) {
+  const baseUrl = `${environment.rest.baseUrl}${environment.actuators.endpointPath}`;
+  axios.get(baseUrl)
+    .then((response) => {
+      res.status(response.status).send(response.data);
+    })
+    .catch((error) => {
+      res.status(error.response.status).send({
+        error: error.message
+      });
+    });
+}
 // Webpack will replace 'require' with '__webpack_require__'
 // '__non_webpack_require__' is a proxy to Node 'require'
 // The below code is to ensure that the server is run only when not requiring the bundle.