Merge branch 'client/support-es5-target'

winwiz1 · Feb 8, 2020 · 27c5520 · 27c5520
2 parents 7f35f1d + bc8313d
commit 27c5520
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 40 deletions.
diff --git a/README.md b/README.md
@@ -203,9 +203,9 @@ To turn off code splitting using multiple SPAs simply leave one SPA in the SPA C
 
 > Tip: Let's assume over the time the application has grown and acquired extensive reporting capabilities, perhaps with a reporting dashboard that imports many components. In this case the third SPA and its entry point `reporting.tsx` can be added to the SPA Configuration block. The entry point would import the dashboard and use it for rendering. Such an addition would take little time but bring performance and development/testing benefits. For example, some tests can focus on a React application which has the reporting SPA as the only entry in the SPA Configuration block thus taking the rest of the application out of the testing scope.
 ### Integration with UI and CSS Libraries
-Both libraries ([Semantic UI](https://react.semantic-ui.com) and [Typestyle](https://typestyle.github.io) respectively) provide React with the type safety afforded by Typescript.
+Both libraries ([Semantic UI](https://react.semantic-ui.com) and [Typestyle](https://typestyle.github.io) respectively) provide React with the type safety afforded by TypeScript.
 ### Testing
-Debuggable test cases written in Typescript. Integration with [React Testing Library](https://testing-library.com/docs/react-testing-library/intro) on the client and [Supertest](https://github.com/visionmedia/supertest) on the backend. Both using [Jest](https://jestjs.io/) as an engine.<br/>
+Debuggable test cases written in TypeScript. Integration with [React Testing Library](https://testing-library.com/docs/react-testing-library/intro) on the client and [Supertest](https://github.com/visionmedia/supertest) on the backend. Both using [Jest](https://jestjs.io/) as an engine.<br/>
 The client and backend can be tested independently by executing the `yarn test` command. Alternatively the same command can be executed at the workspace level.
 
 The repository is integrated with Travis CI and the test outcome is reflected by the test badge.
@@ -386,8 +386,21 @@ A: It depends. These two are complimentary techniques. Obviously once a bundle g
 Q: How can I add my own HTML including polyfills etc. to the generated .html files?<br/>
 A: Use react-helmet to add additional HTML tags to the `<head>` element and modify the existing ones. Alternatively use the `client\src\entrypoints\head-snippet.html` file. Its content is inserted into the `<head>` element. You can add a [bodyHtmlSnippet](https://github.com/jaketrent/html-webpack-template) by changing the `HtmlWebpackPlugin` configuration in `webpack.config.js` (search for `headHtmlSnippet` and add similar code).
 
-Q: How can I fix Typescript compilation errors?<br/>
-A: Note the Typescript version in `package.json`. Ensure the Typescript version shown at the VS Code status bar when .ts or .tsx file is opened is not lower.
+Q: I need to support Microsoft Edge and IE11.<br/>
+A: Edge is supported provided it has been updated using Windows updates. To support IE11 add the following 5 lines to the `client\src\entrypoints\head-snippet.html` file:
+```
+<script src="https://cdn.jsdelivr.net/npm/promise-polyfill@8/dist/polyfill.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/fetch.umd.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/umd-polyfill.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/mdn-polyfills/String.prototype.includes.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/mdn-polyfills/Object.assign.js"></script>
+```
+
+Q: In addition to Edge and IE11, I also need to support earlier versions of Internet Explorer.<br/>
+A: IE10 is officially [unsupported](https://support.microsoft.com/en-au/help/4488955/support-ending-for-internet-explorer-10) and therefore insecure. This project aims to support browsers that can be made secure.
+
+Q: How can I fix TypeScript compilation errors?<br/>
+A: Note the TypeScript version in `package.json`. Ensure the TypeScript version shown at the VS Code status bar when .ts or .tsx file is opened is not lower.
 
 Q: Breakpoints in Chrome DevTools are not hit. How can I fix it?<br/>
 A: Open the Settings page of the Chrome DevTools and ensure 'Enable JavaScript source maps' and 'Disable cache (while DevTools is open)' boxes are ticked. Close the Settings page and on the Network tab tick the 'Disable cache' box. If debugging a production build, change the `sourceMap` setting of the TerserPlugin config to `true` in `webpack.config.js`, then restart debugging.

diff --git a/client/config/spa.config.js b/client/config/spa.config.js
@@ -72,31 +72,37 @@ var ConfiguredSPAs = function() {
 
   SPAs.getEntrypoints = function() {
     var entryPoints = new Object();
-    SPAs.forEach(spa => (entryPoints[spa.params.name] = spa.params.entryPoint));
+    SPAs.forEach(function(spa) {
+      entryPoints[spa.params.name] = spa.params.entryPoint;
+    });
     return entryPoints;
   };
 
   SPAs.getRedirectName = function() {
-    return SPAs.find(spa => spa.params.redirect).params.name;
+    return SPAs.find(function(spa) {
+      return spa.params.redirect;
+    }).params.name;
   };
 
   SPAs.getNames = function() {
     var spaNames = new Array();
-    SPAs.forEach(spa => spaNames.push(spa.params.name));
+    SPAs.forEach(function(spa) {
+      spaNames.push(spa.params.name);
+    });
     return spaNames;
   };
 
   SPAs.getRewriteRules = function() {
     var ret = new Array();
-    SPAs.forEach(spa => {
+    SPAs.forEach(function(spa) {
       var rule = new Object();
-      rule.from = new RegExp(`^/${spa.params.name}` + "(\\.html)?$");
-      rule.to = `${spa.params.name}.html`;
+      rule.from = new RegExp("^/" + spa.params.name + "(\\.html)?$");
+      rule.to = spa.params.name + ".html";
       ret.push(rule);
     });
     ret.push({
       from: new RegExp("^.*$"),
-      to: `/${SPAs.getRedirectName()}.html`
+      to: "/" + SPAs.getRedirectName() + ".html"
     });
     return ret;
   };

diff --git a/client/package.json b/client/package.json
@@ -37,7 +37,7 @@
     "copy": "copyfiles -f dist/* ../server/build/client/"
   },
   "dependencies": {
-    "debug": "^4.1.1",
+    "loglevel": "^1.6.6",
     "react": "16.12.0",
     "react-dom": "16.12.0",
     "react-helmet": "5.2.1",

diff --git a/client/src/utils/logger.ts b/client/src/utils/logger.ts
@@ -1,41 +1,24 @@
-import debug from "debug";
+import * as log from "loglevel";
 import * as SPAs from "../../config/spa.config";
 
-const enum LOG_LEVEL {
-  LOG_TRACE,
-  LOG_INFO,
-  LOG_WARN,
-  LOG_ERROR
-}
-
 export class Log {
-  private readonly BASE = SPAs.appTitle;
-
-  private generateMessage(level: LOG_LEVEL, message: string, source?: string) {
-    const namespace = `${this.BASE}:${level}`;
-    const logger: debug.Debugger = debug(namespace);
-
-    if (source) {
-      logger(source, message);
-    } else {
-      logger(message);
-    }
-  }
+  private readonly m_title = SPAs.appTitle;
+  private readonly m_logger = log.getLogger(this.m_title);
 
-  public trace(message: string, source?: string) {
-    return this.generateMessage(LOG_LEVEL.LOG_TRACE, message, source);
+  public trace(message: string) {
+    return this.m_logger.trace(message);
   }
 
-  public info(message: string, source?: string) {
-    return this.generateMessage(LOG_LEVEL.LOG_INFO, message, source);
+  public info(message: string) {
+    return this.m_logger.info(message);
   }
 
-  public warn(message: string, source?: string) {
-    return this.generateMessage(LOG_LEVEL.LOG_WARN, message, source);
+  public warn(message: string) {
+    return this.m_logger.warn(message);
   }
 
-  public error(message: string, source?: string) {
-    return this.generateMessage(LOG_LEVEL.LOG_ERROR, message, source);
+  public error(message: string) {
+    return this.m_logger.error(message);
   }
 }