Removes the EJS dependency (#46)

this low level dependency should that doesn't directly use EJS should not control which version it exposes. By having this here, it forces the dependents to use this version and making it overly complicated to update and fix security issues with ejs.
opentable · Aug 3, 2022 · 439f614 · 439f614
1 parent 3eaf325
commit 439f614
Show file tree

Hide file tree

Showing 9 changed files with 18 additions and 167 deletions.
diff --git a/README.md b/README.md
@@ -80,14 +80,6 @@ module.exports = function (BaseWebServer, path) {
     // Add additional changes to the middleware by overriding the method
     registerDefaultMiddleware() {
       super.registerDefaultMiddleware();
-      this.registerEjsTemplates();
-    }
-
-    registerEjsTemplates() {
-      this.logSectionHeader('EJS Template Registration');
-
-      this.app.set('view engine', 'ejs');
-      this.app.set('views', path.join(__dirname, '../views'));
     }
   }
 
@@ -96,19 +88,6 @@ module.exports = function (BaseWebServer, path) {
 };
 ```
 
-#### `src/views/hello.ejs`
-
-```html
-<html>
-  <head>
-     <meta charset="utf-8">
-  </head>
-<body>
-  <h1><%= user %></h1>
-</body>
-</html>
-```
-
 #### `src/controllers/HelloController.js`
 
 Files ending in `*Controller.js` are auto registered as controllers.
@@ -129,11 +108,7 @@ module.exports = function (BaseController) {
     }
 
     getHello(req, res) {
-      const model = {
-        user: req.query.user || 'John Doe'
-      };
-
-      res.render('hello', model);
+      res.send('hello');
     }
 
   }
@@ -184,7 +159,6 @@ List of external dependencies used and exposed by spur-web. They can be found at
 | **cookieParser**   | [cookie-parser](https://www.npmjs.org/package/cookie-parser)     |
 | **bodyParser**     | [body-parser](https://www.npmjs.org/package/body-parser)         |
 | **expressWinston** | [express-winston](https://www.npmjs.org/package/express-winston) |
-| **ejs**            | [ejs](https://www.npmjs.org/package/ejs)                         |
 
 ### Local dependecies
 
@@ -244,4 +218,4 @@ $ npm test
 [npm-install-size-image]: https://badgen.net/packagephobia/install/spur-web
 [npm-install-size-url]: https://packagephobia.com/result?p=spur-web
 [npm-url]: https://npmjs.org/package/spur-web
-[npm-version-image]: https://badgen.net/npm/v/spur-web
+[npm-version-image]: https://badgen.net/npm/v/spur-web
diff --git a/example/src/runtime/WebServer.js b/example/src/runtime/WebServer.js
@@ -1,18 +1,11 @@
-module.exports = function (BaseWebServer, path) {
+module.exports = function (BaseWebServer) {
   class WebServer extends BaseWebServer {
 
     // Add additional changes to the middleware by overriding the method
     registerDefaultMiddleware() {
       super.registerDefaultMiddleware();
-      this.registerEjsTemplates();
     }
 
-    registerEjsTemplates() {
-      this.logSectionHeader('EJS Template Registration');
-
-      this.app.set('view engine', 'ejs');
-      this.app.set('views', path.join(__dirname, '../views'));
-    }
   }
 
   // Assure there is just one instance

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -52,7 +52,6 @@
   "dependencies": {
     "body-parser": "^1.20.0",
     "cookie-parser": "^1.4.6",
-    "ejs": "^3.1.8",
     "express": "^4.18.1",
     "express-device": "^0.4.2",
     "express-winston": "^2.6.0",

diff --git a/src/injector.js b/src/injector.js
@@ -6,7 +6,6 @@ const methodOverride = require('method-override');
 const cookieParser = require('cookie-parser');
 const bodyParser = require('body-parser');
 const expressWinston = require('express-winston');
-const ejs = require('ejs');
 
 module.exports = function injector() {
   const ioc = spur.create('spur-web');
@@ -17,8 +16,7 @@ module.exports = function injector() {
     methodOverride,
     cookieParser,
     bodyParser,
-    expressWinston,
-    ejs
+    expressWinston
   });
 
   ioc.registerFolders(__dirname, [

diff --git a/test/fixtures/runtime/TestWebServer.js b/test/fixtures/runtime/TestWebServer.js
@@ -1,18 +1,11 @@
-module.exports = function (BaseWebServer, Logger, path) {
+module.exports = function (BaseWebServer) {
 
   class TestWebServer extends BaseWebServer {
 
     registerDefaultMiddleware(){
       super.registerDefaultMiddleware();
-      this.registerEjsTemplates();
     }
 
-    registerEjsTemplates() {
-      Logger.log('EJS Template Registration');
-
-      this.app.set('view engine', 'ejs');
-      this.app.set('views', path.join(__dirname, '../views'));
-    }
   }
 
   return new TestWebServer();

diff --git a/test/fixtures/views/renderView.ejs b/test/fixtures/views/renderView.ejs
diff --git a/test/integration/ModuleIntegration_Spec.js b/test/integration/ModuleIntegration_Spec.js
@@ -12,14 +12,13 @@ describe('Integration', () => {
 
     describe('base dependencies', () => {
       it('base module dependencies are injectable', function () {
-        this.ioc.inject(function (express, expressDevice, methodOverride, cookieParser, bodyParser, expressWinston, ejs) {
+        this.ioc.inject(function (express, expressDevice, methodOverride, cookieParser, bodyParser, expressWinston) {
           expect(express).to.exist;
           expect(expressDevice).to.exist;
           expect(methodOverride).to.exist;
           expect(cookieParser).to.exist;
           expect(bodyParser).to.exist;
           expect(expressWinston).to.exist;
-          expect(ejs).to.exist;
         });
       });
     });

diff --git a/test/unit/middleware/PromiseMiddlewareSpec.js b/test/unit/middleware/PromiseMiddlewareSpec.js
@@ -29,14 +29,6 @@ describe('PromiseMiddleware', function () {
       expect(response.body).to.equal('jsonAsync success');
     });
   });
-
-  it('renderAsync - success', () => {
-    return base.getResponse('renderasync').promise().then((response) => {
-      expect(response.type).to.equal('text/html');
-      expect(response.text).to.contain('renderView from ejs: renderAsync success');
-    });
-  });
-
   it('sendStatusAsync - success', () => {
     return base.getResponse('sendstatusasync').promise().then((response) => {
       expect(response.type).to.equal('text/plain');