feat(jes-api): implement job execution via API to JES

2026-01-21 02:50:05 +00:00 · 2020-07-13 18:38:30 +01:00
parent c22b9066d8
commit 92504b0c16
4 changed files with 356 additions and 283 deletions
--- a/sasjs-tests/public/config.json
+++ b/sasjs-tests/public/config.json
@@ -6,6 +6,6 @@
    "appLoc": "/Public/app",
    "serverType": "SASVIYA",
    "debug": false,
-    "contextName": null
+    "contextName": "SAS Job Execution compute context"
  }
 }
--- a/src/SASViyaApiClient.ts
+++ b/src/SASViyaApiClient.ts
@@ -6,7 +6,7 @@ import {
 } from "./utils";
 import * as NodeFormData from "form-data";
 import * as path from "path";
-import { Job, Session, Context, Folder } from "./types";
+import { Job, Session, Context, Folder, CsrfToken } from "./types";

 /**
 * A client for interfacing with the SAS Viya REST API
@@ -296,17 +296,27 @@ export class SASViyaApiClient {

    if (!parentFolderUri && parentFolderPath) {
      parentFolderUri = await this.getFolderUri(parentFolderPath, accessToken);
-      if (!parentFolderUri){
+      if (!parentFolderUri) {
        console.log(`Parent folder is not present: ${parentFolderPath}`);

-        const newParentFolderPath = parentFolderPath.substring(0, parentFolderPath.lastIndexOf("/"));
+        const newParentFolderPath = parentFolderPath.substring(
+          0,
+          parentFolderPath.lastIndexOf("/")
+        );
        const newFolderName = `${parentFolderPath.split("/").pop()}`;
-        if (newParentFolderPath === ""){
+        if (newParentFolderPath === "") {
          throw new Error("Root Folder should have been present on server");
        }
-        console.log(`Creating Parent Folder:\n${newFolderName} in ${newParentFolderPath}`)
-        const parentFolder = await this.createFolder(newFolderName, newParentFolderPath, undefined, accessToken)
-        console.log(`Parent Folder "${newFolderName}" successfully created.`)
+        console.log(
+          `Creating Parent Folder:\n${newFolderName} in ${newParentFolderPath}`
+        );
+        const parentFolder = await this.createFolder(
+          newFolderName,
+          newParentFolderPath,
+          undefined,
+          accessToken
+        );
+        console.log(`Parent Folder "${newFolderName}" successfully created.`);
        parentFolderUri = `/folders/folders/${parentFolder.id}`;
      }
    }
@@ -350,7 +360,9 @@ export class SASViyaApiClient {
    accessToken?: string
  ) {
    if (!parentFolderPath && !parentFolderUri) {
-      throw new Error('Either parentFolderPath or parentFolderUri must be provided');
+      throw new Error(
+        "Either parentFolderPath or parentFolderUri must be provided"
+      );
    }

    if (!parentFolderUri && parentFolderPath) {
@@ -365,12 +377,12 @@ export class SASViyaApiClient {
      },
      body: JSON.stringify({
        name: jobName,
-        parameters:[
+        parameters: [
          {
-            "name":"_addjesbeginendmacros",
-            "type":"CHARACTER",
-            "defaultValue":"false"
-          }
+            name: "_addjesbeginendmacros",
+            type: "CHARACTER",
+            defaultValue: "false",
+          },
        ],
        type: "Compute",
        code,
@@ -578,6 +590,7 @@ export class SASViyaApiClient {
    let files: any[] = [];
    if (data && Object.keys(data).length) {
      files = await this.uploadTables(data, accessToken);
+      console.log("Uploaded table files: ", files);
    }
    const jobName = path.basename(sasJob);
    const jobFolder = sasJob.replace(`/${jobName}`, "");
@@ -612,15 +625,15 @@ export class SASViyaApiClient {
      };

      if (debug) {
-        jobArguments["_omittextlog"] = "false";
-        jobArguments["_omitsessionresults"] = "false";
-        jobArguments["_debug"] = 131;
+        jobArguments["_OMITTEXTLOG"] = "false";
+        jobArguments["_OMITSESSIONRESULTS"] = "false";
+        jobArguments["_DEBUG"] = 131;
      }

      files.forEach((fileInfo, index) => {
        jobArguments[
          `_webin_fileuri${index + 1}`
-        ] = `/files/files/${fileInfo.id}`;
+        ] = `/files/files/${fileInfo.file.id}`;
        jobArguments[`_webin_name${index + 1}`] = fileInfo.tableName;
      });

@@ -643,16 +656,29 @@ export class SASViyaApiClient {
        `${this.serverUrl}/jobExecution/jobs/${postedJob.id}`,
        { headers }
      );
-      const resultLink = currentJob.results["_webout.json"];
-      if (resultLink) {
-        const result = await this.request<any>(
-          `${this.serverUrl}${resultLink}/content`,
-          { headers }
-        );
-        return result;
-      }

-      return postedJob;
+      let result, log;
+      if (jobStatus === "failed") {
+        return Promise.reject(currentJob.error);
+      }
+      const resultLink = currentJob.results["_webout.json"];
+      const logLink = currentJob.links.find((l) => l.rel === "log");
+      if (resultLink) {
+        result = await this.request<any>(
+          `${this.serverUrl}${resultLink}/content`,
+          { headers },
+          "text"
+        );
+      }
+      if (debug && logLink) {
+        log = await this.request<any>(
+          `${this.serverUrl}${logLink.href}/content`,
+          {
+            headers,
+          }
+        ).then((res: any) => res.items.map((i: any) => i.line).join("\n"));
+      }
+      return { result, log };
    } else {
      throw new Error(
        `The job ${sasJob} was not found at the location ${this.rootFolderName}`
@@ -673,7 +699,7 @@ export class SASViyaApiClient {
      `${this.serverUrl}${url}`,
      requestInfo
    );
-    if (!folder){
+    if (!folder) {
      throw new Error("Cannot populate RootFolderMap unless rootFolder exists");
    }
    const members = await this.request<{ items: any[] }>(
@@ -734,6 +760,8 @@ export class SASViyaApiClient {
    accessToken?: string,
    silent = false
  ) {
+    const MAX_POLL_COUNT = 1000;
+    const POLL_INTERVAL = 300;
    let postedJobState = "";
    let pollCount = 0;
    const headers: any = {
@@ -767,7 +795,7 @@ export class SASViyaApiClient {
              console.log(`Current state: ${postedJobState}\n`);
            }
            pollCount++;
-            if (pollCount >= 100) {
+            if (pollCount >= MAX_POLL_COUNT) {
              resolve(postedJobState);
            }
          }
@@ -775,7 +803,7 @@ export class SASViyaApiClient {
          clearInterval(interval);
          resolve(postedJobState);
        }
-      }, 100);
+      }, POLL_INTERVAL);
    });
  }

@@ -824,11 +852,14 @@ export class SASViyaApiClient {
      `${this.serverUrl}${url}`,
      requestInfo
    );
-      if (!folder)
-        return undefined;
+    if (!folder) return undefined;
    return `/folders/folders/${folder.id}`;
  }

+  setCsrfToken = (csrfToken: CsrfToken) => {
+    this.csrfToken = csrfToken;
+  };
+
  private async request<T>(
    url: string,
    options: RequestInit,
@@ -840,11 +871,6 @@ export class SASViyaApiClient {
        [this.csrfToken.headerName]: this.csrfToken.value,
      };
    }
-    return await makeRequest<T>(
-      url,
-      options,
-      (csrfToken) => (this.csrfToken = csrfToken),
-      contentType
-    );
+    return await makeRequest<T>(url, options, this.setCsrfToken, contentType);
  }
 }
--- a/src/SASjs.ts
+++ b/src/SASjs.ts
@@ -386,6 +386,18 @@ export default class SASjs {
    loginRequiredCallback?: any,
    accessToken?: string
  ) {
+    if (
+      this.sasjsConfig.serverType === ServerType.SASViya &&
+      this.sasjsConfig.contextName
+    ) {
+      return await this.executeViaJesApi(
+        sasJob,
+        data,
+        params,
+        loginRequiredCallback,
+        accessToken
+      );
+    } else {
      const sasjsWaitingRequest: SASjsWaitingRequest = {
        requestPromise: {
          promise: null,
@@ -396,38 +408,9 @@ export default class SASjs {
        data,
        params,
      };
-
-    // if (
-    //   this.sasjsConfig.serverType === ServerType.SASViya &&
-    //   this.sasjsConfig.contextName
-    // ) {
-    //   sasjsWaitingRequest.requestPromise.promise = new Promise(
-    //     async (resolve, reject) => {
-    //       const session = await this.checkSession();
-
-    //       if (!session.isLoggedIn) {
-    //         if (loginRequiredCallback) loginRequiredCallback(true);
-    //         logInRequired = true;
-    //         sasjsWaitingRequest.requestPromise.resolve = resolve;
-    //         sasjsWaitingRequest.requestPromise.reject = reject;
-    //         this.sasjsWaitingRequests.push(sasjsWaitingRequest);
-    //       } else {
-    //         resolve(
-    //           await this.sasViyaApiClient?.executeJob(
-    //             sasJob,
-    //             this.sasjsConfig.contextName,
-    //             this.sasjsConfig.debug,
-    //             data,
-    //             accessToken
-    //           )
-    //         );
-    //       }
-    //     }
-    //   );
-    //   return sasjsWaitingRequest.requestPromise.promise;
-    // } else {
      const program = this.sasjsConfig.appLoc
-      ? this.sasjsConfig.appLoc.replace(/\/?$/, "/") + sasJob.replace(/^\//, "")
+        ? this.sasjsConfig.appLoc.replace(/\/?$/, "/") +
+          sasJob.replace(/^\//, "")
        : sasJob;
      const jobUri =
        this.sasjsConfig.serverType === "SASVIYA"
@@ -474,7 +457,9 @@ export default class SASjs {
                "The max length of a string value in SASjs is 32765 characters.";
            }

-          const file = new Blob([csv], { type: "application/csv" });
+            const file = new Blob([csv], {
+              type: "application/csv",
+            });
            console.log("File", file);

            formData.append(name, file, `${name}.csv`);
@@ -587,7 +572,9 @@ export default class SASjs {
                    this.sasjsConfig.debug
                  ) {
                    this.updateUsername(responseText);
-                  const jsonResponseText = this.parseSAS9Response(responseText);
+                    const jsonResponseText = this.parseSAS9Response(
+                      responseText
+                    );

                    if (jsonResponseText !== "") {
                      resolve(JSON.parse(jsonResponseText));
@@ -636,7 +623,7 @@ export default class SASjs {
      );

      return sasjsWaitingRequest.requestPromise.promise;
-    // }
+    }
  }

  /**
@@ -695,6 +682,59 @@ export default class SASjs {
    );
  }

+  private async executeViaJesApi(
+    sasJob: string,
+    data: any,
+    params?: any,
+    loginRequiredCallback?: any,
+    accessToken?: string
+  ) {
+    const sasjsWaitingRequest: SASjsWaitingRequest = {
+      requestPromise: {
+        promise: null,
+        resolve: null,
+        reject: null,
+      },
+      SASjob: sasJob,
+      data,
+      params,
+    };
+
+    sasjsWaitingRequest.requestPromise.promise = new Promise(
+      async (resolve, reject) => {
+        const session = await this.checkSession();
+
+        if (!session.isLoggedIn) {
+          if (loginRequiredCallback) loginRequiredCallback(true);
+          sasjsWaitingRequest.requestPromise.resolve = resolve;
+          sasjsWaitingRequest.requestPromise.reject = reject;
+          this.sasjsWaitingRequests.push(sasjsWaitingRequest);
+        } else {
+          resolve(
+            await this.sasViyaApiClient
+              ?.executeJob(
+                sasJob,
+                this.sasjsConfig.contextName,
+                this.sasjsConfig.debug,
+                data,
+                accessToken
+              )
+              .then((response) => {
+                if (!this.sasjsConfig.debug) {
+                  this.appendSasjsRequest(null, sasJob, null);
+                } else {
+                  this.appendSasjsRequest(response, sasJob, null);
+                }
+                return JSON.parse(response.result);
+              })
+              .catch((e) => reject({ MESSAGE: e.message }))
+          );
+        }
+      }
+    );
+    return sasjsWaitingRequest.requestPromise.promise;
+  }
+
  private async resendWaitingRequests() {
    for (const sasjsWaitingRequest of this.sasjsWaitingRequests) {
      this.request(
@@ -856,14 +896,20 @@ export default class SASjs {
    let generatedCode = "";
    let sasWork = null;

+    if (response && response.result && response.log) {
+      sourceCode = parseSourceCode(response.log);
+      generatedCode = parseGeneratedCode(response.log);
+      sasWork = JSON.parse(response.result).WORK;
+    } else {
      if (response) {
        sourceCode = parseSourceCode(response);
        generatedCode = parseGeneratedCode(response);
        sasWork = await this.parseSasWork(response);
      }
+    }

    this.sasjsRequests.push({
-      logFile: response,
+      logFile: (response && response.log) || response,
      serviceLink: program,
      timestamp: new Date(),
      sourceCode,
--- a/src/types/Job.ts
+++ b/src/types/Job.ts
@@ -8,4 +8,5 @@ export interface Job {
  createdBy: string;
  links: Link[];
  results: JobResult;
+  error?: any;
 }