Documenting functions of rest-client's mock

Add documenting comments to the functions in the mock file used to test
rest-client.ts.

Signed-off-by: Rodrigo Pinto <rodrigo.pinto@calian.ca>.

Author: Rodrigoplp-work

.gitignore

@@ -1,5 +1,6 @@
 # LC_COLLATE=C sort
 /*.log
 /.DS_Store
+/coverage/
 /lib/
 /node_modules/

README.md

@@ -25,3 +25,11 @@ To keep tests running do:
 ```shell
 yarn test --verbose --watch
 ```
+
+### Test coverage
+
+The following command prints a coverage report to the terminal. As of now it covers all typescript files of the project, including those that are not supposed to have tests.
+
+```shell
+yarn test --coverage --collectCoverageFrom='src/**/*.ts'
+```

src/protocol/__mocks__/rest-client.ts

@@ -24,6 +24,14 @@ const output: OutputDescriptor = {
 };
 
 export class RestClient {
+  /**
+   * Perform request
+   * Mocks the request call without calling the real backend.
+   * @param verb RestAPI verb
+   * @param url URL to query
+   * @param body Query object as defined by the Query interface
+   * @return A TspClientResponse object
+   */
   private static async performRequest<T>(verb: string, url: string, body?: any): Promise<TspClientResponse<T>> {
     return new Promise((resolve, reject) => {
       let client: TspClientResponse<T> = new TspClientResponse(response.text, response.status, response.statusText);
@@ -62,6 +70,13 @@ export class RestClient {
     });
   }
 
+  /**
+   * Perform GET
+   * T is the expected type of the json object returned by this request
+   * @param url URL to query without query parameters
+   * @param parameters Query parameters. Mapped keys and values are used to build the final URL
+   * @return A TspClientResponse object
+   */
   public static async get<T>(url: string, parameters?: Map<string, string>): Promise<TspClientResponse<T>> {
     let getUrl = url;
     if (parameters) {
@@ -71,14 +86,35 @@ export class RestClient {
     return this.performRequest<T>('get', getUrl);
   }
 
+  /**
+   * Perform POST
+   * T is the expected type of the json object returned by this request
+   * @param url URL to query
+   * @param body Query object as defined by the Query interface
+   * @return A TspClientResponse object
+   */
   public static async post<T>(url: string, body?: any): Promise<TspClientResponse<T>> {
     return this.performRequest<T>('post', url, body);
   }
 
+  /**
+   * Perform PUT
+   * T is the expected type of the json object returned by this request
+   * @param url URL to query
+   * @param body Query object as defined by the Query interface
+   * @return A TspClientResponse object
+   */
   public static async put<T>(url: string, body?: any): Promise<TspClientResponse<T>> {
     return this.performRequest<T>('put', url, body);
   }
 
+  /**
+   * Perform DELETE
+   * T is the expected type of the json object returned by this request
+   * @param url URL to query without query parameters
+   * @param parameters Query parameters. Mapped keys and values are use to build the final URL
+   * @return A TspClientResponse object
+   */
   public static async delete<T>(url: string, parameters?: Map<string, string>): Promise<TspClientResponse<T>> {
     let deleteUrl = url;
     if (parameters) {
@@ -88,6 +124,11 @@ export class RestClient {
     return this.performRequest<T>('delete', deleteUrl);
   }
 
+  /**
+   * Encode URL parameters
+   * @param parameters Query parameters. Mapped keys and values are used to build the final URL
+   * @return Encoded string
+   */
   private static encodeURLParameters(parameters: Map<string, string>): string {
     if (parameters.size) {
       const urlParameters: string = '?';
@@ -100,6 +141,11 @@ export class RestClient {
     return '';
   }
 
+  /**
+    * Extract parameters
+    * @param url URL string
+    * @return String containing the parameters extracted from the url
+    */
   public static extractParameters(url: string): string {
     const topic = url.includes('traces') ? 'traces' : 'experiments';
     const ar = url.split(topic + '/');

src/protocol/rest-client.ts

@@ -15,7 +15,8 @@ export class RestClient {
                 'Content-Type': 'application/json'
             },
             method: verb,
-            body: jsonBody});
+            body: jsonBody
+        });
         const text = await response.text();
         return new TspClientResponse(text, response.status, response.statusText);
     }
@@ -24,7 +25,7 @@ export class RestClient {
      * Perform GET
      * T is the expected type of the json object returned by this request
      * @param url URL to query without query parameters
-     * @param parameters Query parameters. Map keys and values are used to build the final URL
+     * @param parameters Query parameters. Mapped keys and values are used to build the final URL
      */
     public static async get<T>(url: string, parameters?: Map<string, string>): Promise<TspClientResponse<T>> {
         let getUrl = url;
@@ -59,7 +60,7 @@ export class RestClient {
      * Perform DELETE
      * T is the expected type of the json object returned by this request
      * @param url URL to query without query parameters
-     * @param parameters Query parameters. Map keys and values are used to build the final URL
+     * @param parameters Query parameters. Mapped keys and values are used to build the final URL
      */
     public static async delete<T>(url: string, parameters?: Map<string, string>): Promise<TspClientResponse<T>> {
         let deleteUrl = url;