Removed namespace and added appropriate comments for methods

Author: ishwaryamamidi

app/controllers/InstanceRegistryController.scala

@@ -94,7 +94,11 @@ class InstanceRegistryController @Inject()(implicit system: ActorSystem, mat: Ma
     }(myExecutionContext)
   }
 
-  //This function is for all the  POST methods to the Scala web server
+  /**
+  * This function is for handling all(start, stop, play, pause, resume) POST request.
+  * To control the instance State
+  * @param componentId
+  */
 
 
   def handleRequest(action: String): Action[AnyContent] = Action.async { request =>
@@ -122,7 +126,12 @@ class InstanceRegistryController @Inject()(implicit system: ActorSystem, mat: Ma
       }(myExecutionContext)
   }
 
-  //This function is for adding an instance to the Scala web server
+  /**
+  * This function is for handling an POST request for adding an instance to the Scala web server
+  *
+  * @param componentType
+  * @param name
+  */
   def postInstance(): Action[AnyContent] = Action.async { request =>
     var compType = ""
     var name = ""

client/src/app/api/model/instance.ts

@@ -34,7 +34,7 @@ export interface Instance {
   /**
    * Component Type
    */
-  componentType?: Instance.ComponentTypeEnum;
+  componentType?: ComponentType;
   dockerId?: string;
   /**
    * State of the instance
@@ -43,16 +43,6 @@ export interface Instance {
   labels?: Array<string>;
 }
 
-export namespace Instance {
-  export type ComponentTypeEnum = 'Crawler' | 'WebApi' | 'WebApp' | 'DelphiManagement';
-  export const ComponentTypeEnum = {
-    Crawler: 'Crawler' as ComponentTypeEnum,
-    WebApi: 'WebApi' as ComponentTypeEnum,
-    WebApp: 'WebApp' as ComponentTypeEnum,
-    DelphiManagement: 'DelphiManagement' as ComponentTypeEnum
-  };
-}
-
 export type StateEnum = 'Running' | 'Failed' | 'Stopped' | 'Paused' | 'NotReachable';
 export const StateEnum = {
   Running: 'Running' as StateEnum,

client/src/app/dashboard/add-dialog/add-dialog.component.ts

@@ -15,10 +15,8 @@ export class AddDialogComponent implements OnInit {
 
   formControl = new FormControl('', [
     Validators.required
-    // Validators.email,
   ]);
   ngOnInit() {
-    // console.log('data.type', this.data);
   }
 
   getErrorMessage() {

client/src/app/dashboard/crawler/crawler.component.ts

@@ -32,7 +32,7 @@ export class CrawlerComponent implements OnInit {
   compType: string;
 
   constructor(private apiService: ApiService) {
-    this.compType = Instance.ComponentTypeEnum.Crawler;
+  
   }
 
   ngOnInit() {

client/src/app/dashboard/table-all/table-all.component.html

@@ -21,7 +21,7 @@
 <ng-template #tableBlock>
     <div class="container">
         <mat-form-field>
-            <input id="filter_data" matInput (keyup)="applyFilter($event.target.value)" placeholder="Filter">
+            <input id="filterData" matInput (keyup)="applyFilter($event.target.value)" placeholder="Filter">
         </mat-form-field>
         <table class="mat-elevation-z8 mat-table" mat-table [dataSource]="dataSource">
             <ng-container matColumnDef="ID">

client/src/app/dashboard/table-all/table-all.component.spec.ts

@@ -51,11 +51,11 @@ describe('TableAllComponent', () => {
         useValue: {}
       }, {
         provide: MAT_DIALOG_DATA,
-        useValue: {} // Add any data you wish to test if it is passed/used correctly
+        useValue: {} 
       },
       {
         provide: MatTableDataSource,
-        useValue: {} // Add any data you wish to test if it is passed/used correctly
+        useValue: {} 
       }]
     })
       .compileComponents();

client/src/app/dashboard/table-all/table-all.component.ts

@@ -31,7 +31,7 @@ import { ApiService } from '../../api/api/api.service';
     styleUrls: ['./table-all.component.css']
 })
 export class TableAllComponent implements OnInit {
-    @Input() type: Instance.ComponentTypeEnum;
+    @Input() type: Instance['componentType'];
 
     @Input() set dataArray(dataArray: Instance[]) {
         if (this.dataSource != null) {
@@ -58,7 +58,11 @@ export class TableAllComponent implements OnInit {
         this.dataSource.paginator = this.paginator;
     }
 
-    // Function to Delete the data from datasource
+    /**
+   * Function for deleting an insatnce. Cannot delete an instance if its running. 
+   * Prompts to Stop the instance before deleting.   
+   * @param InstanceID
+   */
     openDeleteDialog(i: number, instance: Instance, id: string) {
         const dialogRef = this.dialog.open(DeleteDialogComponent, {
             width: '250px',
@@ -94,7 +98,11 @@ export class TableAllComponent implements OnInit {
         this.dataSource.filter = filterValue.trim().toLowerCase();
     }
 
-    // Function to add the data into dataSource
+   /**
+   * Adding an instance using mat-dialog component 
+   * @param componentType
+   * @param componentName
+   */
     openAddDialog() {
         const instance: Instance = {};
         instance.componentType = this.type;
@@ -107,7 +115,7 @@ export class TableAllComponent implements OnInit {
             this.apiService.postInstance(instance.componentType, dialogResult.name).subscribe((result: Instance) => {
                 this.dataSource.data.push({
                     id: result.id,
-                    host: result.host,
+                    host: '',
                     portNumber: result.portNumber,
                     name: dialogResult.name,
                     instanceState: result.instanceState,
@@ -121,7 +129,10 @@ export class TableAllComponent implements OnInit {
         });
     }
 
-    // Function to 'start' the instance
+   /**
+   * Function used to control the state of the instance. Case1: 'start' an instance  
+   * @param InstanceID
+   */
     public startInstance(id: string): void {
 
         this.apiService.startInstance(id).subscribe((result: number) => {
@@ -131,7 +142,10 @@ export class TableAllComponent implements OnInit {
         });
     }
 
-    // Function to 'stop' the instance
+    /**
+   * Function used to control the state of the instance. Case2: 'stop' an instance  
+   * @param InstanceID
+   */
     public stopInstance(id: string): void {
 
         this.apiService.stopInstance(id).subscribe((result: number) => {
@@ -141,7 +155,10 @@ export class TableAllComponent implements OnInit {
         });
     }
 
-    // Function to 'pause' the instance
+    /**
+   * Function used to control the state of the instance. Case3: 'Pause' an instance 
+   * @param InstanceID
+   */
     public pauseInstance(id: string): void {
 
         this.apiService.pauseInstance(id).subscribe((result: number) => {
@@ -151,7 +168,10 @@ export class TableAllComponent implements OnInit {
         });
     }
 
-    // Function to 'resume' the instance
+    /**
+   * Function used to control the state of the instance. Case4: 'Resume' an instance if Paused  
+   * @param InstanceID
+   */
     public resumeInstance(id: string): void {
 
         this.apiService.resumeInstance(id).subscribe((result: number) => {

conf/application.conf

@@ -220,7 +220,7 @@ play.filters {
   # Disabled filters remove elements from the enabled list.
   #disabled += filters.ExampleFilters
   disabled += play.filters.csrf.CSRFFilter
-
+  
   ## CORS filter configuration
   # https://www.playframework.com/documentation/latest/CorsFilter
   # ~~~~~