feat(routes): Moves routes to separate files

Author: Gery Hirschfeld

README.md

@@ -131,6 +131,9 @@ express-graphql-typescript-boilerplate
  |    |-- services/                             * use a services to separate the logic that retrieves the data and maps it to the entity model from the business logic that acts on the model
  |    |    |-- **/*Services.ts
  |    |
+ |    |-- routes/                               * defines our application routes
+ |    |    |-- **/*Routes.ts
+ |    |
  |    |-- schemas/                              * our graphql schema definitions (use a single file for every graphql object action)
  |    |    |-- arguments/                       * our graphql argument files
  |    |    |-- fields/                          * our graphql field files
@@ -139,7 +142,6 @@ express-graphql-typescript-boilerplate
  |    |    |-- types/                           * our graphql type files
  |    |
  |    |-- index.ts                              * main entry point for our application
- |    |-- App.ts                                * our application
  |    |-- RootValue.ts                          * RootValue with some functions for all the queries and mutations
  |    |-- config.ts                             * has our configuration for our different environments
  |

src/App.ts

@@ -1,33 +1,3 @@
 export * from './Context';
 export * from './DataloadersContext';
 export * from './ServicesContext';
-
-import { DB } from '../core/Database';
-import {
-    AuthorRepository,
-    BookRepository
-} from '../repositories';
-
-
-/**
- * Services
- */
-import { ServicesContext } from './ServicesContext';
-
-import {
-    BookService,
-    AuthorService
-} from '../services';
-
-ServicesContext.getInstance()
-    .setBookService(new BookService(new BookRepository(DB)))
-    .setAuthorService(new AuthorService(new AuthorRepository(DB)));
-
-
-/**
- * Dataloaders
- */
-import { DataLoadersContext } from './DataloadersContext';
-DataLoadersContext.getInstance()
-    .setAuthorDataLoader(ServicesContext.getInstance().AuthorService)
-    .setBookDataLoader(ServicesContext.getInstance().BookService);

src/context/index.ts

@@ -1,7 +1,8 @@
 import * as express from 'express';
 import * as http from 'http';
 
-import { Logger } from './logger';
+import { Environment, Logger } from './';
+
 const log = Logger('app:core:server');
 
 
@@ -15,6 +16,7 @@ export class Server {
         const server = app.listen(this.normalizePort(port));
         server.on('listening', () => this.onListening(server));
         server.on('error', (error) => this.onError(server, error));
+        log.debug('Server was started on environment %s', Environment.getName());
         return server;
     }
 

src/core/Server.ts

@@ -9,5 +9,49 @@
  *
  */
 
-import { App } from './app';
-App.getInstance().main();
+// Core elements to get the server started
+import {
+    Environment,
+    Server,
+    winstonStream,
+    debugStream
+} from './core';
+
+// Import all express libs
+import * as helmet from 'helmet';
+import * as morgan from 'morgan';
+import * as cors from 'cors';
+
+// Import our middlewares to add to the express chain
+import { oauth } from './middlewares';
+
+// Import all routes
+import { DefaultRoutes, GraphQLRoutes } from './routes';
+
+// Create a new express app
+const app = Server.init();
+
+// Helmet helps you secure your Express apps by setting various HTTP headers
+app.use(helmet());
+app.use(helmet.noCache());
+app.use(helmet.hsts({
+    maxAge: 31536000,
+    includeSubdomains: true
+}));
+
+// Enable cors for all routes and origins
+app.use(cors());
+
+// Adds winston logger to the express framework
+app.use(morgan('dev', debugStream));
+app.use(morgan('combined', winstonStream));
+
+// Our custom oauth middleware
+app.use(oauth({}));
+
+// Map routes to the express application
+DefaultRoutes.map(app);
+GraphQLRoutes.map(app);
+
+// Starts the server and listens for common errors
+Server.run(app, Environment.getConfig().server.port);

src/index.ts

@@ -0,0 +1,19 @@
+import * as express from 'express';
+
+
+export class DefaultRoutes {
+
+    static map(app: express.Application): void {
+        app.use('/', (req: express.Request, res: express.Response) => {
+            const pkg = require('../../package.json');
+            res.json({
+                name: pkg.name,
+                version: pkg.version,
+                description: pkg.description
+            });
+        });
+    }
+
+}
+
+

src/routes/DefaultRoutes.ts

@@ -0,0 +1,61 @@
+import * as express from 'express';
+import * as GraphQLHTTP from 'express-graphql';
+
+import { Environment, DB } from '../core';
+import { Exception } from '../exceptions';
+import { Schema } from '../schemas';
+import { RootValue } from '../RootValue';
+import {
+    Context,
+    DataLoadersContext,
+    ServicesContext
+} from '../context';
+import {
+    AuthorRepository,
+    BookRepository
+} from '../repositories';
+import {
+    BookService,
+    AuthorService
+} from '../services';
+
+
+export class GraphQLRoutes {
+
+    static map(app: express.Application): void {
+        GraphQLRoutes.buildContext();
+
+        // Add GraphQL to express route
+        app.use('/graphql', (req: express.Request, res: express.Response) => {
+            // Creates a GraphQLHTTP per request
+            GraphQLHTTP({
+                schema: Schema.get(),
+                rootValue: new RootValue(),
+                context: new Context(
+                    req, res,
+                    DataLoadersContext.getInstance(),
+                    ServicesContext.getInstance()
+                ),
+                graphiql: Environment.getConfig().server.graphiql,
+                formatError: exception => ({
+                    name: Exception.getName(exception.message),
+                    message: Exception.getMessage(exception.message),
+                    path: exception.path
+                })
+            })(req, res);
+        });
+    }
+
+    private static buildContext(): void {
+        ServicesContext.getInstance()
+            .setBookService(new BookService(new BookRepository(DB)))
+            .setAuthorService(new AuthorService(new AuthorRepository(DB)));
+
+        DataLoadersContext.getInstance()
+            .setAuthorDataLoader(ServicesContext.getInstance().AuthorService)
+            .setBookDataLoader(ServicesContext.getInstance().BookService);
+    }
+
+}
+
+

src/routes/GraphQLRoutes.ts

@@ -0,0 +1,2 @@
+export * from './DefaultRoutes';
+export * from './GraphQLRoutes';