Implement pause session functionality along with other ui improvements. (#30)

Author: sudharsan-selvaraj

migrations/001_create_table.js

@@ -55,6 +55,7 @@ var createSessionTable = function (queryInterface, Sequelize) {
     start_time: { type: Sequelize.DATE, allowNull: false },
     end_time: { type: Sequelize.DATE, defaultValue: null },
     is_test_passed: { type: Sequelize.BOOLEAN, allowNull: true },
+    is_paused: { type: Sequelize.BOOLEAN, allowNull: true, default: false },
     session_status: {
       type: Sequelize.ENUM,
       values: ["PASSED", "FAILED", "TIMEOUT", "RUNNING"],

package-lock.json

@@ -28,17 +28,20 @@
     "mainClass": "AppiumDashboardPlugin"
   },
   "dependencies": {
-    "@appium/base-plugin": "^1.7.2",
+    "@appium/base-plugin": "^1.8.0",
     "@ffmpeg-installer/ffmpeg": "^1.1.0",
     "@mui/icons-material": "^5.0.4",
     "@mui/material": "^5.0.4",
     "appium-base-driver": "^7.10.1",
+    "async-lock": "^1.3.0",
+    "async-wait-until": "^2.0.12",
     "bluebird": "^3.7.2",
     "body-parser": "^1.19.0",
     "circular-json": "^0.5.9",
     "cors": "^2.8.5",
     "debug": "^4.3.2",
     "express": "^4.17.1",
+    "lodash": "^4.17.21",
     "lokijs": "^1.5.12",
     "react-ga": "^3.3.0",
     "reflect-metadata": "^0.1.13",
@@ -51,7 +54,9 @@
     "winston": "^3.3.3"
   },
   "devDependencies": {
+    "@types/async-lock": "^1.1.3",
     "@types/express": "^4.17.13",
+    "@types/lodash": "^4.14.178",
     "@types/lokijs": "^1.5.7",
     "@types/node": "^16.10.2",
     "@types/uuid": "^8.3.1",

package.json

@@ -1,9 +1,10 @@
 import { Request, Response, Router } from "express";
+import { Config } from "../../config";
 import { IExpressController, IExpressRequest } from "../../interfaces/express-controller";
 import { ExpressUtils } from "../utils/express-utils";
 
 export abstract class BaseController implements IExpressController {
-  abstract initializeRoutes(router: Router, config: any): void;
+  abstract initializeRoutes(router: Router, config: Config): void;
 
   public sendPaginatedResponse(result: { rows: any[]; count: number }, request: IExpressRequest, response: Response) {
     if (request.parsedQuery.paginate == true) {

src/app/commons/base-controller.ts

@@ -0,0 +1,26 @@
+import { NextFunction, Router, Request, Response } from "express";
+import { EventEmitter } from "events";
+import { BaseController } from "../commons/base-controller";
+import { Config } from "../../config";
+
+export class DebugController extends BaseController {
+  constructor(private debugEventEmitter: EventEmitter) {
+    super();
+  }
+
+  public initializeRoutes(router: Router, config: Config) {
+    router.post("/:sessionId/:state", this.changeSessionState.bind(this));
+  }
+
+  public async changeSessionState(request: Request, response: Response, next: NextFunction) {
+    let { sessionId, state } = request.params;
+    if (!state.match("play|pause")) {
+      return this.sendFailureResponse(response, "Invalid state. Supported states are play,pause");
+    }
+    this.debugEventEmitter.emit(sessionId, {
+      event: "change_state",
+      state,
+    });
+    return this.sendSuccessResponse(response, "Changed session state");
+  }
+}

src/app/controllers/debug-controller.ts

@@ -1,3 +1,4 @@
 export { SessionController } from "./session-controller";
 export { BuildController } from "./build-controller";
 export { ProjectController } from "./project-controller";
+export { DebugController } from "./debug-controller";

src/app/controllers/index.ts

@@ -86,16 +86,18 @@ export class SessionController extends BaseController {
       },
     });
 
-    if (session) {
+    if (session && session.session_status != "RUNNING") {
       await session.destroy();
       if (session.video_path) {
         fs.unlinkSync(session.video_path);
       }
       fs.rmdirSync(path.join(config.screenshotSavePath, session.session_id), { recursive: true });
+      this.sendSuccessResponse(response, {
+        success: true,
+      });
+    } else {
+      this.sendFailureResponse(response, "Cannnot delete running session");
     }
-    this.sendSuccessResponse(response, {
-      success: true,
-    });
   }
 
   public async getVideoForSession(request: Request, response: Response, next: NextFunction) {

src/app/controllers/session-controller.ts

@@ -3,8 +3,9 @@ import bodyParser from "body-parser";
 import * as path from "path";
 const cors = require("cors");
 import { registerRoutes } from "./routes";
+import { Config } from "../config";
 
-function getRouter({ config }: { config: any }) {
+function getRouter({ config, dependencies }: { config: Config; dependencies: Record<string, any> }) {
   let router = express.Router();
   let apiRouter = express.Router();
   router.use(bodyParser.json());
@@ -23,7 +24,7 @@ function getRouter({ config }: { config: any }) {
     });
   });
 
-  registerRoutes(apiRouter, config);
+  registerRoutes(apiRouter, config, dependencies);
 
   router.use("/api", apiRouter);
   router.get("*", async (req: express.Request, res: express.Response, next: express.NextFunction) => {

src/app/index.ts

@@ -1,12 +1,14 @@
 import { Router } from "express";
+import { Config } from "../config";
 import { IExpressController } from "../interfaces/express-controller";
 import * as apiControllers from "./controllers/index";
 
-export let registerRoutes = (apiRouter: Router, config: any) => {
+export let registerRoutes = (apiRouter: Router, config: Config, dependencies: any) => {
   let controllers: [string, IExpressController][] = [
     ["/sessions", new apiControllers.SessionController()],
     ["/builds", new apiControllers.BuildController()],
     ["/projects", new apiControllers.ProjectController()],
+    ["/debug", new apiControllers.DebugController(dependencies.debugEventEmitter)],
   ];
 
   for (let [path, controller] of controllers) {

src/app/routes.ts

@@ -2,6 +2,15 @@ import * as os from "os";
 import * as path from "path";
 let basePath = path.join(os.homedir(), ".cache", "appium-dashboard-plugin");
 
+export interface Config {
+  cacheDir: string;
+  databasePath: string;
+  videoSavePath: string;
+  screenshotSavePath: string;
+  logFilePath: string;
+  takeScreenshotsFor: Array<string>;
+}
+
 export let config = {
   cacheDir: basePath,
   databasePath: `${basePath}`,