refactor(app): create loosely coupled engine

.env.example

@@ -0,0 +1,5 @@
+#PRODUCTION
+RDBMS_DATABASE_URI="mysql://DATBASE_USER:DATABASE_PASSWORD@DATABASE_HOST:DATABASE_PORT/DATABASE_DB"
+NOSQL_DATABASE_URI="mongodb://DATABASE_HOST:DATABASE_PORT/DATABASE_DB"
+NOSQL_DATABASE_ADAPTER="mongodb"
+API_BASE='/v1/'

README.md

@@ -20,13 +20,29 @@ A component based framework for NodeJs Applications
 ## Architecture
 <img src="./architecture.png" width="500" >
 
-We are creating a structure for developing large scalable, maitanable Nodejs applications. We mash up ideas from component based architecture, MVC, Entity Framework and Repository Pattern. We want different teams to focus on creating their domain apps in the components with ease. Fractal Js comes with authentication out of the box based on JWT
+We are creating a structure for developing large scalable, maitanable Nodejs applications. We mash up ideas from component based architecture, MVC, Entity Framework and Repository Pattern. We want different teams to focus on creating their domain apps in the components with ease. 
 
 ## Issues, suggestions and feature requests
-We are actively maintaining this boilerplate, please report any issues or suggestion for improvement at https://github.com/fractalerp/fractal-js/issues
+We are actively maintaining this framework, please report any issues or suggestion for improvement at https://github.com/fractalerp/fractal-js/issues
+
+## How to run the project
+Prerequisite: Install git, node package manager, webpack CLI, grunt CLI. This framework also uses fractalerp [Active Record Js](https://github.com/fractalerp/active-record-js) for defining models.
+
+1. Create the following environment variables in your node project.
+```env
+RDBMS_DATABASE_URI="mysql://DATBASE_USER:DATABASE_PASSWORD@DATABASE_HOST:DATABASE_PORT/DATABASE_DB"
+NOSQL_DATABASE_URI="mongodb://DATABASE_HOST:DATABASE_PORT/DATABASE_DB"
+NOSQL_DATABASE_ADAPTER="mongodb"
+```
 
-## Development and contribution
-Prerequisite: Install git, node package manager, webpack CLI, grunt CLI
+2. Then you can create your `nodejs` apps in the `components` folder. The projects in that folder are autoloaded at run time. See the sample `Task` project in the same folder. A proper documentation will be provided in the future. Also tools will be provided to create this structure. Refer to the github project management dashboard to see what is coming up.
+
+## 🫶 Projects using this package
+See the projects using this package in action.
+- [Fractalerp core](https://github.com/fractalerp/fractal-core)
+
+## Issues, suggestions and feature requests
+We are actively maintaining this boilerplate, please report any issues or suggestion for improvement at https://github.com/fractalerp/fractal-js/issues
 
 To contribute, fork and clone.
 
@@ -50,10 +66,6 @@ Run the unit test continuously during development:
 
     > npm run test:dev
 
-Run the end to end test during development:
-
-    > npm run test:e2e:dev
-
 ## Scripts
 While developing, you will probably rely mostly on `npm start`; however, there are additional scripts at your disposal:
 
@@ -67,8 +79,8 @@ While developing, you will probably rely mostly on `npm start`; however, there a
 |`test`|Runs lint, build, unit tests with mocha and generates a coverage report|
 |`test:dev`|Runs mocha and watches for changes to re-run tests; does not generate coverage reports.|
 |`test:unit`|Runs unit tests with mocha and generates a coverage report.|
-|`build:prod`|Build app optimized for production|
-|`build:dev`|Build app optimized for debugging.|
+|`build:release`|Build app optimized for production|
+|`build:development`|Build app optimized for debugging.|
 |`lint`|Lint all `.js` files.|
 |`lint:fix`|Lint and fix all `.ts` files.|
 

index.ts → app.ts

@@ -19,8 +19,9 @@ import fractaLog, { fractalLogger } from "./config/logger";
 import { csrfHandler } from "./middleware/csrf.middleware";
 import { Environments } from "./utils/constants";
 import { getJWT } from "./utils/helpers";
+import { FractalRouter } from "./routes/fractal_router";
 
-export class FractalApp {
+export class FractalJs {
   public express!: express.Application;
   public session!: express.RequestHandler;
   public server!: http.Server;
@@ -45,6 +46,8 @@ export class FractalApp {
       this.express.use(csrfHandler);
       //
       this.express.use(this.initPassport());
+      // Main app router
+      new FractalRouter(this);
 
       this.loadComponents();
 
@@ -69,6 +72,7 @@ export class FractalApp {
     this.express.enable("trust proxy");
     // set up logging
     this.express.use(morgan("combined", { stream: fractaLog.stream } as any));
+
     this.server = http.createServer(this.express);
 
     useragent(true);
@@ -210,4 +214,4 @@ export class FractalApp {
   };
 }
 
-export default new FractalApp();
+export default new FractalJs();

components/task/adapters/task_adapter.ts

@@ -0,0 +1,11 @@
+import { TaskEntity } from "../public/entities/task_entity";
+
+export class TaskAdapter {
+  taskEntity: TaskEntity;
+
+  constructor(taskEntity: TaskEntity) {
+    this.taskEntity = taskEntity;
+  }
+
+  toJson = () => JSON.stringify(this.taskEntity);
+}

components/task/controllers/tasks_controller.ts

@@ -0,0 +1,59 @@
+import { Request, Response } from "express";
+
+import { StatusCodes } from "http-status-codes";
+import { TaskRepository } from "../public/repositories/task_repository";
+import { TaskAdapter } from "../adapters/task_adapter";
+import { TaskEntity } from "../public/entities/task_entity";
+
+export class TasksController {
+  taskRepository = new TaskRepository();
+
+  public addNewTask = async (req: Request, res: Response) => {
+    const taskEntity = await this.taskRepository.create({
+      name: req.body.name,
+      description: req.body.description
+    });
+
+    const json = new TaskAdapter(taskEntity).toJson();
+
+    return res.status(StatusCodes.CREATED).json(json);
+  };
+
+  public getTasks = async (_req: Request, res: Response) => {
+    const taskEntities = await this.taskRepository.read({});
+    const taskListJson = taskEntities.map((taskEntity: TaskEntity) => new TaskAdapter(taskEntity).toJson());
+
+    return res.status(StatusCodes.OK).json(taskListJson);
+  };
+
+  public getTaskWithID = async (req: Request, res: Response) => {
+    const taskEntities = await this.taskRepository.read({ id: req.params.id });
+    let json = {};
+
+    if (taskEntities.length > 0) {
+      json = new TaskAdapter(taskEntities[0]).toJson();
+    }
+
+    return res.status(StatusCodes.OK).json(json);
+  };
+
+  public updateTask = async (req: Request, res: Response) => {
+    const taskEntity = await this.taskRepository.update({
+      id: req.body.id,
+      name: req.body.name,
+      description: req.body.description
+    });
+
+    const json = new TaskAdapter(taskEntity).toJson();
+
+    return res.status(StatusCodes.OK).json(json);
+  };
+
+  public deleteTask = async (req: Request, res: Response) => {
+    await this.taskRepository.delete({
+      id: req.body.id
+    });
+
+    return res.status(StatusCodes.OK).json({});
+  };
+}

components/task/index.ts

@@ -1,15 +1,15 @@
 import { fractalLogger } from "../../config/logger";
-import { FractalApp } from "../../index";
-import { TaskRouter } from "./config/router";
+import { FractalJs } from "../../app";
+import { TaskRouter } from "./routes/router";
 
 export class TaskComponent {
   public taskRouter!: TaskRouter;
-  public fractalApp!: FractalApp;
+  public fractalJs!: FractalJs;
 
-  constructor(fractalApp: FractalApp) {
+  constructor(fractalJs: FractalJs) {
     try {
-      this.fractalApp = fractalApp;
-      this.taskRouter = new TaskRouter(fractalApp);
+      this.fractalJs = fractalJs;
+      this.taskRouter = new TaskRouter(fractalJs);
     } catch (error) {
       fractalLogger.error(`Task Component: Failed to create component :( ", ${error}`);
     }

components/task/models/task_model.ts

@@ -0,0 +1,20 @@
+import { ActiveRecord } from "@fractalerp/active-record-js"
+
+export interface ITaskModelDocument {
+  name: string;
+  description: string;
+}
+
+const TaskModelSchema = {
+  name: {
+    type: String,
+    required: true,
+    unique: true
+  },
+  description: {
+    type: String,
+    default: null
+  }
+};
+
+export const TaskModel = new ActiveRecord<ITaskModelDocument>("Task", TaskModelSchema);

components/task/routes/router.ts

@@ -0,0 +1,28 @@
+import { NextFunction } from "express-serve-static-core";
+
+import { TasksHomeRoute } from "../routes/tasks_home_route";
+import { TasksRoute } from "../routes/tasks_route";
+import { FractalJs } from "../../../app";
+
+export class TaskRouter {
+  public fractalJs!: FractalJs;
+
+  constructor(fractalJs: FractalJs) {
+    this.fractalJs = fractalJs;
+    // white list public routes
+    this.allowPublicRoutes();
+    // Add routes
+    new TasksHomeRoute(fractalJs);
+    new TasksRoute(fractalJs);
+  }
+
+  private allowPublicRoutes() {
+    this.fractalJs.express.all(
+      `${process.env.API_BASE}tasks/*`, async (_req: any, _res: any, next: NextFunction) => {
+        // Add public routes not to authenticate
+        // await this.authenticateApi(this.fractalJs, req, res, next);
+
+        next();
+      });
+  }
+}

components/task/app/routes/home.ts → components/task/routes/tasks_home_route.ts

@@ -1,11 +1,11 @@
 import { Request, Response } from "express";
-import { FractalApp } from "../../../../index";
+import { FractalJs } from "../../../app";
 
-export class TaskHome {
-  public routes = (app: FractalApp) => {
-    const authEndpoint = `${process.env.API_BASE}tasks`;
+export class TasksHomeRoute {
+  public constructor(fractalJs: FractalJs) {
+    const authEndpoint = `${process.env.API_BASE}tasks/home`;
     // GET endpoint
-    app.express.route(authEndpoint)
+    fractalJs.express.route(authEndpoint)
       // GET endpoint
       .get((_req: Request, res: Response) => {
         // Get all contacts
@@ -16,5 +16,3 @@ export class TaskHome {
       });
   };
 }
-
-export default new TaskHome();

components/task/routes/tasks_route.ts

@@ -0,0 +1,21 @@
+import { TasksController } from "../controllers/tasks_controller";
+import { FractalJs } from "../../../app";
+
+export class TasksRoute {
+  public tasksController!: TasksController;
+
+  public constructor(fractalJs: FractalJs) {
+    this.tasksController = new TasksController();
+    const tasksEndpoint = `${process.env.API_BASE}tasks`;
+    /* Get, Add tasks */
+    fractalJs.express.route(`${tasksEndpoint}`)
+      .get(this.tasksController.getTasks)
+      .post(this.tasksController.addNewTask);
+
+    /* Task details, update and delete */
+    fractalJs.express.route(`${tasksEndpoint}/:id`)
+      .get(this.tasksController.getTaskWithID)
+      .put(this.tasksController.updateTask)
+      .delete(this.tasksController.deleteTask);
+  }
+}