fix(common): Fix views extension mapping and add cache in production …

…profile
tsedio · Oct 1, 2020 · 487456f · 487456f
1 parent b6ca396
commit 487456f
Show file tree

Hide file tree

Showing 8 changed files with 36 additions and 15 deletions.
diff --git a/examples/socketio/src/Server.ts b/examples/socketio/src/Server.ts
@@ -30,7 +30,7 @@ const rootDir = __dirname;
   }],
   socketIO: {},
   views: {
-    path: `${rootDir}/../views`,
+    root: `${rootDir}/../views`,
     viewEngine: "ejs",
     extensions: {
       html: "ejs"

diff --git a/packages/common/src/config/interfaces/PlatformViewsSettings.ts b/packages/common/src/config/interfaces/PlatformViewsSettings.ts
@@ -50,8 +50,25 @@ export type PlatformViewsEngineOptions = {
 };
 
 export interface PlatformViewsSettings {
-  path?: string;
+  /**
+   * Views directory.
+   */
+  root?: string;
+  /**
+   * Enable cache. Ts.ED enable cache in PRODUCTION profile by default.
+   */
+  cache?: boolean;
+  /**
+   * Provide extensions mapping to match the expected engines.
+   */
   extensions?: Partial<PlatformViewsExtensionsTypes>;
+  /**
+   * Default view engine extension.
+   * Allow omitting extension when using View decorator or render method.
+   */
   viewEngine?: string;
+  /**
+   * Options mapping for each engine.
+   */
   options?: Partial<PlatformViewsEngineOptions>;
 }
diff --git a/packages/common/src/platform/services/PlatformViews.spec.ts b/packages/common/src/platform/services/PlatformViews.spec.ts
@@ -32,7 +32,7 @@ describe("PlatformViews", () => {
       const result = await platformViews.render("views.ejs");
 
       expect(result).to.equal("HTML");
-      expect(platformViews.consolidate.ejs).to.have.been.calledWithExactly("views.ejs", {global: "global"});
+      expect(platformViews.consolidate.ejs).to.have.been.calledWithExactly("views.ejs", {cache: false, global: "global"});
     });
     it("should render a template without extension", async () => {
       const platformViews = PlatformTest.get<PlatformViews>(PlatformViews);
@@ -43,6 +43,7 @@ describe("PlatformViews", () => {
 
       expect(result).to.equal("HTML");
       expect(platformViews.consolidate.ejs).to.have.been.calledWithExactly("views.ejs", {
+        cache: false,
         global: "global",
         test: "test"
       });

diff --git a/packages/common/src/platform/services/PlatformViews.ts b/packages/common/src/platform/services/PlatformViews.ts
@@ -1,3 +1,4 @@
+import {Env} from "@tsed/core";
 import {Constant, Injectable} from "@tsed/di";
 import * as cons from "consolidate";
 import * as Fs from "fs";
@@ -13,8 +14,14 @@ import {
  */
 @Injectable()
 export class PlatformViews {
-  @Constant("views.path", `${process.cwd()}/views`)
-  readonly path: string;
+  @Constant("env")
+  env: Env;
+
+  @Constant("views.root", `${process.cwd()}/views`)
+  readonly root: string;
+
+  @Constant("views.cache")
+  readonly cache: boolean;
 
   @Constant("views.viewEngine", "ejs")
   readonly viewEngine: string;
@@ -30,7 +37,7 @@ export class PlatformViews {
   $onInit() {
     this.extensionsMap = new Map(
       Object.entries({
-        hsb: "handlebars",
+        hbs: "handlebars",
         ejs: "ejs",
         ...this.extensions
       })
@@ -69,10 +76,7 @@ export class PlatformViews {
       throw new Error(`Engine not found for the ".${extension}" file extension`);
     }
 
-    return render(this.resolve(viewPath), {
-      ...engineOptions,
-      ...options
-    });
+    return render(this.resolve(viewPath), Object.assign({cache: this.cache || this.env === Env.PROD}, engineOptions, options));
   }
 
   protected resolve(viewPath: string) {
@@ -83,7 +87,7 @@ export class PlatformViews {
     return (
       [
         viewPath,
-        resolve(join(this.path, viewPath)),
+        resolve(join(this.root, viewPath)),
         resolve(join(process.cwd(), "views", viewPath)),
         resolve(join(process.cwd(), "public", viewPath))
       ].find((file) => Fs.existsSync(file)) || viewPath

diff --git a/packages/platform-express/test/app/Server.ts b/packages/platform-express/test/app/Server.ts
@@ -19,7 +19,7 @@ export const rootDir = __dirname;
     "/": `${rootDir}/public`
   },
   views: {
-    path: `${rootDir}/views`,
+    root: `${rootDir}/views`,
     extensions: {
       ejs: "ejs"
     }

diff --git a/packages/platform-koa/src/services/PlatformKoaRouter.ts b/packages/platform-koa/src/services/PlatformKoaRouter.ts
@@ -11,7 +11,6 @@ import {
 } from "@tsed/common";
 import {Configuration, Inject} from "@tsed/di";
 import * as send from "koa-send";
-import {resolve} from "path";
 import {staticsMiddleware} from "../middlewares/staticsMiddleware";
 import {getMulter} from "../utils/multer";
 

diff --git a/packages/platform-koa/test/app/Server.ts b/packages/platform-koa/test/app/Server.ts
@@ -15,7 +15,7 @@ export const rootDir = __dirname;
     "/": `${rootDir}/public`
   },
   views: {
-    path: `${rootDir}/views`,
+    root: `${rootDir}/views`,
     extensions: {
       ejs: "ejs"
     }

diff --git a/packages/socketio/test/app/Server.ts b/packages/socketio/test/app/Server.ts
@@ -27,7 +27,7 @@ const rootDir = resolve(__dirname);
     "/": "${rootDir}/views"
   },
   views: {
-    path: `${rootDir}/views`,
+    root: `${rootDir}/views`,
     extensions: {
       html: "ejs"
     },