Merge pull request #31 from sasjs/session-cleanup

feat(session-cleanup): delete a session after it has been used

package.json

@@ -37,7 +37,7 @@
   "license": "ISC",
   "devDependencies": {
     "@types/isomorphic-fetch": "0.0.35",
-    "@types/jest": "^26.0.5",
+    "@types/jest": "^26.0.8",
     "cp": "^0.2.0",
     "jest": "^25.5.4",
     "path": "^0.12.7",
@@ -45,15 +45,15 @@
     "rimraf": "^3.0.2",
     "semantic-release": "^17.1.1",
     "ts-jest": "^25.5.1",
-    "ts-loader": "^8.0.1",
-    "tslint": "^6.1.2",
+    "ts-loader": "^8.0.2",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0",
     "typedoc": "^0.17.8",
     "typedoc-neo-theme": "^1.0.9",
     "typedoc-plugin-external-module-name": "^4.0.3",
     "typescript": "^3.9.7",
     "uglifyjs-webpack-plugin": "^2.2.0",
-    "webpack": "^4.43.0",
+    "webpack": "^4.44.1",
     "webpack-cli": "^3.3.12"
   },
   "main": "index.js",

src/SASViyaApiClient.ts

@@ -29,7 +29,11 @@ export class SASViyaApiClient {
   }
   private csrfToken: CsrfToken | null = null;
   private rootFolder: Folder | null = null;
-  private sessionManager = new SessionManager(this.serverUrl, this.contextName, this.setCsrfToken);
+  private sessionManager = new SessionManager(
+    this.serverUrl,
+    this.contextName,
+    this.setCsrfToken
+  );
 
   /**
    * Returns a map containing the directory structure in the currently set root folder.
@@ -113,9 +117,7 @@ export class SASViyaApiClient {
         `test-${context.name}`,
         linesOfCode,
         context.name,
-        accessToken,
-        undefined,
-        true
+        accessToken
       ).catch(() => null);
     });
     const results = await Promise.all(promises);
@@ -201,11 +203,11 @@ export class SASViyaApiClient {
     linesOfCode: string[],
     contextName: string,
     accessToken?: string,
-    sessionId = "",
     silent = false,
     data = null,
     debug = false
   ) {
+    silent = !debug;
     const headers: any = {
       "Content-Type": "application/json",
     };
@@ -313,7 +315,9 @@ export class SASViyaApiClient {
         }
       ).then((res: any) => res.result.items.map((i: any) => i.line).join("\n"));
     }
-    
+
+    await this.sessionManager.clearSession(executionSessionId, accessToken);
+
     return { result: jobResult?.result, log };
     // } else {
     //   console.error(
@@ -623,12 +627,16 @@ export class SASViyaApiClient {
       await this.populateRootFolder(accessToken);
     }
     if (!this.rootFolder) {
+      console.error("Root folder was not found");
       throw new Error("Root folder was not found");
     }
     if (!this.rootFolderMap.size) {
       await this.populateRootFolderMap(accessToken);
     }
     if (!this.rootFolderMap.size) {
+      console.error(
+        `The job ${sasJob} was not found in ${this.rootFolderName}`
+      );
       throw new Error(
         `The job ${sasJob} was not found in ${this.rootFolderName}`
       );
@@ -647,6 +655,7 @@ export class SASViyaApiClient {
       (l) => l.rel === "getResource"
     );
     if (!jobDefinitionLink) {
+      console.error("Job definition URI was not found.");
       throw new Error("Job definition URI was not found.");
     }
     const { result: jobDefinition } = await this.request<JobDefinition>(
@@ -661,7 +670,6 @@ export class SASViyaApiClient {
       linesToExecute,
       contextName,
       accessToken,
-      "",
       true,
       data,
       debug
@@ -1018,7 +1026,10 @@ export class SASViyaApiClient {
     const { result: folder } = await this.request<Folder>(
       `${this.serverUrl}${url}`,
       requestInfo
-    );
+    ).catch((err) => {
+      return { result: null };
+    });
+
     if (!folder) return undefined;
     return `/folders/folders/${folder.id}`;
   }
@@ -1039,6 +1050,11 @@ export class SASViyaApiClient {
         [this.csrfToken.headerName]: this.csrfToken.value,
       };
     }
-    return await makeRequest<T>(url, options, this.setCsrfTokenLocal, contentType);
+    return await makeRequest<T>(
+      url,
+      options,
+      this.setCsrfTokenLocal,
+      contentType
+    );
   }
 }

src/SASjs.ts

@@ -21,7 +21,7 @@ import {
   SASjsWaitingRequest,
   ServerType,
   CsrfToken,
-  UploadFile
+  UploadFile,
 } from "./types";
 import { SASViyaApiClient } from "./SASViyaApiClient";
 import { SAS9ApiClient } from "./SAS9ApiClient";
@@ -122,7 +122,6 @@ export default class SASjs {
       linesOfCode,
       contextName,
       accessToken,
-      sessionId,
       silent
     );
   }
@@ -546,52 +545,52 @@ export default class SASjs {
     sasjsWaitingRequest.requestPromise.promise = new Promise(
       async (resolve, reject) => {
         this.sasViyaApiClient
-            ?.executeComputeJob(
-              sasJob,
-              config.contextName,
-              config.debug,
-              data,
-              accessToken
-            )
-            .then((response) => {
-              if (!config.debug) {
-                this.appendSasjsRequest(null, sasJob, null);
+          ?.executeComputeJob(
+            sasJob,
+            config.contextName,
+            config.debug,
+            data,
+            accessToken
+          )
+          .then((response) => {
+            if (!config.debug) {
+              this.appendSasjsRequest(null, sasJob, null);
+            } else {
+              this.appendSasjsRequest(response, sasJob, null);
+            }
+
+            resolve(JSON.parse(response!.result));
+          })
+          .catch(async (e) => {
+            if (needsRetry(JSON.stringify(e))) {
+              if (this.retryCountComputeApi < requestRetryLimit) {
+                let retryResponse = await this.executeJobViaComputeApi(
+                  sasJob,
+                  data,
+                  config,
+                  loginRequiredCallback,
+                  accessToken
+                );
+
+                this.retryCountComputeApi++;
+
+                resolve(retryResponse);
               } else {
-                this.appendSasjsRequest(response, sasJob, null);
+                this.retryCountComputeApi = 0;
+                reject({ MESSAGE: "Compute API retry requests limit reached" });
               }
+            }
 
-              resolve(JSON.parse(response!.result));
-            })
-            .catch(async (e) => {
-              if (needsRetry(JSON.stringify(e))) {
-                if (this.retryCountComputeApi < requestRetryLimit) {
-                  let retryResponse = await this.executeJobViaComputeApi(
-                    sasJob,
-                    data,
-                    config,
-                    loginRequiredCallback,
-                    accessToken
-                  );
-
-                  this.retryCountComputeApi++;
-  
-                  resolve(retryResponse);
-                } else {
-                  this.retryCountComputeApi = 0;
-                  reject({ MESSAGE: "Compute API retry requests limit reached" });
-                }
-              }
-
-              if (e && e.status === 401) {
-                if (loginRequiredCallback) loginRequiredCallback(true);
-                sasjsWaitingRequest.requestPromise.resolve = resolve;
-                sasjsWaitingRequest.requestPromise.reject = reject;
-                sasjsWaitingRequest.config = config;
-                this.sasjsWaitingRequests.push(sasjsWaitingRequest);
-              } else {
-                reject({ MESSAGE: e || "Job execution failed" });
-              }
-            })
+            if (e && e.status === 401) {
+              if (loginRequiredCallback) loginRequiredCallback(true);
+              sasjsWaitingRequest.requestPromise.resolve = resolve;
+              sasjsWaitingRequest.requestPromise.reject = reject;
+              sasjsWaitingRequest.config = config;
+              this.sasjsWaitingRequests.push(sasjsWaitingRequest);
+            } else {
+              reject({ MESSAGE: e || "Job execution failed" });
+            }
+          });
       }
     );
     return sasjsWaitingRequest.requestPromise.promise;
@@ -652,9 +651,9 @@ export default class SASjs {
                       loginRequiredCallback,
                       accessToken
                     );
-  
+
                     this.retryCountJeseApi++;
-    
+
                     resolve(retryResponse);
                   } else {
                     this.retryCountJeseApi = 0;
@@ -662,7 +661,7 @@ export default class SASjs {
                   }
                 }
 
-                reject({ MESSAGE: (e && e.message) || "Job execution failed" })
+                reject({ MESSAGE: (e && e.message) || "Job execution failed" });
               })
           );
         }

src/SessionManager.ts

@@ -16,7 +16,21 @@ export class SessionManager {
   async getSession(accessToken?: string) {
     await this.createSessions(accessToken);
     this.createAndWaitForSession(accessToken);
-    return this.sessions.pop();
+    const session = this.sessions.pop();
+    return session;
+  }
+
+  async clearSession(id: string, accessToken?: string) {
+    const deleteSessionRequest = {
+      method: "DELETE",
+      headers: this.getHeaders(accessToken),
+    };
+    return await this.request<Session>(
+      `${this.serverUrl}/compute/sessions/${id}`,
+      deleteSessionRequest
+    ).then(() => {
+      this.sessions = this.sessions.filter((s) => s.id !== id);
+    });
   }
 
   private async createSessions(accessToken?: string) {

src/utils/makeRequest.ts

@@ -1,4 +1,8 @@
 import { CsrfToken } from "../types";
+import { needsRetry } from "./needsRetry";
+
+let retryCount: number = 0;
+let retryLimit: number = 5;
 
 export async function makeRequest<T>(
   url: string,
@@ -6,6 +10,8 @@ export async function makeRequest<T>(
   callback: (value: CsrfToken) => any,
   contentType: "text" | "json" = "json"
 ): Promise<{ result: T; etag: string | null }> {
+  let retryRequest: any = null;
+
   const responseTransform =
     contentType === "json"
       ? (res: Response) => res.json()
@@ -23,7 +29,7 @@ export async function makeRequest<T>(
             value: token || "",
           });
 
-          const retryRequest = {
+          retryRequest = {
             ...request,
             headers: { ...request.headers, [tokenHeader]: token },
           };
@@ -34,15 +40,66 @@ export async function makeRequest<T>(
         }
       } else {
         const body = await response.text();
+
+        if (needsRetry(body)) {
+          if (retryCount < retryLimit) {
+            retryCount++;
+            let retryResponse = await makeRequest(
+              url,
+              retryRequest || request,
+              callback,
+              contentType
+            );
+            retryCount = 0;
+
+            return retryResponse;
+          } else {
+            retryCount = 0;
+
+            throw new Error("Request retry limit exceeded");
+          }
+        }
+
         return Promise.reject({ status: response.status, body });
       }
     } else {
-      if (response.redirected && response.url.includes("SASLogon/login")) {
-        const body = await response.text();
-        return Promise.reject({ status: 401, body });
+      if (response.status === 204) {
+        return Promise.resolve();
       }
+      const responseTransformed = await responseTransform(response);
+      let responseText = "";
+
+      if (typeof responseTransformed === "string") {
+        responseText = responseTransformed;
+      } else {
+        responseText = JSON.stringify(responseTransformed);
+      }
+
+      if (response.redirected && response.url.includes("SASLogon/login")) {
+        return Promise.reject({ status: 401, responseTransformed });
+      }
+
+      if (needsRetry(responseText)) {
+        if (retryCount < retryLimit) {
+          retryCount++;
+          const retryResponse = await makeRequest(
+            url,
+            retryRequest || request,
+            callback,
+            contentType
+          );
+          retryCount = 0;
+
+          return retryResponse;
+        } else {
+          retryCount = 0;
+
+          throw new Error("Request retry limit exceeded");
+        }
+      }
+
       etag = response.headers.get("ETag");
-      return responseTransform(response);
+      return responseTransformed;
     }
   });
   return { result, etag };

src/utils/needsRetry.ts

@@ -1,11 +1,14 @@
 export const needsRetry = (responseText: string): boolean => {
   return (
-    (responseText.includes('"errorCode":403') &&
+    !!responseText &&
+    ((responseText.includes('"errorCode":403') &&
       responseText.includes("_csrf") &&
       responseText.includes("X-CSRF-TOKEN")) ||
-    (responseText.includes('"status":403') &&
-      responseText.includes('"error":"Forbidden"')) ||
-    (responseText.includes('"status":449') &&
-      responseText.includes("Authentication success, retry original request"))
+      (responseText.includes('"status":403') &&
+        responseText.includes('"error":"Forbidden"')) ||
+      (responseText.includes('"status":449') &&
+        responseText.includes(
+          "Authentication success, retry original request"
+        )))
   );
 };